list_groups

list_groups(**kwargs)

Lists all user groups in Amazon QuickSight.

See also: AWS API Documentation

Request Syntax

response = client.list_groups(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Namespace='string'
)
Parameters
  • AwsAccountId (string) --

    [REQUIRED]

    The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • NextToken (string) -- A pagination token that can be used in a subsequent request.
  • MaxResults (integer) -- The maximum number of results to return.
  • Namespace (string) --

    [REQUIRED]

    The namespace that you want a list of groups from.

Return type

dict

Returns

Response Syntax

{
    'GroupList': [
        {
            'Arn': 'string',
            'GroupName': 'string',
            'Description': 'string',
            'PrincipalId': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • GroupList (list) --

      The list of the groups.

      • (dict) --

        A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

        • Arn (string) --

          The Amazon Resource Name (ARN) for the group.

        • GroupName (string) --

          The name of the group.

        • Description (string) --

          The group description.

        • PrincipalId (string) --

          The principal ID of the group.

    • NextToken (string) --

      A pagination token that can be used in a subsequent request.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException
  • QuickSight.Client.exceptions.InvalidParameterValueException
  • QuickSight.Client.exceptions.ResourceNotFoundException
  • QuickSight.Client.exceptions.ThrottlingException
  • QuickSight.Client.exceptions.InvalidNextTokenException
  • QuickSight.Client.exceptions.PreconditionNotMetException
  • QuickSight.Client.exceptions.InternalFailureException
  • QuickSight.Client.exceptions.ResourceUnavailableException