Skip to content

Describe Capacity Reservation Billing Requests

ec2_describe_capacity_reservation_billing_requests R Documentation

Describes a request to assign the billing of the unused capacity of a Capacity Reservation

Description

Describes a request to assign the billing of the unused capacity of a Capacity Reservation. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.

Usage

ec2_describe_capacity_reservation_billing_requests(
  CapacityReservationIds, Role, NextToken, MaxResults, Filters, DryRun)

Arguments

CapacityReservationIds

The ID of the Capacity Reservation.

Role

[required] Specify one of the following:

  • odcr-owner - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the requested-by filter.

  • unused-reservation-billing-owner - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the unused-reservation-billing-owner filter.

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.

Filters

One or more filters.

  • status - The state of the request (pending | accepted | rejected | cancelled | revoked | expired).

  • requested-by - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify requested-by for Role.

  • unused-reservation-billing-owner - The ID of the consumer account to which the request was sent. Not supported if you specify unused-reservation-billing-owner for Role.

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",
  CapacityReservationBillingRequests = list(
    list(
      CapacityReservationId = "string",
      RequestedBy = "string",
      UnusedReservationBillingOwnerId = "string",
      LastUpdateTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "pending"|"accepted"|"rejected"|"cancelled"|"revoked"|"expired",
      StatusMessage = "string",
      CapacityReservationInfo = list(
        InstanceType = "string",
        AvailabilityZone = "string",
        Tenancy = "default"|"dedicated"
      )
    )
  )
)

Request syntax

svc$describe_capacity_reservation_billing_requests(
  CapacityReservationIds = list(
    "string"
  ),
  Role = "odcr-owner"|"unused-reservation-billing-owner",
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)