OpsWorks / Client / describe_elastic_load_balancers

describe_elastic_load_balancers#

OpsWorks.Client.describe_elastic_load_balancers(**kwargs)#

Describes a stack’s Elastic Load Balancing instances.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_elastic_load_balancers(
    StackId='string',
    LayerIds=[
        'string',
    ]
)
Parameters:

  • StackId (string) – A stack ID. The action describes the stack’s Elastic Load Balancing instances.

  • LayerIds (list) –

    A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ElasticLoadBalancers': [
        {
            'ElasticLoadBalancerName': 'string',
            'Region': 'string',
            'DnsName': 'string',
            'StackId': 'string',
            'LayerId': 'string',
            'VpcId': 'string',
            'AvailabilityZones': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ],
            'Ec2InstanceIds': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) –

    Contains the response to a DescribeElasticLoadBalancers request.

    • ElasticLoadBalancers (list) –

      A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

      • (dict) –

        Describes an Elastic Load Balancing instance.

        • ElasticLoadBalancerName (string) –

          The Elastic Load Balancing instance’s name.

        • Region (string) –

          The instance’s AWS region.

        • DnsName (string) –

          The instance’s public DNS name.

        • StackId (string) –

          The ID of the stack that the instance is associated with.

        • LayerId (string) –

          The ID of the layer that the instance is attached to.

        • VpcId (string) –

          The VPC ID.

        • AvailabilityZones (list) –

          A list of Availability Zones.

          • (string) –

        • SubnetIds (list) –

          A list of subnet IDs, if the stack is running in a VPC.

          • (string) –

        • Ec2InstanceIds (list) –

          A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

          • (string) –

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException