Table of Contents
A low-level client representing AWS Auto Scaling Plans:
import boto3
client = boto3.client('autoscaling-plans')
These are the available methods:
Check if an operation can be paginated.
Creates a scaling plan.
A scaling plan contains a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions in your scaling plan.
See also: AWS API Documentation
Request Syntax
response = client.create_scaling_plan(
ScalingPlanName='string',
ApplicationSource={
'CloudFormationStackARN': 'string',
'TagFilters': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
ScalingInstructions=[
{
'ServiceNamespace': 'autoscaling'|'ecs'|'ec2'|'rds'|'dynamodb',
'ResourceId': 'string',
'ScalableDimension': 'autoscaling:autoScalingGroup:DesiredCapacity'|'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'rds:cluster:ReadReplicaCount'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits',
'MinCapacity': 123,
'MaxCapacity': 123,
'TargetTrackingConfigurations': [
{
'PredefinedScalingMetricSpecification': {
'PredefinedScalingMetricType': 'ASGAverageCPUUtilization'|'ASGAverageNetworkIn'|'ASGAverageNetworkOut'|'DynamoDBReadCapacityUtilization'|'DynamoDBWriteCapacityUtilization'|'ECSServiceAverageCPUUtilization'|'ECSServiceAverageMemoryUtilization'|'ALBRequestCountPerTarget'|'RDSReaderAverageCPUUtilization'|'RDSReaderAverageDatabaseConnections'|'EC2SpotFleetRequestAverageCPUUtilization'|'EC2SpotFleetRequestAverageNetworkIn'|'EC2SpotFleetRequestAverageNetworkOut',
'ResourceLabel': 'string'
},
'CustomizedScalingMetricSpecification': {
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
'Unit': 'string'
},
'TargetValue': 123.0,
'DisableScaleIn': True|False,
'ScaleOutCooldown': 123,
'ScaleInCooldown': 123,
'EstimatedInstanceWarmup': 123
},
]
},
]
)
[REQUIRED]
The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
[REQUIRED]
A CloudFormation stack or set of tags. You can create one scaling plan per application source.
The Amazon Resource Name (ARN) of a CloudFormation stack.
A set of tags (up to 50).
Represents a tag.
The tag key.
The tag values (0 to 20).
[REQUIRED]
The scaling instructions.
Specifies the scaling configuration for a scalable resource.
The namespace of the AWS service.
The ID of the resource. This string consists of the resource type and unique identifier.
The scalable dimension associated with the resource.
The minimum value to scale to in response to a scale in event.
The maximum value to scale to in response to a scale out event.
The target tracking scaling policies (up to 10).
Represents a target tracking scaling policy.
A predefined metric.
The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Sport 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 for an Application Load Balancer attached to the Auto Scaling group, 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.
Represents a dimension for a customized metric.
The name of the dimension.
The value of the dimension.
The statistic of the metric.
The unit of the metric.
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).
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 .
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
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. This value is not used if the scalable resource is an Auto Scaling group.
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, AWS Auto Scaling scales out your scalable target immediately.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
dict
Response Syntax
{
'ScalingPlanVersion': 123
}
Response Structure
(dict) --
ScalingPlanVersion (integer) --
The version of the scaling plan. This value is always 1.
Deletes the specified scaling plan.
See also: AWS API Documentation
Request Syntax
response = client.delete_scaling_plan(
ScalingPlanName='string',
ScalingPlanVersion=123
)
[REQUIRED]
The name of the scaling plan.
[REQUIRED]
The version of the scaling plan.
dict
Response Syntax
{}
Response Structure
Describes the scalable resources in the specified scaling plan.
See also: AWS API Documentation
Request Syntax
response = client.describe_scaling_plan_resources(
ScalingPlanName='string',
ScalingPlanVersion=123,
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the scaling plan.
[REQUIRED]
The version of the scaling plan.
dict
Response Syntax
{
'ScalingPlanResources': [
{
'ScalingPlanName': 'string',
'ScalingPlanVersion': 123,
'ServiceNamespace': 'autoscaling'|'ecs'|'ec2'|'rds'|'dynamodb',
'ResourceId': 'string',
'ScalableDimension': 'autoscaling:autoScalingGroup:DesiredCapacity'|'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'rds:cluster:ReadReplicaCount'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits',
'ScalingPolicies': [
{
'PolicyName': 'string',
'PolicyType': 'TargetTrackingScaling',
'TargetTrackingConfiguration': {
'PredefinedScalingMetricSpecification': {
'PredefinedScalingMetricType': 'ASGAverageCPUUtilization'|'ASGAverageNetworkIn'|'ASGAverageNetworkOut'|'DynamoDBReadCapacityUtilization'|'DynamoDBWriteCapacityUtilization'|'ECSServiceAverageCPUUtilization'|'ECSServiceAverageMemoryUtilization'|'ALBRequestCountPerTarget'|'RDSReaderAverageCPUUtilization'|'RDSReaderAverageDatabaseConnections'|'EC2SpotFleetRequestAverageCPUUtilization'|'EC2SpotFleetRequestAverageNetworkIn'|'EC2SpotFleetRequestAverageNetworkOut',
'ResourceLabel': 'string'
},
'CustomizedScalingMetricSpecification': {
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
'Unit': 'string'
},
'TargetValue': 123.0,
'DisableScaleIn': True|False,
'ScaleOutCooldown': 123,
'ScaleInCooldown': 123,
'EstimatedInstanceWarmup': 123
}
},
],
'ScalingStatusCode': 'Inactive'|'PartiallyActive'|'Active',
'ScalingStatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ScalingPlanResources (list) --
Information about the scalable resources.
(dict) --
Represents a scalable resource.
ScalingPlanName (string) --
The name of the scaling plan.
ScalingPlanVersion (integer) --
The version of the scaling plan.
ServiceNamespace (string) --
The namespace of the AWS service.
ResourceId (string) --
The ID of the resource. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension for the resource.
ScalingPolicies (list) --
The scaling policies.
(dict) --
Represents a scaling policy.
PolicyName (string) --
The name of the scaling policy.
PolicyType (string) --
The type of scaling policy.
TargetTrackingConfiguration (dict) --
The target tracking scaling policy.
PredefinedScalingMetricSpecification (dict) --
A predefined metric.
PredefinedScalingMetricType (string) --
The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Sport 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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
CustomizedScalingMetricSpecification (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) --
Represents a dimension for a customized 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.
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).
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 .
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
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. This value is not used if the scalable resource is an Auto Scaling group.
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, AWS Auto Scaling scales out your scalable target immediately.
EstimatedInstanceWarmup (integer) --
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
ScalingStatusCode (string) --
The scaling status of the resource.
ScalingStatusMessage (string) --
A simple message about the current scaling status of the resource.
NextToken (string) --
The token required to get the next set of results. This value is null if there are no more results to return.
Describes the specified scaling plans or all of your scaling plans.
See also: AWS API Documentation
Request Syntax
response = client.describe_scaling_plans(
ScalingPlanNames=[
'string',
],
ScalingPlanVersion=123,
ApplicationSources=[
{
'CloudFormationStackARN': 'string',
'TagFilters': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
],
MaxResults=123,
NextToken='string'
)
The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
Represents an application source.
The Amazon Resource Name (ARN) of a CloudFormation stack.
A set of tags (up to 50).
Represents a tag.
The tag key.
The tag values (0 to 20).
dict
Response Syntax
{
'ScalingPlans': [
{
'ScalingPlanName': 'string',
'ScalingPlanVersion': 123,
'ApplicationSource': {
'CloudFormationStackARN': 'string',
'TagFilters': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
'ScalingInstructions': [
{
'ServiceNamespace': 'autoscaling'|'ecs'|'ec2'|'rds'|'dynamodb',
'ResourceId': 'string',
'ScalableDimension': 'autoscaling:autoScalingGroup:DesiredCapacity'|'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'rds:cluster:ReadReplicaCount'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits',
'MinCapacity': 123,
'MaxCapacity': 123,
'TargetTrackingConfigurations': [
{
'PredefinedScalingMetricSpecification': {
'PredefinedScalingMetricType': 'ASGAverageCPUUtilization'|'ASGAverageNetworkIn'|'ASGAverageNetworkOut'|'DynamoDBReadCapacityUtilization'|'DynamoDBWriteCapacityUtilization'|'ECSServiceAverageCPUUtilization'|'ECSServiceAverageMemoryUtilization'|'ALBRequestCountPerTarget'|'RDSReaderAverageCPUUtilization'|'RDSReaderAverageDatabaseConnections'|'EC2SpotFleetRequestAverageCPUUtilization'|'EC2SpotFleetRequestAverageNetworkIn'|'EC2SpotFleetRequestAverageNetworkOut',
'ResourceLabel': 'string'
},
'CustomizedScalingMetricSpecification': {
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
'Unit': 'string'
},
'TargetValue': 123.0,
'DisableScaleIn': True|False,
'ScaleOutCooldown': 123,
'ScaleInCooldown': 123,
'EstimatedInstanceWarmup': 123
},
]
},
],
'StatusCode': 'Active'|'ActiveWithProblems'|'CreationInProgress'|'CreationFailed'|'DeletionInProgress'|'DeletionFailed'|'UpdateInProgress'|'UpdateFailed',
'StatusMessage': 'string',
'StatusStartTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ScalingPlans (list) --
Information about the scaling plans.
(dict) --
Represents a scaling plan.
ScalingPlanName (string) --
The name of the scaling plan.
ScalingPlanVersion (integer) --
The version of the scaling plan.
ApplicationSource (dict) --
The application source.
CloudFormationStackARN (string) --
The Amazon Resource Name (ARN) of a CloudFormation stack.
TagFilters (list) --
A set of tags (up to 50).
(dict) --
Represents a tag.
Key (string) --
The tag key.
Values (list) --
The tag values (0 to 20).
ScalingInstructions (list) --
The scaling instructions.
(dict) --
Specifies the scaling configuration for a scalable resource.
ServiceNamespace (string) --
The namespace of the AWS service.
ResourceId (string) --
The ID of the resource. This string consists of the resource type and unique identifier.
ScalableDimension (string) --
The scalable dimension associated with the resource.
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.
TargetTrackingConfigurations (list) --
The target tracking scaling policies (up to 10).
(dict) --
Represents a target tracking scaling policy.
PredefinedScalingMetricSpecification (dict) --
A predefined metric.
PredefinedScalingMetricType (string) --
The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Sport 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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:
CustomizedScalingMetricSpecification (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) --
Represents a dimension for a customized 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.
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).
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 .
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
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. This value is not used if the scalable resource is an Auto Scaling group.
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, AWS Auto Scaling scales out your scalable target immediately.
EstimatedInstanceWarmup (integer) --
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
StatusCode (string) --
The status of the scaling plan.
StatusMessage (string) --
A simple message about the current status of the scaling plan.
StatusStartTime (datetime) --
The Unix timestamp when the scaling plan entered the current status.
CreationTime (datetime) --
The Unix timestamp when the scaling plan 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.
Updates the scaling plan for the specified scaling plan.
You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
See also: AWS API Documentation
Request Syntax
response = client.update_scaling_plan(
ApplicationSource={
'CloudFormationStackARN': 'string',
'TagFilters': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
ScalingPlanName='string',
ScalingInstructions=[
{
'ServiceNamespace': 'autoscaling'|'ecs'|'ec2'|'rds'|'dynamodb',
'ResourceId': 'string',
'ScalableDimension': 'autoscaling:autoScalingGroup:DesiredCapacity'|'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'rds:cluster:ReadReplicaCount'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits',
'MinCapacity': 123,
'MaxCapacity': 123,
'TargetTrackingConfigurations': [
{
'PredefinedScalingMetricSpecification': {
'PredefinedScalingMetricType': 'ASGAverageCPUUtilization'|'ASGAverageNetworkIn'|'ASGAverageNetworkOut'|'DynamoDBReadCapacityUtilization'|'DynamoDBWriteCapacityUtilization'|'ECSServiceAverageCPUUtilization'|'ECSServiceAverageMemoryUtilization'|'ALBRequestCountPerTarget'|'RDSReaderAverageCPUUtilization'|'RDSReaderAverageDatabaseConnections'|'EC2SpotFleetRequestAverageCPUUtilization'|'EC2SpotFleetRequestAverageNetworkIn'|'EC2SpotFleetRequestAverageNetworkOut',
'ResourceLabel': 'string'
},
'CustomizedScalingMetricSpecification': {
'MetricName': 'string',
'Namespace': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
'Unit': 'string'
},
'TargetValue': 123.0,
'DisableScaleIn': True|False,
'ScaleOutCooldown': 123,
'ScaleInCooldown': 123,
'EstimatedInstanceWarmup': 123
},
]
},
],
ScalingPlanVersion=123
)
A CloudFormation stack or set of tags.
The Amazon Resource Name (ARN) of a CloudFormation stack.
A set of tags (up to 50).
Represents a tag.
The tag key.
The tag values (0 to 20).
[REQUIRED]
The name of the scaling plan.
The scaling instructions.
Specifies the scaling configuration for a scalable resource.
The namespace of the AWS service.
The ID of the resource. This string consists of the resource type and unique identifier.
The scalable dimension associated with the resource.
The minimum value to scale to in response to a scale in event.
The maximum value to scale to in response to a scale out event.
The target tracking scaling policies (up to 10).
Represents a target tracking scaling policy.
A predefined metric.
The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Sport 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 for an Application Load Balancer attached to the Auto Scaling group, 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.
Represents a dimension for a customized metric.
The name of the dimension.
The value of the dimension.
The statistic of the metric.
The unit of the metric.
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).
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 .
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
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. This value is not used if the scalable resource is an Auto Scaling group.
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, AWS Auto Scaling scales out your scalable target immediately.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
[REQUIRED]
The version number.
dict
Response Syntax
{}
Response Structure
The available paginators are: