NAME

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

DESCRIPTION

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.

SYNOPSIS

    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

ATTRIBUTES

EndTime => Int

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.

FilterPattern => Str

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.

Interleaved => Bool

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 will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.

Limit => Int

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

REQUIRED LogGroupName => Str

The name of the log group to search.

LogStreamNamePrefix => Str

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.

LogStreamNames => ArrayRef[Str|Undef]

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.

NextToken => Str

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

StartTime => Int

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.

SEE ALSO

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

BUGS and CONTRIBUTIONS

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