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 |
Describes the specified users. You can describe all users or filter the results (for example, by status or organization).
By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.
This operation returns paginated results.
Synopsis
- data DescribeUsers = DescribeUsers' {}
- newDescribeUsers :: DescribeUsers
- describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text)
- describeUsers_fields :: Lens' DescribeUsers (Maybe Text)
- describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType)
- describeUsers_limit :: Lens' DescribeUsers (Maybe Natural)
- describeUsers_marker :: Lens' DescribeUsers (Maybe Text)
- describeUsers_order :: Lens' DescribeUsers (Maybe OrderType)
- describeUsers_organizationId :: Lens' DescribeUsers (Maybe Text)
- describeUsers_query :: Lens' DescribeUsers (Maybe Text)
- describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType)
- describeUsers_userIds :: Lens' DescribeUsers (Maybe Text)
- data DescribeUsersResponse = DescribeUsersResponse' {}
- newDescribeUsersResponse :: Int -> DescribeUsersResponse
- describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)
- describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)
- describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
- describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int
Creating a Request
data DescribeUsers Source #
See: newDescribeUsers
smart constructor.
DescribeUsers' | |
|
Instances
newDescribeUsers :: DescribeUsers Source #
Create a value of DescribeUsers
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:authenticationToken:DescribeUsers'
, describeUsers_authenticationToken
- Amazon WorkDocs authentication token. Not required when using AWS
administrator credentials to access the API.
$sel:fields:DescribeUsers'
, describeUsers_fields
- A comma-separated list of values. Specify "STORAGE_METADATA" to
include the user storage quota and utilization information.
$sel:include:DescribeUsers'
, describeUsers_include
- The state of the users. Specify "ALL" to include inactive users.
$sel:limit:DescribeUsers'
, describeUsers_limit
- The maximum number of items to return.
DescribeUsers
, describeUsers_marker
- The marker for the next set of results. (You received this marker from a
previous call.)
$sel:order:DescribeUsers'
, describeUsers_order
- The order for the results.
DescribeUsers
, describeUsers_organizationId
- The ID of the organization.
$sel:query:DescribeUsers'
, describeUsers_query
- A query to filter users by user name. Remember the following about the
Userids
and Query
parameters:
- If you don't use either parameter, the API returns a paginated list of all users on the site.
- If you use both parameters, the API ignores the
Query
parameter. - The
Userid
parameter only returns user names that match a corresponding user ID. - The
Query
parameter runs a "prefix" search for users by theGivenName
,SurName
, orUserName
fields included in a CreateUser API call. For example, querying onMa
returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying onMa J
only returns Mateo Jackson.
$sel:sort:DescribeUsers'
, describeUsers_sort
- The sorting criteria.
$sel:userIds:DescribeUsers'
, describeUsers_userIds
- The IDs of the users.
Request Lenses
describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text) Source #
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
describeUsers_fields :: Lens' DescribeUsers (Maybe Text) Source #
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.
describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType) Source #
The state of the users. Specify "ALL" to include inactive users.
describeUsers_limit :: Lens' DescribeUsers (Maybe Natural) Source #
The maximum number of items to return.
describeUsers_marker :: Lens' DescribeUsers (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
describeUsers_order :: Lens' DescribeUsers (Maybe OrderType) Source #
The order for the results.
describeUsers_organizationId :: Lens' DescribeUsers (Maybe Text) Source #
The ID of the organization.
describeUsers_query :: Lens' DescribeUsers (Maybe Text) Source #
A query to filter users by user name. Remember the following about the
Userids
and Query
parameters:
- If you don't use either parameter, the API returns a paginated list of all users on the site.
- If you use both parameters, the API ignores the
Query
parameter. - The
Userid
parameter only returns user names that match a corresponding user ID. - The
Query
parameter runs a "prefix" search for users by theGivenName
,SurName
, orUserName
fields included in a CreateUser API call. For example, querying onMa
returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying onMa J
only returns Mateo Jackson.
describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType) Source #
The sorting criteria.
describeUsers_userIds :: Lens' DescribeUsers (Maybe Text) Source #
The IDs of the users.
Destructuring the Response
data DescribeUsersResponse Source #
See: newDescribeUsersResponse
smart constructor.
DescribeUsersResponse' | |
|
Instances
newDescribeUsersResponse Source #
Create a value of DescribeUsersResponse
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:
DescribeUsers
, describeUsersResponse_marker
- The marker to use when requesting the next set of results. If there are
no additional results, the string is empty.
$sel:totalNumberOfUsers:DescribeUsersResponse'
, describeUsersResponse_totalNumberOfUsers
- The total number of users included in the results.
DescribeUsersResponse
, describeUsersResponse_users
- The users.
$sel:httpStatus:DescribeUsersResponse'
, describeUsersResponse_httpStatus
- The response's http status code.
Response Lenses
describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text) Source #
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer) Source #
The total number of users included in the results.
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User]) Source #
The users.
describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int Source #
The response's http status code.