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 staticbuilder()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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteScalingPolicyRequest.builder()- Parameters:
deleteScalingPolicyRequest- AConsumerthat will call methods onDeleteScalingPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteScalingPolicy operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteScheduledActionRequest.builder()- Parameters:
deleteScheduledActionRequest- AConsumerthat will call methods onDeleteScheduledActionRequest.Builderto create a request.- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeregisterScalableTargetRequest.builder()- Parameters:
deregisterScalableTargetRequest- AConsumerthat will call methods onDeregisterScalableTargetRequest.Builderto create a request.- Returns:
- Result of the DeregisterScalableTarget operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
ResourceIdsandScalableDimension.- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
ResourceIdsandScalableDimension.
This is a convenience which creates an instance of the
DescribeScalableTargetsRequest.Builderavoiding the need to create one manually viaDescribeScalableTargetsRequest.builder()- Parameters:
describeScalableTargetsRequest- AConsumerthat will call methods onDescribeScalableTargetsRequest.Builderto create a request.- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalableTargetsIterable responses = client.describeScalableTargetsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaDescribeScalableTargetsRequest.builder()- Parameters:
describeScalableTargetsRequest- AConsumerthat will call methods onDescribeScalableTargetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
ResourceIdandScalableDimension.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.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
ResourceIdandScalableDimension.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.Builderavoiding the need to create one manually viaDescribeScalingActivitiesRequest.builder()- Parameters:
describeScalingActivitiesRequest- AConsumerthat will call methods onDescribeScalingActivitiesRequest.Builderto create a request.- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaDescribeScalingActivitiesRequest.builder()- Parameters:
describeScalingActivitiesRequest- AConsumerthat will call methods onDescribeScalingActivitiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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, andPolicyNames.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.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException- Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException- The next token supplied was invalid.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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, andPolicyNames.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.Builderavoiding the need to create one manually viaDescribeScalingPoliciesRequest.builder()- Parameters:
describeScalingPoliciesRequest- AConsumerthat will call methods onDescribeScalingPoliciesRequest.Builderto create a request.- Returns:
- Result of the DescribeScalingPolicies operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException- Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException- The next token supplied was invalid.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException- Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException- The next token supplied was invalid.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaDescribeScalingPoliciesRequest.builder()- Parameters:
describeScalingPoliciesRequest- AConsumerthat will call methods onDescribeScalingPoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException- Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InvalidNextTokenException- The next token supplied was invalid.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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, andScheduledActionNamesparameters.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.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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, andScheduledActionNamesparameters.For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeScheduledActionsRequest.Builderavoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()- Parameters:
describeScheduledActionsRequest- AConsumerthat will call methods onDescribeScheduledActionsRequest.Builderto create a request.- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException- The next token supplied was invalid.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.applicationautoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()- Parameters:
describeScheduledActionsRequest- AConsumerthat will call methods onDescribeScheduledActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPredictiveScalingForecast
default GetPredictiveScalingForecastResponse getPredictiveScalingForecast(GetPredictiveScalingForecastRequest getPredictiveScalingForecastRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
- Parameters:
getPredictiveScalingForecastRequest-- Returns:
- Result of the GetPredictiveScalingForecast operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPredictiveScalingForecast
default GetPredictiveScalingForecastResponse getPredictiveScalingForecast(Consumer<GetPredictiveScalingForecastRequest.Builder> getPredictiveScalingForecastRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, ApplicationAutoScalingException
Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
This is a convenience which creates an instance of the
GetPredictiveScalingForecastRequest.Builderavoiding the need to create one manually viaGetPredictiveScalingForecastRequest.builder()- Parameters:
getPredictiveScalingForecastRequest- AConsumerthat will call methods onGetPredictiveScalingForecastRequest.Builderto create a request.- Returns:
- Result of the GetPredictiveScalingForecast operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The specified resource doesn't exist.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource doesn't exist.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.FailedResourceAccessException- Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaPutScalingPolicyRequest.builder()- Parameters:
putScalingPolicyRequest- AConsumerthat will call methods onPutScalingPolicyRequest.Builderto create a request.- Returns:
- Result of the PutScalingPolicy operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.FailedResourceAccessException- Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaPutScheduledActionRequest.builder()- Parameters:
putScheduledActionRequest- AConsumerthat will call methods onPutScheduledActionRequest.Builderto create a request.- Returns:
- Result of the PutScheduledAction operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException- The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
RegisterScalableTargetAPI 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
RegisterScalableTargetAPI 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 theMinCapacityorMaxCapacityrequest parameters.- Parameters:
registerScalableTargetRequest-- Returns:
- Result of the RegisterScalableTarget operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
RegisterScalableTargetAPI 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
RegisterScalableTargetAPI 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 theMinCapacityorMaxCapacityrequest parameters.
This is a convenience which creates an instance of the
RegisterScalableTargetRequest.Builderavoiding the need to create one manually viaRegisterScalableTargetRequest.builder()- Parameters:
registerScalableTargetRequest- AConsumerthat will call methods onRegisterScalableTargetRequest.Builderto create a request.- Returns:
- Result of the RegisterScalableTarget operation returned by the service.
- Throws:
ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ConcurrentUpdateException- Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.InternalServiceException- The service encountered an internal error.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The specified resource doesn't exist.TooManyTagsException- The request contains too many tags. Try the request again with fewer tags.ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource doesn't exist.TooManyTagsException- The request contains too many tags. Try the request again with fewer tags.ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- Throws:
ResourceNotFoundException- The specified resource doesn't exist.ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource doesn't exist.ValidationException- An exception was thrown for a validation issue. Review the available parameters for the API request.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ApplicationAutoScalingClient create()
Create aApplicationAutoScalingClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ApplicationAutoScalingClientBuilder builder()
Create a builder that can be used to configure and create aApplicationAutoScalingClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ApplicationAutoScalingServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-