Get Bucket Tagging
s3control_get_bucket_tagging | R Documentation |
This action gets an Amazon S3 on Outposts bucket's tags¶
Description¶
This action gets an Amazon S3 on Outposts bucket's tags. To get an S3
bucket tags, see get_bucket_tagging
in the Amazon S3 API Reference.
Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
To use this action, you must have permission to perform the
get_bucket_tagging
action. By default, the bucket owner has this
permission and can grant this permission to others.
get_bucket_tagging
has the following special error:
-
Error code:
NoSuchTagSetError
- Description: There is no tag set associated with the bucket.
All Amazon S3 on Outposts REST API requests for this action require an
additional parameter of x-amz-outpost-id
to be passed with the
request. In addition, you must use an S3 on Outposts endpoint hostname
prefix instead of s3-control
. For an example of the request syntax for
Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname
prefix and the x-amz-outpost-id
derived by using the access point ARN,
see the
Examples
section.
The following actions are related to get_bucket_tagging
:
-
put_bucket_tagging
-
delete_bucket_tagging
Usage¶
Arguments¶
AccountId
[required] The Amazon Web Services account ID of the Outposts bucket.
Bucket
[required] Specifies the bucket.
For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.
For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>
. For example, to access the bucketreports
through Outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports
. The value must be URL encoded.
Value¶
A list with the following syntax: