GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::CloudWatchLogs::FilterLogEvents(3) User Contributed Perl Documentation Paws::CloudWatchLogs::FilterLogEvents(3)

Paws::CloudWatchLogs::FilterLogEvents - Arguments for method FilterLogEvents on Paws::CloudWatchLogs

This class represents the parameters used for calling the method FilterLogEvents on the Amazon CloudWatch Logs service. Use the attributes of this class as arguments to method FilterLogEvents.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to FilterLogEvents.

    my $logs = Paws->service('CloudWatchLogs');
    my $FilterLogEventsResponse = $logs->FilterLogEvents(
      LogGroupName        => 'MyLogGroupName',
      EndTime             => 1,                    # OPTIONAL
      FilterPattern       => 'MyFilterPattern',    # OPTIONAL
      Interleaved         => 1,                    # OPTIONAL
      Limit               => 1,                    # OPTIONAL
      LogStreamNamePrefix => 'MyLogStreamName',    # OPTIONAL
      LogStreamNames      => [
        'MyLogStreamName', ...                     # min: 1, max: 512
      ],    # OPTIONAL
      NextToken => 'MyNextToken',    # OPTIONAL
      StartTime => 1,                # OPTIONAL
    );
    # Results:
    my $Events             = $FilterLogEventsResponse->Events;
    my $NextToken          = $FilterLogEventsResponse->NextToken;
    my $SearchedLogStreams = $FilterLogEventsResponse->SearchedLogStreams;
    # Returns a L<Paws::CloudWatchLogs::FilterLogEventsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/logs/FilterLogEvents>

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

The filter pattern to use. For more information, see Filter and Pattern Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).

If not provided, all the events are matched.

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

The maximum number of events to return. The default is 10,000 events.

REQUIRED LogGroupName => Str

The name of the log group to search.

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both "logStreamNamePrefix" and "logStreamNames", but the value for "logStreamNamePrefix" does not match any log stream names specified in "logStreamNames", the action returns an "InvalidParameterException" error.

Filters the results to only logs from the log streams in this list.

If you specify a value for both "logStreamNamePrefix" and "logStreamNames", the action returns an "InvalidParameterException" error.

The token for the next set of events to return. (You received this token from a previous call.)

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

This class forms part of Paws, documenting arguments for method FilterLogEvents in Paws::CloudWatchLogs

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.