Class: Aws::S3::Types::GetObjectTaggingRequest

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 GetObjectTaggingRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name containing the object for which to get the tagging information.

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 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 in the Amazon S3 User Guide.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5931

class GetObjectTaggingRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :expected_bucket_owner,
  :request_payer)
  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)


5931
5932
5933
5934
5935
5936
5937
5938
5939
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5931

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

#keyString

Object key for which to get the tagging information.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5931

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

#request_payerString

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 User Guide.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5931

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

#version_idString

The versionId of the object for which to get the tagging information.

Returns:

  • (String)


5931
5932
5933
5934
5935
5936
5937
5938
5939
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 5931

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