amazonka-discovery-1.6.0: Amazon Application Discovery Service SDK.

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

Network.AWS.Discovery.DescribeAgents

Contents

Description

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an 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 or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.
  • daFilters - You can filter the request using various logical operators and a key -value format. For example: {"key": "collectionStatus", "value": STARTED}
  • daNextToken - Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.
  • daMaxResults - The total number of agents/Connectors to return in a single page of output. 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 # 
ToHeaders DescribeAgents # 
ToPath DescribeAgents # 
ToQuery DescribeAgents # 
type Rep DescribeAgents # 
type Rep DescribeAgents = D1 * (MetaData "DescribeAgents" "Network.AWS.Discovery.DescribeAgents" "amazonka-discovery-1.6.0-Fb1PXKRDeoaB3tyc19m36q" False) (C1 * (MetaCons "DescribeAgents'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_daAgentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_daFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter])))) ((:*:) * (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 or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

daFilters :: Lens' DescribeAgents [Filter] #

You can filter the request using various logical operators and a key -value format. For example: {"key": "collectionStatus", "value": STARTED}

daNextToken :: Lens' DescribeAgents (Maybe Text) #

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

daMaxResults :: Lens' DescribeAgents (Maybe Int) #

The total number of agents/Connectors to return in a single page of output. 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:

  • dasrsAgentsInfo - Lists agents or the Connector by ID or lists all agentsConnectors associated with your user account if you did not specify an agentConnector ID. The output includes agentConnector IDs, IP addresses, media access control (MAC) addresses, agentConnector health, host name where the agentConnector resides, and the version number of each agentConnector.
  • dasrsNextToken - Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.
  • dasrsResponseStatus - -- | 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.6.0-Fb1PXKRDeoaB3tyc19m36q" False) (C1 * (MetaCons "DescribeAgentsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dasrsAgentsInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [AgentInfo]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dasrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dasrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dasrsAgentsInfo :: Lens' DescribeAgentsResponse [AgentInfo] #

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

dasrsNextToken :: Lens' DescribeAgentsResponse (Maybe Text) #

Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

dasrsResponseStatus :: Lens' DescribeAgentsResponse Int #

  • - | The response status code.