ElasticLoadBalancingv2 / Client / describe_load_balancers

describe_load_balancers

ElasticLoadBalancingv2.Client.describe_load_balancers(**kwargs)

Describes the specified load balancers or all of your load balancers.

See also: AWS API Documentation

Request Syntax

response = client.describe_load_balancers(
    LoadBalancerArns=[
        'string',
    ],
    Names=[
        'string',
    ],
    Marker='string',
    PageSize=123
)

Parameters:

• LoadBalancerArns (list) –

  The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

  • (string) –

• Names (list) –

  The names of the load balancers.

  • (string) –

• Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)

• PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'LoadBalancers': [
        {
            'LoadBalancerArn': 'string',
            'DNSName': 'string',
            'CanonicalHostedZoneId': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LoadBalancerName': 'string',
            'Scheme': 'internet-facing'|'internal',
            'VpcId': 'string',
            'State': {
                'Code': 'active'|'provisioning'|'active_impaired'|'failed',
                'Reason': 'string'
            },
            'Type': 'application'|'network'|'gateway',
            'AvailabilityZones': [
                {
                    'ZoneName': 'string',
                    'SubnetId': 'string',
                    'OutpostId': 'string',
                    'LoadBalancerAddresses': [
                        {
                            'IpAddress': 'string',
                            'AllocationId': 'string',
                            'PrivateIPv4Address': 'string',
                            'IPv6Address': 'string'
                        },
                    ]
                },
            ],
            'SecurityGroups': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack',
            'CustomerOwnedIpv4Pool': 'string'
        },
    ],
    'NextMarker': 'string'
}

Response Structure

• (dict) –

  • LoadBalancers (list) –

    Information about the load balancers.

    • (dict) –

      Information about a load balancer.

      • LoadBalancerArn (string) –

        The Amazon Resource Name (ARN) of the load balancer.

      • DNSName (string) –

        The public DNS name of the load balancer.

      • CanonicalHostedZoneId (string) –

        The ID of the Amazon Route 53 hosted zone associated with the load balancer.

      • CreatedTime (datetime) –

        The date and time the load balancer was created.

      • LoadBalancerName (string) –

        The name of the load balancer.

      • Scheme (string) –

        The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

        The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

      • VpcId (string) –

        The ID of the VPC for the load balancer.

      • State (dict) –

        The state of the load balancer.

        • Code (string) –

          The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If load balancer is routing traffic but does not have the resources it needs to scale, its state is active_impaired. If the load balancer could not be set up, its state is failed.

        • Reason (string) –

          A description of the state.

      • Type (string) –

        The type of load balancer.

      • AvailabilityZones (list) –

        The subnets for the load balancer.

        • (dict) –

          Information about an Availability Zone.

          • ZoneName (string) –

            The name of the Availability Zone.

          • SubnetId (string) –

            The ID of the subnet. You can specify one subnet per Availability Zone.

          • OutpostId (string) –

            [Application Load Balancers on Outposts] The ID of the Outpost.

          • LoadBalancerAddresses (list) –

            [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.

            • (dict) –

              Information about a static IP address for a load balancer.

              • IpAddress (string) –

                The static IP address.

              • AllocationId (string) –

                [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.

              • PrivateIPv4Address (string) –

                [Network Load Balancers] The private IPv4 address for an internal load balancer.

              • IPv6Address (string) –

                [Network Load Balancers] The IPv6 address.

      • SecurityGroups (list) –

        The IDs of the security groups for the load balancer.

        • (string) –

      • IpAddressType (string) –

        The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

      • CustomerOwnedIpv4Pool (string) –

        [Application Load Balancers on Outposts] The ID of the customer-owned address pool.

  • NextMarker (string) –

    If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

Exceptions

• ElasticLoadBalancingv2.Client.exceptions.LoadBalancerNotFoundException

Examples

This example describes the specified load balancer.

response = client.describe_load_balancers(
    LoadBalancerArns=[
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
    ],
)

print(response)

Expected Output:

{
    'LoadBalancers': [
        {
            'AvailabilityZones': [
                {
                    'SubnetId': 'subnet-8360a9e7',
                    'ZoneName': 'us-west-2a',
                },
                {
                    'SubnetId': 'subnet-b7d581c0',
                    'ZoneName': 'us-west-2b',
                },
            ],
            'CanonicalHostedZoneId': 'Z2P70J7EXAMPLE',
            'CreatedTime': datetime(2016, 3, 25, 21, 26, 12, 4, 85, 0),
            'DNSName': 'my-load-balancer-424835706.us-west-2.elb.amazonaws.com',
            'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'LoadBalancerName': 'my-load-balancer',
            'Scheme': 'internet-facing',
            'SecurityGroups': [
                'sg-5943793c',
            ],
            'State': {
                'Code': 'active',
            },
            'Type': 'application',
            'VpcId': 'vpc-3ac0fb5f',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}