*
* 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSAutoScalingPlansClient extends AmazonWebServiceClient implements AWSAutoScalingPlans { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSAutoScalingPlans.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "autoscaling-plans"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.autoscalingplans.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServiceException").withExceptionUnmarshaller( com.amazonaws.services.autoscalingplans.model.transform.InternalServiceExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidNextTokenException").withExceptionUnmarshaller( com.amazonaws.services.autoscalingplans.model.transform.InvalidNextTokenExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ObjectNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.autoscalingplans.model.transform.ObjectNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("LimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.autoscalingplans.model.transform.LimitExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConcurrentUpdateException").withExceptionUnmarshaller( com.amazonaws.services.autoscalingplans.model.transform.ConcurrentUpdateExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.autoscalingplans.model.AWSAutoScalingPlansException.class)); public static AWSAutoScalingPlansClientBuilder builder() { return AWSAutoScalingPlansClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS Auto Scaling Plans using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSAutoScalingPlansClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS Auto Scaling Plans using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSAutoScalingPlansClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("autoscaling.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/autoscalingplans/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/autoscalingplans/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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 */ @Override public CreateScalingPlanResult createScalingPlan(CreateScalingPlanRequest request) { request = beforeClientExecution(request); return executeCreateScalingPlan(request); } @SdkInternalApi final CreateScalingPlanResult executeCreateScalingPlan(CreateScalingPlanRequest createScalingPlanRequest) { ExecutionContext executionContext = createExecutionContext(createScalingPlanRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public DeleteScalingPlanResult deleteScalingPlan(DeleteScalingPlanRequest request) { request = beforeClientExecution(request); return executeDeleteScalingPlan(request); } @SdkInternalApi final DeleteScalingPlanResult executeDeleteScalingPlan(DeleteScalingPlanRequest deleteScalingPlanRequest) { ExecutionContext executionContext = createExecutionContext(deleteScalingPlanRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public DescribeScalingPlanResourcesResult describeScalingPlanResources(DescribeScalingPlanResourcesRequest request) { request = beforeClientExecution(request); return executeDescribeScalingPlanResources(request); } @SdkInternalApi final DescribeScalingPlanResourcesResult executeDescribeScalingPlanResources(DescribeScalingPlanResourcesRequest describeScalingPlanResourcesRequest) { ExecutionContext executionContext = createExecutionContext(describeScalingPlanResourcesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public DescribeScalingPlansResult describeScalingPlans(DescribeScalingPlansRequest request) { request = beforeClientExecution(request); return executeDescribeScalingPlans(request); } @SdkInternalApi final DescribeScalingPlansResult executeDescribeScalingPlans(DescribeScalingPlansRequest describeScalingPlansRequest) { ExecutionContext executionContext = createExecutionContext(describeScalingPlansRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public GetScalingPlanResourceForecastDataResult getScalingPlanResourceForecastData(GetScalingPlanResourceForecastDataRequest request) { request = beforeClientExecution(request); return executeGetScalingPlanResourceForecastData(request); } @SdkInternalApi final GetScalingPlanResourceForecastDataResult executeGetScalingPlanResourceForecastData( GetScalingPlanResourceForecastDataRequest getScalingPlanResourceForecastDataRequest) { ExecutionContext executionContext = createExecutionContext(getScalingPlanResourceForecastDataRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public UpdateScalingPlanResult updateScalingPlan(UpdateScalingPlanRequest request) { request = beforeClientExecution(request); return executeUpdateScalingPlan(request); } @SdkInternalApi final UpdateScalingPlanResult executeUpdateScalingPlan(UpdateScalingPlanRequest updateScalingPlanRequest) { ExecutionContext executionContext = createExecutionContext(updateScalingPlanRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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 the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private