/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.applicationautoscaling; import javax.annotation.Generated; import com.amazonaws.services.applicationautoscaling.model.*; /** * Interface for accessing Application Auto Scaling asynchronously. Each asynchronous method will return a Java Future * object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.applicationautoscaling.AbstractAWSApplicationAutoScalingAsync} instead. *
**
* 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 *
** Amazon SageMaker Serverless endpoint provisioned concurrency *
** Spot Fleets (Amazon EC2) *
** Custom resources provided by your own applications or services *
** To learn more about Application Auto Scaling, see the Application Auto Scaling User Guide. *
** 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. *
** 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. *
* * @param deleteScalingPolicyRequest * @return A Java Future containing the result of the DeleteScalingPolicy operation returned by the service. * @sample AWSApplicationAutoScalingAsync.DeleteScalingPolicy * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteScalingPolicyRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the DeleteScalingPolicy operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.DeleteScalingPolicy * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteScheduledActionRequest * @return A Java Future containing the result of the DeleteScheduledAction operation returned by the service. * @sample AWSApplicationAutoScalingAsync.DeleteScheduledAction * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteScheduledActionRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the DeleteScheduledAction operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.DeleteScheduledAction * @see AWS API Documentation */ java.util.concurrent.Future* Deregisters 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. *
** Deregisters 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. *
** Gets information about the scalable targets in the specified namespace. *
*
* You can filter the results using ResourceIds
and ScalableDimension
.
*
* Gets information about the scalable targets in the specified namespace. *
*
* You can filter the results using ResourceIds
and ScalableDimension
.
*
* 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
.
*
* For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling. *
* * @param describeScalingActivitiesRequest * @return A Java Future containing the result of the DescribeScalingActivities operation returned by the service. * @sample AWSApplicationAutoScalingAsync.DescribeScalingActivities * @see AWS API Documentation */ java.util.concurrent.Future* 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
.
*
* For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling. *
* * @param describeScalingActivitiesRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the DescribeScalingActivities operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.DescribeScalingActivities * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeScalingPoliciesRequest * @return A Java Future containing the result of the DescribeScalingPolicies operation returned by the service. * @sample AWSApplicationAutoScalingAsync.DescribeScalingPolicies * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeScalingPoliciesRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the DescribeScalingPolicies operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.DescribeScalingPolicies * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeScheduledActionsRequest * @return A Java Future containing the result of the DescribeScheduledActions operation returned by the service. * @sample AWSApplicationAutoScalingAsync.DescribeScheduledActions * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeScheduledActionsRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the DescribeScheduledActions operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.DescribeScheduledActions * @see AWS API Documentation */ java.util.concurrent.Future* Returns all the tags on the specified Application Auto Scaling scalable target. *
** For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSApplicationAutoScalingAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Returns all the tags on the specified Application Auto Scaling scalable target. *
** For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *
* * @param listTagsForResourceRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
** If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any * scaling policies that were specified for the scalable target are deleted. *
** 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. *
** If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any * scaling policies that were specified for the scalable target are deleted. *
** 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 you specify start and end times 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. *
** 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 you specify start and end times 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. *
** Registers or updates a scalable target, which is the resource that you want to scale. *
** Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, * which represents some capacity dimension of the underlying service. *
** When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the * specified resource is not active in the target service, this operation does not change the resource's current * capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. *
** If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. * Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and * maximum 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 operation to create a scalable target, there might be a
* brief delay until the operation achieves eventual
* consistency. You might become aware of this brief delay if you get unexpected errors when performing
* sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include
* automatic backoff and retry logic.
*
* If you call the RegisterScalableTarget
API operation to update an existing scalable target,
* Application Auto Scaling retrieves the current capacity of the resource. If it's 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.
*
* Registers or updates a scalable target, which is the resource that you want to scale. *
** Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, * which represents some capacity dimension of the underlying service. *
** When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the * specified resource is not active in the target service, this operation does not change the resource's current * capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range. *
** If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. * Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and * maximum 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 operation to create a scalable target, there might be a
* brief delay until the operation achieves eventual
* consistency. You might become aware of this brief delay if you get unexpected errors when performing
* sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include
* automatic backoff and retry logic.
*
* If you call the RegisterScalableTarget
API operation to update an existing scalable target,
* Application Auto Scaling retrieves the current capacity of the resource. If it's 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.
*
* Adds or edits tags on an Application Auto Scaling scalable target. *
** Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a * new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. *
** You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling * policy or scheduled action. *
*
* You can also add tags to an Application Auto Scaling scalable target while creating it (
* RegisterScalableTarget
).
*
* For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *
** Use tags to control access to a scalable target. For more information, see Tagging * support for Application Auto Scaling in the Application Auto Scaling User Guide. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSApplicationAutoScalingAsync.TagResource * @see AWS API Documentation */ java.util.concurrent.Future* Adds or edits tags on an Application Auto Scaling scalable target. *
** Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a * new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. *
** You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling * policy or scheduled action. *
*
* You can also add tags to an Application Auto Scaling scalable target while creating it (
* RegisterScalableTarget
).
*
* For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *
** Use tags to control access to a scalable target. For more information, see Tagging * support for Application Auto Scaling in the Application Auto Scaling User Guide. *
* * @param tagResourceRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.TagResource * @see AWS API Documentation */ java.util.concurrent.Future* Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the * Application Auto Scaling scalable target. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSApplicationAutoScalingAsync.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future* Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the * Application Auto Scaling scalable target. *
* * @param untagResourceRequest * @param asyncHandler * 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. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSApplicationAutoScalingAsyncHandler.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future