@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSApplicationAutoScalingClient extends AmazonWebServiceClient implements AWSApplicationAutoScaling
With Application Auto Scaling, you can automatically scale your AWS resources. The experience is similar to that of Auto Scaling. You can use Application Auto Scaling to accomplish the following tasks:
Define scaling policies to automatically scale your AWS resources
Scale your resources in response to CloudWatch alarms
View the history of your scaling events
Application Auto Scaling can scale the following AWS resources:
Amazon ECS services. For more information, see Service Auto Scaling in the Amazon EC2 Container Service Developer Guide.
Amazon EC2 Spot fleets. For more information, see Automatic Scaling for Spot Fleet in the Amazon EC2 User Guide.
Amazon EMR clusters. For more information, see Using Automatic Scaling in Amazon EMR in the Amazon EMR Management Guide.
AppStream 2.0 fleets. For more information, see Fleet Auto Scaling for Amazon AppStream 2.0 in the Amazon AppStream 2.0 Developer Guide.
Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see Managing Throughput Capacity Automatically with DynamoDB Auto Scaling in the Amazon DynamoDB Developer Guide.
For a list of supported regions, see AWS Regions and Endpoints: Application Auto Scaling in the AWS General Reference.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSApplicationAutoScalingClient()
Deprecated.
|
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSApplicationAutoScalingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSApplicationAutoScalingClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSApplicationAutoScalingClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AWSApplicationAutoScalingClientBuilder |
builder() |
DeleteScalingPolicyResult |
deleteScalingPolicy(DeleteScalingPolicyRequest request)
Deletes the specified Application Auto Scaling scaling policy.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified Application Auto Scaling scheduled action.
|
DeregisterScalableTargetResult |
deregisterScalableTarget(DeregisterScalableTargetRequest request)
Deregisters a scalable target.
|
DescribeScalableTargetsResult |
describeScalableTargets(DescribeScalableTargetsRequest request)
Provides descriptive information about the scalable targets in the specified namespace.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest request)
Provides descriptive information about the scaling activities in the specified namespace from the previous six
weeks.
|
DescribeScalingPoliciesResult |
describeScalingPolicies(DescribeScalingPoliciesRequest request)
Describes the scaling policies for the specified service namespace.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the scheduled actions for the specified service namespace.
|
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.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a policy for an Application Auto Scaling scalable target.
|
PutScheduledActionResult |
putScheduledAction(PutScheduledActionRequest request)
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
|
RegisterScalableTargetResult |
registerScalableTarget(RegisterScalableTargetRequest request)
Registers or updates a scalable target.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AWSApplicationAutoScalingClient()
AWSApplicationAutoScalingClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSApplicationAutoScalingClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSApplicationAutoScalingClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSApplicationAutoScalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).@Deprecated public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).@Deprecated public AWSApplicationAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Application Auto Scaling (ex:
proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSApplicationAutoScalingClientBuilder builder()
public DeleteScalingPolicyResult deleteScalingPolicy(DeleteScalingPolicyRequest request)
Deletes the specified Application Auto Scaling scaling policy.
Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.
To create a scaling policy or update an existing one, see PutScalingPolicy.
deleteScalingPolicy in interface AWSApplicationAutoScalingdeleteScalingPolicyRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any Put or Register API operation,
which depends on the existence of a scalable target, this exception is thrown if the scalable target with
the specified service namespace, resource ID, and scalable dimension does not exist. For any
Delete or Deregister API operation, this exception is thrown if the resource
that is to be deleted or deregistered cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
DeleteScalingPolicyRequest request = new DeleteScalingPolicyRequest()
.withPolicyName("web-app-cpu-lt-25")
.withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount")
.withServiceNamespace("ecs");
DeleteScalingPolicyResult response = client
.deleteScalingPolicy(request);public DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified Application Auto Scaling scheduled action.
deleteScheduledAction in interface AWSApplicationAutoScalingdeleteScheduledActionRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any Put or Register API operation,
which depends on the existence of a scalable target, this exception is thrown if the scalable target with
the specified service namespace, resource ID, and scalable dimension does not exist. For any
Delete or Deregister API operation, this exception is thrown if the resource
that is to be deleted or deregistered cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.public DeregisterScalableTargetResult deregisterScalableTarget(DeregisterScalableTargetRequest request)
Deregisters a scalable target.
Deregistering a scalable target deletes the scaling policies that are associated with it.
To create a scalable target or update an existing one, see RegisterScalableTarget.
deregisterScalableTarget in interface AWSApplicationAutoScalingderegisterScalableTargetRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.ObjectNotFoundException - The specified object could not be found. For any Put or Register API operation,
which depends on the existence of a scalable target, this exception is thrown if the scalable target with
the specified service namespace, resource ID, and scalable dimension does not exist. For any
Delete or Deregister API operation, this exception is thrown if the resource
that is to be deleted or deregistered cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
DeregisterScalableTargetRequest request = new DeregisterScalableTargetRequest()
.withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount")
.withServiceNamespace("ecs");
DeregisterScalableTargetResult response = client
.deregisterScalableTarget(request);public DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest request)
Provides descriptive information about the scalable targets in the specified namespace.
You can filter the results using the ResourceIds and ScalableDimension parameters.
To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.
describeScalableTargets in interface AWSApplicationAutoScalingdescribeScalableTargetsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
DescribeScalableTargetsRequest request = new DescribeScalableTargetsRequest()
.withServiceNamespace("ecs");
DescribeScalableTargetsResult response = client
.describeScalableTargets(request);public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest request)
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using the ResourceId and ScalableDimension parameters.
Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.
describeScalingActivities in interface AWSApplicationAutoScalingdescribeScalingActivitiesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
DescribeScalingActivitiesRequest request = new DescribeScalingActivitiesRequest()
.withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount")
.withServiceNamespace("ecs");
DescribeScalingActivitiesResult response = client
.describeScalingActivities(request);public DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest request)
Describes the scaling policies for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
PolicyNames parameters.
To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
describeScalingPolicies in interface AWSApplicationAutoScalingdescribeScalingPoliciesRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms API operation on behalf of your account.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
DescribeScalingPoliciesRequest request = new DescribeScalingPoliciesRequest()
.withServiceNamespace("ecs");
DescribeScalingPoliciesResult response = client
.describeScalingPolicies(request);public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the scheduled actions for the specified service namespace.
You can filter the results using the ResourceId, ScalableDimension, and
ScheduledActionNames parameters.
To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.
describeScheduledActions in interface AWSApplicationAutoScalingdescribeScheduledActionsRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.InvalidNextTokenException - The next token supplied was invalid.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a policy for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using RegisterScalableTarget.
To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.
You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.
putScalingPolicy in interface AWSApplicationAutoScalingputScalingPolicyRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.
For more information, see Application
Auto Scaling Limits.ObjectNotFoundException - The specified object could not be found. For any Put or Register API operation,
which depends on the existence of a scalable target, this exception is thrown if the scalable target with
the specified service namespace, resource ID, and scalable dimension does not exist. For any
Delete or Deregister API operation, this exception is thrown if the resource
that is to be deleted or deregistered cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.FailedResourceAccessException - Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is
unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the
role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms API operation on behalf of your account.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
PutScalingPolicyRequest request = new PutScalingPolicyRequest()
.withPolicyName("web-app-cpu-gt-75")
.withPolicyType("StepScaling")
.withResourceId("service/default/web-app")
.withScalableDimension("ecs:service:DesiredCount")
.withServiceNamespace("ecs")
.withStepScalingPolicyConfiguration(
new StepScalingPolicyConfiguration()
.withAdjustmentType("PercentChangeInCapacity")
.withCooldown(60)
.withStepAdjustments(
new StepAdjustment()
.withMetricIntervalLowerBound(
0d)
.withScalingAdjustment(200)));
PutScalingPolicyResult response = client.putScalingPolicy(request);
AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
PutScalingPolicyRequest request = new PutScalingPolicyRequest()
.withPolicyName("fleet-cpu-gt-75")
.withPolicyType("StepScaling")
.withResourceId(
"spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3")
.withScalableDimension("ec2:spot-fleet-request:TargetCapacity")
.withServiceNamespace("ec2")
.withStepScalingPolicyConfiguration(
new StepScalingPolicyConfiguration()
.withAdjustmentType("PercentChangeInCapacity")
.withCooldown(180)
.withStepAdjustments(
new StepAdjustment()
.withMetricIntervalLowerBound(
0d)
.withScalingAdjustment(200)));
PutScalingPolicyResult response = client.putScalingPolicy(request);public PutScheduledActionResult putScheduledAction(PutScheduledActionRequest request)
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action without first registering a scalable target using RegisterScalableTarget.
To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.
You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.
putScheduledAction in interface AWSApplicationAutoScalingputScheduledActionRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.
For more information, see Application
Auto Scaling Limits.ObjectNotFoundException - The specified object could not be found. For any Put or Register API operation,
which depends on the existence of a scalable target, this exception is thrown if the scalable target with
the specified service namespace, resource ID, and scalable dimension does not exist. For any
Delete or Deregister API operation, this exception is thrown if the resource
that is to be deleted or deregistered cannot be found.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.public RegisterScalableTargetResult registerScalableTarget(RegisterScalableTargetRequest request)
Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.
After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.
registerScalableTarget in interface AWSApplicationAutoScalingregisterScalableTargetRequest - ValidationException - An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException - Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.
For more information, see Application
Auto Scaling Limits.ConcurrentUpdateException - Concurrent updates caused an exception, for example, if you request an update to an Application Auto
Scaling resource that already has a pending update.InternalServiceException - The service encountered an internal error.AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
RegisterScalableTargetRequest request = new RegisterScalableTargetRequest()
.withMaxCapacity(10)
.withMinCapacity(1)
.withResourceId("service/default/web-app")
.withRoleARN(
"arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole")
.withScalableDimension("ecs:service:DesiredCount")
.withServiceNamespace("ecs");
RegisterScalableTargetResult response = client
.registerScalableTarget(request);AWSApplicationAutoScaling client = new AWSApplicationAutoScalingClient();
RegisterScalableTargetRequest request = new RegisterScalableTargetRequest()
.withMaxCapacity(10)
.withMinCapacity(1)
.withResourceId(
"spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3")
.withRoleARN(
"arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole")
.withScalableDimension("ec2:spot-fleet-request:TargetCapacity")
.withServiceNamespace("ec2");
RegisterScalableTargetResult response = client
.registerScalableTarget(request);public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest 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.
getCachedResponseMetadata in interface AWSApplicationAutoScalingrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.