CloudWatchLogs / Paginator / ListScheduledQueries

ListScheduledQueries¶

class CloudWatchLogs.Paginator.ListScheduledQueries¶

paginator = client.get_paginator('list_scheduled_queries')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    state='ENABLED'|'DISABLED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

state (string) – Filter results by the state of scheduled queries (ENABLED or DISABLED).
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

{
    'scheduledQueries': [
        {
            'scheduledQueryArn': 'string',
            'name': 'string',
            'state': 'ENABLED'|'DISABLED',
            'lastTriggeredTime': 123,
            'lastExecutionStatus': 'Running'|'InvalidQuery'|'Complete'|'Failed'|'Timeout',
            'scheduleExpression': 'string',
            'timezone': 'string',
            'destinationConfiguration': {
                's3Configuration': {
                    'destinationIdentifier': 'string',
                    'roleArn': 'string'
                }
            },
            'creationTime': 123,
            'lastUpdatedTime': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- scheduledQueries (list) –
  
  The list of scheduled queries with summary information.
  - (dict) –
    
    Summary information about a scheduled query, used in list operations.
    - scheduledQueryArn (string) –
      
      The ARN of the scheduled query.
    - name (string) –
      
      The name of the scheduled query.
    - state (string) –
      
      The current state of the scheduled query (ENABLED or DISABLED).
    - lastTriggeredTime (integer) –
      
      The time when the scheduled query was last executed.
    - lastExecutionStatus (string) –
      
      The status of the last execution (Running, Complete, Failed, Timeout, or InvalidQuery).
    - scheduleExpression (string) –
      
      The cron expression that defines when the scheduled query runs.
    - timezone (string) –
      
      The timezone in which the schedule expression is evaluated.
    - destinationConfiguration (dict) –
      
      Configuration for destinations where the query results are delivered.
      - s3Configuration (dict) –
        
        Configuration for delivering query results to an Amazon S3 bucket.
        
        destinationIdentifier (string) –
        
        The S3 URI where query results will be stored (e.g., s3://bucket-name/prefix/).
        
        roleArn (string) –
        
        The ARN of the IAM role that CloudWatch Logs will assume to write results to the S3 bucket.
    - creationTime (integer) –
      
      The time when the scheduled query was created.
    - lastUpdatedTime (integer) –
      
      The time when the scheduled query was last updated.
- NextToken (string) –
  
  A token to resume pagination.