amazonka-ec2-1.4.5: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.DescribeHosts

Contents

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 .

Synopsis

Creating a Request

describeHosts :: DescribeHosts #

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:

  • dhNextToken - The token to retrieve the next page of results.
  • dhFilter - 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 assigned to 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 - The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
  • dhMaxResults - 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.

data DescribeHosts #

Contains the parameters for DescribeHosts.

See: describeHosts smart constructor.

Instances

Eq DescribeHosts # 
Data DescribeHosts # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeHosts -> c DescribeHosts #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeHosts #

toConstr :: DescribeHosts -> Constr #

dataTypeOf :: DescribeHosts -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeHosts) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeHosts) #

gmapT :: (forall b. Data b => b -> b) -> DescribeHosts -> DescribeHosts #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHosts -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHosts -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeHosts -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeHosts -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeHosts -> m DescribeHosts #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHosts -> m DescribeHosts #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHosts -> m DescribeHosts #

Read DescribeHosts # 
Show DescribeHosts # 
Generic DescribeHosts # 

Associated Types

type Rep DescribeHosts :: * -> * #

Hashable DescribeHosts # 
NFData DescribeHosts # 

Methods

rnf :: DescribeHosts -> () #

AWSRequest DescribeHosts # 
ToQuery DescribeHosts # 
ToPath DescribeHosts # 
ToHeaders DescribeHosts # 
type Rep DescribeHosts # 
type Rep DescribeHosts = D1 (MetaData "DescribeHosts" "Network.AWS.EC2.DescribeHosts" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "DescribeHosts'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dhNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dhFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter])))) ((:*:) (S1 (MetaSel (Just Symbol "_dhHostIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dhMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))
type Rs DescribeHosts # 

Request Lenses

dhNextToken :: Lens' DescribeHosts (Maybe Text) #

The token to retrieve the next page of results.

dhFilter :: Lens' DescribeHosts [Filter] #

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 assigned to 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] #

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

dhMaxResults :: Lens' DescribeHosts (Maybe Int) #

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

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:

  • dhrsHosts - Information about the Dedicated Hosts.
  • dhrsNextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.
  • dhrsResponseStatus - -- | The response status code.

data DescribeHostsResponse #

Contains the output of DescribeHosts.

See: describeHostsResponse smart constructor.

Instances

Eq DescribeHostsResponse # 
Data DescribeHostsResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeHostsResponse -> c DescribeHostsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeHostsResponse #

toConstr :: DescribeHostsResponse -> Constr #

dataTypeOf :: DescribeHostsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeHostsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeHostsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeHostsResponse -> DescribeHostsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHostsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHostsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeHostsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeHostsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeHostsResponse -> m DescribeHostsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHostsResponse -> m DescribeHostsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHostsResponse -> m DescribeHostsResponse #

Read DescribeHostsResponse # 
Show DescribeHostsResponse # 
Generic DescribeHostsResponse # 
NFData DescribeHostsResponse # 

Methods

rnf :: DescribeHostsResponse -> () #

type Rep DescribeHostsResponse # 
type Rep DescribeHostsResponse = D1 (MetaData "DescribeHostsResponse" "Network.AWS.EC2.DescribeHosts" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "DescribeHostsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dhrsHosts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Host]))) ((:*:) (S1 (MetaSel (Just Symbol "_dhrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dhrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dhrsHosts :: Lens' DescribeHostsResponse [Host] #

Information about the Dedicated Hosts.

dhrsNextToken :: Lens' DescribeHostsResponse (Maybe Text) #

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 #

  • - | The response status code.