DescribePolicies
Gets information about the scaling policies in the account and Region.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AutoScalingGroupName
-
The name of the Auto Scaling group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- MaxRecords
-
The maximum number of items to be returned with each call. The default value is
50and the maximum value is100.Type: Integer
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- PolicyNames.member.N
-
The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.
Array Members: Maximum number of 50 items.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- PolicyTypes.member.N
-
One or more policy types. The valid values are
SimpleScaling,StepScaling,TargetTrackingScaling, andPredictiveScaling.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
Response Elements
The following elements are returned by the service.
- NextToken
-
A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the
NextTokenvalue when requesting the next set of items. This value is null when there are no more items to return.Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]* - ScalingPolicies.member.N
-
The scaling policies.
Type: Array of ScalingPolicy objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextToken
-
The
NextTokenvalue is not valid.HTTP Status Code: 400
- ResourceContention
-
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
HTTP Status Code: 500
- ServiceLinkedRoleFailure
-
The service-linked role is not yet ready for use.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of DescribePolicies.
Sample Request
https://autoscaling.amazonaws.com/?Action=DescribePolicies
&AutoScalingGroupName=my-asg
&Version=2011-01-01
&AUTHPARAMS Sample Response
<DescribePoliciesResponse xmlns="https://autoscaling.amazonaws.com/doc/2011-01-01/">
<DescribePoliciesResult>
<ScalingPolicies>
<member>
<PolicyARN>arn:aws:autoscaling:us-east-1:123456789012:scalingPolicy:c322761b-3172-4d56-9a21-0ed9dEXAMPLE:autoScalingGroupName/my-asg:policyName/MyScaleInPolicy</PolicyARN>
<AdjustmentType>ChangeInCapacity</AdjustmentType>
<ScalingAdjustment>-1</ScalingAdjustment>
<PolicyName>MyScaleInPolicy</PolicyName>
<PolicyType>SimpleScaling</PolicyType>
<AutoScalingGroupName>my-asg</AutoScalingGroupName>
<Cooldown>60</Cooldown>
<Alarms>
<member>
<AlarmName>TestQueue</AlarmName>
<AlarmARN>arn:aws:cloudwatch:us-east-1:123456789012:alarm:TestQueue</AlarmARN>
</member>
</Alarms>
</member>
<member>
<PolicyARN>arn:aws:autoscaling:us-east-1:123456789012:scalingPolicy:c55a5cdd-9be0-435b-b60b-a8dd3EXAMPLE:autoScalingGroupName/my-asg:policyName/MyScaleOutPolicy</PolicyARN>
<AdjustmentType>ChangeInCapacity</AdjustmentType>
<ScalingAdjustment>1</ScalingAdjustment>
<PolicyName>MyScaleOutPolicy</PolicyName>
<PolicyType>SimpleScaling</PolicyType>
<AutoScalingGroupName>my-asg</AutoScalingGroupName>
<Cooldown>60</Cooldown>
<Alarms>
<member>
<AlarmName>TestQueue</AlarmName>
<AlarmARN>arn:aws:cloudwatch:us-east-1:123456789012:alarm:TestQueue</AlarmARN>
</member>
</Alarms>
</member>
</ScalingPolicies>
</DescribePoliciesResult>
<ResponseMetadata>
<RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>
</ResponseMetadata>
</DescribePoliciesResponse> See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
