ExAws.Autoscaling.Core

Auto Scaling

Auto Scaling

Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.

Source

Summary

attach_instances!(client, input)

Same as attach_instances/2 but raise on error

attach_instances(client, input)

AttachInstances

attach_load_balancers!(client, input)

Same as attach_load_balancers/2 but raise on error

attach_load_balancers(client, input)

AttachLoadBalancers

complete_lifecycle_action!(client, input)

Same as complete_lifecycle_action/2 but raise on error

complete_lifecycle_action(client, input)

CompleteLifecycleAction

create_auto_scaling_group!(client, input)

Same as create_auto_scaling_group/2 but raise on error

create_auto_scaling_group(client, input)

CreateAutoScalingGroup

create_launch_configuration!(client, input)

Same as create_launch_configuration/2 but raise on error

create_launch_configuration(client, input)

CreateLaunchConfiguration

create_or_update_tags!(client, input)

Same as create_or_update_tags/2 but raise on error

create_or_update_tags(client, input)

CreateOrUpdateTags

delete_auto_scaling_group!(client, input)

Same as delete_auto_scaling_group/2 but raise on error

delete_auto_scaling_group(client, input)

DeleteAutoScalingGroup

delete_launch_configuration!(client, input)

Same as delete_launch_configuration/2 but raise on error

delete_launch_configuration(client, input)

DeleteLaunchConfiguration

delete_lifecycle_hook!(client, input)

Same as delete_lifecycle_hook/2 but raise on error

delete_lifecycle_hook(client, input)

DeleteLifecycleHook

delete_notification_configuration!(client, input)

Same as delete_notification_configuration/2 but raise on error

delete_notification_configuration(client, input)

DeleteNotificationConfiguration

delete_policy!(client, input)

Same as delete_policy/2 but raise on error

delete_policy(client, input)

DeletePolicy

delete_scheduled_action!(client, input)

Same as delete_scheduled_action/2 but raise on error

delete_scheduled_action(client, input)

DeleteScheduledAction

delete_tags!(client, input)

Same as delete_tags/2 but raise on error

delete_tags(client, input)

DeleteTags

describe_account_limits!(client)

Same as describe_account_limits/2 but raise on error

describe_account_limits(client)

DescribeAccountLimits

describe_adjustment_types!(client)

Same as describe_adjustment_types/2 but raise on error

describe_adjustment_types(client)

DescribeAdjustmentTypes

describe_auto_scaling_groups!(client, input)

Same as describe_auto_scaling_groups/2 but raise on error

describe_auto_scaling_groups(client, input)

DescribeAutoScalingGroups

describe_auto_scaling_instances!(client, input)

Same as describe_auto_scaling_instances/2 but raise on error

describe_auto_scaling_instances(client, input)

DescribeAutoScalingInstances

describe_auto_scaling_notification_types!(client)

Same as describe_auto_scaling_notification_types/2 but raise on error

describe_auto_scaling_notification_types(client)

DescribeAutoScalingNotificationTypes

describe_launch_configurations!(client, input)

Same as describe_launch_configurations/2 but raise on error

describe_launch_configurations(client, input)

DescribeLaunchConfigurations

describe_lifecycle_hook_types!(client)

Same as describe_lifecycle_hook_types/2 but raise on error

describe_lifecycle_hook_types(client)

DescribeLifecycleHookTypes

describe_lifecycle_hooks!(client, input)

Same as describe_lifecycle_hooks/2 but raise on error

describe_lifecycle_hooks(client, input)

DescribeLifecycleHooks

describe_load_balancers!(client, input)

Same as describe_load_balancers/2 but raise on error

describe_load_balancers(client, input)

DescribeLoadBalancers

describe_metric_collection_types!(client)

Same as describe_metric_collection_types/2 but raise on error

describe_metric_collection_types(client)

DescribeMetricCollectionTypes

describe_notification_configurations!(client, input)

Same as describe_notification_configurations/2 but raise on error

describe_notification_configurations(client, input)

DescribeNotificationConfigurations

describe_policies!(client, input)

Same as describe_policies/2 but raise on error

describe_policies(client, input)

DescribePolicies

describe_scaling_activities!(client, input)

Same as describe_scaling_activities/2 but raise on error

describe_scaling_activities(client, input)

DescribeScalingActivities

describe_scaling_process_types!(client)

Same as describe_scaling_process_types/2 but raise on error

describe_scaling_process_types(client)

DescribeScalingProcessTypes

describe_scheduled_actions!(client, input)

Same as describe_scheduled_actions/2 but raise on error

describe_scheduled_actions(client, input)

DescribeScheduledActions

describe_tags!(client, input)

Same as describe_tags/2 but raise on error

describe_tags(client, input)

DescribeTags

describe_termination_policy_types!(client)

Same as describe_termination_policy_types/2 but raise on error

describe_termination_policy_types(client)

DescribeTerminationPolicyTypes

detach_instances!(client, input)

Same as detach_instances/2 but raise on error

detach_instances(client, input)

DetachInstances

detach_load_balancers!(client, input)

Same as detach_load_balancers/2 but raise on error

detach_load_balancers(client, input)

DetachLoadBalancers

disable_metrics_collection!(client, input)

Same as disable_metrics_collection/2 but raise on error

disable_metrics_collection(client, input)

DisableMetricsCollection

enable_metrics_collection!(client, input)

Same as enable_metrics_collection/2 but raise on error

enable_metrics_collection(client, input)

EnableMetricsCollection

enter_standby!(client, input)

Same as enter_standby/2 but raise on error

enter_standby(client, input)

EnterStandby

execute_policy!(client, input)

Same as execute_policy/2 but raise on error

execute_policy(client, input)

ExecutePolicy

exit_standby!(client, input)

Same as exit_standby/2 but raise on error

exit_standby(client, input)

ExitStandby

put_lifecycle_hook!(client, input)

Same as put_lifecycle_hook/2 but raise on error

put_lifecycle_hook(client, input)

PutLifecycleHook

put_notification_configuration!(client, input)

Same as put_notification_configuration/2 but raise on error

put_notification_configuration(client, input)

PutNotificationConfiguration

put_scaling_policy!(client, input)

Same as put_scaling_policy/2 but raise on error

put_scaling_policy(client, input)

PutScalingPolicy

put_scheduled_update_group_action!(client, input)

Same as put_scheduled_update_group_action/2 but raise on error

put_scheduled_update_group_action(client, input)

PutScheduledUpdateGroupAction

record_lifecycle_action_heartbeat!(client, input)

Same as record_lifecycle_action_heartbeat/2 but raise on error

record_lifecycle_action_heartbeat(client, input)

RecordLifecycleActionHeartbeat

resume_processes!(client, input)

Same as resume_processes/2 but raise on error

resume_processes(client, input)

ResumeProcesses

set_desired_capacity!(client, input)

Same as set_desired_capacity/2 but raise on error

set_desired_capacity(client, input)

SetDesiredCapacity

set_instance_health!(client, input)

Same as set_instance_health/2 but raise on error

set_instance_health(client, input)

SetInstanceHealth

suspend_processes!(client, input)

Same as suspend_processes/2 but raise on error

suspend_processes(client, input)

SuspendProcesses

terminate_instance_in_auto_scaling_group!(client, input)

Same as terminate_instance_in_auto_scaling_group/2 but raise on error

terminate_instance_in_auto_scaling_group(client, input)

TerminateInstanceInAutoScalingGroup

update_auto_scaling_group!(client, input)

Same as update_auto_scaling_group/2 but raise on error

update_auto_scaling_group(client, input)

UpdateAutoScalingGroup

Types

delete_notification_configuration_type :: [auto_scaling_group_name: resource_name, topic_arn: resource_name]

alarms :: [alarm]

timestamp_type :: integer

policy_arn_type :: [{:policy_arn, resource_name}]

put_notification_configuration_type :: [auto_scaling_group_name: resource_name, notification_types: auto_scaling_notification_types, topic_arn: resource_name]

attach_load_balancers_type :: [auto_scaling_group_name: resource_name, load_balancer_names: load_balancer_names]

auto_scaling_instance_details :: [auto_scaling_group_name: xml_string_max_len255, availability_zone: xml_string_max_len255, health_status: xml_string_max_len32, instance_id: xml_string_max_len16, launch_configuration_name: xml_string_max_len255, lifecycle_state: xml_string_max_len32]

activity_type :: [{:activity, activity}]

describe_auto_scaling_instances_type :: [instance_ids: instance_ids, max_records: max_records, next_token: xml_string]

disable_metrics_collection_query :: [auto_scaling_group_name: resource_name, metrics: metrics]

create_launch_configuration_type :: [associate_public_ip_address: associate_public_ip_address, block_device_mappings: block_device_mappings, classic_link_vpc_id: xml_string_max_len255, classic_link_vpc_security_groups: classic_link_vpc_security_groups, ebs_optimized: ebs_optimized, iam_instance_profile: xml_string_max_len1600, image_id: xml_string_max_len255, instance_id: xml_string_max_len16, instance_monitoring: instance_monitoring, instance_type: xml_string_max_len255, kernel_id: xml_string_max_len255, key_name: xml_string_max_len255, launch_configuration_name: xml_string_max_len255, placement_tenancy: xml_string_max_len64, ramdisk_id: xml_string_max_len255, security_groups: security_groups, spot_price: spot_price, user_data: xml_string_user_data]

launch_configurations_type :: [launch_configurations: launch_configurations, next_token: xml_string]

scaling_process_query :: [auto_scaling_group_name: resource_name, scaling_processes: process_names]

process_type :: [{:process_name, xml_string_max_len255}]

describe_lifecycle_hooks_type :: [auto_scaling_group_name: resource_name, lifecycle_hook_names: lifecycle_hook_names]

exit_standby_query :: [auto_scaling_group_name: resource_name, instance_ids: instance_ids]

global_timeout :: integer

min_adjustment_step :: integer

enable_metrics_collection_query :: [auto_scaling_group_name: resource_name, granularity: xml_string_max_len255, metrics: metrics]

policies_type :: [next_token: xml_string, scaling_policies: scaling_policies]

delete_auto_scaling_group_type :: [auto_scaling_group_name: resource_name, force_delete: force_delete]

spot_price :: binary

describe_scheduled_actions_type :: [auto_scaling_group_name: resource_name, end_time: timestamp_type, max_records: max_records, next_token: xml_string, scheduled_action_names: scheduled_action_names, start_time: timestamp_type]

complete_lifecycle_action_type :: [auto_scaling_group_name: resource_name, lifecycle_action_result: lifecycle_action_result, lifecycle_action_token: lifecycle_action_token, lifecycle_hook_name: ascii_string_max_len255]

detach_load_balancers_type :: [auto_scaling_group_name: resource_name, load_balancer_names: load_balancer_names]

lifecycle_hook :: [auto_scaling_group_name: resource_name, default_result: lifecycle_action_result, global_timeout: global_timeout, heartbeat_timeout: heartbeat_timeout, lifecycle_hook_name: ascii_string_max_len255, lifecycle_transition: lifecycle_transition, notification_metadata: xml_string_max_len1023, notification_target_arn: resource_name, role_arn: resource_name]

filter :: [name: xml_string, values: values]

scheduled_actions_type :: [next_token: xml_string, scheduled_update_group_actions: scheduled_update_group_actions]

put_scaling_policy_type :: [adjustment_type: xml_string_max_len255, auto_scaling_group_name: resource_name, cooldown: cooldown, estimated_instance_warmup: estimated_instance_warmup, metric_aggregation_type: xml_string_max_len32, min_adjustment_magnitude: min_adjustment_magnitude, min_adjustment_step: min_adjustment_step, policy_name: xml_string_max_len255, policy_type: xml_string_max_len64, scaling_adjustment: policy_increment, step_adjustments: step_adjustments]

processes_type :: [{:processes, processes}]

tags_type :: [next_token: xml_string, tags: tag_description_list]

describe_load_balancers_request :: [auto_scaling_group_name: resource_name, max_records: max_records, next_token: xml_string]

describe_tags_type :: [filters: filters, max_records: max_records, next_token: xml_string]

record_lifecycle_action_heartbeat_type :: [auto_scaling_group_name: resource_name, lifecycle_action_token: lifecycle_action_token, lifecycle_hook_name: ascii_string_max_len255]

delete_tags_type :: [{:tags, tags}]

tags :: [tag]

tag :: [key: tag_key, propagate_at_launch: propagate_at_launch, resource_id: xml_string, resource_type: xml_string, value: tag_value]

delete_scheduled_action_type :: [auto_scaling_group_name: resource_name, scheduled_action_name: resource_name]

metric_scale :: float

auto_scaling_groups_type :: [auto_scaling_groups: auto_scaling_groups, next_token: xml_string]

adjustment_type :: [{:adjustment_type, xml_string_max_len255}]

enter_standby_answer :: [{:activities, activities}]

tag_value :: binary

detach_instances_answer :: [{:activities, activities}]

max_records :: integer

heartbeat_timeout :: integer

update_auto_scaling_group_type :: [auto_scaling_group_name: resource_name, availability_zones: availability_zones, default_cooldown: cooldown, desired_capacity: auto_scaling_group_desired_capacity, health_check_grace_period: health_check_grace_period, health_check_type: xml_string_max_len32, launch_configuration_name: resource_name, max_size: auto_scaling_group_max_size, min_size: auto_scaling_group_min_size, placement_group: xml_string_max_len255, termination_policies: termination_policies, vpc_zone_identifier: xml_string_max_len255]

xml_string :: binary

scaling_policy :: [adjustment_type: xml_string_max_len255, alarms: alarms, auto_scaling_group_name: xml_string_max_len255, cooldown: cooldown, estimated_instance_warmup: estimated_instance_warmup, metric_aggregation_type: xml_string_max_len32, min_adjustment_magnitude: min_adjustment_magnitude, min_adjustment_step: min_adjustment_step, policy_arn: resource_name, policy_name: xml_string_max_len255, policy_type: xml_string_max_len64, scaling_adjustment: policy_increment, step_adjustments: step_adjustments]

policy_increment :: integer

delete_lifecycle_hook_type :: [auto_scaling_group_name: resource_name, lifecycle_hook_name: ascii_string_max_len255]

force_delete :: boolean

launch_configuration :: [associate_public_ip_address: associate_public_ip_address, block_device_mappings: block_device_mappings, classic_link_vpc_id: xml_string_max_len255, classic_link_vpc_security_groups: classic_link_vpc_security_groups, created_time: timestamp_type, ebs_optimized: ebs_optimized, iam_instance_profile: xml_string_max_len1600, image_id: xml_string_max_len255, instance_monitoring: instance_monitoring, instance_type: xml_string_max_len255, kernel_id: xml_string_max_len255, key_name: xml_string_max_len255, launch_configuration_arn: resource_name, launch_configuration_name: xml_string_max_len255, placement_tenancy: xml_string_max_len64, ramdisk_id: xml_string_max_len255, security_groups: security_groups, spot_price: spot_price, user_data: xml_string_user_data]

tag_description :: [key: tag_key, propagate_at_launch: propagate_at_launch, resource_id: xml_string, resource_type: xml_string, value: tag_value]

propagate_at_launch :: boolean

lifecycle_state :: binary

describe_notification_configurations_type :: [auto_scaling_group_names: auto_scaling_group_names, max_records: max_records, next_token: xml_string]

describe_policies_type :: [auto_scaling_group_name: resource_name, max_records: max_records, next_token: xml_string, policy_names: policy_names, policy_types: policy_types]

scheduled_update_group_action :: [auto_scaling_group_name: xml_string_max_len255, desired_capacity: auto_scaling_group_desired_capacity, end_time: timestamp_type, max_size: auto_scaling_group_max_size, min_size: auto_scaling_group_min_size, recurrence: xml_string_max_len255, scheduled_action_arn: resource_name, scheduled_action_name: xml_string_max_len255, start_time: timestamp_type, time: timestamp_type]

set_desired_capacity_type :: [auto_scaling_group_name: resource_name, desired_capacity: auto_scaling_group_desired_capacity, honor_cooldown: honor_cooldown]

no_device :: boolean

honor_cooldown :: boolean

attach_instances_query :: [auto_scaling_group_name: resource_name, instance_ids: instance_ids]

create_auto_scaling_group_type :: [auto_scaling_group_name: xml_string_max_len255, availability_zones: availability_zones, default_cooldown: cooldown, desired_capacity: auto_scaling_group_desired_capacity, health_check_grace_period: health_check_grace_period, health_check_type: xml_string_max_len32, instance_id: xml_string_max_len16, launch_configuration_name: resource_name, load_balancer_names: load_balancer_names, max_size: auto_scaling_group_max_size, min_size: auto_scaling_group_min_size, placement_group: xml_string_max_len255, tags: tags, termination_policies: termination_policies, vpc_zone_identifier: xml_string_max_len255]

enter_standby_query :: [auto_scaling_group_name: resource_name, instance_ids: instance_ids, should_decrement_desired_capacity: should_decrement_desired_capacity]

put_lifecycle_hook_type :: [auto_scaling_group_name: resource_name, default_result: lifecycle_action_result, heartbeat_timeout: heartbeat_timeout, lifecycle_hook_name: ascii_string_max_len255, lifecycle_transition: lifecycle_transition, notification_metadata: xml_string_max_len1023, notification_target_arn: resource_name, role_arn: resource_name]

activity :: [activity_id: xml_string, auto_scaling_group_name: xml_string_max_len255, cause: xml_string_max_len1023, description: xml_string, details: xml_string, end_time: timestamp_type, progress: progress, start_time: timestamp_type, status_code: scaling_activity_status_code, status_message: xml_string_max_len255]

set_instance_health_query :: [health_status: xml_string_max_len32, instance_id: xml_string_max_len16, should_respect_grace_period: should_respect_grace_period]

execute_policy_type :: [auto_scaling_group_name: resource_name, breach_threshold: metric_scale, honor_cooldown: honor_cooldown, metric_value: metric_scale, policy_name: resource_name]

delete_policy_type :: [auto_scaling_group_name: resource_name, policy_name: resource_name]

progress :: integer

step_adjustment :: [metric_interval_lower_bound: metric_scale, metric_interval_upper_bound: metric_scale, scaling_adjustment: policy_increment]

describe_scaling_activities_type :: [activity_ids: activity_ids, auto_scaling_group_name: resource_name, max_records: max_records, next_token: xml_string]

auto_scaling_instances_type :: [auto_scaling_instances: auto_scaling_instances, next_token: xml_string]

tag_key :: binary

launch_configuration_names_type :: [launch_configuration_names: launch_configuration_names, max_records: max_records, next_token: xml_string]

describe_account_limits_answer :: [max_number_of_auto_scaling_groups: max_number_of_auto_scaling_groups, max_number_of_launch_configurations: max_number_of_launch_configurations]

cooldown :: integer

detach_instances_query :: [auto_scaling_group_name: resource_name, instance_ids: instance_ids, should_decrement_desired_capacity: should_decrement_desired_capacity]

monitoring_enabled :: boolean

auto_scaling_group_names_type :: [auto_scaling_group_names: auto_scaling_group_names, max_records: max_records, next_token: xml_string]

ebs_optimized :: boolean

auto_scaling_group :: [auto_scaling_group_arn: resource_name, auto_scaling_group_name: xml_string_max_len255, availability_zones: availability_zones, created_time: timestamp_type, default_cooldown: cooldown, desired_capacity: auto_scaling_group_desired_capacity, enabled_metrics: enabled_metrics, health_check_grace_period: health_check_grace_period, health_check_type: xml_string_max_len32, instances: instances, launch_configuration_name: xml_string_max_len255, load_balancer_names: load_balancer_names, max_size: auto_scaling_group_max_size, min_size: auto_scaling_group_min_size, placement_group: xml_string_max_len255, status: xml_string_max_len255, suspended_processes: suspended_processes, tags: tag_description_list, termination_policies: termination_policies, vpc_zone_identifier: xml_string_max_len255]

resource_name :: binary

exit_standby_answer :: [{:activities, activities}]

notification_configuration :: [auto_scaling_group_name: resource_name, notification_type: xml_string_max_len255, topic_arn: resource_name]

launch_configuration_name_type :: [{:launch_configuration_name, resource_name}]

suspended_process :: [process_name: xml_string_max_len255, suspension_reason: xml_string_max_len255]

activities_type :: [activities: activities, next_token: xml_string]

block_device_mapping :: [device_name: xml_string_max_len255, ebs: ebs, no_device: no_device, virtual_name: xml_string_max_len255]

put_scheduled_update_group_action_type :: [auto_scaling_group_name: resource_name, desired_capacity: auto_scaling_group_desired_capacity, end_time: timestamp_type, max_size: auto_scaling_group_max_size, min_size: auto_scaling_group_min_size, recurrence: xml_string_max_len255, scheduled_action_name: xml_string_max_len255, start_time: timestamp_type, time: timestamp_type]

alarm :: [alarm_arn: resource_name, alarm_name: xml_string_max_len255]

instance :: [availability_zone: xml_string_max_len255, health_status: xml_string_max_len32, instance_id: xml_string_max_len16, launch_configuration_name: xml_string_max_len255, lifecycle_state: lifecycle_state]

Functions

attach_instances(client, input)

Specs:

  • attach_instances(client :: ExAws.Autoscaling.t, input :: attach_instances_query) :: ExAws.Request.Query.response_t

AttachInstances

Attaches one or more EC2 instances to the specified Auto Scaling group.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling Developer Guide.

Source
attach_instances!(client, input)

Specs:

  • attach_instances!(client :: ExAws.Autoscaling.t, input :: attach_instances_query) :: ExAws.Request.Query.success_t | no_return

Same as attach_instances/2 but raise on error.

Source
attach_load_balancers(client, input)

Specs:

AttachLoadBalancers

Attaches one or more load balancers to the specified Auto Scaling group.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling Developer Guide.

Source
attach_load_balancers!(client, input)

Specs:

  • attach_load_balancers!(client :: ExAws.Autoscaling.t, input :: attach_load_balancers_type) :: ExAws.Request.Query.success_t | no_return

Same as attach_load_balancers/2 but raise on error.

Source
complete_lifecycle_action(client, input)

Specs:

CompleteLifecycleAction

Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  • Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.

  • Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.

  • Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.

  • If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.

  • Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

Source
complete_lifecycle_action!(client, input)

Specs:

Same as complete_lifecycle_action/2 but raise on error.

Source
create_auto_scaling_group(client, input)

Specs:

CreateAutoScalingGroup

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Auto Scaling Groups in the Auto Scaling Developer Guide.

Source
create_auto_scaling_group!(client, input)

Specs:

Same as create_auto_scaling_group/2 but raise on error.

Source
create_launch_configuration(client, input)

Specs:

CreateLaunchConfiguration

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Launch Configurations in the Auto Scaling Developer Guide.

Source
create_launch_configuration!(client, input)

Specs:

Same as create_launch_configuration/2 but raise on error.

Source
create_or_update_tags(client, input)

Specs:

CreateOrUpdateTags

Creates or updates tags for the specified Auto Scaling group.

A tag is defined by its resource ID, resource type, key, value, and propagate flag. The value and the propagate flag are optional parameters. The only supported resource type is auto-scaling-group, and the resource ID must be the name of the group. The PropagateAtLaunch flag determines whether the tag is added to instances launched in the group. Valid values are true or false.

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 Tagging Auto Scaling Groups and Instances in the Auto Scaling Developer Guide.

Source
create_or_update_tags!(client, input)

Specs:

  • create_or_update_tags!(client :: ExAws.Autoscaling.t, input :: create_or_update_tags_type) :: ExAws.Request.Query.success_t | no_return

Same as create_or_update_tags/2 but raise on error.

Source
delete_auto_scaling_group(client, input)

Specs:

DeleteAutoScalingGroup

Deletes the specified Auto Scaling group.

The group must have no instances and no scaling activities in progress.

To remove all instances before calling DeleteAutoScalingGroup, call UpdateAutoScalingGroup to set the minimum and maximum size of the Auto Scaling group to zero.

Source
delete_auto_scaling_group!(client, input)

Specs:

Same as delete_auto_scaling_group/2 but raise on error.

Source
delete_launch_configuration(client, input)

Specs:

DeleteLaunchConfiguration

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.

Source
delete_launch_configuration!(client, input)

Specs:

Same as delete_launch_configuration/2 but raise on error.

Source
delete_lifecycle_hook(client, input)

Specs:

DeleteLifecycleHook

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

Source
delete_lifecycle_hook!(client, input)

Specs:

  • delete_lifecycle_hook!(client :: ExAws.Autoscaling.t, input :: delete_lifecycle_hook_type) :: ExAws.Request.Query.success_t | no_return

Same as delete_lifecycle_hook/2 but raise on error.

Source
delete_notification_configuration(client, input)

Specs:

DeleteNotificationConfiguration

Deletes the specified notification.

Source
delete_notification_configuration!(client, input)

Specs:

Same as delete_notification_configuration/2 but raise on error.

Source
delete_policy(client, input)

Specs:

  • delete_policy(client :: ExAws.Autoscaling.t, input :: delete_policy_type) :: ExAws.Request.Query.response_t

DeletePolicy

Deletes the specified Auto Scaling policy.

Source
delete_policy!(client, input)

Specs:

  • delete_policy!(client :: ExAws.Autoscaling.t, input :: delete_policy_type) :: ExAws.Request.Query.success_t | no_return

Same as delete_policy/2 but raise on error.

Source
delete_scheduled_action(client, input)

Specs:

DeleteScheduledAction

Deletes the specified scheduled action.

Source
delete_scheduled_action!(client, input)

Specs:

  • delete_scheduled_action!(client :: ExAws.Autoscaling.t, input :: delete_scheduled_action_type) :: ExAws.Request.Query.success_t | no_return

Same as delete_scheduled_action/2 but raise on error.

Source
delete_tags(client, input)

Specs:

  • delete_tags(client :: ExAws.Autoscaling.t, input :: delete_tags_type) :: ExAws.Request.Query.response_t

DeleteTags

Deletes the specified tags.

Source
delete_tags!(client, input)

Specs:

  • delete_tags!(client :: ExAws.Autoscaling.t, input :: delete_tags_type) :: ExAws.Request.Query.success_t | no_return

Same as delete_tags/2 but raise on error.

Source
describe_account_limits(client)

Specs:

  • describe_account_limits(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.response_t

DescribeAccountLimits

Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference.

Source
describe_account_limits!(client)

Specs:

  • describe_account_limits!(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.success_t | no_return

Same as describe_account_limits/2 but raise on error.

Source
describe_adjustment_types(client)

Specs:

  • describe_adjustment_types(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.response_t

DescribeAdjustmentTypes

Describes the policy adjustment types for use with PutScalingPolicy.

Source
describe_adjustment_types!(client)

Specs:

  • describe_adjustment_types!(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.success_t | no_return

Same as describe_adjustment_types/2 but raise on error.

Source
describe_auto_scaling_groups(client, input)

Specs:

DescribeAutoScalingGroups

Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.

Source
describe_auto_scaling_groups!(client, input)

Specs:

  • describe_auto_scaling_groups!(client :: ExAws.Autoscaling.t, input :: auto_scaling_group_names_type) :: ExAws.Request.Query.success_t | no_return

Same as describe_auto_scaling_groups/2 but raise on error.

Source
describe_auto_scaling_instances(client, input)

Specs:

DescribeAutoScalingInstances

Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.

Source
describe_auto_scaling_instances!(client, input)

Specs:

Same as describe_auto_scaling_instances/2 but raise on error.

Source
describe_auto_scaling_notification_types(client)

Specs:

  • describe_auto_scaling_notification_types(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.response_t

DescribeAutoScalingNotificationTypes

Describes the notification types that are supported by Auto Scaling.

Source
describe_auto_scaling_notification_types!(client)

Specs:

  • describe_auto_scaling_notification_types!(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.success_t | no_return

Same as describe_auto_scaling_notification_types/2 but raise on error.

Source
describe_launch_configurations(client, input)

Specs:

DescribeLaunchConfigurations

Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.

Source
describe_launch_configurations!(client, input)

Specs:

Same as describe_launch_configurations/2 but raise on error.

Source
describe_lifecycle_hook_types(client)

Specs:

  • describe_lifecycle_hook_types(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.response_t

DescribeLifecycleHookTypes

Describes the available types of lifecycle hooks.

Source
describe_lifecycle_hook_types!(client)

Specs:

  • describe_lifecycle_hook_types!(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.success_t | no_return

Same as describe_lifecycle_hook_types/2 but raise on error.

Source
describe_lifecycle_hooks(client, input)

Specs:

DescribeLifecycleHooks

Describes the lifecycle hooks for the specified Auto Scaling group.

Source
describe_lifecycle_hooks!(client, input)

Specs:

Same as describe_lifecycle_hooks/2 but raise on error.

Source
describe_load_balancers(client, input)

Specs:

DescribeLoadBalancers

Describes the load balancers for the specified Auto Scaling group.

Source
describe_load_balancers!(client, input)

Specs:

Same as describe_load_balancers/2 but raise on error.

Source
describe_metric_collection_types(client)

Specs:

  • describe_metric_collection_types(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.response_t

DescribeMetricCollectionTypes

Describes the available CloudWatch metrics for Auto Scaling.

Note that the GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

Source
describe_metric_collection_types!(client)

Specs:

  • describe_metric_collection_types!(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.success_t | no_return

Same as describe_metric_collection_types/2 but raise on error.

Source
describe_notification_configurations(client, input)

Specs:

DescribeNotificationConfigurations

Describes the notification actions associated with the specified Auto Scaling group.

Source
describe_notification_configurations!(client, input)

Specs:

Same as describe_notification_configurations/2 but raise on error.

Source
describe_policies(client, input)

Specs:

  • describe_policies(client :: ExAws.Autoscaling.t, input :: describe_policies_type) :: ExAws.Request.Query.response_t

DescribePolicies

Describes the policies for the specified Auto Scaling group.

Source
describe_policies!(client, input)

Specs:

  • describe_policies!(client :: ExAws.Autoscaling.t, input :: describe_policies_type) :: ExAws.Request.Query.success_t | no_return

Same as describe_policies/2 but raise on error.

Source
describe_scaling_activities(client, input)

Specs:

DescribeScalingActivities

Describes one or more scaling activities for the specified Auto Scaling group. If you omit the ActivityIds, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.

Source
describe_scaling_activities!(client, input)

Specs:

Same as describe_scaling_activities/2 but raise on error.

Source
describe_scaling_process_types(client)

Specs:

  • describe_scaling_process_types(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.response_t

DescribeScalingProcessTypes

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

Source
describe_scaling_process_types!(client)

Specs:

  • describe_scaling_process_types!(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.success_t | no_return

Same as describe_scaling_process_types/2 but raise on error.

Source
describe_scheduled_actions(client, input)

Specs:

DescribeScheduledActions

Describes the actions scheduled for your Auto Scaling group that haven’t run. To describe the actions that have already run, use DescribeScalingActivities.

Source
describe_scheduled_actions!(client, input)

Specs:

Same as describe_scheduled_actions/2 but raise on error.

Source
describe_tags(client, input)

Specs:

  • describe_tags(client :: ExAws.Autoscaling.t, input :: describe_tags_type) :: ExAws.Request.Query.response_t

DescribeTags

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.

Source
describe_tags!(client, input)

Specs:

  • describe_tags!(client :: ExAws.Autoscaling.t, input :: describe_tags_type) :: ExAws.Request.Query.success_t | no_return

Same as describe_tags/2 but raise on error.

Source
describe_termination_policy_types(client)

Specs:

  • describe_termination_policy_types(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.response_t

DescribeTerminationPolicyTypes

Describes the termination policies supported by Auto Scaling.

Source
describe_termination_policy_types!(client)

Specs:

  • describe_termination_policy_types!(client :: ExAws.Autoscaling.t) :: ExAws.Request.Query.success_t | no_return

Same as describe_termination_policy_types/2 but raise on error.

Source
detach_instances(client, input)

Specs:

  • detach_instances(client :: ExAws.Autoscaling.t, input :: detach_instances_query) :: ExAws.Request.Query.response_t

DetachInstances

Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide.

Source
detach_instances!(client, input)

Specs:

  • detach_instances!(client :: ExAws.Autoscaling.t, input :: detach_instances_query) :: ExAws.Request.Query.success_t | no_return

Same as detach_instances/2 but raise on error.

Source
detach_load_balancers(client, input)

Specs:

DetachLoadBalancers

Removes one or more load balancers from the specified Auto Scaling group.

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 DescribeLoadBalancers. Note that the instances remain running.

Source
detach_load_balancers!(client, input)

Specs:

  • detach_load_balancers!(client :: ExAws.Autoscaling.t, input :: detach_load_balancers_type) :: ExAws.Request.Query.success_t | no_return

Same as detach_load_balancers/2 but raise on error.

Source
disable_metrics_collection(client, input)

Specs:

DisableMetricsCollection

Disables monitoring of the specified metrics for the specified Auto Scaling group.

Source
disable_metrics_collection!(client, input)

Specs:

Same as disable_metrics_collection/2 but raise on error.

Source
enable_metrics_collection(client, input)

Specs:

EnableMetricsCollection

Enables monitoring of the specified metrics for the specified Auto Scaling group.

You can only enable metrics collection if InstanceMonitoring in the launch configuration for the group is set to True.

Source
enable_metrics_collection!(client, input)

Specs:

Same as enable_metrics_collection/2 but raise on error.

Source
enter_standby(client, input)

Specs:

  • enter_standby(client :: ExAws.Autoscaling.t, input :: enter_standby_query) :: ExAws.Request.Query.response_t

EnterStandby

Moves the specified instances into Standby mode.

For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide.

Source
enter_standby!(client, input)

Specs:

  • enter_standby!(client :: ExAws.Autoscaling.t, input :: enter_standby_query) :: ExAws.Request.Query.success_t | no_return

Same as enter_standby/2 but raise on error.

Source
execute_policy(client, input)

Specs:

  • execute_policy(client :: ExAws.Autoscaling.t, input :: execute_policy_type) :: ExAws.Request.Query.response_t

ExecutePolicy

Executes the specified policy.

Source
execute_policy!(client, input)

Specs:

  • execute_policy!(client :: ExAws.Autoscaling.t, input :: execute_policy_type) :: ExAws.Request.Query.success_t | no_return

Same as execute_policy/2 but raise on error.

Source
exit_standby(client, input)

Specs:

  • exit_standby(client :: ExAws.Autoscaling.t, input :: exit_standby_query) :: ExAws.Request.Query.response_t

ExitStandby

Moves the specified instances out of Standby mode.

For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide.

Source
exit_standby!(client, input)

Specs:

  • exit_standby!(client :: ExAws.Autoscaling.t, input :: exit_standby_query) :: ExAws.Request.Query.success_t | no_return

Same as exit_standby/2 but raise on error.

Source
put_lifecycle_hook(client, input)

Specs:

  • put_lifecycle_hook(client :: ExAws.Autoscaling.t, input :: put_lifecycle_hook_type) :: ExAws.Request.Query.response_t

PutLifecycleHook

Creates or updates a lifecycle hook for the specified Auto Scaling Group.

A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  • Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.

  • Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.

  • Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.

  • If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.

  • Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Source
put_lifecycle_hook!(client, input)

Specs:

  • put_lifecycle_hook!(client :: ExAws.Autoscaling.t, input :: put_lifecycle_hook_type) :: ExAws.Request.Query.success_t | no_return

Same as put_lifecycle_hook/2 but raise on error.

Source
put_notification_configuration(client, input)

Specs:

PutNotificationConfiguration

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.

For more information see Getting Notifications When Your Auto Scaling Group Changes in the Auto Scaling Developer Guide.

This configuration overwrites an existing configuration.

Source
put_notification_configuration!(client, input)

Specs:

Same as put_notification_configuration/2 but raise on error.

Source
put_scaling_policy(client, input)

Specs:

  • put_scaling_policy(client :: ExAws.Autoscaling.t, input :: put_scaling_policy_type) :: ExAws.Request.Query.response_t

PutScalingPolicy

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

Source
put_scaling_policy!(client, input)

Specs:

  • put_scaling_policy!(client :: ExAws.Autoscaling.t, input :: put_scaling_policy_type) :: ExAws.Request.Query.success_t | no_return

Same as put_scaling_policy/2 but raise on error.

Source
put_scheduled_update_group_action(client, input)

Specs:

PutScheduledUpdateGroupAction

Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

For more information, see Scheduled Scaling in the Auto Scaling Developer Guide.

Source
put_scheduled_update_group_action!(client, input)

Specs:

Same as put_scheduled_update_group_action/2 but raise on error.

Source
record_lifecycle_action_heartbeat(client, input)

Specs:

RecordLifecycleActionHeartbeat

Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of PutLifecycleHook.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  • Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.

  • Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.

  • Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.

  • If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.

  • Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide.

Source
record_lifecycle_action_heartbeat!(client, input)

Specs:

Same as record_lifecycle_action_heartbeat/2 but raise on error.

Source
resume_processes(client, input)

Specs:

  • resume_processes(client :: ExAws.Autoscaling.t, input :: scaling_process_query) :: ExAws.Request.Query.response_t

ResumeProcesses

Resumes the specified suspended Auto Scaling processes for the specified Auto Scaling group. To resume specific processes, use the ScalingProcesses parameter. To resume all processes, omit the ScalingProcesses parameter. For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide.

Source
resume_processes!(client, input)

Specs:

  • resume_processes!(client :: ExAws.Autoscaling.t, input :: scaling_process_query) :: ExAws.Request.Query.success_t | no_return

Same as resume_processes/2 but raise on error.

Source
set_desired_capacity(client, input)

Specs:

SetDesiredCapacity

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Auto Scaling? in the Auto Scaling Developer Guide.

Source
set_desired_capacity!(client, input)

Specs:

  • set_desired_capacity!(client :: ExAws.Autoscaling.t, input :: set_desired_capacity_type) :: ExAws.Request.Query.success_t | no_return

Same as set_desired_capacity/2 but raise on error.

Source
set_instance_health(client, input)

Specs:

SetInstanceHealth

Sets the health status of the specified instance.

For more information, see Health Checks in the Auto Scaling Developer Guide.

Source
set_instance_health!(client, input)

Specs:

  • set_instance_health!(client :: ExAws.Autoscaling.t, input :: set_instance_health_query) :: ExAws.Request.Query.success_t | no_return

Same as set_instance_health/2 but raise on error.

Source
suspend_processes(client, input)

Specs:

  • suspend_processes(client :: ExAws.Autoscaling.t, input :: scaling_process_query) :: ExAws.Request.Query.response_t

SuspendProcesses

Suspends the specified Auto Scaling processes for the specified Auto Scaling group. To suspend specific processes, use the ScalingProcesses parameter. To suspend all processes, omit the ScalingProcesses parameter.

Note that if you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide.

Source
suspend_processes!(client, input)

Specs:

  • suspend_processes!(client :: ExAws.Autoscaling.t, input :: scaling_process_query) :: ExAws.Request.Query.success_t | no_return

Same as suspend_processes/2 but raise on error.

Source
terminate_instance_in_auto_scaling_group(client, input)

Specs:

TerminateInstanceInAutoScalingGroup

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instances is not terminated immediately.

Source
terminate_instance_in_auto_scaling_group!(client, input)

Specs:

Same as terminate_instance_in_auto_scaling_group/2 but raise on error.

Source
update_auto_scaling_group(client, input)

Specs:

UpdateAutoScalingGroup

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to False, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren’t affected.

Note the following:

  • 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, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize.

  • 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, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize.

  • All other optional parameters are left unchanged if not specified.
Source
update_auto_scaling_group!(client, input)

Specs:

Same as update_auto_scaling_group/2 but raise on error.

Source