[ aws . workmail ]



Returns the data available for the group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--organization-id <value>
--group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--organization-id (string)

The identifier for the organization under which the group exists.

--group-id (string)

The identifier for the group to be described.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.


To retrieve information for a group

The following describe-group command retrieves information about the specified group.

aws workmail describe-group \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --group-id S-1-1-11-1122222222-2222233333-3333334444-4444


    "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444",
    "Name": "exampleGroup1",
    "State": "ENABLED"


GroupId -> (string)

The identifier of the described group.

Name -> (string)

The name of the described group.

Email -> (string)

The email of the described group.

State -> (string)

The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

EnabledDate -> (timestamp)

The date and time when a user was registered to WorkMail, in UNIX epoch time format.

DisabledDate -> (timestamp)

The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.