Table of Contents
ApplicationAutoScaling.Client¶A low-level client representing Application Auto Scaling
With Application Auto Scaling, you can configure automatic scaling for the following resources:
API Summary
The Application Auto Scaling service API includes three key sets of actions:
To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.
import boto3
client = boto3.client('application-autoscaling')
These are the available methods:
can_paginate()close()delete_scaling_policy()delete_scheduled_action()deregister_scalable_target()describe_scalable_targets()describe_scaling_activities()describe_scaling_policies()describe_scheduled_actions()get_paginator()get_waiter()put_scaling_policy()put_scheduled_action()register_scalable_target()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
delete_scaling_policy(**kwargs)¶Deletes the specified scaling policy for an Application Auto Scaling scalable target.
Deleting a step scaling 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.
For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_scaling_policy(
PolicyName='string',
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount'
)
[REQUIRED]
The name of the scaling policy.
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
[REQUIRED]
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .[REQUIRED]
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.ObjectNotFoundExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionExamples
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': {
'...': '...',
},
}
delete_scheduled_action(**kwargs)¶Deletes the specified scheduled action for an Application Auto Scaling scalable target.
For more information, see Delete a scheduled action in the Application Auto Scaling User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_scheduled_action(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
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'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount'
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
[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.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .[REQUIRED]
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.ObjectNotFoundExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionderegister_scalable_target(**kwargs)¶Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Note
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
See also: AWS API Documentation
Request Syntax
response = client.deregister_scalable_target(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount'
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
[REQUIRED]
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .[REQUIRED]
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.ObjectNotFoundExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionExamples
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': {
'...': '...',
},
}
describe_scalable_targets(**kwargs)¶Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension .
See also: AWS API Documentation
Request Syntax
response = client.describe_scalable_targets(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
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'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'ResourceId': 'string',
'ScalableDimension': 'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'MinCapacity': 123,
'MaxCapacity': 123,
'RoleARN': 'string',
'CreationTime': datetime(2015, 1, 1),
'SuspendedState': {
'DynamicScalingInSuspended': True|False,
'DynamicScalingOutSuspended': True|False,
'ScheduledScalingSuspended': True|False
}
},
],
'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 Amazon Web Services service that provides the resource, or a custom-resource .
ResourceId (string) --
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.MinCapacity (integer) --
The minimum value to scale to in response to a scale-in activity.
MaxCapacity (integer) --
The maximum value to scale to in response to a scale-out activity.
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.
SuspendedState (dict) --
Specifies whether the scaling activities for a scalable target are in a suspended state.
DynamicScalingInSuspended (boolean) --
Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false .
DynamicScalingOutSuspended (boolean) --
Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false .
ScheduledScalingSuspended (boolean) --
Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false .
NextToken (string) --
The token required to get the next set of results. This value is null if there are no more results to return.
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.InvalidNextTokenExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionExamples
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(2019, 5, 6, 11, 21, 46, 0, 126, 0),
'MaxCapacity': 10,
'MinCapacity': 1,
'ResourceId': 'service/default/web-app',
'RoleARN': 'arn:aws:iam::012345678910:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService',
'ScalableDimension': 'ecs:service:DesiredCount',
'ServiceNamespace': 'ecs',
'SuspendedState': {
'DynamicScalingInSuspended': False,
'DynamicScalingOutSuspended': False,
'ScheduledScalingSuspended': False,
},
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_scaling_activities(**kwargs)¶Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension .
See also: AWS API Documentation
Request Syntax
response = client.describe_scaling_activities(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'ResourceId': 'string',
'ScalableDimension': 'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'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 Amazon Web Services service that provides the resource, or a custom-resource .
ResourceId (string) --
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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.
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.InvalidNextTokenExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionExamples
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(2019, 5, 6, 16, 4, 32, 0, 126, 0),
'ResourceId': 'service/default/web-app',
'ScalableDimension': 'ecs:service:DesiredCount',
'ServiceNamespace': 'ecs',
'StartTime': datetime(2019, 5, 6, 16, 3, 58, 0, 126, 0),
'StatusCode': 'Successful',
'StatusMessage': 'Successfully set desired count to 1. Change successfully fulfilled by ecs.',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_scaling_policies(**kwargs)¶Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId , ScalableDimension , and PolicyNames .
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_scaling_policies(
PolicyNames=[
'string',
],
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
MaxResults=123,
NextToken='string'
)
The names of the scaling policies to describe.
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.The maximum number of scalable targets. This value can be between 1 and 10. The default value is 10.
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 10 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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'ResourceId': 'string',
'ScalableDimension': 'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'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'|'AppStreamAverageCapacityUtilization'|'ComprehendInferenceUtilization'|'LambdaProvisionedConcurrencyUtilization'|'CassandraReadCapacityUtilization'|'CassandraWriteCapacityUtilization'|'KafkaBrokerStorageUtilization'|'ElastiCachePrimaryEngineCPUUtilization'|'ElastiCacheReplicaEngineCPUUtilization'|'ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage'|'NeptuneReaderAverageCPUUtilization',
'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 to use with Application Auto Scaling.
For more information about configuring scaling policies for a specific service, see Getting started with Application Auto Scaling in the Application Auto Scaling User Guide .
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 Amazon Web Services service that provides the resource, or a custom-resource .
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.PolicyType (string) --
The scaling policy type.
StepScalingPolicyConfiguration (dict) --
A step scaling policy.
AdjustmentType (string) --
Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .
AdjustmentTypeis required if you are adding a new step scaling policy configuration.
StepAdjustments (list) --
A set of adjustments that enable you to scale based on the size of the alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
(dict) --
Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
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 capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.
MinAdjustmentMagnitude (integer) --
The minimum value to scale by when the adjustment type is PercentChangeInCapacity . For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
Cooldown (integer) --
The amount of time, in seconds, to wait for a previous scaling activity to take effect.
With scale-out policies, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity. For example, when an alarm triggers a step scaling policy to increase the capacity by 2, the scaling activity completes successfully, and a cooldown period starts. If the alarm triggers again during the cooldown period but at a more aggressive step adjustment of 3, the previous increase of 2 is considered part of the current capacity. Therefore, only 1 is added to the capacity.
With scale-in policies, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the cooldown period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the cooldown period for the scale-in activity stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
MetricAggregationType (string) --
The aggregation type for the CloudWatch metrics. Valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .
TargetTrackingScalingPolicyConfiguration (dict) --
A target tracking scaling policy.
TargetValue (float) --
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
PredefinedMetricSpecification (dict) --
A predefined metric. You can specify either a predefined metric or a customized 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.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
CustomizedMetricSpecification (dict) --
A customized metric. You can specify either a predefined metric or a customized metric.
MetricName (string) --
The name of the metric.
Namespace (string) --
The namespace of the metric.
Dimensions (list) --
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
(dict) --
Describes the dimension names and values associated with a metric.
Name (string) --
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, to wait for a previous scale-out activity to take effect.
With the scale-out cooldown period , the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
With the scale-in cooldown period , the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true , scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value 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.
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.FailedResourceAccessExceptionApplicationAutoScaling.Client.exceptions.InvalidNextTokenExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionExamples
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(2019, 5, 6, 12, 11, 39, 0, 126, 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': {
'...': '...',
},
}
describe_scheduled_actions(**kwargs)¶Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId , ScalableDimension , and ScheduledActionNames parameters.
For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_scheduled_actions(
ScheduledActionNames=[
'string',
],
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
MaxResults=123,
NextToken='string'
)
The names of the scheduled actions to describe.
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'Schedule': 'string',
'Timezone': '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'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'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 Amazon Web Services service that provides the resource, or a custom-resource .
Schedule (string) --
The schedule for this action. The following formats are supported:
at(yyyy-mm-ddThh:mm:ss) "rate(valueunit) "cron(fields) "At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days .
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide .
Timezone (string) --
The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.StartTime (datetime) --
The date and time that the action is scheduled to begin, in UTC.
EndTime (datetime) --
The date and time that the action is scheduled to end, in UTC.
ScalableTargetAction (dict) --
The new minimum and maximum capacity. You can set both values or just one. At 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.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
MaxCapacity (integer) --
The maximum capacity.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference .
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.
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.InvalidNextTokenExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
put_scaling_policy(**kwargs)¶Creates or updates a scaling policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide .
Note
If a scalable target is deregistered, the scalable target is no longer available to execute scaling policies. Any scaling policies that were specified for the scalable target are deleted.
See also: AWS API Documentation
Request Syntax
response = client.put_scaling_policy(
PolicyName='string',
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
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'|'AppStreamAverageCapacityUtilization'|'ComprehendInferenceUtilization'|'LambdaProvisionedConcurrencyUtilization'|'CassandraReadCapacityUtilization'|'CassandraWriteCapacityUtilization'|'KafkaBrokerStorageUtilization'|'ElastiCachePrimaryEngineCPUUtilization'|'ElastiCacheReplicaEngineCPUUtilization'|'ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage'|'NeptuneReaderAverageCPUUtilization',
'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 Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
[REQUIRED]
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .[REQUIRED]
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.The policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide .
A step scaling policy.
This parameter is required if you are creating a policy and the policy type is StepScaling .
Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .
AdjustmentTypeis required if you are adding a new step scaling policy configuration.
A set of adjustments that enable you to scale based on the size of the alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
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 capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.
The minimum value to scale by when the adjustment type is PercentChangeInCapacity . For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
The amount of time, in seconds, to wait for a previous scaling activity to take effect.
With scale-out policies, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity. For example, when an alarm triggers a step scaling policy to increase the capacity by 2, the scaling activity completes successfully, and a cooldown period starts. If the alarm triggers again during the cooldown period but at a more aggressive step adjustment of 3, the previous increase of 2 is considered part of the current capacity. Therefore, only 1 is added to the capacity.
With scale-in policies, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the cooldown period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the cooldown period for the scale-in activity stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
The aggregation type for the CloudWatch metrics. Valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .
A target tracking scaling policy. Includes support for predefined or customized metrics.
This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling .
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
A predefined metric. You can specify either a predefined metric or a customized 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.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
A customized metric. You can specify either a predefined metric or a customized metric.
The name of the metric.
The namespace of the metric.
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
Describes the dimension names and values associated with 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, to wait for a previous scale-out activity to take effect.
With the scale-out cooldown period , the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
With the scale-in cooldown period , the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true , scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value 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 scaling policy.
(dict) --
Represents a CloudWatch alarm associated with a scaling policy.
AlarmName (string) --
The name of the alarm.
AlarmARN (string) --
The Amazon Resource Name (ARN) of the alarm.
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.LimitExceededExceptionApplicationAutoScaling.Client.exceptions.ObjectNotFoundExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.FailedResourceAccessExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionExamples
The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.
response = client.put_scaling_policy(
PolicyName='cpu75-target-tracking-scaling-policy',
PolicyType='TargetTrackingScaling',
ResourceId='service/default/web-app',
ScalableDimension='ecs:service:DesiredCount',
ServiceNamespace='ecs',
TargetTrackingScalingPolicyConfiguration={
'PredefinedMetricSpecification': {
'PredefinedMetricType': 'ECSServiceAverageCPUUtilization',
},
'ScaleInCooldown': 60,
'ScaleOutCooldown': 60,
'TargetValue': 75,
},
)
print(response)
Expected Output:
{
'Alarms': [
{
'AlarmARN': 'arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca',
'AlarmName': 'TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca',
},
{
'AlarmARN': 'arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d',
'AlarmName': 'TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d',
},
],
'PolicyARN': 'arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy',
'ResponseMetadata': {
'...': '...',
},
}
put_scheduled_action(**kwargs)¶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 have registered the resource as a scalable target.
When start and end times are specified with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops.
To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.
For more information, see Scheduled scaling in the Application Auto Scaling User Guide .
Note
If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
See also: AWS API Documentation
Request Syntax
response = client.put_scheduled_action(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
Schedule='string',
Timezone='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'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
ScalableTargetAction={
'MinCapacity': 123,
'MaxCapacity': 123
}
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The schedule for this action. The following formats are supported:
at(yyyy-mm-ddThh:mm:ss) "rate(valueunit) "cron(fields) "At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days .
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide .
Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones supported by Joda-Time (such as Etc/GMT+9 or Pacific/Tahiti ). For more information, see https://www.joda.org/joda-time/timezones.html.
[REQUIRED]
The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
[REQUIRED]
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .[REQUIRED]
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.The new minimum and maximum capacity. You can set both values or just one. At 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.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
The maximum capacity.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference .
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.LimitExceededExceptionApplicationAutoScaling.Client.exceptions.ObjectNotFoundExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionregister_scalable_target(**kwargs)¶Registers or updates a scalable target.
A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.
When you register a new scalable target, you must specify values for minimum and maximum capacity. Current capacity will be adjusted within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of this range.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.
Note
If you call the RegisterScalableTarget API to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it is below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.
See also: AWS API Documentation
Request Syntax
response = client.register_scalable_target(
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
MinCapacity=123,
MaxCapacity=123,
RoleARN='string',
SuspendedState={
'DynamicScalingInSuspended': True|False,
'DynamicScalingOutSuspended': True|False,
'ScheduledScalingSuspended': True|False
}
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
[REQUIRED]
The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .[REQUIRED]
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference .
This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.
An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
Suspension Outcomes
DynamicScalingInSuspended , while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.DynamicScalingOutSuspended , while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.ScheduledScalingSuspended , while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide .
Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false .
Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false .
Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false .
dict
Response Syntax
{}
Response Structure
Exceptions
ApplicationAutoScaling.Client.exceptions.ValidationExceptionApplicationAutoScaling.Client.exceptions.LimitExceededExceptionApplicationAutoScaling.Client.exceptions.ConcurrentUpdateExceptionApplicationAutoScaling.Client.exceptions.InternalServiceExceptionExamples
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',
ScalableDimension='ecs:service:DesiredCount',
ServiceNamespace='ecs',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
ApplicationAutoScaling.Paginator.DescribeScalableTargetsApplicationAutoScaling.Paginator.DescribeScalingActivitiesApplicationAutoScaling.Paginator.DescribeScalingPoliciesApplicationAutoScaling.Paginator.DescribeScheduledActionsApplicationAutoScaling.Paginator.DescribeScalableTargets¶paginator = client.get_paginator('describe_scalable_targets')
paginate(**kwargs)¶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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
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'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'ResourceId': 'string',
'ScalableDimension': 'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'MinCapacity': 123,
'MaxCapacity': 123,
'RoleARN': 'string',
'CreationTime': datetime(2015, 1, 1),
'SuspendedState': {
'DynamicScalingInSuspended': True|False,
'DynamicScalingOutSuspended': True|False,
'ScheduledScalingSuspended': True|False
}
},
],
}
Response Structure
(dict) --
ScalableTargets (list) --
The scalable targets that match the request parameters.
(dict) --
Represents a scalable target.
ServiceNamespace (string) --
The namespace of the Amazon Web Services service that provides the resource, or a custom-resource .
ResourceId (string) --
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.MinCapacity (integer) --
The minimum value to scale to in response to a scale-in activity.
MaxCapacity (integer) --
The maximum value to scale to in response to a scale-out activity.
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.
SuspendedState (dict) --
Specifies whether the scaling activities for a scalable target are in a suspended state.
DynamicScalingInSuspended (boolean) --
Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false .
DynamicScalingOutSuspended (boolean) --
Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false .
ScheduledScalingSuspended (boolean) --
Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false .
ApplicationAutoScaling.Paginator.DescribeScalingActivities¶paginator = client.get_paginator('describe_scaling_activities')
paginate(**kwargs)¶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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'ResourceId': 'string',
'ScalableDimension': 'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'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 Amazon Web Services service that provides the resource, or a custom-resource .
ResourceId (string) --
The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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.
ApplicationAutoScaling.Paginator.DescribeScalingPolicies¶paginator = client.get_paginator('describe_scaling_policies')
paginate(**kwargs)¶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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the scaling policies to describe.
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'ResourceId': 'string',
'ScalableDimension': 'ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'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'|'AppStreamAverageCapacityUtilization'|'ComprehendInferenceUtilization'|'LambdaProvisionedConcurrencyUtilization'|'CassandraReadCapacityUtilization'|'CassandraWriteCapacityUtilization'|'KafkaBrokerStorageUtilization'|'ElastiCachePrimaryEngineCPUUtilization'|'ElastiCacheReplicaEngineCPUUtilization'|'ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage'|'NeptuneReaderAverageCPUUtilization',
'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 to use with Application Auto Scaling.
For more information about configuring scaling policies for a specific service, see Getting started with Application Auto Scaling in the Application Auto Scaling User Guide .
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 Amazon Web Services service that provides the resource, or a custom-resource .
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.PolicyType (string) --
The scaling policy type.
StepScalingPolicyConfiguration (dict) --
A step scaling policy.
AdjustmentType (string) --
Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .
AdjustmentTypeis required if you are adding a new step scaling policy configuration.
StepAdjustments (list) --
A set of adjustments that enable you to scale based on the size of the alarm breach.
At least one step adjustment is required if you are adding a new step scaling policy configuration.
(dict) --
Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.
For the following examples, suppose that you have an alarm with a breach threshold of 50:
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 capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.
MinAdjustmentMagnitude (integer) --
The minimum value to scale by when the adjustment type is PercentChangeInCapacity . For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
Cooldown (integer) --
The amount of time, in seconds, to wait for a previous scaling activity to take effect.
With scale-out policies, the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity. For example, when an alarm triggers a step scaling policy to increase the capacity by 2, the scaling activity completes successfully, and a cooldown period starts. If the alarm triggers again during the cooldown period but at a more aggressive step adjustment of 3, the previous increase of 2 is considered part of the current capacity. Therefore, only 1 is added to the capacity.
With scale-in policies, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the cooldown period after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the cooldown period for the scale-in activity stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
MetricAggregationType (string) --
The aggregation type for the CloudWatch metrics. Valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .
TargetTrackingScalingPolicyConfiguration (dict) --
A target tracking scaling policy.
TargetValue (float) --
The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
PredefinedMetricSpecification (dict) --
A predefined metric. You can specify either a predefined metric or a customized 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.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
CustomizedMetricSpecification (dict) --
A customized metric. You can specify either a predefined metric or a customized metric.
MetricName (string) --
The name of the metric.
Namespace (string) --
The namespace of the metric.
Dimensions (list) --
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
(dict) --
Describes the dimension names and values associated with a metric.
Name (string) --
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, to wait for a previous scale-out activity to take effect.
With the scale-out cooldown period , the intention is to continuously (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends. While the cooldown period is in effect, the capacity added by the initiating scale-out activity is calculated as part of the desired capacity for the next scale-out activity.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
With the scale-in cooldown period , the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups and a default value of 300 for the following scalable targets:
For all other scalable targets, the default value is 0:
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true , scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value 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.
ApplicationAutoScaling.Paginator.DescribeScheduledActions¶paginator = client.get_paginator('describe_scheduled_actions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ApplicationAutoScaling.Client.describe_scheduled_actions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ScheduledActionNames=[
'string',
],
ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
ResourceId='string',
ScalableDimension='ecs:service:DesiredCount'|'ec2:spot-fleet-request:TargetCapacity'|'elasticmapreduce:instancegroup:InstanceCount'|'appstream:fleet:DesiredCapacity'|'dynamodb:table:ReadCapacityUnits'|'dynamodb:table:WriteCapacityUnits'|'dynamodb:index:ReadCapacityUnits'|'dynamodb:index:WriteCapacityUnits'|'rds:cluster:ReadReplicaCount'|'sagemaker:variant:DesiredInstanceCount'|'custom-resource:ResourceType:Property'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the scheduled actions to describe.
[REQUIRED]
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .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.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.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
{
'ScheduledActions': [
{
'ScheduledActionName': 'string',
'ScheduledActionARN': 'string',
'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune',
'Schedule': 'string',
'Timezone': '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'|'comprehend:document-classifier-endpoint:DesiredInferenceUnits'|'comprehend:entity-recognizer-endpoint:DesiredInferenceUnits'|'lambda:function:ProvisionedConcurrency'|'cassandra:table:ReadCapacityUnits'|'cassandra:table:WriteCapacityUnits'|'kafka:broker-storage:VolumeSize'|'elasticache:replication-group:NodeGroups'|'elasticache:replication-group:Replicas'|'neptune:cluster:ReadReplicaCount',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ScalableTargetAction': {
'MinCapacity': 123,
'MaxCapacity': 123
},
'CreationTime': datetime(2015, 1, 1)
},
],
}
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 Amazon Web Services service that provides the resource, or a custom-resource .
Schedule (string) --
The schedule for this action. The following formats are supported:
at(yyyy-mm-ddThh:mm:ss) "rate(valueunit) "cron(fields) "At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days .
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide .
Timezone (string) --
The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
ResourceId (string) --
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0 .fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet .table and the unique identifier is the table name. Example: table/my-table .index and the unique identifier is the index name. Example: table/my-table/index/my-table-index .cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering .OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE .arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE .function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST . Example: function:my-function:prod or function:my-function:1 .table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable .arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster .cluster and the unique identifier is the cluster name. Example: cluster:mycluster .ScalableDimension (string) --
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.StartTime (datetime) --
The date and time that the action is scheduled to begin, in UTC.
EndTime (datetime) --
The date and time that the action is scheduled to end, in UTC.
ScalableTargetAction (dict) --
The new minimum and maximum capacity. You can set both values or just one. At 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.
For certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
MaxCapacity (integer) --
The maximum capacity.
Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service Endpoints and Quotas in the Amazon Web Services General Reference .
CreationTime (datetime) --
The date and time that the scheduled action was created.