CloudWatchLogs / Paginator / DescribeLogStreams

DescribeLogStreams

class CloudWatchLogs.Paginator.DescribeLogStreams

paginator = client.get_paginator('describe_log_streams')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_log_streams().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    logGroupName='string',
    logGroupIdentifier='string',
    logStreamNamePrefix='string',
    orderBy='LogStreamName'|'LastEventTime',
    descending=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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

• logStreamNamePrefix (string) –

  The prefix to match.

  If orderBy is LastEventTime, you cannot specify this parameter.

• orderBy (string) –

  If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

  If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

  lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

• descending (boolean) – If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'logStreams': [
        {
            'logStreamName': 'string',
            'creationTime': 123,
            'firstEventTimestamp': 123,
            'lastEventTimestamp': 123,
            'lastIngestionTime': 123,
            'uploadSequenceToken': 'string',
            'arn': 'string',
            'storedBytes': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • logStreams (list) –

    The log streams.

    • (dict) –

      Represents a log stream, which is a sequence of log events from a single emitter of logs.

      • logStreamName (string) –

        The name of the log stream.

      • creationTime (integer) –

        The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

      • firstEventTimestamp (integer) –

        The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

      • lastEventTimestamp (integer) –

        The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

      • lastIngestionTime (integer) –

        The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.

      • uploadSequenceToken (string) –

        The sequence token.

        Warning

        The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don’t need to obtain uploadSequenceToken to use a PutLogEvents action.

      • arn (string) –

        The Amazon Resource Name (ARN) of the log stream.

      • storedBytes (integer) –

        The number of bytes stored.

        Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

  • NextToken (string) –

    A token to resume pagination.