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

UpdateGroup

Updates the description for an existing group. You cannot update the name of a resource group.

Minimum permissions

To run this command, you must have the following permissions:

resource-groups:UpdateGroup

Request Syntax


POST /update-group HTTP/1.1
Content-type: application/json

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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Description

The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.

Type: String

Length Constraints: Maximum length of 1024.

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

Required: No

Group

The name or the ARN of the resource group to modify.

Type: String

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

Pattern: (arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/)?[a-zA-Z0-9_\.-]{1,300}

Required: No

GroupName

This parameter has been deprecated.

Don't use this parameter. Use Group instead.

Type: String

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

Pattern: [a-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.

Group

The update description of the resource group.

Type: Group object

Errors

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

BadRequestException

The request includes one or more parameters that violate validation rules.

HTTP Status Code: 400

ForbiddenException

The caller isn't authorized to make the request. Check permissions.

HTTP Status Code: 403

InternalServerErrorException

An internal error occurred while processing the request. Try again later.

HTTP Status Code: 500

MethodNotAllowedException

The request uses an HTTP method that isn't allowed for the specified resource.

HTTP Status Code: 405

NotFoundException

One or more of the specified resources don't exist.

HTTP Status Code: 404

TooManyRequestsException

You've exceeded throttling limits by making too many requests in a period of time.

HTTP Status Code: 429

Examples

Example

The following example adds or updates the description attached to the specified resource group.

Sample Request


POST /update-group HTTP/1.1
Host: resource-groups.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.40 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/resource-groups.update-group
X-Amz-Date: 20220120T224252Z
X-Amz-Security-Token: <SECURITY-TOKEN>
Authorization: AWS4-HMAC-SHA256 Credential=<ACCESS-KEY>/20220113/us-west-2/resource-groups/aws4_request,SignedHeaders=host;x-amz-date;x-amz-security-token,Signature=<SIGV4-SIGNATURE>
Content-Length: 51

{
    "Group": "MyTest",
    "Description": "My Test group"
}

Sample Response


HTTP/1.1 200 OK
Date: Thu, 20 Jan 2022 22:42:52 GMT
Content-Type: application/json
Content-Length: 155
x-amzn-RequestId: <VARIES>
x-amz-apigw-id: <VARIES>
X-Amzn-Trace-Id: Root=<VARIES>
Connection: keep-alive

{
    "Group":{
        "GroupArn":"arn:aws:resource-groups:us-west-2:123456789012:group/MyTest",
        "Name":"MyTest",
        "Description":"My Test group",
        "OwnerId":"123456789012"
    }
}