Module Smaws_Client_ApplicationAutoScaling.Types

type nonrec xml_string = string
type nonrec error_message = string
type nonrec validation_exception = {
  1. message : error_message option;
}

An exception was thrown for a validation issue. Review the available parameters for the API request.

type nonrec untag_resource_response = unit
type nonrec amazon_resource_name = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    One or more tag keys. Specify only the tag keys, not the tag values.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

    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.

    *)
}
type nonrec exception_message = string
type nonrec resource_not_found_exception = {
  1. resource_name : amazon_resource_name option;
    (*

    The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

    *)
  2. message : exception_message option;
}

The specified resource doesn't exist.

type nonrec too_many_tags_exception = {
  1. resource_name : amazon_resource_name option;
    (*

    The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

    *)
  2. message : exception_message option;
}

The request contains too many tags. Try the request again with fewer tags.

type nonrec timestamp_type = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec metric_scale = float
type nonrec metric_type =
  1. | ECSServiceAverageMemoryUtilizationHighResolution
  2. | ECSServiceAverageCPUUtilizationHighResolution
  3. | SageMakerVariantConcurrentRequestsPerModelHighResolution
  4. | SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution
  5. | WorkSpacesAverageUserSessionsCapacityUtilization
  6. | SageMakerInferenceComponentInvocationsPerCopy
  7. | ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage
  8. | SageMakerVariantProvisionedConcurrencyUtilization
  9. | NeptuneReaderAverageCPUUtilization
  10. | ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage
  11. | ElastiCacheReplicaEngineCPUUtilization
  12. | ElastiCachePrimaryEngineCPUUtilization
  13. | ElastiCacheDatabaseMemoryUsagePercentage
  14. | ElastiCacheEngineCPUUtilization
  15. | KafkaBrokerStorageUtilization
  16. | CassandraWriteCapacityUtilization
  17. | CassandraReadCapacityUtilization
  18. | LambdaProvisionedConcurrencyUtilization
  19. | ComprehendInferenceUtilization
  20. | AppStreamAverageCapacityUtilization
  21. | ECSServiceAverageMemoryUtilization
  22. | ECSServiceAverageCPUUtilization
  23. | SageMakerVariantInvocationsPerInstance
  24. | EC2SpotFleetRequestAverageNetworkOut
  25. | EC2SpotFleetRequestAverageNetworkIn
  26. | EC2SpotFleetRequestAverageCPUUtilization
  27. | RDSReaderAverageDatabaseConnections
  28. | RDSReaderAverageCPUUtilization
  29. | ALBRequestCountPerTarget
  30. | DynamoDBWriteCapacityUtilization
  31. | DynamoDBReadCapacityUtilization
type nonrec resource_label = string
type nonrec predefined_metric_specification = {
  1. resource_label : resource_label option;
    (*

    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.

    *)
  2. predefined_metric_type : metric_type;
    (*

    The metric type. The following are notes about specific metric types:

    • ALBRequestCountPerTarget - This metric type applies only to Spot Fleets and ECS services.
    • ECSServiceAverageCPUUtilizationHighResolution - The high-resolution version of ECSServiceAverageCPUUtilization that uses 20-second CloudWatch metrics. Use this metric for target tracking scaling policies that evaluate metrics every 20 seconds. You must enable high-resolution metrics in Amazon ECS before creating a scaling policy with this metric type.
    • ECSServiceAverageMemoryUtilizationHighResolution - The high-resolution version of ECSServiceAverageMemoryUtilization that uses 20-second CloudWatch metrics. Use this metric for target tracking scaling policies that evaluate metrics every 20 seconds. You must enable high-resolution metrics in Amazon ECS before creating a scaling policy with this metric type.
    *)
}

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

For more information, Predefined metrics for target tracking scaling policies in the Application Auto Scaling User Guide.

type nonrec metric_name = string
type nonrec metric_namespace = string
type nonrec metric_dimension_name = string
type nonrec metric_dimension_value = string
type nonrec metric_dimension = {
  1. value : metric_dimension_value;
    (*

    The value of the dimension.

    *)
  2. name : metric_dimension_name;
    (*

    The name of the dimension.

    *)
}

Describes the dimension names and values associated with a metric.

type nonrec metric_dimensions = metric_dimension list
type nonrec metric_statistic =
  1. | Sum
  2. | SampleCount
  3. | Maximum
  4. | Minimum
  5. | Average
type nonrec metric_unit = string
type nonrec expression = string
type nonrec id = string
type nonrec target_tracking_metric_dimension_name = string
type nonrec target_tracking_metric_dimension_value = string
type nonrec target_tracking_metric_dimension = {
  1. value : target_tracking_metric_dimension_value;
    (*

    The value of the dimension.

    *)
  2. name : target_tracking_metric_dimension_name;
    (*

    The name of the dimension.

    *)
}

Describes the dimension of a metric.

type nonrec target_tracking_metric_dimensions = target_tracking_metric_dimension list
type nonrec target_tracking_metric_name = string
type nonrec target_tracking_metric_namespace = string
type nonrec target_tracking_metric = {
  1. namespace : target_tracking_metric_namespace option;
    (*

    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.

    *)
  2. metric_name : target_tracking_metric_name option;
    (*

    The name of the metric.

    *)
  3. dimensions : target_tracking_metric_dimensions option;
    (*

    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.

    *)
}

Represents a specific metric.

Metric is a property of the TargetTrackingMetricStat object.

type nonrec target_tracking_metric_unit = string
type nonrec target_tracking_metric_stat = {
  1. unit_ : target_tracking_metric_unit option;
    (*

    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.

    *)
  2. stat : xml_string;
    (*

    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.

    *)
  3. metric : target_tracking_metric;
    (*

    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.

    *)
}

This structure defines the CloudWatch metric to return, along with the statistic and unit.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.

type nonrec return_data = bool
type nonrec target_tracking_metric_data_query = {
  1. return_data : return_data option;
    (*

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

    *)
  2. metric_stat : target_tracking_metric_stat option;
    (*

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

    *)
  3. label : xml_string option;
    (*

    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.

    *)
  4. id : id;
    (*

    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.

    *)
  5. expression : expression option;
    (*

    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.

    *)
}

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.

type nonrec target_tracking_metric_data_queries = target_tracking_metric_data_query list
type nonrec customized_metric_specification = {
  1. metrics : target_tracking_metric_data_queries option;
    (*

    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.

    *)
  2. unit_ : metric_unit option;
    (*

    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.

    *)
  3. statistic : metric_statistic option;
    (*

    The statistic of the metric.

    *)
  4. dimensions : metric_dimensions option;
    (*

    The dimensions of the metric.

    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

    *)
  5. namespace : metric_namespace option;
    (*

    The namespace of the metric.

    *)
  6. metric_name : metric_name option;
    (*

    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.

    *)
}

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.

type nonrec cooldown = int
type nonrec disable_scale_in = bool
type nonrec target_tracking_scaling_policy_configuration = {
  1. disable_scale_in : disable_scale_in option;
    (*

    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.

    *)
  2. scale_in_cooldown : cooldown option;
    (*

    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.

    *)
  3. scale_out_cooldown : cooldown option;
    (*

    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.

    *)
  4. customized_metric_specification : customized_metric_specification option;
    (*

    A customized metric. You can specify either a predefined metric or a customized metric.

    *)
  5. predefined_metric_specification : predefined_metric_specification option;
    (*

    A predefined metric. You can specify either a predefined metric or a customized metric.

    *)
  6. target_value : metric_scale;
    (*

    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.

    *)
}

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.

type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag_map = (tag_key * tag_value) list
type nonrec tag_resource_request = {
  1. tags : tag_map;
    (*

    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 User Guide.

    *)
  2. resource_ar_n : amazon_resource_name;
    (*

    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.

    *)
}
type nonrec scaling_suspended = bool
type nonrec suspended_state = {
  1. scheduled_scaling_suspended : scaling_suspended option;
    (*

    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.

    *)
  2. dynamic_scaling_out_suspended : scaling_suspended option;
    (*

    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.

    *)
  3. dynamic_scaling_in_suspended : scaling_suspended option;
    (*

    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.

    *)
}

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

type nonrec adjustment_type =
  1. | ExactCapacity
  2. | PercentChangeInCapacity
  3. | ChangeInCapacity
type nonrec scaling_adjustment = int
type nonrec step_adjustment = {
  1. scaling_adjustment : scaling_adjustment;
    (*

    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.

    *)
  2. metric_interval_upper_bound : metric_scale option;
    (*

    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.

    *)
  3. metric_interval_lower_bound : metric_scale option;
    (*

    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.

    *)
}

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.
type nonrec step_adjustments = step_adjustment list
type nonrec min_adjustment_magnitude = int
type nonrec metric_aggregation_type =
  1. | Maximum
  2. | Minimum
  3. | Average
type nonrec step_scaling_policy_configuration = {
  1. metric_aggregation_type : metric_aggregation_type option;
    (*

    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.

    *)
  2. cooldown : cooldown option;
    (*

    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.

    *)
  3. min_adjustment_magnitude : min_adjustment_magnitude option;
    (*

    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.

    *)
  4. step_adjustments : step_adjustments option;
    (*

    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.

    *)
  5. adjustment_type : adjustment_type option;
    (*

    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.

    *)
}

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.

type nonrec service_namespace =
  1. | WORKSPACES
  2. | NEPTUNE
  3. | ELASTICACHE
  4. | KAFKA
  5. | CASSANDRA
  6. | LAMBDA
  7. | COMPREHEND
  8. | CUSTOM_RESOURCE
  9. | SAGEMAKER
  10. | RDS
  11. | DYNAMODB
  12. | APPSTREAM
  13. | EC2
  14. | EMR
  15. | ECS
type nonrec scheduled_action_name = string
type nonrec resource_id_max_len1600 = string
type nonrec scalable_dimension =
  1. | WorkSpacesWorkSpacesPoolDesiredUserSessions
  2. | SageMakerInferenceComponentDesiredCopyCount
  3. | SageMakerVariantDesiredProvisionedConcurrency
  4. | NeptuneClusterReadReplicaCount
  5. | ElastiCacheReplicationGroupReplicas
  6. | ElastiCacheReplicationGroupNodeGroups
  7. | ElastiCacheCacheClusterNodes
  8. | KafkaBrokerStorageVolumeSize
  9. | CassandraTableWriteCapacityUnits
  10. | CassandraTableReadCapacityUnits
  11. | LambdaFunctionProvisionedConcurrency
  12. | ComprehendEntityRecognizerEndpointInferenceUnits
  13. | ComprehendDocClassifierEndpointInferenceUnits
  14. | CustomResourceScalableDimension
  15. | SageMakerVariantDesiredInstanceCount
  16. | RDSClusterReadReplicaCount
  17. | DynamoDBIndexWriteCapacityUnits
  18. | DynamoDBIndexReadCapacityUnits
  19. | DynamoDBTableWriteCapacityUnits
  20. | DynamoDBTableReadCapacityUnits
  21. | AppstreamFleetDesiredCapacity
  22. | EMRInstanceGroupInstanceCount
  23. | EC2SpotFleetRequestTargetCapacity
  24. | ECSServiceDesiredCount
type nonrec resource_capacity = int
type nonrec scalable_target_action = {
  1. max_capacity : resource_capacity option;
    (*

    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.

    *)
  2. min_capacity : resource_capacity option;
    (*

    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.

    *)
}

Represents the minimum and maximum capacity for a scheduled action.

type nonrec scheduled_action = {
  1. creation_time : timestamp_type;
    (*

    The date and time that the scheduled action was created.

    *)
  2. scalable_target_action : scalable_target_action option;
    (*

    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.

    *)
  3. end_time : timestamp_type option;
    (*

    The date and time that the action is scheduled to end, in UTC.

    *)
  4. start_time : timestamp_type option;
    (*

    The date and time that the action is scheduled to begin, in UTC.

    *)
  5. scalable_dimension : scalable_dimension option;
    (*

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  6. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  7. timezone : resource_id_max_len1600 option;
    (*

    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.

    *)
  8. schedule : resource_id_max_len1600;
    (*

    The schedule for this action. The following formats are supported:

    • At expressions - "

      at({i yyyy}-{i mm}-{i dd}T{i hh}:{i mm}:{i ss})

      "

    • Rate expressions - "

      rate({i value} {i unit})

      "

    • Cron expressions - "

      cron({i 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, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.

    *)
  9. service_namespace : service_namespace;
    (*

    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

    *)
  10. scheduled_action_ar_n : resource_id_max_len1600;
    (*

    The Amazon Resource Name (ARN) of the scheduled action.

    *)
  11. scheduled_action_name : scheduled_action_name;
    (*

    The name of the scheduled action.

    *)
}

Represents a scheduled action.

type nonrec scheduled_actions = scheduled_action list
type nonrec policy_name = string
type nonrec policy_type =
  1. | PredictiveScaling
  2. | TargetTrackingScaling
  3. | StepScaling
type nonrec predictive_scaling_metric_type = string
type nonrec predictive_scaling_predefined_metric_pair_specification = {
  1. resource_label : resource_label option;
    (*

    A label that uniquely identifies a specific target group from which to determine the total and average request count.

    *)
  2. predefined_metric_type : predictive_scaling_metric_type;
    (*

    Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric.

    *)
}

Represents a metric pair for a predictive scaling policy.

The following predefined metrics are available for predictive scaling:

  • ECSServiceAverageCPUUtilization
  • ECSServiceAverageMemoryUtilization
  • ECSServiceCPUUtilization
  • ECSServiceMemoryUtilization
  • ECSServiceTotalCPUUtilization
  • ECSServiceTotalMemoryUtilization
  • ALBRequestCount
  • ALBRequestCountPerTarget
  • TotalALBRequestCount
type nonrec predictive_scaling_predefined_scaling_metric_specification = {
  1. resource_label : resource_label option;
    (*

    A label that uniquely identifies a specific target group from which to determine the average request count.

    *)
  2. predefined_metric_type : predictive_scaling_metric_type;
    (*

    The metric type.

    *)
}

Describes a scaling metric for a predictive scaling policy.

When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.

The following predefined metrics are available for predictive scaling:

  • ECSServiceAverageCPUUtilization
  • ECSServiceAverageMemoryUtilization
  • ECSServiceCPUUtilization
  • ECSServiceMemoryUtilization
  • ECSServiceTotalCPUUtilization
  • ECSServiceTotalMemoryUtilization
  • ALBRequestCount
  • ALBRequestCountPerTarget
  • TotalALBRequestCount
type nonrec predictive_scaling_predefined_load_metric_specification = {
  1. resource_label : resource_label option;
    (*

    A label that uniquely identifies a target group.

    *)
  2. predefined_metric_type : predictive_scaling_metric_type;
    (*

    The metric type.

    *)
}

Describes a load metric for a predictive scaling policy.

When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.

The following predefined metrics are available for predictive scaling:

  • ECSServiceAverageCPUUtilization
  • ECSServiceAverageMemoryUtilization
  • ECSServiceCPUUtilization
  • ECSServiceMemoryUtilization
  • ECSServiceTotalCPUUtilization
  • ECSServiceTotalMemoryUtilization
  • ALBRequestCount
  • ALBRequestCountPerTarget
  • TotalALBRequestCount
type nonrec predictive_scaling_metric_dimension_name = string
type nonrec predictive_scaling_metric_dimension_value = string
type nonrec predictive_scaling_metric_dimension = {
  1. value : predictive_scaling_metric_dimension_value;
    (*

    The value of the dimension.

    *)
  2. name : predictive_scaling_metric_dimension_name;
    (*

    The name of the dimension.

    *)
}

Describes the dimension of a metric.

type nonrec predictive_scaling_metric_dimensions = predictive_scaling_metric_dimension list
type nonrec predictive_scaling_metric_name = string
type nonrec predictive_scaling_metric_namespace = string
type nonrec predictive_scaling_metric = {
  1. namespace : predictive_scaling_metric_namespace option;
    (*

    The namespace of the metric.

    *)
  2. metric_name : predictive_scaling_metric_name option;
    (*

    The name of the metric.

    *)
  3. dimensions : predictive_scaling_metric_dimensions option;
    (*

    Describes the dimensions of the metric.

    *)
}

Describes the scaling metric.

type nonrec predictive_scaling_metric_unit = string
type nonrec predictive_scaling_metric_stat = {
  1. unit_ : predictive_scaling_metric_unit option;
    (*

    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.

    *)
  2. stat : xml_string;
    (*

    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 metrics for predictive scaling are Average and Sum.

    *)
  3. metric : predictive_scaling_metric;
    (*

    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.

    *)
}

This structure defines the CloudWatch metric to return, along with the statistic and unit.

type nonrec predictive_scaling_metric_data_query = {
  1. return_data : return_data option;
    (*

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

    *)
  2. label : xml_string option;
    (*

    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.

    *)
  3. metric_stat : predictive_scaling_metric_stat option;
    (*

    Information about the metric data to return.

    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

    *)
  4. expression : expression option;
    (*

    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 MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

    *)
  5. id : id;
    (*

    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.

    *)
}

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.

type nonrec predictive_scaling_metric_data_queries = predictive_scaling_metric_data_query list
type nonrec predictive_scaling_customized_metric_specification = {
  1. metric_data_queries : predictive_scaling_metric_data_queries;
    (*

    One or more metric data queries to provide data points for a metric specification.

    *)
}

Represents a CloudWatch metric of your choosing for a predictive scaling policy.

type nonrec predictive_scaling_metric_specification = {
  1. customized_capacity_metric_specification : predictive_scaling_customized_metric_specification option;
    (*

    The customized capacity metric specification.

    *)
  2. customized_load_metric_specification : predictive_scaling_customized_metric_specification option;
    (*

    The customized load metric specification.

    *)
  3. customized_scaling_metric_specification : predictive_scaling_customized_metric_specification option;
    (*

    The customized scaling metric specification.

    *)
  4. predefined_load_metric_specification : predictive_scaling_predefined_load_metric_specification option;
    (*

    The predefined load metric specification.

    *)
  5. predefined_scaling_metric_specification : predictive_scaling_predefined_scaling_metric_specification option;
    (*

    The predefined scaling metric specification.

    *)
  6. predefined_metric_pair_specification : predictive_scaling_predefined_metric_pair_specification option;
    (*

    The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.

    *)
  7. target_value : metric_scale;
    (*

    Specifies the target utilization.

    *)
}

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

type nonrec predictive_scaling_metric_specifications = predictive_scaling_metric_specification list
type nonrec predictive_scaling_mode =
  1. | ForecastAndScale
  2. | ForecastOnly
type nonrec predictive_scaling_scheduling_buffer_time = int
type nonrec predictive_scaling_max_capacity_breach_behavior =
  1. | IncreaseMaxCapacity
  2. | HonorMaxCapacity
type nonrec predictive_scaling_max_capacity_buffer = int
type nonrec predictive_scaling_policy_configuration = {
  1. max_capacity_buffer : predictive_scaling_max_capacity_buffer option;
    (*

    The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

    Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and cannot be used otherwise.

    *)
  2. max_capacity_breach_behavior : predictive_scaling_max_capacity_breach_behavior option;
    (*

    Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity. Defaults to HonorMaxCapacity if not specified.

    *)
  3. scheduling_buffer_time : predictive_scaling_scheduling_buffer_time option;
    (*

    The amount of time, in seconds, that the start time can be advanced.

    The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.

    *)
  4. mode : predictive_scaling_mode option;
    (*

    The predictive scaling mode. Defaults to ForecastOnly if not specified.

    *)
  5. metric_specifications : predictive_scaling_metric_specifications;
    (*

    This structure includes the metrics and target utilization to use for predictive scaling.

    This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.

    *)
}

Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.

type nonrec resource_id = string
type nonrec alarm = {
  1. alarm_ar_n : resource_id;
    (*

    The Amazon Resource Name (ARN) of the alarm.

    *)
  2. alarm_name : resource_id;
    (*

    The name of the alarm.

    *)
}

Represents a CloudWatch alarm associated with a scaling policy.

type nonrec alarms = alarm list
type nonrec scaling_policy = {
  1. creation_time : timestamp_type;
    (*

    The Unix timestamp for when the scaling policy was created.

    *)
  2. alarms : alarms option;
    (*

    The CloudWatch alarms associated with the scaling policy.

    *)
  3. predictive_scaling_policy_configuration : predictive_scaling_policy_configuration option;
    (*

    The predictive scaling policy configuration.

    *)
  4. target_tracking_scaling_policy_configuration : target_tracking_scaling_policy_configuration option;
    (*

    A target tracking scaling policy.

    *)
  5. step_scaling_policy_configuration : step_scaling_policy_configuration option;
    (*

    A step scaling policy.

    *)
  6. policy_type : policy_type;
    (*

    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.

    PredictiveScaling—Only supported for Amazon ECS

    *)
  7. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  8. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  9. service_namespace : service_namespace;
    (*

    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

    *)
  10. policy_name : policy_name;
    (*

    The name of the scaling policy.

    *)
  11. policy_ar_n : resource_id_max_len1600;
    (*

    The Amazon Resource Name (ARN) of the scaling policy.

    *)
}

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.

type nonrec scaling_policies = scaling_policy list
type nonrec scaling_activity_status_code =
  1. | Failed
  2. | Unfulfilled
  3. | Overridden
  4. | Successful
  5. | InProgress
  6. | Pending
type nonrec not_scaled_reason = {
  1. current_capacity : resource_capacity option;
    (*

    The current capacity.

    *)
  2. min_capacity : resource_capacity option;
    (*

    The minimum capacity.

    *)
  3. max_capacity : resource_capacity option;
    (*

    The maximum capacity.

    *)
  4. code : xml_string;
    (*

    A code that represents the reason for not scaling.

    Valid values:

    • AutoScalingAnticipatedFlapping
    • TargetServicePutResourceAsUnscalable
    • AlreadyAtMaxCapacity
    • AlreadyAtMinCapacity
    • AlreadyAtDesiredCapacity
    *)
}

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 in the Application Auto Scaling User Guide.

type nonrec not_scaled_reasons = not_scaled_reason list
type nonrec scaling_activity = {
  1. not_scaled_reasons : not_scaled_reasons option;
    (*

    Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.

    *)
  2. details : xml_string option;
    (*

    The details about the scaling activity.

    *)
  3. status_message : xml_string option;
    (*

    A simple message about the current status of the scaling activity.

    *)
  4. status_code : scaling_activity_status_code;
    (*

    Indicates the status of the scaling activity.

    *)
  5. end_time : timestamp_type option;
    (*

    The Unix timestamp for when the scaling activity ended.

    *)
  6. start_time : timestamp_type;
    (*

    The Unix timestamp for when the scaling activity began.

    *)
  7. cause : xml_string;
    (*

    A simple description of what caused the scaling activity to happen.

    *)
  8. description : xml_string;
    (*

    A simple description of what action the scaling activity intends to accomplish.

    *)
  9. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  10. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  11. service_namespace : service_namespace;
    (*

    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

    *)
  12. activity_id : resource_id;
    (*

    The unique identifier of the scaling activity.

    *)
}

Represents a scaling activity.

type nonrec scaling_activities = scaling_activity list
type nonrec scalable_target = {
  1. scalable_target_ar_n : xml_string option;
    (*

    The ARN of the scalable target.

    *)
  2. suspended_state : suspended_state option;
    (*

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

    *)
  3. creation_time : timestamp_type;
    (*

    The Unix timestamp for when the scalable target was created.

    *)
  4. role_ar_n : resource_id_max_len1600;
    (*

    The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

    *)
  5. predicted_capacity : resource_capacity option;
    (*

    The predicted capacity of the scalable target.

    *)
  6. max_capacity : resource_capacity;
    (*

    The maximum value to scale to in response to a scale-out activity.

    *)
  7. min_capacity : resource_capacity;
    (*

    The minimum value to scale to in response to a scale-in activity.

    *)
  8. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  9. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  10. service_namespace : service_namespace;
    (*

    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

    *)
}

Represents a scalable target.

type nonrec scalable_targets = scalable_target list
type nonrec resource_ids_max_len1600 = resource_id_max_len1600 list
type nonrec register_scalable_target_response = {
  1. scalable_target_ar_n : xml_string option;
    (*

    The ARN of the scalable target.

    *)
}
type nonrec register_scalable_target_request = {
  1. tags : tag_map option;
    (*

    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.

    *)
  2. suspended_state : suspended_state option;
    (*

    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 Suspend and resume scaling in the Application Auto Scaling User Guide.

    *)
  3. role_ar_n : resource_id_max_len1600 option;
    (*

    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 How Application Auto Scaling works with IAM.

    *)
  4. max_capacity : resource_capacity option;
    (*

    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.

    *)
  5. min_capacity : resource_capacity option;
    (*

    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 inference components
    • 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.

    *)
  6. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  7. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  8. service_namespace : service_namespace;
    (*

    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.

    *)
}
type nonrec limit_exceeded_exception = {
  1. message : error_message option;
}

A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.

type nonrec internal_service_exception = {
  1. message : error_message option;
}

The service encountered an internal error.

type nonrec concurrent_update_exception = {
  1. message : error_message option;
}

Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.

type nonrec put_scheduled_action_response = unit
type nonrec put_scheduled_action_request = {
  1. scalable_target_action : scalable_target_action option;
    (*

    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.

    *)
  2. end_time : timestamp_type option;
    (*

    The date and time for the recurring schedule to end, in UTC.

    *)
  3. start_time : timestamp_type option;
    (*

    The date and time for this scheduled action to start, in UTC.

    *)
  4. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  5. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  6. scheduled_action_name : scheduled_action_name;
    (*

    The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.

    *)
  7. timezone : resource_id_max_len1600 option;
    (*

    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.

    *)
  8. schedule : resource_id_max_len1600 option;
    (*

    The schedule for this action. The following formats are supported:

    • At expressions - "

      at({i yyyy}-{i mm}-{i dd}T{i hh}:{i mm}:{i ss})

      "

    • Rate expressions - "

      rate({i value} {i unit})

      "

    • Cron expressions - "

      cron({i 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, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.

    *)
  9. service_namespace : service_namespace;
    (*

    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.

    *)
}
type nonrec object_not_found_exception = {
  1. message : error_message option;
}

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.

type nonrec put_scaling_policy_response = {
  1. alarms : alarms option;
    (*

    The CloudWatch alarms created for the target tracking scaling policy.

    *)
  2. policy_ar_n : resource_id_max_len1600;
    (*

    The Amazon Resource Name (ARN) of the resulting scaling policy.

    *)
}
type nonrec put_scaling_policy_request = {
  1. predictive_scaling_policy_configuration : predictive_scaling_policy_configuration option;
    (*

    The configuration of the predictive scaling policy.

    *)
  2. target_tracking_scaling_policy_configuration : target_tracking_scaling_policy_configuration option;
    (*

    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.

    *)
  3. step_scaling_policy_configuration : step_scaling_policy_configuration option;
    (*

    A step scaling policy.

    This parameter is required if you are creating a policy and the policy type is StepScaling.

    *)
  4. policy_type : policy_type option;
    (*

    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.

    PredictiveScaling—Only supported for Amazon ECS.

    For more information, see Target tracking scaling policies, Step scaling policies, and Predictive scaling policies in the Application Auto Scaling User Guide.

    *)
  5. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  6. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  7. service_namespace : service_namespace;
    (*

    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.

    *)
  8. policy_name : policy_name;
    (*

    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.

    *)
}
type nonrec failed_resource_access_exception = {
  1. message : error_message option;
}

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.

type nonrec predictive_scaling_forecast_values = metric_scale list
type nonrec predictive_scaling_forecast_timestamps = timestamp_type list
type nonrec max_results = int
type nonrec load_forecast = {
  1. metric_specification : predictive_scaling_metric_specification;
    (*

    The metric specification for the load forecast.

    *)
  2. values : predictive_scaling_forecast_values;
    (*

    The values of the data points.

    *)
  3. timestamps : predictive_scaling_forecast_timestamps;
    (*

    The timestamps for the data points, in UTC format.

    *)
}

A GetPredictiveScalingForecast call returns the load forecast for a predictive scaling policy. This structure includes the data points for that load forecast, along with the timestamps of those data points and the metric specification.

type nonrec load_forecasts = load_forecast list
type nonrec list_tags_for_resource_response = {
  1. tags : tag_map option;
    (*

    A list of tags. Each tag consists of a tag key and a tag value.

    *)
}
type nonrec list_tags_for_resource_request = {
  1. resource_ar_n : amazon_resource_name;
    (*

    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.

    *)
}
type nonrec invalid_next_token_exception = {
  1. message : error_message option;
}

The next token supplied was invalid.

type nonrec include_not_scaled_activities = bool
type nonrec capacity_forecast = {
  1. values : predictive_scaling_forecast_values;
    (*

    The values of the data points.

    *)
  2. timestamps : predictive_scaling_forecast_timestamps;
    (*

    The timestamps for the data points, in UTC format.

    *)
}

A GetPredictiveScalingForecast call returns the capacity forecast for a predictive scaling policy. This structure includes the data points for that capacity forecast, along with the timestamps of those data points.

type nonrec get_predictive_scaling_forecast_response = {
  1. update_time : timestamp_type option;
    (*

    The time the forecast was made.

    *)
  2. capacity_forecast : capacity_forecast option;
    (*

    The capacity forecast.

    *)
  3. load_forecast : load_forecasts option;
    (*

    The load forecast.

    *)
}
type nonrec get_predictive_scaling_forecast_request = {
  1. end_time : timestamp_type;
    (*

    The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.

    *)
  2. start_time : timestamp_type;
    (*

    The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time

    *)
  3. policy_name : policy_name;
    (*

    The name of the policy.

    *)
  4. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension.

    *)
  5. resource_id : resource_id_max_len1600;
    (*

    The identifier of the resource.

    *)
  6. service_namespace : service_namespace;
    (*

    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.

    *)
}
type nonrec describe_scheduled_actions_response = {
  1. next_token : xml_string option;
    (*

    The token required to get the next set of results. This value is null if there are no more results to return.

    *)
  2. scheduled_actions : scheduled_actions option;
    (*

    Information about the scheduled actions.

    *)
}
type nonrec describe_scheduled_actions_request = {
  1. next_token : xml_string option;
    (*

    The token for the next set of results.

    *)
  2. max_results : max_results option;
    (*

    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.

    *)
  3. scalable_dimension : scalable_dimension option;
    (*

    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 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  4. resource_id : resource_id_max_len1600 option;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  5. service_namespace : service_namespace;
    (*

    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.

    *)
  6. scheduled_action_names : resource_ids_max_len1600 option;
    (*

    The names of the scheduled actions to describe.

    *)
}
type nonrec describe_scaling_policies_response = {
  1. next_token : xml_string option;
    (*

    The token required to get the next set of results. This value is null if there are no more results to return.

    *)
  2. scaling_policies : scaling_policies option;
    (*

    Information about the scaling policies.

    *)
}
type nonrec describe_scaling_policies_request = {
  1. next_token : xml_string option;
    (*

    The token for the next set of results.

    *)
  2. max_results : max_results option;
    (*

    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.

    *)
  3. scalable_dimension : scalable_dimension option;
    (*

    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 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  4. resource_id : resource_id_max_len1600 option;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  5. service_namespace : service_namespace;
    (*

    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.

    *)
  6. policy_names : resource_ids_max_len1600 option;
    (*

    The names of the scaling policies to describe.

    *)
}
type nonrec describe_scaling_activities_response = {
  1. next_token : xml_string option;
    (*

    The token required to get the next set of results. This value is null if there are no more results to return.

    *)
  2. scaling_activities : scaling_activities option;
    (*

    A list of scaling activity objects.

    *)
}
type nonrec describe_scaling_activities_request = {
  1. include_not_scaled_activities : include_not_scaled_activities option;
    (*

    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.

    *)
  2. next_token : xml_string option;
    (*

    The token for the next set of results.

    *)
  3. max_results : max_results option;
    (*

    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.

    *)
  4. scalable_dimension : scalable_dimension option;
    (*

    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 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  5. resource_id : resource_id_max_len1600 option;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  6. service_namespace : service_namespace;
    (*

    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.

    *)
}
type nonrec describe_scalable_targets_response = {
  1. next_token : xml_string option;
    (*

    The token required to get the next set of results. This value is null if there are no more results to return.

    *)
  2. scalable_targets : scalable_targets option;
    (*

    The scalable targets that match the request parameters.

    *)
}
type nonrec describe_scalable_targets_request = {
  1. next_token : xml_string option;
    (*

    The token for the next set of results.

    *)
  2. max_results : max_results option;
    (*

    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.

    *)
  3. scalable_dimension : scalable_dimension option;
    (*

    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 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  4. resource_ids : resource_ids_max_len1600 option;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  5. service_namespace : service_namespace;
    (*

    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.

    *)
}
type nonrec deregister_scalable_target_response = unit
type nonrec deregister_scalable_target_request = {
  1. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  2. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  3. service_namespace : service_namespace;
    (*

    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.

    *)
}
type nonrec delete_scheduled_action_response = unit
type nonrec delete_scheduled_action_request = {
  1. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  2. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  3. scheduled_action_name : resource_id_max_len1600;
    (*

    The name of the scheduled action.

    *)
  4. service_namespace : service_namespace;
    (*

    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.

    *)
}
type nonrec delete_scaling_policy_response = unit
type nonrec delete_scaling_policy_request = {
  1. scalable_dimension : scalable_dimension;
    (*

    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

    • ecs:service:DesiredCount - The 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 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:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    • workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    *)
  2. resource_id : resource_id_max_len1600;
    (*

    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/my-cluster/my-service.
    • 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.
    • Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name. Example: cache-cluster/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.
    • SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    • Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    *)
  3. service_namespace : service_namespace;
    (*

    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.

    *)
  4. policy_name : resource_id_max_len1600;
    (*

    The name of the scaling policy.

    *)
}