list_tags

OpenSearchService.Client.list_tags(**kwargs)

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    ARN='string'
)

Parameters

ARN (string) --

[REQUIRED]

Amazon Resource Name (ARN) for the domain to view tags for.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  The results of a ListTags operation.

  • TagList (list) --

    List of resource tags associated with the specified domain.

    • (dict) --

      A tag (key-value pair) for an Amazon OpenSearch Service resource.

      • Key (string) --

        The tag key. Tag keys must be unique for the domain to which they are attached.

      • Value (string) --

        The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Exceptions

• OpenSearchService.Client.exceptions.BaseException
• OpenSearchService.Client.exceptions.ResourceNotFoundException
• OpenSearchService.Client.exceptions.ValidationException
• OpenSearchService.Client.exceptions.InternalException