PUT

/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}

Changes a group description.

Access Token Required: API Key

Path Parameters

GroupNamestringrequired

The name of the group that you want to update.

AwsAccountIdstringrequired

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.

Namespacestringrequired

The namespace of the group that you want to update.

Body Params

Descriptionstring

The description for the group that you want to update.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}