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

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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#filterArray<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:



12083
12084
12085
12086
12087
12088
12089
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12083

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

#host_idsArray<String>

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

Returns:

  • (Array<String>)


12083
12084
12085
12086
12087
12088
12089
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12083

class DescribeHostsRequest < Struct.new(
  :filter,
  :host_ids,
  :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.

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

Returns:

  • (Integer)


12083
12084
12085
12086
12087
12088
12089
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12083

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

#next_tokenString

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

Returns:

  • (String)


12083
12084
12085
12086
12087
12088
12089
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12083

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