:doc:`DocDB <../../docdb>` / Paginator / DescribeDBClusterSnapshots

**************************
DescribeDBClusterSnapshots
**************************



.. py:class:: DocDB.Paginator.DescribeDBClusterSnapshots

  ::

    
    paginator = client.get_paginator('describe_db_cluster_snapshots')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DocDB.Client.describe_db_cluster_snapshots`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DBClusterIdentifier='string',
          DBClusterSnapshotIdentifier='string',
          SnapshotType='string',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          IncludeShared=True|False,
          IncludePublic=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 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``.

      

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

      
      ::

        {
            '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'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output of  DescribeDBClusterSnapshots.

        
        

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

              
        
      
        

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

          A token to resume pagination.

          
    