Table Of Contents

Feedback

User Guide

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

[ aws . workmail ]

list-group-members

Description

Returns an overview of the members of a group.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-group-members 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: Members

Synopsis

  list-group-members
--organization-id <value>
--group-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 group exists.

--group-id (string)

The identifier for the group to which the members are associated.

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

See 'aws help' for descriptions of global parameters.

Examples

To list group members

This example lists members for the specified group.

Command:

aws workmail list-group-members --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 --group-id S-1-1-11-1122222222-2222233333-3333334444-4444

Output:

{
  "Members": [
      {
          "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333",
          "Name": "exampleUser1",
          "Type": "USER",
          "State": "ENABLED",
          "EnabledDate": 1532459261.827
      }

  ]
}

Output

Members -> (list)

The members associated to the group.

(structure)

The representation of a group member (user or group).

Id -> (string)

The identifier of the member.

Name -> (string)

The name of the member.

Type -> (string)

A member can be a user or group.

State -> (string)

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

EnabledDate -> (timestamp)

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

DisabledDate -> (timestamp)

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

NextToken -> (string)

The token to use to retrieve the next page of results. The first call does not contain any tokens.