Class: Aws::EC2::Types::DescribeReservedInstancesOfferingsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeReservedInstancesOfferingsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ec2/types.rb
Overview
When making an API call, you may pass DescribeReservedInstancesOfferingsRequest data as a hash:
{
availability_zone: "String",
filters: [
{
name: "String",
values: ["String"],
},
],
include_marketplace: false,
instance_type: "t1.micro", # accepts t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.12xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.12xlarge, r5a.24xlarge, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.12xlarge, r5d.24xlarge, r5d.metal, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.18xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.18xlarge, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.12xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.12xlarge, m5a.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.12xlarge, m5d.24xlarge, m5d.metal, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge
max_duration: 1,
max_instance_count: 1,
min_duration: 1,
offering_class: "standard", # accepts standard, convertible
product_description: "Linux/UNIX", # accepts Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
reserved_instances_offering_ids: ["String"],
dry_run: false,
instance_tenancy: "default", # accepts default, dedicated, host
max_results: 1,
next_token: "String",
offering_type: "Heavy Utilization", # accepts Heavy Utilization, Medium Utilization, Light Utilization, No Upfront, Partial Upfront, All Upfront
}
Contains the parameters for DescribeReservedInstancesOfferings.
Instance Attribute Summary collapse
-
#availability_zone ⇒ String
The Availability Zone in which the Reserved Instance can be used.
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#filters ⇒ Array<Types::Filter>
One or more filters.
-
#include_marketplace ⇒ Boolean
Include Reserved Instance Marketplace offerings in the response.
-
#instance_tenancy ⇒ String
The tenancy of the instances covered by the reservation.
-
#instance_type ⇒ String
The instance type that the reservation will cover (for example, ‘m1.small`).
-
#max_duration ⇒ Integer
The maximum duration (in seconds) to filter when searching for offerings.
-
#max_instance_count ⇒ Integer
The maximum number of instances to filter when searching for offerings.
-
#max_results ⇒ Integer
The maximum number of results to return for the request in a single page.
-
#min_duration ⇒ Integer
The minimum duration (in seconds) to filter when searching for offerings.
-
#next_token ⇒ String
The token to retrieve the next page of results.
-
#offering_class ⇒ String
The offering class of the Reserved Instance.
-
#offering_type ⇒ String
The Reserved Instance offering type.
-
#product_description ⇒ String
The Reserved Instance product platform description.
-
#reserved_instances_offering_ids ⇒ Array<String>
One or more Reserved Instances offering IDs.
Instance Attribute Details
#availability_zone ⇒ String
The Availability Zone in which the Reserved Instance can be used.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#dry_run ⇒ Boolean
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`.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#filters ⇒ Array<Types::Filter>
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 AWS and the Reserved Instance Marketplace are listed.
-
‘product-description` - The Reserved Instance product platform description. Instances that include `(Amazon VPC)` in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (`Linux/UNIX` | `Linux/UNIX (Amazon VPC)` | `SUSE Linux` | `SUSE Linux (Amazon VPC)` | `Red Hat Enterprise Linux` | `Red Hat Enterprise Linux (Amazon VPC)` | `Windows` | `Windows (Amazon VPC)` | `Windows with SQL Server Standard` | `Windows with SQL Server Standard (Amazon VPC)` | `Windows with SQL Server Web` | ` Windows with SQL Server Web (Amazon VPC)` | `Windows with SQL Server Enterprise` | `Windows with SQL Server Enterprise (Amazon VPC)`)
-
‘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).
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#include_marketplace ⇒ Boolean
Include Reserved Instance Marketplace offerings in the response.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#instance_tenancy ⇒ String
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`
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#instance_type ⇒ String
The instance type that the reservation will cover (for example, ‘m1.small`). For more information, see [Instance Types] in the *Amazon Elastic Compute Cloud User Guide*.
[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#max_duration ⇒ Integer
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#max_instance_count ⇒ Integer
The maximum number of instances to filter when searching for offerings.
Default: 20
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#max_results ⇒ Integer
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
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#min_duration ⇒ Integer
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#next_token ⇒ String
The token to retrieve the next page of results.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#offering_class ⇒ String
The offering class of the Reserved Instance. Can be ‘standard` or `convertible`.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#offering_type ⇒ String
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.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#product_description ⇒ String
The Reserved Instance product platform description. Instances that include ‘(Amazon VPC)` in the description are for use with Amazon VPC.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |
#reserved_instances_offering_ids ⇒ Array<String>
One or more Reserved Instances offering IDs.
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 |
# File 'lib/aws-sdk-ec2/types.rb', line 13913 class DescribeReservedInstancesOfferingsRequest < Struct.new( :availability_zone, :filters, :include_marketplace, :instance_type, :max_duration, :max_instance_count, :min_duration, :offering_class, :product_description, :reserved_instances_offering_ids, :dry_run, :instance_tenancy, :max_results, :next_token, :offering_type) include Aws::Structure end |