UpdateGroup

Changes a group description.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The response is a group object.

CLI Sample:

aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"

Request Syntax

PUT /accounts/AwsAccountId/namespaces/Namespace/groups/GroupName HTTP/1.1 Content-type: application/json { "Description": "string" }

URI Request Parameters

The request requires 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}$

GroupName

The name of the group that you want to update.

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Namespace

The namespace. Currently, you should set this to default.

Pattern: default

Request Body

The request accepts the following data in JSON format.

Description

The description for the group that you want to update.

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" }, "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 Client Errors.

AccessDeniedException

You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters don't have a valid value.

HTTP Status Code: 400

PreconditionNotMetException

One or more preconditions aren't met.

HTTP Status Code: 400

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: