Skip to content

GetCapacityReservationUsageResult

Source code in docs_src/capo_ec2/types/get_capacity_reservation_usage_result.py
class GetCapacityReservationUsageResult(TypedDict, closed=True):
    next_token: NotRequired["capo_ec2.types.string.String"]
    """<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"""
    capacity_reservation_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Capacity Reservation.</p>"""
    instance_type: NotRequired["capo_ec2.types.string.String"]
    """<p>The type of instance for which the Capacity Reservation reserves capacity.</p>"""
    total_instance_count: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of instances for which the Capacity Reservation reserves capacity.</p>"""
    available_instance_count: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.</p>"""
    state: NotRequired[
        "capo_ec2.types.capacity_reservation_state.CapacityReservationState"
    ]
    """<p>The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:</p> <ul> <li> <p> <code>active</code> - The capacity is available for use.</p> </li> <li> <p> <code>expired</code> - 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.</p> </li> <li> <p> <code>cancelled</code> - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.</p> </li> <li> <p> <code>pending</code> - The Capacity Reservation request was successful but the capacity provisioning is still pending.</p> </li> <li> <p> <code>failed</code> - 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.</p> </li> <li> <p> <code>scheduled</code> - (<i>Future-dated Capacity Reservations</i>) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.</p> </li> <li> <p> <code>payment-pending</code> - (<i>Capacity Blocks</i>) The upfront payment has not been processed yet.</p> </li> <li> <p> <code>payment-failed</code> - (<i>Capacity Blocks</i>) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.</p> </li> <li> <p> <code>assessing</code> - (<i>Future-dated Capacity Reservations</i>) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.</p> </li> <li> <p> <code>delayed</code> - (<i>Future-dated Capacity Reservations</i>) 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.</p> </li> <li> <p> <code>unsupported</code> - (<i>Future-dated Capacity Reservations</i>) 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.</p> </li> <li> <p> <code>cancelling</code> - (<i>Future-dated Capacity Reservations</i>) The Capacity Reservation is being cancelled. Capacity has been released but charges continue for the commitment wind-down period. The reservation transitions to <code>cancelled</code> when the wind-down completes.</p> </li> </ul>"""
    instance_usages: NotRequired["capo_ec2.types.instance_usage_set.InstanceUsageSet"]
    """<p>Information about the Capacity Reservation usage.</p>"""
    interruptible: NotRequired["capo_ec2.types.boxed_boolean.BoxedBoolean"]
    """<p> Indicates whether the Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity. </p>"""
    interruptible_capacity_allocation: NotRequired[
        "capo_ec2.types.interruptible_capacity_allocation.InterruptibleCapacityAllocation"
    ]
    """<p> Information about the capacity allocated to the interruptible Capacity Reservation, including instance counts and allocation status. </p>"""
    interruption_info: NotRequired["capo_ec2.types.interruption_info.InterruptionInfo"]
    """<p> Details about the interruption configuration and source reservation for interruptible Capacity Reservations. </p>"""

available_instance_count instance-attribute

available_instance_count: NotRequired[Integer]

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

capacity_reservation_id instance-attribute

capacity_reservation_id: NotRequired[String]

The ID of the Capacity Reservation.

instance_type instance-attribute

instance_type: NotRequired[String]

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

instance_usages instance-attribute

instance_usages: NotRequired[InstanceUsageSet]

Information about the Capacity Reservation usage.

interruptible instance-attribute

interruptible: NotRequired[BoxedBoolean]

Indicates whether the Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.

interruptible_capacity_allocation instance-attribute

interruptible_capacity_allocation: NotRequired[InterruptibleCapacityAllocation]

Information about the capacity allocated to the interruptible Capacity Reservation, including instance counts and allocation status.

interruption_info instance-attribute

interruption_info: NotRequired[InterruptionInfo]

Details about the interruption configuration and source reservation for interruptible Capacity Reservations.

next_token instance-attribute

next_token: NotRequired[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 instance-attribute

state: NotRequired[CapacityReservationState]

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 instance-attribute

total_instance_count: NotRequired[Integer]

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