DescribeScalingPlans - AWS Auto Scaling


Describes one or more of your scaling plans.

Request Syntax

{ "ApplicationSources": [ { "CloudFormationStackARN": "string", "TagFilters": [ { "Key": "string", "Values": [ "string" ] } ] } ], "MaxResults": number, "NextToken": "string", "ScalingPlanNames": [ "string" ], "ScalingPlanVersion": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

Type: Array of ApplicationSource objects

Required: No


The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

Type: Integer

Required: No


The token for the next set of results.

Type: String

Required: No


The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{Print}&&[^|:/]]+

Required: No


The version number of the scaling plan. Currently, the only valid value is 1.


If you specify a scaling plan version, you must also specify a scaling plan name.

Type: Long

Required: No

Response Syntax

{ "NextToken": "string", "ScalingPlans": [ { "ApplicationSource": { "CloudFormationStackARN": "string", "TagFilters": [ { "Key": "string", "Values": [ "string" ] } ] }, "CreationTime": number, "ScalingInstructions": [ { "CustomizedLoadMetricSpecification": { "Dimensions": [ { "Name": "string", "Value": "string" } ], "MetricName": "string", "Namespace": "string", "Statistic": "string", "Unit": "string" }, "DisableDynamicScaling": boolean, "MaxCapacity": number, "MinCapacity": number, "PredefinedLoadMetricSpecification": { "PredefinedLoadMetricType": "string", "ResourceLabel": "string" }, "PredictiveScalingMaxCapacityBehavior": "string", "PredictiveScalingMaxCapacityBuffer": number, "PredictiveScalingMode": "string", "ResourceId": "string", "ScalableDimension": "string", "ScalingPolicyUpdateBehavior": "string", "ScheduledActionBufferTime": number, "ServiceNamespace": "string", "TargetTrackingConfigurations": [ { "CustomizedScalingMetricSpecification": { "Dimensions": [ { "Name": "string", "Value": "string" } ], "MetricName": "string", "Namespace": "string", "Statistic": "string", "Unit": "string" }, "DisableScaleIn": boolean, "EstimatedInstanceWarmup": number, "PredefinedScalingMetricSpecification": { "PredefinedScalingMetricType": "string", "ResourceLabel": "string" }, "ScaleInCooldown": number, "ScaleOutCooldown": number, "TargetValue": number } ] } ], "ScalingPlanName": "string", "ScalingPlanVersion": number, "StatusCode": "string", "StatusMessage": "string", "StatusStartTime": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The token required to get the next set of results. This value is null if there are no more results to return.

Type: String


Information about the scaling plans.

Type: Array of ScalingPlan objects


For information about the errors that are common to all actions, see Common Errors.


Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

HTTP Status Code: 400


The service encountered an internal error.

HTTP Status Code: 400


The token provided is not valid.

HTTP Status Code: 400


An exception was thrown for a validation issue. Review the parameters provided.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: