com.amazonaws.services.autoscalingplans.AWSAutoScalingPlansAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-autoscalingplans Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.autoscalingplans;
import javax.annotation.Generated;
import com.amazonaws.services.autoscalingplans.model.*;
/**
* Interface for accessing AWS Auto Scaling Plans asynchronously. Each asynchronous method will return a Java Future
* object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.autoscalingplans.AbstractAWSAutoScalingPlansAsync} instead.
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAutoScalingPlansAsync extends AWSAutoScalingPlans {
/**
*
* Creates a scaling plan.
*
*
* @param createScalingPlanRequest
* @return A Java Future containing the result of the CreateScalingPlan operation returned by the service.
* @sample AWSAutoScalingPlansAsync.CreateScalingPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future createScalingPlanAsync(CreateScalingPlanRequest createScalingPlanRequest);
/**
*
* Creates a scaling plan.
*
*
* @param createScalingPlanRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateScalingPlan operation returned by the service.
* @sample AWSAutoScalingPlansAsyncHandler.CreateScalingPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future createScalingPlanAsync(CreateScalingPlanRequest createScalingPlanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteScalingPlanRequest
* @return A Java Future containing the result of the DeleteScalingPlan operation returned by the service.
* @sample AWSAutoScalingPlansAsync.DeleteScalingPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteScalingPlanAsync(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.
*
*
* @param deleteScalingPlanRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteScalingPlan operation returned by the service.
* @sample AWSAutoScalingPlansAsyncHandler.DeleteScalingPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteScalingPlanAsync(DeleteScalingPlanRequest deleteScalingPlanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes the scalable resources in the specified scaling plan.
*
*
* @param describeScalingPlanResourcesRequest
* @return A Java Future containing the result of the DescribeScalingPlanResources operation returned by the
* service.
* @sample AWSAutoScalingPlansAsync.DescribeScalingPlanResources
* @see AWS API Documentation
*/
java.util.concurrent.Future describeScalingPlanResourcesAsync(
DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest);
/**
*
* Describes the scalable resources in the specified scaling plan.
*
*
* @param describeScalingPlanResourcesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeScalingPlanResources operation returned by the
* service.
* @sample AWSAutoScalingPlansAsyncHandler.DescribeScalingPlanResources
* @see AWS API Documentation
*/
java.util.concurrent.Future describeScalingPlanResourcesAsync(
DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes one or more of your scaling plans.
*
*
* @param describeScalingPlansRequest
* @return A Java Future containing the result of the DescribeScalingPlans operation returned by the service.
* @sample AWSAutoScalingPlansAsync.DescribeScalingPlans
* @see AWS API Documentation
*/
java.util.concurrent.Future describeScalingPlansAsync(DescribeScalingPlansRequest describeScalingPlansRequest);
/**
*
* Describes one or more of your scaling plans.
*
*
* @param describeScalingPlansRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeScalingPlans operation returned by the service.
* @sample AWSAutoScalingPlansAsyncHandler.DescribeScalingPlans
* @see AWS API Documentation
*/
java.util.concurrent.Future describeScalingPlansAsync(DescribeScalingPlansRequest describeScalingPlansRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getScalingPlanResourceForecastDataRequest
* @return A Java Future containing the result of the GetScalingPlanResourceForecastData operation returned by the
* service.
* @sample AWSAutoScalingPlansAsync.GetScalingPlanResourceForecastData
* @see AWS API Documentation
*/
java.util.concurrent.Future getScalingPlanResourceForecastDataAsync(
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.
*
*
* @param getScalingPlanResourceForecastDataRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetScalingPlanResourceForecastData operation returned by the
* service.
* @sample AWSAutoScalingPlansAsyncHandler.GetScalingPlanResourceForecastData
* @see AWS API Documentation
*/
java.util.concurrent.Future getScalingPlanResourceForecastDataAsync(
GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the specified scaling plan.
*
*
* You cannot update a scaling plan if it is in the process of being created, updated, or deleted.
*
*
* @param updateScalingPlanRequest
* @return A Java Future containing the result of the UpdateScalingPlan operation returned by the service.
* @sample AWSAutoScalingPlansAsync.UpdateScalingPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future updateScalingPlanAsync(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.
*
*
* @param updateScalingPlanRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateScalingPlan operation returned by the service.
* @sample AWSAutoScalingPlansAsyncHandler.UpdateScalingPlan
* @see AWS API Documentation
*/
java.util.concurrent.Future updateScalingPlanAsync(UpdateScalingPlanRequest updateScalingPlanRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}