Package software.amazon.awssdk.services.applicationautoscaling

Interface ApplicationAutoScalingClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ApplicationAutoScalingClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method.

With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of Auto Scaling. You can use Application Auto Scaling to accomplish the following tasks:

• Define scaling policies to automatically scale your AWS resources

• Scale your resources in response to CloudWatch alarms

• View the history of your scaling events

Application Auto Scaling can scale the following AWS resources:

• Amazon ECS services. For more information, see Service Auto Scaling in the Amazon EC2 Container Service Developer Guide.

• Amazon EC2 Spot fleets. For more information, see Automatic Scaling for Spot Fleet in the Amazon EC2 User Guide.

• Amazon EMR clusters. For more information, see Using Automatic Scaling in Amazon EMR in the Amazon EMR Management Guide.

• AppStream 2.0 fleets. For more information, see Fleet Auto Scaling for Amazon AppStream 2.0 in the Amazon AppStream 2.0 Developer Guide.

• Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see Auto Scaling for DynamoDB in the Amazon DynamoDB Developer Guide.

For a list of supported regions, see AWS Regions and Endpoints: Application Auto Scaling in the AWS General Reference.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ApplicationAutoScalingClientBuilder	builder()	Create a builder that can be used to configure and create a ApplicationAutoScalingClient.
static ApplicationAutoScalingClient	create()	Create a ApplicationAutoScalingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteScalingPolicyResponse	deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)	Deletes the specified Application Auto Scaling scaling policy.
default DeregisterScalableTargetResponse	deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest)	Deregisters a scalable target.
default DescribeScalableTargetsResponse	describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest)	Provides descriptive information about the scalable targets in the specified namespace.
default DescribeScalingActivitiesResponse	describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)	Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
default DescribeScalingPoliciesResponse	describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)	Provides descriptive information about the scaling policies in the specified namespace.
default PutScalingPolicyResponse	putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)	Creates or updates a policy for an Application Auto Scaling scalable target.
default RegisterScalableTargetResponse	registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest)	Registers or updates a scalable target.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ApplicationAutoScalingClient create()

Create a ApplicationAutoScalingClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ApplicationAutoScalingClientBuilder builder()

Create a builder that can be used to configure and create a ApplicationAutoScalingClient.

deleteScalingPolicy

default DeleteScalingPolicyResponse deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)
                                                 throws ValidationException,
                                                        ObjectNotFoundException,
                                                        ConcurrentUpdateException,
                                                        InternalServiceException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        ApplicationAutoScalingException

Deletes the specified Application Auto Scaling scaling policy.

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 scaling policy or update an existing one, see PutScalingPolicy.

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ApplicationAutoScalingException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deregisterScalableTarget

default DeregisterScalableTargetResponse deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest)
                                                           throws ValidationException,
                                                                  ObjectNotFoundException,
                                                                  ConcurrentUpdateException,
                                                                  InternalServiceException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  ApplicationAutoScalingException

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

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ApplicationAutoScalingException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeScalableTargets

default DescribeScalableTargetsResponse describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest)
                                                         throws ValidationException,
                                                                InvalidNextTokenException,
                                                                ConcurrentUpdateException,
                                                                InternalServiceException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                ApplicationAutoScalingException

Provides descriptive information about the scalable targets in the specified namespace.

You can filter the results using the ResourceIds and ScalableDimension parameters.

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.

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ApplicationAutoScalingException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeScalingActivities

default DescribeScalingActivitiesResponse describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
                                                             throws ValidationException,
                                                                    InvalidNextTokenException,
                                                                    ConcurrentUpdateException,
                                                                    InternalServiceException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    ApplicationAutoScalingException

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

You can filter the results using the ResourceId and ScalableDimension parameters.

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.

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ApplicationAutoScalingException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeScalingPolicies

default DescribeScalingPoliciesResponse describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
                                                         throws ValidationException,
                                                                FailedResourceAccessException,
                                                                InvalidNextTokenException,
                                                                ConcurrentUpdateException,
                                                                InternalServiceException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                ApplicationAutoScalingException

Provides descriptive information about the scaling policies in the specified namespace.

You can filter the results using the ResourceId, ScalableDimension, and PolicyNames parameters.

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.

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

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ApplicationAutoScalingException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putScalingPolicy

default PutScalingPolicyResponse putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
                                           throws ValidationException,
                                                  LimitExceededException,
                                                  ObjectNotFoundException,
                                                  ConcurrentUpdateException,
                                                  FailedResourceAccessException,
                                                  InternalServiceException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  ApplicationAutoScalingException

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 without first registering 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.

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.

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 API operation on behalf of your account.

InternalServiceException - The service encountered an internal error.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ApplicationAutoScalingException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

registerScalableTarget

default RegisterScalableTargetResponse registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest)
                                                       throws ValidationException,
                                                              LimitExceededException,
                                                              ConcurrentUpdateException,
                                                              InternalServiceException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              ApplicationAutoScalingException

Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. 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, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

ApplicationAutoScalingException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()