S3Control / Client / untag_resource
untag_resource¶
- S3Control.Client.untag_resource(**kwargs)¶
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:UntagResourcepermission 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 and access points for directory buckets, you must have the
s3express:UntagResourcepermission 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.
Warning
You must URL encode any signed header values that contain spaces. For example, if your header value is
my file.txt, containing two spaces aftermy, you must URL encode this value tomy%20%20file.txt.See also: AWS API Documentation
Request Syntax
response = client.untag_resource( AccountId='string', ResourceArn='string', TagKeys=[ 'string', ] )
- Parameters:
AccountId (string) –
[REQUIRED]
The Amazon Web Services account ID that owns the resource that you’re trying to remove the tags from.
ResourceArn (string) –
[REQUIRED]
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.
TagKeys (list) –
[REQUIRED]
The array of tag key-value pairs that you’re trying to remove from of the S3 resource.
(string) –
- Return type:
dict
- Returns:
Response Syntax
{}Response Structure
(dict) –