libZSservicesZSamazonka-workdocsZSamazonka-workdocs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkDocs.DescribeUsers

Description

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

Creating a Request

data DescribeUsers Source #

See: newDescribeUsers smart constructor.

Constructors

DescribeUsers' 

Fields

Instances

Instances details
Eq DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Show DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Generic DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Associated Types

type Rep DescribeUsers :: Type -> Type #

NFData DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

rnf :: DescribeUsers -> () #

Hashable DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

AWSPager DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

AWSRequest DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Associated Types

type AWSResponse DescribeUsers #

ToHeaders DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

ToPath DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

ToQuery DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

type Rep DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

type AWSResponse DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

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:include:DescribeUsers', describeUsers_include - The state of the users. Specify "ALL" to include inactive users.

$sel:userIds:DescribeUsers', describeUsers_userIds - The IDs of the users.

$sel:authenticationToken:DescribeUsers', describeUsers_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:sort:DescribeUsers', describeUsers_sort - The sorting criteria.

$sel:marker:DescribeUsers', describeUsers_marker - The marker for the next set of results. (You received this marker from a previous call.)

$sel:query:DescribeUsers', describeUsers_query - A query to filter users by user name.

$sel:limit:DescribeUsers', describeUsers_limit - The maximum number of items to return.

$sel:order:DescribeUsers', describeUsers_order - The order for the results.

$sel:organizationId:DescribeUsers', describeUsers_organizationId - The ID of the organization.

$sel:fields:DescribeUsers', describeUsers_fields - A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Request Lenses

describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType) Source #

The state of the users. Specify "ALL" to include inactive users.

describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text) Source #

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

describeUsers_marker :: Lens' DescribeUsers (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

describeUsers_query :: Lens' DescribeUsers (Maybe Text) Source #

A query to filter users by user name.

describeUsers_limit :: Lens' DescribeUsers (Maybe Natural) Source #

The maximum number of items to return.

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.

Destructuring the Response

data DescribeUsersResponse Source #

See: newDescribeUsersResponse smart constructor.

Constructors

DescribeUsersResponse' 

Fields

Instances

Instances details
Eq DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Read DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Show DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Generic DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Associated Types

type Rep DescribeUsersResponse :: Type -> Type #

NFData DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

rnf :: DescribeUsersResponse -> () #

type Rep DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

type Rep DescribeUsersResponse = D1 ('MetaData "DescribeUsersResponse" "Amazonka.WorkDocs.DescribeUsers" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "DescribeUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [User])) :*: S1 ('MetaSel ('Just "totalNumberOfUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:

$sel:users:DescribeUsersResponse', describeUsersResponse_users - The users.

$sel:totalNumberOfUsers:DescribeUsersResponse', describeUsersResponse_totalNumberOfUsers - The total number of users included in the results.

$sel:marker: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:httpStatus:DescribeUsersResponse', describeUsersResponse_httpStatus - The response's http status code.

Response Lenses

describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer) Source #

The total number of users included in the results.

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.