tag_resource `async` ¶

tag_resource(
    resource_arn: AmazonResourceName,
    tags: TagList,
    *,
    config_overrides: Optional[AsyncKendraRankingClientConfig] = None,
) -> TagResourceResponse

Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the existing value is replaced with the new value.

Parameters:

resource_arn (AmazonResourceName) –

The Amazon Resource Name (ARN) of the rescore execution plan to tag.
tags (TagList) –

A list of tag keys to add to a rescore execution plan. If a tag already exists, the existing value is replaced with the new value.

Raises:

AccessDeniedException –

You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
InternalServerException –

An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support for help.
ResourceUnavailableException –

The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.
ThrottlingException –

The request was denied due to request throttling. Please reduce the number of requests and try again.
ValidationException –

The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.
UnknownServiceError –

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

Source code in docs_src/capo_kendra_ranking/_services/async_kendra_ranking.py

async def tag_resource(
    self,
    resource_arn: "capo_kendra_ranking.types.amazon_resource_name.AmazonResourceName",
    tags: "capo_kendra_ranking.types.tag_list.TagList",
    *,
    config_overrides: Optional[AsyncKendraRankingClientConfig] = None,
) -> "capo_kendra_ranking.types.tag_resource_response.TagResourceResponse":
    """<p>Adds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API. If the tag already exists, the existing value is replaced with the new value.</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) of the rescore execution plan to tag.</p>
        tags: <p>A list of tag keys to add to a rescore execution plan. If a tag already exists, the existing value is replaced with the new value.</p>

    Raises:
        capo_kendra_ranking.errors.access_denied_exception.AccessDeniedException: <p>You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra_ranking.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra_ranking.errors.resource_unavailable_exception.ResourceUnavailableException: <p>The resource you want to use is unavailable. Please check you have provided the correct resource information and try again.</p>
        capo_kendra_ranking.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra_ranking.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.</p>
        capo_kendra_ranking.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kendra_ranking.types.tag_resource_request.TagResourceRequest]",
    ) -> AsyncOperationResponse[
        "capo_kendra_ranking.types.tag_resource_response.TagResourceResponse"
    ]:
        import capo_kendra_ranking._operations.aws_kendra_reranking_frontend_service.tag_resource

        (
            output,
            http_response,
        ) = await capo_kendra_ranking._operations.aws_kendra_reranking_frontend_service.tag_resource.async_tag_resource(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TagResource")
    )
    input_: capo_kendra_ranking.types.tag_resource_request.TagResourceRequest = {
        "resource_arn": resource_arn,
        "tags": tags,
    }

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

tag_resource async ¶

tag_resource `async` ¶