Skip to content

describe_db_snapshot_attributes

Operation

describe_db_snapshot_attributes

describe_db_snapshot_attributes(request: DescribeDBSnapshotAttributesInput | DescribeDBSnapshotAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBSnapshotAttributesInputDict]) -> DescribeDBSnapshotAttributesOutput

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

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes 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 snapshot. If all is included in the list of values for the restore attribute, then the manual DB 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 snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

Parameters:

Name Type Description Default
request DescribeDBSnapshotAttributesInput | DescribeDBSnapshotAttributesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeDBSnapshotAttributesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDBSnapshotAttributesOutput

An instance of DescribeDBSnapshotAttributesOutput.

describe_db_snapshot_attributes async

describe_db_snapshot_attributes(request: DescribeDBSnapshotAttributesInput | DescribeDBSnapshotAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBSnapshotAttributesInputDict]) -> DescribeDBSnapshotAttributesOutput

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

When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes 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 snapshot. If all is included in the list of values for the restore attribute, then the manual DB 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 snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

Parameters:

Name Type Description Default
request DescribeDBSnapshotAttributesInput | DescribeDBSnapshotAttributesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeDBSnapshotAttributesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeDBSnapshotAttributesOutput

An instance of DescribeDBSnapshotAttributesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeDBSnapshotAttributesInputDict

Bases: TypedDict

Dictionary form of DescribeDBSnapshotAttributesInput.

Attributes

db_snapshot_identifier instance-attribute
db_snapshot_identifier: Required[str]

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

DescribeDBSnapshotAttributesInput dataclass

Bases: _SerdeShape

Attributes

db_snapshot_identifier class-attribute instance-attribute
db_snapshot_identifier: str | None = ...

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

Output

DescribeDBSnapshotAttributesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeDBSnapshotAttributesOutput structure.

Attributes

db_snapshot_attributes_result class-attribute instance-attribute
db_snapshot_attributes_result: DBSnapshotAttributesResult | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.