AutoScaling / Paginator / DescribeLoadBalancers

DescribeLoadBalancers

class AutoScaling.Paginator.DescribeLoadBalancers

paginator = client.get_paginator('describe_load_balancers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_load_balancers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AutoScalingGroupName (string) –

  [REQUIRED]

  The name of the Auto Scaling group.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'LoadBalancers': [
        {
            'LoadBalancerName': 'string',
            'State': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • LoadBalancers (list) –

    The load balancers.

    • (dict) –

      Describes the state of a Classic Load Balancer.

      • LoadBalancerName (string) –

        The name of the load balancer.

      • State (string) –

        One of the following load balancer states:

        • Adding - The Auto Scaling instances are being registered with the load balancer.

        • Added - All Auto Scaling instances are registered with the load balancer.

        • InService - At least one Auto Scaling instance passed an ELB health check.

        • Removing - The Auto Scaling instances are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.

        • Removed - All Auto Scaling instances are deregistered from the load balancer.