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

Application Auto Scaling is a general purpose Auto Scaling service for supported elastic AWS resources. With Application Auto Scaling, you can automatically scale your AWS resources, with an experience similar to that of Auto Scaling.

Application Auto Scaling supports scaling the following AWS resources:

• Amazon ECS services

• Amazon EC2 Spot fleet instances

You can use Application Auto Scaling to accomplish the following tasks:

• Define scaling policies for automatically adjusting your AWS resources

• Scale your resources in response to CloudWatch alarms

• View history of your scaling events

Application Auto Scaling is available in the following regions:

• us-east-1

• us-west-1

• us-west-2

• ap-southeast-1

• ap-southeast-2

• ap-northeast-1

• eu-central-1

• eu-west-1

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() Constructs a new client to invoke service methods on Application Auto Scaling.
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials.
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials and client configuration options.
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials provider.
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Application Auto Scaling using the specified AWS account credentials provider and client configuration options.
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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.
AWSApplicationAutoScalingClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Application Auto Scaling.

Method Summary

Modifier and Type	Method and Description
DeleteScalingPolicyResult	deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest) Deletes an Application Auto Scaling scaling policy that was previously created.
DeregisterScalableTargetResult	deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest) Deregisters a scalable target that was previously registered.
DescribeScalableTargetsResult	describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest) Provides descriptive information for scalable targets with a specified service namespace.
DescribeScalingActivitiesResult	describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) Provides descriptive information for scaling activities with a specified service namespace for the previous six weeks.
DescribeScalingPoliciesResult	describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) Provides descriptive information for scaling policies with a 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 putScalingPolicyRequest) Creates or updates a policy for an existing Application Auto Scaling scalable target.
RegisterScalableTargetResult	registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest) Registers or updates a scalable target.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, 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, shutdown

Constructor Detail

AWSApplicationAutoScalingClient

public AWSApplicationAutoScalingClient()

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

public AWSApplicationAutoScalingClient(ClientConfiguration 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

public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials)

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

public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials,
                                       ClientConfiguration 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

public AWSApplicationAutoScalingClient(AWSCredentialsProvider 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

public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
                                       ClientConfiguration 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

public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
                                       ClientConfiguration clientConfiguration,
                                       RequestMetricCollector 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

deleteScalingPolicy

public DeleteScalingPolicyResult deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)

Deletes an Application Auto Scaling scaling policy that was previously created. If you are no longer using a scaling policy, you can delete it with this operation.

Deleting a 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.

To create a new scaling policy or update an existing one, see PutScalingPolicy.

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 Put or Register API operation, which 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 Delete or Deregister API operation, this exception is thrown if the resource that is to be deleted or deregistered 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.

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 = new AWSApplicationAutoScalingClient();
  DeleteScalingPolicyRequest request = new DeleteScalingPolicyRequest()
          .withPolicyName("web-app-cpu-lt-25")
          .withResourceId("service/default/web-app")
          .withScalableDimension("ecs:service:DesiredCount")
          .withServiceNamespace("ecs");
  DeleteScalingPolicyResult response = client
          .deleteScalingPolicy(request);

deregisterScalableTarget

public DeregisterScalableTargetResult deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest)

Deregisters a scalable target that was previously registered. If you are no longer using a scalable target, you can delete it with this operation. When you deregister a scalable target, all of the scaling policies that are associated with that scalable target are deleted.

To create a new scalable target or update an existing one, see RegisterScalableTarget.

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 Put or Register API operation, which 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 Delete or Deregister API operation, this exception is thrown if the resource that is to be deleted or deregistered 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.

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 = new AWSApplicationAutoScalingClient();
  DeregisterScalableTargetRequest request = new DeregisterScalableTargetRequest()
          .withResourceId("service/default/web-app")
          .withScalableDimension("ecs:service:DesiredCount")
          .withServiceNamespace("ecs");
  DeregisterScalableTargetResult response = client
          .deregisterScalableTarget(request);

describeScalableTargets

public DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest)

Provides descriptive information for scalable targets with a specified service namespace.

You can filter the results in a service namespace with the ResourceIds and ScalableDimension parameters.

To create a new scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it with DeregisterScalableTarget.

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.

Samples:

• To describe scalable targets

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

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

describeScalingActivities

public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)

Provides descriptive information for scaling activities with a specified service namespace for the previous six weeks.

You can filter the results in a service namespace with the ResourceId and ScalableDimension parameters.

Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the existing scaling policies for a service namespace, see DescribeScalingPolicies. To create a new scaling policy or update an existing one, see PutScalingPolicy.

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.

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 = new AWSApplicationAutoScalingClient();
  DescribeScalingActivitiesRequest request = new DescribeScalingActivitiesRequest()
          .withResourceId("service/default/web-app")
          .withScalableDimension("ecs:service:DesiredCount")
          .withServiceNamespace("ecs");
  DescribeScalingActivitiesResult response = client
          .describeScalingActivities(request);

describeScalingPolicies

public DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)

Provides descriptive information for scaling policies with a specified service namespace.

You can filter the results in a service namespace with the ResourceId, ScalableDimension, and PolicyNames parameters.

To create a new scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it with DeleteScalingPolicy.

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 currently only applies to DescribeScalingPolicies. It 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 the proper permissions to call the CloudWatch DescribeAlarms API operation on behalf of your account.

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.

Samples:

• To describe scaling policies

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

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

putScalingPolicy

public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)

Creates or updates a policy for an existing Application Auto Scaling scalable target. Each scalable target is identified by service namespace, a resource ID, and a scalable dimension, and a scaling policy applies to a scalable target that is identified by those three attributes. You cannot create a scaling policy without first registering a scalable target with RegisterScalableTarget.

To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

You can view the existing scaling policies for a service namespace with DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it with DeleteScalingPolicy.

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 - Your account exceeded a limit. This exception is thrown when 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 Put or Register API operation, which 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 Delete or Deregister API operation, this exception is thrown if the resource that is to be deleted or deregistered 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.

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 = new AWSApplicationAutoScalingClient();
  PutScalingPolicyRequest request = new PutScalingPolicyRequest()
          .withPolicyName("web-app-cpu-gt-75")
          .withPolicyType("StepScaling")
          .withResourceId("service/default/web-app")
          .withScalableDimension("ecs:service:DesiredCount")
          .withServiceNamespace("ecs")
          .withStepScalingPolicyConfiguration(
                  new StepScalingPolicyConfiguration()
                          .withAdjustmentType("PercentChangeInCapacity")
                          .withCooldown(60)
                          .withStepAdjustments(
                                  new StepAdjustment()
                                          .withMetricIntervalLowerBound(
                                                  0d)
                                          .withScalingAdjustment(200)));
  PutScalingPolicyResult response = client.putScalingPolicy(request);
  AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
  PutScalingPolicyRequest request = new PutScalingPolicyRequest()
          .withPolicyName("fleet-cpu-gt-75")
          .withPolicyType("StepScaling")
          .withResourceId(
                  "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3")
          .withScalableDimension("ec2:spot-fleet-request:TargetCapacity")
          .withServiceNamespace("ec2")
          .withStepScalingPolicyConfiguration(
                  new StepScalingPolicyConfiguration()
                          .withAdjustmentType("PercentChangeInCapacity")
                          .withCooldown(180)
                          .withStepAdjustments(
                                  new StepAdjustment()
                                          .withMetricIntervalLowerBound(
                                                  0d)
                                          .withScalingAdjustment(200)));
  PutScalingPolicyResult response = client.putScalingPolicy(request);

registerScalableTarget

public RegisterScalableTargetResult registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest)

Registers or updates a scalable target. A scalable target is a resource that can be scaled out or in with Application Auto Scaling. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.

After you register a scalable target with Application Auto Scaling, you can create and apply scaling policies to it with PutScalingPolicy. You can view the existing scaling policies for a service namespace with DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it with DeregisterScalableTarget.

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 - Your account exceeded a limit. This exception is thrown when 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.

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 = new AWSApplicationAutoScalingClient();
  RegisterScalableTargetRequest request = new RegisterScalableTargetRequest()
          .withMaxCapacity(10)
          .withMinCapacity(1)
          .withResourceId("service/default/web-app")
          .withRoleARN(
                  "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole")
          .withScalableDimension("ecs:service:DesiredCount")
          .withServiceNamespace("ecs");
  RegisterScalableTargetResult response = client
          .registerScalableTarget(request);AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
  RegisterScalableTargetRequest request = new RegisterScalableTargetRequest()
          .withMaxCapacity(10)
          .withMinCapacity(1)
          .withResourceId(
                  "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3")
          .withRoleARN(
                  "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole")
          .withScalableDimension("ec2:spot-fleet-request:TargetCapacity")
          .withServiceNamespace("ec2");
  RegisterScalableTargetResult response = client
          .registerScalableTarget(request);

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.