describe_reserved_instances_offerings¶
Operation¶
describe_reserved_instances_offerings
¶
describe_reserved_instances_offerings(request: DescribeReservedInstancesOfferingsInput | DescribeReservedInstancesOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedInstancesOfferingsInputDict]) -> DescribeReservedInstancesOfferingsOutput
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
Note
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeReservedInstancesOfferingsInput | DescribeReservedInstancesOfferingsInputDict | 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[DescribeReservedInstancesOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeReservedInstancesOfferingsOutput
|
An instance of |
describe_reserved_instances_offerings
async
¶
describe_reserved_instances_offerings(request: DescribeReservedInstancesOfferingsInput | DescribeReservedInstancesOfferingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeReservedInstancesOfferingsInputDict]) -> DescribeReservedInstancesOfferingsOutput
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
Note
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeReservedInstancesOfferingsInput | DescribeReservedInstancesOfferingsInputDict | 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[DescribeReservedInstancesOfferingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeReservedInstancesOfferingsOutput
|
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.
DescribeReservedInstancesOfferingsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeReservedInstancesOfferingsInput.
Attributes¶
availability_zone
instance-attribute
¶
availability_zone: str | None
The Availability Zone in which the Reserved Instance can be used.
Either AvailabilityZone or AvailabilityZoneId can be specified, but
not both.
availability_zone_id
instance-attribute
¶
availability_zone_id: str | None
The ID of the Availability Zone.
Either AvailabilityZone or AvailabilityZoneId can be specified, but
not both.
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.
-
availability-zone- The Availability Zone where the Reserved Instance can be used. -
availability-zone-id- The ID of the Availability Zone where the Reserved Instance can be used. -
duration- The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000|94608000). -
fixed-price- The purchase price of the Reserved Instance (for example, 9800.0). -
instance-type- The instance type that is covered by the reservation. -
marketplace- Set totrueto show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed. -
product-description- The Reserved Instance product platform description (Linux/UNIX|Linux with SQL Server Standard|Linux with SQL Server Web|Linux with SQL Server Enterprise|SUSE Linux|Red Hat Enterprise Linux|Red Hat Enterprise Linux with HA|Windows|Windows with SQL Server Standard|Windows with SQL Server Web|Windows with SQL Server Enterprise). -
reserved-instances-offering-id- The Reserved Instances offering ID. -
scope- The scope of the Reserved Instance (Availability ZoneorRegion). -
usage-price- The usage price of the Reserved Instance, per hour (for example, 0.84).
include_marketplace
instance-attribute
¶
include_marketplace: bool | None
Include Reserved Instance Marketplace offerings in the response.
instance_tenancy
instance-attribute
¶
instance_tenancy: str | None
The tenancy of the instances covered by the reservation. A Reserved
Instance with a tenancy of dedicated is applied to instances that run
in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use
the default or dedicated values only.
Default: default
instance_type
instance-attribute
¶
instance_type: str | None
The instance type that the reservation will cover (for example,
m1.small). For more information, see Amazon EC2 instance
types
in the Amazon EC2 User Guide.
max_duration
instance-attribute
¶
max_duration: int | None
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
max_instance_count
instance-attribute
¶
max_instance_count: int | None
The maximum number of instances to filter when searching for offerings.
Default: 20
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 of the initial request can be seen by
sending another request with the returned NextToken value. The maximum
is 100.
Default: 100
min_duration
instance-attribute
¶
min_duration: int | None
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
next_token
instance-attribute
¶
next_token: str | None
The token to retrieve the next page of results.
offering_class
instance-attribute
¶
offering_class: str | None
The offering class of the Reserved Instance. Can be standard or
convertible.
offering_type
instance-attribute
¶
offering_type: str | None
The Reserved Instance offering type. If you are using tools that predate
the 2011-11-01 API version, you only have access to the
Medium Utilization Reserved Instance offering type.
DescribeReservedInstancesOfferingsInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DescribeReservedInstancesOfferings.
Attributes¶
availability_zone
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
The Availability Zone in which the Reserved Instance can be used.
Either AvailabilityZone or AvailabilityZoneId can be specified, but
not both.
availability_zone_id
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
The ID of the Availability Zone.
Either AvailabilityZone or AvailabilityZoneId can be specified, but
not both.
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.
-
availability-zone- The Availability Zone where the Reserved Instance can be used. -
availability-zone-id- The ID of the Availability Zone where the Reserved Instance can be used. -
duration- The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000|94608000). -
fixed-price- The purchase price of the Reserved Instance (for example, 9800.0). -
instance-type- The instance type that is covered by the reservation. -
marketplace- Set totrueto show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed. -
product-description- The Reserved Instance product platform description (Linux/UNIX|Linux with SQL Server Standard|Linux with SQL Server Web|Linux with SQL Server Enterprise|SUSE Linux|Red Hat Enterprise Linux|Red Hat Enterprise Linux with HA|Windows|Windows with SQL Server Standard|Windows with SQL Server Web|Windows with SQL Server Enterprise). -
reserved-instances-offering-id- The Reserved Instances offering ID. -
scope- The scope of the Reserved Instance (Availability ZoneorRegion). -
usage-price- The usage price of the Reserved Instance, per hour (for example, 0.84).
include_marketplace
class-attribute
instance-attribute
¶
include_marketplace: bool | None = ...
Include Reserved Instance Marketplace offerings in the response.
instance_tenancy
class-attribute
instance-attribute
¶
instance_tenancy: str | None = ...
The tenancy of the instances covered by the reservation. A Reserved
Instance with a tenancy of dedicated is applied to instances that run
in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use
the default or dedicated values only.
Default: default
instance_type
class-attribute
instance-attribute
¶
instance_type: str | None = ...
The instance type that the reservation will cover (for example,
m1.small). For more information, see Amazon EC2 instance
types
in the Amazon EC2 User Guide.
max_duration
class-attribute
instance-attribute
¶
max_duration: int | None = ...
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
max_instance_count
class-attribute
instance-attribute
¶
max_instance_count: int | None = ...
The maximum number of instances to filter when searching for offerings.
Default: 20
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 of the initial request can be seen by
sending another request with the returned NextToken value. The maximum
is 100.
Default: 100
min_duration
class-attribute
instance-attribute
¶
min_duration: int | None = ...
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to retrieve the next page of results.
offering_class
class-attribute
instance-attribute
¶
offering_class: str | None = ...
The offering class of the Reserved Instance. Can be standard or
convertible.
offering_type
class-attribute
instance-attribute
¶
offering_type: str | None = ...
The Reserved Instance offering type. If you are using tools that predate
the 2011-11-01 API version, you only have access to the
Medium Utilization Reserved Instance offering type.
Output¶
DescribeReservedInstancesOfferingsOutput
dataclass
¶
Bases: _SerdeShape
Contains the output of DescribeReservedInstancesOfferings.
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.
reserved_instances_offerings
class-attribute
instance-attribute
¶
reserved_instances_offerings: list[ReservedInstancesOffering] | None = ...
A list of Reserved Instances 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.