Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Discovery.DescribeAgents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeAgents Source #

See: newDescribeAgents smart constructor.

Constructors

DescribeAgents'

Fields

agentIds :: Maybe [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.
filters :: Maybe [Filter]
You can filter the request using various logical operators and a key-value format. For example:
```
{"key": "collectionStatus", "value": "STARTED"}
```
nextToken :: 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.
maxResults :: Maybe Int
The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

Instances

Instances details

Eq DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods (==) :: DescribeAgents -> DescribeAgents -> Bool # (/=) :: DescribeAgents -> DescribeAgents -> Bool #
Read DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods readsPrec :: Int -> ReadS DescribeAgents # readList :: ReadS [DescribeAgents] # readPrec :: ReadPrec DescribeAgents # readListPrec :: ReadPrec [DescribeAgents] #
Show DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods showsPrec :: Int -> DescribeAgents -> ShowS # show :: DescribeAgents -> String # showList :: [DescribeAgents] -> ShowS #
Generic DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Associated Types type Rep DescribeAgents :: Type -> Type # Methods from :: DescribeAgents -> Rep DescribeAgents x # to :: Rep DescribeAgents x -> DescribeAgents #
NFData DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods rnf :: DescribeAgents -> () #
Hashable DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods hashWithSalt :: Int -> DescribeAgents -> Int # hash :: DescribeAgents -> Int #
ToJSON DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods toJSON :: DescribeAgents -> Value # toEncoding :: DescribeAgents -> Encoding # toJSONList :: [DescribeAgents] -> Value # toEncodingList :: [DescribeAgents] -> Encoding #
AWSPager DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods page :: DescribeAgents -> AWSResponse DescribeAgents -> Maybe DescribeAgents #
AWSRequest DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Associated Types type AWSResponse DescribeAgents # Methods request :: DescribeAgents -> Request DescribeAgents # response :: MonadResource m => Logger -> Service -> Proxy DescribeAgents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAgents))) #
ToHeaders DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods toHeaders :: DescribeAgents -> [Header] #
ToPath DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods toPath :: DescribeAgents -> ByteString #
ToQuery DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods toQuery :: DescribeAgents -> QueryString #
type Rep DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents type Rep DescribeAgents = D1 ('MetaData "DescribeAgents" "Amazonka.Discovery.DescribeAgents" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "DescribeAgents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "agentIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeAgents Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents type AWSResponse DescribeAgents = DescribeAgentsResponse

newDescribeAgents :: DescribeAgents Source #

Create a value of DescribeAgents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agentIds:DescribeAgents', describeAgents_agentIds - 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.

$sel:filters:DescribeAgents', describeAgents_filters - You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

$sel:nextToken:DescribeAgents', describeAgents_nextToken - 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.

$sel:maxResults:DescribeAgents', describeAgents_maxResults - The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

Request Lenses

describeAgents_agentIds :: Lens' DescribeAgents (Maybe [Text]) Source #

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.

describeAgents_filters :: Lens' DescribeAgents (Maybe [Filter]) Source #

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

describeAgents_nextToken :: Lens' DescribeAgents (Maybe Text) Source #

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.

describeAgents_maxResults :: Lens' DescribeAgents (Maybe Int) Source #

The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

Destructuring the Response

data DescribeAgentsResponse Source #

See: newDescribeAgentsResponse smart constructor.

Constructors

DescribeAgentsResponse'

Fields

agentsInfo :: Maybe [AgentInfo]
Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.
nextToken :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeAgentsResponse Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods (==) :: DescribeAgentsResponse -> DescribeAgentsResponse -> Bool # (/=) :: DescribeAgentsResponse -> DescribeAgentsResponse -> Bool #
Read DescribeAgentsResponse Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods readsPrec :: Int -> ReadS DescribeAgentsResponse # readList :: ReadS [DescribeAgentsResponse] # readPrec :: ReadPrec DescribeAgentsResponse # readListPrec :: ReadPrec [DescribeAgentsResponse] #
Show DescribeAgentsResponse Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods showsPrec :: Int -> DescribeAgentsResponse -> ShowS # show :: DescribeAgentsResponse -> String # showList :: [DescribeAgentsResponse] -> ShowS #
Generic DescribeAgentsResponse Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Associated Types type Rep DescribeAgentsResponse :: Type -> Type # Methods from :: DescribeAgentsResponse -> Rep DescribeAgentsResponse x # to :: Rep DescribeAgentsResponse x -> DescribeAgentsResponse #
NFData DescribeAgentsResponse Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents Methods rnf :: DescribeAgentsResponse -> () #
type Rep DescribeAgentsResponse Source #
Instance details Defined in Amazonka.Discovery.DescribeAgents type Rep DescribeAgentsResponse = D1 ('MetaData "DescribeAgentsResponse" "Amazonka.Discovery.DescribeAgents" "libZSservicesZSamazonka-discoveryZSamazonka-discovery" 'False) (C1 ('MetaCons "DescribeAgentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "agentsInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AgentInfo])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeAgentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeAgentsResponse'`
-> DescribeAgentsResponse

Create a value of DescribeAgentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:agentsInfo:DescribeAgentsResponse', describeAgentsResponse_agentsInfo - Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.

$sel:nextToken:DescribeAgents', describeAgentsResponse_nextToken - 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.

$sel:httpStatus:DescribeAgentsResponse', describeAgentsResponse_httpStatus - The response's http status code.

Response Lenses

describeAgentsResponse_agentsInfo :: Lens' DescribeAgentsResponse (Maybe [AgentInfo]) Source #

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

describeAgentsResponse_nextToken :: Lens' DescribeAgentsResponse (Maybe Text) Source #

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.

describeAgentsResponse_httpStatus :: Lens' DescribeAgentsResponse Int Source #

The response's http status code.