@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSApplicationAutoScalingClient extends AmazonWebServiceClient implements AWSApplicationAutoScaling
With Application Auto Scaling, you can configure automatic scaling for the following resources:
Amazon ECS services
Amazon EC2 Spot Fleet requests
Amazon EMR clusters
Amazon AppStream 2.0 fleets
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon Aurora Replicas
Amazon SageMaker endpoint variants
Custom resources provided by your own applications or services
Amazon Comprehend document classification endpoints
AWS Lambda function provisioned concurrency
API Summary
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register AWS 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 action for any Application Auto Scaling scalable target. You can suspend and resume, individually or in combination, scale-out activities triggered by a scaling policy, scale-in activities 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_PREFIX| Constructor and Description |
|---|
AWSApplicationAutoScalingClient()
Deprecated.
|
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSApplicationAutoScalingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSApplicationAutoScalingClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AWSApplicationAutoScalingClientBuilder |
builder() |
DeleteScalingPolicyResult |
deleteScalingPolicy(DeleteScalingPolicyRequest request)
Deletes the specified scaling policy for an Application Auto Scaling scalable target.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
|
DeregisterScalableTargetResult |
deregisterScalableTarget(DeregisterScalableTargetRequest request)
Deregisters an Application Auto Scaling scalable target.
|
DescribeScalableTargetsResult |
describeScalableTargets(DescribeScalableTargetsRequest request)
Gets information about the scalable targets in the specified namespace.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest request)
Provides descriptive information about the scaling activities in the specified namespace from the previous six
weeks.
|
DescribeScalingPoliciesResult |
describeScalingPolicies(DescribeScalingPoliciesRequest request)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a policy for an Application Auto Scaling scalable target.
|
PutScheduledActionResult |
putScheduledAction(PutScheduledActionRequest request)
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
|
RegisterScalableTargetResult |
registerScalableTarget(RegisterScalableTargetRequest request)
Registers or updates a scalable target.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSApplicationAutoScalingClient()
AWSApplicationAutoScalingClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSApplicationAutoScalingClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSApplicationAutoScalingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).@Deprecated public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).@Deprecated public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSApplicationAutoScalingClientBuilder builder()
public DeleteScalingPolicyResult deleteScalingPolicy(DeleteScalingPolicyRequest request)
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.
To create a scaling policy or update an existing one, see PutScalingPolicy.
deleteScalingPolicy in interface AWSApplicationAutoScalingdeleteScalingPolicyRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.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.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.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
DeleteScalingPolicyRequest request = new DeleteScalingPolicyRequest().withPolicyName("web-app-cpu-lt-25").withServiceNamespace("ecs")
.withResourceId("service/default/web-app").withScalableDimension("ecs:service:DesiredCount");
DeleteScalingPolicyResult response = client.deleteScalingPolicy(request);public DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)
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.
deleteScheduledAction in interface AWSApplicationAutoScalingdeleteScheduledActionRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.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.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.InternalServiceException - The service encountered an internal error.public DeregisterScalableTargetResult deregisterScalableTarget(DeregisterScalableTargetRequest request)
Deregisters an Application Auto Scaling scalable target.
Deregistering a scalable target deletes the scaling policies that are associated with it.
To create a scalable target or update an existing one, see RegisterScalableTarget.
deregisterScalableTarget in interface AWSApplicationAutoScalingderegisterScalableTargetRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.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.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.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
DeregisterScalableTargetRequest request = new DeregisterScalableTargetRequest().withServiceNamespace("ecs").withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount");
DeregisterScalableTargetResult response = client.deregisterScalableTarget(request);public DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest request)
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds and ScalableDimension.
To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.
describeScalableTargets in interface AWSApplicationAutoScalingdescribeScalableTargetsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.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.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
DescribeScalableTargetsRequest request = new DescribeScalableTargetsRequest().withServiceNamespace("ecs");
DescribeScalableTargetsResult response = client.describeScalableTargets(request);public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest request)
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.
Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.
describeScalingActivities in interface AWSApplicationAutoScalingdescribeScalingActivitiesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.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.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
DescribeScalingActivitiesRequest request = new DescribeScalingActivitiesRequest().withServiceNamespace("ecs").withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount");
DescribeScalingActivitiesResult response = client.describeScalingActivities(request);public DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest request)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId, ScalableDimension, and
PolicyNames.
To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
describeScalingPolicies in interface AWSApplicationAutoScalingdescribeScalingPoliciesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.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.InvalidNextTokenException - The next token supplied was invalid.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.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
DescribeScalingPoliciesRequest request = new DescribeScalingPoliciesRequest().withServiceNamespace("ecs");
DescribeScalingPoliciesResult response = client.describeScalingPolicies(request);public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
ScheduledActionNames parameters.
To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.
describeScheduledActions in interface AWSApplicationAutoScalingdescribeScheduledActionsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.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.InternalServiceException - The service encountered an internal error.public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a 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 using RegisterScalableTarget.
To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.
You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
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.
Learn more about how to work with scaling policies in the Application Auto Scaling User Guide.
putScalingPolicy in interface AWSApplicationAutoScalingputScalingPolicyRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits.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.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.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.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
PutScalingPolicyRequest request = new PutScalingPolicyRequest()
.withPolicyName("web-app-cpu-gt-75")
.withServiceNamespace("ecs")
.withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount")
.withPolicyType("StepScaling")
.withStepScalingPolicyConfiguration(
new StepScalingPolicyConfiguration().withAdjustmentType("PercentChangeInCapacity")
.withStepAdjustments(new StepAdjustment().withMetricIntervalLowerBound(0d).withScalingAdjustment(200)).withCooldown(60));
PutScalingPolicyResult response = client.putScalingPolicy(request);AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
PutScalingPolicyRequest request = new PutScalingPolicyRequest()
.withPolicyName("fleet-cpu-gt-75")
.withServiceNamespace("ec2")
.withResourceId("spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3")
.withScalableDimension("ec2:spot-fleet-request:TargetCapacity")
.withPolicyType("StepScaling")
.withStepScalingPolicyConfiguration(
new StepScalingPolicyConfiguration().withAdjustmentType("PercentChangeInCapacity")
.withStepAdjustments(new StepAdjustment().withMetricIntervalLowerBound(0d).withScalingAdjustment(200)).withCooldown(180));
PutScalingPolicyResult response = client.putScalingPolicy(request);public PutScheduledActionResult putScheduledAction(PutScheduledActionRequest request)
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 using RegisterScalableTarget.
To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.
You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.
Learn more about how to work with scheduled actions in the Application Auto Scaling User Guide.
putScheduledAction in interface AWSApplicationAutoScalingputScheduledActionRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits.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.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.InternalServiceException - The service encountered an internal error.public RegisterScalableTargetResult registerScalableTarget(RegisterScalableTargetRequest request)
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. Application Auto Scaling will not scale capacity to values that are outside of this range.
To update a scalable target, specify the parameter that you want to change as well as the following 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.
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.
registerScalableTarget in interface AWSApplicationAutoScalingregisterScalableTargetRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits.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.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
RegisterScalableTargetRequest request = new RegisterScalableTargetRequest().withServiceNamespace("ecs").withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount").withMinCapacity(1).withMaxCapacity(10)
.withRoleARN("arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole");
RegisterScalableTargetResult response = client.registerScalableTarget(request);AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
RegisterScalableTargetRequest request = new RegisterScalableTargetRequest().withServiceNamespace("ec2")
.withResourceId("spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3").withScalableDimension("ec2:spot-fleet-request:TargetCapacity")
.withMinCapacity(1).withMaxCapacity(10).withRoleARN("arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole");
RegisterScalableTargetResult response = client.registerScalableTarget(request);public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AWSApplicationAutoScalingrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.