The Wayback Machine - https://web.archive.org/web/20171024091338/http://docs.aws.amazon.com:80/redshift/latest/APIReference/API_DescribeReservedNodeOfferings.html
Menu
Sign In to the Console
Amazon Redshift
API Reference (API Version 2012-12-01)

AWS Documentation » Amazon Redshift Documentation » API Reference » Actions » DescribeReservedNodeOfferings

DescribeReservedNodeOfferings

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

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 DescribeReservedNodeOfferings 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

ReservedNodeOfferingId

The unique identifier for the offering.

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

ReservedNodeOfferings.ReservedNodeOffering.N

A list of ReservedNodeOffering objects.

Type: Array of ReservedNodeOffering 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

ReservedNodeOfferingNotFound

Specified offering does not exist.

HTTP Status Code: 404

UnsupportedOperation

The requested operation isn't supported.

HTTP Status Code: 400

Example

Sample Request

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

Sample Response

<DescribeReservedNodeOfferingsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <DescribeReservedNodeOfferingsResult>
    <ReservedNodeOfferings>
      <ReservedNodeOffering>
        <OfferingType>Heavy Utilization</OfferingType>
        <Duration>94608000</Duration>
        <RecurringCharges>
          <RecurringCharge>
            <RecurringChargeFrequency>Hourly</RecurringChargeFrequency>
            <RecurringChargeAmount>0.21</RecurringChargeAmount>
          </RecurringCharge>
        </RecurringCharges>
        <FixedPrice>12452.0</FixedPrice>
        <ReservedNodeOfferingId>3a98bf7d-979a-49cc-b568-18f24315baf0</ReservedNodeOfferingId>
        <UsagePrice>0.0</UsagePrice>
        <NodeType>ds2.8xlarge</NodeType>
      </ReservedNodeOffering>
      <ReservedNodeOffering>
        <OfferingType>Heavy Utilization</OfferingType>
        <Duration>31536000</Duration>
        <RecurringCharges>
          <RecurringCharge>
            <RecurringChargeFrequency>Hourly</RecurringChargeFrequency>
            <RecurringChargeAmount>0.09</RecurringChargeAmount>
          </RecurringCharge>
        </RecurringCharges>
        <FixedPrice>1815.0</FixedPrice>
        <ReservedNodeOfferingId>d586503b-289f-408b-955b-9c95005d6908</ReservedNodeOfferingId>
        <UsagePrice>0.0</UsagePrice>
        <NodeType>ds2.xlarge</NodeType>
      </ReservedNodeOffering>
  </DescribeReservedNodeOfferingsResult>
  <ResponseMetadata>
    <RequestId>f4a07e06-60fc-11e2-95d9-658e9466d117</RequestId>
  </ResponseMetadata>
</DescribeReservedNodeOfferingsResponse>

See Also

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