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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

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

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.

Returns:

  • (String) 


8969
8970
8971
8972
8973
8974
8975
8976
8977
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8969

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

#expected_bucket_owner ⇒ String

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).

Returns:

  • (String) 


8969
8970
8971
8972
8973
8974
8975
8976
8977
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8969

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

#key ⇒ String

Object key for which to get the tagging information.

Returns:

  • (String) 


8969
8970
8971
8972
8973
8974
8975
8976
8977
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8969

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

#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Returns:

  • (String) 


8969
8970
8971
8972
8973
8974
8975
8976
8977
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8969

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

#version_id ⇒ String

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

Returns:

  • (String) 


8969
8970
8971
8972
8973
8974
8975
8976
8977
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8969

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