WorkDocs / Client / describe_groups

describe_groups#

WorkDocs.Client.describe_groups(**kwargs)#

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

See also: AWS API Documentation

Request Syntax

response = client.describe_groups(
    AuthenticationToken='string',
    SearchQuery='string',
    OrganizationId='string',
    Marker='string',
    Limit=123
)
Parameters:

  • AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • SearchQuery (string) –

    [REQUIRED]

    A query to describe groups by group name.

  • OrganizationId (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.

Return type:

dict

Returns:

Response Syntax

{
    'Groups': [
        {
            'Id': 'string',
            'Name': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –

    • Groups (list) –

      The list of groups.

      • (dict) –

        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.

Exceptions

  • WorkDocs.Client.exceptions.UnauthorizedOperationException

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.FailedDependencyException

  • WorkDocs.Client.exceptions.ServiceUnavailableException