Skip to content

describe_capacity_reservation_billing_requests

Operation

describe_capacity_reservation_billing_requests

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.

Parameters:

Name Type Description Default
request DescribeCapacityReservationBillingRequestsInput | DescribeCapacityReservationBillingRequestsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeCapacityReservationBillingRequestsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityReservationBillingRequestsOutput

An instance of DescribeCapacityReservationBillingRequestsOutput.

describe_capacity_reservation_billing_requests async

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.

Parameters:

Name Type Description Default
request DescribeCapacityReservationBillingRequestsInput | DescribeCapacityReservationBillingRequestsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeCapacityReservationBillingRequestsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityReservationBillingRequestsOutput

An instance of DescribeCapacityReservationBillingRequestsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeCapacityReservationBillingRequestsInputDict

Bases: TypedDict

Dictionary form of DescribeCapacityReservationBillingRequestsInput.

Attributes

capacity_reservation_ids instance-attribute
capacity_reservation_ids: Sequence[str] | None

The ID of the Capacity Reservation.

dry_run instance-attribute
dry_run: bool | None

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

max_results instance-attribute
max_results: int | None

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.

next_token instance-attribute
next_token: str | None

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

role instance-attribute
role: Required[str]

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.

DescribeCapacityReservationBillingRequestsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityReservationBillingRequestsInput structure.

Attributes

capacity_reservation_ids class-attribute instance-attribute
capacity_reservation_ids: list[str] | None = ...

The ID of the Capacity Reservation.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

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.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

role class-attribute instance-attribute
role: str | None = ...

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.

Output

DescribeCapacityReservationBillingRequestsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityReservationBillingRequestsOutput structure.

Attributes

capacity_reservation_billing_requests class-attribute instance-attribute
capacity_reservation_billing_requests: list[CapacityReservationBillingRequest] | None = ...

Information about the request.

next_token class-attribute instance-attribute
next_token: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.