ElasticsearchService / Client / list_tags

list_tags

ElasticsearchService.Client.list_tags(**kwargs)

Returns all tags for the given Elasticsearch domain.

See also: AWS API Documentation

Request Syntax

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

ARN (string) –

[REQUIRED]

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

    • TagList (list) –

      List of Tag for the requested Elasticsearch domain.

      • (dict) –

        Specifies a key value pair for a resource tag.

        • Key (string) –

          Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

        • Value (string) –

          Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not 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

  • ElasticsearchService.Client.exceptions.BaseException

  • ElasticsearchService.Client.exceptions.ResourceNotFoundException

  • ElasticsearchService.Client.exceptions.ValidationException

  • ElasticsearchService.Client.exceptions.InternalException