Table of Contents
A low-level client representing Application Auto Scaling:
client = session.create_client('application-autoscaling')
These are the available methods:
Check if an operation can be paginated.
Deletes the specified Application Auto Scaling scaling policy.
Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
To create a scaling policy or update an existing one, see PutScalingPolicy .
See also: AWS API Documentation
Request Syntax
response = client.delete_scaling_policy(
PolicyName='string',
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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'
)
[REQUIRED]
The name of the scaling policy.
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
[REQUIRED]
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
[REQUIRED]
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
dict
Response Syntax
{}
Response Structure
Examples
This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.
response = client.delete_scaling_policy(
PolicyName='web-app-cpu-lt-25',
ResourceId='service/default/web-app',
ScalableDimension='ecs:service:DesiredCount',
ServiceNamespace='ecs',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified Application Auto Scaling scheduled action.
See also: AWS API Documentation
Request Syntax
response = client.delete_scheduled_action(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
ScheduledActionName='string',
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'
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
[REQUIRED]
The name of the scheduled action.
[REQUIRED]
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
dict
Response Syntax
{}
Response Structure
Deregisters a scalable target.
Deregistering a scalable target deletes the scaling policies that are associated with it.
To create a scalable target or update an existing one, see RegisterScalableTarget .
See also: AWS API Documentation
Request Syntax
response = client.deregister_scalable_target(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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'
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
[REQUIRED]
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
[REQUIRED]
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
dict
Response Syntax
{}
Response Structure
Examples
This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.
response = client.deregister_scalable_target(
ResourceId='service/default/web-app',
ScalableDimension='ecs:service:DesiredCount',
ServiceNamespace='ecs',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Gets information about the scalable targets in the specified namespace.
You can filter the results using the ResourceIds and ScalableDimension parameters.
To create a scalable target or update an existing one, see RegisterScalableTarget . If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget .
See also: AWS API Documentation
Request Syntax
response = client.describe_scalable_targets(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
ResourceIds=[
'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',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
dict
Response Syntax
{
'ScalableTargets': [
{
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
'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',
'MinCapacity': 123,
'MaxCapacity': 123,
'RoleARN': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ScalableTargets (list) --
The scalable targets that match the request parameters.
(dict) --
Represents a scalable target.
ServiceNamespace (string) --
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
ResourceId (string) --
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
MinCapacity (integer) --
The minimum value to scale to in response to a scale in event.
MaxCapacity (integer) --
The maximum value to scale to in response to a scale out event.
RoleARN (string) --
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
CreationTime (datetime) --
The Unix timestamp for when the scalable target was created.
NextToken (string) --
The token required to get the next set of results. This value is null if there are no more results to return.
Examples
This example describes the scalable targets for the ecs service namespace.
response = client.describe_scalable_targets(
ServiceNamespace='ecs',
)
print(response)
Expected Output:
{
'ScalableTargets': [
{
'CreationTime': datetime(2016, 5, 6, 11, 21, 46, 4, 127, 0),
'MaxCapacity': 10,
'MinCapacity': 1,
'ResourceId': 'service/default/web-app',
'RoleARN': 'arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole',
'ScalableDimension': 'ecs:service:DesiredCount',
'ServiceNamespace': 'ecs',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using the ResourceId and ScalableDimension parameters.
Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies . To create a scaling policy or update an existing one, see PutScalingPolicy .
See also: AWS API Documentation
Request Syntax
response = client.describe_scaling_activities(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
dict
Response Syntax
{
'ScalingActivities': [
{
'ActivityId': 'string',
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
'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',
'Description': 'string',
'Cause': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'StatusCode': 'Pending'|'InProgress'|'Successful'|'Overridden'|'Unfulfilled'|'Failed',
'StatusMessage': 'string',
'Details': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ScalingActivities (list) --
A list of scaling activity objects.
(dict) --
Represents a scaling activity.
ActivityId (string) --
The unique identifier of the scaling activity.
ServiceNamespace (string) --
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
ResourceId (string) --
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
Description (string) --
A simple description of what action the scaling activity intends to accomplish.
Cause (string) --
A simple description of what caused the scaling activity to happen.
StartTime (datetime) --
The Unix timestamp for when the scaling activity began.
EndTime (datetime) --
The Unix timestamp for when the scaling activity ended.
StatusCode (string) --
Indicates the status of the scaling activity.
StatusMessage (string) --
A simple message about the current status of the scaling activity.
Details (string) --
The details about the scaling activity.
NextToken (string) --
The token required to get the next set of results. This value is null if there are no more results to return.
Examples
This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.
response = client.describe_scaling_activities(
ResourceId='service/default/web-app',
ScalableDimension='ecs:service:DesiredCount',
ServiceNamespace='ecs',
)
print(response)
Expected Output:
{
'ScalingActivities': [
{
'ActivityId': 'e6c5f7d1-dbbb-4a3f-89b2-51f33e766399',
'Cause': 'monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25',
'Description': 'Setting desired count to 1.',
'EndTime': datetime(2016, 5, 6, 16, 4, 32, 4, 127, 0),
'ResourceId': 'service/default/web-app',
'ScalableDimension': 'ecs:service:DesiredCount',
'ServiceNamespace': 'ecs',
'StartTime': datetime(2016, 5, 6, 16, 3, 58, 4, 127, 0),
'StatusCode': 'Successful',
'StatusMessage': 'Successfully set desired count to 1. Change successfully fulfilled by ecs.',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the scaling policies for the specified service namespace.
You can filter the results using the ResourceId , ScalableDimension , and PolicyNames parameters.
To create a scaling policy or update an existing one, see PutScalingPolicy . If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy .
See also: AWS API Documentation
Request Syntax
response = client.describe_scaling_policies(
PolicyNames=[
'string',
],
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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',
MaxResults=123,
NextToken='string'
)
The names of the scaling policies to describe.
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
dict
Response Syntax
{
'ScalingPolicies': [
{
'PolicyARN': 'string',
'PolicyName': 'string',
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
'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',
'PolicyType': 'StepScaling'|'TargetTrackingScaling',
'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',
'ResourceLabel': 'string'
},
'CustomizedMetricSpecification': {
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
'Unit': 'string'
},
'ScaleOutCooldown': 123,
'ScaleInCooldown': 123,
'DisableScaleIn': True|False
},
'Alarms': [
{
'AlarmName': 'string',
'AlarmARN': 'string'
},
],
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents a scaling policy.
PolicyARN (string) --
The Amazon Resource Name (ARN) of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
ServiceNamespace (string) --
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
PolicyType (string) --
The scaling policy type.
StepScalingPolicyConfiguration (dict) --
A step scaling policy.
AdjustmentType (string) --
The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
StepAdjustments (list) --
A set of adjustments that enable you to scale based on the size of the alarm breach.
(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:
There are a few rules for the step adjustments for your step policy:
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 is 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 is 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) --
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.
MinAdjustmentMagnitude (integer) --
The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity , the scaling policy changes the scalable dimension of the scalable target by this amount.
Cooldown (integer) --
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.
For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
MetricAggregationType (string) --
The aggregation type for the CloudWatch metrics. Valid values are Minimum , Maximum , and Average .
TargetTrackingScalingPolicyConfiguration (dict) --
A target tracking policy.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
PredefinedMetricSpecification (dict) --
A predefined metric.
PredefinedMetricType (string) --
The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests 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 ALBRequestCountPerTarget and there is a target group attached to the Spot fleet request or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
CustomizedMetricSpecification (dict) --
A customized metric.
MetricName (string) --
The name of the metric.
Namespace (string) --
The namespace of the metric.
Dimensions (list) --
The dimensions of the metric.
(dict) --
Describes the dimension of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value of the dimension.
Statistic (string) --
The statistic of the metric.
Unit (string) --
The unit of the metric.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true , scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false .
Alarms (list) --
The CloudWatch alarms associated with the 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.
CreationTime (datetime) --
The Unix timestamp for when the scaling policy was created.
NextToken (string) --
The token required to get the next set of results. This value is null if there are no more results to return.
Examples
This example describes the scaling policies for the ecs service namespace.
response = client.describe_scaling_policies(
ServiceNamespace='ecs',
)
print(response)
Expected Output:
{
'NextToken': '',
'ScalingPolicies': [
{
'Alarms': [
{
'AlarmARN': 'arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75',
'AlarmName': 'web-app-cpu-gt-75',
},
],
'CreationTime': datetime(2016, 5, 6, 12, 11, 39, 4, 127, 0),
'PolicyARN': 'arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75',
'PolicyName': 'web-app-cpu-gt-75',
'PolicyType': 'StepScaling',
'ResourceId': 'service/default/web-app',
'ScalableDimension': 'ecs:service:DesiredCount',
'ServiceNamespace': 'ecs',
'StepScalingPolicyConfiguration': {
'AdjustmentType': 'PercentChangeInCapacity',
'Cooldown': 60,
'StepAdjustments': [
{
'MetricIntervalLowerBound': 0,
'ScalingAdjustment': 200,
},
],
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
Describes the scheduled actions for the specified service namespace.
You can filter the results using the ResourceId , ScalableDimension , and ScheduledActionNames parameters.
To create a scheduled action or update an existing one, see PutScheduledAction . If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction .
See also: AWS API Documentation
Request Syntax
response = client.describe_scheduled_actions(
ScheduledActionNames=[
'string',
],
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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',
MaxResults=123,
NextToken='string'
)
The names of the scheduled actions to describe.
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50.
If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
dict
Response Syntax
{
'ScheduledActions': [
{
'ScheduledActionName': 'string',
'ScheduledActionARN': 'string',
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
'Schedule': 'string',
'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',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ScalableTargetAction': {
'MinCapacity': 123,
'MaxCapacity': 123
},
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ScheduledActions (list) --
Information about the scheduled actions.
(dict) --
Represents a scheduled action.
ScheduledActionName (string) --
The name of the scheduled action.
ScheduledActionARN (string) --
The Amazon Resource Name (ARN) of the scheduled action.
ServiceNamespace (string) --
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
Schedule (string) --
The schedule for this action. The following formats are supported:
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days .
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide .
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
StartTime (datetime) --
The date and time that the action is scheduled to begin.
EndTime (datetime) --
The date and time that the action is scheduled to end.
ScalableTargetAction (dict) --
The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
MinCapacity (integer) --
The minimum capacity.
MaxCapacity (integer) --
The maximum capacity.
CreationTime (datetime) --
The date and time that the scheduled action was created.
NextToken (string) --
The token required to get the next set of results. This value is null if there are no more results to return.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Creates or updates a 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 register the scalable target using RegisterScalableTarget .
To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.
You can view the scaling policies for a service namespace using DescribeScalingPolicies . If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy .
See also: AWS API Documentation
Request Syntax
response = client.put_scaling_policy(
PolicyName='string',
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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',
PolicyType='StepScaling'|'TargetTrackingScaling',
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',
'ResourceLabel': 'string'
},
'CustomizedMetricSpecification': {
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
'Unit': 'string'
},
'ScaleOutCooldown': 123,
'ScaleInCooldown': 123,
'DisableScaleIn': True|False
}
)
[REQUIRED]
The name of the scaling policy.
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
[REQUIRED]
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
[REQUIRED]
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
The policy type. This parameter is required if you are creating a policy.
For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported.
A step scaling policy.
This parameter is required if you are creating a policy and the policy type is StepScaling .
The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
A set of adjustments that enable you to scale based on the size of the alarm breach.
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:
There are a few rules for the step adjustments for your step policy:
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 is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
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 is 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.
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.
The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity , the scaling policy changes the scalable dimension of the scalable target by this amount.
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.
For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
The aggregation type for the CloudWatch metrics. Valid values are Minimum , Maximum , and Average .
A target tracking policy.
This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling .
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
A predefined metric.
The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.
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 attached to the Spot fleet request or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
A customized metric.
The name of the metric.
The namespace of the metric.
The dimensions of the metric.
Describes the dimension of a metric.
The name of the dimension.
The value of the dimension.
The statistic of the metric.
The unit of the metric.
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
Indicates whether scale in by the target tracking policy is disabled. If the value is true , scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false .
dict
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 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.
Examples
This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds.
response = client.put_scaling_policy(
PolicyName='web-app-cpu-gt-75',
PolicyType='StepScaling',
ResourceId='service/default/web-app',
ScalableDimension='ecs:service:DesiredCount',
ServiceNamespace='ecs',
StepScalingPolicyConfiguration={
'AdjustmentType': 'PercentChangeInCapacity',
'Cooldown': 60,
'StepAdjustments': [
{
'MetricIntervalLowerBound': 0,
'ScalingAdjustment': 200,
},
],
},
)
print(response)
Expected Output:
{
'PolicyARN': 'arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75',
'ResponseMetadata': {
'...': '...',
},
}
This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.",
response = client.put_scaling_policy(
PolicyName='fleet-cpu-gt-75',
PolicyType='StepScaling',
ResourceId='spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3',
ScalableDimension='ec2:spot-fleet-request:TargetCapacity',
ServiceNamespace='ec2',
StepScalingPolicyConfiguration={
'AdjustmentType': 'PercentChangeInCapacity',
'Cooldown': 180,
'StepAdjustments': [
{
'MetricIntervalLowerBound': 0,
'ScalingAdjustment': 200,
},
],
},
)
print(response)
Expected Output:
{
'PolicyARN': 'arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75',
'ResponseMetadata': {
'...': '...',
},
}
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you register the scalable target using RegisterScalableTarget .
To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.
You can view the scheduled actions using DescribeScheduledActions . If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction .
See also: AWS API Documentation
Request Syntax
response = client.put_scheduled_action(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
Schedule='string',
ScheduledActionName='string',
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',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
ScalableTargetAction={
'MinCapacity': 123,
'MaxCapacity': 123
}
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The schedule for this action. The following formats are supported:
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days .
For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide .
[REQUIRED]
The name of the scheduled action.
[REQUIRED]
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
The scalable dimension. This parameter is required if you are creating a scheduled action. This string consists of the service namespace, resource type, and scaling property.
The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
The minimum capacity.
The maximum capacity.
dict
Response Syntax
{}
Response Structure
Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for its scalable dimension.
After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy . You can view the scaling policies for a service namespace using DescribeScalableTargets . If you no longer need a scalable target, you can deregister it using DeregisterScalableTarget .
See also: AWS API Documentation
Request Syntax
response = client.register_scalable_target(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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',
MinCapacity=123,
MaxCapacity=123,
RoleARN='string'
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
[REQUIRED]
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
[REQUIRED]
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling .
For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
dict
Response Syntax
{}
Response Structure
Examples
This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.
response = client.register_scalable_target(
MaxCapacity=10,
MinCapacity=1,
ResourceId='service/default/web-app',
RoleARN='arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole',
ScalableDimension='ecs:service:DesiredCount',
ServiceNamespace='ecs',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10.
response = client.register_scalable_target(
MaxCapacity=10,
MinCapacity=1,
ResourceId='spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3',
RoleARN='arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole',
ScalableDimension='ec2:spot-fleet-request:TargetCapacity',
ServiceNamespace='ec2',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
paginator = client.get_paginator('describe_scalable_targets')
Creates an iterator that will paginate through responses from ApplicationAutoScaling.Client.describe_scalable_targets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
ResourceIds=[
'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',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ScalableTargets': [
{
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
'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',
'MinCapacity': 123,
'MaxCapacity': 123,
'RoleARN': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
ScalableTargets (list) --
The scalable targets that match the request parameters.
(dict) --
Represents a scalable target.
ServiceNamespace (string) --
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
ResourceId (string) --
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
MinCapacity (integer) --
The minimum value to scale to in response to a scale in event.
MaxCapacity (integer) --
The maximum value to scale to in response to a scale out event.
RoleARN (string) --
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
CreationTime (datetime) --
The Unix timestamp for when the scalable target was created.
paginator = client.get_paginator('describe_scaling_activities')
Creates an iterator that will paginate through responses from ApplicationAutoScaling.Client.describe_scaling_activities().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ScalingActivities': [
{
'ActivityId': 'string',
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
'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',
'Description': 'string',
'Cause': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'StatusCode': 'Pending'|'InProgress'|'Successful'|'Overridden'|'Unfulfilled'|'Failed',
'StatusMessage': 'string',
'Details': 'string'
},
],
}
Response Structure
(dict) --
ScalingActivities (list) --
A list of scaling activity objects.
(dict) --
Represents a scaling activity.
ActivityId (string) --
The unique identifier of the scaling activity.
ServiceNamespace (string) --
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
ResourceId (string) --
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
Description (string) --
A simple description of what action the scaling activity intends to accomplish.
Cause (string) --
A simple description of what caused the scaling activity to happen.
StartTime (datetime) --
The Unix timestamp for when the scaling activity began.
EndTime (datetime) --
The Unix timestamp for when the scaling activity ended.
StatusCode (string) --
Indicates the status of the scaling activity.
StatusMessage (string) --
A simple message about the current status of the scaling activity.
Details (string) --
The details about the scaling activity.
paginator = client.get_paginator('describe_scaling_policies')
Creates an iterator that will paginate through responses from ApplicationAutoScaling.Client.describe_scaling_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PolicyNames=[
'string',
],
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
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',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the scaling policies to describe.
[REQUIRED]
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ScalingPolicies': [
{
'PolicyARN': 'string',
'PolicyName': 'string',
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource',
'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',
'PolicyType': 'StepScaling'|'TargetTrackingScaling',
'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',
'ResourceLabel': 'string'
},
'CustomizedMetricSpecification': {
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
'Unit': 'string'
},
'ScaleOutCooldown': 123,
'ScaleInCooldown': 123,
'DisableScaleIn': True|False
},
'Alarms': [
{
'AlarmName': 'string',
'AlarmARN': 'string'
},
],
'CreationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents a scaling policy.
PolicyARN (string) --
The Amazon Resource Name (ARN) of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
ServiceNamespace (string) --
The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference .
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
PolicyType (string) --
The scaling policy type.
StepScalingPolicyConfiguration (dict) --
A step scaling policy.
AdjustmentType (string) --
The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.
StepAdjustments (list) --
A set of adjustments that enable you to scale based on the size of the alarm breach.
(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:
There are a few rules for the step adjustments for your step policy:
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 is 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 is 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) --
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.
MinAdjustmentMagnitude (integer) --
The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity , the scaling policy changes the scalable dimension of the scalable target by this amount.
Cooldown (integer) --
The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.
For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.
For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
MetricAggregationType (string) --
The aggregation type for the CloudWatch metrics. Valid values are Minimum , Maximum , and Average .
TargetTrackingScalingPolicyConfiguration (dict) --
A target tracking policy.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
PredefinedMetricSpecification (dict) --
A predefined metric.
PredefinedMetricType (string) --
The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests 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 ALBRequestCountPerTarget and there is a target group attached to the Spot fleet request or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
CustomizedMetricSpecification (dict) --
A customized metric.
MetricName (string) --
The name of the metric.
Namespace (string) --
The namespace of the metric.
Dimensions (list) --
The dimensions of the metric.
(dict) --
Describes the dimension of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value of the dimension.
Statistic (string) --
The statistic of the metric.
Unit (string) --
The unit of the metric.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true , scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false .
Alarms (list) --
The CloudWatch alarms associated with the 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.
CreationTime (datetime) --
The Unix timestamp for when the scaling policy was created.