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

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

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

Overview

Note:

When making an API call, you may pass DescribeHostReservationOfferingsRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#filterArray<Types::Filter>

One or more filters.

  • instance-family - The instance family of the offering (e.g., m4).

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

Returns:



6451
6452
6453
6454
6455
6456
6457
6458
6459
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6451

class DescribeHostReservationOfferingsRequest < Struct.new(
  :filter,
  :max_duration,
  :max_results,
  :min_duration,
  :next_token,
  :offering_id)
  include Aws::Structure
end

#max_durationInteger

This is the maximum 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 94608000 for three years.

Returns:

  • (Integer)


6451
6452
6453
6454
6455
6456
6457
6458
6459
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6451

class DescribeHostReservationOfferingsRequest < Struct.new(
  :filter,
  :max_duration,
  :max_results,
  :min_duration,
  :next_token,
  :offering_id)
  include Aws::Structure
end

#max_resultsInteger

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 will receive an error.

Returns:

  • (Integer)


6451
6452
6453
6454
6455
6456
6457
6458
6459
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6451

class DescribeHostReservationOfferingsRequest < Struct.new(
  :filter,
  :max_duration,
  :max_results,
  :min_duration,
  :next_token,
  :offering_id)
  include Aws::Structure
end

#min_durationInteger

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)


6451
6452
6453
6454
6455
6456
6457
6458
6459
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6451

class DescribeHostReservationOfferingsRequest < Struct.new(
  :filter,
  :max_duration,
  :max_results,
  :min_duration,
  :next_token,
  :offering_id)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


6451
6452
6453
6454
6455
6456
6457
6458
6459
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6451

class DescribeHostReservationOfferingsRequest < Struct.new(
  :filter,
  :max_duration,
  :max_results,
  :min_duration,
  :next_token,
  :offering_id)
  include Aws::Structure
end

#offering_idString

The ID of the reservation offering.

Returns:

  • (String)


6451
6452
6453
6454
6455
6456
6457
6458
6459
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6451

class DescribeHostReservationOfferingsRequest < Struct.new(
  :filter,
  :max_duration,
  :max_results,
  :min_duration,
  :next_token,
  :offering_id)
  include Aws::Structure
end