describe_host_reservation_offerings¶
Operation¶
describe_host_reservation_offerings
¶
describe_host_reservation_offerings(request: DescribeHostReservationOfferingsInput | DescribeHostReservationOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeHostReservationOfferingsInputDict]) -> DescribeHostReservationOfferingsOutput
Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeHostReservationOfferingsInput | DescribeHostReservationOfferingsInputDict | 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[DescribeHostReservationOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeHostReservationOfferingsOutput
|
An instance of |
describe_host_reservation_offerings
async
¶
describe_host_reservation_offerings(request: DescribeHostReservationOfferingsInput | DescribeHostReservationOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeHostReservationOfferingsInputDict]) -> DescribeHostReservationOfferingsOutput
Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeHostReservationOfferingsInput | DescribeHostReservationOfferingsInputDict | 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[DescribeHostReservationOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeHostReservationOfferingsOutput
|
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.
DescribeHostReservationOfferingsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeHostReservationOfferingsInput.
Attributes¶
filter
instance-attribute
¶
filter: Sequence[Filter | FilterDict] | None
The filters.
-
instance-family- The instance family of the offering (for example,m4). -
payment-option- The payment option (NoUpfront|PartialUpfront|AllUpfront).
max_duration
instance-attribute
¶
max_duration: int | None
This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request with
the returned nextToken value. This value can be between 5 and 500. If
maxResults is given a larger value than 500, you receive an error.
min_duration
instance-attribute
¶
min_duration: int | None
This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
DescribeHostReservationOfferingsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeHostReservationOfferingsInput structure.
Attributes¶
filter
class-attribute
instance-attribute
¶
The filters.
-
instance-family- The instance family of the offering (for example,m4). -
payment-option- The payment option (NoUpfront|PartialUpfront|AllUpfront).
max_duration
class-attribute
instance-attribute
¶
max_duration: int | None = ...
This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request with
the returned nextToken value. This value can be between 5 and 500. If
maxResults is given a larger value than 500, you receive an error.
min_duration
class-attribute
instance-attribute
¶
min_duration: int | None = ...
This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
Output¶
DescribeHostReservationOfferingsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeHostReservationOfferingsOutput structure.
Attributes¶
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.
offering_set
class-attribute
instance-attribute
¶
offering_set: list[HostOffering] | None = ...
Information about the offerings.
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.