kendra / Client / tag_resource

tag_resource#

kendra.Client.tag_resource(**kwargs)#

Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.

Request Syntax

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

Parameters:

ResourceARN (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to add a tag. For example, the ARN of an index is constructed as follows: arn:aws:kendra:your-region:your-account-id:index/index-id For information on how to construct an ARN for all types of Amazon Kendra resources, see Resource types.
Tags (list) –
[REQUIRED]

A list of tag keys to add to the index, FAQ, data source, or other resource. If a tag already exists, the existing value is replaced with the new value.
- (dict) –
  
  A key-value pair that identifies or categorizes an index, FAQ, data source, or other resource. TA 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 for the index, FAQ, data source, or other resource.
  - Value (string) – [REQUIRED]
    
    The value associated with the tag. The value may be an empty string but it can’t be null.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

kendra.Client.exceptions.ValidationException
kendra.Client.exceptions.ResourceUnavailableException
kendra.Client.exceptions.ThrottlingException
kendra.Client.exceptions.AccessDeniedException
kendra.Client.exceptions.InternalServerException