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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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 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.

Returns:

  • (String)


3413
3414
3415
3416
3417
3418
3419
3420
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3413

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 fails with the HTTP status code 403 Forbidden (access denied).

Returns:

  • (String)


3413
3414
3415
3416
3417
3418
3419
3420
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3413

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)


3413
3414
3415
3416
3417
3418
3419
3420
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3413

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)


3413
3414
3415
3416
3417
3418
3419
3420
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3413

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