modify_db_snapshot_attribute¶
Operation¶
async
¶
modify_db_snapshot_attribute(input: ModifyDBSnapshotAttributeInput, plugins: list[Plugin] | None = None) -> ModifyDBSnapshotAttributeOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyDBSnapshotAttributeInput
|
An instance of |
required |
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
|
Returns:
| Type | Description |
|---|---|
ModifyDBSnapshotAttributeOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
attribute_name: str | None = ...
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.
class-attribute
instance-attribute
¶
db_snapshot_identifier: str | None = ...
The identifier for the DB snapshot to modify the attributes for.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyDBSnapshotAttributeOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
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.