Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

DescribeReservedNodes

Returns the descriptions of the reserved nodes.

Request Parameters

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

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Type: String

Required: No

MaxRecords

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Type: Integer

Required: No

ReservedNodeId

Identifier for the node reservation.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

Marker

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Type: String

ReservedNodes.ReservedNode.N

The list of ReservedNode objects.

Type: Array of ReservedNode objects

Errors

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

DependentServiceUnavailableFault

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

HTTP Status Code: 400

ReservedNodeNotFound

The specified reserved compute node not found.

HTTP Status Code: 404

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/
    ?Action=DescribeReservedNodes
    &Version=2012-12-01
    &x-amz-algorithm=AWS4-HMAC-SHA256
    &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130125/us-east-1/redshift/aws4_request
    &x-amz-date=20130125T202355Z
    &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<DescribeReservedNodesResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <DescribeReservedNodesResult>
    <ReservedNodes>
      <ReservedNode>
        <StartTime>2013-01-22T18:46:48.600Z</StartTime>
        <OfferingType>Medium Utilization</OfferingType>
        <Duration>31536000</Duration>
        <RecurringCharges/>
        <FixedPrice>800.0</FixedPrice>
        <UsagePrice>0.158</UsagePrice>
        <State>payment-pending</State>
        <NodeType>ds2.xlarge</NodeType>
        <NodeCount>1</NodeCount>
        <ReservedNodeId>4357912c-9266-469d-beb0-0f1b775e1bc9</ReservedNodeId>
      </ReservedNode>
      <ReservedNode>
        <StartTime>2013-01-22T20:09:16.630Z</StartTime>
        <OfferingType>Heavy Utilization</OfferingType>
        <Duration>94608000</Duration>
        <RecurringCharges>
          <RecurringCharge>
            <RecurringChargeFrequency>Hourly</RecurringChargeFrequency>
            <RecurringChargeAmount>0.21</RecurringChargeAmount>
          </RecurringCharge>
        </RecurringCharges>
        <FixedPrice>12452.0</FixedPrice>
        <UsagePrice>0.0</UsagePrice>
        <State>payment-pending</State>
        <NodeType>ds2.8xlarge</NodeType>
        <NodeCount>2</NodeCount>
        <ReservedNodeId>93bbbca2-e88c-4b8b-a600-b64eaabf18a3</ReservedNodeId>
      </ReservedNode>
      <ReservedNode>
        <StartTime>2013-01-23T21:49:32.517Z</StartTime>
        <OfferingType>Medium Utilization</OfferingType>
        <Duration>31536000</Duration>
        <RecurringCharges/>
        <FixedPrice>800.0</FixedPrice>
        <UsagePrice>0.158</UsagePrice>
        <State>payment-pending</State>
        <NodeType>ds2.xlarge</NodeType>
        <NodeCount>1</NodeCount>
        <ReservedNodeId>bbcd9749-f2ea-4d01-9b1b-b576f618eb4e</ReservedNodeId>
      </ReservedNode>
    </ReservedNodes>
  </DescribeReservedNodesResult>
  <ResponseMetadata>
    <RequestId>24dc90c8-672d-11e2-b2e1-8f41f0379151</RequestId>
  </ResponseMetadata>
</DescribeReservedNodesResponse>

See Also

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