Network.AWS.WorkDocs.DescribeUsers

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.

Creating a Request

describeUsers :: DescribeUsers

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

See: describeUsers smart constructor.

Instances

Eq DescribeUsers

Methods

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

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

Data 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

Methods

showsPrec :: Int -> DescribeUsers -> ShowS

show :: DescribeUsers -> String

showList :: [DescribeUsers] -> ShowS

Generic DescribeUsers

Associated Types

type Rep DescribeUsers :: * -> *

Methods

from :: DescribeUsers -> Rep DescribeUsers x

to :: Rep DescribeUsers x -> DescribeUsers

Hashable DescribeUsers

Methods

hashWithSalt :: Int -> DescribeUsers -> Int

hash :: DescribeUsers -> Int

NFData DescribeUsers

Methods

rnf :: DescribeUsers -> ()

AWSPager DescribeUsers

Methods

page :: DescribeUsers -> Rs DescribeUsers -> Maybe DescribeUsers

AWSRequest DescribeUsers

Associated Types

type Rs DescribeUsers :: *

Methods

request :: DescribeUsers -> Request DescribeUsers

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeUsers -> ClientResponse -> m (Response DescribeUsers)

ToHeaders DescribeUsers

Methods

toHeaders :: DescribeUsers -> [Header]

ToPath DescribeUsers

Methods

toPath :: DescribeUsers -> ByteString

ToQuery DescribeUsers

Methods

toQuery :: DescribeUsers -> QueryString

type Rep DescribeUsers

type Rep DescribeUsers = D1 * (MetaData "DescribeUsers" "Network.AWS.WorkDocs.DescribeUsers" "amazonka-workdocs-1.6.0-1U8VphMWtKAbdAmu8y8qj" False) (C1 * (MetaCons "DescribeUsers'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_duInclude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserFilterType))) (S1 * (MetaSel (Just Symbol "_duUserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_duAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_duSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserSortType))) (S1 * (MetaSel (Just Symbol "_duMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_duQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) (S1 * (MetaSel (Just Symbol "_duLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_duOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OrderType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_duOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_duFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

type Rs DescribeUsers

type Rs DescribeUsers = DescribeUsersResponse

Request Lenses

duInclude :: Lens' DescribeUsers (Maybe UserFilterType)

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

duUserIds :: Lens' DescribeUsers (Maybe Text)

The IDs of the users.

duAuthenticationToken :: Lens' DescribeUsers (Maybe Text)

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)

The sorting criteria.

duMarker :: Lens' DescribeUsers (Maybe Text)

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

duQuery :: Lens' DescribeUsers (Maybe Text)

A query to filter users by user name.

duLimit :: Lens' DescribeUsers (Maybe Natural)

The maximum number of items to return.

duOrder :: Lens' DescribeUsers (Maybe OrderType)

The order for the results.

duOrganizationId :: Lens' DescribeUsers (Maybe Text)

The ID of the organization.

duFields :: Lens' DescribeUsers (Maybe Text)

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

Destructuring the Response

describeUsersResponse

Arguments

:: Int

dursResponseStatus

-> DescribeUsersResponse

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

See: describeUsersResponse smart constructor.

Instances

Eq DescribeUsersResponse

Methods

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

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

Data DescribeUsersResponse

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

Methods

readsPrec :: Int -> ReadS DescribeUsersResponse

readList :: ReadS [DescribeUsersResponse]

readPrec :: ReadPrec DescribeUsersResponse

readListPrec :: ReadPrec [DescribeUsersResponse]

Show DescribeUsersResponse

Methods

showsPrec :: Int -> DescribeUsersResponse -> ShowS

show :: DescribeUsersResponse -> String

showList :: [DescribeUsersResponse] -> ShowS

Generic DescribeUsersResponse

Associated Types

type Rep DescribeUsersResponse :: * -> *

Methods

from :: DescribeUsersResponse -> Rep DescribeUsersResponse x

to :: Rep DescribeUsersResponse x -> DescribeUsersResponse

NFData DescribeUsersResponse

Methods

rnf :: DescribeUsersResponse -> ()

type Rep DescribeUsersResponse

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

Response Lenses

dursUsers :: Lens' DescribeUsersResponse [User]

The users.

dursTotalNumberOfUsers :: Lens' DescribeUsersResponse (Maybe Integer)

The total number of users included in the results.

dursMarker :: Lens' DescribeUsersResponse (Maybe Text)

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

• - | The response status code.