rds-describe-db-snapshots

Description

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

Syntax

rds-describe-db-snapshots [--db-instance-identifier] value

[--db-snapshot-identifier] value [--max-records ] value [General Options]

Options

Name Description Required

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

--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

Output

The command returns the following information:

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)
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.

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