UntagResource
This operation removes the specified user-defined tags from an S3 resource. You can pass one or more tag keys.
Note
This operation is only supported for the following Amazon S3 resources:
- Permissions
-
For Storage Lens groups and S3 Access Grants, you must have the
s3:UntagResource
permission to use this operation.For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
- Directory bucket permissions
-
For directory buckets, you must have the
s3express:UntagResource
permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide. - HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com
.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
Request Syntax
DELETE /v20180820/tags/resourceArn+
?tagKeys=TagKeys
HTTP/1.1
Host: s3-control.amazonaws.com
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- resourceArn
-
The Amazon Resource Name (ARN) of the S3 resource that you're removing tags from. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
Length Constraints: Maximum length of 1011.
Pattern:
arn:[^:]+:s3(express)?:[^:].*
Required: Yes
- tagKeys
-
The array of tag key-value pairs that you're trying to remove from of the S3 resource.
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Required: Yes
- x-amz-account-id
-
The AWS account ID that owns the resource that you're trying to remove the tags from.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: