| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.EC2.DescribeHosts
Description
Describes one or more of 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 will be listed
with the state released.
- describeHosts :: DescribeHosts
- data DescribeHosts
- dhNextToken :: Lens' DescribeHosts (Maybe Text)
- dhFilter :: Lens' DescribeHosts [Filter]
- dhHostIds :: Lens' DescribeHosts [Text]
- dhMaxResults :: Lens' DescribeHosts (Maybe Int)
- describeHostsResponse :: Int -> DescribeHostsResponse
- data DescribeHostsResponse
- dhrsHosts :: Lens' DescribeHostsResponse [Host]
- dhrsNextToken :: Lens' DescribeHostsResponse (Maybe Text)
- dhrsResponseStatus :: Lens' DescribeHostsResponse Int
Creating a Request
describeHosts :: DescribeHosts Source
Creates a value of DescribeHosts with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeHosts Source
See: describeHosts smart constructor.
Instances
Request Lenses
dhNextToken :: Lens' DescribeHosts (Maybe Text) Source
The token to retrieve the next page of results.
dhFilter :: Lens' DescribeHosts [Filter] Source
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 associated with 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.
dhHostIds :: Lens' DescribeHosts [Text] Source
The IDs of the Dedicated hosts. The IDs are used for targeted instance launches.
dhMaxResults :: 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 will receive an
error. You cannot specify this parameter and the host IDs parameter in
the same request.
Destructuring the Response
Arguments
| :: Int | |
| -> DescribeHostsResponse |
Creates a value of DescribeHostsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeHostsResponse Source
See: describeHostsResponse smart constructor.
Response Lenses
dhrsHosts :: Lens' DescribeHostsResponse [Host] Source
Information about the Dedicated hosts.
dhrsNextToken :: 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.
dhrsResponseStatus :: Lens' DescribeHostsResponse Int Source
The response status code.