class Aws::WorkDocs::Types::DescribeUsersRequest
@note When making an API call, you may pass DescribeUsersRequest
data as a 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", }
@!attribute [rw] authentication_token
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. @return [String]
@!attribute [rw] organization_id
The ID of the organization. @return [String]
@!attribute [rw] user_ids
The IDs of the users. @return [String]
@!attribute [rw] query
A query to filter users by user name. @return [String]
@!attribute [rw] include
The state of the users. Specify "ALL" to include inactive users. @return [String]
@!attribute [rw] order
The order for the results. @return [String]
@!attribute [rw] sort
The sorting criteria. @return [String]
@!attribute [rw] marker
The marker for the next set of results. (You received this marker from a previous call.) @return [String]
@!attribute [rw] limit
The maximum number of items to return. @return [Integer]
@!attribute [rw] fields
A comma-separated list of values. Specify "STORAGE\_METADATA" to include the user storage quota and utilization information. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsersRequest AWS API Documentation
Constants
- SENSITIVE