Skip to content

EC2  >  Operations  >  describe_capacity_blocks

describe_capacity_blocks

Operation

describe_capacity_blocks async

describe_capacity_blocks(request: DescribeCapacityBlocksInput | DescribeCapacityBlocksInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCapacityBlocksOutput
describe_capacity_blocks(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCapacityBlocksInputDict]) -> DescribeCapacityBlocksOutput

Describes details about Capacity Blocks in the Amazon Web Services Region that you're currently using.

Parameters:

Name Type Description Default
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

Returns:

Type Description
DescribeCapacityBlocksOutput

An instance of DescribeCapacityBlocksOutput.

Input

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

Model

DescribeCapacityBlocksInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityBlocksInput structure.

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

The IDs of the Capacity Blocks.

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.

  • capacity-block-id - The ID of the Capacity Block.

  • ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

  • availability-zone - The Availability Zone of the Capacity Block.

  • start-date - The date and time at which the Capacity Block was started.

  • end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

  • create-date - The date and time at which the Capacity Block was created.

  • state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

  • tags - The tags assigned to the Capacity Block.

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.

Dictionaries

DescribeCapacityBlocksInputDict

Bases: TypedDict

Dictionary form of DescribeCapacityBlocksInput.

Attributes
capacity_block_ids instance-attribute
capacity_block_ids: Sequence[str] | None

The IDs of the Capacity Blocks.

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.

  • capacity-block-id - The ID of the Capacity Block.

  • ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

  • availability-zone - The Availability Zone of the Capacity Block.

  • start-date - The date and time at which the Capacity Block was started.

  • end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

  • create-date - The date and time at which the Capacity Block was created.

  • state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

  • tags - The tags assigned to the Capacity Block.

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.

Output

DescribeCapacityBlocksOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityBlocksOutput structure.

Attributes

capacity_blocks class-attribute instance-attribute
capacity_blocks: list[CapacityBlock] | None = ...

The Capacity Blocks.

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.