CmdID / aws / aws workmail

aws workmail list-groups

Returns summaries of the organization's groups. AWS CLI reference

1 example 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To retrieve a list of groups

The following list-groups example retrieves summaries of the groups in the specified organization.

aws workmail list-groups --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27Identify

--organization-idThe identifier for the organization under which the groups exist.

Its output

{
    "Groups": [
        {
            "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444",
            "Name": "exampleGroup1",
            "State": "DISABLED"
        },
        {
            "Id": "S-4-4-44-1122222222-2222233333-3333334444-4444",
            "Name": "exampleGroup2",
            "State": "ENABLED"
        }
    ]
}

For more information, see Viewing a list of groups in the Amazon WorkMail Administrator Guide.

Options

4 in the AWS CLI reference

--filtersLimit the search results based on the filter criteria.

--max-resultsThe maximum number of results to return in a single call.

--next-tokenThe token to use to retrieve the next page of results.

--organization-idThe identifier for the organization under which the groups exist.