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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Array<Types::Filter>

One or more filters.

  • ‘instance-family` - The instance family (e.g., `m4`).

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

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

Returns:



6353
6354
6355
6356
6357
6358
6359
 
# File 'lib/aws-sdk-ec2/types.rb', line 6353

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

#host_reservation_id_set ⇒ Array<String>

One or more host reservation IDs.

Returns:

  • (Array<String>) 


6353
6354
6355
6356
6357
6358
6359
 
# File 'lib/aws-sdk-ec2/types.rb', line 6353

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

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

Returns:

  • (Integer) 


6353
6354
6355
6356
6357
6358
6359
 
# File 'lib/aws-sdk-ec2/types.rb', line 6353

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

#next_token ⇒ String

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

Returns:

  • (String) 


6353
6354
6355
6356
6357
6358
6359
 
# File 'lib/aws-sdk-ec2/types.rb', line 6353

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