Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . workmail ]

list-users

Description

Returns summaries of the organization's users.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-users is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Users

Synopsis

  list-users
--organization-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The identifier for the organization under which the users exist.

--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.

--starting-token (string)

A token to specify where to start paginating. This is the next-token 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 next-token is provided in the command's output. To resume pagination, provide the next-token value in the starting-token argument of a subsequent command. Do not use the next-token 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.

See 'aws help' for descriptions of global parameters.

Output

Users -> (list)

The overview of users for an organization.

(structure)

The representation of an Amazon WorkMail user.

Id -> (string)

The identifier of the user.

Email -> (string)

The email of the user.

Name -> (string)

The name of the user.

DisplayName -> (string)

The display name of the user.

State -> (string)

The state of the user, which can be ENABLED, DISABLED, or DELETED.

UserRole -> (string)

The role of the user.

EnabledDate -> (timestamp)

The date indicating when the user was enabled for Amazon WorkMail use.

DisabledDate -> (timestamp)

The date indicating when the user was disabled from Amazon WorkMail use.

NextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.