Get Capacity Reservation Usage

ec2_get_capacity_reservation_usage

R Documentation

Gets usage information about a Capacity Reservation

Description

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.

Usage

ec2_get_capacity_reservation_usage(CapacityReservationId, NextToken,
  MaxResults, DryRun)

Arguments

CapacityReservationId

[required] The ID of the Capacity Reservation.

NextToken

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

MaxResults

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.

DryRun

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.

Value

A list with the following syntax:

list(
  NextToken = "string",
  CapacityReservationId = "string",
  InstanceType = "string",
  TotalInstanceCount = 123,
  AvailableInstanceCount = 123,
  State = "active"|"expired"|"cancelled"|"pending"|"failed"|"scheduled"|"payment-pending"|"payment-failed",
  InstanceUsages = list(
    list(
      AccountId = "string",
      UsedInstanceCount = 123
    )
  )
)

Request syntax

svc$get_capacity_reservation_usage(
  CapacityReservationId = "string",
  NextToken = "string",
  MaxResults = 123,
  DryRun = TRUE|FALSE
)