DescribeCapacityBlockOfferings - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeCapacityBlockOfferings

Describes Capacity Block offerings available for purchase. With Capacity Blocks, you purchase a specific instance type for a period of time.

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 is UnauthorizedOperation.

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: Yes

InstanceType

The type of instance for which the Capacity Block offering reserves capacity.

Type: String

Required: Yes

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 null when 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 Amazon SDKs, see the following: