You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeReservedInstancesOfferingsRequest as input to an Aws::Client method, you can use a vanilla 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, 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, x1.16xlarge, x1.32xlarge, x1e.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, 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, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, f1.2xlarge, f1.16xlarge
  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

Instance Attribute Details

#availability_zoneString

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

Returns:

  • (String)

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

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

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

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

Returns:

#include_marketplaceBoolean

Include Reserved Instance Marketplace offerings in the response.

Returns:

  • (Boolean)

    Include Reserved Instance Marketplace offerings in the response.

#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

Possible values:

  • default
  • dedicated
  • host

Returns:

  • (String)

    The tenancy of the instances covered by the reservation.

#instance_typeString

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.

Returns:

  • (String)

    The instance type that the reservation will cover (for example, m1.small).

#max_durationInteger

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

Default: 94608000 (3 years)

Returns:

  • (Integer)

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

#max_instance_countInteger

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

Default: 20

Returns:

  • (Integer)

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

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

    The maximum number of results to return for the request in a single page.

#min_durationInteger

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

Default: 2592000 (1 month)

Returns:

  • (Integer)

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)

    The token to retrieve the next page of results.

#offering_classString

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

Possible values:

  • standard
  • convertible

Returns:

  • (String)

    The offering class of the Reserved Instance.

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

Possible values:

  • Heavy Utilization
  • Medium Utilization
  • Light Utilization
  • No Upfront
  • Partial Upfront
  • All Upfront

Returns:

  • (String)

    The Reserved Instance offering type.

#product_descriptionString

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

Possible values:

  • Linux/UNIX
  • Linux/UNIX (Amazon VPC)
  • Windows
  • Windows (Amazon VPC)

Returns:

  • (String)

    The Reserved Instance product platform description.

#reserved_instances_offering_idsArray<String>

One or more Reserved Instances offering IDs.

Returns:

  • (Array<String>)

    One or more Reserved Instances offering IDs.