KendraRanking / Client / list_tags_for_resource

list_tags_for_resource#

KendraRanking.Client.list_tags_for_resource(**kwargs)#

Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)
Parameters:

ResourceARN (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the rescore execution plan to get a list of tags for.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) –

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

    • Tags (list) –

      A list of tags associated with the rescore execution plan.

      • (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) –

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

        • Value (string) –

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

Exceptions

  • KendraRanking.Client.exceptions.ValidationException

  • KendraRanking.Client.exceptions.ResourceUnavailableException

  • KendraRanking.Client.exceptions.ThrottlingException

  • KendraRanking.Client.exceptions.AccessDeniedException

  • KendraRanking.Client.exceptions.InternalServerException