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 |
Lists the users for a file transfer protocol-enabled server that you
specify by passing the ServerId
parameter.
This operation returns paginated results.
Synopsis
- data ListUsers = ListUsers' {}
- newListUsers :: Text -> ListUsers
- listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
- listUsers_nextToken :: Lens' ListUsers (Maybe Text)
- listUsers_serverId :: Lens' ListUsers Text
- data ListUsersResponse = ListUsersResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- serverId :: Text
- users :: [ListedUser]
- newListUsersResponse :: Int -> Text -> ListUsersResponse
- listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)
- listUsersResponse_httpStatus :: Lens' ListUsersResponse Int
- listUsersResponse_serverId :: Lens' ListUsersResponse Text
- listUsersResponse_users :: Lens' ListUsersResponse [ListedUser]
Creating a Request
See: newListUsers
smart constructor.
ListUsers' | |
|
Instances
Create a value of ListUsers
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:ListUsers'
, listUsers_maxResults
- Specifies the number of users to return as a response to the ListUsers
request.
ListUsers
, listUsers_nextToken
- When you can get additional results from the ListUsers
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional users.
ListUsers
, listUsers_serverId
- A system-assigned unique identifier for a server that has users assigned
to it.
Request Lenses
listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #
Specifies the number of users to return as a response to the ListUsers
request.
listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #
When you can get additional results from the ListUsers
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional users.
listUsers_serverId :: Lens' ListUsers Text Source #
A system-assigned unique identifier for a server that has users assigned to it.
Destructuring the Response
data ListUsersResponse Source #
See: newListUsersResponse
smart constructor.
ListUsersResponse' | |
|
Instances
Create a value of ListUsersResponse
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:
ListUsers
, listUsersResponse_nextToken
- When you can get additional results from the ListUsers
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional users.
$sel:httpStatus:ListUsersResponse'
, listUsersResponse_httpStatus
- The response's http status code.
ListUsers
, listUsersResponse_serverId
- A system-assigned unique identifier for a server that the users are
assigned to.
$sel:users:ListUsersResponse'
, listUsersResponse_users
- Returns the user accounts and their properties for the ServerId
value
that you specify.
Response Lenses
listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #
When you can get additional results from the ListUsers
call, a
NextToken
parameter is returned in the output. You can then pass in a
subsequent command to the NextToken
parameter to continue listing
additional users.
listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #
The response's http status code.
listUsersResponse_serverId :: Lens' ListUsersResponse Text Source #
A system-assigned unique identifier for a server that the users are assigned to.
listUsersResponse_users :: Lens' ListUsersResponse [ListedUser] Source #
Returns the user accounts and their properties for the ServerId
value
that you specify.