ElastiCache / Client / add_tags_to_resource

add_tags_to_resource#

ElastiCache.Client.add_tags_to_resource(**kwargs)#

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.

For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.

For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

Request Syntax

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

Parameters:

ResourceName (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
Tags (list) –
[REQUIRED]

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
- (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.

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.TagQuotaPerResourceExceeded
ElastiCache.Client.exceptions.InvalidARNFault

Examples

Adds up to 10 tags, key/value pairs, to a cluster or snapshot resource.

response = client.add_tags_to_resource(
    ResourceName='arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster',
    Tags=[
        {
            'Key': 'APIVersion',
            'Value': '20150202',
        },
        {
            'Key': 'Service',
            'Value': 'ElastiCache',
        },
    ],
)

print(response)

Expected Output:

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