Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're
currently using. All listed instances consume capacity on your Dedicated
Host. Dedicated Hosts that have recently been released are listed with
the state released
.
This operation returns paginated results.
Synopsis
- data DescribeHosts = DescribeHosts' {}
- newDescribeHosts :: DescribeHosts
- describeHosts_filter :: Lens' DescribeHosts (Maybe [Filter])
- describeHosts_hostIds :: Lens' DescribeHosts (Maybe [Text])
- describeHosts_maxResults :: Lens' DescribeHosts (Maybe Int)
- describeHosts_nextToken :: Lens' DescribeHosts (Maybe Text)
- data DescribeHostsResponse = DescribeHostsResponse' {}
- newDescribeHostsResponse :: Int -> DescribeHostsResponse
- describeHostsResponse_hosts :: Lens' DescribeHostsResponse (Maybe [Host])
- describeHostsResponse_nextToken :: Lens' DescribeHostsResponse (Maybe Text)
- describeHostsResponse_httpStatus :: Lens' DescribeHostsResponse Int
Creating a Request
data DescribeHosts Source #
See: newDescribeHosts
smart constructor.
DescribeHosts' | |
|
Instances
newDescribeHosts :: DescribeHosts Source #
Create a value of DescribeHosts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':DescribeHosts'
, describeHosts_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.
$sel:hostIds:DescribeHosts'
, describeHosts_hostIds
- The IDs of the Dedicated Hosts. The IDs are used for targeted instance
launches.
$sel:maxResults:DescribeHosts'
, describeHosts_maxResults
- 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.
DescribeHosts
, describeHosts_nextToken
- The token to use to retrieve the next page of results.
Request Lenses
describeHosts_filter :: Lens' DescribeHosts (Maybe [Filter]) Source #
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.
describeHosts_hostIds :: Lens' DescribeHosts (Maybe [Text]) Source #
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
describeHosts_maxResults :: Lens' DescribeHosts (Maybe Int) Source #
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.
describeHosts_nextToken :: Lens' DescribeHosts (Maybe Text) Source #
The token to use to retrieve the next page of results.
Destructuring the Response
data DescribeHostsResponse Source #
See: newDescribeHostsResponse
smart constructor.
Instances
newDescribeHostsResponse Source #
Create a value of DescribeHostsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hosts:DescribeHostsResponse'
, describeHostsResponse_hosts
- Information about the Dedicated Hosts.
DescribeHosts
, describeHostsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:DescribeHostsResponse'
, describeHostsResponse_httpStatus
- The response's http status code.
Response Lenses
describeHostsResponse_hosts :: Lens' DescribeHostsResponse (Maybe [Host]) Source #
Information about the Dedicated Hosts.
describeHostsResponse_nextToken :: Lens' DescribeHostsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeHostsResponse_httpStatus :: Lens' DescribeHostsResponse Int Source #
The response's http status code.