com.amazonaws.services.applicationautoscaling

Class AWSApplicationAutoScalingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.applicationautoscaling.AWSApplicationAutoScalingClient

All Implemented Interfaces:

AWSApplicationAutoScaling

Direct Known Subclasses:

AWSApplicationAutoScalingAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSApplicationAutoScalingClient
extends AmazonWebServiceClient
implements AWSApplicationAutoScaling

Client for accessing Application Auto Scaling. All service calls made using this client are blocking, and will not return until the service call 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

• 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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.applicationautoscaling.AWSApplicationAutoScaling

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSApplicationAutoScalingClient() Deprecated. use AWSApplicationAutoScalingClientBuilder.defaultClient()
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSApplicationAutoScalingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSApplicationAutoScalingClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

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 when you have finished using it.
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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns all the tags on the specified Application Auto Scaling scalable target.
PutScalingPolicyResult	putScalingPolicy(PutScalingPolicyRequest request) Creates or updates a scaling 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, which is the resource that you want to scale.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds or edits tags on an Application Auto Scaling scalable target.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes tags from an Application Auto Scaling scalable target.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.applicationautoscaling.AWSApplicationAutoScaling

setEndpoint, setRegion

Constructor Detail

AWSApplicationAutoScalingClient

@Deprecated
public AWSApplicationAutoScalingClient()

Deprecated. use AWSApplicationAutoScalingClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Application Auto Scaling. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSApplicationAutoScalingClient

@Deprecated
public AWSApplicationAutoScalingClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Application Auto Scaling. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSApplicationAutoScalingClient

@Deprecated
public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSApplicationAutoScalingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSApplicationAutoScalingClient

@Deprecated
public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials,
                                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSApplicationAutoScalingClient

@Deprecated
public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSApplicationAutoScalingClient

@Deprecated
public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
                                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSApplicationAutoScalingClient

@Deprecated
public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
                                                   ClientConfiguration clientConfiguration,
                                                   RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 collector

Method Detail

builder

public static AWSApplicationAutoScalingClientBuilder builder()

deleteScalingPolicy

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.

Specified by:

deleteScalingPolicy in interface AWSApplicationAutoScaling

Parameters:

deleteScalingPolicyRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

Samples:

• To delete a scaling policy

  This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.
  

  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);

deleteScheduledAction

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.

Specified by:

deleteScheduledAction in interface AWSApplicationAutoScaling

Parameters:

deleteScheduledActionRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

deregisterScalableTarget

public DeregisterScalableTargetResult deregisterScalableTarget(DeregisterScalableTargetRequest request)

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.

Specified by:

deregisterScalableTarget in interface AWSApplicationAutoScaling

Parameters:

deregisterScalableTargetRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

Samples:

• To deregister a scalable target

  This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.
  

  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);

describeScalableTargets

public DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest request)

Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.

Specified by:

describeScalableTargets in interface AWSApplicationAutoScaling

Parameters:

describeScalableTargetsRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

Samples:

• To describe scalable targets

  This example describes the scalable targets for the ecs service namespace.
  

  AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
  DescribeScalableTargetsRequest request = new DescribeScalableTargetsRequest().withServiceNamespace("ecs");
  DescribeScalableTargetsResult response = client.describeScalableTargets(request);

describeScalingActivities

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.

For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.

Specified by:

describeScalingActivities in interface AWSApplicationAutoScaling

Parameters:

describeScalingActivitiesRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

Samples:

• To describe scaling activities for a scalable target

  This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.
  

  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);

describeScalingPolicies

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.

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

Specified by:

describeScalingPolicies in interface AWSApplicationAutoScaling

Parameters:

describeScalingPoliciesRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

Samples:

• To describe scaling policies

  This example describes the scaling policies for the ecs service namespace.
  

  AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build();
  DescribeScalingPoliciesRequest request = new DescribeScalingPoliciesRequest().withServiceNamespace("ecs");
  DescribeScalingPoliciesResult response = client.describeScalingPolicies(request);

describeScheduledActions

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.

For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide.

Specified by:

describeScheduledActions in interface AWSApplicationAutoScaling

Parameters:

describeScheduledActionsRequest -

Returns:

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.

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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.

Specified by:

listTagsForResource in interface AWSApplicationAutoScaling

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource doesn't exist.

See Also:

AWS API Documentation

putScalingPolicy

public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)

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.

Specified by:

putScalingPolicy in interface AWSApplicationAutoScaling

Parameters:

putScalingPolicyRequest -

Returns:

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.

LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.

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.

See Also:

AWS API Documentation

Samples:

• To apply a scaling policy to an Amazon EC2 Spot fleet

  This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.",
  

  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);

putScheduledAction

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.

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.

Specified by:

putScheduledAction in interface AWSApplicationAutoScaling

Parameters:

putScheduledActionRequest -

Returns:

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.

LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.

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.

See Also:

AWS API Documentation

registerScalableTarget

public RegisterScalableTargetResult registerScalableTarget(RegisterScalableTargetRequest request)

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.

Specified by:

registerScalableTarget in interface AWSApplicationAutoScaling

Parameters:

registerScalableTargetRequest -

Returns:

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.

LimitExceededException - A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.

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.

See Also:

AWS API Documentation

Samples:

• To register an EC2 Spot fleet as a scalable target

  This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10.
  

  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);

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AWSApplicationAutoScaling

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource doesn't exist.

TooManyTagsException - The request contains too many tags. Try the request again with fewer tags.

ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.

Specified by:

untagResource in interface AWSApplicationAutoScaling

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource doesn't exist.

ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSApplicationAutoScaling

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSApplicationAutoScaling

Overrides:

shutdown in class AmazonWebServiceClient