Copyright	(c) 2013-2021 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

Amazonka.WorkDocs.DescribeUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data DescribeUsers = DescribeUsers' {
- include :: Maybe UserFilterType
- userIds :: Maybe Text
- authenticationToken :: Maybe (Sensitive Text)
- sort :: Maybe UserSortType
- marker :: Maybe Text
- query :: Maybe (Sensitive Text)
- limit :: Maybe Natural
- order :: Maybe OrderType
- organizationId :: Maybe Text
- fields :: Maybe Text
}
newDescribeUsers :: DescribeUsers
describeUsers_include :: Lens' DescribeUsers (Maybe UserFilterType)
describeUsers_userIds :: Lens' DescribeUsers (Maybe Text)
describeUsers_authenticationToken :: Lens' DescribeUsers (Maybe Text)
describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType)
describeUsers_marker :: Lens' DescribeUsers (Maybe Text)
describeUsers_query :: Lens' DescribeUsers (Maybe Text)
describeUsers_limit :: Lens' DescribeUsers (Maybe Natural)
describeUsers_order :: Lens' DescribeUsers (Maybe OrderType)
describeUsers_organizationId :: Lens' DescribeUsers (Maybe Text)
describeUsers_fields :: Lens' DescribeUsers (Maybe Text)
data DescribeUsersResponse = DescribeUsersResponse' {
- users :: Maybe [User]
- totalNumberOfUsers :: Maybe Integer
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeUsersResponse :: Int -> DescribeUsersResponse
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
describeUsersResponse_totalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)
describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)
describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int

Creating a Request

data DescribeUsers Source #

See: newDescribeUsers smart constructor.

Constructors

DescribeUsers'

Fields

include :: Maybe UserFilterType
The state of the users. Specify "ALL" to include inactive users.
userIds :: Maybe Text
The IDs of the users.
authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
sort :: Maybe UserSortType
The sorting criteria.
marker :: Maybe Text
The marker for the next set of results. (You received this marker from a previous call.)
query :: Maybe (Sensitive Text)
A query to filter users by user name.
limit :: Maybe Natural
The maximum number of items to return.
order :: Maybe OrderType
The order for the results.
organizationId :: Maybe Text
The ID of the organization.
fields :: Maybe Text
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Instances

Instances details

Eq DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods (==) :: DescribeUsers -> DescribeUsers -> Bool # (/=) :: DescribeUsers -> DescribeUsers -> Bool #
Show DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods showsPrec :: Int -> DescribeUsers -> ShowS # show :: DescribeUsers -> String # showList :: [DescribeUsers] -> ShowS #
Generic DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Associated Types type Rep DescribeUsers :: Type -> Type # Methods from :: DescribeUsers -> Rep DescribeUsers x # to :: Rep DescribeUsers x -> DescribeUsers #
NFData DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods rnf :: DescribeUsers -> () #
Hashable DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods hashWithSalt :: Int -> DescribeUsers -> Int # hash :: DescribeUsers -> Int #
AWSPager DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods page :: DescribeUsers -> AWSResponse DescribeUsers -> Maybe DescribeUsers #
AWSRequest DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Associated Types type AWSResponse DescribeUsers # Methods request :: DescribeUsers -> Request DescribeUsers # response :: MonadResource m => Logger -> Service -> Proxy DescribeUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUsers))) #
ToHeaders DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods toHeaders :: DescribeUsers -> [Header] #
ToPath DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods toPath :: DescribeUsers -> ByteString #
ToQuery DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods toQuery :: DescribeUsers -> QueryString #
type Rep DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers type Rep DescribeUsers = D1 ('MetaData "DescribeUsers" "Amazonka.WorkDocs.DescribeUsers" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "DescribeUsers'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserFilterType)) :: S1 ('MetaSel ('Just "userIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "sort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSortType)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrderType)) :: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))
type AWSResponse DescribeUsers Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers type AWSResponse DescribeUsers = DescribeUsersResponse

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_userIds :: Lens' DescribeUsers (Maybe Text) Source #

The IDs of the users.

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

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

describeUsers_sort :: Lens' DescribeUsers (Maybe UserSortType) Source #

The sorting criteria.

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_order :: Lens' DescribeUsers (Maybe OrderType) Source #

The order for the results.

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

The ID of the organization.

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 users :: Maybe [User] The users. totalNumberOfUsers :: Maybe Integer The total number of users included in the results. marker :: Maybe Text The marker to use when requesting the next set of results. If there are no additional results, the string is empty. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeUsersResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods (==) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool # (/=) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool #
Read DescribeUsersResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods readsPrec :: Int -> ReadS DescribeUsersResponse # readList :: ReadS [DescribeUsersResponse] # readPrec :: ReadPrec DescribeUsersResponse # readListPrec :: ReadPrec [DescribeUsersResponse] #
Show DescribeUsersResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Methods showsPrec :: Int -> DescribeUsersResponse -> ShowS # show :: DescribeUsersResponse -> String # showList :: [DescribeUsersResponse] -> ShowS #
Generic DescribeUsersResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeUsers Associated Types type Rep DescribeUsersResponse :: Type -> Type # Methods from :: DescribeUsersResponse -> Rep DescribeUsersResponse x # to :: Rep DescribeUsersResponse x -> DescribeUsersResponse #
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 #

Arguments

:: Int	`$sel:httpStatus:DescribeUsersResponse'`
-> DescribeUsersResponse

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_users :: Lens' DescribeUsersResponse (Maybe [User]) Source #

The users.

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.

describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int Source #

The response's http status code.