AWS SDK Version 3 for .NET
API Reference

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.

Classes

NameDescription
Class Alarm

Represents a CloudWatch alarm associated with a scaling policy.

Class ConcurrentUpdateException

ApplicationAutoScaling exception

Class CustomizedMetricSpecification

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.

To create your customized metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For more information about CloudWatch, see Amazon CloudWatch Concepts.

Class 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.

To create a scaling policy or update an existing one, see PutScalingPolicy.

Class DeleteScalingPolicyResponse

This is the response object from the DeleteScalingPolicy operation.

Class 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.

Class DeleteScheduledActionResponse

This is the response object from the DeleteScheduledAction operation.

Class DeregisterScalableTargetRequest

Container for the parameters to the DeregisterScalableTarget operation. Deregisters an Application Auto Scaling 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.

Class DeregisterScalableTargetResponse

This is the response object from the DeregisterScalableTarget operation.

Class 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 ResourceIds and ScalableDimension.

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.

Class DescribeScalableTargetsResponse

This is the response object from the DescribeScalableTargets operation.

Class 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 ResourceId and ScalableDimension.

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.

Class DescribeScalingActivitiesResponse

This is the response object from the DescribeScalingActivities operation.

Class 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 ResourceId, ScalableDimension, and PolicyNames.

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.

Class DescribeScalingPoliciesResponse

This is the response object from the DescribeScalingPolicies operation.

Class 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 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.

Class DescribeScheduledActionsResponse

This is the response object from the DescribeScheduledActions operation.

Class FailedResourceAccessException

ApplicationAutoScaling exception

Class InternalServiceException

ApplicationAutoScaling exception

Class InvalidNextTokenException

ApplicationAutoScaling exception

Class LimitExceededException

ApplicationAutoScaling exception

Class MetricDimension

Describes the dimension names and values associated with a metric.

Class ObjectNotFoundException

ApplicationAutoScaling exception

Class PredefinedMetricSpecification

Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.

Class PutScalingPolicyRequest

Container for the parameters to the PutScalingPolicy operation. 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 until you have registered the resource as 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.

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.

Learn more about how to work with scaling policies in the Application Auto Scaling User Guide.

Class PutScalingPolicyResponse

This is the response object from the PutScalingPolicy operation.

Class 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 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.

Learn more about how to work with scheduled actions in the Application Auto Scaling User Guide.

Class PutScheduledActionResponse

This is the response object from the PutScheduledAction operation.

Class RegisterScalableTargetRequest

Container for the parameters to the RegisterScalableTarget operation. Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.

When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling will not scale capacity to values that are outside of this range.

To update a scalable target, specify the parameter that you want to change as well as the following 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.

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.

Class RegisterScalableTargetResponse

This is the response object from the RegisterScalableTarget operation.

Class ScalableTarget

Represents a scalable target.

Class ScalableTargetAction

Represents the minimum and maximum capacity for a scheduled action.

Class ScalingActivity

Represents a scaling activity.

Class ScalingPolicy

Represents a scaling policy to use with Application Auto Scaling.

Class ScheduledAction

Represents a scheduled action.

Class 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:

  • To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

  • To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.

  • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

  • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

  • The upper and lower bound can't be null in the same step adjustment.

Class StepScalingPolicyConfiguration

Represents a step scaling policy configuration to use with Application Auto Scaling.

Class SuspendedState

Specifies whether the scaling activities for a scalable target are in a suspended state.

Class TargetTrackingScalingPolicyConfiguration

Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

Class ValidationException

ApplicationAutoScaling exception