Resource Groups Tagging API
API Reference (API Version 2017-01-26)

UntagResources

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.

Request Syntax

{ "ResourceARNList": [ "string" ], "TagKeys": [ "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.

ResourceARNList

A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

Pattern: [\s\S]*

Required: Yes

TagKeys

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

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

Pattern: [\s\S]*

Required: Yes

Response Syntax

{ "FailedResourcesMap": { "string" : { "ErrorCode": "string", "ErrorMessage": "string", "StatusCode": number } } }

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.

FailedResourcesMap

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

Type: String to FailureInfo object map

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

Key Pattern: [\s\S]*

Errors

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

InternalServiceException

The request processing failed because of an unknown error, exception, or failure. You can retry the request.

HTTP Status Code: 500

InvalidParameterException

This error indicates one of the following:

  • A parameter is missing.

  • A malformed string was supplied for the request parameter.

  • An out-of-range value was supplied for the request parameter.

  • The target ID is invalid, unsupported, or doesn't exist.

  • You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.

HTTP Status Code: 400

ThrottledException

The request was denied to limit the frequency of submitted requests.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1 Host: tagging.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 74 X-Amz-Target: ResourceGroupsTaggingAPI_20170126.UntagResources X-Amz-Date: 20170421T215122Z User-Agent: aws-cli/1.11.79 Python/2.7.9 Windows/7 botocore/1.5.42 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "TagKeys": [ "key" ], "ResourceARNList": [ "arn:aws:s3:::examplebucket" ] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: a923ddd9-26dc-11e7-bf86-49f2fe9ee8df Content-Type: application/x-amz-json-1.1 Content-Length: 25 Date: Fri, 21 Apr 2017 21:51:23 GMT { "FailedResourcesMap": {} }

See Also

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