Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

The following update-group example updates the description for the specified resource group.

aws resource-groups update-group \
    --group-name tbq-WebServer \
    --description "Resource group for all web server resources."

Output:

{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
        "Description": "Resource group for all web server resources."
    }
}

For more information, see Update Groups in the AWS Resource Groups User Guide.

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.