DescribeElasticLoadBalancers - OpsWorks

DescribeElasticLoadBalancers

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.

Request Syntax

{ "LayerIds": [ "string" ], "StackId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

LayerIds

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

Type: Array of strings

Required: No

StackId

A stack ID. The action describes the stack's Elastic Load Balancing instances.

Type: String

Required: No

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ElasticLoadBalancers

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

Type: Array of ElasticLoadBalancer objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

Indicates that a resource was not found.

HTTP Status Code: 400

ValidationException

Indicates that a request was not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: