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.DataSync.ListAgents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAgents Source #

ListAgentsRequest

See: newListAgents smart constructor.

Constructors

ListAgents'
Fields nextToken :: Maybe Text An opaque string that indicates the position at which to begin the next list of agents. maxResults :: Maybe Natural The maximum number of agents to list.

Instances

Instances details

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

newListAgents :: ListAgents Source #

Create a value of ListAgents 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:nextToken:ListAgents', listAgents_nextToken - An opaque string that indicates the position at which to begin the next list of agents.

$sel:maxResults:ListAgents', listAgents_maxResults - The maximum number of agents to list.

Request Lenses

listAgents_nextToken :: Lens' ListAgents (Maybe Text) Source #

An opaque string that indicates the position at which to begin the next list of agents.

listAgents_maxResults :: Lens' ListAgents (Maybe Natural) Source #

The maximum number of agents to list.

Destructuring the Response

data ListAgentsResponse Source #

ListAgentsResponse

See: newListAgentsResponse smart constructor.

Constructors

ListAgentsResponse'
Fields agents :: Maybe [AgentListEntry] A list of agents in your account. nextToken :: Maybe Text An opaque string that indicates the position at which to begin returning the next list of agents. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAgentsResponse Source #

Arguments

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

Create a value of ListAgentsResponse 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:agents:ListAgentsResponse', listAgentsResponse_agents - A list of agents in your account.

$sel:nextToken:ListAgents', listAgentsResponse_nextToken - An opaque string that indicates the position at which to begin returning the next list of agents.

$sel:httpStatus:ListAgentsResponse', listAgentsResponse_httpStatus - The response's http status code.

Response Lenses

listAgentsResponse_agents :: Lens' ListAgentsResponse (Maybe [AgentListEntry]) Source #

A list of agents in your account.

listAgentsResponse_nextToken :: Lens' ListAgentsResponse (Maybe Text) Source #

An opaque string that indicates the position at which to begin returning the next list of agents.

listAgentsResponse_httpStatus :: Lens' ListAgentsResponse Int Source #

The response's http status code.