ResourceGroupsTaggingAPI / Client / get_tag_values

get_tag_values#

ResourceGroupsTaggingAPI.Client.get_tag_values(**kwargs)#

Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

See also: AWS API Documentation

Request Syntax

response = client.get_tag_values(
    PaginationToken='string',
    Key='string'
)
Parameters:

  • PaginationToken (string) – Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

  • Key (string) –

    [REQUIRED]

    Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.

Return type:

dict

Returns:

Response Syntax

{
    'PaginationToken': 'string',
    'TagValues': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • PaginationToken (string) –

      A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

    • TagValues (list) –

      A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.

      • (string) –

Exceptions

  • ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException

  • ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException

  • ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException

  • ResourceGroupsTaggingAPI.Client.exceptions.PaginationTokenExpiredException