Skip to content

describe_capacity_block_extension_history

Operation

describe_capacity_block_extension_history

Describes the events for the specified Capacity Block extension during the specified time.

Parameters:

Name Type Description Default
request DescribeCapacityBlockExtensionHistoryInput | DescribeCapacityBlockExtensionHistoryInputDict | 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[DescribeCapacityBlockExtensionHistoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityBlockExtensionHistoryOutput

An instance of DescribeCapacityBlockExtensionHistoryOutput.

describe_capacity_block_extension_history async

Describes the events for the specified Capacity Block extension during the specified time.

Parameters:

Name Type Description Default
request DescribeCapacityBlockExtensionHistoryInput | DescribeCapacityBlockExtensionHistoryInputDict | 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[DescribeCapacityBlockExtensionHistoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityBlockExtensionHistoryOutput

An instance of DescribeCapacityBlockExtensionHistoryOutput.

Input

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

DescribeCapacityBlockExtensionHistoryInputDict

Bases: TypedDict

Dictionary form of DescribeCapacityBlockExtensionHistoryInput.

Attributes

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

The IDs of Capacity Block reservations that you want to display the history for.

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

  • availability-zone - The Availability Zone of the extension.

  • availability-zone-id - The Availability Zone ID of the extension.

  • capacity-block-extension-offering-id - The ID of the extension offering.

  • capacity-block-extension-status - The status of the extension (payment-pending | payment-failed | payment-succeeded).

  • capacity-reservation-id - The reservation ID of the extension.

  • instance-type - The instance type of the extension.

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.

DescribeCapacityBlockExtensionHistoryInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityBlockExtensionHistoryInput structure.

Attributes

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

The IDs of Capacity Block reservations that you want to display the history for.

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

  • availability-zone - The Availability Zone of the extension.

  • availability-zone-id - The Availability Zone ID of the extension.

  • capacity-block-extension-offering-id - The ID of the extension offering.

  • capacity-block-extension-status - The status of the extension (payment-pending | payment-failed | payment-succeeded).

  • capacity-reservation-id - The reservation ID of the extension.

  • instance-type - The instance type of the extension.

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.

Output

DescribeCapacityBlockExtensionHistoryOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityBlockExtensionHistoryOutput structure.

Attributes

capacity_block_extensions class-attribute instance-attribute
capacity_block_extensions: list[CapacityBlockExtension] | None = ...

Describes one or more of your Capacity Block extensions. The results describe only the Capacity Block extensions in the Amazon Web Services Region that you're currently using.

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.