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

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 ARN or name of the scheduled query to retrieve history for.
startTime (integer) –
[REQUIRED]

The start time for the history query in Unix epoch format.
endTime (integer) –
[REQUIRED]

The end time for the history query in Unix epoch format.
executionStatuses (list) –
An array of execution statuses to filter the history results. Only executions with the specified statuses are returned.
- (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) –
  
  An array of execution history records for the scheduled query.
  - (dict) –
    
    A record of a scheduled query execution, including execution status, timestamp, and destination processing results.
    - queryId (string) –
      
      The unique identifier for this query execution.
    - executionStatus (string) –
      
      The execution status of the scheduled query run.
    - triggeredTimestamp (integer) –
      
      The timestamp when the scheduled query execution was triggered.
    - errorMessage (string) –
      
      Error message if the query execution failed.
    - destinations (list) –
      
      Information about destination processing for this query execution.
      - (dict) –
        
        Information about a destination where scheduled query results are processed, including processing status and any error messages.
        
        destinationType (string) –
        
        The type of destination for query results.
        
        destinationIdentifier (string) –
        
        The identifier for the destination where results are delivered.
        
        status (string) –
        
        The processing status of the destination delivery.
        
        processedIdentifier (string) –
        
        The identifier of the processed result at the destination.
        
        errorMessage (string) –
        
        Error message if destination processing failed.
- NextToken (string) –
  
  A token to resume pagination.