com.amazonaws.services.autoscalingplans

Class AWSAutoScalingPlansClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.autoscalingplans.AWSAutoScalingPlansClient

All Implemented Interfaces:

AWSAutoScalingPlans

Direct Known Subclasses:

AWSAutoScalingPlansAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSAutoScalingPlansClient
extends AmazonWebServiceClient
implements AWSAutoScalingPlans

Client for accessing AWS Auto Scaling Plans. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Auto Scaling

Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.

To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.autoscalingplans.AWSAutoScalingPlans

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSAutoScalingPlansClientBuilder	builder()
CreateScalingPlanResult	createScalingPlan(CreateScalingPlanRequest request) Creates a scaling plan.
DeleteScalingPlanResult	deleteScalingPlan(DeleteScalingPlanRequest request) Deletes the specified scaling plan.
DescribeScalingPlanResourcesResult	describeScalingPlanResources(DescribeScalingPlanResourcesRequest request) Describes the scalable resources in the specified scaling plan.
DescribeScalingPlansResult	describeScalingPlans(DescribeScalingPlansRequest request) Describes the specified scaling plans or all 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.
UpdateScalingPlanResult	updateScalingPlan(UpdateScalingPlanRequest request) Updates the scaling plan for the specified scaling plan.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.autoscalingplans.AWSAutoScalingPlans

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSAutoScalingPlansClientBuilder builder()

createScalingPlan

public CreateScalingPlanResult createScalingPlan(CreateScalingPlanRequest request)

Creates a scaling plan.

A scaling plan contains a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions in your scaling plan.

Specified by:

createScalingPlan in interface AWSAutoScalingPlans

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

public DeleteScalingPlanResult deleteScalingPlan(DeleteScalingPlanRequest request)

Deletes the specified scaling plan.

Specified by:

deleteScalingPlan in interface AWSAutoScalingPlans

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

public DescribeScalingPlanResourcesResult describeScalingPlanResources(DescribeScalingPlanResourcesRequest request)

Describes the scalable resources in the specified scaling plan.

Specified by:

describeScalingPlanResources in interface AWSAutoScalingPlans

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

public DescribeScalingPlansResult describeScalingPlans(DescribeScalingPlansRequest request)

Describes the specified scaling plans or all of your scaling plans.

Specified by:

describeScalingPlans in interface AWSAutoScalingPlans

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

updateScalingPlan

public UpdateScalingPlanResult updateScalingPlan(UpdateScalingPlanRequest request)

Updates the scaling plan for the specified scaling plan.

You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

Specified by:

updateScalingPlan in interface AWSAutoScalingPlans

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSAutoScalingPlans

Parameters:

request - The originally executed request

Returns:

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