Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeTags

Describes one or more of the tags for your Amazon ML object.

Request Syntax


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

Type: String

Valid Values: BatchPrediction | DataSource | Evaluation | MLModel

Required: Yes

Response Syntax


{
   "ResourceId": "string",
   "ResourceType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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 tagged ML object.

Type: String

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

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

ResourceType

The type of the tagged ML object.

Type: String

Valid Values: BatchPrediction | DataSource | Evaluation | MLModel

Tags

A list of tags associated with the ML object.

Type: Array of Tag objects

Array Members: Maximum number of 100 items.

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

ResourceNotFoundException

A specified resource cannot be located.

HTTP Status Code: 400

Examples

The following are an example request and response for the DescribeTags operation.

This example illustrates one usage of DescribeTags.

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.DescribeTags
{
  "ResourceId": "exampleModelId", 
  "ResourceType": "MLModel"
}

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", 
  "Tags": {
      "Key":"exampleKey",
	  "Value":"exampleKeyValue"
  }
}