Skip to content

delete_object_tagging

Operation

delete_object_tagging

delete_object_tagging(request: DeleteObjectTaggingInput | DeleteObjectTaggingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteObjectTaggingInputDict]) -> DeleteObjectTaggingOutput
Note

This operation is not supported for directory buckets.

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteObjectTagging:

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 after my, you must URL encode this value to my%20%20file.txt.

Parameters:

Name Type Description Default
request DeleteObjectTaggingInput | DeleteObjectTaggingInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteObjectTaggingInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteObjectTaggingOutput

An instance of DeleteObjectTaggingOutput.

delete_object_tagging async

delete_object_tagging(request: DeleteObjectTaggingInput | DeleteObjectTaggingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteObjectTaggingInputDict]) -> DeleteObjectTaggingOutput
Note

This operation is not supported for directory buckets.

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteObjectTagging:

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 after my, you must URL encode this value to my%20%20file.txt.

Parameters:

Name Type Description Default
request DeleteObjectTaggingInput | DeleteObjectTaggingInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteObjectTaggingInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteObjectTaggingOutput

An instance of DeleteObjectTaggingOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteObjectTaggingInputDict

Bases: TypedDict

Dictionary form of DeleteObjectTaggingInput.

Attributes

bucket instance-attribute
bucket: Required[str]

The bucket name containing the objects from which to remove the tags.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

expected_bucket_owner instance-attribute
expected_bucket_owner: str | None

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

key instance-attribute
key: Required[str]

The key that identifies the object in the bucket from which to remove all tags.

version_id instance-attribute
version_id: str | None

The versionId of the object that the tag-set will be removed from.

DeleteObjectTaggingInput dataclass

Bases: _SerdeShape

Dataclass for DeleteObjectTaggingInput structure.

Attributes

bucket class-attribute instance-attribute
bucket: str | None = ...

The bucket name containing the objects from which to remove the tags.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = ...

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

key class-attribute instance-attribute
key: str | None = ...

The key that identifies the object in the bucket from which to remove all tags.

version_id class-attribute instance-attribute
version_id: str | None = ...

The versionId of the object that the tag-set will be removed from.

Output

DeleteObjectTaggingOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteObjectTaggingOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

version_id class-attribute instance-attribute
version_id: str | None = ...

The versionId of the object the tag-set was removed from.