CmdID / aws / aws workdocs

aws workdocs describe-groups

Describes the groups specified by the query. AWS CLI reference

1 example 5 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 describe-groups example lists the groups associated with the specified Amazon WorkDocs organization.

aws workdocs describe-groups --search-query "e" --organization-id d-123456789cIdentify

--search-queryA query to describe groups by group name.

--organization-idThe ID of the organization.

Its output

{
    "Groups": [
        {
            "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444&d-123456789c",
            "Name": "Example Group 1"
        },
        {
            "Id": "S-1-1-11-1122222222-2222233333-3333334444-5555&d-123456789c",
            "Name": "Example Group 2"
        }
    ]
}

Options

5 in the AWS CLI reference

--authentication-tokenAmazon WorkDocs authentication token.

--limitThe maximum number of items to return with this call.

--markerThe marker for the next set of results.

--organization-idThe ID of the organization.

--search-queryA query to describe groups by group name.