| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DataSync.ListAgents
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
- data ListAgents = ListAgents' {}
- newListAgents :: ListAgents
- listAgents_maxResults :: Lens' ListAgents (Maybe Natural)
- listAgents_nextToken :: Lens' ListAgents (Maybe Text)
- data ListAgentsResponse = ListAgentsResponse' {
- agents :: Maybe [AgentListEntry]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListAgentsResponse :: Int -> ListAgentsResponse
- listAgentsResponse_agents :: Lens' ListAgentsResponse (Maybe [AgentListEntry])
- listAgentsResponse_nextToken :: Lens' ListAgentsResponse (Maybe Text)
- listAgentsResponse_httpStatus :: Lens' ListAgentsResponse Int
Creating a Request
data ListAgents Source #
ListAgentsRequest
See: newListAgents smart constructor.
Constructors
| ListAgents' | |
Instances
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:maxResults:ListAgents', listAgents_maxResults - The maximum number of agents to list.
ListAgents, listAgents_nextToken - An opaque string that indicates the position at which to begin the next
list of agents.
Request Lenses
listAgents_maxResults :: Lens' ListAgents (Maybe Natural) Source #
The maximum number of agents to list.
listAgents_nextToken :: Lens' ListAgents (Maybe Text) Source #
An opaque string that indicates the position at which to begin the next list of agents.
Destructuring the Response
data ListAgentsResponse Source #
ListAgentsResponse
See: newListAgentsResponse smart constructor.
Constructors
| ListAgentsResponse' | |
Fields
| |
Instances
newListAgentsResponse Source #
Arguments
| :: Int | |
| -> 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.
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.