You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::WorkDocs::Types::DescribeUsersRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkDocs::Types::DescribeUsersRequest
- Defined in:
- (unknown)
Overview
When passing DescribeUsersRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
authentication_token: "AuthenticationHeaderType",
organization_id: "IdType",
user_ids: "UserIdsType",
query: "SearchQueryType",
include: "ALL", # accepts ALL, ACTIVE_PENDING
order: "ASCENDING", # accepts ASCENDING, DESCENDING
sort: "USER_NAME", # accepts USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED
marker: "PageMarkerType",
limit: 1,
fields: "FieldNamesType",
}
Instance Attribute Summary collapse
-
#authentication_token ⇒ String
Amazon WorkDocs authentication token.
-
#fields ⇒ String
A comma-separated list of values.
-
#include ⇒ String
The state of the users.
-
#limit ⇒ Integer
The maximum number of items to return.
-
#marker ⇒ String
The marker for the next set of results.
-
#order ⇒ String
The order for the results.
-
#organization_id ⇒ String
The ID of the organization.
-
#query ⇒ String
A query to filter users by user name.
-
#sort ⇒ String
The sorting criteria.
-
#user_ids ⇒ String
The IDs of the users.
Instance Attribute Details
#authentication_token ⇒ String
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
#fields ⇒ String
A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the user storage quota and utilization information.
#include ⇒ String
The state of the users. Specify \"ALL\" to include inactive users.
Possible values:
- ALL
- ACTIVE_PENDING
#limit ⇒ Integer
The maximum number of items to return.
#marker ⇒ String
The marker for the next set of results. (You received this marker from a previous call.)
#order ⇒ String
The order for the results.
Possible values:
- ASCENDING
- DESCENDING
#organization_id ⇒ String
The ID of the organization.
#query ⇒ String
A query to filter users by user name.
#sort ⇒ String
The sorting criteria.
Possible values:
- USER_NAME
- FULL_NAME
- STORAGE_LIMIT
- USER_STATUS
- STORAGE_USED
#user_ids ⇒ String
The IDs of the users.