Package software.amazon.awssdk.services.autoscalingplans

Interface AutoScalingPlansAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AutoScalingPlansAsyncClient extends AwsClient
Service client for accessing AWS Auto Scaling Plans asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. AWS Auto Scaling

Use AWS Auto Scaling to create scaling plans for your applications to automatically scale your scalable AWS resources.

API Summary

You can use the AWS Auto Scaling service API to accomplish the following tasks:

  • Create and manage scaling plans

  • Define target tracking scaling policies to dynamically scale your resources based on utilization

  • Scale Amazon EC2 Auto Scaling groups using predictive scaling and dynamic scaling to scale your Amazon EC2 capacity faster

  • Set minimum and maximum capacity limits

  • Retrieve information on existing scaling plans

  • Access current forecast data and historical forecast data for up to 56 days previous

To learn more about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.

  • Field Details

  • Method Details

    • createScalingPlan

      default CompletableFuture<CreateScalingPlanResponse> createScalingPlan(CreateScalingPlanRequest createScalingPlanRequest)

      Creates a scaling plan.

      Parameters:
      createScalingPlanRequest -
      Returns:
      A Java Future containing the result of the CreateScalingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • LimitExceededException Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createScalingPlan

      default CompletableFuture<CreateScalingPlanResponse> createScalingPlan(Consumer<CreateScalingPlanRequest.Builder> createScalingPlanRequest)

      Creates a scaling plan.


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

      Parameters:
      createScalingPlanRequest - A Consumer that will call methods on CreateScalingPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateScalingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • LimitExceededException Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteScalingPlan

      default CompletableFuture<DeleteScalingPlanResponse> deleteScalingPlan(DeleteScalingPlanRequest deleteScalingPlanRequest)

      Deletes the specified scaling plan.

      Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.

      If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.

      Parameters:
      deleteScalingPlanRequest -
      Returns:
      A Java Future containing the result of the DeleteScalingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • ObjectNotFoundException The specified object could not be found.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteScalingPlan

      default CompletableFuture<DeleteScalingPlanResponse> deleteScalingPlan(Consumer<DeleteScalingPlanRequest.Builder> deleteScalingPlanRequest)

      Deletes the specified scaling plan.

      Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.

      If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.


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

      Parameters:
      deleteScalingPlanRequest - A Consumer that will call methods on DeleteScalingPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteScalingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • ObjectNotFoundException The specified object could not be found.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeScalingPlanResources

      default CompletableFuture<DescribeScalingPlanResourcesResponse> describeScalingPlanResources(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest)

      Describes the scalable resources in the specified scaling plan.

      Parameters:
      describeScalingPlanResourcesRequest -
      Returns:
      A Java Future containing the result of the DescribeScalingPlanResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • InvalidNextTokenException The token provided is not valid.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeScalingPlanResources

      default CompletableFuture<DescribeScalingPlanResourcesResponse> describeScalingPlanResources(Consumer<DescribeScalingPlanResourcesRequest.Builder> describeScalingPlanResourcesRequest)

      Describes the scalable resources in the specified scaling plan.


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

      Parameters:
      describeScalingPlanResourcesRequest - A Consumer that will call methods on DescribeScalingPlanResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeScalingPlanResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • InvalidNextTokenException The token provided is not valid.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeScalingPlans

      default CompletableFuture<DescribeScalingPlansResponse> describeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest)

      Describes one or more of your scaling plans.

      Parameters:
      describeScalingPlansRequest -
      Returns:
      A Java Future containing the result of the DescribeScalingPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • InvalidNextTokenException The token provided is not valid.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeScalingPlans

      default CompletableFuture<DescribeScalingPlansResponse> describeScalingPlans(Consumer<DescribeScalingPlansRequest.Builder> describeScalingPlansRequest)

      Describes one or more of your scaling plans.


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

      Parameters:
      describeScalingPlansRequest - A Consumer that will call methods on DescribeScalingPlansRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeScalingPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • InvalidNextTokenException The token provided is not valid.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeScalingPlans

      default CompletableFuture<DescribeScalingPlansResponse> describeScalingPlans()

      Describes one or more of your scaling plans.

      Returns:
      A Java Future containing the result of the DescribeScalingPlans operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • InvalidNextTokenException The token provided is not valid.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getScalingPlanResourceForecastData

      default CompletableFuture<GetScalingPlanResourceForecastDataResponse> getScalingPlanResourceForecastData(GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest)

      Retrieves the forecast data for a scalable resource.

      Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

      Parameters:
      getScalingPlanResourceForecastDataRequest -
      Returns:
      A Java Future containing the result of the GetScalingPlanResourceForecastData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getScalingPlanResourceForecastData

      default CompletableFuture<GetScalingPlanResourceForecastDataResponse> getScalingPlanResourceForecastData(Consumer<GetScalingPlanResourceForecastDataRequest.Builder> getScalingPlanResourceForecastDataRequest)

      Retrieves the forecast data for a scalable resource.

      Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.


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

      Parameters:
      getScalingPlanResourceForecastDataRequest - A Consumer that will call methods on GetScalingPlanResourceForecastDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetScalingPlanResourceForecastData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateScalingPlan

      default CompletableFuture<UpdateScalingPlanResponse> updateScalingPlan(UpdateScalingPlanRequest updateScalingPlanRequest)

      Updates the specified scaling plan.

      You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

      Parameters:
      updateScalingPlanRequest -
      Returns:
      A Java Future containing the result of the UpdateScalingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.
      • InternalServiceException The service encountered an internal error.
      • ObjectNotFoundException The specified object could not be found.
      • 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateScalingPlan

      default CompletableFuture<UpdateScalingPlanResponse> updateScalingPlan(Consumer<UpdateScalingPlanRequest.Builder> updateScalingPlanRequest)

      Updates the specified scaling plan.

      You cannot update a scaling plan if it is in the process of being created, updated, or deleted.


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

      Parameters:
      updateScalingPlanRequest - A Consumer that will call methods on UpdateScalingPlanRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateScalingPlan operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException An exception was thrown for a validation issue. Review the parameters provided.
      • ConcurrentUpdateException Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.
      • InternalServiceException The service encountered an internal error.
      • ObjectNotFoundException The specified object could not be found.
      • 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.
      • AutoScalingPlansException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default AutoScalingPlansServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static AutoScalingPlansAsyncClient create()
      Create a AutoScalingPlansAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static AutoScalingPlansAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a AutoScalingPlansAsyncClient.