get_bucket_tagging¶
Operation¶
get_bucket_tagging
¶
get_bucket_tagging(request: GetBucketTaggingInput | GetBucketTaggingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketTaggingInputDict]) -> GetBucketTaggingOutput
Note
This operation is not supported for directory buckets.
Returns the tag set associated with the general purpose bucket.
To use this operation, you must have permission to perform the
s3:GetBucketTagging action. By default, the bucket owner has this
permission and can grant this permission to others.
GetBucketTagging has the following special error:
-
Error code:
NoSuchTagSet -
Description: There is no tag set associated with the bucket.
The following operations are related to GetBucketTagging:
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetBucketTaggingInput | GetBucketTaggingInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetBucketTaggingInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBucketTaggingOutput
|
An instance of |
get_bucket_tagging
async
¶
get_bucket_tagging(request: GetBucketTaggingInput | GetBucketTaggingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketTaggingInputDict]) -> GetBucketTaggingOutput
Note
This operation is not supported for directory buckets.
Returns the tag set associated with the general purpose bucket.
To use this operation, you must have permission to perform the
s3:GetBucketTagging action. By default, the bucket owner has this
permission and can grant this permission to others.
GetBucketTagging has the following special error:
-
Error code:
NoSuchTagSet -
Description: There is no tag set associated with the bucket.
The following operations are related to GetBucketTagging:
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetBucketTaggingInput | GetBucketTaggingInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetBucketTaggingInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetBucketTaggingOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetBucketTaggingInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketTaggingInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket for which to get the tagging information.
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
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).
Output¶
GetBucketTaggingOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketTaggingOutput structure.