Manage tags using the CLI or API

Use the following Amazon CLI commands or Amazon Batch API operations to add, update, list, and delete the tags for your resources.

Tag support for Amazon Batch resources
Task	API action	Amazon CLI	Amazon Tools for Windows PowerShell
Add or overwrite one or more tags.	TagResource	tag-resource	Add-BATResourceTag
Delete one or more tags.	UntagResource	untag-resource	Remove-BATResourceTag
List tags for a resource	ListTagsForResource	list-tags-for-resource	Get-BATResourceTag

The following examples show how to tag or untag resources using the Amazon CLI.

The following command tags an existing resource.


aws batch tag-resource --resource-arn resource_ARN --tags team=devs

The following command deletes a tag from an existing resource.


aws batch untag-resource --resource-arn resource_ARN --tag-keys tag_key

The following command lists the tags associated with an existing resource.


aws batch list-tags-for-resource --resource-arn resource_ARN

Some resource-creating actions enable you to specify tags when you create the resource. The following actions support tagging on creation.

Task	API action	Amazon CLI	Amazon Tools for Windows PowerShell
Create a compute environment	CreateComputeEnvironment	create-compute-environment	New-BATComputeEnvironment
Create a job queue	CreateJobQueue	create-job-queue	New-BATJobQueue
Create a scheduling policy	CreateSchedulingPolicy	create-scheduling-policy	New-BATSchedulingPolicy
Register a job definition	RegisterJobDefinition	register-job-definition	Register-BATJobDefinition
Submit a job	SubmitJob	submit-job	Submit-BATJob
Create a consumable resource	CreateConsumableResource	create-consumable-resource	Create-BATConsumableResource

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Tutorial: Manage tags using the console

Best practices