Awso_autoscaling_eioSourceval attach_instances :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.AttachInstancesQuery.t ->
(unit, unit) Result.tval attach_load_balancer_target_groups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.AttachLoadBalancerTargetGroupsType.t ->
(Awso_autoscaling.Values.AttachLoadBalancerTargetGroupsResultType.t,
Awso_autoscaling.Values.AttachLoadBalancerTargetGroupsResultType.error)
Result.tval attach_load_balancers :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.AttachLoadBalancersType.t ->
(Awso_autoscaling.Values.AttachLoadBalancersResultType.t,
Awso_autoscaling.Values.AttachLoadBalancersResultType.error)
Result.tval attach_traffic_sources :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.AttachTrafficSourcesType.t ->
(Awso_autoscaling.Values.AttachTrafficSourcesResultType.t,
Awso_autoscaling.Values.AttachTrafficSourcesResultType.error)
Result.tval batch_delete_scheduled_action :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.BatchDeleteScheduledActionType.t ->
(Awso_autoscaling.Values.BatchDeleteScheduledActionAnswer.t,
Awso_autoscaling.Values.BatchDeleteScheduledActionAnswer.error)
Result.tval batch_put_scheduled_update_group_action :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.BatchPutScheduledUpdateGroupActionType.t ->
(Awso_autoscaling.Values.BatchPutScheduledUpdateGroupActionAnswer.t,
Awso_autoscaling.Values.BatchPutScheduledUpdateGroupActionAnswer.error)
Result.tval cancel_instance_refresh :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.CancelInstanceRefreshType.t ->
(Awso_autoscaling.Values.CancelInstanceRefreshAnswer.t,
Awso_autoscaling.Values.CancelInstanceRefreshAnswer.error)
Result.tval complete_lifecycle_action :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.CompleteLifecycleActionType.t ->
(Awso_autoscaling.Values.CompleteLifecycleActionAnswer.t,
Awso_autoscaling.Values.CompleteLifecycleActionAnswer.error)
Result.tval create_auto_scaling_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.CreateAutoScalingGroupType.t ->
(unit, unit) Result.tval create_launch_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.CreateLaunchConfigurationType.t ->
(unit, unit) Result.tval create_or_update_tags :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.CreateOrUpdateTagsType.t ->
(unit, unit) Result.tval delete_auto_scaling_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DeleteAutoScalingGroupType.t ->
(unit, unit) Result.tval delete_launch_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.LaunchConfigurationNameType.t ->
(unit, unit) Result.tval delete_lifecycle_hook :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DeleteLifecycleHookType.t ->
(Awso_autoscaling.Values.DeleteLifecycleHookAnswer.t,
Awso_autoscaling.Values.DeleteLifecycleHookAnswer.error)
Result.tval delete_notification_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DeleteNotificationConfigurationType.t ->
(unit, unit) Result.tval delete_policy :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DeletePolicyType.t ->
(unit, unit) Result.tval delete_scheduled_action :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DeleteScheduledActionType.t ->
(unit, unit) Result.tval delete_tags :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DeleteTagsType.t ->
(unit, unit) Result.tval delete_warm_pool :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DeleteWarmPoolType.t ->
(Awso_autoscaling.Values.DeleteWarmPoolAnswer.t,
Awso_autoscaling.Values.DeleteWarmPoolAnswer.error)
Result.tval describe_account_limits :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
unit ->
(Awso_autoscaling.Values.DescribeAccountLimitsAnswer.t,
Awso_autoscaling.Values.DescribeAccountLimitsAnswer.error)
Result.tval describe_adjustment_types :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
unit ->
(Awso_autoscaling.Values.DescribeAdjustmentTypesAnswer.t,
Awso_autoscaling.Values.DescribeAdjustmentTypesAnswer.error)
Result.tval describe_auto_scaling_groups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.AutoScalingGroupNamesType.t ->
(Awso_autoscaling.Values.AutoScalingGroupsType.t,
Awso_autoscaling.Values.AutoScalingGroupsType.error)
Result.tval describe_auto_scaling_instances :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeAutoScalingInstancesType.t ->
(Awso_autoscaling.Values.AutoScalingInstancesType.t,
Awso_autoscaling.Values.AutoScalingInstancesType.error)
Result.tval describe_auto_scaling_notification_types :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
unit ->
(Awso_autoscaling.Values.DescribeAutoScalingNotificationTypesAnswer.t,
Awso_autoscaling.Values.DescribeAutoScalingNotificationTypesAnswer.error)
Result.tval describe_instance_refreshes :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeInstanceRefreshesType.t ->
(Awso_autoscaling.Values.DescribeInstanceRefreshesAnswer.t,
Awso_autoscaling.Values.DescribeInstanceRefreshesAnswer.error)
Result.tval describe_launch_configurations :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.LaunchConfigurationNamesType.t ->
(Awso_autoscaling.Values.LaunchConfigurationsType.t,
Awso_autoscaling.Values.LaunchConfigurationsType.error)
Result.tval describe_lifecycle_hook_types :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
unit ->
(Awso_autoscaling.Values.DescribeLifecycleHookTypesAnswer.t,
Awso_autoscaling.Values.DescribeLifecycleHookTypesAnswer.error)
Result.tval describe_lifecycle_hooks :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeLifecycleHooksType.t ->
(Awso_autoscaling.Values.DescribeLifecycleHooksAnswer.t,
Awso_autoscaling.Values.DescribeLifecycleHooksAnswer.error)
Result.tval describe_load_balancer_target_groups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeLoadBalancerTargetGroupsRequest.t ->
(Awso_autoscaling.Values.DescribeLoadBalancerTargetGroupsResponse.t,
Awso_autoscaling.Values.DescribeLoadBalancerTargetGroupsResponse.error)
Result.tval describe_load_balancers :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeLoadBalancersRequest.t ->
(Awso_autoscaling.Values.DescribeLoadBalancersResponse.t,
Awso_autoscaling.Values.DescribeLoadBalancersResponse.error)
Result.tval describe_metric_collection_types :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
unit ->
(Awso_autoscaling.Values.DescribeMetricCollectionTypesAnswer.t,
Awso_autoscaling.Values.DescribeMetricCollectionTypesAnswer.error)
Result.tval describe_notification_configurations :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeNotificationConfigurationsType.t ->
(Awso_autoscaling.Values.DescribeNotificationConfigurationsAnswer.t,
Awso_autoscaling.Values.DescribeNotificationConfigurationsAnswer.error)
Result.tval describe_policies :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribePoliciesType.t ->
(Awso_autoscaling.Values.PoliciesType.t,
Awso_autoscaling.Values.PoliciesType.error)
Result.tval describe_scaling_activities :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeScalingActivitiesType.t ->
(Awso_autoscaling.Values.ActivitiesType.t,
Awso_autoscaling.Values.ActivitiesType.error)
Result.tval describe_scaling_process_types :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
unit ->
(Awso_autoscaling.Values.ProcessesType.t,
Awso_autoscaling.Values.ProcessesType.error)
Result.tval describe_scheduled_actions :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeScheduledActionsType.t ->
(Awso_autoscaling.Values.ScheduledActionsType.t,
Awso_autoscaling.Values.ScheduledActionsType.error)
Result.tval describe_tags :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeTagsType.t ->
(Awso_autoscaling.Values.TagsType.t, Awso_autoscaling.Values.TagsType.error)
Result.tval describe_termination_policy_types :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
unit ->
(Awso_autoscaling.Values.DescribeTerminationPolicyTypesAnswer.t,
Awso_autoscaling.Values.DescribeTerminationPolicyTypesAnswer.error)
Result.tval describe_traffic_sources :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeTrafficSourcesRequest.t ->
(Awso_autoscaling.Values.DescribeTrafficSourcesResponse.t,
Awso_autoscaling.Values.DescribeTrafficSourcesResponse.error)
Result.tval describe_warm_pool :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DescribeWarmPoolType.t ->
(Awso_autoscaling.Values.DescribeWarmPoolAnswer.t,
Awso_autoscaling.Values.DescribeWarmPoolAnswer.error)
Result.tval detach_instances :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DetachInstancesQuery.t ->
(Awso_autoscaling.Values.DetachInstancesAnswer.t,
Awso_autoscaling.Values.DetachInstancesAnswer.error)
Result.tval detach_load_balancer_target_groups :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DetachLoadBalancerTargetGroupsType.t ->
(Awso_autoscaling.Values.DetachLoadBalancerTargetGroupsResultType.t,
Awso_autoscaling.Values.DetachLoadBalancerTargetGroupsResultType.error)
Result.tval detach_load_balancers :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DetachLoadBalancersType.t ->
(Awso_autoscaling.Values.DetachLoadBalancersResultType.t,
Awso_autoscaling.Values.DetachLoadBalancersResultType.error)
Result.tval detach_traffic_sources :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DetachTrafficSourcesType.t ->
(Awso_autoscaling.Values.DetachTrafficSourcesResultType.t,
Awso_autoscaling.Values.DetachTrafficSourcesResultType.error)
Result.tval disable_metrics_collection :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.DisableMetricsCollectionQuery.t ->
(unit, unit) Result.tval enable_metrics_collection :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.EnableMetricsCollectionQuery.t ->
(unit, unit) Result.tval enter_standby :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.EnterStandbyQuery.t ->
(Awso_autoscaling.Values.EnterStandbyAnswer.t,
Awso_autoscaling.Values.EnterStandbyAnswer.error)
Result.tval execute_policy :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.ExecutePolicyType.t ->
(unit, unit) Result.tval exit_standby :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.ExitStandbyQuery.t ->
(Awso_autoscaling.Values.ExitStandbyAnswer.t,
Awso_autoscaling.Values.ExitStandbyAnswer.error)
Result.tval get_predictive_scaling_forecast :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.GetPredictiveScalingForecastType.t ->
(Awso_autoscaling.Values.GetPredictiveScalingForecastAnswer.t,
Awso_autoscaling.Values.GetPredictiveScalingForecastAnswer.error)
Result.tval launch_instances :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.LaunchInstancesRequest.t ->
(Awso_autoscaling.Values.LaunchInstancesResult.t,
Awso_autoscaling.Values.LaunchInstancesResult.error)
Result.tval put_lifecycle_hook :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.PutLifecycleHookType.t ->
(Awso_autoscaling.Values.PutLifecycleHookAnswer.t,
Awso_autoscaling.Values.PutLifecycleHookAnswer.error)
Result.tval put_notification_configuration :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.PutNotificationConfigurationType.t ->
(unit, unit) Result.tval put_scaling_policy :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.PutScalingPolicyType.t ->
(Awso_autoscaling.Values.PolicyARNType.t,
Awso_autoscaling.Values.PolicyARNType.error)
Result.tval put_scheduled_update_group_action :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.PutScheduledUpdateGroupActionType.t ->
(unit, unit) Result.tval put_warm_pool :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.PutWarmPoolType.t ->
(Awso_autoscaling.Values.PutWarmPoolAnswer.t,
Awso_autoscaling.Values.PutWarmPoolAnswer.error)
Result.tval record_lifecycle_action_heartbeat :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.RecordLifecycleActionHeartbeatType.t ->
(Awso_autoscaling.Values.RecordLifecycleActionHeartbeatAnswer.t,
Awso_autoscaling.Values.RecordLifecycleActionHeartbeatAnswer.error)
Result.tval resume_processes :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.ScalingProcessQuery.t ->
(unit, unit) Result.tval rollback_instance_refresh :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.RollbackInstanceRefreshType.t ->
(Awso_autoscaling.Values.RollbackInstanceRefreshAnswer.t,
Awso_autoscaling.Values.RollbackInstanceRefreshAnswer.error)
Result.tval set_desired_capacity :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.SetDesiredCapacityType.t ->
(unit, unit) Result.tval set_instance_health :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.SetInstanceHealthQuery.t ->
(unit, unit) Result.tval set_instance_protection :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.SetInstanceProtectionQuery.t ->
(Awso_autoscaling.Values.SetInstanceProtectionAnswer.t,
Awso_autoscaling.Values.SetInstanceProtectionAnswer.error)
Result.tval start_instance_refresh :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.StartInstanceRefreshType.t ->
(Awso_autoscaling.Values.StartInstanceRefreshAnswer.t,
Awso_autoscaling.Values.StartInstanceRefreshAnswer.error)
Result.tval suspend_processes :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.ScalingProcessQuery.t ->
(unit, unit) Result.tval terminate_instance_in_auto_scaling_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.TerminateInstanceInAutoScalingGroupType.t ->
(Awso_autoscaling.Values.ActivityType.t,
Awso_autoscaling.Values.ActivityType.error)
Result.tval update_auto_scaling_group :
?endpoint_url:string ->
?cfg:Awso_eio.Cfg.t ->
Awso_autoscaling.Values.UpdateAutoScalingGroupType.t ->
(unit, unit) Result.tinclude module type of struct include Values endinclude module type of struct include Awso_autoscaling.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Describes the dimension of a metric.
module PerformanceFactorReferenceRequest =
Awso_autoscaling.Values.PerformanceFactorReferenceRequestSpecify an instance family to use as the baseline reference for CPU performance. All instance types that All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Currently only one instance family can be specified in the list.
module PerformanceFactorReferenceSetRequest =
Awso_autoscaling.Values.PerformanceFactorReferenceSetRequestRepresents a specific metric.
The CPU performance to consider, using an instance family as the baseline reference.
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.
Specifies the minimum and maximum for the AcceleratorCount object when you specify InstanceRequirements for an Auto Scaling group.
module AcceleratorTotalMemoryMiBRequest =
Awso_autoscaling.Values.AcceleratorTotalMemoryMiBRequestSpecifies the minimum and maximum for the AcceleratorTotalMemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
module BaselineEbsBandwidthMbpsRequest =
Awso_autoscaling.Values.BaselineEbsBandwidthMbpsRequestSpecifies the minimum and maximum for the BaselineEbsBandwidthMbps object when you specify InstanceRequirements for an Auto Scaling group.
module BaselinePerformanceFactorsRequest =
Awso_autoscaling.Values.BaselinePerformanceFactorsRequestThe baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Auto Scaling uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying c6i uses the CPU performance of the c6i family as the baseline reference.
Specifies the minimum and maximum for the MemoryGiBPerVCpu object when you specify InstanceRequirements for an Auto Scaling group.
Specifies the minimum and maximum for the MemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
Specifies the minimum and maximum for the NetworkBandwidthGbps object when you specify InstanceRequirements for an Auto Scaling group. Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth in the Amazon EC2 User Guide.
Specifies the minimum and maximum for the NetworkInterfaceCount object when you specify InstanceRequirements for an Auto Scaling group.
Specifies the minimum and maximum for the TotalLocalStorageGB object when you specify InstanceRequirements for an Auto Scaling group.
Specifies the minimum and maximum for the VCpuCount object when you specify InstanceRequirements for an Auto Scaling group.
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 Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes. You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes in the Amazon EC2 User Guide.
Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
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.
Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy: Override the instance type that is specified in the launch template. Use multiple instance types. Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group. After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.
module PredictiveScalingCustomizedCapacityMetric =
Awso_autoscaling.Values.PredictiveScalingCustomizedCapacityMetricDescribes a customized capacity metric for a predictive scaling policy.
module PredictiveScalingCustomizedLoadMetric =
Awso_autoscaling.Values.PredictiveScalingCustomizedLoadMetricDescribes a custom load metric for a predictive scaling policy.
module PredictiveScalingCustomizedScalingMetric =
Awso_autoscaling.Values.PredictiveScalingCustomizedScalingMetricDescribes a custom scaling metric for a predictive scaling policy.
module PredictiveScalingPredefinedLoadMetric =
Awso_autoscaling.Values.PredictiveScalingPredefinedLoadMetricDescribes 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.
module PredictiveScalingPredefinedMetricPair =
Awso_autoscaling.Values.PredictiveScalingPredefinedMetricPairRepresents a metric pair for a predictive scaling policy.
module PredictiveScalingPredefinedScalingMetric =
Awso_autoscaling.Values.PredictiveScalingPredefinedScalingMetricDescribes 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 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.
module BlockDeviceEbsDeleteOnTermination =
Awso_autoscaling.Values.BlockDeviceEbsDeleteOnTerminationmodule OnDemandPercentageAboveBaseCapacity =
Awso_autoscaling.Values.OnDemandPercentageAboveBaseCapacitymodule PredictiveScalingMetricSpecification =
Awso_autoscaling.Values.PredictiveScalingMetricSpecificationThis 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. Example You create a predictive scaling policy and specify ALBRequestCount as the value for the metric pair and 1000.0 as the target value. For this type of metric, you must provide the metric dimension for the corresponding target group, so you also provide a resource label for the Application Load Balancer target group that is attached to your Auto Scaling group. The number of requests the target group receives per minute provides the load metric, and the request count averaged between the members of the target group provides the scaling metric. In CloudWatch, this refers to the RequestCount and RequestCountPerTarget metrics, respectively. For optimal use of predictive scaling, you adhere to the best practice of using a dynamic scaling policy to automatically scale between the minimum capacity and maximum capacity in response to real-time changes in resource utilization. Amazon EC2 Auto Scaling consumes data points for the load metric over the last 14 days and creates an hourly load forecast for predictive scaling. (A minimum of 24 hours of data is required.) After creating the load forecast, Amazon EC2 Auto Scaling determines when to reduce or increase the capacity of your Auto Scaling group in each hour of the forecast period so that the average number of requests received by each instance is as close to 1000 requests per minute as possible at all times. For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in the Amazon EC2 Auto Scaling User Guide.
module TargetTrackingMetricDataQueries =
Awso_autoscaling.Values.TargetTrackingMetricDataQueriesDescribes information used to set up an Amazon EBS volume specified in a block device mapping.
Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.
Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.
module InstanceRefreshLivePoolProgress =
Awso_autoscaling.Values.InstanceRefreshLivePoolProgressReports progress on replacing instances that are in the Auto Scaling group.
module InstanceRefreshWarmPoolProgress =
Awso_autoscaling.Values.InstanceRefreshWarmPoolProgressReports progress on replacing instances that are in the warm pool.
module CapacityReservationResourceGroupArns =
Awso_autoscaling.Values.CapacityReservationResourceGroupArnsDescribes an alarm.
module PredictiveScalingMaxCapacityBreachBehavior =
Awso_autoscaling.Values.PredictiveScalingMaxCapacityBreachBehaviormodule PredictiveScalingMaxCapacityBuffer =
Awso_autoscaling.Values.PredictiveScalingMaxCapacityBuffermodule PredictiveScalingMetricSpecifications =
Awso_autoscaling.Values.PredictiveScalingMetricSpecificationsmodule PredictiveScalingSchedulingBufferTime =
Awso_autoscaling.Values.PredictiveScalingSchedulingBufferTimeDescribes information used to create a step adjustment for a step scaling policy. For the following examples, suppose that you have an alarm with a breach threshold of 50: To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. There are a few rules for the step adjustments for your step policy: The ranges of your step adjustments can't overlap or have a gap. At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound. At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound. The upper and lower bound can't be null in the same step adjustment. For more information, see Step adjustments in the Amazon EC2 Auto Scaling User Guide.
Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling. To create your customized metric specification: Add values for each required property from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish custom metrics in the Amazon CloudWatch User Guide. Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases. For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts. Each individual service provides information about the metrics, namespace, and dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.
Describes a block device mapping.
module InstanceMetadataHttpPutResponseHopLimit =
Awso_autoscaling.Values.InstanceMetadataHttpPutResponseHopLimitmodule InstanceMetadataHttpTokensState =
Awso_autoscaling.Values.InstanceMetadataHttpTokensStateUse this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
Specifies the CloudWatch alarm specification to use in an instance refresh.
module InstanceRefreshProgressDetails =
Awso_autoscaling.Values.InstanceRefreshProgressDetailsReports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool).
module ImpairedZoneHealthCheckBehavior =
Awso_autoscaling.Values.ImpairedZoneHealthCheckBehaviorThe target for the Capacity Reservation. Specify Capacity Reservations IDs or Capacity Reservation resource group ARNs.
Describes an enabled Auto Scaling group metric.
Defines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention.
Describes an EC2 instance.
Describes an auto scaling process that has been suspended. For more information, see Types of processes in the Amazon EC2 Auto Scaling User Guide.
Describes a tag for an Auto Scaling group.
Identifying information for a traffic source.
Describes an instance reuse policy for a warm pool. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
module AutoScalingGroupDesiredCapacity =
Awso_autoscaling.Values.AutoScalingGroupDesiredCapacitymodule PredictiveScalingConfiguration =
Awso_autoscaling.Values.PredictiveScalingConfigurationRepresents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.
Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.
The metadata options for the instances. For more information, see Configure the instance metadata options in the Amazon EC2 Auto Scaling User Guide.
Describes whether detailed monitoring is enabled for the Auto Scaling instances.
module PredictiveScalingForecastTimestamps =
Awso_autoscaling.Values.PredictiveScalingForecastTimestampsmodule PredictiveScalingForecastValues =
Awso_autoscaling.Values.PredictiveScalingForecastValuesmodule AnyPrintableAsciiStringMaxLen4000 =
Awso_autoscaling.Values.AnyPrintableAsciiStringMaxLen4000module NotificationTargetResourceName =
Awso_autoscaling.Values.NotificationTargetResourceNameDescribes the desired configuration for an instance refresh. If you specify a desired configuration, you must specify either a LaunchTemplate or a MixedInstancesPolicy.
Describes the preferences for an instance refresh.
Details about an instance refresh rollback.
module AutoScalingGroupPredictedCapacity =
Awso_autoscaling.Values.AutoScalingGroupPredictedCapacityDescribes an Availability Zone distribution.
module AvailabilityZoneImpairmentPolicy =
Awso_autoscaling.Values.AvailabilityZoneImpairmentPolicyDescribes an Availability Zone impairment policy.
module CapacityReservationSpecification =
Awso_autoscaling.Values.CapacityReservationSpecificationDescribes the Capacity Reservation preference and targeting options. If you specify open or none for CapacityReservationPreference, do not specify a CapacityReservationTarget.
The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when instances should move to a Retained state instead of automatic termination. For more information, see Control instance retention with instance lifecycle policies in the Amazon EC2 Auto Scaling User Guide.
Describes an instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
Describes a warm pool configuration.
Describes a scheduled scaling action.
Describes a process type. For more information, see Types of processes in the Amazon EC2 Auto Scaling User Guide.
Describes a scaling policy.
Contains details about a collection of instances launched in the Auto Scaling group.
Contains details about errors encountered during instance launch attempts.
Describes a launch configuration.
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.
Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.
Describes the state of a traffic source.
Describes a filter that is used to return a more specific list of results from a describe operation. If you specify multiple filters, the filters are automatically logically joined with an AND, and the request returns only the results that match all of the specified filters. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
Describes a notification.
Describes a metric.
Describes a granularity of a metric.
Describes the state of a Classic Load Balancer.
Describes the state of a target group.
Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
Describes an instance refresh for an Auto Scaling group.
Describes a policy adjustment type.
Describes a tag for an Auto Scaling group.
Describes information used to specify a lifecycle hook for an Auto Scaling group. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
module ScheduledUpdateGroupActionRequest =
Awso_autoscaling.Values.ScheduledUpdateGroupActionRequestDescribes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.
module FailedScheduledUpdateGroupActionRequest =
Awso_autoscaling.Values.FailedScheduledUpdateGroupActionRequestDescribes a scheduled action that could not be created, updated, or deleted.
Describes an EC2 instance associated with an Auto Scaling group.
Describes an Auto Scaling group.
module ShouldDecrementDesiredCapacity =
Awso_autoscaling.Values.ShouldDecrementDesiredCapacityThe NextToken value is not valid.
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
module InstanceRefreshInProgressFault =
Awso_autoscaling.Values.InstanceRefreshInProgressFaultThe request failed because an active instance refresh already exists for the specified Auto Scaling group.
You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.
module ActiveInstanceRefreshNotFoundFault =
Awso_autoscaling.Values.ActiveInstanceRefreshNotFoundFaultThe request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.
module IrreversibleInstanceRefreshFault =
Awso_autoscaling.Values.IrreversibleInstanceRefreshFaultThe request failed because a desired configuration was not found or an incompatible launch template (uses a Systems Manager parameter instead of an AMI ID) or launch template version ($Latest or $Default) is present on the Auto Scaling group.
The service-linked role is not yet ready for use.
module IdempotentParameterMismatchError =
Awso_autoscaling.Values.IdempotentParameterMismatchErrorIndicates that the parameters in the current request do not match the parameters from a previous request with the same client token within the idempotency window.
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.
module MaxNumberOfLaunchConfigurations =
Awso_autoscaling.Values.MaxNumberOfLaunchConfigurationsThe operation can't be performed because the resource is in use.
module ScalingActivityInProgressFault =
Awso_autoscaling.Values.ScalingActivityInProgressFaultThe operation can't be performed because there are scaling activities in progress.
module ScheduledUpdateGroupActionRequests =
Awso_autoscaling.Values.ScheduledUpdateGroupActionRequestsYou already have an Auto Scaling group or launch configuration with this name.
module FailedScheduledUpdateGroupActionRequests =
Awso_autoscaling.Values.FailedScheduledUpdateGroupActionRequestsWe strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Updates the configuration for the specified Auto Scaling group. To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns. If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application. Note the following about changing DesiredCapacity, MaxSize, or MinSize: If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value. To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
module TerminateInstanceInAutoScalingGroupType =
Awso_autoscaling.Values.TerminateInstanceInAutoScalingGroupTypeTerminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
Starts an instance refresh. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group. If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API. An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in Standby state or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API. If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the AutoRollback property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.
Starts an instance refresh. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group. If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API. An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in Standby state or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API. If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the AutoRollback property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool. For more information, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool. For more information, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
Sets the health status of the specified instance. For more information, see Set up a custom health check for your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Sets the size of the specified Auto Scaling group. If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
Gets information about the scheduled actions that haven't run or that have not reached their end time. To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspend and resume Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. A rollback is not supported in the following situations: There is no desired configuration specified for the instance refresh. The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property. The Auto Scaling group uses the launch template's $Latest or $Default version. When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. A rollback is not supported in the following situations: There is no desired configuration specified for the instance refresh. The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId property. The Auto Scaling group uses the launch template's $Latest or $Default version. When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
module RecordLifecycleActionHeartbeatType =
Awso_autoscaling.Values.RecordLifecycleActionHeartbeatTypeRecords a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
module RecordLifecycleActionHeartbeatAnswer =
Awso_autoscaling.Values.RecordLifecycleActionHeartbeatAnswerRecords a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. This operation must be called from the Region in which the Auto Scaling group was created. You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. This operation must be called from the Region in which the Auto Scaling group was created. You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
module PutScheduledUpdateGroupActionType =
Awso_autoscaling.Values.PutScheduledUpdateGroupActionTypeCreates or updates a scheduled scaling action for an Auto Scaling group. For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide. You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API. If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used. For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide. For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
module PutNotificationConfigurationType =
Awso_autoscaling.Values.PutNotificationConfigurationTypeConfigures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Amazon SNS notification options for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
Creates or updates a lifecycle hook for the specified Auto Scaling group. Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
Creates or updates a lifecycle hook for the specified Auto Scaling group. Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
Contains the output of PutScalingPolicy.
Gets information about the scaling policies in the account and Region.
Launches a specified number of instances in an Auto Scaling group. Returns instance IDs and other details if launch is successful or error details if launch is unsuccessful.
Launches a specified number of instances in an Auto Scaling group. Returns instance IDs and other details if launch is successful or error details if launch is unsuccessful.
Gets information about the launch configurations in the account and Region.
Gets information about the launch configurations in the account and Region.
Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
module GetPredictiveScalingForecastType =
Awso_autoscaling.Values.GetPredictiveScalingForecastTypeRetrieves the forecast data for a predictive scaling policy. Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast. A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts. For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
module GetPredictiveScalingForecastAnswer =
Awso_autoscaling.Values.GetPredictiveScalingForecastAnswerRetrieves the forecast data for a predictive scaling policy. Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast. A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts. For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Moves the specified instances out of the standby state. After you put the instances back in service, the desired capacity is incremented. For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Moves the specified instances out of the standby state. After you put the instances back in service, the desired capacity is incremented. For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Executes the specified policy. This can be useful for testing the design of your scaling policy.
Moves the specified instances into the standby state. If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group. If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby. For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Moves the specified instances into the standby state. If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group. If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby. For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Enables group metrics collection for the specified Auto Scaling group. You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
Disables group metrics collection for the specified Auto Scaling group.
Detaches one or more traffic sources from the specified Auto Scaling group. When you detach a traffic source, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.
module DetachTrafficSourcesResultType =
Awso_autoscaling.Values.DetachTrafficSourcesResultTypeDetaches one or more traffic sources from the specified Auto Scaling group. When you detach a traffic source, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancers. You can use both the original DetachLoadBalancers API operation and DetachTrafficSources on the same Auto Scaling group. Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancers. You can use both the original DetachLoadBalancers API operation and DetachTrafficSources on the same Auto Scaling group. Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
module DetachLoadBalancerTargetGroupsType =
Awso_autoscaling.Values.DetachLoadBalancerTargetGroupsTypeThis API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the same Auto Scaling group. Detaches one or more target groups from the specified Auto Scaling group. When you detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running. You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
module DetachLoadBalancerTargetGroupsResultType =
Awso_autoscaling.Values.DetachLoadBalancerTargetGroupsResultTypeThis API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the same Auto Scaling group. Detaches one or more target groups from the specified Auto Scaling group. When you detach a target group, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running. You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach or attach instances in the Amazon EC2 Auto Scaling User Guide.
Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach or attach instances in the Amazon EC2 Auto Scaling User Guide.
Gets information about a warm pool and its instances. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Gets information about a warm pool and its instances. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
module DescribeTrafficSourcesResponse =
Awso_autoscaling.Values.DescribeTrafficSourcesResponseGets information about the traffic sources for the specified Auto Scaling group. You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type. If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
Gets information about the traffic sources for the specified Auto Scaling group. You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type. If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
module DescribeTerminationPolicyTypesAnswer =
Awso_autoscaling.Values.DescribeTerminationPolicyTypesAnswerDescribes the termination policies supported by Amazon EC2 Auto Scaling. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
Gets information about the scheduled actions that haven't run or that have not reached their end time. To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
Gets information about the scaling activities in the account and Region. When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verify a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Gets information about the scaling policies in the account and Region.
module DescribeNotificationConfigurationsType =
Awso_autoscaling.Values.DescribeNotificationConfigurationsTypeGets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
module DescribeNotificationConfigurationsAnswer =
Awso_autoscaling.Values.DescribeNotificationConfigurationsAnswerGets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
module DescribeMetricCollectionTypesAnswer =
Awso_autoscaling.Values.DescribeMetricCollectionTypesAnswerDescribes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DescribeTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API operation and DescribeTrafficSources on the same Auto Scaling group. Gets information about the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead. To determine the attachment status of the load balancer, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter the InService state. Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary. For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DescribeTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API operation and DescribeTrafficSources on the same Auto Scaling group. Gets information about the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead. To determine the attachment status of the load balancer, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter the InService state. Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary. For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
module DescribeLoadBalancerTargetGroupsResponse =
Awso_autoscaling.Values.DescribeLoadBalancerTargetGroupsResponseThis API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same Auto Scaling group. Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group. To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService state. Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary. For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
module DescribeLoadBalancerTargetGroupsRequest =
Awso_autoscaling.Values.DescribeLoadBalancerTargetGroupsRequestThis API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same Auto Scaling group. Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group. To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService state. Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary. For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
Gets information about the lifecycle hooks for the specified Auto Scaling group.
Gets information about the lifecycle hooks for the specified Auto Scaling group.
module DescribeLifecycleHookTypesAnswer =
Awso_autoscaling.Values.DescribeLifecycleHookTypesAnswerDescribes the available types of lifecycle hooks. The following hook types are supported: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
module DescribeInstanceRefreshesAnswer =
Awso_autoscaling.Values.DescribeInstanceRefreshesAnswerGets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
module DescribeAutoScalingNotificationTypesAnswer =
Awso_autoscaling.Values.DescribeAutoScalingNotificationTypesAnswerDescribes the notification types that are supported by Amazon EC2 Auto Scaling.
module DescribeAutoScalingInstancesType =
Awso_autoscaling.Values.DescribeAutoScalingInstancesTypeGets information about the Auto Scaling instances in the account and Region.
Describes the available adjustment types for step scaling and simple scaling policies. The following adjustment types are supported: ChangeInCapacity ExactCapacity PercentChangeInCapacity
Describes the current Amazon EC2 Auto Scaling resource quotas for your account. When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Deletes the warm pool for the specified Auto Scaling group. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Deletes the warm pool for the specified Auto Scaling group. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Deletes the specified tags.
Deletes the specified scheduled action.
Deletes the specified scaling policy. Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. For more information, see Delete a scaling policy in the Amazon EC2 Auto Scaling User Guide.
module DeleteNotificationConfigurationType =
Awso_autoscaling.Values.DeleteNotificationConfigurationTypeDeletes the specified notification.
Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool. To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero. If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide. Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Every Auto Scaling group has three size properties (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call. For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes. When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
module BatchPutScheduledUpdateGroupActionType =
Awso_autoscaling.Values.BatchPutScheduledUpdateGroupActionTypeCreates or updates one or more scheduled scaling actions for an Auto Scaling group.
module BatchPutScheduledUpdateGroupActionAnswer =
Awso_autoscaling.Values.BatchPutScheduledUpdateGroupActionAnswerCreates or updates one or more scheduled scaling actions for an Auto Scaling group.
module BatchDeleteScheduledActionType =
Awso_autoscaling.Values.BatchDeleteScheduledActionTypeDeletes one or more scheduled actions for the specified Auto Scaling group.
module BatchDeleteScheduledActionAnswer =
Awso_autoscaling.Values.BatchDeleteScheduledActionAnswerDeletes one or more scheduled actions for the specified Auto Scaling group.
Gets information about the Auto Scaling instances in the account and Region.
Gets information about the Auto Scaling groups in the account and Region. If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups. This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
Gets information about the Auto Scaling groups in the account and Region. If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups. This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
Attaches one or more traffic sources to the specified Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Application Load Balancer Classic Load Balancer Gateway Load Balancer Network Load Balancer VPC Lattice This operation is additive and does not detach existing traffic sources from the Auto Scaling group. After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
module AttachTrafficSourcesResultType =
Awso_autoscaling.Values.AttachTrafficSourcesResultTypeAttaches one or more traffic sources to the specified Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Application Load Balancer Classic Load Balancer Gateway Load Balancer Network Load Balancer VPC Lattice This operation is additive and does not detach existing traffic sources from the Auto Scaling group. After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and AttachTrafficSources on the same Auto Scaling group. Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers. To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API. This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and AttachTrafficSources on the same Auto Scaling group. Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers. To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API. This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
module AttachLoadBalancerTargetGroupsType =
Awso_autoscaling.Values.AttachLoadBalancerTargetGroupsTypeThis API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto Scaling group. Attaches one or more target groups to the specified Auto Scaling group. This operation is used with the following load balancer types: Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS. Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP. Gateway Load Balancer - Operates at the network layer (layer 3). To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API. This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
module AttachLoadBalancerTargetGroupsResultType =
Awso_autoscaling.Values.AttachLoadBalancerTargetGroupsResultTypeThis API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto Scaling group. Attaches one or more target groups to the specified Auto Scaling group. This operation is used with the following load balancer types: Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS. Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP. Gateway Load Balancer - Operates at the network layer (layer 3). To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API. This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Detach or attach instances in the Amazon EC2 Auto Scaling User Guide.
Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
Gets information about the scaling activities in the account and Region. When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verify a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.