Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

create_group

create_group(**kwargs)

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.

The permissions resource is arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name> .

The response is a group object.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    GroupName='string',
    Description='string',
    AwsAccountId='string',
    Namespace='string'
)
Parameters
  • GroupName (string) --

    [REQUIRED]

    A name for the group that you want to create.

  • Description (string) -- A description for the group that you want to create.
  • 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 that you want the group to be a part of.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    The response object for this operation.

    • 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

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