:doc:`CloudWatchLogs <../../logs>` / Paginator / ListScheduledQueries

********************
ListScheduledQueries
********************



.. py:class:: CloudWatchLogs.Paginator.ListScheduledQueries

  ::

    
    paginator = client.get_paginator('list_scheduled_queries')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudWatchLogs.Client.list_scheduled_queries`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/ListScheduledQueries>`_    


    **Request Syntax**
    ::

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

      Filter scheduled queries by state. Valid values are ``ENABLED`` and ``DISABLED``. If not specified, all scheduled queries are returned.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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) --* 

          An array of scheduled query summary information.

          
          

          - *(dict) --* 

            Summary information about a scheduled query, including basic configuration and execution status.

            
            

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

              
            

            - **lastTriggeredTime** *(integer) --* 

              The timestamp when the scheduled query was last executed.

              
            

            - **lastExecutionStatus** *(string) --* 

              The status of the most recent execution.

              
            

            - **scheduleExpression** *(string) --* 

              The cron expression that defines when the scheduled query runs.

              
            

            - **timezone** *(string) --* 

              The timezone used for evaluating the schedule expression.

              
            

            - **destinationConfiguration** *(dict) --* 

              Configuration for where query results are delivered.

              
              

              - **s3Configuration** *(dict) --* 

                Configuration for delivering query results to Amazon S3.

                
                

                - **destinationIdentifier** *(string) --* 

                  The Amazon S3 URI where query results are delivered. Must be a valid S3 URI format.

                  
                

                - **roleArn** *(string) --* 

                  The ARN of the IAM role that grants permissions to write query results to the specified Amazon S3 destination.

                  
            
          
            

            - **creationTime** *(integer) --* 

              The timestamp when the scheduled query was created.

              
            

            - **lastUpdatedTime** *(integer) --* 

              The timestamp when the scheduled query was last updated.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    