describe_instance_type_offerings¶
Operation¶
describe_instance_type_offerings
¶
describe_instance_type_offerings(request: DescribeInstanceTypeOfferingsInput | DescribeInstanceTypeOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInstanceTypeOfferingsInputDict]) -> DescribeInstanceTypeOfferingsOutput
Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeInstanceTypeOfferingsInput | DescribeInstanceTypeOfferingsInputDict | 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[DescribeInstanceTypeOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeInstanceTypeOfferingsOutput
|
An instance of |
describe_instance_type_offerings
async
¶
describe_instance_type_offerings(request: DescribeInstanceTypeOfferingsInput | DescribeInstanceTypeOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInstanceTypeOfferingsInputDict]) -> DescribeInstanceTypeOfferingsOutput
Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeInstanceTypeOfferingsInput | DescribeInstanceTypeOfferingsInputDict | 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[DescribeInstanceTypeOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeInstanceTypeOfferingsOutput
|
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.
DescribeInstanceTypeOfferingsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeInstanceTypeOfferingsInput.
Attributes¶
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. Filter names and values are case-sensitive.
-
instance-type- The instance type. For a list of possible values, see Instance. -
location- The location. For a list of possible identifiers, see Regions and Zones.
location_type
instance-attribute
¶
location_type: str | None
The location type.
-
availability-zone- The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region. -
availability-zone-id- The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region. -
outpost- The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region. -
region- The current Region. If you specify a location filter, it must match the current Region.
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.
DescribeInstanceTypeOfferingsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceTypeOfferingsInput structure.
Attributes¶
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. Filter names and values are case-sensitive.
-
instance-type- The instance type. For a list of possible values, see Instance. -
location- The location. For a list of possible identifiers, see Regions and Zones.
location_type
class-attribute
instance-attribute
¶
location_type: str | None = ...
The location type.
-
availability-zone- The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region. -
availability-zone-id- The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region. -
outpost- The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region. -
region- The current Region. If you specify a location filter, it must match the current Region.
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.
Output¶
DescribeInstanceTypeOfferingsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceTypeOfferingsOutput structure.
Attributes¶
instance_type_offerings
class-attribute
instance-attribute
¶
instance_type_offerings: list[InstanceTypeOffering] | None = ...
The instance types offered in the location.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items 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.