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

GetCapacityReservationUsage

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.

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

The ID of the Capacity Reservation.

Type: String

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

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.

Valid range: Minimum value of 1. Maximum value of 1000.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

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.

availableInstanceCount

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

Type: Integer

capacityReservationId

The ID of the Capacity Reservation.

Type: String

instanceType

The type of instance for which the Capacity Reservation reserves capacity.

Type: String

instanceUsageSet

Information about the Capacity Reservation usage.

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

state

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

Type: String

Valid Values: active | expired | cancelled | pending | failed

totalInstanceCount

The number of instances for which the Capacity Reservation reserves capacity.

Type: Integer

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: