Copyright | (c) 2013-2018 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 |
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
- describeUsers :: DescribeUsers
- data DescribeUsers
- duInclude :: Lens' DescribeUsers (Maybe UserFilterType)
- duUserIds :: Lens' DescribeUsers (Maybe Text)
- duAuthenticationToken :: Lens' DescribeUsers (Maybe Text)
- duSort :: Lens' DescribeUsers (Maybe UserSortType)
- duMarker :: Lens' DescribeUsers (Maybe Text)
- duQuery :: Lens' DescribeUsers (Maybe Text)
- duLimit :: Lens' DescribeUsers (Maybe Natural)
- duOrder :: Lens' DescribeUsers (Maybe OrderType)
- duOrganizationId :: Lens' DescribeUsers (Maybe Text)
- duFields :: Lens' DescribeUsers (Maybe Text)
- describeUsersResponse :: Int -> DescribeUsersResponse
- data DescribeUsersResponse
- dursUsers :: Lens' DescribeUsersResponse [User]
- dursTotalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)
- dursMarker :: Lens' DescribeUsersResponse (Maybe Text)
- dursResponseStatus :: Lens' DescribeUsersResponse Int
Creating a Request
describeUsers :: DescribeUsers Source #
Creates a value of DescribeUsers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
duInclude
- The state of the users. Specify ALL to include inactive users.duUserIds
- The IDs of the users.duAuthenticationToken
- Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.duSort
- The sorting criteria.duMarker
- The marker for the next set of results. (You received this marker from a previous call.)duQuery
- A query to filter users by user name.duLimit
- The maximum number of items to return.duOrder
- The order for the results.duOrganizationId
- The ID of the organization.duFields
- A comma-separated list of values. Specify STORAGE_METADATA to include the user storage quota and utilization information.
data DescribeUsers Source #
See: describeUsers
smart constructor.
Instances
Request Lenses
duInclude :: Lens' DescribeUsers (Maybe UserFilterType) Source #
The state of the users. Specify ALL to include inactive users.
duAuthenticationToken :: Lens' DescribeUsers (Maybe Text) Source #
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
duSort :: Lens' DescribeUsers (Maybe UserSortType) Source #
The sorting criteria.
duMarker :: Lens' DescribeUsers (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
duOrganizationId :: Lens' DescribeUsers (Maybe Text) Source #
The ID of the organization.
duFields :: Lens' DescribeUsers (Maybe Text) Source #
A comma-separated list of values. Specify STORAGE_METADATA to include the user storage quota and utilization information.
Destructuring the Response
describeUsersResponse Source #
Creates a value of DescribeUsersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dursUsers
- The users.dursTotalNumberOfUsers
- The total number of users included in the results.dursMarker
- The marker to use when requesting the next set of results. If there are no additional results, the string is empty.dursResponseStatus
- -- | The response status code.
data DescribeUsersResponse Source #
See: describeUsersResponse
smart constructor.
Instances
Response Lenses
dursTotalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer) Source #
The total number of users included in the results.
dursMarker :: 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.
dursResponseStatus :: Lens' DescribeUsersResponse Int Source #
- - | The response status code.