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

Class: Aws::EC2::Types::DescribeHostReservationsRequest

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 DescribeHostReservationsRequest data as a hash:

{
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  host_reservation_id_set: ["String"],
  max_results: 1,
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#filterArray<Types::Filter>

The filters.

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

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

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Returns:



11922
11923
11924
11925
11926
11927
11928
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11922

class DescribeHostReservationsRequest < Struct.new(
  :filter,
  :host_reservation_id_set,
  :max_results,
  :next_token)
  include Aws::Structure
end

#host_reservation_id_setArray<String>

The host reservation IDs.

Returns:

  • (Array<String>)


11922
11923
11924
11925
11926
11927
11928
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11922

class DescribeHostReservationsRequest < Struct.new(
  :filter,
  :host_reservation_id_set,
  :max_results,
  :next_token)
  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 receive an error.

Returns:

  • (Integer)


11922
11923
11924
11925
11926
11927
11928
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11922

class DescribeHostReservationsRequest < Struct.new(
  :filter,
  :host_reservation_id_set,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


11922
11923
11924
11925
11926
11927
11928
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11922

class DescribeHostReservationsRequest < Struct.new(
  :filter,
  :host_reservation_id_set,
  :max_results,
  :next_token)
  include Aws::Structure
end