Returns information about DB snapshots. This API action supports pagination.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-db-snapshots
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: DBSnapshots
describe-db-snapshots
[--db-instance-identifier <value>]
[--db-snapshot-identifier <value>]
[--snapshot-type <value>]
[--filters <value>]
[--include-shared | --no-include-shared]
[--include-public | --no-include-public]
[--dbi-resource-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--db-instance-identifier
(string)
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can’t be used in conjunction with
DBSnapshotIdentifier
. This parameter isn’t case-sensitive.Constraints:
If supplied, must match the identifier of an existing DBInstance.
--db-snapshot-identifier
(string)
A specific DB snapshot identifier to describe. This parameter can’t be used in conjunction with
DBInstanceIdentifier
. This value is stored as a lowercase string.Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
--snapshot-type
(string)
The type of snapshots to be returned. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
manual
- Return all DB snapshots that have been taken by my Amazon Web Services account.
shared
- Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public
- Return all DB snapshots that have been marked as public.
awsbackup
- Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ Theawsbackup
type does not apply to Aurora.If you don’t specify a
SnapshotType
value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling theIncludeShared
parameter. You can include public snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don’t apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn’t apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn’t apply whenSnapshotType
is set topublic
.
--filters
(list)
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id
- Accepts DB snapshot identifiers.
dbi-resource-id
- Accepts identifiers of source DB instances.
snapshot-type
- Accepts types of DB snapshots.
engine
- Accepts names of database engines.(structure)
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Name -> (string)
The name of the filter. Filter names are case-sensitive.
Values -> (list)
One or more filter values. Filter values are case-sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--include-shared
| --no-include-shared
(boolean)
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the
ModifyDBSnapshotAttribute
API action.This setting doesn’t apply to RDS Custom.
--include-public
| --no-include-public
(boolean)
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn’t apply to RDS Custom.
--dbi-resource-id
(string)
A specific DB resource ID to describe.
--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
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
Example 1: To describe a DB snapshot for a DB instance
The following describe-db-snapshots
example retrieves the details of a DB snapshot for a DB instance.
aws rds describe-db-snapshots \
--db-snapshot-identifier mydbsnapshot
Output:
{
"DBSnapshots": [
{
"DBSnapshotIdentifier": "mydbsnapshot",
"DBInstanceIdentifier": "mysqldb",
"SnapshotCreateTime": "2018-02-08T22:28:08.598Z",
"Engine": "mysql",
"AllocatedStorage": 20,
"Status": "available",
"Port": 3306,
"AvailabilityZone": "us-east-1f",
"VpcId": "vpc-6594f31c",
"InstanceCreateTime": "2018-02-08T22:24:55.973Z",
"MasterUsername": "mysqladmin",
"EngineVersion": "5.6.37",
"LicenseModel": "general-public-license",
"SnapshotType": "manual",
"OptionGroupName": "default:mysql-5-6",
"PercentProgress": 100,
"StorageType": "gp2",
"Encrypted": false,
"DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot",
"IAMDatabaseAuthenticationEnabled": false,
"ProcessorFeatures": [],
"DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE"
}
]
}
For more information, see Creating a DB Snapshot in the Amazon RDS User Guide.
Example 2: To find the number of manual snapshots taken
The following describe-db-snapshots
example uses the length
operator in the --query
option to return the number of manual snapshots that have been taken in a particular AWS Region.
aws rds describe-db-snapshots \
--snapshot-type manual \
--query "length(*[].{DBSnapshots:SnapshotType})" \
--region eu-central-1
Output:
35
For more information, see Creating a DB Snapshot in the Amazon RDS User Guide.
Marker -> (string)
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBSnapshots -> (list)
A list of
DBSnapshot
instances.(structure)
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.DBSnapshotIdentifier -> (string)
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier -> (string)
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime -> (timestamp)
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine -> (string)
Specifies the name of the database engine.
AllocatedStorage -> (integer)
Specifies the allocated storage size in gibibytes (GiB).
Status -> (string)
Specifies the status of this DB snapshot.
Port -> (integer)
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone -> (string)
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId -> (string)
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime -> (timestamp)
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername -> (string)
Provides the master username for the DB snapshot.
EngineVersion -> (string)
Specifies the version of the database engine.
LicenseModel -> (string)
License model information for the restored DB instance.
SnapshotType -> (string)
Provides the type of the DB snapshot.
Iops -> (integer)
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName -> (string)
Provides the option group name for the DB snapshot.
PercentProgress -> (integer)
The percentage of the estimated data that has been transferred.
SourceRegion -> (string)
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier -> (string)
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType -> (string)
Specifies the storage type associated with DB snapshot.
TdeCredentialArn -> (string)
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted -> (boolean)
Specifies whether the DB snapshot is encrypted.
KmsKeyId -> (string)
If
Encrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn -> (string)
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone -> (string)
The time zone of the DB snapshot. In most cases, the
Timezone
element is empty.Timezone
content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.IAMDatabaseAuthenticationEnabled -> (boolean)
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
ProcessorFeatures -> (list)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
(structure)
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the
coreCount
feature name for theName
parameter. To specify the number of threads per core, use thethreadsPerCore
feature name for theName
parameter.You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstance
ModifyDBInstance
RestoreDBInstanceFromDBSnapshot
RestoreDBInstanceFromS3
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the
DescribeOrderableDBInstanceOptions
action and specifying the instance class for theDBInstanceClass
parameter.In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstances
DescribeDBSnapshots
DescribeValidDBInstanceModifications
If you call
DescribeDBInstances
,ProcessorFeature
returns non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name -> (string)
The name of the processor feature. Valid names are
coreCount
andthreadsPerCore
.Value -> (string)
The value of a processor feature name.
DbiResourceId -> (string)
The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.
TagList -> (list)
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).OriginalSnapshotCreateTime -> (timestamp)
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn’t change when the snapshot is copied.