:doc:`Redshift <../../redshift>` / Client / describe_snapshot_schedules

***************************
describe_snapshot_schedules
***************************



.. py:method:: Redshift.Client.describe_snapshot_schedules(**kwargs)

  

  Returns a list of snapshot schedules.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeSnapshotSchedules>`_  


  **Request Syntax**
  ::

    response = client.describe_snapshot_schedules(
        ClusterIdentifier='string',
        ScheduleIdentifier='string',
        TagKeys=[
            'string',
        ],
        TagValues=[
            'string',
        ],
        Marker='string',
        MaxRecords=123
    )
    
  :type ClusterIdentifier: string
  :param ClusterIdentifier: 

    The unique identifier for the cluster whose snapshot schedules you want to view.

    

  
  :type ScheduleIdentifier: string
  :param ScheduleIdentifier: 

    A unique identifier for a snapshot schedule.

    

  
  :type TagKeys: list
  :param TagKeys: 

    The key value for a snapshot schedule tag.

    

  
    - *(string) --* 

    

  :type TagValues: list
  :param TagValues: 

    The value corresponding to the key of the snapshot schedule tag.

    

  
    - *(string) --* 

    

  :type Marker: string
  :param Marker: 

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the ``marker`` parameter and retrying the command. If the ``marker`` field is empty, all response records have been retrieved for the request.

    

  
  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified ``MaxRecords`` value, a value is returned in a ``marker`` field of the response. You can retrieve the next set of records by retrying the command with the returned ``marker`` value.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'SnapshotSchedules': [
              {
                  'ScheduleDefinitions': [
                      'string',
                  ],
                  'ScheduleIdentifier': 'string',
                  'ScheduleDescription': 'string',
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ],
                  'NextInvocations': [
                      datetime(2015, 1, 1),
                  ],
                  'AssociatedClusterCount': 123,
                  'AssociatedClusters': [
                      {
                          'ClusterIdentifier': 'string',
                          'ScheduleAssociationState': 'MODIFYING'|'ACTIVE'|'FAILED'
                      },
                  ]
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SnapshotSchedules** *(list) --* 

        A list of SnapshotSchedules.

        
        

        - *(dict) --* 

          Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.

          
          

          - **ScheduleDefinitions** *(list) --* 

            A list of ScheduleDefinitions.

            
            

            - *(string) --* 
        
          

          - **ScheduleIdentifier** *(string) --* 

            A unique identifier for the schedule.

            
          

          - **ScheduleDescription** *(string) --* 

            The description of the schedule.

            
          

          - **Tags** *(list) --* 

            An optional set of tags describing the schedule.

            
            

            - *(dict) --* 

              A tag consisting of a name/value pair for a resource.

              
              

              - **Key** *(string) --* 

                The key, or name, for the resource tag.

                
              

              - **Value** *(string) --* 

                The value for the resource tag.

                
          
        
          

          - **NextInvocations** *(list) --* 
            

            - *(datetime) --* 
        
          

          - **AssociatedClusterCount** *(integer) --* 

            The number of clusters associated with the schedule.

            
          

          - **AssociatedClusters** *(list) --* 

            A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

            
            

            - *(dict) --* 
              

              - **ClusterIdentifier** *(string) --* 
              

              - **ScheduleAssociationState** *(string) --* 
          
        
      
    
      

      - **Marker** *(string) --* 

        A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the ``marker`` parameter and retrying the command. If the ``marker`` field is empty, all response records have been retrieved for the request.

        
  