ElasticLoadBalancing / Client / describe_tags

describe_tags#

ElasticLoadBalancing.Client.describe_tags(**kwargs)#

Describes the tags associated with the specified load balancers.

See also: AWS API Documentation

Request Syntax

response = client.describe_tags(
    LoadBalancerNames=[
        'string',
    ]
)
Parameters:

LoadBalancerNames (list) –

[REQUIRED]

The names of the load balancers.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'TagDescriptions': [
        {
            'LoadBalancerName': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    Contains the output for DescribeTags.

    • TagDescriptions (list) –

      Information about the tags.

      • (dict) –

        The tags associated with a load balancer.

        • LoadBalancerName (string) –

          The name of the load balancer.

        • Tags (list) –

          The tags.

          • (dict) –

            Information about a tag.

            • Key (string) –

              The key of the tag.

            • Value (string) –

              The value of the tag.

Exceptions

  • ElasticLoadBalancing.Client.exceptions.AccessPointNotFoundException

Examples

This example describes the tags for the specified load balancer.

response = client.describe_tags(
    LoadBalancerNames=[
        'my-load-balancer',
    ],
)

print(response)

Expected Output:

{
    'TagDescriptions': [
        {
            'LoadBalancerName': 'my-load-balancer',
            'Tags': [
                {
                    'Key': 'project',
                    'Value': 'lima',
                },
                {
                    'Key': 'department',
                    'Value': 'digital-media',
                },
            ],
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}