describe_load_balancer_policies ( $opt )

Returns detailed descriptions of the policies. If you specify a LoadBalancer name, the operation returns either the descriptions of the specified policies, or descriptions of all the policies created for the LoadBalancer. If you don’t specify a LoadBalancer name, the operation returns descriptions of the specified sample policies, or descriptions of all the sample policies. The names of the sample policies have the ELBSample- prefix.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • LoadBalancerName - string - Optional - The mnemonic name associated with the LoadBalancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.
  • PolicyNames - string|array - Optional - The names of LoadBalancer policies you’ve created or Elastic Load Balancing sample policy names. Pass a string for a single value, or an indexed array for multiple values.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Describe load balancer policies.

$elb = new AmazonELB();

$response = $elb->describe_load_balancer_policies();

// Success?
var_dump($response->isOK());
Result:
bool(true)

Source

Method defined in services/elb.class.php | Toggle source view (15 lines) | View on GitHub

public function describe_load_balancer_policies($opt = null)
{
    if (!$opt) $opt = array();
            
    // Optional list (non-map)
    if (isset($opt['PolicyNames']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'PolicyNames' => (is_array($opt['PolicyNames']) ? $opt['PolicyNames'] : array($opt['PolicyNames']))
        ), 'member'));
        unset($opt['PolicyNames']);
    }

    return $this->authenticate('DescribeLoadBalancerPolicies', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback