Class: Aws::EC2::Types::DescribeReservedInstancesOfferingsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Contains the parameters for DescribeReservedInstancesOfferings.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

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

Returns:

  • (String)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

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`.

Returns:

  • (Boolean)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<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 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).

Returns:



23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#include_marketplaceBoolean

Include Reserved Instance Marketplace offerings in the response.

Returns:

  • (Boolean)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_tenancyString

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`

Returns:

  • (String)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type that the reservation will cover (for example, ‘m1.small`). For more information, see [Instance types] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

Returns:

  • (String)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#max_durationInteger

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

Default: 94608000 (3 years)

Returns:

  • (Integer)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#max_instance_countInteger

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

Default: 20

Returns:

  • (Integer)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#min_durationInteger

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

Default: 2592000 (1 month)

Returns:

  • (Integer)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#offering_classString

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

Returns:

  • (String)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#offering_typeString

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.

Returns:

  • (String)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#product_descriptionString

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

Returns:

  • (String)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end

#reserved_instances_offering_idsArray<String>

One or more Reserved Instances offering IDs.

Returns:

  • (Array<String>)


23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
# File 'lib/aws-sdk-ec2/types.rb', line 23537

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)
  SENSITIVE = []
  include Aws::Structure
end