amazonka-workdocs-2.0: Amazon WorkDocs SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

  • authenticationToken :: Maybe (Sensitive Text)

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

  • fields :: Maybe Text

    A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

  • include :: Maybe UserFilterType

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

  • limit :: Maybe Natural

    The maximum number of items to return.

  • marker :: Maybe Text

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

  • order :: Maybe OrderType

    The order for the results.

  • organizationId :: Maybe Text

    The ID of the organization.

  • query :: Maybe (Sensitive Text)

    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 the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma 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 on Ma J only returns Mateo Jackson.
  • sort :: Maybe UserSortType

    The sorting criteria.

  • userIds :: Maybe Text

    The IDs of the users.

Instances

Instances details
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 #

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 :: (Service -> Service) -> DescribeUsers -> Request DescribeUsers #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUsers))) #

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 #

Show DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

showsPrec :: Int -> DescribeUsers -> ShowS #

show :: DescribeUsers -> String #

showList :: [DescribeUsers] -> ShowS #

NFData DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

rnf :: DescribeUsers -> () #

Eq DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

(==) :: DescribeUsers -> DescribeUsers -> Bool #

(/=) :: DescribeUsers -> DescribeUsers -> Bool #

Hashable DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

hashWithSalt :: Int -> DescribeUsers -> Int #

hash :: DescribeUsers -> Int #

type AWSResponse DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

type AWSResponse DescribeUsers = DescribeUsersResponse
type Rep DescribeUsers Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

type Rep DescribeUsers = D1 ('MetaData "DescribeUsers" "Amazonka.WorkDocs.DescribeUsers" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeUsers'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserFilterType)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrderType)) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "sort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSortType)) :*: S1 ('MetaSel ('Just "userIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

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 the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma 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 on Ma 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 the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma 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 on Ma 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.

Constructors

DescribeUsersResponse' 

Fields

Instances

Instances details
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 #

Show DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

showsPrec :: Int -> DescribeUsersResponse -> ShowS #

show :: DescribeUsersResponse -> String #

showList :: [DescribeUsersResponse] -> ShowS #

NFData DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

rnf :: DescribeUsersResponse -> () #

Eq DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

Methods

(==) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool #

(/=) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool #

type Rep DescribeUsersResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeUsers

type Rep DescribeUsersResponse = D1 ('MetaData "DescribeUsersResponse" "Amazonka.WorkDocs.DescribeUsers" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "totalNumberOfUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [User])) :*: 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:

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.