describe_capacity_block_status¶
Operation¶
describe_capacity_block_status
async
¶
describe_capacity_block_status(request: DescribeCapacityBlockStatusInput | DescribeCapacityBlockStatusInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeCapacityBlockStatusOutput
describe_capacity_block_status(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCapacityBlockStatusInputDict]) -> DescribeCapacityBlockStatusOutput
Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.
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 |
|---|---|
DescribeCapacityBlockStatusOutput
|
An instance of |
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¶
DescribeCapacityBlockStatusInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCapacityBlockStatusInput structure.
Attributes¶
capacity_block_ids
class-attribute
instance-attribute
¶
The ID of the Capacity Block.
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
¶
One or more filters.
interconnect-status- The status of the interconnect for the Capacity Block (ok|impaired|insufficient-data).
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.
Dictionaries¶
DescribeCapacityBlockStatusInputDict
¶
Bases: TypedDict
Dictionary form of DescribeCapacityBlockStatusInput.
Attributes¶
capacity_block_ids
instance-attribute
¶
The ID of the Capacity Block.
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.
interconnect-status- The status of the interconnect for the Capacity Block (ok|impaired|insufficient-data).
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.
Output¶
DescribeCapacityBlockStatusOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCapacityBlockStatusOutput structure.
Attributes¶
capacity_block_statuses
class-attribute
instance-attribute
¶
capacity_block_statuses: list[CapacityBlockStatus] | None = ...
The availability of capacity for a Capacity Block.
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
¶
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.