Class: Aws::EC2::Types::DescribeHostsRequest

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

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

Contains the parameters for DescribeHosts.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Array<Types::Filter>

One or more filters.

  • ‘instance-type` - The instance type size that the Dedicated Host is configured to support.

  • ‘auto-placement` - Whether auto-placement is enabled or disabled (`on` | `off`).

  • ‘host-reservation-id` - The ID of the reservation assigned to this host.

  • ‘client-token` - The idempotency token you provided when you launched the instance

  • ‘state`- The allocation state of the Dedicated Host (`available` | `under-assessment` | `permanent-failure` | `released` | `released-permanent-failure`).

  • ‘availability-zone` - The Availability Zone of the host.

Returns:



6437
6438
6439
6440
6441
6442
6443
 
# File 'lib/aws-sdk-ec2/types.rb', line 6437

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

#host_ids ⇒ Array<String>

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

Returns:

  • (Array<String>) 


6437
6438
6439
6440
6441
6442
6443
 
# File 'lib/aws-sdk-ec2/types.rb', line 6437

class DescribeHostsRequest < Struct.new(
  :filter,
  :host_ids,
  :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. You cannot specify this parameter and the host IDs parameter in the same request.

Returns:

  • (Integer) 


6437
6438
6439
6440
6441
6442
6443
 
# File 'lib/aws-sdk-ec2/types.rb', line 6437

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

#next_token ⇒ String

The token to retrieve the next page of results.

Returns:

  • (String) 


6437
6438
6439
6440
6441
6442
6443
 
# File 'lib/aws-sdk-ec2/types.rb', line 6437

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