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

Class: Aws::EC2::Types::DescribeHostReservationOfferingsRequest

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

Overview

Note:

When passing DescribeHostReservationOfferingsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_duration: 1,
  max_results: 1,
  min_duration: 1,
  next_token: "String",
  offering_id: "OfferingId",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Array<Types::Filter>

The filters.

  • instance-family - The instance family of the offering (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

Returns:

#max_duration ⇒ Integer

This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

Returns:

  • (Integer) —

    This is the maximum duration of the reservation to purchase, specified in seconds.

#max_results ⇒ Integer

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Returns:

  • (Integer) —

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

#min_duration ⇒ Integer

This is the minimum duration of the reservation you\'d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

Returns:

  • (Integer) —

    This is the minimum duration of the reservation you\'d like to purchase, specified in seconds.

#next_token ⇒ String

The token to use to retrieve the next page of results.

Returns:

  • (String) —

    The token to use to retrieve the next page of results.

#offering_id ⇒ String

The ID of the reservation offering.

Returns:

  • (String) —

    The ID of the reservation offering.