@Generated(value="software.amazon.awssdk:codegen") public interface AutoScalingPlansClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static AutoScalingPlansClient create()
AutoScalingPlansClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static AutoScalingPlansClientBuilder builder()
AutoScalingPlansClient
.default CreateScalingPlanResponse createScalingPlan(CreateScalingPlanRequest createScalingPlanRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
Creates a scaling plan.
createScalingPlanRequest
- 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.AwsServiceException
default CreateScalingPlanResponse createScalingPlan(Consumer<CreateScalingPlanRequest.Builder> createScalingPlanRequest) throws ValidationException, LimitExceededException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
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()
createScalingPlanRequest
- A Consumer
that will call methods on CreateScalingPlanRequest.Builder
to create a request.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.AwsServiceException
default DeleteScalingPlanResponse deleteScalingPlan(DeleteScalingPlanRequest deleteScalingPlanRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
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.
deleteScalingPlanRequest
- 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.AwsServiceException
default DeleteScalingPlanResponse deleteScalingPlan(Consumer<DeleteScalingPlanRequest.Builder> deleteScalingPlanRequest) throws ValidationException, ObjectNotFoundException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
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()
deleteScalingPlanRequest
- A Consumer
that will call methods on DeleteScalingPlanRequest.Builder
to create a request.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.AwsServiceException
default DescribeScalingPlanResourcesResponse describeScalingPlanResources(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
Describes the scalable resources in the specified scaling plan.
describeScalingPlanResourcesRequest
- 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.AwsServiceException
default DescribeScalingPlanResourcesResponse describeScalingPlanResources(Consumer<DescribeScalingPlanResourcesRequest.Builder> describeScalingPlanResourcesRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
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()
describeScalingPlanResourcesRequest
- A Consumer
that will call methods on DescribeScalingPlanResourcesRequest.Builder
to create
a request.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.AwsServiceException
default DescribeScalingPlansResponse describeScalingPlans() throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
Describes one or more of your scaling plans.
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.AwsServiceException
describeScalingPlans(DescribeScalingPlansRequest)
,
AWS API Documentationdefault DescribeScalingPlansResponse describeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
Describes one or more of your scaling plans.
describeScalingPlansRequest
- 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.AwsServiceException
default DescribeScalingPlansResponse describeScalingPlans(Consumer<DescribeScalingPlansRequest.Builder> describeScalingPlansRequest) throws ValidationException, InvalidNextTokenException, ConcurrentUpdateException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
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()
describeScalingPlansRequest
- A Consumer
that will call methods on DescribeScalingPlansRequest.Builder
to create a
request.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.AwsServiceException
default GetScalingPlanResourceForecastDataResponse getScalingPlanResourceForecastData(GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
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.
getScalingPlanResourceForecastDataRequest
- 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.AwsServiceException
default GetScalingPlanResourceForecastDataResponse getScalingPlanResourceForecastData(Consumer<GetScalingPlanResourceForecastDataRequest.Builder> getScalingPlanResourceForecastDataRequest) throws ValidationException, InternalServiceException, AwsServiceException, SdkClientException, AutoScalingPlansException
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()
getScalingPlanResourceForecastDataRequest
- A Consumer
that will call methods on GetScalingPlanResourceForecastDataRequest.Builder
to
create a request.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.AwsServiceException
default UpdateScalingPlanResponse updateScalingPlan(UpdateScalingPlanRequest updateScalingPlanRequest) throws ValidationException, ConcurrentUpdateException, InternalServiceException, ObjectNotFoundException, AwsServiceException, SdkClientException, AutoScalingPlansException
Updates the specified scaling plan.
You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
updateScalingPlanRequest
- 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.AwsServiceException
default UpdateScalingPlanResponse updateScalingPlan(Consumer<UpdateScalingPlanRequest.Builder> updateScalingPlanRequest) throws ValidationException, ConcurrentUpdateException, InternalServiceException, ObjectNotFoundException, AwsServiceException, SdkClientException, AutoScalingPlansException
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()
updateScalingPlanRequest
- A Consumer
that will call methods on UpdateScalingPlanRequest.Builder
to create a request.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.AwsServiceException
static ServiceMetadata serviceMetadata()