PurchaseReservedDBInstancesOffering - Amazon Relational Database Service

Description

Purchases a reserved DB Instance offering.

Request Parameters

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

Name Description Required

Name	Description	Required
`DBInstanceCount`	The number of instances to reserve. Default: `1` Type: Integer	No
`ReservedDBInstanceId`	Customer-specified identifier to track this reservation. Example: myreservationID Type: String	No
`ReservedDBInstancesOfferingId`	The ID of the Reserved DB Instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706 Type: String	Yes

DBInstanceCount

The number of instances to reserve.

Default: 1

Type: Integer

No

ReservedDBInstanceId

Customer-specified identifier to track this reservation.

Example: myreservationID

Type: String

No

ReservedDBInstancesOfferingId

The ID of the Reserved DB Instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

Type: String

Yes

Response Elements

The following elements come wrapped in a ReservedDBInstance structure.

Name	Description
`CurrencyCode`	The currency code for the reserved DB Instance. Type: String
`DBInstanceClass`	The DB instance class for the reserved DB Instance. Type: String
`DBInstanceCount`	The number of reserved DB Instances. Type: Integer
`Duration`	The duration of the reservation in seconds. Type: Integer
`FixedPrice`	The fixed price charged for this reserved DB Instance. Type: Double
`MultiAZ`	Indicates if the reservation applies to Multi-AZ deployments. Type: Boolean
`OfferingType`	The offering type of this reserved DB Instance. Type: String
`ProductDescription`	The description of the reserved DB Instance. Type: String
`RecurringCharges`	The recurring price charged to run this reserved DB Instance. Type: RecurringCharge list
`ReservedDBInstanceId`	The unique identifier for the reservation. Type: String
`ReservedDBInstancesOfferingId`	The offering identifier. Type: String
`StartTime`	The time the reservation started. Type: DateTime
`State`	The state of the reserved DB Instance. Type: String
`UsagePrice`	The hourly price charged for this reserved DB Instance. Type: Double

Errors

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

Error	Description	HTTP Status Code
`ReservedDBInstanceAlreadyExists`	User already has a reservation with the given identifier.	404
`ReservedDBInstanceQuotaExceeded`	Request would exceed the user's DB Instance quota.	400
`ReservedDBInstancesOfferingNotFound`	Specified offering does not exist.	404

Examples

Sample Request

https://rds.amazonaws.com/
   ?Action=PurchaseReservedDBInstancesOffering
   &ReservedDBInstanceId=myreservationID
   &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706
   &DBInstanceCount=1
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &Timestamp=2011-05-10T18%3A31%3A36.118Z
   &AWSAccessKeyId=<AWS Access Key ID>
   &Signature=<Signature>

Sample Response

<PurchaseReservedDBInstancesOfferingResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <PurchaseReservedDBInstancesOfferingResult>
    <ReservedDBInstance>
      <OfferingType>Medium Utilization</OfferingType>
      <CurrencyCode>USD</CurrencyCode>
      <RecurringCharges/>
      <ProductDescription>mysql</ProductDescription>
      <ReservedDBInstancesOfferingId> 438012d3-4052-4cc7-b2e3-8d3372e0e706</ReservedDBInstancesOfferingId>
      <MultiAZ>true</MultiAZ>
      <State>payment-pending</State>
      <ReservedDBInstanceId>myreservationID</ReservedDBInstanceId>
      <DBInstanceCount>10</DBInstanceCount>
      <StartTime>2011-12-18T23:24:56.577Z</StartTime>
      <Duration>31536000</Duration>
      <FixedPrice>123.0</FixedPrice>
      <UsagePrice>0.123</UsagePrice>
      <DBInstanceClass>db.m1.small</DBInstanceClass>
    </ReservedDBInstance>
  </PurchaseReservedDBInstancesOfferingResult>
  <ResponseMetadata>
    <RequestId>7f099901-29cf-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</PurchaseReservedDBInstancesOfferingResponse>