[ aws . resource-groups ]

update-group

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--group-name (string)

Don’t use this parameter. Use Group instead.

--group (string)

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

--description (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 update description of the resource group.

GroupArn -> (string)

The ARN of the resource group.

Name -> (string)

The name of the resource group.

Description -> (string)

The description of the resource group.