RDS / Client / describe_db_cluster_snapshots

describe_db_cluster_snapshots

RDS.Client.describe_db_cluster_snapshots(**kwargs)

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

See also: AWS API Documentation

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
)

Parameters:

• DBClusterIdentifier (string) –

  The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can’t be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn’t case-sensitive.

  Constraints:

  • If supplied, must match the identifier of an existing DBCluster.

• DBClusterSnapshotIdentifier (string) –

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

  Constraints:

  • If supplied, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

• SnapshotType (string) –

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

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

  • manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

  • shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

  • public - Return all DB cluster snapshots that have been marked as public.

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

  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.

• Filters (list) –

  A filter that specifies one or more DB cluster snapshots to describe.

  Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

  • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

  • snapshot-type - Accepts types of DB cluster snapshots.

  • engine - Accepts names of database engines.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribePendingMaintenanceActions

    • 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) –

• MaxRecords (integer) –

  The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• Marker (string) – An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

• IncludeShared (boolean) –

  A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

  You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

• IncludePublic (boolean) –

  A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

  You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'DBClusterSnapshots': [
        {
            'AvailabilityZones': [
                'string',
            ],
            'DBClusterSnapshotIdentifier': 'string',
            'DBClusterIdentifier': 'string',
            'SnapshotCreateTime': datetime(2015, 1, 1),
            'Engine': 'string',
            'EngineMode': 'string',
            'AllocatedStorage': 123,
            'Status': 'string',
            'Port': 123,
            'VpcId': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1),
            'MasterUsername': 'string',
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'SnapshotType': 'string',
            'PercentProgress': 123,
            'StorageEncrypted': True|False,
            'KmsKeyId': 'string',
            'DBClusterSnapshotArn': 'string',
            'SourceDBClusterSnapshotArn': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'DBSystemId': 'string',
            'StorageType': 'string'
        },
    ]
}

Response Structure

• (dict) –

  Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

  • Marker (string) –

    An optional pagination token provided by a previous DescribeDBClusterSnapshots 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 DB cluster snapshots for the user.

    • (dict) –

      Contains the details for an Amazon RDS DB cluster snapshot

      This data type is used as a response element in the DescribeDBClusterSnapshots action.

      • AvailabilityZones (list) –

        Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

        • (string) –

      • DBClusterSnapshotIdentifier (string) –

        Specifies the identifier for the DB cluster snapshot.

      • DBClusterIdentifier (string) –

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

      • SnapshotCreateTime (datetime) –

        Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

      • Engine (string) –

        Specifies the name of the database engine for this DB cluster snapshot.

      • EngineMode (string) –

        Provides the engine mode of the database engine for this DB cluster snapshot.

      • AllocatedStorage (integer) –

        Specifies the allocated storage size in gibibytes (GiB).

      • Status (string) –

        Specifies the status of this DB cluster snapshot. Valid statuses are the following:

        • available

        • copying

        • creating

      • Port (integer) –

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

      • VpcId (string) –

        Provides the VPC ID associated with the DB cluster snapshot.

      • ClusterCreateTime (datetime) –

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

      • MasterUsername (string) –

        Provides the master username for this DB cluster snapshot.

      • EngineVersion (string) –

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

      • LicenseModel (string) –

        Provides the license model information for this DB cluster snapshot.

      • SnapshotType (string) –

        Provides the type of the DB cluster snapshot.

      • PercentProgress (integer) –

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

      • StorageEncrypted (boolean) –

        Specifies whether the DB cluster snapshot is encrypted.

      • KmsKeyId (string) –

        If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

        The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

      • DBClusterSnapshotArn (string) –

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

      • SourceDBClusterSnapshotArn (string) –

        If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

      • IAMDatabaseAuthenticationEnabled (boolean) –

        True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      • TagList (list) –

        A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • (dict) –

          Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

          For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

          • Key (string) –

            A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

          • Value (string) –

            A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

      • DBSystemId (string) –

        Reserved for future use.

      • StorageType (string) –

        The storage type associated with the DB cluster snapshot.

        This setting is only for Aurora DB clusters.

Exceptions

• RDS.Client.exceptions.DBClusterSnapshotNotFoundFault

Examples

This example lists settings for the specified, manually-created cluster snapshot.

response = client.describe_db_cluster_snapshots(
    DBClusterSnapshotIdentifier='mydbclustersnapshot',
    SnapshotType='manual',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}