:doc:`TimestreamQuery <../../timestream-query>` / Paginator / ListScheduledQueries

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



.. py:class:: TimestreamQuery.Paginator.ListScheduledQueries

  ::

    
    paginator = client.get_paginator('list_scheduled_queries')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/timestream-query-2018-11-01/ListScheduledQueries>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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': [
                {
                    'Arn': 'string',
                    'Name': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'State': 'ENABLED'|'DISABLED',
                    'PreviousInvocationTime': datetime(2015, 1, 1),
                    'NextInvocationTime': datetime(2015, 1, 1),
                    'ErrorReportConfiguration': {
                        'S3Configuration': {
                            'BucketName': 'string',
                            'ObjectKeyPrefix': 'string',
                            'EncryptionOption': 'SSE_S3'|'SSE_KMS'
                        }
                    },
                    'TargetDestination': {
                        'TimestreamDestination': {
                            'DatabaseName': 'string',
                            'TableName': 'string'
                        }
                    },
                    'LastRunStatus': 'AUTO_TRIGGER_SUCCESS'|'AUTO_TRIGGER_FAILURE'|'MANUAL_TRIGGER_SUCCESS'|'MANUAL_TRIGGER_FAILURE'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ScheduledQueries** *(list) --* 

          A list of scheduled queries.

          
          

          - *(dict) --* 

            Scheduled Query

            
            

            - **Arn** *(string) --* 

              The Amazon Resource Name.

              
            

            - **Name** *(string) --* 

              The name of the scheduled query.

              
            

            - **CreationTime** *(datetime) --* 

              The creation time of the scheduled query.

              
            

            - **State** *(string) --* 

              State of scheduled query.

              
            

            - **PreviousInvocationTime** *(datetime) --* 

              The last time the scheduled query was run.

              
            

            - **NextInvocationTime** *(datetime) --* 

              The next time the scheduled query is to be run.

              
            

            - **ErrorReportConfiguration** *(dict) --* 

              Configuration for scheduled query error reporting.

              
              

              - **S3Configuration** *(dict) --* 

                The S3 configuration for the error reports.

                
                

                - **BucketName** *(string) --* 

                  Name of the S3 bucket under which error reports will be created.

                  
                

                - **ObjectKeyPrefix** *(string) --* 

                  Prefix for the error report key. Timestream by default adds the following prefix to the error report path.

                  
                

                - **EncryptionOption** *(string) --* 

                  Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.

                  
            
          
            

            - **TargetDestination** *(dict) --* 

              Target data source where final scheduled query result will be written.

              
              

              - **TimestreamDestination** *(dict) --* 

                Query result destination details for Timestream data source.

                
                

                - **DatabaseName** *(string) --* 

                  Timestream database name.

                  
                

                - **TableName** *(string) --* 

                  Timestream table name.

                  
            
          
            

            - **LastRunStatus** *(string) --* 

              Status of the last scheduled query run.

              
        
      
    