SDK for PHP 3.x

AWS Auto Scaling Plans 2018-01-06

Client: Aws\AutoScalingPlans\AutoScalingPlansClient
Service ID: autoscaling-plans
Version: 2018-01-06

This page describes the parameters and results for the operations of the AWS Auto Scaling Plans (2018-01-06), and shows how to use the Aws\AutoScalingPlans\AutoScalingPlansClient object to call the described operations. This documentation is specific to the 2018-01-06 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateScalingPlan ( array $params = [] )
Creates a scaling plan.
DeleteScalingPlan ( array $params = [] )
Deletes the specified scaling plan.
DescribeScalingPlanResources ( array $params = [] )
Describes the scalable resources in the specified scaling plan.
DescribeScalingPlans ( array $params = [] )
Describes one or more of your scaling plans.
GetScalingPlanResourceForecastData ( array $params = [] )
Retrieves the forecast data for a scalable resource.
UpdateScalingPlan ( array $params = [] )
Updates the specified scaling plan.

Operations

CreateScalingPlan 

$result = $client->createScalingPlan([/* ... */]);
$promise = $client->createScalingPlanAsync([/* ... */]);

Creates a scaling plan.

Parameter Syntax

$result = $client->createScalingPlan([
    'ApplicationSource' => [ // REQUIRED
        'CloudFormationStackARN' => '<string>',
        'TagFilters' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'ScalingInstructions' => [ // REQUIRED
        [
            'CustomizedLoadMetricSpecification' => [
                'Dimensions' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'MetricName' => '<string>', // REQUIRED
                'Namespace' => '<string>', // REQUIRED
                'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum', // REQUIRED
                'Unit' => '<string>',
            ],
            'DisableDynamicScaling' => true || false,
            'MaxCapacity' => <integer>, // REQUIRED
            'MinCapacity' => <integer>, // REQUIRED
            'PredefinedLoadMetricSpecification' => [
                'PredefinedLoadMetricType' => 'ASGTotalCPUUtilization|ASGTotalNetworkIn|ASGTotalNetworkOut|ALBTargetGroupRequestCount', // REQUIRED
                'ResourceLabel' => '<string>',
            ],
            'PredictiveScalingMaxCapacityBehavior' => 'SetForecastCapacityToMaxCapacity|SetMaxCapacityToForecastCapacity|SetMaxCapacityAboveForecastCapacity',
            'PredictiveScalingMaxCapacityBuffer' => <integer>,
            'PredictiveScalingMode' => 'ForecastAndScale|ForecastOnly',
            'ResourceId' => '<string>', // REQUIRED
            'ScalableDimension' => 'autoscaling:autoScalingGroup:DesiredCapacity|ecs:service:DesiredCount|ec2:spot-fleet-request:TargetCapacity|rds:cluster:ReadReplicaCount|dynamodb:table:ReadCapacityUnits|dynamodb:table:WriteCapacityUnits|dynamodb:index:ReadCapacityUnits|dynamodb:index:WriteCapacityUnits', // REQUIRED
            'ScalingPolicyUpdateBehavior' => 'KeepExternalPolicies|ReplaceExternalPolicies',
            'ScheduledActionBufferTime' => <integer>,
            'ServiceNamespace' => 'autoscaling|ecs|ec2|rds|dynamodb', // REQUIRED
            'TargetTrackingConfigurations' => [ // REQUIRED
                [
                    'CustomizedScalingMetricSpecification' => [
                        'Dimensions' => [
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'MetricName' => '<string>', // REQUIRED
                        'Namespace' => '<string>', // REQUIRED
                        'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum', // REQUIRED
                        'Unit' => '<string>',
                    ],
                    'DisableScaleIn' => true || false,
                    'EstimatedInstanceWarmup' => <integer>,
                    'PredefinedScalingMetricSpecification' => [
                        'PredefinedScalingMetricType' => 'ASGAverageCPUUtilization|ASGAverageNetworkIn|ASGAverageNetworkOut|DynamoDBReadCapacityUtilization|DynamoDBWriteCapacityUtilization|ECSServiceAverageCPUUtilization|ECSServiceAverageMemoryUtilization|ALBRequestCountPerTarget|RDSReaderAverageCPUUtilization|RDSReaderAverageDatabaseConnections|EC2SpotFleetRequestAverageCPUUtilization|EC2SpotFleetRequestAverageNetworkIn|EC2SpotFleetRequestAverageNetworkOut', // REQUIRED
                        'ResourceLabel' => '<string>',
                    ],
                    'ScaleInCooldown' => <integer>,
                    'ScaleOutCooldown' => <integer>,
                    'TargetValue' => <float>, // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'ScalingPlanName' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationSource
Required: Yes
Type: ApplicationSource structure

A CloudFormation stack or set of tags. You can create one scaling plan per application source.

For more information, see ApplicationSource in the AWS Auto Scaling API Reference.

ScalingInstructions
Required: Yes
Type: Array of ScalingInstruction structures

The scaling instructions.

For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.

ScalingPlanName
Required: Yes
Type: string

The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

Result Syntax

[
    'ScalingPlanVersion' => <integer>,
]

Result Details

Members
ScalingPlanVersion
Required: Yes
Type: long (int|float)

The version number of the scaling plan. This value is always 1. Currently, you cannot have multiple scaling plan versions.

Errors

ValidationException:

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

LimitExceededException:

Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.

ConcurrentUpdateException:

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

InternalServiceException:

The service encountered an internal error.

DeleteScalingPlan 

$result = $client->deleteScalingPlan([/* ... */]);
$promise = $client->deleteScalingPlanAsync([/* ... */]);

Deletes the specified scaling plan.

Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.

If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.

Parameter Syntax

$result = $client->deleteScalingPlan([
    'ScalingPlanName' => '<string>', // REQUIRED
    'ScalingPlanVersion' => <integer>, // REQUIRED
]);

Parameter Details

Members
ScalingPlanName
Required: Yes
Type: string

The name of the scaling plan.

ScalingPlanVersion
Required: Yes
Type: long (int|float)

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

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

ObjectNotFoundException:

The specified object could not be found.

ConcurrentUpdateException:

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

InternalServiceException:

The service encountered an internal error.

DescribeScalingPlanResources 

$result = $client->describeScalingPlanResources([/* ... */]);
$promise = $client->describeScalingPlanResourcesAsync([/* ... */]);

Describes the scalable resources in the specified scaling plan.

Parameter Syntax

$result = $client->describeScalingPlanResources([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ScalingPlanName' => '<string>', // REQUIRED
    'ScalingPlanVersion' => <integer>, // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

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

NextToken
Type: string

The token for the next set of results.

ScalingPlanName
Required: Yes
Type: string

The name of the scaling plan.

ScalingPlanVersion
Required: Yes
Type: long (int|float)

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

Result Syntax

[
    'NextToken' => '<string>',
    'ScalingPlanResources' => [
        [
            'ResourceId' => '<string>',
            'ScalableDimension' => 'autoscaling:autoScalingGroup:DesiredCapacity|ecs:service:DesiredCount|ec2:spot-fleet-request:TargetCapacity|rds:cluster:ReadReplicaCount|dynamodb:table:ReadCapacityUnits|dynamodb:table:WriteCapacityUnits|dynamodb:index:ReadCapacityUnits|dynamodb:index:WriteCapacityUnits',
            'ScalingPlanName' => '<string>',
            'ScalingPlanVersion' => <integer>,
            'ScalingPolicies' => [
                [
                    'PolicyName' => '<string>',
                    'PolicyType' => 'TargetTrackingScaling',
                    'TargetTrackingConfiguration' => [
                        'CustomizedScalingMetricSpecification' => [
                            'Dimensions' => [
                                [
                                    'Name' => '<string>',
                                    'Value' => '<string>',
                                ],
                                // ...
                            ],
                            'MetricName' => '<string>',
                            'Namespace' => '<string>',
                            'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum',
                            'Unit' => '<string>',
                        ],
                        'DisableScaleIn' => true || false,
                        'EstimatedInstanceWarmup' => <integer>,
                        'PredefinedScalingMetricSpecification' => [
                            'PredefinedScalingMetricType' => 'ASGAverageCPUUtilization|ASGAverageNetworkIn|ASGAverageNetworkOut|DynamoDBReadCapacityUtilization|DynamoDBWriteCapacityUtilization|ECSServiceAverageCPUUtilization|ECSServiceAverageMemoryUtilization|ALBRequestCountPerTarget|RDSReaderAverageCPUUtilization|RDSReaderAverageDatabaseConnections|EC2SpotFleetRequestAverageCPUUtilization|EC2SpotFleetRequestAverageNetworkIn|EC2SpotFleetRequestAverageNetworkOut',
                            'ResourceLabel' => '<string>',
                        ],
                        'ScaleInCooldown' => <integer>,
                        'ScaleOutCooldown' => <integer>,
                        'TargetValue' => <float>,
                    ],
                ],
                // ...
            ],
            'ScalingStatusCode' => 'Inactive|PartiallyActive|Active',
            'ScalingStatusMessage' => '<string>',
            'ServiceNamespace' => 'autoscaling|ecs|ec2|rds|dynamodb',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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

ScalingPlanResources
Type: Array of ScalingPlanResource structures

Information about the scalable resources.

Errors

ValidationException:

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

InvalidNextTokenException:

The token provided is not valid.

ConcurrentUpdateException:

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

InternalServiceException:

The service encountered an internal error.

DescribeScalingPlans 

$result = $client->describeScalingPlans([/* ... */]);
$promise = $client->describeScalingPlansAsync([/* ... */]);

Describes one or more of your scaling plans.

Parameter Syntax

$result = $client->describeScalingPlans([
    'ApplicationSources' => [
        [
            'CloudFormationStackARN' => '<string>',
            'TagFilters' => [
                [
                    'Key' => '<string>',
                    'Values' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ScalingPlanNames' => ['<string>', ...],
    'ScalingPlanVersion' => <integer>,
]);

Parameter Details

Members
ApplicationSources
Type: Array of ApplicationSource structures

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

MaxResults
Type: int

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

NextToken
Type: string

The token for the next set of results.

ScalingPlanNames
Type: Array of strings

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

ScalingPlanVersion
Type: long (int|float)

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.

Result Syntax

[
    'NextToken' => '<string>',
    'ScalingPlans' => [
        [
            'ApplicationSource' => [
                'CloudFormationStackARN' => '<string>',
                'TagFilters' => [
                    [
                        'Key' => '<string>',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'CreationTime' => <DateTime>,
            'ScalingInstructions' => [
                [
                    'CustomizedLoadMetricSpecification' => [
                        'Dimensions' => [
                            [
                                'Name' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'MetricName' => '<string>',
                        'Namespace' => '<string>',
                        'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum',
                        'Unit' => '<string>',
                    ],
                    'DisableDynamicScaling' => true || false,
                    'MaxCapacity' => <integer>,
                    'MinCapacity' => <integer>,
                    'PredefinedLoadMetricSpecification' => [
                        'PredefinedLoadMetricType' => 'ASGTotalCPUUtilization|ASGTotalNetworkIn|ASGTotalNetworkOut|ALBTargetGroupRequestCount',
                        'ResourceLabel' => '<string>',
                    ],
                    'PredictiveScalingMaxCapacityBehavior' => 'SetForecastCapacityToMaxCapacity|SetMaxCapacityToForecastCapacity|SetMaxCapacityAboveForecastCapacity',
                    'PredictiveScalingMaxCapacityBuffer' => <integer>,
                    'PredictiveScalingMode' => 'ForecastAndScale|ForecastOnly',
                    'ResourceId' => '<string>',
                    'ScalableDimension' => 'autoscaling:autoScalingGroup:DesiredCapacity|ecs:service:DesiredCount|ec2:spot-fleet-request:TargetCapacity|rds:cluster:ReadReplicaCount|dynamodb:table:ReadCapacityUnits|dynamodb:table:WriteCapacityUnits|dynamodb:index:ReadCapacityUnits|dynamodb:index:WriteCapacityUnits',
                    'ScalingPolicyUpdateBehavior' => 'KeepExternalPolicies|ReplaceExternalPolicies',
                    'ScheduledActionBufferTime' => <integer>,
                    'ServiceNamespace' => 'autoscaling|ecs|ec2|rds|dynamodb',
                    'TargetTrackingConfigurations' => [
                        [
                            'CustomizedScalingMetricSpecification' => [
                                'Dimensions' => [
                                    [
                                        'Name' => '<string>',
                                        'Value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'MetricName' => '<string>',
                                'Namespace' => '<string>',
                                'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum',
                                'Unit' => '<string>',
                            ],
                            'DisableScaleIn' => true || false,
                            'EstimatedInstanceWarmup' => <integer>,
                            'PredefinedScalingMetricSpecification' => [
                                'PredefinedScalingMetricType' => 'ASGAverageCPUUtilization|ASGAverageNetworkIn|ASGAverageNetworkOut|DynamoDBReadCapacityUtilization|DynamoDBWriteCapacityUtilization|ECSServiceAverageCPUUtilization|ECSServiceAverageMemoryUtilization|ALBRequestCountPerTarget|RDSReaderAverageCPUUtilization|RDSReaderAverageDatabaseConnections|EC2SpotFleetRequestAverageCPUUtilization|EC2SpotFleetRequestAverageNetworkIn|EC2SpotFleetRequestAverageNetworkOut',
                                'ResourceLabel' => '<string>',
                            ],
                            'ScaleInCooldown' => <integer>,
                            'ScaleOutCooldown' => <integer>,
                            'TargetValue' => <float>,
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'ScalingPlanName' => '<string>',
            'ScalingPlanVersion' => <integer>,
            'StatusCode' => 'Active|ActiveWithProblems|CreationInProgress|CreationFailed|DeletionInProgress|DeletionFailed|UpdateInProgress|UpdateFailed',
            'StatusMessage' => '<string>',
            'StatusStartTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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

ScalingPlans
Type: Array of ScalingPlan structures

Information about the scaling plans.

Errors

ValidationException:

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

InvalidNextTokenException:

The token provided is not valid.

ConcurrentUpdateException:

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

InternalServiceException:

The service encountered an internal error.

GetScalingPlanResourceForecastData 

$result = $client->getScalingPlanResourceForecastData([/* ... */]);
$promise = $client->getScalingPlanResourceForecastDataAsync([/* ... */]);

Retrieves the forecast data for a scalable resource.

Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

Parameter Syntax

$result = $client->getScalingPlanResourceForecastData([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'ForecastDataType' => 'CapacityForecast|LoadForecast|ScheduledActionMinCapacity|ScheduledActionMaxCapacity', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
    'ScalableDimension' => 'autoscaling:autoScalingGroup:DesiredCapacity|ecs:service:DesiredCount|ec2:spot-fleet-request:TargetCapacity|rds:cluster:ReadReplicaCount|dynamodb:table:ReadCapacityUnits|dynamodb:table:WriteCapacityUnits|dynamodb:index:ReadCapacityUnits|dynamodb:index:WriteCapacityUnits', // REQUIRED
    'ScalingPlanName' => '<string>', // REQUIRED
    'ScalingPlanVersion' => <integer>, // REQUIRED
    'ServiceNamespace' => 'autoscaling|ecs|ec2|rds|dynamodb', // REQUIRED
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members
EndTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days.

Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.

ForecastDataType
Required: Yes
Type: string

The type of forecast data to get.

  • LoadForecast: The load metric forecast.

  • CapacityForecast: The capacity forecast.

  • ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.

  • ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.

ResourceId
Required: Yes
Type: string

The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.

ScalableDimension
Required: Yes
Type: string

The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

ScalingPlanName
Required: Yes
Type: string

The name of the scaling plan.

ScalingPlanVersion
Required: Yes
Type: long (int|float)

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

ServiceNamespace
Required: Yes
Type: string

The namespace of the AWS service. The only valid value is autoscaling.

StartTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.

Result Syntax

[
    'Datapoints' => [
        [
            'Timestamp' => <DateTime>,
            'Value' => <float>,
        ],
        // ...
    ],
]

Result Details

Members
Datapoints
Required: Yes
Type: Array of Datapoint structures

The data points to return.

Errors

ValidationException:

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

InternalServiceException:

The service encountered an internal error.

UpdateScalingPlan 

$result = $client->updateScalingPlan([/* ... */]);
$promise = $client->updateScalingPlanAsync([/* ... */]);

Updates the specified scaling plan.

You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

Parameter Syntax

$result = $client->updateScalingPlan([
    'ApplicationSource' => [
        'CloudFormationStackARN' => '<string>',
        'TagFilters' => [
            [
                'Key' => '<string>',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'ScalingInstructions' => [
        [
            'CustomizedLoadMetricSpecification' => [
                'Dimensions' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'MetricName' => '<string>', // REQUIRED
                'Namespace' => '<string>', // REQUIRED
                'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum', // REQUIRED
                'Unit' => '<string>',
            ],
            'DisableDynamicScaling' => true || false,
            'MaxCapacity' => <integer>, // REQUIRED
            'MinCapacity' => <integer>, // REQUIRED
            'PredefinedLoadMetricSpecification' => [
                'PredefinedLoadMetricType' => 'ASGTotalCPUUtilization|ASGTotalNetworkIn|ASGTotalNetworkOut|ALBTargetGroupRequestCount', // REQUIRED
                'ResourceLabel' => '<string>',
            ],
            'PredictiveScalingMaxCapacityBehavior' => 'SetForecastCapacityToMaxCapacity|SetMaxCapacityToForecastCapacity|SetMaxCapacityAboveForecastCapacity',
            'PredictiveScalingMaxCapacityBuffer' => <integer>,
            'PredictiveScalingMode' => 'ForecastAndScale|ForecastOnly',
            'ResourceId' => '<string>', // REQUIRED
            'ScalableDimension' => 'autoscaling:autoScalingGroup:DesiredCapacity|ecs:service:DesiredCount|ec2:spot-fleet-request:TargetCapacity|rds:cluster:ReadReplicaCount|dynamodb:table:ReadCapacityUnits|dynamodb:table:WriteCapacityUnits|dynamodb:index:ReadCapacityUnits|dynamodb:index:WriteCapacityUnits', // REQUIRED
            'ScalingPolicyUpdateBehavior' => 'KeepExternalPolicies|ReplaceExternalPolicies',
            'ScheduledActionBufferTime' => <integer>,
            'ServiceNamespace' => 'autoscaling|ecs|ec2|rds|dynamodb', // REQUIRED
            'TargetTrackingConfigurations' => [ // REQUIRED
                [
                    'CustomizedScalingMetricSpecification' => [
                        'Dimensions' => [
                            [
                                'Name' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'MetricName' => '<string>', // REQUIRED
                        'Namespace' => '<string>', // REQUIRED
                        'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum', // REQUIRED
                        'Unit' => '<string>',
                    ],
                    'DisableScaleIn' => true || false,
                    'EstimatedInstanceWarmup' => <integer>,
                    'PredefinedScalingMetricSpecification' => [
                        'PredefinedScalingMetricType' => 'ASGAverageCPUUtilization|ASGAverageNetworkIn|ASGAverageNetworkOut|DynamoDBReadCapacityUtilization|DynamoDBWriteCapacityUtilization|ECSServiceAverageCPUUtilization|ECSServiceAverageMemoryUtilization|ALBRequestCountPerTarget|RDSReaderAverageCPUUtilization|RDSReaderAverageDatabaseConnections|EC2SpotFleetRequestAverageCPUUtilization|EC2SpotFleetRequestAverageNetworkIn|EC2SpotFleetRequestAverageNetworkOut', // REQUIRED
                        'ResourceLabel' => '<string>',
                    ],
                    'ScaleInCooldown' => <integer>,
                    'ScaleOutCooldown' => <integer>,
                    'TargetValue' => <float>, // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'ScalingPlanName' => '<string>', // REQUIRED
    'ScalingPlanVersion' => <integer>, // REQUIRED
]);

Parameter Details

Members
ApplicationSource
Type: ApplicationSource structure

A CloudFormation stack or set of tags.

For more information, see ApplicationSource in the AWS Auto Scaling API Reference.

ScalingInstructions
Type: Array of ScalingInstruction structures

The scaling instructions.

For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.

ScalingPlanName
Required: Yes
Type: string

The name of the scaling plan.

ScalingPlanVersion
Required: Yes
Type: long (int|float)

The version number of the scaling plan. The only valid value is 1. Currently, you cannot have multiple scaling plan versions.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

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

ConcurrentUpdateException:

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

InternalServiceException:

The service encountered an internal error.

ObjectNotFoundException:

The specified object could not be found.

Shapes

ApplicationSource

Description

Represents an application source.

Members
CloudFormationStackARN
Type: string

The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

TagFilters
Type: Array of TagFilter structures

A set of tags (up to 50).

ConcurrentUpdateException

Description

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

Members
Message
Type: string

CustomizedLoadMetricSpecification

Description

Represents a CloudWatch metric of your choosing that can be used for predictive scaling.

For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data.

When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.

After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.

Members
Dimensions
Type: Array of MetricDimension structures

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

MetricName
Required: Yes
Type: string

The name of the metric.

Namespace
Required: Yes
Type: string

The namespace of the metric.

Statistic
Required: Yes
Type: string

The statistic of the metric. The only valid value is Sum.

Unit
Type: string

The unit of the metric.

CustomizedScalingMetricSpecification

Description

Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.

Members
Dimensions
Type: Array of MetricDimension structures

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

MetricName
Required: Yes
Type: string

The name of the metric.

Namespace
Required: Yes
Type: string

The namespace of the metric.

Statistic
Required: Yes
Type: string

The statistic of the metric.

Unit
Type: string

The unit of the metric.

Datapoint

Description

Represents a single value in the forecast data used for predictive scaling.

Members
Timestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp for the data point in UTC format.

Value
Type: double

The value of the data point.

InternalServiceException

Description

The service encountered an internal error.

Members
Message
Type: string

InvalidNextTokenException

Description

The token provided is not valid.

Members
Message
Type: string

LimitExceededException

Description

Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.

Members
Message
Type: string

MetricDimension

Description

Represents a dimension for a customized metric.

Members
Name
Required: Yes
Type: string

The name of the dimension.

Value
Required: Yes
Type: string

The value of the dimension.

ObjectNotFoundException

Description

The specified object could not be found.

Members
Message
Type: string

PredefinedLoadMetricSpecification

Description

Represents a predefined metric that can be used for predictive scaling.

After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.

Members
PredefinedLoadMetricType
Required: Yes
Type: string

The metric type.

ResourceLabel
Type: string

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

PredefinedScalingMetricSpecification

Description

Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.

Members
PredefinedScalingMetricType
Required: Yes
Type: string

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

ResourceLabel
Type: string

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

ScalingInstruction

Description

Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource.

AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.

AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.

We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best Practices for AWS Auto Scaling in the AWS Auto Scaling User Guide.

Members
CustomizedLoadMetricSpecification
Type: CustomizedLoadMetricSpecification structure

The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

DisableDynamicScaling
Type: boolean

Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

The default is enabled (false).

MaxCapacity
Required: Yes
Type: int

The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

MinCapacity
Required: Yes
Type: int

The minimum capacity of the resource.

PredefinedLoadMetricSpecification
Type: PredefinedLoadMetricSpecification structure

The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

PredictiveScalingMaxCapacityBehavior
Type: string

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

The following are possible values:

  • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

  • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

Only valid when configuring predictive scaling.

PredictiveScalingMaxCapacityBuffer
Type: int

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

The range is 1-100.

PredictiveScalingMode
Type: string

The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

ResourceId
Required: Yes
Type: string

The ID of the resource. This string consists of the resource type and unique identifier.

  • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

ScalableDimension
Required: Yes
Type: string

The scalable dimension associated with the resource.

  • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

ScalingPolicyUpdateBehavior
Type: string

Controls whether a resource's externally created scaling policies are kept or replaced.

The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

Only valid when configuring dynamic scaling.

Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

ScheduledActionBufferTime
Type: int

The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

Only valid when configuring predictive scaling.

ServiceNamespace
Required: Yes
Type: string

The namespace of the AWS service.

TargetTrackingConfigurations
Required: Yes
Type: Array of TargetTrackingConfiguration structures

The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.

ScalingPlan

Description

Represents a scaling plan.

Members
ApplicationSource
Required: Yes
Type: ApplicationSource structure

A CloudFormation stack or a set of tags. You can create one scaling plan per application source.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix time stamp when the scaling plan was created.

ScalingInstructions
Required: Yes
Type: Array of ScalingInstruction structures

The scaling instructions.

ScalingPlanName
Required: Yes
Type: string

The name of the scaling plan.

ScalingPlanVersion
Required: Yes
Type: long (int|float)

The version number of the scaling plan.

StatusCode
Required: Yes
Type: string

The status of the scaling plan.

  • Active - The scaling plan is active.

  • ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

  • CreationInProgress - The scaling plan is being created.

  • CreationFailed - The scaling plan could not be created.

  • DeletionInProgress - The scaling plan is being deleted.

  • DeletionFailed - The scaling plan could not be deleted.

  • UpdateInProgress - The scaling plan is being updated.

  • UpdateFailed - The scaling plan could not be updated.

StatusMessage
Type: string

A simple message about the current status of the scaling plan.

StatusStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix time stamp when the scaling plan entered the current status.

ScalingPlanResource

Description

Represents a scalable resource.

Members
ResourceId
Required: Yes
Type: string

The ID of the resource. This string consists of the resource type and unique identifier.

  • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

ScalableDimension
Required: Yes
Type: string

The scalable dimension for the resource.

  • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

ScalingPlanName
Required: Yes
Type: string

The name of the scaling plan.

ScalingPlanVersion
Required: Yes
Type: long (int|float)

The version number of the scaling plan.

ScalingPolicies
Type: Array of ScalingPolicy structures

The scaling policies.

ScalingStatusCode
Required: Yes
Type: string

The scaling status of the resource.

  • Active - The scaling configuration is active.

  • Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.

  • PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.

ScalingStatusMessage
Type: string

A simple message about the current scaling status of the resource.

ServiceNamespace
Required: Yes
Type: string

The namespace of the AWS service.

ScalingPolicy

Description

Represents a scaling policy.

Members
PolicyName
Required: Yes
Type: string

The name of the scaling policy.

PolicyType
Required: Yes
Type: string

The type of scaling policy.

TargetTrackingConfiguration
Type: TargetTrackingConfiguration structure

The target tracking scaling policy. Includes support for predefined or customized metrics.

TagFilter

Description

Represents a tag.

Members
Key
Type: string

The tag key.

Values
Type: Array of strings

The tag values (0 to 20).

TargetTrackingConfiguration

Description

Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.

Members
CustomizedScalingMetricSpecification
Type: CustomizedScalingMetricSpecification structure

A customized metric. You can specify either a predefined metric or a customized metric.

DisableScaleIn
Type: boolean

Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

The default value is false.

EstimatedInstanceWarmup
Type: int

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

PredefinedScalingMetricSpecification
Type: PredefinedScalingMetricSpecification structure

A predefined metric. You can specify either a predefined metric or a customized metric.

ScaleInCooldown
Type: int

The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.

With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.

ScaleOutCooldown
Type: int

The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.

With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.

TargetValue
Required: Yes
Type: double

The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360.

ValidationException

Description

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

Members
Message
Type: string