capacity_reservation_usages

Creates, updates, deletes, gets or lists a capacity_reservation_usages resource.

Overview

Name	capacity_reservation_usages
Type	Resource
Id	aws.ec2.capacity_reservation_usages

Fields

The following fields are returned by SELECT queries:

get_capacity_reservation_usage

Name	Datatype	Description
available_instance_count	integer	The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
capacity_reservation_id	string	The ID of the Capacity Reservation.
instance_type	string	The type of instance for which the Capacity Reservation reserves capacity.
instance_usages	string	Information about the Capacity Reservation usage.
interruptible	boolean	Indicates whether the Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.
interruptible_capacity_allocation	string	Information about the capacity allocated to the interruptible Capacity Reservation, including instance counts and allocation status.
interruption_info	string	Details about the interruption configuration and source reservation for interruptible Capacity Reservations.
next_token	string	The token to use to retrieve the next page of results. This value is null when there are no more results to return.
state	string	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 to cancelled when the wind-down completes.
total_instance_count	integer	The number of instances for which the Capacity Reservation reserves capacity.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_capacity_reservation_usage	select	CapacityReservationId, region	NextToken, MaxResults, DryRun	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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
CapacityReservationId	string	The ID of the Capacity Reservation.
region	string	AWS region (default: us-east-1)
DryRun	boolean	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.
MaxResults	integer	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.
NextToken	string	The token to use to retrieve the next page of results.

SELECT examples

get_capacity_reservation_usage

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.

SELECT
available_instance_count,
capacity_reservation_id,
instance_type,
instance_usages,
interruptible,
interruptible_capacity_allocation,
interruption_info,
next_token,
state,
total_instance_count
FROM aws.ec2.capacity_reservation_usages
WHERE CapacityReservationId = '{{ CapacityReservationId }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
;