[ aws . resourcegroupstaggingapi ]



Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see this list .

  • You can only tag resources that are located in the specified Region for the AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--resource-arn-list <value>
--tag-keys <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--resource-arn-list (list)

A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .



"string" "string" ...

--tag-keys (list)

A list of the tag keys that you want to remove from the specified resources.



"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To remove a tag from a resource

The following untag-resources example removes the specified tag keys and associated values from a resource.

aws resourcegroupstaggingapi untag-resources \
    --resource-arn-list arn:aws:s3:::awsexamplebucket \
    --tag-keys Environment,CostCenter


    "FailedResourcesMap": {}

For more information, see UntagResources in the Resource Groups Tagging API Reference.


FailedResourcesMap -> (map)

Details of resources that could not be untagged. An error code, status code, and error message are returned for each failed item.

key -> (string)

value -> (structure)

Information about the errors that are returned for each failed resource. This information can include InternalServiceException and InvalidParameterException errors. It can also include any valid error code returned by the AWS service that hosts the resource that the ARN key represents.

The following are common error codes that you might receive from other AWS services:

For more information on errors that are generated from other AWS services, see the documentation for that service.

StatusCode -> (integer)

The HTTP status code of the common error.

ErrorCode -> (string)

The code of the common error. Valid values include InternalServiceException , InvalidParameterException , and any valid error code returned by the AWS service that hosts the resource that you want to tag.

ErrorMessage -> (string)

The message of the common error.