@aws-sdk/client-ec2

DescribeReservedInstancesOfferingsCommandInput Interface

The input for DescribeReservedInstancesOfferingsCommand.

Members

Name
Type
Details
AvailabilityZone string | undefined

The Availability Zone in which the Reserved Instance can be used.

DryRun boolean | undefined

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 Filter[] | undefined

One or more filters.

  • availability-zone - 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 to true to 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 Zone or Region).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

IncludeMarketplace boolean | undefined

Include Reserved Instance Marketplace offerings in the response.

InstanceTenancy Tenancy | undefined

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

InstanceType _InstanceType | undefined

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.

MaxDuration number | undefined

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

MaxInstanceCount number | undefined

The maximum number of instances to filter when searching for offerings.

Default: 20

MaxResults number | undefined

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

MinDuration number | undefined

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

NextToken string | undefined

The token to retrieve the next page of results.

OfferingClass OfferingClassType | undefined

The offering class of the Reserved Instance. Can be standard or convertible.

OfferingType OfferingTypeValues | undefined

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.

ProductDescription RIProductDescription | undefined

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

ReservedInstancesOfferingIds string[] | undefined

One or more Reserved Instances offering IDs.

Full Signature

export interface DescribeReservedInstancesOfferingsCommandInput extends DescribeReservedInstancesOfferingsRequest