Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetCapacityReservationUsageCommandOutput

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional AvailableInstanceCount

AvailableInstanceCount: undefined | number

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

Optional CapacityReservationId

CapacityReservationId: undefined | string

The ID of the Capacity Reservation.

Optional InstanceType

InstanceType: undefined | string

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

Optional InstanceUsages

InstanceUsages: InstanceUsage[]

Information about the Capacity Reservation usage.

Optional NextToken

NextToken: undefined | string

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Optional State

State: CapacityReservationState | string

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 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.

Optional TotalInstanceCount

TotalInstanceCount: undefined | number

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