DocDB / Client / describe_db_cluster_snapshot_attributes

describe_db_cluster_snapshot_attributes

DocDB.Client.describe_db_cluster_snapshot_attributes(**kwargs)

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

See also: AWS API Documentation

Request Syntax

response = client.describe_db_cluster_snapshot_attributes(
    DBClusterSnapshotIdentifier='string'
)

Parameters:

DBClusterSnapshotIdentifier (string) –

[REQUIRED]

The identifier for the cluster snapshot to describe the attributes for.

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterSnapshotAttributesResult': {
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterSnapshotAttributes': [
            {
                'AttributeName': 'string',
                'AttributeValues': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

• (dict) –

  • DBClusterSnapshotAttributesResult (dict) –

    Detailed information about the attributes that are associated with a cluster snapshot.

    • DBClusterSnapshotIdentifier (string) –

      The identifier of the cluster snapshot that the attributes apply to.

    • DBClusterSnapshotAttributes (list) –

      The list of attributes and values for the cluster snapshot.

      • (dict) –

        Contains the name and values of a manual cluster snapshot attribute.

        Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

        • AttributeName (string) –

          The name of the manual cluster snapshot attribute.

          The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.

        • AttributeValues (list) –

          The values for the manual cluster snapshot attribute.

          If the AttributeName field is set to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

          • (string) –

Exceptions

• DocDB.Client.exceptions.DBClusterSnapshotNotFoundFault