Request Syntax Request Parameters Response Elements Errors Examples See Also

CreateTags

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

Important

Do not store sensitive information (like personal data) in tags.

Request Syntax


{
   "configurationIds": [ "string" ],
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

configurationIds

A list of configuration items that you want to tag.

Type: Array of strings

Length Constraints: Maximum length of 200.

Pattern: \S*

Required: Yes

tags

Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example:

{"key": "serverType", "value": "webServer"}

Type: Array of Tag objects

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationErrorException

The user does not have permission to perform the action. Check the IAM policy associated with this user.

HTTP Status Code: 400

HomeRegionNotSetException

The home Region is not set. Set the home Region to continue.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid. Verify the parameters and try again.

HTTP Status Code: 400

InvalidParameterValueException

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

HTTP Status Code: 400

ResourceNotFoundException

The specified configuration ID was not located. Verify the configuration ID and try again.

HTTP Status Code: 400

ServerInternalErrorException

The server experienced an internal error. Try again.

HTTP Status Code: 500

Examples

Create tags for configuration items

The following example creates two tags, each with a key/value pair, and associates both tags to two Application Discovery Service discovered resources specified by the values passed to the parameter configurationIds in the request.

Sample Request



{
    "configurationIds": [
	      "d-server-08a4bce106f63340e",
	      "d-server-04dadef51d0a728f3"
    ],
    "tags": [ 
        { 
            "key": "ServerLocation",
            "value": "Warehouse"
        },
        { 
            "key": "MigrationPhase",
            "value": "PH1"
        }
    ]
}