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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Array<Types::Filter>

The filters.

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

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

  • client-token - The idempotency token that you provided when you allocated the host.

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

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

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

  • 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:



19004
19005
19006
19007
19008
19009
19010
19011
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19004

class DescribeHostsRequest < Struct.new(
  :filter,
  :host_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  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>) 


19004
19005
19006
19007
19008
19009
19010
19011
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19004

class DescribeHostsRequest < Struct.new(
  :filter,
  :host_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  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 receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

Returns:

  • (Integer) 


19004
19005
19006
19007
19008
19009
19010
19011
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19004

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

#next_token ⇒ String

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

Returns:

  • (String) 


19004
19005
19006
19007
19008
19009
19010
19011
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 19004

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