Interface ApplicationAutoScalingClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

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 inference components

• Amazon SageMaker serverless endpoint provisioned concurrency

• Spot Fleets (Amazon EC2)

• Pool of WorkSpaces

• 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

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final 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(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest)	Deletes the specified scaling policy for an Application Auto Scaling scalable target.
default DeleteScalingPolicyResponse	deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)	Deletes the specified scaling policy for an Application Auto Scaling scalable target.
default DeleteScheduledActionResponse	deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest)	Deletes the specified scheduled action for an Application Auto Scaling scalable target.
default DeleteScheduledActionResponse	deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)	Deletes the specified scheduled action for an Application Auto Scaling scalable target.
default DeregisterScalableTargetResponse	deregisterScalableTarget(Consumer<DeregisterScalableTargetRequest.Builder> deregisterScalableTargetRequest)	Deregisters an Application Auto Scaling scalable target when you have finished using it.
default DeregisterScalableTargetResponse	deregisterScalableTarget(DeregisterScalableTargetRequest deregisterScalableTargetRequest)	Deregisters an Application Auto Scaling scalable target when you have finished using it.
default DescribeScalableTargetsResponse	describeScalableTargets(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest)	Gets information about the scalable targets in the specified namespace.
default DescribeScalableTargetsResponse	describeScalableTargets(DescribeScalableTargetsRequest describeScalableTargetsRequest)	Gets information about the scalable targets in the specified namespace.
default DescribeScalableTargetsIterable	describeScalableTargetsPaginator(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest)	This is a variant of describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest) operation.
default DescribeScalableTargetsIterable	describeScalableTargetsPaginator(DescribeScalableTargetsRequest describeScalableTargetsRequest)	This is a variant of describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest) operation.
default DescribeScalingActivitiesResponse	describeScalingActivities(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)	Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
default DescribeScalingActivitiesResponse	describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)	Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
default DescribeScalingActivitiesIterable	describeScalingActivitiesPaginator(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)	This is a variant of describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest) operation.
default DescribeScalingActivitiesIterable	describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)	This is a variant of describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest) operation.
default DescribeScalingPoliciesResponse	describeScalingPolicies(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)	Describes the Application Auto Scaling scaling policies for the specified service namespace.
default DescribeScalingPoliciesResponse	describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)	Describes the Application Auto Scaling scaling policies for the specified service namespace.
default DescribeScalingPoliciesIterable	describeScalingPoliciesPaginator(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)	This is a variant of describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest) operation.
default DescribeScalingPoliciesIterable	describeScalingPoliciesPaginator(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)	This is a variant of describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest) operation.
default DescribeScheduledActionsResponse	describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)	Describes the Application Auto Scaling scheduled actions for the specified service namespace.
default DescribeScheduledActionsResponse	describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)	Describes the Application Auto Scaling scheduled actions for the specified service namespace.
default DescribeScheduledActionsIterable	describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)	This is a variant of describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest) operation.
default DescribeScheduledActionsIterable	describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest)	This is a variant of describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns all the tags on the specified Application Auto Scaling scalable target.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns all the tags on the specified Application Auto Scaling scalable target.
default PutScalingPolicyResponse	putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest)	Creates or updates a scaling policy for an Application Auto Scaling scalable target.
default PutScalingPolicyResponse	putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)	Creates or updates a scaling policy for an Application Auto Scaling scalable target.
default PutScheduledActionResponse	putScheduledAction(Consumer<PutScheduledActionRequest.Builder> putScheduledActionRequest)	Creates or updates a scheduled action for an Application Auto Scaling scalable target.
default PutScheduledActionResponse	putScheduledAction(PutScheduledActionRequest putScheduledActionRequest)	Creates or updates a scheduled action for an Application Auto Scaling scalable target.
default RegisterScalableTargetResponse	registerScalableTarget(Consumer<RegisterScalableTargetRequest.Builder> registerScalableTargetRequest)	Registers or updates a scalable target, which is the resource that you want to scale.
default RegisterScalableTargetResponse	registerScalableTarget(RegisterScalableTargetRequest registerScalableTargetRequest)	Registers or updates a scalable target, which is the resource that you want to scale.
default ApplicationAutoScalingServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds or edits tags on an Application Auto Scaling scalable target.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or edits tags on an Application Auto Scaling scalable target.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Deletes tags from an Application Auto Scaling scalable target.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Deletes tags from an Application Auto Scaling scalable target.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

deleteScalingPolicy

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

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.

Parameters:

deleteScalingPolicyRequest -

Returns:

Result of the DeleteScalingPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteScalingPolicy

default DeleteScalingPolicyResponse deleteScalingPolicy(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest)
                                                 throws ValidationException,
ObjectNotFoundException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the DeleteScalingPolicyRequest.Builder avoiding the need to create one manually via DeleteScalingPolicyRequest.builder()

Parameters:

deleteScalingPolicyRequest - A Consumer that will call methods on DeleteScalingPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteScalingPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteScheduledAction

default DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
                                                     throws ValidationException,
ObjectNotFoundException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

Parameters:

deleteScheduledActionRequest -

Returns:

Result of the DeleteScheduledAction operation returned by the service.

See Also:

• AWS API Documentation

deleteScheduledAction

default DeleteScheduledActionResponse deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest)
                                                     throws ValidationException,
ObjectNotFoundException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the DeleteScheduledActionRequest.Builder avoiding the need to create one manually via DeleteScheduledActionRequest.builder()

Parameters:

deleteScheduledActionRequest - A Consumer that will call methods on DeleteScheduledActionRequest.Builder to create a request.

Returns:

Result of the DeleteScheduledAction operation returned by the service.

See Also:

• AWS API Documentation

deregisterScalableTarget

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

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.

Parameters:

deregisterScalableTargetRequest -

Returns:

Result of the DeregisterScalableTarget operation returned by the service.

See Also:

• AWS API Documentation

deregisterScalableTarget

default DeregisterScalableTargetResponse deregisterScalableTarget(Consumer<DeregisterScalableTargetRequest.Builder> deregisterScalableTargetRequest)
                                                           throws ValidationException,
ObjectNotFoundException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the DeregisterScalableTargetRequest.Builder avoiding the need to create one manually via DeregisterScalableTargetRequest.builder()

Parameters:

deregisterScalableTargetRequest - A Consumer that will call methods on DeregisterScalableTargetRequest.Builder to create a request.

Returns:

Result of the DeregisterScalableTarget operation returned by the service.

See Also:

• AWS API Documentation

describeScalableTargets

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

Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.

Parameters:

describeScalableTargetsRequest -

Returns:

Result of the DescribeScalableTargets operation returned by the service.

See Also:

• AWS API Documentation

describeScalableTargets

default DescribeScalableTargetsResponse describeScalableTargets(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest)
                                                         throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.

This is a convenience which creates an instance of the DescribeScalableTargetsRequest.Builder avoiding the need to create one manually via DescribeScalableTargetsRequest.builder()

Parameters:

describeScalableTargetsRequest - A Consumer that will call methods on DescribeScalableTargetsRequest.Builder to create a request.

Returns:

Result of the DescribeScalableTargets operation returned by the service.

See Also:

• AWS API Documentation

describeScalableTargetsPaginator

default DescribeScalableTargetsIterable describeScalableTargetsPaginator(DescribeScalableTargetsRequest describeScalableTargetsRequest)
                                                                  throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client
             .describeScalableTargetsPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest) operation.

Parameters:

describeScalableTargetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeScalableTargetsPaginator

default DescribeScalableTargetsIterable describeScalableTargetsPaginator(Consumer<DescribeScalableTargetsRequest.Builder> describeScalableTargetsRequest)
                                                                  throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client
             .describeScalableTargetsPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScalableTargets(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalableTargetsRequest) operation.

This is a convenience which creates an instance of the DescribeScalableTargetsRequest.Builder avoiding the need to create one manually via DescribeScalableTargetsRequest.builder()

Parameters:

describeScalableTargetsRequest - A Consumer that will call methods on DescribeScalableTargetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeScalingActivities

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

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.

Parameters:

describeScalingActivitiesRequest -

Returns:

Result of the DescribeScalingActivities operation returned by the service.

See Also:

• AWS API Documentation

describeScalingActivities

default DescribeScalingActivitiesResponse describeScalingActivities(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)
                                                             throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the DescribeScalingActivitiesRequest.Builder avoiding the need to create one manually via DescribeScalingActivitiesRequest.builder()

Parameters:

describeScalingActivitiesRequest - A Consumer that will call methods on DescribeScalingActivitiesRequest.Builder to create a request.

Returns:

Result of the DescribeScalingActivities operation returned by the service.

See Also:

• AWS API Documentation

describeScalingActivitiesPaginator

default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
                                                                      throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client
             .describeScalingActivitiesPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest) operation.

Parameters:

describeScalingActivitiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeScalingActivitiesPaginator

default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)
                                                                      throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client
             .describeScalingActivitiesPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScalingActivities(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingActivitiesRequest) operation.

This is a convenience which creates an instance of the DescribeScalingActivitiesRequest.Builder avoiding the need to create one manually via DescribeScalingActivitiesRequest.builder()

Parameters:

describeScalingActivitiesRequest - A Consumer that will call methods on DescribeScalingActivitiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeScalingPolicies

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

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.

Parameters:

describeScalingPoliciesRequest -

Returns:

Result of the DescribeScalingPolicies operation returned by the service.

See Also:

• AWS API Documentation

describeScalingPolicies

default DescribeScalingPoliciesResponse describeScalingPolicies(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)
                                                         throws ValidationException,
FailedResourceAccessException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the DescribeScalingPoliciesRequest.Builder avoiding the need to create one manually via DescribeScalingPoliciesRequest.builder()

Parameters:

describeScalingPoliciesRequest - A Consumer that will call methods on DescribeScalingPoliciesRequest.Builder to create a request.

Returns:

Result of the DescribeScalingPolicies operation returned by the service.

See Also:

• AWS API Documentation

describeScalingPoliciesPaginator

default DescribeScalingPoliciesIterable describeScalingPoliciesPaginator(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
                                                                  throws ValidationException,
FailedResourceAccessException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client
             .describeScalingPoliciesPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest) operation.

Parameters:

describeScalingPoliciesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeScalingPoliciesPaginator

default DescribeScalingPoliciesIterable describeScalingPoliciesPaginator(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)
                                                                  throws ValidationException,
FailedResourceAccessException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client
             .describeScalingPoliciesPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScalingPolicies(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScalingPoliciesRequest) operation.

This is a convenience which creates an instance of the DescribeScalingPoliciesRequest.Builder avoiding the need to create one manually via DescribeScalingPoliciesRequest.builder()

Parameters:

describeScalingPoliciesRequest - A Consumer that will call methods on DescribeScalingPoliciesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeScheduledActions

default DescribeScheduledActionsResponse describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
                                                           throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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 in the Application Auto Scaling User Guide.

Parameters:

describeScheduledActionsRequest -

Returns:

Result of the DescribeScheduledActions operation returned by the service.

See Also:

• AWS API Documentation

describeScheduledActions

default DescribeScheduledActionsResponse describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
                                                           throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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 in the Application Auto Scaling User Guide.

This is a convenience which creates an instance of the DescribeScheduledActionsRequest.Builder avoiding the need to create one manually via DescribeScheduledActionsRequest.builder()

Parameters:

describeScheduledActionsRequest - A Consumer that will call methods on DescribeScheduledActionsRequest.Builder to create a request.

Returns:

Result of the DescribeScheduledActions operation returned by the service.

See Also:

• AWS API Documentation

describeScheduledActionsPaginator

default DescribeScheduledActionsIterable describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest)
                                                                    throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client
             .describeScheduledActionsPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest) operation.

Parameters:

describeScheduledActionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeScheduledActionsPaginator

default DescribeScheduledActionsIterable describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
                                                                    throws ValidationException,
InvalidNextTokenException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

This is a variant of describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client
             .describeScheduledActionsPaginator(request);
     for (software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeScheduledActions(software.amazon.awssdk.services.applicationautoscaling.model.DescribeScheduledActionsRequest) operation.

This is a convenience which creates an instance of the DescribeScheduledActionsRequest.Builder avoiding the need to create one manually via DescribeScheduledActionsRequest.builder()

Parameters:

describeScheduledActionsRequest - A Consumer that will call methods on DescribeScheduledActionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

Returns all the tags on the specified Application Auto Scaling scalable target.

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

Returns all the tags on the specified Application Auto Scaling scalable target.

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putScalingPolicy

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

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.

Parameters:

putScalingPolicyRequest -

Returns:

Result of the PutScalingPolicy operation returned by the service.

See Also:

• AWS API Documentation

putScalingPolicy

default PutScalingPolicyResponse putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest)
                                           throws ValidationException,
LimitExceededException,
ObjectNotFoundException,
ConcurrentUpdateException,
FailedResourceAccessException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the PutScalingPolicyRequest.Builder avoiding the need to create one manually via PutScalingPolicyRequest.builder()

Parameters:

putScalingPolicyRequest - A Consumer that will call methods on PutScalingPolicyRequest.Builder to create a request.

Returns:

Result of the PutScalingPolicy operation returned by the service.

See Also:

• AWS API Documentation

putScheduledAction

default PutScheduledActionResponse putScheduledAction(PutScheduledActionRequest putScheduledActionRequest)
                                               throws ValidationException,
LimitExceededException,
ObjectNotFoundException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

Parameters:

putScheduledActionRequest -

Returns:

Result of the PutScheduledAction operation returned by the service.

See Also:

• AWS API Documentation

putScheduledAction

default PutScheduledActionResponse putScheduledAction(Consumer<PutScheduledActionRequest.Builder> putScheduledActionRequest)
                                               throws ValidationException,
LimitExceededException,
ObjectNotFoundException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the PutScheduledActionRequest.Builder avoiding the need to create one manually via PutScheduledActionRequest.builder()

Parameters:

putScheduledActionRequest - A Consumer that will call methods on PutScheduledActionRequest.Builder to create a request.

Returns:

Result of the PutScheduledAction operation returned by the service.

See Also:

• AWS API Documentation

registerScalableTarget

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

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.

Parameters:

registerScalableTargetRequest -

Returns:

Result of the RegisterScalableTarget operation returned by the service.

See Also:

• AWS API Documentation

registerScalableTarget

default RegisterScalableTargetResponse registerScalableTarget(Consumer<RegisterScalableTargetRequest.Builder> registerScalableTargetRequest)
                                                       throws ValidationException,
LimitExceededException,
ConcurrentUpdateException,
InternalServiceException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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.

This is a convenience which creates an instance of the RegisterScalableTargetRequest.Builder avoiding the need to create one manually via RegisterScalableTargetRequest.builder()

Parameters:

registerScalableTargetRequest - A Consumer that will call methods on RegisterScalableTargetRequest.Builder to create a request.

Returns:

Result of the RegisterScalableTarget operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
TooManyTagsException,
ValidationException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
TooManyTagsException,
ValidationException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ApplicationAutoScalingException

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

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ApplicationAutoScalingServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration