Menu
Elastic Load Balancing
API Reference (API Version 2012-06-01)

DescribeLoadBalancerPolicyTypes

Describes the specified load balancer policy types or all load balancer policy types.

The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.

You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.

Request Parameters

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

PolicyTypeNames.member.N

The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

PolicyTypeDescriptions.member.N

Information about the policy types.

Type: Array of PolicyTypeDescription objects

Errors

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

PolicyTypeNotFound

One or more of the specified policy types do not exist.

HTTP Status Code: 400

Examples

Describe All Policy Types

This example describes the load balancer policy types that you can use to create policy configurations.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=DescribeLoadBalancerPolicyTypes
&Version=2012-06-01
&AUTHPARAMS 

Sample Response

<DescribeLoadBalancerPolicyTypesResponse  xmlns="http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/">
  <DescribeLoadBalancerPolicyTypesResult>
    <PolicyTypeName>SSLNegotiationPolicyType</PolicyTypeName>
      <...>
    <PolicyTypeName>BackendServerAuthenticationPolicyType</PolicyTypeName>
      <...>
    <PolicyTypeName>PublicKeyPolicyType</PolicyTypeName>
      <...>
    <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName>
      <...>
    <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName>
      <...>
    <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName>
      <...>
  </DescribeLoadBalancerPolicyTypesResult>
  <ResponseMetadata>
    <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>
  </ResponseMetadata>
</DescribeLoadBalancerPolicyTypesResponse> 

Describe a Specific Policy Type

This example describes the specified policy type.

Sample Request

https://elasticloadbalancing.amazonaws.com/?Action=DescribeLoadBalancerPolicyTypes
&PolicyTypeNames.member.1=ProxyProtocolPolicyType
&Version=2012-06-01
&AUTHPARAMS 

Sample Response

<DescribeLoadBalancerPolicyTypesResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/">
  <DescribeLoadBalancerPolicyTypesResult>
    <PolicyTypeDescriptions>
      <member>
        <PolicyAttributeTypeDescriptions>
          <member>
            <AttributeName>ProxyProtocol</AttributeName>
            <AttributeType>Boolean</AttributeType>
            <Cardinality>ONE</Cardinality>
          </member>
        </PolicyAttributeTypeDescriptions>
        <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName>
        <Description>Policy that controls whether to include the IP address and port of the originating request for TCP messages.
        This policy operates on TCP/SSL listeners only</Description>
      </member>
    </PolicyTypeDescriptions>
  </DescribeLoadBalancerPolicyTypesResult>
  <ResponseMetadata>
    <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>
  </ResponseMetadata>
</DescribeLoadBalancerPolicyTypesResponse>
 

See Also

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