AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
describe-load-balancer-policies
[--load-balancer-name <value>]
[--policy-names <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--load-balancer-name
(string)
The name of the load balancer.
--policy-names
(list)
The names of the policies.
(string)
Syntax:
"string" "string" ...
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe all policies associated with a load balancer
This example describes all of the policies associated with the specified load balancer.
Command:
aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer
Output:
{
"PolicyDescriptions": [
{
"PolicyAttributeDescriptions": [
{
"AttributeName": "ProxyProtocol",
"AttributeValue": "true"
}
],
"PolicyName": "my-ProxyProtocol-policy",
"PolicyTypeName": "ProxyProtocolPolicyType"
},
{
"PolicyAttributeDescriptions": [
{
"AttributeName": "CookieName",
"AttributeValue": "my-app-cookie"
}
],
"PolicyName": "my-app-cookie-policy",
"PolicyTypeName": "AppCookieStickinessPolicyType"
},
{
"PolicyAttributeDescriptions": [
{
"AttributeName": "CookieExpirationPeriod",
"AttributeValue": "60"
}
],
"PolicyName": "my-duration-cookie-policy",
"PolicyTypeName": "LBCookieStickinessPolicyType"
},
.
.
.
]
}
To describe a specific policy associated with a load balancer
This example describes the specified policy associated with the specified load balancer.
Command:
aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer --policy-name my-authentication-policy
Output:
{
"PolicyDescriptions": [
{
"PolicyAttributeDescriptions": [
{
"AttributeName": "PublicKeyPolicyName",
"AttributeValue": "my-PublicKey-policy"
}
],
"PolicyName": "my-authentication-policy",
"PolicyTypeName": "BackendServerAuthenticationPolicyType"
}
]
}
PolicyDescriptions -> (list)
Information about the policies.
(structure)
Information about a policy.
PolicyName -> (string)
The name of the policy.PolicyTypeName -> (string)
The name of the policy type.PolicyAttributeDescriptions -> (list)
The policy attributes.
(structure)
Information about a policy attribute.
AttributeName -> (string)
The name of the attribute.AttributeValue -> (string)
The value of the attribute.