CloudWatchLogs / Client / filter_log_events

filter_log_events#

CloudWatchLogs.Client.filter_log_events(**kwargs)#

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

You must have the logs:FilterLogEvents permission to perform this operation.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can’t include both.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the events found within the specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Request Syntax

response = client.filter_log_events(
    logGroupName='string',
    logGroupIdentifier='string',
    logStreamNames=[
        'string',
    ],
    logStreamNamePrefix='string',
    startTime=123,
    endTime=123,
    filterPattern='string',
    nextToken='string',
    limit=123,
    interleaved=True|False,
    unmask=True|False
)

Parameters:

logGroupName (string) –
The name of the log group to search.

Note
You must include either logGroupIdentifier or logGroupName, but not both.
logGroupIdentifier (string) –
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

Note
You must include either logGroupIdentifier or logGroupName, but not both.
logStreamNames (list) –
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.
- (string) –
logStreamNamePrefix (string) –
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.
startTime (integer) – 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.
endTime (integer) – 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 (string) –
The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.
nextToken (string) – The token for the next set of events to return. (You received this token from a previous call.)
limit (integer) – The maximum number of events to return. The default is 10,000 events.
interleaved (boolean) –
If the value is true, the operation attempts 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.

Important As of 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.
unmask (boolean) –
Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Return type:

dict

Returns:

Response Syntax

{
    'events': [
        {
            'logStreamName': 'string',
            'timestamp': 123,
            'message': 'string',
            'ingestionTime': 123,
            'eventId': 'string'
        },
    ],
    'searchedLogStreams': [
        {
            'logStreamName': 'string',
            'searchedCompletely': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- events (list) –
  
  The matched events.
  - (dict) –
    
    Represents a matched event.
    - logStreamName (string) –
      
      The name of the log stream to which this event belongs.
    - timestamp (integer) –
      
      The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
    - message (string) –
      
      The data contained in the log event.
    - ingestionTime (integer) –
      
      The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
    - eventId (string) –
      
      The ID of the event.
- searchedLogStreams (list) –
  
  Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.
  
  Indicates which log streams have been searched and whether each has been searched completely.
  - (dict) –
    
    Represents the search status of a log stream.
    - logStreamName (string) –
      
      The name of the log stream.
    - searchedCompletely (boolean) –
      
      Indicates whether all the events in this log stream were searched.
- nextToken (string) –
  
  The token to use when requesting the next set of items. The token expires after 24 hours.

Exceptions

CloudWatchLogs.Client.exceptions.InvalidParameterException
CloudWatchLogs.Client.exceptions.ResourceNotFoundException
CloudWatchLogs.Client.exceptions.ServiceUnavailableException