Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

rds-describe-db-snapshots

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

Returns information about the DB snapshots for this account. If you pass in a db-instance-identifier, it will return information only about DB snapshots taken for that instance. If you pass in a db-snapshot-identifier, it will return information only about the specified DB snapshot. If you omit both db-instance-identifier and db-snapshot-identifier, it will return all snapshot information for all instances, up to max-records. Passing both db-instance-identifier and db-snapshot-identifier will result in an error.

Syntax

rds-describe-db-snapshots

[-i (--db-instance-identifier)value]

[-s (--db-snapshot-identifier) value]

[-t (--snapshot-type) value]

[General Options]

Options

Name Description Required

--db-instance-identifier value

-i value

The unique identifier for the DB instance.

Type: String

Default: None

Constraints: Must contain 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.

Example: --db-instance-identifier mydbinstance

No

--db-snapshot-identifier value

-s value

The unique identifier for the DB snapshot. Stored as a lowercase string.

Type: String

Default: None

Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.

Example: --db-snapshot-identifier m1233123-123

No

--snapshot-type value

-t value

The type of DB snapshot. Valid values include "manual" and "automated." If no value is provided, all snapshot types will be returned.

Type: String

Default: None

Example: --snapshot-type manual

No

Output

The command returns the following information:

Note

Output values list the possible values returned by CLI commands. Not all values are returned for every call to a command. If a value is null or empty, it will not be included in the command output. For example, CLI commands to create or restore a DB instance will not return the Endpoint Address value because that value is null until the DB instance has finished being created or restored.

  • DBSnapshotId—Name of the DB snapshot

  • Snapshot Created—The time (UTC) when the DB snapshot was taken

  • DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB instance

  • Instance Created—The date and time when the DB instance was created

  • Engine—The name of the database engine used

  • Storage—The size of the DB snapshot's allocated storage (GB)

  • Iops—The provisioned storage IOPS, expressed as I/O operations per second.

  • Storage Type—The storage type of the DB snapshot

  • Encrypted—Indicates whether the DB snapshot is encrypted

  • KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB snapshot

  • Status—Status of the DB snapshot. Valid values: creating | available | deleting

  • Master Username—The login name of the database's master user

  • AZ—The original Availability Zone of the database from which the DB snapshot was taken. This column appears only in the --show-long view

  • Port—The original port of the database from which the DB snapshot was taken. This column appears only in the --show-long view

  • EngineVersion—Database engine version number.

Examples

Get a Description of All Database Snapshots

This example returns a description of all DB snapshots for the account, with column headers.

Copy
PROMPT> rds-describe-db-snapshots -H DBSNAPSHOT DBSnapshotId Snapshot Created DBInstanceId Instance Created Engine Storage Status Master Username Version DBSNAPSHOT mysnapshot1 mydbinstance 2010-08-04T23:27:36.420Z mysql 50 creating sa 5.1.49 DBSNAPSHOT mysnapshot2 2010-08-05T00:15:51.815Z simcoprod01 2010-07-16T00:06:59.107Z mysql 60 available master 5.1.47