* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.autoscalingplans.AbstractAWSAutoScalingPlans} instead. *
*
*
* 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 AWSAutoScalingPlans { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "autoscaling-plans"; /** ** Creates a scaling plan. *
* * @param createScalingPlanRequest * @return Result of the CreateScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws LimitExceededException * Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @sample AWSAutoScalingPlans.CreateScalingPlan * @see AWS API Documentation */ CreateScalingPlanResult createScalingPlan(CreateScalingPlanRequest createScalingPlanRequest); /** ** 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 Result of the DeleteScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws ObjectNotFoundException * The specified object could not be found. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @sample AWSAutoScalingPlans.DeleteScalingPlan * @see AWS API Documentation */ DeleteScalingPlanResult deleteScalingPlan(DeleteScalingPlanRequest deleteScalingPlanRequest); /** ** Describes the scalable resources in the specified scaling plan. *
* * @param describeScalingPlanResourcesRequest * @return Result of the DescribeScalingPlanResources operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InvalidNextTokenException * The token provided is not valid. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @sample AWSAutoScalingPlans.DescribeScalingPlanResources * @see AWS API Documentation */ DescribeScalingPlanResourcesResult describeScalingPlanResources(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest); /** ** Describes one or more of your scaling plans. *
* * @param describeScalingPlansRequest * @return Result of the DescribeScalingPlans operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InvalidNextTokenException * The token provided is not valid. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @sample AWSAutoScalingPlans.DescribeScalingPlans * @see AWS API Documentation */ DescribeScalingPlansResult describeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest); /** ** 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 Result of the GetScalingPlanResourceForecastData operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws InternalServiceException * The service encountered an internal error. * @sample AWSAutoScalingPlans.GetScalingPlanResourceForecastData * @see AWS API Documentation */ GetScalingPlanResourceForecastDataResult getScalingPlanResourceForecastData( GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest); /** ** 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 Result of the UpdateScalingPlan operation returned by the service. * @throws ValidationException * An exception was thrown for a validation issue. Review the parameters provided. * @throws ConcurrentUpdateException * Concurrent updates caused an exception, for example, if you request an update to a scaling plan that * already has a pending update. * @throws InternalServiceException * The service encountered an internal error. * @throws ObjectNotFoundException * The specified object could not be found. * @sample AWSAutoScalingPlans.UpdateScalingPlan * @see AWS API Documentation */ UpdateScalingPlanResult updateScalingPlan(UpdateScalingPlanRequest updateScalingPlanRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. ** Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }