AWS Resource Groups
Welcome (API Version 2017-11-27)


Updates an existing group with a new or changed description. You cannot update the name of a resource group.

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.


The name of the resource group for which you want to update its description.

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

Pattern: [a-zA-Z0-9_\.-]+

Request Body

The request accepts the following data in JSON format.


The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [\sa-zA-Z0-9_\.-]*

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Group": { "Description": "string", "GroupArn": "string", "Name": "string" } }

Response Elements

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

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


The full description of the resource group after it has been updated.

Type: Group object


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


The request does not comply with validation rules that are defined for the request parameters.

HTTP Status Code: 400


The caller is not authorized to make the request.

HTTP Status Code: 403


An internal error occurred while processing the request.

HTTP Status Code: 500


The request uses an HTTP method which is not allowed for the specified resource.

HTTP Status Code: 405


One or more resources specified in the request do not exist.

HTTP Status Code: 404


The caller has exceeded throttling limits.

HTTP Status Code: 429


Sample Request

PUT /groups/TestGroup HTTP/1.1 Content-type: application/json { "Description": "Resources used in QA and production stages of development." }

Sample Response

HTTP/1.1 200 Content-type: application/json { "Group": { "Description": "Resources used in QA and production stages of development.", "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/TestGroup", "Name": "TestGroup" } }

See Also

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