RDS / Client / modify_db_snapshot_attribute

modify_db_snapshot_attribute

RDS.Client.modify_db_snapshot_attribute(**kwargs)

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.

Note

Don’t add the all value for any manual DB snapshots that contain private information that you don’t want available to all Amazon Web Services accounts.

If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can’t use all as a value for that parameter in this case.

To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.

See also: AWS API Documentation

Request Syntax

response = client.modify_db_snapshot_attribute(
    DBSnapshotIdentifier='string',
    AttributeName='string',
    ValuesToAdd=[
        'string',
    ],
    ValuesToRemove=[
        'string',
    ]
)
Parameters:

  • DBSnapshotIdentifier (string) –

    [REQUIRED]

    The identifier for the DB snapshot to modify the attributes for.

  • AttributeName (string) –

    [REQUIRED]

    The name of the DB snapshot attribute to modify.

    To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore.

    Note

    To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.

  • ValuesToAdd (list) –

    A list of DB snapshot attributes to add to the attribute specified by AttributeName.

    To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don’t want available to all Amazon Web Services accounts.

    • (string) –

  • ValuesToRemove (list) –

    A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

    To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshotAttributesResult': {
        'DBSnapshotIdentifier': 'string',
        'DBSnapshotAttributes': [
            {
                'AttributeName': 'string',
                'AttributeValues': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) –

    • DBSnapshotAttributesResult (dict) –

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

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

      • DBSnapshotIdentifier (string) –

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

      • DBSnapshotAttributes (list) –

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

        • (dict) –

          Contains the name and values of a manual DB snapshot attribute

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

          • AttributeName (string) –

            The name of the manual DB 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 ModifyDBSnapshotAttribute API action.

          • AttributeValues (list) –

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

            • (string) –

Exceptions

  • RDS.Client.exceptions.DBSnapshotNotFoundFault

  • RDS.Client.exceptions.InvalidDBSnapshotStateFault

  • RDS.Client.exceptions.SharedSnapshotQuotaExceededFault

Examples

This example adds the specified attribute for the specified DB snapshot.

response = client.modify_db_snapshot_attribute(
    AttributeName='restore',
    DBSnapshotIdentifier='mydbsnapshot',
    ValuesToAdd=[
        'all',
    ],
)

print(response)

Expected Output:

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