DescribeDBSnapshots - Amazon Relational Database Service

Description

Returns information about DBSnapshots. This API supports pagination.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name	Description	Required
`DBInstanceIdentifier`	A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn't case sensitive. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Type: String	No
`DBSnapshotIdentifier`	A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens If this is the identifier of an automated snapshot, the `SnapshotType` parameter must also be specified. Type: String	No
`Marker`	An optional marker provided in the previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String	No
`MaxRecords`	The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer	No
`SnapshotType`	An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types. Type: String	No

Response Elements

The following elements come wrapped in a DescribeDBSnapshotsResult structure.

Name Description

Name	Description
`DBSnapshots`	A list of DBSnapshot instances. Type: DBSnapshot list
`Marker`	The marker obtained from a previous operation response. Type: String

DBSnapshots

A list of DBSnapshot instances.

Type: DBSnapshot list

Marker

The marker obtained from a previous operation response.

Type: String

Errors

For information about the common errors that all actions use, see Common Errors.

Error	Description	HTTP Status Code
`DBSnapshotNotFound`	DBSnapshotIdentifier does not refer to an existing DB Snapshot.	404

Examples

Sample Request

https://rds.amazon.com/
    ?Action=DescribeDBSnapshots
    &MaxRecords=100
    &Version=2012-04-23
    &Timestamp=2011-05-23T06%3A27%3A42.551Z
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<DescribeDBSnapshotsResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeDBSnapshotsResult>
    <DBSnapshots>
      <DBSnapshot>
        <Port>3306</Port>
        <SnapshotCreateTime>2011-05-23T06:29:03.483Z</SnapshotCreateTime>
        <Engine>mysql</Engine>
        <Status>available</Status>
        <AvailabilityZone>us-east-1a</AvailabilityZone>
        <LicenseModel>general-public-license</LicenseModel>
        <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>
        <AllocatedStorage>10</AllocatedStorage>
        <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>
        <EngineVersion>5.1.50</EngineVersion>
        <DBSnapshotIdentifier>mydbsnapshot</DBSnapshotIdentifier>
        <SnapshotType>manual</SnapshotType>
        <MasterUsername>master</MasterUsername>
      </DBSnapshot>
      <DBSnapshot>
        <Port>3306</Port>
        <SnapshotCreateTime>2011-03-11T07:20:24.082Z</SnapshotCreateTime>
        <Engine>mysql</Engine>
        <Status>available</Status>
        <AvailabilityZone>us-east-1a</AvailabilityZone>
        <LicenseModel>general-public-license</LicenseModel>
        <InstanceCreateTime>2010-08-04T23:27:36.420Z</InstanceCreateTime>
        <AllocatedStorage>50</AllocatedStorage>
        <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
        <EngineVersion>5.1.49</EngineVersion>
        <DBSnapshotIdentifier>mysnapshot1</DBSnapshotIdentifier>
        <SnapshotType>manual</SnapshotType>
        <MasterUsername>sa</MasterUsername>
      </DBSnapshot>
      <DBSnapshot>
        <Port>3306</Port>
        <SnapshotCreateTime>2012-04-02T00:01:24.082Z</SnapshotCreateTime>
        <Engine>mysql</Engine>
        <Status>available</Status>
        <AvailabilityZone>us-east-1d</AvailabilityZone>
        <LicenseModel>general-public-license</LicenseModel>
        <InstanceCreateTime>2010-07-16T00:06:59.107Z</InstanceCreateTime>
        <AllocatedStorage>60</AllocatedStorage>
        <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>
        <EngineVersion>5.1.47</EngineVersion>
        <DBSnapshotIdentifier>rds:simcoprod01-2012-04-02-00-01</DBSnapshotIdentifier>
        <SnapshotType>automated</SnapshotType>
        <MasterUsername>master</MasterUsername>
      </DBSnapshot>
    </DBSnapshots>
  </DescribeDBSnapshotsResult>
  <ResponseMetadata>
    <RequestId>c4191173-8506-11e0-90aa-eb648410240d</RequestId>
  </ResponseMetadata>
</DescribeDBSnapshotsResponse>