Class: Aws::S3::Types::GetObjectTaggingRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::GetObjectTaggingRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
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
-
#bucket ⇒ String
The bucket name containing the object for which to get the tagging information.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#key ⇒ String
Object key for which to get the tagging information.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#version_id ⇒ String
The versionId of the object for which to get the tagging information.
Instance Attribute Details
#bucket ⇒ String
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][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 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][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
6715 6716 6717 6718 6719 6720 6721 6722 6723 |
# File 'lib/aws-sdk-s3/types.rb', line 6715 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 bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).
6715 6716 6717 6718 6719 6720 6721 6722 6723 |
# File 'lib/aws-sdk-s3/types.rb', line 6715 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.
6715 6716 6717 6718 6719 6720 6721 6722 6723 |
# File 'lib/aws-sdk-s3/types.rb', line 6715 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. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
6715 6716 6717 6718 6719 6720 6721 6722 6723 |
# File 'lib/aws-sdk-s3/types.rb', line 6715 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.
6715 6716 6717 6718 6719 6720 6721 6722 6723 |
# File 'lib/aws-sdk-s3/types.rb', line 6715 class GetObjectTaggingRequest < Struct.new( :bucket, :key, :version_id, :expected_bucket_owner, :request_payer) SENSITIVE = [] include Aws::Structure end |