RDS / Client / describe_db_cluster_snapshot_attributes

describe_db_cluster_snapshot_attributes

RDS.Client.describe_db_cluster_snapshot_attributes(**kwargs)

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

When sharing 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 DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

See also: AWS API Documentation

Request Syntax

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

Parameters:

DBClusterSnapshotIdentifier (string) –

[REQUIRED]

The identifier for the DB 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) –

    Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

    Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

    • DBClusterSnapshotIdentifier (string) –

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

    • DBClusterSnapshotAttributes (list) –

      The list of attributes and values for the manual DB cluster snapshot.

      • (dict) –

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

        Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

        • AttributeName (string) –

          The name of the manual DB 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 DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

        • AttributeValues (list) –

          The value(s) for the manual DB 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 DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

          • (string) –

Exceptions

• RDS.Client.exceptions.DBClusterSnapshotNotFoundFault

Examples

This example lists attributes for the specified DB cluster snapshot.

response = client.describe_db_cluster_snapshot_attributes(
    DBClusterSnapshotIdentifier='mydbclustersnapshot',
)

print(response)

Expected Output:

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