DescribeLoadBalancerPolicies - Elastic Load Balancing
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeLoadBalancerPolicies

Describes the specified policies.

If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix.

Request Parameters

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

LoadBalancerName

The name of the load balancer.

Type: String

Required: No

PolicyNames.member.N

The names of the policies.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

PolicyDescriptions.member.N

Information about the policies.

Type: Array of PolicyDescription objects

Errors

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

LoadBalancerNotFound

The specified load balancer does not exist.

HTTP Status Code: 400

PolicyNotFound

One or more of the specified policies do not exist.

HTTP Status Code: 400

Examples

Describe all policies

This example describes all of the policies associated with the specified load balancer.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=DescribeLoadBalancerPolicies &LoadBalancerName=my-loadbalancer &Version=2012-06-01 &AUTHPARAMS

Sample Response

<DescribeLoadBalancerPoliciesResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/"> <DescribeLoadBalancerPoliciesResult> <PolicyDescriptions> <member> <PolicyName>my-duration-sticky-policy</PolicyName> <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributeDescriptions> <member> <AttributeName>CookieExpirationPeriod</AttributeName> <AttributeValue>60</AttributeValue> </member> </PolicyAttributeDescriptions> </member> <member> <PolicyName>my-app-sticky-policy</PolicyName> <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributeDescriptions> <member> <AttributeName>CookieName</AttributeName> <AttributeValue>my-app-cookie</AttributeValue> </member> </PolicyAttributeDescriptions> </member> </PolicyDescriptions> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse>

Describe a policy

This example describes the specified policy associated with the specified load balancer.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=DescribeLoadBalancerPolicies &LoadBalancerName=my-loadbalancer &PolicyNames.member.1=EnableProxyProtocol &Version=2012-06-01 &AUTHPARAMS

Sample Response

<DescribeLoadBalancerPoliciesResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/"> <DescribeLoadBalancerPoliciesResult> <PolicyDescriptions> <member> <PolicyName>EnableProxyProtocol</PolicyName> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <PolicyAttributeDescriptions> <member> <AttributeName>ProxyProtocol</AttributeName> <AttributeValue>true</AttributeValue> </member> </PolicyAttributeDescriptions> </member> </PolicyDescriptions> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse>

See Also

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