@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSApplicationAutoScalingClient extends AmazonWebServiceClient implements AWSApplicationAutoScaling
With Application Auto Scaling, you can configure automatic scaling for the following resources:
Amazon AppStream 2.0 fleets
Amazon Aurora Replicas
Amazon Comprehend document classification and entity recognizer endpoints
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon ECS services
Amazon ElastiCache for Redis clusters (replication groups)
Amazon EMR clusters
Amazon Keyspaces (for Apache Cassandra) tables
Lambda function provisioned concurrency
Amazon Managed Streaming for Apache Kafka broker storage
Amazon Neptune clusters
Amazon SageMaker endpoint variants
Amazon SageMaker inference components
Amazon SageMaker serverless endpoint provisioned concurrency
Spot Fleets (Amazon EC2)
Pool of WorkSpaces
Custom resources provided by your own applications or services
To learn more about Application Auto Scaling, see the Application Auto Scaling User Guide.
API Summary
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_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 scaling policy for an Application Auto Scaling scalable target.
|
DeleteScheduledActionResult |
deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
|
DeregisterScalableTargetResult |
deregisterScalableTarget(DeregisterScalableTargetRequest request)
Deregisters an Application Auto Scaling scalable target when you have finished using it.
|
DescribeScalableTargetsResult |
describeScalableTargets(DescribeScalableTargetsRequest request)
Gets 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 Application Auto Scaling scaling policies for the specified service namespace.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the Application Auto Scaling 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.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags on the specified Application Auto Scaling scalable target.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a scaling 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, which is the resource that you want to scale.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or edits tags on an Application Auto Scaling scalable target.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes tags from an Application Auto Scaling scalable target.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@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 scaling policy for an Application Auto Scaling scalable target.
Deleting a step scaling 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.
For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.
deleteScalingPolicy
in interface AWSApplicationAutoScaling
deleteScalingPolicyRequest
- 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 operation that 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 operation that deletes or deregisters a resource, this
exception is thrown if the resource 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 = AWSApplicationAutoScalingClientBuilder.standard().build(); DeleteScalingPolicyRequest request = new DeleteScalingPolicyRequest().withPolicyName("web-app-cpu-lt-25").withServiceNamespace("ecs") .withResourceId("service/default/web-app").withScalableDimension("ecs:service:DesiredCount"); DeleteScalingPolicyResult response = client.deleteScalingPolicy(request);
public DeleteScheduledActionResult deleteScheduledAction(DeleteScheduledActionRequest request)
Deletes the specified scheduled action for an Application Auto Scaling scalable target.
For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.
deleteScheduledAction
in interface AWSApplicationAutoScaling
deleteScheduledActionRequest
- 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 operation that 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 operation that deletes or deregisters a resource, this
exception is thrown if the resource 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 an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.
Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.
deregisterScalableTarget
in interface AWSApplicationAutoScaling
deregisterScalableTargetRequest
- 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 operation that 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 operation that deletes or deregisters a resource, this
exception is thrown if the resource 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 = AWSApplicationAutoScalingClientBuilder.standard().build(); DeregisterScalableTargetRequest request = new DeregisterScalableTargetRequest().withServiceNamespace("ecs").withResourceId("service/default/web-app") .withScalableDimension("ecs:service:DesiredCount"); DeregisterScalableTargetResult response = client.deregisterScalableTarget(request);
public DescribeScalableTargetsResult describeScalableTargets(DescribeScalableTargetsRequest request)
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds
and ScalableDimension
.
describeScalableTargets
in interface AWSApplicationAutoScaling
describeScalableTargetsRequest
- 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 = AWSApplicationAutoScalingClientBuilder.standard().build(); 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 ResourceId
and ScalableDimension
.
For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.
describeScalingActivities
in interface AWSApplicationAutoScaling
describeScalingActivitiesRequest
- 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 = AWSApplicationAutoScalingClientBuilder.standard().build(); DescribeScalingActivitiesRequest request = new DescribeScalingActivitiesRequest().withServiceNamespace("ecs").withResourceId("service/default/web-app") .withScalableDimension("ecs:service:DesiredCount"); DescribeScalingActivitiesResult response = client.describeScalingActivities(request);
public DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest request)
Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using ResourceId
, ScalableDimension
, and
PolicyNames
.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
describeScalingPolicies
in interface AWSApplicationAutoScaling
describeScalingPoliciesRequest
- 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 on your behalf.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 = AWSApplicationAutoScalingClientBuilder.standard().build(); DescribeScalingPoliciesRequest request = new DescribeScalingPoliciesRequest().withServiceNamespace("ecs"); DescribeScalingPoliciesResult response = client.describeScalingPolicies(request);
public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest request)
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the ResourceId
, ScalableDimension
, and
ScheduledActionNames
parameters.
For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
describeScheduledActions
in interface AWSApplicationAutoScaling
describeScheduledActionsRequest
- 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 ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags on the specified Application Auto Scaling scalable target.
For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.
listTagsForResource
in interface AWSApplicationAutoScaling
listTagsForResourceRequest
- ResourceNotFoundException
- The specified resource doesn't exist.public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)
Creates or updates a scaling 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 until you have registered the resource as a scalable target.
Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.
We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.
For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.
putScalingPolicy
in interface AWSApplicationAutoScaling
putScalingPolicyRequest
- ValidationException
- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException
- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException
- The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this
exception is thrown if the resource 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 on your behalf.InternalServiceException
- The service encountered an internal error.AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build(); PutScalingPolicyRequest request = new PutScalingPolicyRequest() .withPolicyName("web-app-cpu-gt-75") .withServiceNamespace("ecs") .withResourceId("service/default/web-app") .withScalableDimension("ecs:service:DesiredCount") .withPolicyType("StepScaling") .withStepScalingPolicyConfiguration( new StepScalingPolicyConfiguration().withAdjustmentType("PercentChangeInCapacity") .withStepAdjustments(new StepAdjustment().withMetricIntervalLowerBound(0d).withScalingAdjustment(200)).withCooldown(60)); PutScalingPolicyResult response = client.putScalingPolicy(request);AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build(); PutScalingPolicyRequest request = new PutScalingPolicyRequest() .withPolicyName("fleet-cpu-gt-75") .withServiceNamespace("ec2") .withResourceId("spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3") .withScalableDimension("ec2:spot-fleet-request:TargetCapacity") .withPolicyType("StepScaling") .withStepScalingPolicyConfiguration( new StepScalingPolicyConfiguration().withAdjustmentType("PercentChangeInCapacity") .withStepAdjustments(new StepAdjustment().withMetricIntervalLowerBound(0d).withScalingAdjustment(200)).withCooldown(180)); 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 until you have registered the resource as a scalable target.
When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops.
To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.
For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.
putScheduledAction
in interface AWSApplicationAutoScaling
putScheduledActionRequest
- ValidationException
- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException
- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.ObjectNotFoundException
- The specified object could not be found. For any operation that 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 operation that deletes or deregisters a resource, this
exception is thrown if the resource 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, which is the resource that you want to scale.
Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service.
When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range.
If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range.
After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.
To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.
If you call the RegisterScalableTarget
API operation to create a scalable target, there might be a
brief delay until the operation achieves eventual
consistency. You might become aware of this brief delay if you get unexpected errors when performing
sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include
automatic backoff and retry logic.
If you call the RegisterScalableTarget
API operation to update an existing scalable target,
Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or
above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it
within these bounds, even if you don't include the MinCapacity
or MaxCapacity
request
parameters.
registerScalableTarget
in interface AWSApplicationAutoScaling
registerScalableTargetRequest
- ValidationException
- An exception was thrown for a validation issue. Review the available parameters for the API request.LimitExceededException
- A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.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 = AWSApplicationAutoScalingClientBuilder.standard().build(); RegisterScalableTargetRequest request = new RegisterScalableTargetRequest().withServiceNamespace("ecs").withResourceId("service/default/web-app") .withScalableDimension("ecs:service:DesiredCount").withMinCapacity(1).withMaxCapacity(10) .withRoleARN("arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole"); RegisterScalableTargetResult response = client.registerScalableTarget(request);AWSApplicationAutoScaling client = AWSApplicationAutoScalingClientBuilder.standard().build(); RegisterScalableTargetRequest request = new RegisterScalableTargetRequest().withServiceNamespace("ec2") .withResourceId("spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3").withScalableDimension("ec2:spot-fleet-request:TargetCapacity") .withMinCapacity(1).withMaxCapacity(10).withRoleARN("arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole"); RegisterScalableTargetResult response = client.registerScalableTarget(request);
public TagResourceResult tagResource(TagResourceRequest request)
Adds or edits tags on an Application Auto Scaling scalable target.
Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.
You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action.
You can also add tags to an Application Auto Scaling scalable target while creating it (
RegisterScalableTarget
).
For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.
Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.
tagResource
in interface AWSApplicationAutoScaling
tagResourceRequest
- ResourceNotFoundException
- The specified resource doesn't exist.TooManyTagsException
- The request contains too many tags. Try the request again with fewer tags.ValidationException
- An exception was thrown for a validation issue. Review the available parameters for the API request.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.
untagResource
in interface AWSApplicationAutoScaling
untagResourceRequest
- ResourceNotFoundException
- The specified resource doesn't exist.ValidationException
- An exception was thrown for a validation issue. Review the available parameters for the API 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 AWSApplicationAutoScaling
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSApplicationAutoScaling
shutdown
in class AmazonWebServiceClient