Table Of Contents

Feedback

User Guide

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

[ aws . workdocs ]

describe-groups

Description

Describes the groups specified by query.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-groups
[--authentication-token <value>]
--search-query <value>
[--organization-id <value>]
[--marker <value>]
[--limit <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--authentication-token (string)

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

--search-query (string)

A query to describe groups by group name.

--organization-id (string)

The ID of the organization.

--marker (string)

The marker for the next set of results. (You received this marker from a previous call.)

--limit (integer)

The maximum number of items to return with this call.

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

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

Groups -> (list)

The list of groups.

(structure)

Describes the metadata of a user group.

Id -> (string)

The ID of the user group.

Name -> (string)

The name of the group.

Marker -> (string)

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.