ApplicationInsights / Client / tag_resource

tag_resource#

ApplicationInsights.Client.tag_resource(**kwargs)#

Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ResourceARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.

  • Tags (list) –

    [REQUIRED]

    A list of tags that to add to the application. A tag consists of a required tag key ( Key) and an associated tag value ( Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

    • (dict) –

      An object that defines the tags associated with an application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria.

      Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

      • Tag keys and values are case sensitive.

      • For each associated resource, each tag key must be unique and it can have only one value.

      • The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can’t edit or remove tag keys or values that use this prefix.

      • Key (string) – [REQUIRED]

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Value (string) – [REQUIRED]

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want an application to have a specific tag value, don’t specify a value for this parameter.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions