Amazonka.S3.DeleteObjectTagging

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 DeleteBucketMetricsConfiguration:

• PutObjectTagging
• GetObjectTagging

Creating a Request

data DeleteObjectTagging

See: newDeleteObjectTagging smart constructor.

Constructors

DeleteObjectTagging'

Fields

• expectedBucketOwner :: Maybe Text

  The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

• versionId :: Maybe ObjectVersionId

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

• bucket :: BucketName

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

  When using this action with an access point, 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.

  When using this action with Amazon 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

• key :: ObjectKey

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

Instances

ToHeaders DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

toHeaders :: DeleteObjectTagging -> [Header]

ToPath DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

toPath :: DeleteObjectTagging -> ByteString

ToQuery DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

toQuery :: DeleteObjectTagging -> QueryString

AWSRequest DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Associated Types

type AWSResponse DeleteObjectTagging

Methods

request :: (Service -> Service) -> DeleteObjectTagging -> Request DeleteObjectTagging

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteObjectTagging -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteObjectTagging)))

Generic DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Associated Types

type Rep DeleteObjectTagging :: Type -> Type

Methods

from :: DeleteObjectTagging -> Rep DeleteObjectTagging x

to :: Rep DeleteObjectTagging x -> DeleteObjectTagging

Read DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

readsPrec :: Int -> ReadS DeleteObjectTagging

readList :: ReadS [DeleteObjectTagging]

readPrec :: ReadPrec DeleteObjectTagging

readListPrec :: ReadPrec [DeleteObjectTagging]

Show DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

showsPrec :: Int -> DeleteObjectTagging -> ShowS

show :: DeleteObjectTagging -> String

showList :: [DeleteObjectTagging] -> ShowS

NFData DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

rnf :: DeleteObjectTagging -> ()

Eq DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

(==) :: DeleteObjectTagging -> DeleteObjectTagging -> Bool

(/=) :: DeleteObjectTagging -> DeleteObjectTagging -> Bool

Hashable DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

Methods

hashWithSalt :: Int -> DeleteObjectTagging -> Int

hash :: DeleteObjectTagging -> Int

type AWSResponse DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

type AWSResponse DeleteObjectTagging = DeleteObjectTaggingResponse

type Rep DeleteObjectTagging

Defined in Amazonka.S3.DeleteObjectTagging

type Rep DeleteObjectTagging = D1 ('MetaData "DeleteObjectTagging" "Amazonka.S3.DeleteObjectTagging" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "DeleteObjectTagging'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId))) :*: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey))))

newDeleteObjectTagging

Arguments

:: BucketName

DeleteObjectTagging

-> ObjectKey

DeleteObjectTagging

-> DeleteObjectTagging

Create a value of DeleteObjectTagging with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:expectedBucketOwner:DeleteObjectTagging', deleteObjectTagging_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

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

DeleteObjectTagging, deleteObjectTagging_bucket - The bucket name containing the objects from which to remove the tags.

When using this action with an access point, 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.

When using this action with Amazon 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

DeleteObjectTagging, deleteObjectTagging_key - The key that identifies the object in the bucket from which to remove all tags.

Request Lenses

deleteObjectTagging_expectedBucketOwner :: Lens' DeleteObjectTagging (Maybe Text)

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

deleteObjectTagging_versionId :: Lens' DeleteObjectTagging (Maybe ObjectVersionId)

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

deleteObjectTagging_bucket :: Lens' DeleteObjectTagging BucketName

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

When using this action with an access point, 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.

When using this action with Amazon 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

deleteObjectTagging_key :: Lens' DeleteObjectTagging ObjectKey

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

Destructuring the Response

data DeleteObjectTaggingResponse

See: newDeleteObjectTaggingResponse smart constructor.

Constructors

DeleteObjectTaggingResponse'

Fields

• versionId :: Maybe ObjectVersionId

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteObjectTaggingResponse

Defined in Amazonka.S3.DeleteObjectTagging

Associated Types

type Rep DeleteObjectTaggingResponse :: Type -> Type

Methods

from :: DeleteObjectTaggingResponse -> Rep DeleteObjectTaggingResponse x

to :: Rep DeleteObjectTaggingResponse x -> DeleteObjectTaggingResponse

Read DeleteObjectTaggingResponse

Defined in Amazonka.S3.DeleteObjectTagging

Methods

readsPrec :: Int -> ReadS DeleteObjectTaggingResponse

readList :: ReadS [DeleteObjectTaggingResponse]

readPrec :: ReadPrec DeleteObjectTaggingResponse

readListPrec :: ReadPrec [DeleteObjectTaggingResponse]

Show DeleteObjectTaggingResponse

Defined in Amazonka.S3.DeleteObjectTagging

Methods

showsPrec :: Int -> DeleteObjectTaggingResponse -> ShowS

show :: DeleteObjectTaggingResponse -> String

showList :: [DeleteObjectTaggingResponse] -> ShowS

NFData DeleteObjectTaggingResponse

Defined in Amazonka.S3.DeleteObjectTagging

Methods

rnf :: DeleteObjectTaggingResponse -> ()

Eq DeleteObjectTaggingResponse

Defined in Amazonka.S3.DeleteObjectTagging

Methods

(==) :: DeleteObjectTaggingResponse -> DeleteObjectTaggingResponse -> Bool

(/=) :: DeleteObjectTaggingResponse -> DeleteObjectTaggingResponse -> Bool

type Rep DeleteObjectTaggingResponse

Defined in Amazonka.S3.DeleteObjectTagging

type Rep DeleteObjectTaggingResponse = D1 ('MetaData "DeleteObjectTaggingResponse" "Amazonka.S3.DeleteObjectTagging" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "DeleteObjectTaggingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteObjectTaggingResponse

Arguments

:: Int

$sel:httpStatus:DeleteObjectTaggingResponse'

-> DeleteObjectTaggingResponse

Create a value of DeleteObjectTaggingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:httpStatus:DeleteObjectTaggingResponse', deleteObjectTaggingResponse_httpStatus - The response's http status code.

Response Lenses

deleteObjectTaggingResponse_versionId :: Lens' DeleteObjectTaggingResponse (Maybe ObjectVersionId)

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

deleteObjectTaggingResponse_httpStatus :: Lens' DeleteObjectTaggingResponse Int

The response's http status code.