com.amazonaws.services.applicationautoscaling.AWSApplicationAutoScaling Maven / Gradle / Ivy
Show all versions of aws-java-sdk-applicationautoscaling Show documentation
/*
* Copyright 2019-2024 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.applicationautoscaling.model.*;
/**
* Interface for accessing Application Auto Scaling.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.applicationautoscaling.AbstractAWSApplicationAutoScaling} 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
*
*
* -
*
* Amazon SageMaker inference components
*
*
* -
*
* 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.
*
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSApplicationAutoScaling {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "application-autoscaling";
/**
* Overrides the default endpoint for this client ("https://application-autoscaling.us-east-1.amazonaws.com").
* Callers can use this method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "application-autoscaling.us-east-1.amazonaws.com") or a full URL,
* including the protocol (ex: "https://application-autoscaling.us-east-1.amazonaws.com"). If the protocol is not
* specified here, the default protocol from this client's {@link ClientConfiguration} will be used, which by
* default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "application-autoscaling.us-east-1.amazonaws.com") or a full URL, including the protocol
* (ex: "https://application-autoscaling.us-east-1.amazonaws.com") of the region specific AWS endpoint this
* client will communicate with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AWSApplicationAutoScaling#setEndpoint(String)}, sets the regional endpoint for this
* client's service calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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 Result of the DeleteScalingPolicy operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws ObjectNotFoundException
* The specified object could not be found. For any operation that depends on the existence of a scalable
* target, this exception is thrown if the scalable target with the specified service namespace, resource
* ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
* exception is thrown if the resource cannot be found.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.DeleteScalingPolicy
* @see AWS API Documentation
*/
DeleteScalingPolicyResult deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest);
/**
*
* 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 Result of the DeleteScheduledAction operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws ObjectNotFoundException
* The specified object could not be found. For any operation that depends on the existence of a scalable
* target, this exception is thrown if the scalable target with the specified service namespace, resource
* ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
* exception is thrown if the resource cannot be found.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.DeleteScheduledAction
* @see AWS API Documentation
*/
DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest);
/**
*
* 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.
*
*
*
* @param deregisterScalableTargetRequest
* @return Result of the DeregisterScalableTarget operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws ObjectNotFoundException
* The specified object could not be found. For any operation that depends on the existence of a scalable
* target, this exception is thrown if the scalable target with the specified service namespace, resource
* ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
* exception is thrown if the resource cannot be found.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.DeregisterScalableTarget
* @see AWS API Documentation
*/
DeregisterScalableTargetResult deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest);
/**
*
* Gets information about the scalable targets in the specified namespace.
*
*
* You can filter the results using ResourceIds and ScalableDimension.
*
*
* @param describeScalableTargetsRequest
* @return Result of the DescribeScalableTargets operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws InvalidNextTokenException
* The next token supplied was invalid.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.DescribeScalableTargets
* @see AWS API Documentation
*/
DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest);
/**
*
* 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 Result of the DescribeScalingActivities operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws InvalidNextTokenException
* The next token supplied was invalid.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.DescribeScalingActivities
* @see AWS API Documentation
*/
DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest);
/**
*
* 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 Result of the DescribeScalingPolicies operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws FailedResourceAccessException
* Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
* unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
* role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.
* @throws InvalidNextTokenException
* The next token supplied was invalid.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.DescribeScalingPolicies
* @see AWS API Documentation
*/
DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest);
/**
*
* 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 Result of the DescribeScheduledActions operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws InvalidNextTokenException
* The next token supplied was invalid.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.DescribeScheduledActions
* @see AWS API Documentation
*/
DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest);
/**
*
* 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 Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource doesn't exist.
* @sample AWSApplicationAutoScaling.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
*
* @param putScalingPolicyRequest
* @return Result of the PutScalingPolicy operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws LimitExceededException
* A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.
* @throws ObjectNotFoundException
* The specified object could not be found. For any operation that depends on the existence of a scalable
* target, this exception is thrown if the scalable target with the specified service namespace, resource
* ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
* exception is thrown if the resource cannot be found.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws FailedResourceAccessException
* Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
* unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
* role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.PutScalingPolicy
* @see AWS API Documentation
*/
PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest);
/**
*
* 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.
*
*
*
* @param putScheduledActionRequest
* @return Result of the PutScheduledAction operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws LimitExceededException
* A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.
* @throws ObjectNotFoundException
* The specified object could not be found. For any operation that depends on the existence of a scalable
* target, this exception is thrown if the scalable target with the specified service namespace, resource
* ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this
* exception is thrown if the resource cannot be found.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.PutScheduledAction
* @see AWS API Documentation
*/
PutScheduledActionResult putScheduledAction(PutScheduledActionRequest putScheduledActionRequest);
/**
*
* 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.
*
*
*
* @param registerScalableTargetRequest
* @return Result of the RegisterScalableTarget operation returned by the service.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @throws LimitExceededException
* A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.
* @throws ConcurrentUpdateException
* Concurrent updates caused an exception, for example, if you request an update to an Application Auto
* Scaling resource that already has a pending update.
* @throws InternalServiceException
* The service encountered an internal error.
* @sample AWSApplicationAutoScaling.RegisterScalableTarget
* @see AWS API Documentation
*/
RegisterScalableTargetResult registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest);
/**
*
* 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 Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource doesn't exist.
* @throws TooManyTagsException
* The request contains too many tags. Try the request again with fewer tags.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @sample AWSApplicationAutoScaling.TagResource
* @see AWS API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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 Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource doesn't exist.
* @throws ValidationException
* An exception was thrown for a validation issue. Review the available parameters for the API request.
* @sample AWSApplicationAutoScaling.UntagResource
* @see AWS API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}