GetCapacityReservationUsageCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, GetCapacityReservationUsageCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, GetCapacityReservationUsageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // GetCapacityReservationUsageRequest
  CapacityReservationId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  DryRun: true || false,
};
const command = new GetCapacityReservationUsageCommand(input);
const response = await client.send(command);
// { // GetCapacityReservationUsageResult
//   NextToken: "STRING_VALUE",
//   CapacityReservationId: "STRING_VALUE",
//   InstanceType: "STRING_VALUE",
//   TotalInstanceCount: Number("int"),
//   AvailableInstanceCount: Number("int"),
//   State: "active" || "expired" || "cancelled" || "pending" || "failed" || "scheduled" || "payment-pending" || "payment-failed" || "assessing" || "delayed" || "unsupported",
//   InstanceUsages: [ // InstanceUsageSet
//     { // InstanceUsage
//       AccountId: "STRING_VALUE",
//       UsedInstanceCount: Number("int"),
//     },
//   ],
// };

GetCapacityReservationUsageCommand Input

See GetCapacityReservationUsageCommandInput for more details

Parameter
Type
Description
CapacityReservationId
Required
string | undefined

The ID of the Capacity Reservation.

DryRun
boolean | undefined

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
number | undefined

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

The token to use to retrieve the next page of results.

GetCapacityReservationUsageCommand Output

See GetCapacityReservationUsageCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AvailableInstanceCount
number | undefined

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

CapacityReservationId
string | undefined

The ID of the Capacity Reservation.

InstanceType
string | undefined

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

InstanceUsages
InstanceUsage[] | undefined

Information about the Capacity Reservation usage.

NextToken
string | undefined

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

State
CapacityReservationState | undefined

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.

TotalInstanceCount
number | undefined

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

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.