AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
Alarm |
Represents a CloudWatch alarm associated with a scaling policy. |
|
ApplicationAutoScalingPaginatorFactory |
Paginators for the ApplicationAutoScaling service |
|
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. |
|
CustomizedMetricSpecification |
Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling. For information about the available metrics for a service, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. To create your customized metric specification:
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide. |
|
DeleteScalingPolicyRequest |
Container for the parameters to the DeleteScalingPolicy operation. 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. |
|
DeleteScalingPolicyResponse |
This is the response object from the DeleteScalingPolicy operation. |
|
DeleteScheduledActionRequest |
Container for the parameters to the DeleteScheduledAction operation. 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. |
|
DeleteScheduledActionResponse |
This is the response object from the DeleteScheduledAction operation. |
|
DeregisterScalableTargetRequest |
Container for the parameters to the DeregisterScalableTarget operation.
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.
|
|
DeregisterScalableTargetResponse |
This is the response object from the DeregisterScalableTarget operation. |
|
DescribeScalableTargetsRequest |
Container for the parameters to the DescribeScalableTargets operation. Gets information about the scalable targets in the specified namespace.
You can filter the results using |
|
DescribeScalableTargetsResponse |
This is the response object from the DescribeScalableTargets operation. |
|
DescribeScalingActivitiesRequest |
Container for the parameters to the DescribeScalingActivities operation. Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling. |
|
DescribeScalingActivitiesResponse |
This is the response object from the DescribeScalingActivities operation. |
|
DescribeScalingPoliciesRequest |
Container for the parameters to the DescribeScalingPolicies operation. Describes the Application Auto Scaling scaling policies for the specified service namespace.
You can filter the results using For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide. |
|
DescribeScalingPoliciesResponse |
This is the response object from the DescribeScalingPolicies operation. |
|
DescribeScheduledActionsRequest |
Container for the parameters to the DescribeScheduledActions operation. Describes the Application Auto Scaling scheduled actions for the specified service namespace.
You can filter the results using the For more information, see Scheduled scaling and Managing scheduled scaling in the Application Auto Scaling User Guide. |
|
DescribeScheduledActionsResponse |
This is the response object from the DescribeScheduledActions operation. |
|
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. |
|
InvalidNextTokenException |
The next token supplied was invalid. |
|
LimitExceededException |
A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Returns all the tags on the specified Application Auto Scaling scalable target. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
MetricDimension |
Describes the dimension names and values associated with a metric. |
|
NotScaledReason |
Describes the reason for an activity that isn't scaled (not scaled activity), in machine-readable format. For help interpreting the not scaled reason details, see Scaling activities for Application Auto Scaling. |
|
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. |
|
PredefinedMetricSpecification |
Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling. Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a desired metric already exists by looking up its namespace and dimension using the CloudWatch metrics dashboard in the console, follow the procedure in Monitor your resources using CloudWatch in the Application Auto Scaling User Guide. |
|
PutScalingPolicyRequest |
Container for the parameters to the PutScalingPolicy operation. 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. |
|
PutScalingPolicyResponse |
This is the response object from the PutScalingPolicy operation. |
|
PutScheduledActionRequest |
Container for the parameters to the PutScheduledAction operation. 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. |
|
PutScheduledActionResponse |
This is the response object from the PutScheduledAction operation. |
|
RegisterScalableTargetRequest |
Container for the parameters to the RegisterScalableTarget operation. 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
If you call the |
|
RegisterScalableTargetResponse |
This is the response object from the RegisterScalableTarget operation. |
|
ResourceNotFoundException |
The specified resource doesn't exist. |
|
ScalableTarget |
Represents a scalable target. |
|
ScalableTargetAction |
Represents the minimum and maximum capacity for a scheduled action. |
|
ScalingActivity |
Represents a scaling activity. |
|
ScalingPolicy |
Represents a scaling policy to use with Application Auto Scaling. For more information about configuring scaling policies for a specific service, see Amazon Web Services services that you can use with Application Auto Scaling in the Application Auto Scaling User Guide. |
|
ScheduledAction |
Represents a scheduled action. |
|
StepAdjustment |
Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. For the following examples, suppose that you have an alarm with a breach threshold of 50:
There are a few rules for the step adjustments for your step policy:
|
|
StepScalingPolicyConfiguration |
Represents a step scaling policy configuration to use with Application Auto Scaling. For more information, see Step scaling policies in the Application Auto Scaling User Guide. |
|
SuspendedState |
Specifies whether the scaling activities for a scalable target are in a suspended state. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. 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 ( For general information about tags, including the format and syntax, see Tagging 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. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
TargetTrackingMetric |
Represents a specific metric. Metric is a property of the TargetTrackingMetricStat object. |
|
TargetTrackingMetricDataQuery |
The metric data to return. Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp. For more information and examples, see Create a target tracking scaling policy for Application Auto Scaling using metric math in the Application Auto Scaling User Guide. |
|
TargetTrackingMetricDimension |
Describes the dimension of a metric. |
|
TargetTrackingMetricStat |
This structure defines the CloudWatch metric to return, along with the statistic, period, and unit. For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide. |
|
TargetTrackingScalingPolicyConfiguration |
Represents a target tracking scaling policy configuration to use with Application Auto Scaling. For more information, see Target tracking scaling policies in the Application Auto Scaling User Guide. |
|
TooManyTagsException |
The request contains too many tags. Try the request again with fewer tags. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
ValidationException |
An exception was thrown for a validation issue. Review the available parameters for the API request. |
Name | Description | |
---|---|---|
IApplicationAutoScalingPaginatorFactory |
Paginators for the ApplicationAutoScaling service |
|
IDescribeScalableTargetsPaginator |
Paginator for the DescribeScalableTargets operation |
|
IDescribeScalingActivitiesPaginator |
Paginator for the DescribeScalingActivities operation |
|
IDescribeScalingPoliciesPaginator |
Paginator for the DescribeScalingPolicies operation |
|
IDescribeScheduledActionsPaginator |
Paginator for the DescribeScheduledActions operation |