Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeCapacityReservations

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.

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.

CapacityReservationId.N

The ID of the Capacity Reservation.

Type: Array of strings

Required: No

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

Filter.N

One or more filters.

Type: Array of Filter objects

Required: No

MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

Type: Integer

Required: No

NextToken

The token to retrieve the next page of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

capacityReservationSet

Information about the Capacity Reservations.

Type: Array of CapacityReservation 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 Errors.

See Also

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