amazonka-discovery-1.4.5: Amazon Application Discovery Service 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.Discovery.DescribeAgents

Contents

Description

Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.

Synopsis

Creating a Request

describeAgents :: DescribeAgents #

Creates a value of DescribeAgents with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • daAgentIds - The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.
  • daNextToken - A token to start the list. Use this token to get the next set of results.
  • daMaxResults - The total number of agents to return. The maximum value is 100.

data DescribeAgents #

See: describeAgents smart constructor.

Instances

Eq DescribeAgents # 
Data DescribeAgents # 

Methods

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

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

toConstr :: DescribeAgents -> Constr #

dataTypeOf :: DescribeAgents -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeAgents # 
Show DescribeAgents # 
Generic DescribeAgents # 

Associated Types

type Rep DescribeAgents :: * -> * #

Hashable DescribeAgents # 
ToJSON DescribeAgents # 
NFData DescribeAgents # 

Methods

rnf :: DescribeAgents -> () #

AWSRequest DescribeAgents # 
ToQuery DescribeAgents # 
ToPath DescribeAgents # 
ToHeaders DescribeAgents # 
type Rep DescribeAgents # 
type Rep DescribeAgents = D1 (MetaData "DescribeAgents" "Network.AWS.Discovery.DescribeAgents" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "DescribeAgents'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_daAgentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_daNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_daMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))
type Rs DescribeAgents # 

Request Lenses

daAgentIds :: Lens' DescribeAgents [Text] #

The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.

daNextToken :: Lens' DescribeAgents (Maybe Text) #

A token to start the list. Use this token to get the next set of results.

daMaxResults :: Lens' DescribeAgents (Maybe Int) #

The total number of agents to return. The maximum value is 100.

Destructuring the Response

describeAgentsResponse #

Creates a value of DescribeAgentsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • darsAgentsInfo - Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID. The output includes agent IDs, IP addresses, media access control (MAC) addresses, agent health, host name where the agent resides, and the version number of each agent.
  • darsNextToken - The call returns a token. Use this token to get the next set of results.
  • darsResponseStatus - -- | The response status code.

data DescribeAgentsResponse #

See: describeAgentsResponse smart constructor.

Instances

Eq DescribeAgentsResponse # 
Data DescribeAgentsResponse # 

Methods

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

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

toConstr :: DescribeAgentsResponse -> Constr #

dataTypeOf :: DescribeAgentsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DescribeAgentsResponse # 
Show DescribeAgentsResponse # 
Generic DescribeAgentsResponse # 
NFData DescribeAgentsResponse # 

Methods

rnf :: DescribeAgentsResponse -> () #

type Rep DescribeAgentsResponse # 
type Rep DescribeAgentsResponse = D1 (MetaData "DescribeAgentsResponse" "Network.AWS.Discovery.DescribeAgents" "amazonka-discovery-1.4.5-14IMFK6azHZ16g41xJUm5E" False) (C1 (MetaCons "DescribeAgentsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_darsAgentsInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AgentInfo]))) ((:*:) (S1 (MetaSel (Just Symbol "_darsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_darsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

darsAgentsInfo :: Lens' DescribeAgentsResponse [AgentInfo] #

Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID. The output includes agent IDs, IP addresses, media access control (MAC) addresses, agent health, host name where the agent resides, and the version number of each agent.

darsNextToken :: Lens' DescribeAgentsResponse (Maybe Text) #

The call returns a token. Use this token to get the next set of results.

darsResponseStatus :: Lens' DescribeAgentsResponse Int #

  • - | The response status code.