Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateGroup

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.

Request Syntax


POST /accounts/AwsAccountId/namespaces/Namespace/groups HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "GroupName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

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

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Namespace

The namespace that you want the group to be a part of.

Length Constraints: Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$

Required: Yes

Request Body

The request accepts the following data in JSON format.

GroupName

A name for the group that you want to create.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Required: Yes

Description

A description for the group that you want to create.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Group": { 
      "Arn": "string",
      "Description": "string",
      "GroupName": "string",
      "PrincipalId": "string"
   },
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

Group

The name of the group.

Type: Group object

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

PreconditionNotMetException

One or more preconditions aren't met.

HTTP Status Code: 400

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

HTTP Status Code: 429