amazonka-workdocs-1.6.1: Amazon WorkDocs SDK.

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

Network.AWS.WorkDocs.DescribeUsers

Contents

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

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
Eq DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Data DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeUsers -> c DescribeUsers #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeUsers #

toConstr :: DescribeUsers -> Constr #

dataTypeOf :: DescribeUsers -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeUsers) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeUsers) #

gmapT :: (forall b. Data b => b -> b) -> DescribeUsers -> DescribeUsers #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeUsers -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeUsers -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeUsers -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeUsers -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeUsers -> m DescribeUsers #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeUsers -> m DescribeUsers #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeUsers -> m DescribeUsers #

Show DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Generic DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Associated Types

type Rep DescribeUsers :: Type -> Type #

Hashable DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

AWSPager DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

AWSRequest DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Associated Types

type Rs DescribeUsers :: Type #

ToHeaders DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

ToPath DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

ToQuery DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

NFData DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Methods

rnf :: DescribeUsers -> () #

type Rep DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

type Rs DescribeUsers Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Request Lenses

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

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

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

The IDs of the 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.)

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

A query to filter users by user name.

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

The maximum number of items to return.

duOrder :: Lens' DescribeUsers (Maybe OrderType) Source #

The order for the results.

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:

data DescribeUsersResponse Source #

See: describeUsersResponse smart constructor.

Instances
Eq DescribeUsersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Data DescribeUsersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeUsersResponse -> c DescribeUsersResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeUsersResponse #

toConstr :: DescribeUsersResponse -> Constr #

dataTypeOf :: DescribeUsersResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeUsersResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeUsersResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeUsersResponse -> DescribeUsersResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeUsersResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeUsersResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeUsersResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeUsersResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeUsersResponse -> m DescribeUsersResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeUsersResponse -> m DescribeUsersResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeUsersResponse -> m DescribeUsersResponse #

Read DescribeUsersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Show DescribeUsersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Generic DescribeUsersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Associated Types

type Rep DescribeUsersResponse :: Type -> Type #

NFData DescribeUsersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

Methods

rnf :: DescribeUsersResponse -> () #

type Rep DescribeUsersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeUsers

type Rep DescribeUsersResponse = D1 (MetaData "DescribeUsersResponse" "Network.AWS.WorkDocs.DescribeUsers" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DescribeUsersResponse'" PrefixI True) ((S1 (MetaSel (Just "_dursUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [User])) :*: S1 (MetaSel (Just "_dursTotalNumberOfUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 (MetaSel (Just "_dursMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dursResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

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.