Class: Aws::S3::Types::DeleteObjectTaggingRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass DeleteObjectTaggingRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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][1

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 using 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 S3 on Outposts][2

in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

  • (String)

2954
2955
2956
2957
2958
2959
2960
2961
# File 'lib/aws-sdk-s3/types.rb', line 2954

class DeleteObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_ownerString

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.

Returns:

  • (String)

2954
2955
2956
2957
2958
2959
2960
2961
# File 'lib/aws-sdk-s3/types.rb', line 2954

class DeleteObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

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

Returns:

  • (String)

2954
2955
2956
2957
2958
2959
2960
2961
# File 'lib/aws-sdk-s3/types.rb', line 2954

class DeleteObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#version_idString

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

Returns:

  • (String)

2954
2955
2956
2957
2958
2959
2960
2961
# File 'lib/aws-sdk-s3/types.rb', line 2954

class DeleteObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end