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 . organizations ]

tag-resource

Description

Adds one or more tags to the specified resource.

Currently, you can attach tags to the following resources in AWS Organizations.

  • AWS account
  • Organization root
  • Organizational unit (OU)
  • Policy (any type)

This operation can be called only from the organization's management account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  tag-resource
--resource-id <value>
--tags <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--resource-id (string)

The ID of the resource to add a tag to.

--tags (list)

A list of tags to add to the specified resource.

You can specify any of the following taggable resources.

  • AWS account – specify the account ID number.
  • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ``ou-1a2b-34uvwxyz ``
  • Root – specify the root ID that begins with r- and looks similar to: ``r-1a2b ``
  • Policy – specify the policy ID that begins with p- andlooks similar to: ``p-12abcdefg3 ``

For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null .

Note

If any one of the tags is invalid or if you exceed the allowed number of tags for an account user, then the entire request fails and the account is not created.

(structure)

A custom key-value pair associated with a resource within your organization.

You can attach tags to any of the following organization resources.

  • AWS account
  • Organizational unit (OU)
  • Organization root
  • Policy

Key -> (string)

The key identifier, or name, of the tag.

Value -> (string)

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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.

Output

None