CopyDBSnapshot - Amazon Relational Database Service

Description

Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state.

Request Parameters

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

Name Description Required

Name	Description	Required
`SourceDBSnapshotIdentifier`	The identifier for the source DB snapshot. Constraints: Must be the identifier for a valid system snapshot in the "available" state. Example: `rds:mydb-2012-04-02-00-01` Type: String	Yes
`TargetDBSnapshotIdentifier`	The identifier for the copied snapshot. Constraints: Cannot be null, empty, or blank 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: `my-db-snapshot` Type: String	Yes

SourceDBSnapshotIdentifier

The identifier for the source DB snapshot.

Constraints:

Must be the identifier for a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Type: String

Yes

TargetDBSnapshotIdentifier

The identifier for the copied snapshot.

Constraints:

Cannot be null, empty, or blank
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: my-db-snapshot

Type: String

Yes

Response Elements

The following elements come wrapped in a DBSnapshot structure.

Name	Description
`AllocatedStorage`	Specifies the allocated storage size in gigabytes (GB). Type: Integer
`AvailabilityZone`	Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot. Type: String
`DBInstanceIdentifier`	Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from. Type: String
`DBSnapshotIdentifier`	Specifies the identifier for the DB Snapshot. Type: String
`Engine`	Specifies the name of the database engine. Type: String
`EngineVersion`	Specifies the version of the database engine. Type: String
`InstanceCreateTime`	Specifies the time (UTC) when the snapshot was taken. Type: DateTime
`LicenseModel`	License model information for the restored DB Instance. Type: String
`MasterUsername`	Provides the master username for the DB Instance. Type: String
`Port`	Specifies the port that the database engine was listening on at the time of the snapshot. Type: Integer
`SnapshotCreateTime`	Provides the time (UTC) when the snapshot was taken. Type: DateTime
`SnapshotType`	Provides the type of the DB Snapshot. Type: String
`Status`	Specifies the status of this DB Snapshot. Type: String
`VpcId`	Provides the Vpc Id associated with the DB Snapshot. Type: String

Errors

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

Error	Description	HTTP Status Code
`DBSnapshotAlreadyExists`	DBSnapshotIdentifier is already used by an existing snapshot.	400
`DBSnapshotNotFound`	DBSnapshotIdentifier does not refer to an existing DB Snapshot.	404
`InvalidDBSnapshotState`	The state of the DB Security Snapshot does not allow deletion.	400
`SnapshotQuotaExceeded`	Request would result in user exceeding the allowed number of DB Snapshots.	400

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=CopyDBSnapshot
    &SourceDBSnapshotIdentifier=rds:simcoprod01-2012-04-02-00-01
    &TargetDBSnapshotIdentifier=mydbsnapshot
    &Version=2012-04-23
    &SignatureVersion=2&SignatureMethod=HmacSHA256
    &Timestamp=2011-12-12T06%3A27%3A42.551Z
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<CopyDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <CopyDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <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>
  </CopyDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>c4181d1d-8505-11e0-90aa-eb648410240d</RequestId>
  </ResponseMetadata>
</CopyDBSnapshotResponse>