CloudWatchLogs / Client / get_log_events

get_log_events

CloudWatchLogs.Client.get_log_events(**kwargs)

Lists log events from the specified log stream. You can list all of the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation can return empty results while there are more log events available through the token.

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_log_events(
    logGroupName='string',
    logGroupIdentifier='string',
    logStreamName='string',
    startTime=123,
    endTime=123,
    nextToken='string',
    limit=123,
    startFromHead=True|False,
    unmask=True|False
)

Parameters:

• logGroupName (string) –

  The name of the log group.

  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 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.

• logStreamName (string) –

  [REQUIRED]

  The name of the log stream.

• 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 equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

• 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 equal to or later than this time are not included.

• nextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

• limit (integer) – The maximum number of log events returned. If you don’t specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

• startFromHead (boolean) –

  If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

  If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

• 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': [
        {
            'timestamp': 123,
            'message': 'string',
            'ingestionTime': 123
        },
    ],
    'nextForwardToken': 'string',
    'nextBackwardToken': 'string'
}

Response Structure

• (dict) –

  • events (list) –

    The events.

    • (dict) –

      Represents a log event.

      • 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.

  • nextForwardToken (string) –

    The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it returns the same token you passed in.

  • nextBackwardToken (string) –

    The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in.

Exceptions

• CloudWatchLogs.Client.exceptions.InvalidParameterException

• CloudWatchLogs.Client.exceptions.ResourceNotFoundException

• CloudWatchLogs.Client.exceptions.ServiceUnavailableException