ApplicationAutoScaling / Client / put_scaling_policy
put_scaling_policy#
- ApplicationAutoScaling.Client.put_scaling_policy(**kwargs)#
Creates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
Note
If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
See also: AWS API Documentation
Request Syntax
response = client.put_scaling_policy( PolicyName='string', ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune'|'workspaces', ResourceId='string', ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredProvisionedConcurrency'|'sagemaker:inference-component:DesiredCopyCount'|'workspaces:workspacespool:DesiredUserSessions', PolicyType='StepScaling'|'TargetTrackingScaling'|'PredictiveScaling', StepScalingPolicyConfiguration={ 'AdjustmentType': 'ChangeInCapacity'|'PercentChangeInCapacity'|'ExactCapacity', 'StepAdjustments': [ { 'MetricIntervalLowerBound': 123.0, 'MetricIntervalUpperBound': 123.0, 'ScalingAdjustment': 123 }, ], 'MinAdjustmentMagnitude': 123, 'Cooldown': 123, 'MetricAggregationType': 'Average'|'Minimum'|'Maximum' }, TargetTrackingScalingPolicyConfiguration={ 'TargetValue': 123.0, 'PredefinedMetricSpecification': { 'PredefinedMetricType': 'DynamoDBReadCapacityUtilization'|'DynamoDBWriteCapacityUtilization'|'ALBRequestCountPerTarget'|'RDSReaderAverageCPUUtilization'|'RDSReaderAverageDatabaseConnections'|'EC2SpotFleetRequestAverageCPUUtilization'|'EC2SpotFleetRequestAverageNetworkIn'|'EC2SpotFleetRequestAverageNetworkOut'|'SageMakerVariantInvocationsPerInstance'|'ECSServiceAverageCPUUtilization'|'ECSServiceAverageMemoryUtilization'|'AppStreamAverageCapacityUtilization'|'ComprehendInferenceUtilization'|'LambdaProvisionedConcurrencyUtilization'|'CassandraReadCapacityUtilization'|'CassandraWriteCapacityUtilization'|'KafkaBrokerStorageUtilization'|'ElastiCachePrimaryEngineCPUUtilization'|'ElastiCacheReplicaEngineCPUUtilization'|'ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage'|'NeptuneReaderAverageCPUUtilization'|'SageMakerVariantProvisionedConcurrencyUtilization'|'ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage'|'SageMakerInferenceComponentInvocationsPerCopy'|'WorkSpacesAverageUserSessionsCapacityUtilization'|'SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution'|'SageMakerVariantConcurrentRequestsPerModelHighResolution', 'ResourceLabel': 'string' }, 'CustomizedMetricSpecification': { 'MetricName': 'string', 'Namespace': 'string', 'Dimensions': [ { 'Name': 'string', 'Value': 'string' }, ], 'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum', 'Unit': 'string', 'Metrics': [ { 'Expression': 'string', 'Id': 'string', 'Label': 'string', 'MetricStat': { 'Metric': { 'Dimensions': [ { 'Name': 'string', 'Value': 'string' }, ], 'MetricName': 'string', 'Namespace': 'string' }, 'Stat': 'string', 'Unit': 'string' }, 'ReturnData': True|False }, ] }, 'ScaleOutCooldown': 123, 'ScaleInCooldown': 123, 'DisableScaleIn': True|False }, PredictiveScalingPolicyConfiguration={ 'MetricSpecifications': [ { 'TargetValue': 123.0, 'PredefinedMetricPairSpecification': { 'PredefinedMetricType': 'string', 'ResourceLabel': 'string' }, 'PredefinedScalingMetricSpecification': { 'PredefinedMetricType': 'string', 'ResourceLabel': 'string' }, 'PredefinedLoadMetricSpecification': { 'PredefinedMetricType': 'string', 'ResourceLabel': 'string' }, 'CustomizedScalingMetricSpecification': { 'MetricDataQueries': [ { 'Id': 'string', 'Expression': 'string', 'MetricStat': { 'Metric': { 'Dimensions': [ { 'Name': 'string', 'Value': 'string' }, ], 'MetricName': 'string', 'Namespace': 'string' }, 'Stat': 'string', 'Unit': 'string' }, 'Label': 'string', 'ReturnData': True|False }, ] }, 'CustomizedLoadMetricSpecification': { 'MetricDataQueries': [ { 'Id': 'string', 'Expression': 'string', 'MetricStat': { 'Metric': { 'Dimensions': [ { 'Name': 'string', 'Value': 'string' }, ], 'MetricName': 'string', 'Namespace': 'string' }, 'Stat': 'string', 'Unit': 'string' }, 'Label': 'string', 'ReturnData': True|False }, ] }, 'CustomizedCapacityMetricSpecification': { 'MetricDataQueries': [ { 'Id': 'string', 'Expression': 'string', 'MetricStat': { 'Metric': { 'Dimensions': [ { 'Name': 'string', 'Value': 'string' }, ], 'MetricName': 'string', 'Namespace': 'string' }, 'Stat': 'string', 'Unit': 'string' }, 'Label': 'string', 'ReturnData': True|False }, ] } }, ], 'Mode': 'ForecastOnly'|'ForecastAndScale', 'SchedulingBufferTime': 123, 'MaxCapacityBreachBehavior': 'HonorMaxCapacity'|'IncreaseMaxCapacity', 'MaxCapacityBuffer': 123 } )
- Parameters:
PolicyName (string) –
[REQUIRED]
The name of the scaling policy.
You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name.
ServiceNamespace (string) –
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use
custom-resourceinstead.ResourceId (string) –
[REQUIRED]
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/my-cluster/my-service.Spot Fleet - The resource type is
spot-fleet-requestand the unique identifier is the Spot Fleet request ID. Example:spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.EMR cluster - The resource type is
instancegroupand the unique identifier is the cluster ID and instance group ID. Example:instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.AppStream 2.0 fleet - The resource type is
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet.DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table.DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index.Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster.SageMaker endpoint variant - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering.Custom resources are not supported with a resource type. This parameter must specify the
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.Lambda provisioned concurrency - The resource type is
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1.Amazon Keyspaces table - The resource type is
tableand the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable.Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.Amazon ElastiCache replication group - The resource type is
replication-groupand the unique identifier is the replication group name. Example:replication-group/mycluster.Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.SageMaker serverless endpoint - The resource type is
variantand the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering.SageMaker inference component - The resource type is
inference-componentand the unique identifier is the resource ID. Example:inference-component/my-inference-component.Pool of WorkSpaces - The resource type is
workspacespooland the unique identifier is the pool ID. Example:workspacespool/wspool-123456.
ScalableDimension (string) –
[REQUIRED]
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount- The task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity- The capacity of an AppStream 2.0 fleet.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.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for a SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits- The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency- The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits- The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits- The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups- The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas- The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount- The count of read replicas in an Amazon Neptune DB cluster.sagemaker:variant:DesiredProvisionedConcurrency- The provisioned concurrency for a SageMaker serverless endpoint.sagemaker:inference-component:DesiredCopyCount- The number of copies across an endpoint for a SageMaker inference component.workspaces:workspacespool:DesiredUserSessions- The number of user sessions for the WorkSpaces in the pool.
PolicyType (string) –
The scaling policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR.StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
StepScalingPolicyConfiguration (dict) –
A step scaling policy.
This parameter is required if you are creating a policy and the policy type is
StepScaling.AdjustmentType (string) –
Specifies how the
ScalingAdjustmentvalue in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values areChangeInCapacity,ExactCapacity, andPercentChangeInCapacity.AdjustmentTypeis required if you are adding a new step scaling policy configuration.StepAdjustments (list) –
A set of adjustments that enable you to scale based on the size of the alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
(dict) –
Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you’ve defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
To initiate the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of
0and an upper bound of10.To initiate the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of
-10and an upper bound of0.
There are a few rules for the step adjustments for your step policy:
The ranges of your step adjustments can’t overlap or have a gap.
At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.
At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.
The upper and lower bound can’t be null in the same step adjustment.
MetricIntervalLowerBound (float) –
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it’s exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
MetricIntervalUpperBound (float) –
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it’s inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
ScalingAdjustment (integer) – [REQUIRED]
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.
MinAdjustmentMagnitude (integer) –
The minimum value to scale by when the adjustment type is
PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify aMinAdjustmentMagnitudeof 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitudeof 2, Application Auto Scaling scales out the service by 2 tasks.Cooldown (integer) –
The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
MetricAggregationType (string) –
The aggregation type for the CloudWatch metrics. Valid values are
Minimum,Maximum, andAverage. If the aggregation type is null, the value is treated asAverage.
TargetTrackingScalingPolicyConfiguration (dict) –
A target tracking scaling policy. Includes support for predefined or customized metrics.
This parameter is required if you are creating a policy and the policy type is
TargetTrackingScaling.TargetValue (float) – [REQUIRED]
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. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
Note
If the scaling policy specifies the
ALBRequestCountPerTargetpredefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.PredefinedMetricSpecification (dict) –
A predefined metric. You can specify either a predefined metric or a customized metric.
PredefinedMetricType (string) – [REQUIRED]
The metric type. The
ALBRequestCountPerTargetmetric type applies only to Spot Fleets and ECS services.ResourceLabel (string) –
Identifies the resource associated with the metric type. You can’t specify a resource label unless the metric type is
ALBRequestCountPerTargetand there is a target group attached to the Spot Fleet 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 of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.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.
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.
CustomizedMetricSpecification (dict) –
A customized metric. You can specify either a predefined metric or a customized metric.
MetricName (string) –
The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that’s returned by a call to ListMetrics.
Namespace (string) –
The namespace of the metric.
Dimensions (list) –
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
(dict) –
Describes the dimension names and values associated with a metric.
Name (string) – [REQUIRED]
The name of the dimension.
Value (string) – [REQUIRED]
The value of the dimension.
Statistic (string) –
The statistic of the metric.
Unit (string) –
The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
Metrics (list) –
The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
(dict) –
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
For more information and examples, see Create a target tracking scaling policy for Application Auto Scaling using metric math in the Application Auto Scaling User Guide.
Expression (string) –
The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the
Idof the other metrics to refer to those metrics, and can also use theIdof other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.Id (string) – [REQUIRED]
A short name that identifies the object’s results in the response. This name must be unique among all
MetricDataQueryobjects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.Label (string) –
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
MetricStat (dict) –
Information about the metric data to return.
Conditional: Within each
MetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.Metric (dict) – [REQUIRED]
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
Dimensions (list) –
The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
(dict) –
Describes the dimension of a metric.
Name (string) – [REQUIRED]
The name of the dimension.
Value (string) – [REQUIRED]
The value of the dimension.
MetricName (string) –
The name of the metric.
Namespace (string) –
The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Stat (string) – [REQUIRED]
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metric for scaling is
Average.Unit (string) –
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
ReturnData (boolean) –
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify
truefor this value for only the final math expression that the metric specification is based on. You must specifyfalseforReturnDatafor all the other metrics and expressions used in the metric specification.If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData. This sets it to its default (true).
ScaleOutCooldown (integer) –
The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
ScaleInCooldown (integer) –
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
DisableScaleIn (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 won’t remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value isfalse.
PredictiveScalingPolicyConfiguration (dict) –
The configuration of the predictive scaling policy.
MetricSpecifications (list) – [REQUIRED]
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
(dict) –
This structure specifies the metrics and target utilization settings for a predictive scaling policy.
You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.
TargetValue (float) – [REQUIRED]
Specifies the target utilization.
PredefinedMetricPairSpecification (dict) –
The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.
PredefinedMetricType (string) – [REQUIRED]
Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric.
ResourceLabel (string) –
A label that uniquely identifies a specific target group from which to determine the total and average request count.
PredefinedScalingMetricSpecification (dict) –
The predefined scaling metric specification.
PredefinedMetricType (string) – [REQUIRED]
The metric type.
ResourceLabel (string) –
A label that uniquely identifies a specific target group from which to determine the average request count.
PredefinedLoadMetricSpecification (dict) –
The predefined load metric specification.
PredefinedMetricType (string) – [REQUIRED]
The metric type.
ResourceLabel (string) –
A label that uniquely identifies a target group.
CustomizedScalingMetricSpecification (dict) –
The customized scaling metric specification.
MetricDataQueries (list) – [REQUIRED]
One or more metric data queries to provide data points for a metric specification.
(dict) –
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
Id (string) – [REQUIRED]
A short name that identifies the object’s results in the response. This name must be unique among all
MetricDataQueryobjects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.Expression (string) –
The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the
Idof the other metrics to refer to those metrics, and can also use theIdof other expressions to use the result of those expressions.Conditional: Within each
MetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.MetricStat (dict) –
Information about the metric data to return.
Conditional: Within each
MetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.Metric (dict) – [REQUIRED]
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
Dimensions (list) –
Describes the dimensions of the metric.
(dict) –
Describes the dimension of a metric.
Name (string) – [REQUIRED]
The name of the dimension.
Value (string) – [REQUIRED]
The value of the dimension.
MetricName (string) –
The name of the metric.
Namespace (string) –
The namespace of the metric.
Stat (string) – [REQUIRED]
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are
AverageandSum.Unit (string) –
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
Label (string) –
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
ReturnData (boolean) –
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify
truefor this value for only the final math expression that the metric specification is based on. You must specifyfalseforReturnDatafor all the other metrics and expressions used in the metric specification.If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData. This sets it to its default (true).
CustomizedLoadMetricSpecification (dict) –
The customized load metric specification.
MetricDataQueries (list) – [REQUIRED]
One or more metric data queries to provide data points for a metric specification.
(dict) –
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
Id (string) – [REQUIRED]
A short name that identifies the object’s results in the response. This name must be unique among all
MetricDataQueryobjects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.Expression (string) –
The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the
Idof the other metrics to refer to those metrics, and can also use theIdof other expressions to use the result of those expressions.Conditional: Within each
MetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.MetricStat (dict) –
Information about the metric data to return.
Conditional: Within each
MetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.Metric (dict) – [REQUIRED]
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
Dimensions (list) –
Describes the dimensions of the metric.
(dict) –
Describes the dimension of a metric.
Name (string) – [REQUIRED]
The name of the dimension.
Value (string) – [REQUIRED]
The value of the dimension.
MetricName (string) –
The name of the metric.
Namespace (string) –
The namespace of the metric.
Stat (string) – [REQUIRED]
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are
AverageandSum.Unit (string) –
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
Label (string) –
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
ReturnData (boolean) –
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify
truefor this value for only the final math expression that the metric specification is based on. You must specifyfalseforReturnDatafor all the other metrics and expressions used in the metric specification.If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData. This sets it to its default (true).
CustomizedCapacityMetricSpecification (dict) –
The customized capacity metric specification.
MetricDataQueries (list) – [REQUIRED]
One or more metric data queries to provide data points for a metric specification.
(dict) –
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
Id (string) – [REQUIRED]
A short name that identifies the object’s results in the response. This name must be unique among all
MetricDataQueryobjects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.Expression (string) –
The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the
Idof the other metrics to refer to those metrics, and can also use theIdof other expressions to use the result of those expressions.Conditional: Within each
MetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.MetricStat (dict) –
Information about the metric data to return.
Conditional: Within each
MetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.Metric (dict) – [REQUIRED]
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
Dimensions (list) –
Describes the dimensions of the metric.
(dict) –
Describes the dimension of a metric.
Name (string) – [REQUIRED]
The name of the dimension.
Value (string) – [REQUIRED]
The value of the dimension.
MetricName (string) –
The name of the metric.
Namespace (string) –
The namespace of the metric.
Stat (string) – [REQUIRED]
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are
AverageandSum.Unit (string) –
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
Label (string) –
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
ReturnData (boolean) –
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify
truefor this value for only the final math expression that the metric specification is based on. You must specifyfalseforReturnDatafor all the other metrics and expressions used in the metric specification.If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData. This sets it to its default (true).
Mode (string) –
The predictive scaling mode. Defaults to
ForecastOnlyif not specified.SchedulingBufferTime (integer) –
The amount of time, in seconds, that the start time can be advanced.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
MaxCapacityBreachBehavior (string) –
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to
HonorMaxCapacityif not specified.MaxCapacityBuffer (integer) –
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.
Required if the
MaxCapacityBreachBehaviorproperty is set toIncreaseMaxCapacity, and cannot be used otherwise.
- Return type:
dict
- Returns:
Response Syntax
{ 'PolicyARN': 'string', 'Alarms': [ { 'AlarmName': 'string', 'AlarmARN': 'string' }, ] }
Response Structure
(dict) –
PolicyARN (string) –
The Amazon Resource Name (ARN) of the resulting scaling policy.
Alarms (list) –
The CloudWatch alarms created for the target tracking scaling policy.
(dict) –
Represents a CloudWatch alarm associated with a scaling policy.
AlarmName (string) –
The name of the alarm.
AlarmARN (string) –
The Amazon Resource Name (ARN) of the alarm.
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.LimitExceededExceptionApplicationAutoScaling.Client.exceptions.ObjectNotFoundExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.FailedResourceAccessExceptionApplicationAutoScaling.Client.exceptions.InternalServiceException
Examples
The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.
response = client.put_scaling_policy( PolicyName='cpu75-target-tracking-scaling-policy', PolicyType='TargetTrackingScaling', ResourceId='service/default/web-app', ScalableDimension='ecs:service:DesiredCount', ServiceNamespace='ecs', TargetTrackingScalingPolicyConfiguration={ 'PredefinedMetricSpecification': { 'PredefinedMetricType': 'ECSServiceAverageCPUUtilization', }, 'ScaleInCooldown': 60, 'ScaleOutCooldown': 60, 'TargetValue': 75, }, ) print(response)
Expected Output:
{ 'Alarms': [ { 'AlarmARN': 'arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca', 'AlarmName': 'TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca', }, { 'AlarmARN': 'arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d', 'AlarmName': 'TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d', }, ], 'PolicyARN': 'arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy', 'ResponseMetadata': { '...': '...', }, }