Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . resource-groups ]

update-group

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-group
--group-name <value>
[--description <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--group-name (string)

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

--description (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To update the description for a resource group

This example updates the description for a group named WebServer3 in the current region.

Command:

aws resource-groups update-group --group-name WebServer3 --description "Group of web server resources."

Output:

{
  "Group": {
      "GroupArn": "arn:aws:resource-groups:us-east-2:000000000000:group/WebServer3",
      "Name": "WebServer3"
              "Description": "Group of web server resources."
  }

}

Output

Group -> (structure)

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

GroupArn -> (string)

The ARN of a resource group.

Name -> (string)

The name of a resource group.

Description -> (string)

The description of the resource group.