AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Organizations::Types::TagResourceRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing TagResourceRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  resource_id: "TaggableResourceId", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#resource_idString

The ID of the resource to add a tag to.

Returns:

  • (String)

    The ID of the resource to add a tag to.

#tagsArray<Types::Tag>

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.

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.

Returns:

  • (Array<Types::Tag>)

    A list of tags to add to the specified resource.