Network.AWS.Discovery.DescribeAgents

Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent 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
• daNextToken
• daMaxResults

data DescribeAgents

See: describeAgents smart constructor.

Instances

Eq DescribeAgents

Methods

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

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

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

Methods

readsPrec :: Int -> ReadS DescribeAgents

readList :: ReadS [DescribeAgents]

readPrec :: ReadPrec DescribeAgents

readListPrec :: ReadPrec [DescribeAgents]

Show DescribeAgents

Methods

showsPrec :: Int -> DescribeAgents -> ShowS

show :: DescribeAgents -> String

showList :: [DescribeAgents] -> ShowS

Generic DescribeAgents

Associated Types

type Rep DescribeAgents :: * -> *

Methods

from :: DescribeAgents -> Rep DescribeAgents x

to :: Rep DescribeAgents x -> DescribeAgents

Hashable DescribeAgents

Methods

hashWithSalt :: Int -> DescribeAgents -> Int

hash :: DescribeAgents -> Int

ToJSON DescribeAgents

Methods

toJSON :: DescribeAgents -> Value

toEncoding :: DescribeAgents -> Encoding

toJSONList :: [DescribeAgents] -> Value

toEncodingList :: [DescribeAgents] -> Encoding

NFData DescribeAgents

Methods

rnf :: DescribeAgents -> ()

AWSRequest DescribeAgents

Associated Types

type Rs DescribeAgents :: *

Methods

request :: DescribeAgents -> Request DescribeAgents

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

ToQuery DescribeAgents

Methods

toQuery :: DescribeAgents -> QueryString

ToPath DescribeAgents

Methods

toPath :: DescribeAgents -> ByteString

ToHeaders DescribeAgents

Methods

toHeaders :: DescribeAgents -> [Header]

type Rep DescribeAgents

type Rep DescribeAgents = D1 (MetaData "DescribeAgents" "Network.AWS.Discovery.DescribeAgents" "amazonka-discovery-1.4.3-4h2FpjHTGwS4VYZVNIA7Dm" 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

type Rs DescribeAgents = DescribeAgentsResponse

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

Arguments

:: Int

darsResponseStatus

-> 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
• darsNextToken
• darsResponseStatus

data DescribeAgentsResponse

See: describeAgentsResponse smart constructor.

Instances

Eq DescribeAgentsResponse

Methods

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

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

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

Methods

readsPrec :: Int -> ReadS DescribeAgentsResponse

readList :: ReadS [DescribeAgentsResponse]

readPrec :: ReadPrec DescribeAgentsResponse

readListPrec :: ReadPrec [DescribeAgentsResponse]

Show DescribeAgentsResponse

Methods

showsPrec :: Int -> DescribeAgentsResponse -> ShowS

show :: DescribeAgentsResponse -> String

showList :: [DescribeAgentsResponse] -> ShowS

Generic DescribeAgentsResponse

Associated Types

type Rep DescribeAgentsResponse :: * -> *

Methods

from :: DescribeAgentsResponse -> Rep DescribeAgentsResponse x

to :: Rep DescribeAgentsResponse x -> DescribeAgentsResponse

NFData DescribeAgentsResponse

Methods

rnf :: DescribeAgentsResponse -> ()

type Rep DescribeAgentsResponse

type Rep DescribeAgentsResponse = D1 (MetaData "DescribeAgentsResponse" "Network.AWS.Discovery.DescribeAgents" "amazonka-discovery-1.4.3-4h2FpjHTGwS4VYZVNIA7Dm" 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 DecidedStrict) (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.