get_capacity_reservation_usage¶
Operation¶
async
¶
get_capacity_reservation_usage(input: GetCapacityReservationUsageInput, plugins: list[Plugin] | None = None) -> GetCapacityReservationUsageOutput
Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetCapacityReservationUsageInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetCapacityReservationUsageOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetCapacityReservationUsageInput structure.
Attributes¶
class-attribute
instance-attribute
¶
capacity_reservation_id: str | None = ...
The ID of the Capacity Reservation.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetCapacityReservationUsageOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
available_instance_count: int | None = ...
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
class-attribute
instance-attribute
¶
capacity_reservation_id: str | None = ...
The ID of the Capacity Reservation.
class-attribute
instance-attribute
¶
instance_type: str | None = ...
The type of instance for which the Capacity Reservation reserves capacity.
class-attribute
instance-attribute
¶
instance_usages: list[InstanceUsage] | None = ...
Information about the Capacity Reservation usage.
class-attribute
instance-attribute
¶
interruptible: bool | None = ...
Indicates whether the Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
class-attribute
instance-attribute
¶
Information about the capacity allocated to the interruptible Capacity Reservation, including instance counts and allocation status.
class-attribute
instance-attribute
¶
Details about the interruption configuration and source reservation for interruptible Capacity Reservations.
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
state: str | None = ...
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
-
active- The capacity is available for use. -
expired- The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. -
cancelled- The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. -
scheduled- (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. -
payment-pending- (Capacity Blocks) The upfront payment has not been processed yet. -
payment-failed- (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. -
assessing- (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. -
delayed- (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. -
unsupported- (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. -
cancelling- (Future-dated Capacity Reservations) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions tocancelledwhen the wind-down completes.