describe_capacity_block_offerings¶
Operation¶
describe_capacity_block_offerings
¶
describe_capacity_block_offerings(request: DescribeCapacityBlockOfferingsInput | DescribeCapacityBlockOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCapacityBlockOfferingsInputDict]) -> DescribeCapacityBlockOfferingsOutput
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you can purchase a specific GPU instance type or EC2 UltraServer for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeCapacityBlockOfferingsInput | DescribeCapacityBlockOfferingsInputDict | 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[DescribeCapacityBlockOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeCapacityBlockOfferingsOutput
|
An instance of |
describe_capacity_block_offerings
async
¶
describe_capacity_block_offerings(request: DescribeCapacityBlockOfferingsInput | DescribeCapacityBlockOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeCapacityBlockOfferingsInputDict]) -> DescribeCapacityBlockOfferingsOutput
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you can purchase a specific GPU instance type or EC2 UltraServer for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeCapacityBlockOfferingsInput | DescribeCapacityBlockOfferingsInputDict | 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[DescribeCapacityBlockOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeCapacityBlockOfferingsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeCapacityBlockOfferingsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeCapacityBlockOfferingsInput.
Attributes¶
all_availability_zones
instance-attribute
¶
all_availability_zones: bool | None
Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.
capacity_duration_hours
instance-attribute
¶
The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
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.
end_date_range
instance-attribute
¶
end_date_range: datetime | None
The latest end date for the Capacity Block offering.
instance_count
instance-attribute
¶
instance_count: int | None
The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
instance_type
instance-attribute
¶
instance_type: str | None
The type of instance for which the Capacity Block offering reserves capacity.
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.
start_date_range
instance-attribute
¶
start_date_range: datetime | None
The earliest start date for the Capacity Block offering.
DescribeCapacityBlockOfferingsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCapacityBlockOfferingsInput structure.
Attributes¶
all_availability_zones
class-attribute
instance-attribute
¶
all_availability_zones: bool | None = ...
Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.
capacity_duration_hours
class-attribute
instance-attribute
¶
capacity_duration_hours: int | None = ...
The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
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.
end_date_range
class-attribute
instance-attribute
¶
end_date_range: datetime | None = ...
The latest end date for the Capacity Block offering.
instance_count
class-attribute
instance-attribute
¶
instance_count: int | None = ...
The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
instance_type
class-attribute
instance-attribute
¶
instance_type: str | None = ...
The type of instance for which the Capacity Block offering reserves capacity.
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.
start_date_range
class-attribute
instance-attribute
¶
start_date_range: datetime | None = ...
The earliest start date for the Capacity Block offering.
Output¶
DescribeCapacityBlockOfferingsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeCapacityBlockOfferingsOutput structure.
Attributes¶
capacity_block_offerings
class-attribute
instance-attribute
¶
capacity_block_offerings: list[CapacityBlockOffering] | None = ...
The recommended Capacity Block offering 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
¶
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.