KendraRanking / Client / tag_resource

tag_resource

KendraRanking.Client.tag_resource(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ResourceARN (string) –

  [REQUIRED]

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

• Tags (list) –

  [REQUIRED]

  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.

  • (dict) –

    A key-value pair that identifies or categorizes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can also use a tag to help control access to a rescore execution plan. A tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • Key (string) – [REQUIRED]

      The key for the tag. Keys are not case sensitive and must be unique.

    • Value (string) – [REQUIRED]

      The value associated with the tag. The value can be an empty string but it can’t be null.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Exceptions

• KendraRanking.Client.exceptions.ValidationException

• KendraRanking.Client.exceptions.ResourceUnavailableException

• KendraRanking.Client.exceptions.ThrottlingException

• KendraRanking.Client.exceptions.AccessDeniedException

• KendraRanking.Client.exceptions.InternalServerException