DescribeCapacityBlockOfferings
Describes Capacity Block offerings available for purchase in the AWS Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count. You must select one of the following options.
-
For reservation durations 1-day increments up 14 days and 7-day increments up to 182 days total
-
For instance count 1, 2, 4, 8, 16, 32, or 64 instances
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- CapacityDurationHours
-
The number of hours for which to reserve Capacity Block.
Type: Integer
Required: Yes
- DryRun
-
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.Type: Boolean
Required: No
- EndDateRange
-
The latest end date for the Capacity Block offering.
Type: Timestamp
Required: No
- InstanceCount
-
The number of instances for which to reserve capacity.
Type: Integer
Required: No
- InstanceType
-
The type of instance for which the Capacity Block offering reserves capacity.
Type: String
Required: No
- MaxResults
-
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
The token to use to retrieve the next page of results.
Type: String
Required: No
- StartDateRange
-
The earliest start date for the Capacity Block offering.
Type: Timestamp
Required: No
Response Elements
The following elements are returned by the service.
- capacityBlockOfferingSet
-
The recommended Capacity Block offering for the dates specified.
Type: Array of CapacityBlockOffering objects
- nextToken
-
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
