You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::DescribeHostsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeHostsRequest
- Defined in:
- (unknown)
Overview
When passing DescribeHostsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
filter: [
{
name: "String",
values: ["String"],
},
],
host_ids: ["DedicatedHostId"],
max_results: 1,
next_token: "String",
}
Instance Attribute Summary collapse
-
#filter ⇒ Array<Types::Filter>
The filters.
-
#host_ids ⇒ Array<String>
The IDs of the Dedicated Hosts.
-
#max_results ⇒ Integer
The maximum number of results to return for the request in a single page.
-
#next_token ⇒ String
The token to use to retrieve the next page of results.
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.
#host_ids ⇒ Array<String>
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
#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.
#next_token ⇒ String
The token to use to retrieve the next page of results.