TagResource - AWS Batch

TagResource

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

Request Syntax

POST /v1/tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

resourceArn

The Amazon Resource Name (ARN) of the resource to which to add tags. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

Required: Yes

Request Body

The request accepts the following data in JSON format.

tags

The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example adds a tag to the job definition with an ARN of "arn:aws:batch:us-east-1:12345678012:job-definition/sleep30:1".

Sample Request

POST /v1/tags/arn%3Aaws%3Abatch%3Aus-east-1%3A12345678012%3Ajob-definition%2Fsleep30%3A1 HTTP/1.1 Host: batch.us-east-1.amazonaws.com Accept-Encoding: identity X-Amz-Date: 20200604T172359Z X-Amz-Security-Token: [security-token] Authorization: AUTHPARAMS Content-Length: [length-of-JSON] { "tags": { "Stage": "alpha" } }

Sample Response

HTTP/1.1 204 No Content Date: Thu, 05 Jun 2020 17:24:04 GMT Content-Type: application/json Content-Length: 0 x-amzn-RequestId: [request-id] Access-Control-Allow-Origin: * x-amz-apigw-id: [apigw-id] X-Amzn-Trace-Id: [trace-id] Connection: keep-alive

See Also

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