Skip to content

describe_capacity_block_extension_offerings

Operation

describe_capacity_block_extension_offerings

Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.

Parameters:

Name Type Description Default
request DescribeCapacityBlockExtensionOfferingsInput | DescribeCapacityBlockExtensionOfferingsInputDict | 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[DescribeCapacityBlockExtensionOfferingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityBlockExtensionOfferingsOutput

An instance of DescribeCapacityBlockExtensionOfferingsOutput.

describe_capacity_block_extension_offerings async

Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.

Parameters:

Name Type Description Default
request DescribeCapacityBlockExtensionOfferingsInput | DescribeCapacityBlockExtensionOfferingsInputDict | 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[DescribeCapacityBlockExtensionOfferingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeCapacityBlockExtensionOfferingsOutput

An instance of DescribeCapacityBlockExtensionOfferingsOutput.

Input

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

DescribeCapacityBlockExtensionOfferingsInputDict

Bases: TypedDict

Dictionary form of DescribeCapacityBlockExtensionOfferingsInput.

Attributes

capacity_block_extension_duration_hours instance-attribute
capacity_block_extension_duration_hours: Required[int]

The duration of the Capacity Block extension offering in hours.

capacity_reservation_id instance-attribute
capacity_reservation_id: Required[str]

The ID of the Capacity reservation to be extended.

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.

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.

DescribeCapacityBlockExtensionOfferingsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityBlockExtensionOfferingsInput structure.

Attributes

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

The duration of the Capacity Block extension offering in hours.

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

The ID of the Capacity reservation to be extended.

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.

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

DescribeCapacityBlockExtensionOfferingsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeCapacityBlockExtensionOfferingsOutput structure.

Attributes

capacity_block_extension_offerings class-attribute instance-attribute
capacity_block_extension_offerings: list[CapacityBlockExtensionOffering] | None = ...

The recommended Capacity Block extension offerings for the dates specified.

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.