Amazon ElastiCache
API Reference (API Version 2012-11-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

DescribeReservedCacheNodes

Description

Returns information about reserved Cache Nodes for this account, or about a specified reserved Cache Node.

Request Parameters

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

CacheNodeType

The Cache Node type filter value. Specify this parameter to show only those reservations matching the specified Cache Nodes type.

Type: String

Required: No

Duration

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Type: String

Required: No

Marker

The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

Type: Integer

Required: No

OfferingType

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization"

Type: String

Required: No

ProductDescription

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Type: String

Required: No

ReservedCacheNodeId

The reserved Cache Node identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

Type: String

Required: No

ReservedCacheNodesOfferingId

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Type: String

Required: No

Response Elements

The following elements are returned in a DescribeReservedCacheNodesResult structure.

Marker

The marker provided for paginated results.

Type: String

ReservedCacheNodes

A list of of reserved Cache Nodes.

Type: ReservedCacheNode list

Errors

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

InvalidParameterCombination

HTTP Status Code: 400

InvalidParameterValue

HTTP Status Code: 400

ReservedCacheNodeNotFound

The specified reserved Cache Node not found.

HTTP Status Code: 404

Examples

Sample Request

https://elasticache.amazonaws.com/
   ?Action=DescribeReservedCacheNodes
   &ReservedCacheNodeId=customerSpecifiedID
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &Timestamp=2012-12-18T18%3A31%3A36.118Z
   &AWSAccessKeyId=<AWS Access Key ID>
   &Signature=<Signature>

Sample Response

<DescribeReservedCacheNodesResponse xmlns="http://elasticache.amazonaws.com/doc/2012-11-15/">
  <DescribeReservedCacheNodesResult>
    <ReservedCacheNodes>
      <ReservedCacheNode>
        <OfferingType>Medium Utilization</OfferingType>
        <RecurringCharges/>
        <ProductDescription>memcached</ProductDescription>
        <ReservedCacheNodesOfferingId>649fd0c8-cf6d-47a0-bfa6-060f8e75e95f</ReservedCacheNodesOfferingId>
        <State>payment-failed</State>
        <ReservedCacheNodeId>myreservationid</ReservedCacheNodeId>
        <CacheNodeCount>1</CacheNodeCount>
        <StartTime>2010-12-15T00:25:14.131Z</StartTime>
        <Duration>31536000</Duration>
        <FixedPrice>227.5</FixedPrice>
        <UsagePrice>0.046</UsagePrice>
        <CacheNodeType>cache.m1.small</CacheNodeType>
      </ReservedCacheNode>
  </DescribeReservedCacheNodesResult>
  <ResponseMetadata>
    <RequestId>c695119b-2961-11e1-bd06-6fe008f046c3</RequestId>
  </ResponseMetadata>
</DescribeReservedCacheNodesResponse>