@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSApplicationAutoScalingAsyncClient extends AWSApplicationAutoScalingClient implements AWSApplicationAutoScalingAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
With Application Auto Scaling, you can configure automatic scaling for the following resources:
Amazon AppStream 2.0 fleets
Amazon Aurora Replicas
Amazon Comprehend document classification and entity recognizer endpoints
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon ECS services
Amazon ElastiCache for Redis clusters (replication groups)
Amazon EMR clusters
Amazon Keyspaces (for Apache Cassandra) tables
Lambda function provisioned concurrency
Amazon Managed Streaming for Apache Kafka broker storage
Amazon Neptune clusters
Amazon SageMaker endpoint variants
Spot Fleets (Amazon EC2)
Custom resources provided by your own applications or services
API Summary
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, deleteScalingPolicy, deleteScheduledAction, deregisterScalableTarget, describeScalableTargets, describeScalingActivities, describeScalingPolicies, describeScheduledActions, getCachedResponseMetadata, putScalingPolicy, putScheduledAction, registerScalableTargetaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdeleteScalingPolicy, deleteScheduledAction, deregisterScalableTarget, describeScalableTargets, describeScalingActivities, describeScalingPolicies, describeScheduledActions, getCachedResponseMetadata, putScalingPolicy, putScheduledAction, registerScalableTarget, setEndpoint, setRegion@Deprecated public AWSApplicationAutoScalingAsyncClient()
AWSApplicationAutoScalingAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AWSApplicationAutoScalingAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSApplicationAutoScalingAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSApplicationAutoScalingAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSApplicationAutoScalingAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSApplicationAutoScalingAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSApplicationAutoScalingAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSApplicationAutoScalingAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AWSApplicationAutoScalingAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AWSApplicationAutoScalingAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<DeleteScalingPolicyResult> deleteScalingPolicyAsync(DeleteScalingPolicyRequest request)
AWSApplicationAutoScalingAsyncDeletes 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.
deleteScalingPolicyAsync in interface AWSApplicationAutoScalingAsyncpublic Future<DeleteScalingPolicyResult> deleteScalingPolicyAsync(DeleteScalingPolicyRequest request, AsyncHandler<DeleteScalingPolicyRequest,DeleteScalingPolicyResult> asyncHandler)
AWSApplicationAutoScalingAsyncDeletes 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.
deleteScalingPolicyAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteScheduledActionResult> deleteScheduledActionAsync(DeleteScheduledActionRequest request)
AWSApplicationAutoScalingAsyncDeletes 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.
deleteScheduledActionAsync in interface AWSApplicationAutoScalingAsyncpublic Future<DeleteScheduledActionResult> deleteScheduledActionAsync(DeleteScheduledActionRequest request, AsyncHandler<DeleteScheduledActionRequest,DeleteScheduledActionResult> asyncHandler)
AWSApplicationAutoScalingAsyncDeletes 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.
deleteScheduledActionAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeregisterScalableTargetResult> deregisterScalableTargetAsync(DeregisterScalableTargetRequest request)
AWSApplicationAutoScalingAsyncDeregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
deregisterScalableTargetAsync in interface AWSApplicationAutoScalingAsyncpublic Future<DeregisterScalableTargetResult> deregisterScalableTargetAsync(DeregisterScalableTargetRequest request, AsyncHandler<DeregisterScalableTargetRequest,DeregisterScalableTargetResult> asyncHandler)
AWSApplicationAutoScalingAsyncDeregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
deregisterScalableTargetAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeScalableTargetsResult> describeScalableTargetsAsync(DescribeScalableTargetsRequest request)
AWSApplicationAutoScalingAsyncGets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
describeScalableTargetsAsync in interface AWSApplicationAutoScalingAsyncpublic Future<DescribeScalableTargetsResult> describeScalableTargetsAsync(DescribeScalableTargetsRequest request, AsyncHandler<DescribeScalableTargetsRequest,DescribeScalableTargetsResult> asyncHandler)
AWSApplicationAutoScalingAsyncGets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
describeScalableTargetsAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeScalingActivitiesResult> describeScalingActivitiesAsync(DescribeScalingActivitiesRequest request)
AWSApplicationAutoScalingAsyncProvides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
describeScalingActivitiesAsync in interface AWSApplicationAutoScalingAsyncpublic Future<DescribeScalingActivitiesResult> describeScalingActivitiesAsync(DescribeScalingActivitiesRequest request, AsyncHandler<DescribeScalingActivitiesRequest,DescribeScalingActivitiesResult> asyncHandler)
AWSApplicationAutoScalingAsyncProvides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId and ScalableDimension.
describeScalingActivitiesAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeScalingPoliciesResult> describeScalingPoliciesAsync(DescribeScalingPoliciesRequest request)
AWSApplicationAutoScalingAsyncDescribes 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.
describeScalingPoliciesAsync in interface AWSApplicationAutoScalingAsyncpublic Future<DescribeScalingPoliciesResult> describeScalingPoliciesAsync(DescribeScalingPoliciesRequest request, AsyncHandler<DescribeScalingPoliciesRequest,DescribeScalingPoliciesResult> asyncHandler)
AWSApplicationAutoScalingAsyncDescribes 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.
describeScalingPoliciesAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeScheduledActionsResult> describeScheduledActionsAsync(DescribeScheduledActionsRequest request)
AWSApplicationAutoScalingAsyncDescribes 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.
describeScheduledActionsAsync in interface AWSApplicationAutoScalingAsyncpublic Future<DescribeScheduledActionsResult> describeScheduledActionsAsync(DescribeScheduledActionsRequest request, AsyncHandler<DescribeScheduledActionsRequest,DescribeScheduledActionsResult> asyncHandler)
AWSApplicationAutoScalingAsyncDescribes 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.
describeScheduledActionsAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutScalingPolicyResult> putScalingPolicyAsync(PutScalingPolicyRequest request)
AWSApplicationAutoScalingAsyncCreates 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.
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.
putScalingPolicyAsync in interface AWSApplicationAutoScalingAsyncpublic Future<PutScalingPolicyResult> putScalingPolicyAsync(PutScalingPolicyRequest request, AsyncHandler<PutScalingPolicyRequest,PutScalingPolicyResult> asyncHandler)
AWSApplicationAutoScalingAsyncCreates 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.
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.
putScalingPolicyAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutScheduledActionResult> putScheduledActionAsync(PutScheduledActionRequest request)
AWSApplicationAutoScalingAsyncCreates 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.
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.
putScheduledActionAsync in interface AWSApplicationAutoScalingAsyncpublic Future<PutScheduledActionResult> putScheduledActionAsync(PutScheduledActionRequest request, AsyncHandler<PutScheduledActionRequest,PutScheduledActionResult> asyncHandler)
AWSApplicationAutoScalingAsyncCreates 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.
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.
putScheduledActionAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RegisterScalableTargetResult> registerScalableTargetAsync(RegisterScalableTargetRequest request)
AWSApplicationAutoScalingAsyncRegisters 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.
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.
registerScalableTargetAsync in interface AWSApplicationAutoScalingAsyncpublic Future<RegisterScalableTargetResult> registerScalableTargetAsync(RegisterScalableTargetRequest request, AsyncHandler<RegisterScalableTargetRequest,RegisterScalableTargetResult> asyncHandler)
AWSApplicationAutoScalingAsyncRegisters 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.
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.
registerScalableTargetAsync in interface AWSApplicationAutoScalingAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSApplicationAutoScalingshutdown in class AWSApplicationAutoScalingClient