get_bucket_tagging `async` ¶

get_bucket_tagging(
    bucket: BucketName,
    *,
    config_overrides: Optional[AsyncS3ClientConfig] = None,
    expected_bucket_owner: Optional[AccountId] = None,
) -> GetBucketTaggingOutput

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:

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:

bucket (BucketName) –

The name of the bucket for which to get the tagging information.
expected_bucket_owner (Optional[AccountId], default: 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).

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To get tag set associated with a bucket The following example returns tag set associated with a bucket

>>> await client.get_bucket_tagging(bucket='examplebucket')

Source code in docs_src/capo_s3/_services/async_s3.py

async def get_bucket_tagging(
    self,
    bucket: "capo_s3.types.bucket_name.BucketName",
    *,
    config_overrides: Optional[AsyncS3ClientConfig] = None,
    expected_bucket_owner: Optional["capo_s3.types.account_id.AccountId"] = None,
) -> "capo_s3.types.get_bucket_tagging_output.GetBucketTaggingOutput":
    """<note> <p>This operation is not supported for directory buckets.</p> </note> <p>Returns the tag set associated with the general purpose bucket.</p> <p>To use this operation, you must have permission to perform the <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSet</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>The following operations are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html">PutBucketTagging</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html">DeleteBucketTagging</a> </p> </li> </ul> <important> <p>You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>.</p> </important>

    Args:
        bucket: <p>The name of the bucket for which to get the tagging information.</p>
        expected_bucket_owner: <p>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 <code>403 Forbidden</code> (access denied).</p>

    Raises:
        capo_s3.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get tag set associated with a bucket
        The following example returns tag set associated with a bucket

        >>> await client.get_bucket_tagging(bucket='examplebucket')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_s3.types.get_bucket_tagging_request.GetBucketTaggingRequest]",
    ) -> AsyncOperationResponse[
        "capo_s3.types.get_bucket_tagging_output.GetBucketTaggingOutput"
    ]:
        import capo_s3._operations.amazon_s3.get_bucket_tagging

        (
            output,
            http_response,
        ) = await capo_s3._operations.amazon_s3.get_bucket_tagging.async_get_bucket_tagging(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBucketTagging")
    )
    input_: capo_s3.types.get_bucket_tagging_request.GetBucketTaggingRequest = {
        "bucket": bucket
    }
    if expected_bucket_owner is not None:
        input_["expected_bucket_owner"] = expected_bucket_owner

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_bucket_tagging async ¶

get_bucket_tagging `async` ¶