PurchaseReservedNodeOffering - Amazon Redshift

PurchaseReservedNodeOffering

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.

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.

ReservedNodeOfferingId

The unique identifier of the reserved node offering you want to purchase.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

NodeCount

The number of reserved nodes that you want to purchase.

Default: 1

Type: Integer

Required: No

Response Elements

The following element is returned by the service.

ReservedNode

Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

Type: ReservedNode object

Errors

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

ReservedNodeAlreadyExists

User already has a reservation with the given identifier.

HTTP Status Code: 404

ReservedNodeOfferingNotFound

Specified offering does not exist.

HTTP Status Code: 404

ReservedNodeQuotaExceeded

Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

HTTP Status Code: 400

UnsupportedOperation

The requested operation isn't supported.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of PurchaseReservedNodeOffering.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=PurchaseReservedNodeOffering &ReservedNodeOfferingId=12345678-12ab-12a1-1a2a-12ab-12a12bEXAMPLE &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<PurchaseReservedNodeOfferingResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <PurchaseReservedNodeOfferingResult> <ReservedNode> <ReservedNodeId>12345678-12ab-12a1-1a2a-12ab-12a12aEXAMPLE</ReservedNodeId> <OfferingType>All Upfront</OfferingType> <ReservedNodeOfferingType>Regular</ReservedNodeOfferingType> <RecurringCharges/> <NodeType>ra3.4xlarge</NodeType> <FixedPrice>4295.0</FixedPrice> <Duration>31536000</Duration> <UsagePrice>0.0</UsagePrice> <ReservedNodeOfferingId>12345678-12ab-12a1-1a2a-12ab-12a12bEXAMPLE</ReservedNodeOfferingId> <StartTime>2019-12-27T22:06:20.054Z</StartTime> <NodeCount>1</NodeCount> <State>payment-pending</State> <CurrencyCode>USD</CurrencyCode> </ReservedNode> </PurchaseReservedNodeOfferingResult> <ResponseMetadata> <RequestId>1c8a0fe4-28f5-11ea-8314-974e2ba81189</RequestId> </ResponseMetadata> </PurchaseReservedNodeOfferingResponse>

See Also

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