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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-db-snapshot-attributes
--db-snapshot-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-snapshot-identifier
(string)
The identifier for the DB snapshot to describe the attributes for.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe the attribute names and values for a DB snapshot
The following describe-db-snapshot-attributes
example describes the attribute names and values for a DB snapshot.
aws rds describe-db-snapshot-attributes \
--db-snapshot-identifier mydbsnapshot
Output:
{
"DBSnapshotAttributesResult": {
"DBSnapshotIdentifier": "mydbsnapshot",
"DBSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789012",
"210987654321"
]
}
]
}
}
For more information, see Sharing a DB Snapshot in the Amazon RDS User Guide.
DBSnapshotAttributesResult -> (structure)
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.
(structure)
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 theModifyDBSnapshotAttribute
API action.AttributeValues -> (list)
The value or values for the manual DB snapshot attribute.
If the
AttributeName
field is set torestore
, 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 ofall
is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.(string)