as-describe-policies

NAME

as-describe-policies - Describes the specified policies.

SYNOPSIS

as-describe-policies
[PolicyNames [PolicyNames ...] ] [ --auto-scaling-group value ]
[ --max-records value ] [General Options]

DESCRIPTION

Describes the specified policies, if specified policies exist.

PolicyNames
Optional list of policy names or policy ARNs to be described.
It is not valid to mix policy names and policy ARNs.
If this list is omitted, all policy names are described.
If an Auto Scaling group name is provided, the
results are limited to that group. The list of
requested policy names cannot contain more than 50 items.
If unknown policy names are requested, they are ignored with no
error.

SPECIFIC OPTIONS

-g, --auto-scaling-group VALUE
No description available for this parameter.

--max-records VALUE
Maximum number of policies that will be described with each call (default
= 20, max = 50).

GENERAL OPTIONS

--aws-credential-file VALUE
Location of the file with your AWS credentials. This value can be set by
using the environment variable 'AWS_CREDENTIAL_FILE'.

-C, --ec2-cert-file-path VALUE
Path to the file holding the X.509 certificate. This value can be set by
using the environment variable 'EC2_CERT'.

--connection-timeout VALUE
Connection timeout (in seconds). The default value is '30'.

--delimiter VALUE
The delimiter to use when displaying delimited (long) results.

-H, --headers
For displaying tabular or delimited results, it includes the column
headers. For displaying XML results, it returns the HTTP headers from the
service request, if applicable. This is off by default.

-I, --access-key-id VALUE
The AWS access ID to use.

-K, --ec2-private-key-file-path VALUE
Path to the file holding the X.509 private key. This value can be set by
using the environment variable 'EC2_PRIVATE_KEY'.

--region VALUE
Amazon EC2 region to use. This value can be set by using the environment
variable 'EC2_REGION'.

-S, --secret-key VALUE
The AWS Secret Key to use.

--show-empty-fields
Shows empty fields and rows, using a (nil) value. The default is to not
show empty fields or columns.

--show-request
Displays the URL the tools used to call the AWS Service. The default
value is 'false'.

--show-table, --show-long, --show-xml, --quiet
The way in which the results are displayed: tabular, delimited (long),
XML or no output (quiet). Tabular shows a subset of the data in fixed
column-width form, while long shows all of the returned values delimited
by a character, XML is the raw return from the service and quiet
suppresses all standard output. The default is tabular, or 'show-table'.

-U, --url VALUE
This option will override the URL for the service call with VALUE. This
value can be set by using the environment variable
'AWS_AUTO_SCALING_URL'.

INPUT EXAMPLES

Describes all of the user's policies in group test-group.

$PROMPT> as-describe-policies -g test-group

Describes more of the user's policies in test-group.

$PROMPT> as-describe-policies -g test-group --token token-1

Describes user's policies 'test-policy1' and 'test-policy2' in group
test-group, if the specified policies exist.

$PROMPT> as-describe-policies test-policy1 test-policy2 -g test-group

OUTPUT

This command returns a table that contains the following:
* GROUP-NAME - Name of the Auto Scaling group.
* POLICY-NAME - Name of the policy.
* SCALING-ADJUSTMENT - Scaling adjustment used when scaling a group using
this policy.
* MIN-ADJUSTMENT-STEP - MinAdjustmentStep used when scaling a group using
this policy.
* ADJUSTMENT-TYPE - Adjustment type (whether the adjustment is
ExactCapacity/ChangeInCapacity/PercentChangeInCapacity).
* COOLDOWN - Time (in seconds) between a successful scaling activity and
succeeding scaling activity.
* POLICY-ARN - ARN that references this policy.
* ALARM-NAME - Name of the alarm.
* ALARM-ARN - No description available for this column. This column appears
only in the --show-long view.
* POLICY-NAME - Name of the policy.
* POLICY-ARN - No description available for this column. This column appears
only in the --show-long view.

OUTPUT EXAMPLES

This is an example output for a policy.