as-execute-policy

NAME

as-execute-policy - Executes the specified policy.

SYNOPSIS

as-execute-policy
PolicyName [ --auto-scaling-group value ]
[ --honor-cooldown/no-honor-cooldown ] [General Options]

ARGUMENTS

PolicyName
Name or Amazon Resource Name (ARN) of the policy to be executed. You can
also set this value using " --name". Required.

SPECIFIC OPTIONS

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

-h, --honor-cooldown, -H, --no-honor-cooldown
Specify only one of the two flags. If set, execution of a policy will be
blocked by groups that are in cooldown. Otherwise, the policy will be
executed immediately. By default, this flag is not set.

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

Executes the policy test-policy on group test-group.

$PROMPT> as-execute-policy test-policy -g test-group

Executes the policy test-policy on the group test-group, honoring cooldown.

$PROMPT> as-execute-policy test-policy -g test-group --honor-cooldown