Smaws_Client_AutoScalingPlans.TypesAn exception was thrown for a validation issue. Review the parameters provided.
type nonrec scaling_plan_version = Smaws_Lib.CoreTypes.Int64.ttype nonrec tag_values = xml_string_max_len256 listtype nonrec tag_filter = {values : tag_values option;The tag values (0 to 20).
*)key : xml_string_max_len128 option;The tag key.
*)}Represents a tag.
type nonrec tag_filters = tag_filter listtype nonrec application_source = {tag_filters : tag_filters option;A set of tags (up to 50).
*)cloud_formation_stack_ar_n : xml_string option;The Amazon Resource Name (ARN) of a AWS CloudFormation stack.
*)}Represents an application source.
type nonrec scaling_metric_type = | EC2SpotFleetRequestAverageNetworkOut| EC2SpotFleetRequestAverageNetworkIn| EC2SpotFleetRequestAverageCPUUtilization| RDSReaderAverageDatabaseConnections| RDSReaderAverageCPUUtilization| ALBRequestCountPerTarget| ECSServiceAverageMemoryUtilization| ECSServiceAverageCPUUtilization| DynamoDBWriteCapacityUtilization| DynamoDBReadCapacityUtilization| ASGAverageNetworkOut| ASGAverageNetworkIn| ASGAverageCPUUtilizationtype nonrec predefined_scaling_metric_specification = {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 for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, 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 is app///targetgroup//, where:
This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
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.
*)predefined_scaling_metric_type : scaling_metric_type;The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
}Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.
type nonrec metric_dimension = {value : metric_dimension_value;The value of the dimension.
*)name : metric_dimension_name;The name of the dimension.
*)}Represents a dimension for a customized metric.
type nonrec metric_dimensions = metric_dimension listtype nonrec customized_scaling_metric_specification = {unit_ : metric_unit option;The unit of the metric.
*)statistic : metric_statistic;The statistic of the metric.
*)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 customized scaling metric specification.
*)namespace : metric_namespace;The namespace of the metric.
*)metric_name : metric_name;The name of the metric.
*)}Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.
To create your customized scaling metric specification:
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
type nonrec target_tracking_configuration = {estimated_instance_warmup : cooldown option;The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
*)scale_in_cooldown : cooldown option;The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-in cooldown period, the intention is to scale in conservatively to protect your application’s availability, so scale-in activities are blocked until the cooldown period has expired. However, if another alarm triggers a scale-out activity during the scale-in cooldown period, Auto Scaling scales out the target immediately. In this case, the scale-in cooldown period stops and doesn't complete.
*)scale_out_cooldown : cooldown option;The amount of time, in seconds, to wait for a previous scale-out activity to take effect. This property is not used if the scalable resource is an Auto Scaling group.
With the scale-out cooldown period, the intention is to continuously (but not excessively) scale out. After Auto Scaling successfully scales out using a target tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't increase the desired capacity again unless either a larger scale out is triggered or the cooldown period ends.
*)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 doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.
The default value is false.
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.
*)customized_scaling_metric_specification : customized_scaling_metric_specification
option;A customized metric. You can specify either a predefined metric or a customized metric.
*)predefined_scaling_metric_specification : predefined_scaling_metric_specification
option;A predefined metric. You can specify either a predefined metric or a customized metric.
*)}Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.
type nonrec target_tracking_configurations = target_tracking_configuration listtype nonrec predefined_load_metric_specification = {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 ALBTargetGroupRequestCount and there is a target group for an Application Load Balancer attached to the Auto Scaling group.
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 is app///targetgroup//, where:
This is an example: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
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.
*)predefined_load_metric_type : load_metric_type;The metric type.
*)}Represents a predefined metric that can be used for predictive scaling.
After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.
type nonrec customized_load_metric_specification = {unit_ : metric_unit option;The unit of the metric.
*)statistic : metric_statistic;The statistic of the metric. The only valid value is Sum.
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 customized load metric specification.
*)namespace : metric_namespace;The namespace of the metric.
*)metric_name : metric_name;The name of the metric.
*)}Represents a CloudWatch metric of your choosing that can be used for predictive scaling.
For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data.
When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.
If you publish your own metrics, you can aggregate the data points at a given interval and then publish the aggregated data points to CloudWatch. Before AWS Auto Scaling generates the forecast, it sums up all the metric data points that occurred within each hour to match the granularity period that is used in the forecast (60 minutes).
For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.
After creating your scaling plan, you can use the AWS Auto Scaling console to visualize forecasts for the specified metric. For more information, see View Scaling Information for a Resource in the AWS Auto Scaling User Guide.
type nonrec scaling_instruction = {disable_dynamic_scaling : disable_dynamic_scaling option;Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.
The default is enabled (false).
scaling_policy_update_behavior : scaling_policy_update_behavior option;Controls whether a resource's externally created scaling policies are kept or replaced.
The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.
Only valid when configuring dynamic scaling.
Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
*)predictive_scaling_mode : predictive_scaling_mode option;The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
predictive_scaling_max_capacity_buffer : resource_capacity 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.
Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
The range is 1-100.
*)predictive_scaling_max_capacity_behavior : predictive_scaling_max_capacity_behavior
option;Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
The following are possible values:
SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.Only valid when configuring predictive scaling.
*)scheduled_action_buffer_time : scheduled_action_buffer_time option;The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.
Only valid when configuring predictive scaling.
*)customized_load_metric_specification : customized_load_metric_specification
option;The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
*)predefined_load_metric_specification : predefined_load_metric_specification
option;The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
*)target_tracking_configurations : target_tracking_configurations;The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.
*)max_capacity : resource_capacity;The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
*)min_capacity : resource_capacity;The minimum capacity of the resource.
*)scalable_dimension : scalable_dimension;The scalable dimension associated with the resource.
autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.ecs:service:DesiredCount - The desired task count of an ECS service.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.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.resource_id : resource_id_max_len1600;The ID of the resource. This string consists of the resource type and unique identifier.
autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.table and the unique identifier is the resource ID. Example: table/my-table.index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.service_namespace : service_namespace;The namespace of the AWS service.
*)}Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource.
AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.
AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.
We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best Practices for AWS Auto Scaling in the AWS Auto Scaling User Guide.
type nonrec scaling_instructions = scaling_instruction listtype nonrec update_scaling_plan_request = {scaling_instructions : scaling_instructions option;The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
*)application_source : application_source option;A CloudFormation stack or set of tags.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
*)scaling_plan_version : scaling_plan_version;The version number of the scaling plan. The only valid value is 1. Currently, you cannot have multiple scaling plan versions.
scaling_plan_name : scaling_plan_name;The name of the scaling plan.
*)}The specified object could not be found.
The service encountered an internal error.
Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.
type nonrec scaling_policy = {target_tracking_configuration : target_tracking_configuration option;The target tracking scaling policy. Includes support for predefined or customized metrics.
*)policy_type : policy_type;The type of scaling policy.
*)policy_name : policy_name;The name of the scaling policy.
*)}Represents a scaling policy.
type nonrec scaling_policies = scaling_policy listtype nonrec scaling_plan = {creation_time : timestamp_type option;The Unix time stamp when the scaling plan was created.
*)status_start_time : timestamp_type option;The Unix time stamp when the scaling plan entered the current status.
*)status_message : xml_string option;A simple message about the current status of the scaling plan.
*)status_code : scaling_plan_status_code;The status of the scaling plan.
Active - The scaling plan is active.ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.CreationInProgress - The scaling plan is being created.CreationFailed - The scaling plan could not be created.DeletionInProgress - The scaling plan is being deleted.DeletionFailed - The scaling plan could not be deleted.UpdateInProgress - The scaling plan is being updated.UpdateFailed - The scaling plan could not be updated.scaling_instructions : scaling_instructions;The scaling instructions.
*)application_source : application_source;A CloudFormation stack or a set of tags. You can create one scaling plan per application source.
*)scaling_plan_version : scaling_plan_version;The version number of the scaling plan.
*)scaling_plan_name : scaling_plan_name;The name of the scaling plan.
*)}Represents a scaling plan.
type nonrec scaling_plans = scaling_plan listtype nonrec scaling_plan_resource = {scaling_status_message : xml_string option;A simple message about the current scaling status of the resource.
*)scaling_status_code : scaling_status_code;The scaling status of the resource.
Active - The scaling configuration is active.Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.scaling_policies : scaling_policies option;The scaling policies.
*)scalable_dimension : scalable_dimension;The scalable dimension for the resource.
autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.ecs:service:DesiredCount - The desired task count of an ECS service.ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.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.resource_id : resource_id_max_len1600;The ID of the resource. This string consists of the resource type and unique identifier.
autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.table and the unique identifier is the resource ID. Example: table/my-table.index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.service_namespace : service_namespace;The namespace of the AWS service.
*)scaling_plan_version : scaling_plan_version;The version number of the scaling plan.
*)scaling_plan_name : scaling_plan_name;The name of the scaling plan.
*)}Represents a scalable resource.
type nonrec scaling_plan_resources = scaling_plan_resource listtype nonrec scaling_plan_names = scaling_plan_name listYour account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.
The token provided is not valid.
type nonrec datapoint = {value : metric_scale option;The value of the data point.
*)timestamp : timestamp_type option;The time stamp for the data point in UTC format.
*)}Represents a single value in the forecast data used for predictive scaling.
type nonrec datapoints = datapoint listtype nonrec get_scaling_plan_resource_forecast_data_response = {datapoints : datapoints;The data points to return.
*)}type nonrec get_scaling_plan_resource_forecast_data_request = {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 seven days.
Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
*)start_time : timestamp_type;The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.
*)forecast_data_type : forecast_data_type;The type of forecast data to get.
LoadForecast: The load metric forecast.CapacityForecast: The capacity forecast.ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.scalable_dimension : scalable_dimension;The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
resource_id : xml_string;The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
service_namespace : service_namespace;The namespace of the AWS service. The only valid value is autoscaling.
scaling_plan_version : scaling_plan_version;The version number of the scaling plan. Currently, the only valid value is 1.
scaling_plan_name : scaling_plan_name;The name of the scaling plan.
*)}type nonrec describe_scaling_plans_response = {next_token : next_token option;The token required to get the next set of results. This value is null if there are no more results to return.
scaling_plans : scaling_plans option;Information about the scaling plans.
*)}type nonrec application_sources = application_source listtype nonrec describe_scaling_plans_request = {next_token : next_token option;The token for the next set of results.
*)max_results : max_results option;The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.
*)application_sources : application_sources option;The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
*)scaling_plan_version : scaling_plan_version option;The version number of the scaling plan. Currently, the only valid value is 1.
If you specify a scaling plan version, you must also specify a scaling plan name.
*)scaling_plan_names : scaling_plan_names option;The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
*)}type nonrec describe_scaling_plan_resources_response = {next_token : next_token option;The token required to get the next set of results. This value is null if there are no more results to return.
scaling_plan_resources : scaling_plan_resources option;Information about the scalable resources.
*)}type nonrec describe_scaling_plan_resources_request = {next_token : next_token option;The token for the next set of results.
*)max_results : max_results option;The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.
*)scaling_plan_version : scaling_plan_version;The version number of the scaling plan. Currently, the only valid value is 1.
scaling_plan_name : scaling_plan_name;The name of the scaling plan.
*)}type nonrec delete_scaling_plan_request = {scaling_plan_version : scaling_plan_version;The version number of the scaling plan. Currently, the only valid value is 1.
scaling_plan_name : scaling_plan_name;The name of the scaling plan.
*)}type nonrec create_scaling_plan_response = {scaling_plan_version : scaling_plan_version;The version number of the scaling plan. This value is always 1. Currently, you cannot have multiple scaling plan versions.
}type nonrec create_scaling_plan_request = {scaling_instructions : scaling_instructions;The scaling instructions.
For more information, see ScalingInstruction in the AWS Auto Scaling API Reference.
*)application_source : application_source;A CloudFormation stack or set of tags. You can create one scaling plan per application source.
For more information, see ApplicationSource in the AWS Auto Scaling API Reference.
*)scaling_plan_name : scaling_plan_name;The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
*)}