Amazon ElastiCache
API Reference (API Version 2015-02-02)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Allows you to purchase a reserved cache node offering.

Request Parameters

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


The ID of the reserved cache node offering to purchase.

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

Type: String

Required: Yes


The number of cache node instances to reserve.

Default: 1

Type: Integer

Required: No


A customer-specified identifier to track this reservation.


The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

Example: myreservationID

Type: String

Required: No

Response Elements

The following element is returned by the service.


Represents the output of a PurchaseReservedCacheNodesOffering operation.

Type: ReservedCacheNode object


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


Two or more incompatible parameters were specified.

HTTP Status Code: 400


The value for a parameter is invalid.

HTTP Status Code: 400


You already have a reservation with the given identifier.

HTTP Status Code: 404


The request cannot be processed because it would exceed the user's cache node quota.

HTTP Status Code: 400


The requested cache node offering does not exist.

HTTP Status Code: 404



Sample Request ?Action=PurchaseReservedCacheNodesOffering &ReservedCacheNodeId=myreservationID &ReservedCacheNodesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706 &CacheNodeCount=1 &Version=2015-02-02 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &X-Amz-Credential=<credential>

Sample Response

<PurchaseReservedCacheNodesOfferingResponse xmlns=""> <PurchaseReservedCacheNodesOfferingResult> <ReservedCacheNode> <OfferingType>Medium Utilization</OfferingType> <RecurringCharges/> <ProductDescription>memcached</ProductDescription> <ReservedCacheNodesOfferingId> 438012d3-4052-4cc7-b2e3-8d3372e0e706</ReservedCacheNodesOfferingId> <State>payment-pending</State> <ReservedCacheNodeId>myreservationID</ReservedCacheNodeId> <CacheNodeCount>10</CacheNodeCount> <StartTime>2015-02-02T23:24:56.577Z</StartTime> <Duration>31536000</Duration> <FixedPrice>123.0</FixedPrice> <UsagePrice>0.123</UsagePrice> <CacheNodeType>cache.m1.small</CacheNodeType> </ReservedCacheNode> </PurchaseReservedCacheNodesOfferingResult> <ResponseMetadata> <RequestId>7f099901-29cf-11e1-bd06-6fe008f046c3</RequestId> </ResponseMetadata> </PurchaseReservedCacheNodesOfferingResponse>

See Also

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