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

ModifyDBSnapshot

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBSnapshotIdentifier

The identifier of the DB snapshot to modify.

Type: String

Required: Yes

EngineVersion

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

  • 5.5.46 (supported for 5.1 DB snapshots)

Oracle

  • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

  • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

  • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

Type: String

Required: No

OptionGroupName

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations.

Type: String

Required: No

Response Elements

The following element is returned by the service.

DBSnapshot

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

Type: DBSnapshot object

Errors

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

DBSnapshotNotFound

DBSnapshotIdentifier does not refer to an existing DB snapshot.

HTTP Status Code: 404

Example

Sample Request

https://rds.us-west-2.amazonaws.com/
	?Action=ModifyDBSnapshot
	&DBSnapshotIdentifier=mysnapshot1	
	&EngineVersion=5.5.46
	&SignatureMethod=HmacSHA256
	&SignatureVersion=4
	&Version=2014-10-31
	&X-Amz-Algorithm=AWS4-HMAC-SHA256
	&X-Amz-Credential=AKIADQKE4SARGYLE/20161228/us-west-2/rds/aws4_request
	&X-Amz-Date=20161228T220515Z
	&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
	&X-Amz-Signature=eb44f1ce3dab4e1dbf113d8d2a265d88d17ece1999ffd36be85714ed36cbdbe3

Sample Response


<ModifyDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <OptionGroupName>default:mysql-5-5</OptionGroupName>
      <Engine>mysql</Engine>
      <Status>available</Status>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.5.46</EngineVersion>
      <DBInstanceIdentifier>mysqldb-sample</DBInstanceIdentifier>
      <DBSnapshotIdentifier>mysnapshot1</DBSnapshotIdentifier>
      <AvailabilityZone>us-west-2b</AvailabilityZone>
      <InstanceCreateTime>2016-12-28T22:24:26.573Z</InstanceCreateTime>
      <PercentProgress>100</PercentProgress>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBSnapshot>
  </ModifyDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>aa80a25a-af09-11d4-ed11-23c32f9aa7d3</RequestId>
  </ResponseMetadata>
</ModifyDBSnapshotResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: