META-INF.smithy.applicationautoscaling.smithy Maven / Gradle / Ivy
Show all versions of aws-application-auto-scaling-spec Show documentation
$version: "2.0"
metadata suppressions = [
{
id: "HttpMethodSemantics"
namespace: "*"
}
{
id: "HttpResponseCodeSemantics"
namespace: "*"
}
{
id: "PaginatedTrait"
namespace: "*"
}
{
id: "HttpHeaderTrait"
namespace: "*"
}
{
id: "HttpUriConflict"
namespace: "*"
}
{
id: "Service"
namespace: "*"
}
]
namespace com.amazonaws.applicationautoscaling
use aws.api#service
use aws.auth#sigv4
use aws.protocols#awsJson1_1
use aws.protocols#awsQueryError
/// 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 Serverless endpoint provisioned concurrency
///
/// -
///
Spot Fleets (Amazon EC2)
///
/// -
///
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.
///
///
@service(
sdkId: "Application Auto Scaling"
arnNamespace: "application-autoscaling"
cloudFormationName: "ApplicationAutoScaling"
cloudTrailEventSource: "applicationautoscaling.amazonaws.com"
docId: "application-autoscaling-2016-02-06"
endpointPrefix: "application-autoscaling"
)
@sigv4(
name: "application-autoscaling"
)
@awsJson1_1
@title("Application Auto Scaling")
service AnyScaleFrontendService {
version: "2016-02-06"
operations: [
DeleteScalingPolicy
DeleteScheduledAction
DeregisterScalableTarget
DescribeScalableTargets
DescribeScalingActivities
DescribeScalingPolicies
DescribeScheduledActions
ListTagsForResource
PutScalingPolicy
PutScheduledAction
RegisterScalableTarget
TagResource
UntagResource
]
}
/// 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.
@examples([
{
title: "To delete a scaling policy"
documentation: "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster."
input: {
PolicyName: "web-app-cpu-lt-25"
ServiceNamespace: "ecs"
ResourceId: "service/default/web-app"
ScalableDimension: "ecs:service:DesiredCount"
}
output: {}
}
])
operation DeleteScalingPolicy {
input: DeleteScalingPolicyRequest
output: DeleteScalingPolicyResponse
errors: [
ConcurrentUpdateException
InternalServiceException
ObjectNotFoundException
ValidationException
]
}
/// 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.
@examples([
{
title: "To delete a scheduled action"
documentation: "This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet."
input: {
ServiceNamespace: "appstream"
ScheduledActionName: "my-recurring-action"
ResourceId: "fleet/sample-fleet"
ScalableDimension: "appstream:fleet:DesiredCapacity"
}
output: {}
}
])
operation DeleteScheduledAction {
input: DeleteScheduledActionRequest
output: DeleteScheduledActionResponse
errors: [
ConcurrentUpdateException
InternalServiceException
ObjectNotFoundException
ValidationException
]
}
/// 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.
///
@examples([
{
title: "To deregister a scalable target"
documentation: "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster."
input: {
ServiceNamespace: "ecs"
ResourceId: "service/default/web-app"
ScalableDimension: "ecs:service:DesiredCount"
}
output: {}
}
])
operation DeregisterScalableTarget {
input: DeregisterScalableTargetRequest
output: DeregisterScalableTargetResponse
errors: [
ConcurrentUpdateException
InternalServiceException
ObjectNotFoundException
ValidationException
]
}
/// Gets information about the scalable targets in the specified namespace.
/// You can filter the results using ResourceIds and
/// ScalableDimension.
@examples([
{
title: "To describe scalable targets"
documentation: "This example describes the scalable targets for the ECS service namespace."
input: {
ServiceNamespace: "ecs"
}
output: {
ScalableTargets: [
{
ScalableDimension: "ecs:service:DesiredCount"
ResourceId: "service/default/web-app"
RoleARN: "arn:aws:iam::012345678910:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService"
CreationTime: "2019-05-06T11:21:46.199Z"
MinCapacity: 1
ServiceNamespace: "ecs"
MaxCapacity: 10
SuspendedState: {
DynamicScalingInSuspended: false
DynamicScalingOutSuspended: false
ScheduledScalingSuspended: false
}
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "ScalableTargets"
pageSize: "MaxResults"
)
operation DescribeScalableTargets {
input: DescribeScalableTargetsRequest
output: DescribeScalableTargetsResponse
errors: [
ConcurrentUpdateException
InternalServiceException
InvalidNextTokenException
ValidationException
]
}
/// 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.
@examples([
{
title: "To describe scaling activities for a scalable target"
documentation: "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster."
input: {
ServiceNamespace: "ecs"
ResourceId: "service/default/web-app"
ScalableDimension: "ecs:service:DesiredCount"
}
output: {
ScalingActivities: [
{
ScalableDimension: "ecs:service:DesiredCount"
Description: "Setting desired count to 1."
ResourceId: "service/default/web-app"
ActivityId: "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399"
StartTime: "2019-05-06T16:03:58.171Z"
ServiceNamespace: "ecs"
EndTime: "2019-05-06T16:04:32.111Z"
Cause: "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25"
StatusMessage: "Successfully set desired count to 1. Change successfully fulfilled by ecs."
StatusCode: "Successful"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "ScalingActivities"
pageSize: "MaxResults"
)
operation DescribeScalingActivities {
input: DescribeScalingActivitiesRequest
output: DescribeScalingActivitiesResponse
errors: [
ConcurrentUpdateException
InternalServiceException
InvalidNextTokenException
ValidationException
]
}
/// 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.
@examples([
{
title: "To describe scaling policies"
documentation: "This example describes the scaling policies for the ECS service namespace."
input: {
ServiceNamespace: "ecs"
}
output: {
ScalingPolicies: [
{
PolicyName: "web-app-cpu-gt-75"
ScalableDimension: "ecs:service:DesiredCount"
ResourceId: "service/default/web-app"
CreationTime: "2019-05-06T12:11:39.230Z"
StepScalingPolicyConfiguration: {
Cooldown: 60
StepAdjustments: [
{
ScalingAdjustment: 200
MetricIntervalLowerBound: 0
}
]
AdjustmentType: "PercentChangeInCapacity"
}
PolicyARN: "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75"
PolicyType: "StepScaling"
Alarms: [
{
AlarmName: "web-app-cpu-gt-75"
AlarmARN: "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75"
}
]
ServiceNamespace: "ecs"
}
]
NextToken: ""
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "ScalingPolicies"
pageSize: "MaxResults"
)
operation DescribeScalingPolicies {
input: DescribeScalingPoliciesRequest
output: DescribeScalingPoliciesResponse
errors: [
ConcurrentUpdateException
FailedResourceAccessException
InternalServiceException
InvalidNextTokenException
ValidationException
]
}
/// 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 and Managing scheduled scaling in the
/// Application Auto Scaling User Guide.
@examples([
{
title: "To describe scheduled actions"
documentation: "This example describes the scheduled actions for the dynamodb service namespace."
input: {
ServiceNamespace: "dynamodb"
}
output: {
ScheduledActions: [
{
ScalableDimension: "dynamodb:table:WriteCapacityUnits"
Schedule: "at(2019-05-20T18:35:00)"
ResourceId: "table/my-table"
CreationTime: 1.561571888361E9
ScheduledActionARN: "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action"
ScalableTargetAction: {
MinCapacity: 15
MaxCapacity: 20
}
ScheduledActionName: "my-first-scheduled-action"
ServiceNamespace: "dynamodb"
}
{
ScalableDimension: "dynamodb:table:WriteCapacityUnits"
Schedule: "at(2019-05-20T18:40:00)"
ResourceId: "table/my-table"
CreationTime: 1.561571946021E9
ScheduledActionARN: "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action"
ScalableTargetAction: {
MinCapacity: 5
MaxCapacity: 10
}
ScheduledActionName: "my-second-scheduled-action"
ServiceNamespace: "dynamodb"
}
]
}
}
])
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "ScheduledActions"
pageSize: "MaxResults"
)
operation DescribeScheduledActions {
input: DescribeScheduledActionsRequest
output: DescribeScheduledActionsResponse
errors: [
ConcurrentUpdateException
InternalServiceException
InvalidNextTokenException
ValidationException
]
}
/// 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.
@examples([
{
title: "To list tags for a scalable target"
documentation: "This example lists the tag key names and values that are attached to the scalable target specified by its ARN."
input: {
ResourceARN: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}
output: {
Tags: {
environment: "production"
}
}
}
])
operation ListTagsForResource {
input: ListTagsForResourceRequest
output: ListTagsForResourceResponse
errors: [
ResourceNotFoundException
]
}
/// 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.
///
@examples([
{
title: "To apply a target tracking scaling policy with a predefined metric specification"
documentation: "The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds."
input: {
PolicyName: "cpu75-target-tracking-scaling-policy"
ServiceNamespace: "ecs"
ResourceId: "service/default/web-app"
ScalableDimension: "ecs:service:DesiredCount"
PolicyType: "TargetTrackingScaling"
TargetTrackingScalingPolicyConfiguration: {
TargetValue: 75
PredefinedMetricSpecification: {
PredefinedMetricType: "ECSServiceAverageCPUUtilization"
}
ScaleOutCooldown: 60
ScaleInCooldown: 60
}
}
output: {
PolicyARN: "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy"
Alarms: [
{
AlarmARN: "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca"
AlarmName: "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca"
}
{
AlarmARN: "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d"
AlarmName: "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d"
}
]
}
}
])
operation PutScalingPolicy {
input: PutScalingPolicyRequest
output: PutScalingPolicyResponse
errors: [
ConcurrentUpdateException
FailedResourceAccessException
InternalServiceException
LimitExceededException
ObjectNotFoundException
ValidationException
]
}
/// 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.
///
@examples([
{
title: "To create a recurring scheduled action"
documentation: "This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity."
input: {
ServiceNamespace: "dynamodb"
Schedule: "cron(15 12 * * ? *)"
ScheduledActionName: "my-recurring-action"
ResourceId: "table/TestTable"
ScalableDimension: "dynamodb:table:WriteCapacityUnits"
ScalableTargetAction: {
MinCapacity: 6
}
}
output: {}
}
])
operation PutScheduledAction {
input: PutScheduledActionRequest
output: PutScheduledActionResponse
errors: [
ConcurrentUpdateException
InternalServiceException
LimitExceededException
ObjectNotFoundException
ValidationException
]
}
/// 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.
///
@examples([
{
title: "To register an ECS service as a scalable target"
documentation: "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks."
input: {
ServiceNamespace: "ecs"
ResourceId: "service/default/web-app"
ScalableDimension: "ecs:service:DesiredCount"
MinCapacity: 1
MaxCapacity: 10
}
output: {
ScalableTargetARN: "arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
}
}
])
operation RegisterScalableTarget {
input: RegisterScalableTargetRequest
output: RegisterScalableTargetResponse
errors: [
ConcurrentUpdateException
InternalServiceException
LimitExceededException
ValidationException
]
}
/// 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 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.
@examples([
{
title: "To add a tag to a scalable target"
documentation: "This example adds a tag with the key name \"environment\" and the value \"production\" to the scalable target specified by its ARN."
input: {
ResourceARN: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
Tags: {
environment: "production"
}
}
output: {}
}
])
operation TagResource {
input: TagResourceRequest
output: TagResourceResponse
errors: [
ResourceNotFoundException
TooManyTagsException
ValidationException
]
}
/// Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and
/// the Application Auto Scaling scalable target.
@examples([
{
title: "To remove a tag from a scalable target"
documentation: "This example removes the tag pair with the key name \"environment\" from the scalable target specified by its ARN."
input: {
ResourceARN: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
TagKeys: [
"environment"
]
}
output: {}
}
])
operation UntagResource {
input: UntagResourceRequest
output: UntagResourceResponse
errors: [
ResourceNotFoundException
ValidationException
]
}
/// Represents a CloudWatch alarm associated with a scaling policy.
structure Alarm {
/// The name of the alarm.
@required
AlarmName: ResourceId
/// The Amazon Resource Name (ARN) of the alarm.
@required
AlarmARN: ResourceId
}
/// Concurrent updates caused an exception, for example, if you request an update to an
/// Application Auto Scaling resource that already has a pending update.
@awsQueryError(
code: "ConcurrentUpdateException"
httpResponseCode: 500
)
@error("server")
@httpError(500)
structure ConcurrentUpdateException {
Message: ErrorMessage
}
/// 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:
///
/// -
///
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, and
/// increase when capacity decreases.
///
///
/// For more information about the CloudWatch terminology below, see Amazon CloudWatch
/// concepts in the Amazon CloudWatch User Guide.
structure CustomizedMetricSpecification {
/// The name of the metric. To get the exact metric name, namespace, and dimensions, inspect
/// the Metric object that's returned by a call to ListMetrics.
MetricName: MetricName
/// The namespace of the metric.
Namespace: MetricNamespace
/// The dimensions of the metric.
/// Conditional: If you published your metric with dimensions, you must specify the same
/// dimensions in your scaling policy.
Dimensions: MetricDimensions
/// The statistic of the metric.
Statistic: MetricStatistic
/// The unit of the metric. For a complete list of the units that CloudWatch supports, see the
/// MetricDatum data
/// type in the Amazon CloudWatch API Reference.
Unit: MetricUnit
/// The metrics to include in the target tracking scaling policy, as a metric data query.
/// This can include both raw metric and metric math expressions.
Metrics: TargetTrackingMetricDataQueries
}
@input
structure DeleteScalingPolicyRequest {
/// The name of the scaling policy.
@required
PolicyName: ResourceIdMaxLen1600
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scalable target.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
}
@output
structure DeleteScalingPolicyResponse {}
@input
structure DeleteScheduledActionRequest {
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The name of the scheduled action.
@required
ScheduledActionName: ResourceIdMaxLen1600
/// The identifier of the resource associated with the scheduled action.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
}
@output
structure DeleteScheduledActionResponse {}
@input
structure DeregisterScalableTargetRequest {
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scalable target.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension associated with the scalable target.
/// This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
}
@output
structure DeregisterScalableTargetResponse {}
@input
structure DescribeScalableTargetsRequest {
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scalable target.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
ResourceIds: ResourceIdsMaxLen1600
/// The scalable dimension associated with the scalable target.
/// This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
ScalableDimension: ScalableDimension
/// The maximum number of scalable targets. This value can be between 1 and
/// 50. The default value is 50.
/// If this parameter is used, the operation returns up to MaxResults results
/// at a time, along with a NextToken value. To get the next set of results,
/// include the NextToken value in a subsequent call. If this parameter is not
/// used, the operation returns up to 50 results and a
/// NextToken value, if applicable.
MaxResults: MaxResults
/// The token for the next set of results.
NextToken: XmlString
}
@output
structure DescribeScalableTargetsResponse {
/// The scalable targets that match the request parameters.
ScalableTargets: ScalableTargets
/// The token required to get the next set of results. This value is null if
/// there are no more results to return.
NextToken: XmlString
}
@input
structure DescribeScalingActivitiesRequest {
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scaling activity.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
/// If you specify a scalable dimension, you must also specify a resource ID.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
ScalableDimension: ScalableDimension
/// The maximum number of scalable targets. This value can be between 1 and
/// 50. The default value is 50.
/// If this parameter is used, the operation returns up to MaxResults results
/// at a time, along with a NextToken value. To get the next set of results,
/// include the NextToken value in a subsequent call. If this parameter is not
/// used, the operation returns up to 50 results and a
/// NextToken value, if applicable.
MaxResults: MaxResults
/// The token for the next set of results.
NextToken: XmlString
/// Specifies whether to include activities that aren't scaled (not scaled
/// activities) in the response. Not scaled activities are activities that aren't
/// completed or started for various reasons, such as preventing infinite scaling loops. For
/// help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling.
IncludeNotScaledActivities: IncludeNotScaledActivities
}
@output
structure DescribeScalingActivitiesResponse {
/// A list of scaling activity objects.
ScalingActivities: ScalingActivities
/// The token required to get the next set of results. This value is null if
/// there are no more results to return.
NextToken: XmlString
}
@input
structure DescribeScalingPoliciesRequest {
/// The names of the scaling policies to describe.
PolicyNames: ResourceIdsMaxLen1600
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scaling policy.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
/// If you specify a scalable dimension, you must also specify a resource ID.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
ScalableDimension: ScalableDimension
/// The maximum number of scalable targets. This value can be between 1 and 10. The default
/// value is 10.
/// If this parameter is used, the operation returns up to MaxResults results
/// at a time, along with a NextToken value. To get the next set of results,
/// include the NextToken value in a subsequent call. If this parameter is not
/// used, the operation returns up to 10 results and a NextToken value, if
/// applicable.
MaxResults: MaxResults
/// The token for the next set of results.
NextToken: XmlString
}
@output
structure DescribeScalingPoliciesResponse {
/// Information about the scaling policies.
ScalingPolicies: ScalingPolicies
/// The token required to get the next set of results. This value is null if
/// there are no more results to return.
NextToken: XmlString
}
@input
structure DescribeScheduledActionsRequest {
/// The names of the scheduled actions to describe.
ScheduledActionNames: ResourceIdsMaxLen1600
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scheduled action.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
/// If you specify a scalable dimension, you must also specify a resource ID.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
ScalableDimension: ScalableDimension
/// The maximum number of scheduled action results. This value can be between
/// 1 and 50. The default value is 50.
/// If this parameter is used, the operation returns up to MaxResults results
/// at a time, along with a NextToken value. To get the next set of results,
/// include the NextToken value in a subsequent call. If this parameter is not
/// used, the operation returns up to 50 results and a
/// NextToken value, if applicable.
MaxResults: MaxResults
/// The token for the next set of results.
NextToken: XmlString
}
@output
structure DescribeScheduledActionsResponse {
/// Information about the scheduled actions.
ScheduledActions: ScheduledActions
/// The token required to get the next set of results. This value is null if
/// there are no more results to return.
NextToken: XmlString
}
/// 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.
@awsQueryError(
code: "FailedResourceAccessException"
httpResponseCode: 400
)
@error("client")
@httpError(400)
structure FailedResourceAccessException {
Message: ErrorMessage
}
/// The service encountered an internal error.
@awsQueryError(
code: "InternalServiceException"
httpResponseCode: 500
)
@error("server")
@httpError(500)
structure InternalServiceException {
Message: ErrorMessage
}
/// The next token supplied was invalid.
@awsQueryError(
code: "InvalidNextTokenException"
httpResponseCode: 400
)
@error("client")
@httpError(400)
structure InvalidNextTokenException {
Message: ErrorMessage
}
/// A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.
@awsQueryError(
code: "LimitExceededException"
httpResponseCode: 400
)
@error("client")
@httpError(400)
structure LimitExceededException {
Message: ErrorMessage
}
@input
structure ListTagsForResourceRequest {
/// Specify the ARN of the scalable target.
/// For example:
/// arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
///
/// To get the ARN for a scalable target, use DescribeScalableTargets.
@required
ResourceARN: AmazonResourceName
}
@output
structure ListTagsForResourceResponse {
/// A list of tags. Each tag consists of a tag key and a tag value.
Tags: TagMap
}
/// Describes the dimension names and values associated with a metric.
structure MetricDimension {
/// The name of the dimension.
@required
Name: MetricDimensionName
/// The value of the dimension.
@required
Value: MetricDimensionValue
}
/// 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.
structure NotScaledReason {
/// A code that represents the reason for not scaling.
/// Valid values:
///
/// -
///
AutoScalingAnticipatedFlapping
///
/// -
///
TargetServicePutResourceAsUnscalable
///
/// -
///
AlreadyAtMaxCapacity
///
/// -
///
AlreadyAtMinCapacity
///
/// -
///
AlreadyAtDesiredCapacity
///
///
@required
Code: XmlString
/// The maximum capacity.
MaxCapacity: ResourceCapacity
/// The minimum capacity.
MinCapacity: ResourceCapacity
/// The current capacity.
CurrentCapacity: ResourceCapacity
}
/// 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.
@awsQueryError(
code: "ObjectNotFoundException"
httpResponseCode: 400
)
@error("client")
@httpError(400)
structure ObjectNotFoundException {
Message: ErrorMessage
}
/// 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 Building dashboards
/// with CloudWatch in the Application Auto Scaling User Guide.
structure PredefinedMetricSpecification {
/// The metric type. The ALBRequestCountPerTarget metric type applies only to
/// Spot Fleets and ECS services.
@required
PredefinedMetricType: MetricType
/// Identifies the resource associated with the metric type. You can't specify a resource
/// label unless the metric type is ALBRequestCountPerTarget and there is a target
/// group attached to the Spot Fleet or ECS service.
/// You create the resource label by appending the final portion of the load balancer ARN
/// and the final portion of the target group ARN into a single value, separated by a forward
/// slash (/). The format of the resource label is:
///
/// app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
/// Where:
///
/// -
///
app// is the final portion of
/// the load balancer ARN
///
/// -
///
targetgroup// is the final portion
/// of the target group ARN.
///
///
/// To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use
/// the DescribeTargetGroups API operation.
ResourceLabel: ResourceLabel
}
@input
structure PutScalingPolicyRequest {
/// The name of the scaling policy.
/// You cannot change the name of a scaling policy, but you can delete the original scaling
/// policy and create a new scaling policy with the same settings and a different name.
@required
PolicyName: PolicyName
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scaling policy.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
/// The scaling policy type. This parameter is required if you are creating a scaling
/// policy.
/// The following policy types are supported:
///
/// TargetTrackingScaling—Not supported for Amazon EMR
///
/// StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or
/// Neptune.
/// For more information, see Target
/// tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
PolicyType: PolicyType
/// A step scaling policy.
/// This parameter is required if you are creating a policy and the policy type is
/// StepScaling.
StepScalingPolicyConfiguration: StepScalingPolicyConfiguration
/// A target tracking scaling policy. Includes support for predefined or customized
/// metrics.
/// This parameter is required if you are creating a policy and the policy type is
/// TargetTrackingScaling.
TargetTrackingScalingPolicyConfiguration: TargetTrackingScalingPolicyConfiguration
}
@output
structure PutScalingPolicyResponse {
/// The Amazon Resource Name (ARN) of the resulting scaling policy.
@required
PolicyARN: ResourceIdMaxLen1600
/// The CloudWatch alarms created for the target tracking scaling policy.
Alarms: Alarms
}
@input
structure PutScheduledActionRequest {
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The schedule for this action. The following formats are supported:
///
/// -
///
At expressions - "at(yyyy-mm-ddThh:mm:ss)"
///
/// -
///
Rate expressions - "rate(value
/// unit)"
///
/// -
///
Cron expressions - "cron(fields)"
///
///
/// At expressions are useful for one-time schedules. Cron expressions are useful for
/// scheduled actions that run periodically at a specified date and time, and rate expressions
/// are useful for scheduled actions that run at a regular interval.
/// At and cron expressions use Universal Coordinated Time (UTC) by
/// default.
/// The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
/// For rate expressions, value is a positive integer and unit is
/// minute | minutes | hour | hours | day | days.
/// For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
Schedule: ResourceIdMaxLen1600
/// Specifies the time zone used when setting a scheduled action by using an at or cron
/// expression. If a time zone is not provided, UTC is used by default.
/// Valid values are the canonical names of the IANA time zones supported by Joda-Time (such
/// as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.
Timezone: ResourceIdMaxLen1600
/// The name of the scheduled action. This name must be unique among all other scheduled
/// actions on the specified scalable target.
@required
ScheduledActionName: ScheduledActionName
/// The identifier of the resource associated with the scheduled action.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
/// The date and time for this scheduled action to start, in UTC.
StartTime: TimestampType
/// The date and time for the recurring schedule to end, in UTC.
EndTime: TimestampType
/// The new minimum and maximum capacity. You can set both values or just one. At the
/// scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out
/// to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling
/// scales in to the maximum capacity.
ScalableTargetAction: ScalableTargetAction
}
@output
structure PutScheduledActionResponse {}
@input
structure RegisterScalableTargetRequest {
/// The namespace of the Amazon Web Services service that provides the resource. For a resource provided
/// by your own application or service, use custom-resource instead.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource that is associated with the scalable target.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension associated with the scalable target.
/// This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
/// The minimum value that you plan to scale in to. When a scaling policy is in effect,
/// Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to
/// changing demand. This property is required when registering a new scalable target.
/// For the following resources, the minimum value allowed is 0.
///
/// -
///
AppStream 2.0 fleets
///
/// -
///
Aurora DB clusters
///
/// -
///
ECS services
///
/// -
///
EMR clusters
///
/// -
///
Lambda provisioned concurrency
///
/// -
///
SageMaker endpoint variants
///
/// -
///
SageMaker Serverless endpoint provisioned concurrency
///
/// -
///
Spot Fleets
///
/// -
///
custom resources
///
///
/// It's strongly recommended that you specify a value greater than 0. A value greater than 0
/// means that data points are continuously reported to CloudWatch that scaling policies can use to
/// scale on a metric like average CPU utilization.
/// For all other resources, the minimum allowed value depends on the type of resource that
/// you are using. If you provide a value that is lower than what a resource can accept, an error
/// occurs. In which case, the error message will provide the minimum value that the resource can
/// accept.
MinCapacity: ResourceCapacity
/// The maximum value that you plan to scale out to. When a scaling policy is in effect,
/// Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to
/// changing demand. This property is required when registering a new scalable target.
/// Although you can specify a large maximum capacity, note that service quotas might impose
/// lower limits. Each service has its own default quotas for the maximum capacity of the
/// resource. If you want to specify a higher limit, you can request an increase. For more
/// information, consult the documentation for that service. For information about the default
/// quotas for each service, see Service endpoints and
/// quotas in the Amazon Web Services General Reference.
MaxCapacity: ResourceCapacity
/// This parameter is required for services that do not support service-linked roles (such as
/// Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable
/// target on your behalf.
/// If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which
/// it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.
RoleARN: ResourceIdMaxLen1600
/// An embedded object that contains attributes and attribute values that are used to
/// suspend and resume automatic scaling. Setting the value of an attribute to
/// true suspends the specified scaling activities. Setting it to
/// false (default) resumes the specified scaling activities.
///
/// Suspension Outcomes
///
///
/// -
///
For DynamicScalingInSuspended, while a suspension is in effect, all
/// scale-in activities that are triggered by a scaling policy are suspended.
///
/// -
///
For DynamicScalingOutSuspended, while a suspension is in effect, all
/// scale-out activities that are triggered by a scaling policy are suspended.
///
/// -
///
For ScheduledScalingSuspended, while a suspension is in effect, all
/// scaling activities that involve scheduled actions are suspended.
///
///
/// For more information, see Suspending and resuming scaling in the Application Auto Scaling User
/// Guide.
SuspendedState: SuspendedState
/// Assigns one or more tags to the scalable target. Use this parameter to tag the scalable
/// target when it is created. To tag an existing scalable target, use the TagResource operation.
/// Each tag consists of a tag key and a tag value. Both the tag key and the tag value are
/// required. You cannot have more than one tag on a scalable target with the same tag
/// key.
/// 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.
Tags: TagMap
}
@output
structure RegisterScalableTargetResponse {
/// The ARN of the scalable target.
ScalableTargetARN: XmlString
}
/// The specified resource doesn't exist.
@error("client")
@httpError(404)
structure ResourceNotFoundException {
Message: ExceptionMessage
/// The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).
ResourceName: AmazonResourceName
}
/// Represents a scalable target.
structure ScalableTarget {
/// The namespace of the Amazon Web Services service that provides the resource, or a
/// custom-resource.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scalable target.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension associated with the scalable target.
/// This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
/// The minimum value to scale to in response to a scale-in activity.
@required
MinCapacity: ResourceCapacity
/// The maximum value to scale to in response to a scale-out activity.
@required
MaxCapacity: ResourceCapacity
/// The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your
/// behalf.
@required
RoleARN: ResourceIdMaxLen1600
/// The Unix timestamp for when the scalable target was created.
@required
CreationTime: TimestampType
/// Specifies whether the scaling activities for a scalable target are in a suspended
/// state.
SuspendedState: SuspendedState
/// The ARN of the scalable target.
ScalableTargetARN: XmlString
}
/// Represents the minimum and maximum capacity for a scheduled action.
structure ScalableTargetAction {
/// The minimum capacity.
/// When the scheduled action runs, the resource will have at least this much capacity, but it
/// might have more depending on other settings, such as the target utilization level of a target
/// tracking scaling policy.
MinCapacity: ResourceCapacity
/// The maximum capacity.
/// Although you can specify a large maximum capacity, note that service quotas may impose
/// lower limits. Each service has its own default quotas for the maximum capacity of the
/// resource. If you want to specify a higher limit, you can request an increase. For more
/// information, consult the documentation for that service. For information about the default
/// quotas for each service, see Service endpoints and
/// quotas in the Amazon Web Services General Reference.
MaxCapacity: ResourceCapacity
}
/// Represents a scaling activity.
structure ScalingActivity {
/// The unique identifier of the scaling activity.
@required
ActivityId: ResourceId
/// The namespace of the Amazon Web Services service that provides the resource, or a
/// custom-resource.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scaling activity.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
/// A simple description of what action the scaling activity intends to accomplish.
@required
Description: XmlString
/// A simple description of what caused the scaling activity to happen.
@required
Cause: XmlString
/// The Unix timestamp for when the scaling activity began.
@required
StartTime: TimestampType
/// The Unix timestamp for when the scaling activity ended.
EndTime: TimestampType
/// Indicates the status of the scaling activity.
@required
StatusCode: ScalingActivityStatusCode
/// A simple message about the current status of the scaling activity.
StatusMessage: XmlString
/// The details about the scaling activity.
Details: XmlString
/// Machine-readable data that describes the reason for a not scaled activity. Only
/// available when DescribeScalingActivities includes not scaled activities.
NotScaledReasons: NotScaledReasons
}
/// 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.
structure ScalingPolicy {
/// The Amazon Resource Name (ARN) of the scaling policy.
@required
PolicyARN: ResourceIdMaxLen1600
/// The name of the scaling policy.
@required
PolicyName: PolicyName
/// The namespace of the Amazon Web Services service that provides the resource, or a
/// custom-resource.
@required
ServiceNamespace: ServiceNamespace
/// The identifier of the resource associated with the scaling policy.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
@required
ScalableDimension: ScalableDimension
/// The scaling policy type.
/// The following policy types are supported:
///
/// TargetTrackingScaling—Not supported for Amazon EMR
///
/// StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or
/// Neptune.
@required
PolicyType: PolicyType
/// A step scaling policy.
StepScalingPolicyConfiguration: StepScalingPolicyConfiguration
/// A target tracking scaling policy.
TargetTrackingScalingPolicyConfiguration: TargetTrackingScalingPolicyConfiguration
/// The CloudWatch alarms associated with the scaling policy.
Alarms: Alarms
/// The Unix timestamp for when the scaling policy was created.
@required
CreationTime: TimestampType
}
/// Represents a scheduled action.
structure ScheduledAction {
/// The name of the scheduled action.
@required
ScheduledActionName: ScheduledActionName
/// The Amazon Resource Name (ARN) of the scheduled action.
@required
ScheduledActionARN: ResourceIdMaxLen1600
/// The namespace of the Amazon Web Services service that provides the resource, or a
/// custom-resource.
@required
ServiceNamespace: ServiceNamespace
/// The schedule for this action. The following formats are supported:
///
/// -
///
At expressions - "at(yyyy-mm-ddThh:mm:ss)"
///
/// -
///
Rate expressions - "rate(value
/// unit)"
///
/// -
///
Cron expressions - "cron(fields)"
///
///
/// At expressions are useful for one-time schedules. Cron expressions are useful for
/// scheduled actions that run periodically at a specified date and time, and rate expressions
/// are useful for scheduled actions that run at a regular interval.
/// At and cron expressions use Universal Coordinated Time (UTC) by
/// default.
/// The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
/// For rate expressions, value is a positive integer and unit is
/// minute | minutes | hour | hours | day | days.
/// For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
@required
Schedule: ResourceIdMaxLen1600
/// The time zone used when referring to the date and time of a scheduled action, when the
/// scheduled action uses an at or cron expression.
Timezone: ResourceIdMaxLen1600
/// The identifier of the resource associated with the scaling policy.
/// This string consists of the resource type and unique identifier.
///
/// -
///
ECS service - The resource type is service and the unique identifier is the cluster name
/// and service name. Example: service/default/sample-webapp.
///
/// -
///
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the
/// Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
///
/// -
///
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.
/// Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
///
/// -
///
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
/// Example: fleet/sample-fleet.
///
/// -
///
DynamoDB table - The resource type is table and the unique identifier is the table name.
/// Example: table/my-table.
///
/// -
///
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name.
/// Example: table/my-table/index/my-table-index.
///
/// -
///
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.
/// Example: cluster:my-db-cluster.
///
/// -
///
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
/// -
///
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information
/// is available in our GitHub
/// repository.
///
/// -
///
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
///
/// -
///
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
///
/// -
///
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST.
/// Example: function:my-function:prod or function:my-function:1.
///
/// -
///
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
/// Example: keyspace/mykeyspace/table/mytable.
///
/// -
///
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
/// Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
///
/// -
///
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
/// Example: replication-group/mycluster.
///
/// -
///
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
///
/// -
///
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the resource ID.
/// Example: endpoint/my-end-point/variant/KMeansClustering.
///
///
@required
ResourceId: ResourceIdMaxLen1600
/// The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
///
/// -
///
/// ecs:service:DesiredCount - The desired task count of an ECS service.
///
/// -
///
/// elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
///
/// -
///
/// ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
///
/// -
///
/// appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
///
/// -
///
/// dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
///
/// -
///
/// dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
///
/// -
///
/// dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
///
/// -
///
/// rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
///
/// -
///
/// sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
///
/// -
///
/// custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
///
/// -
///
/// comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
///
/// -
///
/// comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
///
/// -
///
/// lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
///
/// -
///
/// cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
///
/// -
///
/// cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
///
/// -
///
/// kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
///
/// -
///
/// elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
///
/// -
///
/// elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
///
/// -
///
/// neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
///
/// -
///
/// sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.
///
///
ScalableDimension: ScalableDimension
/// The date and time that the action is scheduled to begin, in UTC.
StartTime: TimestampType
/// The date and time that the action is scheduled to end, in UTC.
EndTime: TimestampType
/// The new minimum and maximum capacity. You can set both values or just one. At the
/// scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out
/// to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling
/// scales in to the maximum capacity.
ScalableTargetAction: ScalableTargetAction
/// The date and time that the scheduled action was created.
@required
CreationTime: TimestampType
}
/// 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 initiate 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 initiate 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.
///
///
structure StepAdjustment {
/// The lower bound for the difference between the alarm threshold and the CloudWatch metric. If
/// the metric value is above the breach threshold, the lower bound is inclusive (the metric
/// must be greater than or equal to the threshold plus the lower bound). Otherwise, it's
/// exclusive (the metric must be greater than the threshold plus the lower bound). A null
/// value indicates negative infinity.
MetricIntervalLowerBound: MetricScale
/// The upper bound for the difference between the alarm threshold and the CloudWatch metric. If
/// the metric value is above the breach threshold, the upper bound is exclusive (the metric
/// must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the
/// metric must be less than or equal to the threshold plus the upper bound). A null value
/// indicates positive infinity.
/// The upper bound must be greater than the lower bound.
MetricIntervalUpperBound: MetricScale
/// The amount by which to scale, based on the specified adjustment type. A positive value
/// adds to the current capacity while a negative number removes from the current capacity. For
/// exact capacity, you must specify a non-negative value.
@required
ScalingAdjustment: ScalingAdjustment
}
/// 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.
structure StepScalingPolicyConfiguration {
/// Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a
/// percentage). The valid values are ChangeInCapacity,
/// ExactCapacity, and PercentChangeInCapacity.
///
/// AdjustmentType is required if you are adding a new step scaling policy
/// configuration.
AdjustmentType: AdjustmentType
/// A set of adjustments that enable you to scale based on the size of the alarm
/// breach.
/// At least one step adjustment is required if you are adding a new step scaling policy
/// configuration.
StepAdjustments: StepAdjustments
/// The minimum value to scale by when the adjustment type is
/// PercentChangeInCapacity. For example, suppose that you create a step
/// scaling policy to scale out an Amazon ECS service by 25 percent and you specify a
/// MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling
/// policy is performed, 25 percent of 4 is 1. However, because you specified a
/// MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2
/// tasks.
MinAdjustmentMagnitude: MinAdjustmentMagnitude
/// The amount of time, in seconds, to wait for a previous scaling activity to take effect. If
/// not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
Cooldown: Cooldown
/// The aggregation type for the CloudWatch metrics. Valid values are Minimum,
/// Maximum, and Average. If the aggregation type is null, the
/// value is treated as Average.
MetricAggregationType: MetricAggregationType
}
/// Specifies whether the scaling activities for a scalable target are in a suspended state.
///
structure SuspendedState {
/// Whether scale in by a target tracking scaling policy or a step scaling policy is
/// suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity
/// when a scaling policy is triggered. The default is false.
DynamicScalingInSuspended: ScalingSuspended
/// Whether scale out by a target tracking scaling policy or a step scaling policy is
/// suspended. Set the value to true if you don't want Application Auto Scaling to add capacity
/// when a scaling policy is triggered. The default is false.
DynamicScalingOutSuspended: ScalingSuspended
/// Whether scheduled scaling is suspended. Set the value to true if you don't
/// want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is
/// false.
ScheduledScalingSuspended: ScalingSuspended
}
@input
structure TagResourceRequest {
/// Identifies the Application Auto Scaling scalable target that you want to apply tags to.
/// For example:
/// arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
///
/// To get the ARN for a scalable target, use DescribeScalableTargets.
@required
ResourceARN: AmazonResourceName
/// The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services
/// resource.
/// Each tag consists of a tag key and a tag value.
/// You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key.
/// If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the
/// current tag value with the specified one.
/// For information about the rules that apply to tag keys and tag values, see User-defined tag
/// restrictions in the Amazon Web Services Billing and Cost Management User
/// Guide.
@required
Tags: TagMap
}
@output
structure TagResourceResponse {}
/// Represents a specific metric.
/// Metric is a property of the TargetTrackingMetricStat object.
structure TargetTrackingMetric {
/// The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services
/// documentation available from the table in Amazon Web Services
/// services that publish CloudWatch metrics in the Amazon CloudWatch User
/// Guide.
/// Conditional: If you published your metric with dimensions, you must specify the same
/// dimensions in your scaling policy.
Dimensions: TargetTrackingMetricDimensions
/// The name of the metric.
MetricName: TargetTrackingMetricName
/// The namespace of the metric. For more information, see the table in Amazon Web Services
/// services that publish CloudWatch metrics in the Amazon CloudWatch User
/// Guide.
Namespace: TargetTrackingMetricNamespace
}
/// 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.
structure TargetTrackingMetricDataQuery {
/// The math expression to perform on the returned data, if this object is performing a math
/// expression. This expression can use the Id of the other metrics to refer to
/// those metrics, and can also use the Id of other expressions to use the result
/// of those expressions.
/// Conditional: Within each TargetTrackingMetricDataQuery object, you must
/// specify either Expression or MetricStat, but not both.
Expression: Expression
/// A short name that identifies the object's results in the response. This name must be
/// unique among all MetricDataQuery objects specified for a single scaling
/// policy. If you are performing math expressions on this set of data, this name represents
/// that data and can serve as a variable in the mathematical expression. The valid characters
/// are letters, numbers, and underscores. The first character must be a lowercase letter.
///
@required
Id: Id
/// A human-readable label for this metric or expression. This is especially useful if this
/// is a math expression, so that you know what the value represents.
Label: XmlString
/// Information about the metric data to return.
/// Conditional: Within each MetricDataQuery object, you must specify either
/// Expression or MetricStat, but not both.
MetricStat: TargetTrackingMetricStat
/// Indicates whether to return the timestamps and raw data values of this metric.
/// If you use any math expressions, specify true for this value for only the
/// final math expression that the metric specification is based on. You must specify
/// false for ReturnData for all the other metrics and expressions
/// used in the metric specification.
/// If you are only retrieving metrics and not performing any math expressions, do not
/// specify anything for ReturnData. This sets it to its default
/// (true).
ReturnData: ReturnData
}
/// Describes the dimension of a metric.
structure TargetTrackingMetricDimension {
/// The name of the dimension.
@required
Name: TargetTrackingMetricDimensionName
/// The value of the dimension.
@required
Value: TargetTrackingMetricDimensionValue
}
/// 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.
structure TargetTrackingMetricStat {
/// The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get
/// the exact metric name, namespace, and dimensions, inspect the Metric object that is
/// returned by a call to ListMetrics.
@required
Metric: TargetTrackingMetric
/// The statistic to return. It can include any CloudWatch statistic or extended statistic. For a
/// list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
/// The most commonly used metric for scaling is Average.
@required
Stat: XmlString
/// The unit to use for the returned data points. For a complete list of the units that CloudWatch
/// supports, see the MetricDatum data
/// type in the Amazon CloudWatch API Reference.
Unit: TargetTrackingMetricUnit
}
/// 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.
structure TargetTrackingScalingPolicyConfiguration {
/// The target value for the metric. Although this property accepts numbers of type Double,
/// it won't accept values that are either too small or too large. Values must be in the range
/// of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For
/// example, if the metric is CPU utilization, then the target value is a percent value that
/// represents how much of the CPU can be used before scaling out.
///
/// If the scaling policy specifies the ALBRequestCountPerTarget predefined
/// metric, specify the target utilization as the optimal average request count per target
/// during any one-minute interval.
///
@required
TargetValue: MetricScale
/// A predefined metric. You can specify either a predefined metric or a customized
/// metric.
PredefinedMetricSpecification: PredefinedMetricSpecification
/// A customized metric. You can specify either a predefined metric or a customized
/// metric.
CustomizedMetricSpecification: CustomizedMetricSpecification
/// The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
/// For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
ScaleOutCooldown: Cooldown
/// The amount of time, in seconds, after a scale-in activity completes before another
/// scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
ScaleInCooldown: Cooldown
/// Indicates whether scale in by the target tracking scaling policy is disabled. If the
/// value is true, scale in is disabled and the target tracking scaling policy
/// won't remove capacity from the scalable target. Otherwise, scale in is enabled and the
/// target tracking scaling policy can remove capacity from the scalable target. The default
/// value is false.
DisableScaleIn: DisableScaleIn
}
/// The request contains too many tags. Try the request again with fewer tags.
@error("client")
@httpError(400)
structure TooManyTagsException {
Message: ExceptionMessage
/// The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).
ResourceName: AmazonResourceName
}
@input
structure UntagResourceRequest {
/// Identifies the Application Auto Scaling scalable target from which to remove tags.
/// For example:
/// arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
///
/// To get the ARN for a scalable target, use DescribeScalableTargets.
@required
ResourceARN: AmazonResourceName
/// One or more tag keys. Specify only the tag keys, not the tag values.
@required
TagKeys: TagKeyList
}
@output
structure UntagResourceResponse {}
/// An exception was thrown for a validation issue. Review the available parameters for the
/// API request.
@awsQueryError(
code: "ValidationException"
httpResponseCode: 400
)
@error("client")
@httpError(400)
structure ValidationException {
Message: ErrorMessage
}
list Alarms {
member: Alarm
}
list MetricDimensions {
member: MetricDimension
}
list NotScaledReasons {
member: NotScaledReason
}
@length(
min: 0
max: 50
)
list ResourceIdsMaxLen1600 {
member: ResourceIdMaxLen1600
}
list ScalableTargets {
member: ScalableTarget
}
list ScalingActivities {
member: ScalingActivity
}
list ScalingPolicies {
member: ScalingPolicy
}
list ScheduledActions {
member: ScheduledAction
}
list StepAdjustments {
member: StepAdjustment
}
@length(
min: 0
max: 200
)
list TagKeyList {
member: TagKey
}
list TargetTrackingMetricDataQueries {
member: TargetTrackingMetricDataQuery
}
list TargetTrackingMetricDimensions {
member: TargetTrackingMetricDimension
}
map TagMap {
key: TagKey
value: TagValue
}
enum AdjustmentType {
ChangeInCapacity
PercentChangeInCapacity
ExactCapacity
}
@length(
min: 1
max: 1011
)
@pattern("^arn:.+:application-autoscaling:.+:[0-9]+:scalable-target\\/[a-zA-Z0-9-]+$")
string AmazonResourceName
integer Cooldown
boolean DisableScaleIn
string ErrorMessage
string ExceptionMessage
@length(
min: 1
max: 2048
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string Expression
@length(
min: 1
max: 255
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string Id
boolean IncludeNotScaledActivities
integer MaxResults
enum MetricAggregationType {
Average
Minimum
Maximum
}
string MetricDimensionName
string MetricDimensionValue
string MetricName
string MetricNamespace
double MetricScale
enum MetricStatistic {
Average
Minimum
Maximum
SampleCount
Sum
}
enum MetricType {
DynamoDBReadCapacityUtilization
DynamoDBWriteCapacityUtilization
ALBRequestCountPerTarget
RDSReaderAverageCPUUtilization
RDSReaderAverageDatabaseConnections
EC2SpotFleetRequestAverageCPUUtilization
EC2SpotFleetRequestAverageNetworkIn
EC2SpotFleetRequestAverageNetworkOut
SageMakerVariantInvocationsPerInstance
ECSServiceAverageCPUUtilization
ECSServiceAverageMemoryUtilization
AppStreamAverageCapacityUtilization
ComprehendInferenceUtilization
LambdaProvisionedConcurrencyUtilization
CassandraReadCapacityUtilization
CassandraWriteCapacityUtilization
KafkaBrokerStorageUtilization
ElastiCachePrimaryEngineCPUUtilization
ElastiCacheReplicaEngineCPUUtilization
ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage
NeptuneReaderAverageCPUUtilization
SageMakerVariantProvisionedConcurrencyUtilization
ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage
}
string MetricUnit
integer MinAdjustmentMagnitude
@length(
min: 1
max: 256
)
@pattern("^\\p{Print}+$")
string PolicyName
enum PolicyType {
StepScaling
TargetTrackingScaling
}
integer ResourceCapacity
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string ResourceId
@length(
min: 1
max: 1600
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string ResourceIdMaxLen1600
@length(
min: 1
max: 1023
)
string ResourceLabel
boolean ReturnData
enum ScalableDimension {
ECSServiceDesiredCount = "ecs:service:DesiredCount"
EC2SpotFleetRequestTargetCapacity = "ec2:spot-fleet-request:TargetCapacity"
EMRInstanceGroupInstanceCount = "elasticmapreduce:instancegroup:InstanceCount"
AppstreamFleetDesiredCapacity = "appstream:fleet:DesiredCapacity"
DynamoDBTableReadCapacityUnits = "dynamodb:table:ReadCapacityUnits"
DynamoDBTableWriteCapacityUnits = "dynamodb:table:WriteCapacityUnits"
DynamoDBIndexReadCapacityUnits = "dynamodb:index:ReadCapacityUnits"
DynamoDBIndexWriteCapacityUnits = "dynamodb:index:WriteCapacityUnits"
RDSClusterReadReplicaCount = "rds:cluster:ReadReplicaCount"
SageMakerVariantDesiredInstanceCount = "sagemaker:variant:DesiredInstanceCount"
CustomResourceScalableDimension = "custom-resource:ResourceType:Property"
ComprehendDocClassifierEndpointInferenceUnits = "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
ComprehendEntityRecognizerEndpointInferenceUnits = "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
LambdaFunctionProvisionedConcurrency = "lambda:function:ProvisionedConcurrency"
CassandraTableReadCapacityUnits = "cassandra:table:ReadCapacityUnits"
CassandraTableWriteCapacityUnits = "cassandra:table:WriteCapacityUnits"
KafkaBrokerStorageVolumeSize = "kafka:broker-storage:VolumeSize"
ElastiCacheReplicationGroupNodeGroups = "elasticache:replication-group:NodeGroups"
ElastiCacheReplicationGroupReplicas = "elasticache:replication-group:Replicas"
NeptuneClusterReadReplicaCount = "neptune:cluster:ReadReplicaCount"
SageMakerVariantDesiredProvisionedConcurrency = "sagemaker:variant:DesiredProvisionedConcurrency"
}
enum ScalingActivityStatusCode {
Pending
InProgress
Successful
Overridden
Unfulfilled
Failed
}
integer ScalingAdjustment
boolean ScalingSuspended
@length(
min: 1
max: 256
)
@pattern("^(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+$")
string ScheduledActionName
enum ServiceNamespace {
ECS = "ecs"
EMR = "elasticmapreduce"
EC2 = "ec2"
APPSTREAM = "appstream"
DYNAMODB = "dynamodb"
RDS = "rds"
SAGEMAKER = "sagemaker"
CUSTOM_RESOURCE = "custom-resource"
COMPREHEND = "comprehend"
LAMBDA = "lambda"
CASSANDRA = "cassandra"
KAFKA = "kafka"
ELASTICACHE = "elasticache"
NEPTUNE = "neptune"
}
@length(
min: 1
max: 128
)
string TagKey
@length(
min: 0
max: 256
)
string TagValue
@length(
min: 1
max: 255
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string TargetTrackingMetricDimensionName
@length(
min: 1
max: 1024
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string TargetTrackingMetricDimensionValue
@length(
min: 1
max: 255
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string TargetTrackingMetricName
@length(
min: 1
max: 255
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string TargetTrackingMetricNamespace
@length(
min: 1
max: 1023
)
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string TargetTrackingMetricUnit
timestamp TimestampType
@pattern("^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$")
string XmlString