:doc:`DocDB <../../docdb>` / Client / describe_db_cluster_snapshots

*****************************
describe_db_cluster_snapshots
*****************************



.. py:method:: DocDB.Client.describe_db_cluster_snapshots(**kwargs)

  

  Returns information about cluster snapshots. This API operation supports pagination.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshots>`_  


  **Request Syntax**
  ::

    response = client.describe_db_cluster_snapshots(
        DBClusterIdentifier='string',
        DBClusterSnapshotIdentifier='string',
        SnapshotType='string',
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxRecords=123,
        Marker='string',
        IncludeShared=True|False,
        IncludePublic=True|False
    )
    
  :type DBClusterIdentifier: string
  :param DBClusterIdentifier: 

    The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the ``DBClusterSnapshotIdentifier`` parameter. This parameter is not case sensitive.

     

    Constraints:

     

    
    * If provided, must match the identifier of an existing ``DBCluster``.
    

    

  
  :type DBClusterSnapshotIdentifier: string
  :param DBClusterSnapshotIdentifier: 

    A specific cluster snapshot identifier to describe. This parameter can't be used with the ``DBClusterIdentifier`` parameter. This value is stored as a lowercase string.

     

    Constraints:

     

    
    * If provided, must match the identifier of an existing ``DBClusterSnapshot``.
     
    * If this identifier is for an automated snapshot, the ``SnapshotType`` parameter must also be specified.
    

    

  
  :type SnapshotType: string
  :param SnapshotType: 

    The type of cluster snapshots to be returned. You can specify one of the following values:

     

    
    * ``automated`` - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.
     
    * ``manual`` - Return all cluster snapshots that you have manually created for your Amazon Web Services account.
     
    * ``shared`` - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.
     
    * ``public`` - Return all cluster snapshots that have been marked as public.
    

     

    If you don't specify a ``SnapshotType`` value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the ``IncludeShared`` parameter to ``true``. You can include public cluster snapshots with these results by setting the ``IncludePublic`` parameter to ``true``.

     

    The ``IncludeShared`` and ``IncludePublic`` parameters don't apply for ``SnapshotType`` values of ``manual`` or ``automated``. The ``IncludePublic`` parameter doesn't apply when ``SnapshotType`` is set to ``shared``. The ``IncludeShared`` parameter doesn't apply when ``SnapshotType`` is set to ``public``.

    

  
  :type Filters: list
  :param Filters: 

    This parameter is not currently supported.

    

  
    - *(dict) --* 

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

       

      Wildcards are not supported in filters.

      

    
      - **Name** *(string) --* **[REQUIRED]** 

        The name of the filter. Filter names are case sensitive.

        

      
      - **Values** *(list) --* **[REQUIRED]** 

        One or more filter values. Filter values are case sensitive.

        

      
        - *(string) --* 

        
    
    

  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of records to include in the response. If more records exist than the specified ``MaxRecords`` value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

     

    Default: 100

     

    Constraints: Minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

    

  
  :type IncludeShared: boolean
  :param IncludeShared: 

    Set to ``true`` to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise ``false``. The default is ``false``.

    

  
  :type IncludePublic: boolean
  :param IncludePublic: 

    Set to ``true`` to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise ``false``. The default is ``false``.

    

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

    
    ::

      {
          'Marker': 'string',
          'DBClusterSnapshots': [
              {
                  'AvailabilityZones': [
                      'string',
                  ],
                  'DBClusterSnapshotIdentifier': 'string',
                  'DBClusterIdentifier': 'string',
                  'SnapshotCreateTime': datetime(2015, 1, 1),
                  'Engine': 'string',
                  'Status': 'string',
                  'Port': 123,
                  'VpcId': 'string',
                  'ClusterCreateTime': datetime(2015, 1, 1),
                  'MasterUsername': 'string',
                  'EngineVersion': 'string',
                  'SnapshotType': 'string',
                  'PercentProgress': 123,
                  'StorageEncrypted': True|False,
                  'KmsKeyId': 'string',
                  'DBClusterSnapshotArn': 'string',
                  'SourceDBClusterSnapshotArn': 'string',
                  'StorageType': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of  DescribeDBClusterSnapshots.

      
      

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

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by ``MaxRecords``.

        
      

      - **DBClusterSnapshots** *(list) --* 

        Provides a list of cluster snapshots.

        
        

        - *(dict) --* 

          Detailed information about a cluster snapshot.

          
          

          - **AvailabilityZones** *(list) --* 

            Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

            
            

            - *(string) --* 
        
          

          - **DBClusterSnapshotIdentifier** *(string) --* 

            Specifies the identifier for the cluster snapshot.

            
          

          - **DBClusterIdentifier** *(string) --* 

            Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

            
          

          - **SnapshotCreateTime** *(datetime) --* 

            Provides the time when the snapshot was taken, in UTC.

            
          

          - **Engine** *(string) --* 

            Specifies the name of the database engine.

            
          

          - **Status** *(string) --* 

            Specifies the status of this cluster snapshot.

            
          

          - **Port** *(integer) --* 

            Specifies the port that the cluster was listening on at the time of the snapshot.

            
          

          - **VpcId** *(string) --* 

            Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

            
          

          - **ClusterCreateTime** *(datetime) --* 

            Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

            
          

          - **MasterUsername** *(string) --* 

            Provides the master user name for the cluster snapshot.

            
          

          - **EngineVersion** *(string) --* 

            Provides the version of the database engine for this cluster snapshot.

            
          

          - **SnapshotType** *(string) --* 

            Provides the type of the cluster snapshot.

            
          

          - **PercentProgress** *(integer) --* 

            Specifies the percentage of the estimated data that has been transferred.

            
          

          - **StorageEncrypted** *(boolean) --* 

            Specifies whether the cluster snapshot is encrypted.

            
          

          - **KmsKeyId** *(string) --* 

            If ``StorageEncrypted`` is ``true``, the KMS key identifier for the encrypted cluster snapshot.

            
          

          - **DBClusterSnapshotArn** *(string) --* 

            The Amazon Resource Name (ARN) for the cluster snapshot.

            
          

          - **SourceDBClusterSnapshotArn** *(string) --* 

            If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

            
          

          - **StorageType** *(string) --* 

            Storage type associated with your cluster snapshot

             

            For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the *Amazon DocumentDB Developer Guide*.

             

            Valid values for storage type - ``standard | iopt1``

             

            Default value is ``standard``

            
      
    
  
  **Exceptions**
  
  *   :py:class:`DocDB.Client.exceptions.DBClusterSnapshotNotFoundFault`

  