Menu
Amazon Machine Learning
API Reference (API Version 2014-12-12)

AddTags

Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value.

Request Syntax

{
   "ResourceId": "string",
   "ResourceType": "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.

ResourceId

The ID of the ML object to tag. For example, exampleModelId.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

ResourceType

The type of the ML object to tag.

Type: String

Valid Values: BatchPrediction | DataSource | Evaluation | MLModel

Required: Yes

Tags

The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.

Type: Array of Tag objects

Array Members: Maximum number of 100 items.

Required: Yes

Response Syntax

{
   "ResourceId": "string",
   "ResourceType": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

ResourceId

The ID of the ML object that was tagged.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9_.-]+

ResourceType

The type of the ML object that was tagged.

Type: String

Valid Values: BatchPrediction | DataSource | Evaluation | MLModel

Errors

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

InternalServerException

An error on the server occurred when trying to process a request.

HTTP Status Code: 500

InvalidInputException

An error on the client occurred. Typically, the cause is an invalid input value.

HTTP Status Code: 400

InvalidTagException

HTTP Status Code: 400

ResourceNotFoundException

A specified resource cannot be located.

HTTP Status Code: 400

TagLimitExceededException

HTTP Status Code: 400

Example

The following is an example of a request and response for the AddTags operation.

Sample Request

POST / HTTP/1.1
Host: machinelearning.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonML_20141212.AddTags
{
  "ResourceId": "exampleModelId", 
  "ResourceType": "MLModel", 
  "Tags": {
      "Key":"exampleKey",
      "Value":"exampleKeyValue"
  }
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
  "ResourceId": "exampleModelId", 
  "ResourceType": "MLModel"
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: