Network.AWS.Discovery.DescribeAgents

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.

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

Defined in Network.AWS.Discovery.DescribeAgents

Methods

(==) :: DescribeAgents -> DescribeAgents -> Bool

(/=) :: DescribeAgents -> DescribeAgents -> Bool

Data DescribeAgents

Defined in Network.AWS.Discovery.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

Defined in Network.AWS.Discovery.DescribeAgents

Methods

readsPrec :: Int -> ReadS DescribeAgents

readList :: ReadS [DescribeAgents]

readPrec :: ReadPrec DescribeAgents

readListPrec :: ReadPrec [DescribeAgents]

Show DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Methods

showsPrec :: Int -> DescribeAgents -> ShowS

show :: DescribeAgents -> String

showList :: [DescribeAgents] -> ShowS

Generic DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Associated Types

type Rep DescribeAgents :: Type -> Type

Methods

from :: DescribeAgents -> Rep DescribeAgents x

to :: Rep DescribeAgents x -> DescribeAgents

Hashable DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Methods

hashWithSalt :: Int -> DescribeAgents -> Int

hash :: DescribeAgents -> Int

ToJSON DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Methods

toJSON :: DescribeAgents -> Value

toEncoding :: DescribeAgents -> Encoding

toJSONList :: [DescribeAgents] -> Value

toEncodingList :: [DescribeAgents] -> Encoding

AWSRequest DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Associated Types

type Rs DescribeAgents :: Type

Methods

request :: DescribeAgents -> Request DescribeAgents

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeAgents -> ClientResponse -> m (Response DescribeAgents)

ToHeaders DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Methods

toHeaders :: DescribeAgents -> [Header]

ToPath DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Methods

toPath :: DescribeAgents -> ByteString

ToQuery DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Methods

toQuery :: DescribeAgents -> QueryString

NFData DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

Methods

rnf :: DescribeAgents -> ()

type Rep DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

type Rep DescribeAgents = D1 (MetaData "DescribeAgents" "Network.AWS.Discovery.DescribeAgents" "amazonka-discovery-1.6.1-BCKU0SsQ5St9AKTJSgbzOA" False) (C1 (MetaCons "DescribeAgents'" PrefixI True) ((S1 (MetaSel (Just "_daAgentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_daFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 (MetaSel (Just "_daNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_daMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))

type Rs DescribeAgents

Defined in Network.AWS.Discovery.DescribeAgents

type Rs DescribeAgents = DescribeAgentsResponse

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

Arguments

:: Int

dasrsResponseStatus

-> 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

Defined in Network.AWS.Discovery.DescribeAgents

Methods

(==) :: DescribeAgentsResponse -> DescribeAgentsResponse -> Bool

(/=) :: DescribeAgentsResponse -> DescribeAgentsResponse -> Bool

Data DescribeAgentsResponse

Defined in Network.AWS.Discovery.DescribeAgents

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

Defined in Network.AWS.Discovery.DescribeAgents

Methods

readsPrec :: Int -> ReadS DescribeAgentsResponse

readList :: ReadS [DescribeAgentsResponse]

readPrec :: ReadPrec DescribeAgentsResponse

readListPrec :: ReadPrec [DescribeAgentsResponse]

Show DescribeAgentsResponse

Defined in Network.AWS.Discovery.DescribeAgents

Methods

showsPrec :: Int -> DescribeAgentsResponse -> ShowS

show :: DescribeAgentsResponse -> String

showList :: [DescribeAgentsResponse] -> ShowS

Generic DescribeAgentsResponse

Defined in Network.AWS.Discovery.DescribeAgents

Associated Types

type Rep DescribeAgentsResponse :: Type -> Type

Methods

from :: DescribeAgentsResponse -> Rep DescribeAgentsResponse x

to :: Rep DescribeAgentsResponse x -> DescribeAgentsResponse

NFData DescribeAgentsResponse

Defined in Network.AWS.Discovery.DescribeAgents

Methods

rnf :: DescribeAgentsResponse -> ()

type Rep DescribeAgentsResponse

Defined in Network.AWS.Discovery.DescribeAgents

type Rep DescribeAgentsResponse = D1 (MetaData "DescribeAgentsResponse" "Network.AWS.Discovery.DescribeAgents" "amazonka-discovery-1.6.1-BCKU0SsQ5St9AKTJSgbzOA" False) (C1 (MetaCons "DescribeAgentsResponse'" PrefixI True) (S1 (MetaSel (Just "_dasrsAgentsInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AgentInfo])) :*: (S1 (MetaSel (Just "_dasrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_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.