ElastiCache / Client / list_tags_for_resource

list_tags_for_resource#

ElastiCache.Client.list_tags_for_resource(**kwargs)#

Lists all tags currently on a named resource.

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

If the cluster is not in the available state, ListTagsForResource returns an error.

See also: AWS API Documentation

Request Syntax

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

ResourceName (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

    • TagList (list) –

      A list of tags as key-value pairs.

      • (dict) –

        A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.

        • Key (string) –

          The key for the tag. May not be null.

        • Value (string) –

          The tag’s value. May be null.

Exceptions

  • ElastiCache.Client.exceptions.CacheClusterNotFoundFault

  • ElastiCache.Client.exceptions.CacheParameterGroupNotFoundFault

  • ElastiCache.Client.exceptions.CacheSecurityGroupNotFoundFault

  • ElastiCache.Client.exceptions.CacheSubnetGroupNotFoundFault

  • ElastiCache.Client.exceptions.InvalidReplicationGroupStateFault

  • ElastiCache.Client.exceptions.ReplicationGroupNotFoundFault

  • ElastiCache.Client.exceptions.ReservedCacheNodeNotFoundFault

  • ElastiCache.Client.exceptions.SnapshotNotFoundFault

  • ElastiCache.Client.exceptions.UserNotFoundFault

  • ElastiCache.Client.exceptions.UserGroupNotFoundFault

  • ElastiCache.Client.exceptions.ServerlessCacheNotFoundFault

  • ElastiCache.Client.exceptions.InvalidServerlessCacheStateFault

  • ElastiCache.Client.exceptions.ServerlessCacheSnapshotNotFoundFault

  • ElastiCache.Client.exceptions.InvalidServerlessCacheSnapshotStateFault

  • ElastiCache.Client.exceptions.InvalidARNFault

Examples

Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

response = client.list_tags_for_resource(
    ResourceName='arn:aws:elasticache:us-west-2:<my-account-id>:cluster:mycluster',
)

print(response)

Expected Output:

{
    'TagList': [
        {
            'Key': 'APIVersion',
            'Value': '20150202',
        },
        {
            'Key': 'Service',
            'Value': 'ElastiCache',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}