CloudWatchLogs / Paginator / GetScheduledQueryHistory

GetScheduledQueryHistory

class CloudWatchLogs.Paginator.GetScheduledQueryHistory

paginator = client.get_paginator('get_scheduled_query_history')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    identifier='string',
    startTime=123,
    endTime=123,
    executionStatuses=[
        'Running'|'InvalidQuery'|'Complete'|'Failed'|'Timeout',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• identifier (string) –

  [REQUIRED]

  The name or ARN of the scheduled query to retrieve history for.

• startTime (integer) –

  [REQUIRED]

  The start time for the history retrieval window in Unix epoch time.

• endTime (integer) –

  [REQUIRED]

  The end time for the history retrieval window in Unix epoch time.

• executionStatuses (list) –

  Filter results by execution status (Running, Complete, Failed, Timeout, or InvalidQuery).

  • (string) –

• 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

{
    'name': 'string',
    'scheduledQueryArn': 'string',
    'triggerHistory': [
        {
            'queryId': 'string',
            'executionStatus': 'Running'|'InvalidQuery'|'Complete'|'Failed'|'Timeout',
            'triggeredTimestamp': 123,
            'errorMessage': 'string',
            'destinations': [
                {
                    'destinationType': 'S3',
                    'destinationIdentifier': 'string',
                    'status': 'IN_PROGRESS'|'CLIENT_ERROR'|'FAILED'|'COMPLETE',
                    'processedIdentifier': 'string',
                    'errorMessage': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • name (string) –

    The name of the scheduled query.

  • scheduledQueryArn (string) –

    The ARN of the scheduled query.

  • triggerHistory (list) –

    The list of execution history records for the scheduled query.

    • (dict) –

      A record of a scheduled query execution, including its status and destination processing information.

      • queryId (string) –

        The unique identifier for the query execution.

      • executionStatus (string) –

        The status of the query execution (Running, Complete, Failed, Timeout, or InvalidQuery).

      • triggeredTimestamp (integer) –

        The time when the scheduled query was triggered, in Unix epoch time.

      • errorMessage (string) –

        The error message if the scheduled query execution failed. This field is only populated when the execution status indicates a failure.

      • destinations (list) –

        The list of destinations where the scheduled query results were delivered for this execution. This includes S3 buckets configured for the scheduled query.

        • (dict) –

          Information about a destination where scheduled query results are processed and delivered.

          • destinationType (string) –

            The type of destination (S3).

          • destinationIdentifier (string) –

            The destination identifier (S3 URI).

          • status (string) –

            The processing status for this destination (IN_PROGRESS, ERROR, FAILED, or COMPLETE).

          • processedIdentifier (string) –

            The processed identifier returned for the destination (S3 key).

          • errorMessage (string) –

            Error message if the destination processing failed.

  • NextToken (string) –

    A token to resume pagination.