aws workdocs describe-users
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
Options
| Name | Description |
|---|---|
--authentication-token <string> | Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API |
--organization-id <string> | The ID of the organization |
--user-ids <string> | The IDs of the users |
--include <string> | The state of the users. Specify "ALL" to include inactive users |
--order <string> | The order for the results |
--sort <string> | The sorting criteria |
--marker <string> | The marker for the next set of results. (You received this marker from a previous call.) |
--limit <integer> | The maximum number of items to return |
--fields <string> | A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information |
--user-query <string> | A query to filter users by user name |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--starting-token <string> | A token to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--page-size <integer> | The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--max-items <integer> | The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI. For usage examples, see Pagination in the AWS Command Line Interface User Guide |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |