QuickSight / Client / describe_group

describe_group#

QuickSight.Client.describe_group(**kwargs)#

Returns an Amazon QuickSight group’s description and Amazon Resource Name (ARN).

See also: AWS API Documentation

Request Syntax

response = client.describe_group(
    GroupName='string',
    AwsAccountId='string',
    Namespace='string'
)
Parameters:

  • GroupName (string) –

    [REQUIRED]

    The name of the group that you want to describe.

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

  • Namespace (string) –

    [REQUIRED]

    The namespace of the group that you want described.

Return type:

dict

Returns:

Response Syntax

{
    'Group': {
        'Arn': 'string',
        'GroupName': 'string',
        'Description': 'string',
        'PrincipalId': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • Group (dict) –

      The name of the group.

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

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions