com.amazonaws.services.autoscalingplans

Interface AWSAutoScalingPlans

All Known Subinterfaces:

AWSAutoScalingPlansAsync

All Known Implementing Classes:

AbstractAWSAutoScalingPlans, AbstractAWSAutoScalingPlansAsync, AWSAutoScalingPlansAsyncClient, AWSAutoScalingPlansClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAutoScalingPlans

Interface for accessing AWS Auto Scaling Plans.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAutoScalingPlans 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateScalingPlanResult	createScalingPlan(CreateScalingPlanRequest createScalingPlanRequest) Creates a scaling plan.
DeleteScalingPlanResult	deleteScalingPlan(DeleteScalingPlanRequest deleteScalingPlanRequest) Deletes the specified scaling plan.
DescribeScalingPlanResourcesResult	describeScalingPlanResources(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest) Describes the scalable resources in the specified scaling plan.
DescribeScalingPlansResult	describeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest) Describes one or more of your scaling plans.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetScalingPlanResourceForecastDataResult	getScalingPlanResourceForecastData(GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest) Retrieves the forecast data for a scalable resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateScalingPlanResult	updateScalingPlan(UpdateScalingPlanRequest updateScalingPlanRequest) Updates the specified scaling plan.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createScalingPlan

CreateScalingPlanResult createScalingPlan(CreateScalingPlanRequest createScalingPlanRequest)

Creates a scaling plan.

Parameters:

createScalingPlanRequest -

Returns:

Result of the CreateScalingPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteScalingPlan

DeleteScalingPlanResult 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:

Result of the DeleteScalingPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeScalingPlanResources

DescribeScalingPlanResourcesResult describeScalingPlanResources(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest)

Describes the scalable resources in the specified scaling plan.

Parameters:

describeScalingPlanResourcesRequest -

Returns:

Result of the DescribeScalingPlanResources operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeScalingPlans

DescribeScalingPlansResult describeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest)

Describes one or more of your scaling plans.

Parameters:

describeScalingPlansRequest -

Returns:

Result of the DescribeScalingPlans operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getScalingPlanResourceForecastData

GetScalingPlanResourceForecastDataResult 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:

Result of the GetScalingPlanResourceForecastData operation returned by the service.

Throws:

ValidationException - An exception was thrown for a validation issue. Review the parameters provided.

InternalServiceException - The service encountered an internal error.

See Also:

AWS API Documentation

updateScalingPlan

UpdateScalingPlanResult 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:

Result of the UpdateScalingPlan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.