AutoScaling ¶

Table of Contents

AutoScaling
- Client
- Paginators

Client ¶

class AutoScaling.Client¶

A low-level client representing Auto Scaling:

import boto3

client = boto3.client('autoscaling')

These are the available methods:

attach_instances()
attach_load_balancer_target_groups()
attach_load_balancers()
batch_delete_scheduled_action()
batch_put_scheduled_update_group_action()
can_paginate()
complete_lifecycle_action()
create_auto_scaling_group()
create_launch_configuration()
create_or_update_tags()
delete_auto_scaling_group()
delete_launch_configuration()
delete_lifecycle_hook()
delete_notification_configuration()
delete_policy()
delete_scheduled_action()
delete_tags()
describe_account_limits()
describe_adjustment_types()
describe_auto_scaling_groups()
describe_auto_scaling_instances()
describe_auto_scaling_notification_types()
describe_launch_configurations()
describe_lifecycle_hook_types()
describe_lifecycle_hooks()
describe_load_balancer_target_groups()
describe_load_balancers()
describe_metric_collection_types()
describe_notification_configurations()
describe_policies()
describe_scaling_activities()
describe_scaling_process_types()
describe_scheduled_actions()
describe_tags()
describe_termination_policy_types()
detach_instances()
detach_load_balancer_target_groups()
detach_load_balancers()
disable_metrics_collection()
enable_metrics_collection()
enter_standby()
execute_policy()
exit_standby()
generate_presigned_url()
get_paginator()
get_waiter()
put_lifecycle_hook()
put_notification_configuration()
put_scaling_policy()
put_scheduled_update_group_action()
record_lifecycle_action_heartbeat()
resume_processes()
set_desired_capacity()
set_instance_health()
set_instance_protection()
suspend_processes()
terminate_instance_in_auto_scaling_group()
update_auto_scaling_group()

attach_instances(**kwargs)¶

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 Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.attach_instances(
    InstanceIds=[
        'string',
    ],
    AutoScalingGroupName='string'
)

Parameters

InstanceIds (list) --
The IDs of the instances. You can specify up to 20 instances.
- (string) --
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.

Returns

None

Examples

This example attaches the specified instance to the specified Auto Scaling group.

response = client.attach_instances(
    AutoScalingGroupName='my-auto-scaling-group',
    InstanceIds=[
        'i-93633f9b',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

attach_load_balancer_target_groups(**kwargs)¶

Attaches one or more target groups to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups . To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups .

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.attach_load_balancer_target_groups(
    AutoScalingGroupName='string',
    TargetGroupARNs=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
TargetGroupARNs (list) --
[REQUIRED]

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example attaches the specified target group to the specified Auto Scaling group.

response = client.attach_load_balancer_target_groups(
    AutoScalingGroupName='my-auto-scaling-group',
    TargetGroupARNs=[
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

attach_load_balancers(**kwargs)¶

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups .

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 Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.attach_load_balancers(
    AutoScalingGroupName='string',
    LoadBalancerNames=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
LoadBalancerNames (list) --
[REQUIRED]

The names of the load balancers. You can specify up to 10 load balancers.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example attaches the specified load balancer to the specified Auto Scaling group.

response = client.attach_load_balancers(
    AutoScalingGroupName='my-auto-scaling-group',
    LoadBalancerNames=[
        'my-load-balancer',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

batch_delete_scheduled_action(**kwargs)¶

Deletes one or more scheduled actions for the specified Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_scheduled_action(
    AutoScalingGroupName='string',
    ScheduledActionNames=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ScheduledActionNames (list) --
[REQUIRED]

The names of the scheduled actions to delete. The maximum number allowed is 50.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'FailedScheduledActions': [
        {
            'ScheduledActionName': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- FailedScheduledActions (list) --
  
  The names of the scheduled actions that could not be deleted, including an error message.
  - (dict) --
    
    Describes a scheduled action that could not be created, updated, or deleted.
    - ScheduledActionName (string) --
      
      The name of the scheduled action.
    - ErrorCode (string) --
      
      The error code.
    - ErrorMessage (string) --
      
      The error message accompanying the error code.

batch_put_scheduled_update_group_action(**kwargs)¶

Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_scheduled_update_group_action(
    AutoScalingGroupName='string',
    ScheduledUpdateGroupActions=[
        {
            'ScheduledActionName': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Recurrence': 'string',
            'MinSize': 123,
            'MaxSize': 123,
            'DesiredCapacity': 123
        },
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ScheduledUpdateGroupActions (list) --
[REQUIRED]

One or more scheduled actions. The maximum number allowed is 50.
- (dict) --
  Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction .
  
  When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.
  - ScheduledActionName (string) -- [REQUIRED]
    The name of the scaling action.
  - StartTime (datetime) --
    The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z" ).
    
    If you specify Recurrence and StartTime , Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
    
    If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
  - EndTime (datetime) --
    The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
  - Recurrence (string) --
    The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *" ). For more information about this format, see Crontab .
    
    When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
  - MinSize (integer) --
    The minimum number of instances in the Auto Scaling group.
  - MaxSize (integer) --
    The maximum number of instances in the Auto Scaling group.
  - DesiredCapacity (integer) --
    The number of EC2 instances that should be running in the group.

Return type

dict

Returns

Response Syntax

{
    'FailedScheduledUpdateGroupActions': [
        {
            'ScheduledActionName': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- FailedScheduledUpdateGroupActions (list) --
  
  The names of the scheduled actions that could not be created or updated, including an error message.
  - (dict) --
    
    Describes a scheduled action that could not be created, updated, or deleted.
    - ScheduledActionName (string) --
      
      The name of the scheduled action.
    - ErrorCode (string) --
      
      The error code.
    - ErrorMessage (string) --
      
      The error message accompanying the error code.

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

complete_lifecycle_action(**kwargs)¶

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 Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(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 pending state.
If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.complete_lifecycle_action(
    LifecycleHookName='string',
    AutoScalingGroupName='string',
    LifecycleActionToken='string',
    LifecycleActionResult='string',
    InstanceId='string'
)

Parameters

LifecycleHookName (string) --
[REQUIRED]

The name of the lifecycle hook.
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
LifecycleActionToken (string) -- A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
LifecycleActionResult (string) --
[REQUIRED]

The action for the group to take. This parameter can be either CONTINUE or ABANDON .
InstanceId (string) -- The ID of the instance.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.

response = client.complete_lifecycle_action(
    AutoScalingGroupName='my-auto-scaling-group',
    LifecycleActionResult='CONTINUE',
    LifecycleActionToken='bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635',
    LifecycleHookName='my-lifecycle-hook',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

create_auto_scaling_group(**kwargs)¶

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

If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits . For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_auto_scaling_group(
    AutoScalingGroupName='string',
    LaunchConfigurationName='string',
    LaunchTemplate={
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'Version': 'string'
    },
    MixedInstancesPolicy={
        'LaunchTemplate': {
            'LaunchTemplateSpecification': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'Overrides': [
                {
                    'InstanceType': 'string'
                },
            ]
        },
        'InstancesDistribution': {
            'OnDemandAllocationStrategy': 'string',
            'OnDemandBaseCapacity': 123,
            'OnDemandPercentageAboveBaseCapacity': 123,
            'SpotAllocationStrategy': 'string',
            'SpotInstancePools': 123,
            'SpotMaxPrice': 'string'
        }
    },
    InstanceId='string',
    MinSize=123,
    MaxSize=123,
    DesiredCapacity=123,
    DefaultCooldown=123,
    AvailabilityZones=[
        'string',
    ],
    LoadBalancerNames=[
        'string',
    ],
    TargetGroupARNs=[
        'string',
    ],
    HealthCheckType='string',
    HealthCheckGracePeriod=123,
    PlacementGroup='string',
    VPCZoneIdentifier='string',
    TerminationPolicies=[
        'string',
    ],
    NewInstancesProtectedFromScaleIn=True|False,
    LifecycleHookSpecificationList=[
        {
            'LifecycleHookName': 'string',
            'LifecycleTransition': 'string',
            'NotificationMetadata': 'string',
            'HeartbeatTimeout': 123,
            'DefaultResult': 'string',
            'NotificationTargetARN': 'string',
            'RoleARN': 'string'
        },
    ],
    Tags=[
        {
            'ResourceId': 'string',
            'ResourceType': 'string',
            'Key': 'string',
            'Value': 'string',
            'PropagateAtLaunch': True|False
        },
    ],
    ServiceLinkedRoleARN='string'
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group. This name must be unique per Region per account.
LaunchConfigurationName (string) --
The name of the launch configuration.

If you do not specify LaunchConfigurationName , you must specify one of the following parameters: InstanceId , LaunchTemplate , or MixedInstancesPolicy .
LaunchTemplate (dict) --
The launch template to use to launch instances.

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference .

If you do not specify LaunchTemplate , you must specify one of the following parameters: InstanceId , LaunchConfigurationName , or MixedInstancesPolicy .
- LaunchTemplateId (string) --
  The ID of the launch template. You must specify either a template ID or a template name.
- LaunchTemplateName (string) --
  The name of the launch template. You must specify either a template name or a template ID.
- Version (string) --
  The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
MixedInstancesPolicy (dict) --
An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.

The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide .

You must specify one of the following parameters in your request: LaunchConfigurationName , LaunchTemplate , InstanceId , or MixedInstancesPolicy .
- LaunchTemplate (dict) --
  The launch template and instance types (overrides).
  
  This parameter must be specified when creating a mixed instances policy.
  - LaunchTemplateSpecification (dict) --
    The launch template to use. You must specify either the launch template ID or launch template name in the request.
    - LaunchTemplateId (string) --
      The ID of the launch template. You must specify either a template ID or a template name.
    - LaunchTemplateName (string) --
      The name of the launch template. You must specify either a template name or a template ID.
    - Version (string) --
      The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
  - Overrides (list) --
    Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You must specify between 2 and 20 overrides.
    - (dict) --
      Describes an override for a launch template.
      - InstanceType (string) --
        The instance type.
        
        For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
- InstancesDistribution (dict) --
  The instances distribution to use.
  
  If you leave this parameter unspecified when creating a mixed instances policy, the default values are used.
  - OnDemandAllocationStrategy (string) --
    Indicates how to allocate instance types to fulfill On-Demand capacity.
    
    The only valid value is prioritized , which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.
  - OnDemandBaseCapacity (integer) --
    The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
    
    The default value is 0 . If you leave this parameter set to 0 , On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.
  - OnDemandPercentageAboveBaseCapacity (integer) --
    Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity . The range is 0–100.
    
    The default value is 100 . If you leave this parameter set to 100 , the percentages are 100% for On-Demand Instances and 0% for Spot Instances.
  - SpotAllocationStrategy (string) --
    Indicates how to allocate instances across Spot Instance pools.
    
    If the allocation strategy is lowest-price , the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized , the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity.
    
    The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is lowest-price . The default Spot allocation strategy for the AWS Management Console is capacity-optimized .
    
    Valid values: lowest-price | capacity-optimized
  - SpotInstancePools (integer) --
    The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate . The range is 1–20. The default value is 2 .
    
    Valid only when the Spot allocation strategy is lowest-price .
  - SpotMaxPrice (string) --
    The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.
    
    To remove a value that you previously set, include the parameter but leave the value blank.
InstanceId (string) --
The ID of the instance used to create a launch configuration for the group.

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide .

You must specify one of the following parameters in your request: LaunchConfigurationName , LaunchTemplate , InstanceId , or MixedInstancesPolicy .
MinSize (integer) --
[REQUIRED]

The minimum size of the group.
MaxSize (integer) --
[REQUIRED]

The maximum size of the group.
DesiredCapacity (integer) -- The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
DefaultCooldown (integer) --
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300 .

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide .
AvailabilityZones (list) --
One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier .

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
- (string) --
LoadBalancerNames (list) --
A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead.

For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .
- (string) --
TargetGroupARNs (list) --
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group.

For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .
- (string) --
HealthCheckType (string) --
The service to use for the health checks. The valid values are EC2 and ELB . The default value is EC2 . If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide .
HealthCheckGracePeriod (integer) --
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is 0 .

For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide .

Conditional: This parameter is required if you are adding an ELB health check.
PlacementGroup (string) -- The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances .
VPCZoneIdentifier (string) --
A comma-separated list of subnet IDs for your virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones , the subnets that you specify for this parameter must reside in those Availability Zones.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
TerminationPolicies (list) --
One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide .
- (string) --
NewInstancesProtectedFromScaleIn (boolean) --
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide .
LifecycleHookSpecificationList (list) --
One or more lifecycle hooks.
- (dict) --
  Describes a lifecycle hook. Used in combination with CreateAutoScalingGroup .
  
  A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).
  
  This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:
  - (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
  - (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 pending state using RecordLifecycleActionHeartbeat .
  - If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction .
  For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide .
  
  You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks . You can modify an existing lifecycle hook or create new lifecycle hooks using PutLifecycleHook . If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook .
  - LifecycleHookName (string) -- [REQUIRED]
    The name of the lifecycle hook.
  - LifecycleTransition (string) -- [REQUIRED]
    The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:
    - autoscaling:EC2_INSTANCE_LAUNCHING
    - autoscaling:EC2_INSTANCE_TERMINATING
  - NotificationMetadata (string) --
    Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
  - HeartbeatTimeout (integer) --
    The maximum time, in seconds, that can elapse before the lifecycle hook times out.
    
    If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat .
  - DefaultResult (string) --
    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON . The default value is ABANDON .
  - NotificationTargetARN (string) --
    The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
  - RoleARN (string) --
    The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
Tags (list) --
One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide .
- (dict) --
  Describes a tag for an Auto Scaling group.
  - ResourceId (string) --
    The name of the group.
  - ResourceType (string) --
    The type of resource. The only supported value is auto-scaling-group .
  - Key (string) -- [REQUIRED]
    The tag key.
  - Value (string) --
    The tag value.
  - PropagateAtLaunch (boolean) --
    Determines whether the tag is added to new instances as they are launched in the group.
ServiceLinkedRoleARN (string) -- The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide .

Returns

None

Examples

This example creates an Auto Scaling group.

response = client.create_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
    LaunchConfigurationName='my-launch-config',
    MaxSize=3,
    MinSize=1,
    VPCZoneIdentifier='subnet-4176792c',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.

response = client.create_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
    AvailabilityZones=[
        'us-west-2c',
    ],
    HealthCheckGracePeriod=120,
    HealthCheckType='ELB',
    LaunchConfigurationName='my-launch-config',
    LoadBalancerNames=[
        'my-load-balancer',
    ],
    MaxSize=3,
    MinSize=1,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates an Auto Scaling group and attaches the specified target group.

response = client.create_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
    HealthCheckGracePeriod=120,
    HealthCheckType='ELB',
    LaunchConfigurationName='my-launch-config',
    MaxSize=3,
    MinSize=1,
    TargetGroupARNs=[
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
    VPCZoneIdentifier='subnet-4176792c, subnet-65ea5f08',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

create_launch_configuration(**kwargs)¶

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits . For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide .

For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_launch_configuration(
    LaunchConfigurationName='string',
    ImageId='string',
    KeyName='string',
    SecurityGroups=[
        'string',
    ],
    ClassicLinkVPCId='string',
    ClassicLinkVPCSecurityGroups=[
        'string',
    ],
    UserData='string',
    InstanceId='string',
    InstanceType='string',
    KernelId='string',
    RamdiskId='string',
    BlockDeviceMappings=[
        {
            'VirtualName': 'string',
            'DeviceName': 'string',
            'Ebs': {
                'SnapshotId': 'string',
                'VolumeSize': 123,
                'VolumeType': 'string',
                'DeleteOnTermination': True|False,
                'Iops': 123,
                'Encrypted': True|False
            },
            'NoDevice': True|False
        },
    ],
    InstanceMonitoring={
        'Enabled': True|False
    },
    SpotPrice='string',
    IamInstanceProfile='string',
    EbsOptimized=True|False,
    AssociatePublicIpAddress=True|False,
    PlacementTenancy='string'
)

Parameters

LaunchConfigurationName (string) --
[REQUIRED]

The name of the launch configuration. This name must be unique per Region per account.
ImageId (string) --
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances .

If you do not specify InstanceId , you must specify ImageId .
KeyName (string) -- The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances .
SecurityGroups (list) --
A list that contains the security groups to assign to the instances in the Auto Scaling group.

[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .

[EC2-Classic] Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances .
- (string) --
ClassicLinkVPCId (string) --
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .

This parameter can only be used if you are launching EC2-Classic instances.
ClassicLinkVPCSecurityGroups (list) --
The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .

If you specify the ClassicLinkVPCId parameter, you must specify this parameter.
- (string) --
UserData (string) --
The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances .

This value will be base64 encoded automatically. Do not base64 encode this value prior to performing the operation.
InstanceId (string) --
The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide .

If you do not specify InstanceId , you must specify both ImageId and InstanceType .
InstanceType (string) --
Specifies the instance type of the EC2 instance.

For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

If you do not specify InstanceId , you must specify InstanceType .
KernelId (string) -- The ID of the kernel associated with the AMI.
RamdiskId (string) -- The ID of the RAM disk to select.
BlockDeviceMappings (list) --
A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances .
- (dict) --
  Describes a block device mapping.
  - VirtualName (string) --
    The name of the virtual device (for example, ephemeral0 ).
  - DeviceName (string) -- [REQUIRED]
    The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh ). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances .
  - Ebs (dict) --
    The information about the Amazon EBS volume.
    - SnapshotId (string) --
      The snapshot ID of the volume to use.
      
      Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize , VolumeSize must be equal or greater than the size of the snapshot.
    - VolumeSize (integer) --
      The volume size, in Gibibytes (GiB).
      
      This can be a number from 1-1,024 for standard , 4-16,384 for io1 , 1-16,384 for gp2 , and 500-16,384 for st1 and sc1 . If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
      
      Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.
      
      Note
      
      At least one of VolumeSize or SnapshotId is required.
    - VolumeType (string) --
      The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .
      
      Valid values: standard | io1 | gp2 | st1 | sc1
    - DeleteOnTermination (boolean) --
      Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true .
    - Iops (integer) --
      The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .
      
      Conditional: This parameter is required when the volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)
    - Encrypted (boolean) --
      Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
      
      Note
      
      If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.
      
      Enabling encryption by default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.
      
      For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK Key Policy for Use with Encrypted Volumes in the Amazon EC2 Auto Scaling User Guide .
  - NoDevice (boolean) --
    Suppresses a device mapping.
    
    If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.
InstanceMonitoring (dict) --
Controls whether instances in this group are launched with detailed (true ) or basic (false ) monitoring.

The default value is true (enabled).

Warning

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide .
- Enabled (boolean) --
  If true , detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
SpotPrice (string) --
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .

If a Spot price is set, then the Auto Scaling group will only launch instances when the Spot price has been met, regardless of the setting in the Auto Scaling group's DesiredCapacity .

Note

When you change your Spot price by creating a new launch configuration, running instances will continue to run as long as the Spot price for those running instances is higher than the current Spot market price.
IamInstanceProfile (string) --
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide .
EbsOptimized (boolean) --
Specifies whether the launch configuration is optimized for EBS I/O (true ) or not (false ). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances .

The default value is false .
AssociatePublicIpAddress (boolean) --
For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true , each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide .

If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

Note

If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.
PlacementTenancy (string) --
The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.

To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default ), you must set the value of this parameter to dedicated .

If you specify PlacementTenancy , you must specify at least one subnet for VPCZoneIdentifier when you create your group.

For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide .

Valid values: default | dedicated

Returns

None

Examples

This example creates a launch configuration.

response = client.create_launch_configuration(
    IamInstanceProfile='my-iam-role',
    ImageId='ami-12345678',
    InstanceType='m3.medium',
    LaunchConfigurationName='my-launch-config',
    SecurityGroups=[
        'sg-eb2af88e',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

create_or_update_tags(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.create_or_update_tags(
    Tags=[
        {
            'ResourceId': 'string',
            'ResourceType': 'string',
            'Key': 'string',
            'Value': 'string',
            'PropagateAtLaunch': True|False
        },
    ]
)

Parameters

Tags (list) --

[REQUIRED]

One or more tags.

(dict) --
Describes a tag for an Auto Scaling group.
- ResourceId (string) --
  The name of the group.
- ResourceType (string) --
  The type of resource. The only supported value is auto-scaling-group .
- Key (string) -- [REQUIRED]
  The tag key.
- Value (string) --
  The tag value.
- PropagateAtLaunch (boolean) --
  Determines whether the tag is added to new instances as they are launched in the group.

Returns

None

Examples

This example adds two tags to the specified Auto Scaling group.

response = client.create_or_update_tags(
    Tags=[
        {
            'Key': 'Role',
            'PropagateAtLaunch': True,
            'ResourceId': 'my-auto-scaling-group',
            'ResourceType': 'auto-scaling-group',
            'Value': 'WebServer',
        },
        {
            'Key': 'Dept',
            'PropagateAtLaunch': True,
            'ResourceId': 'my-auto-scaling-group',
            'ResourceType': 'auto-scaling-group',
            'Value': 'Research',
        },
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

delete_auto_scaling_group(**kwargs)¶

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.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call DetachInstances 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 UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.

See also: AWS API Documentation

Request Syntax

response = client.delete_auto_scaling_group(
    AutoScalingGroupName='string',
    ForceDelete=True|False
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ForceDelete (boolean) -- Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

Returns

None

Examples

This example deletes the specified Auto Scaling group.

response = client.delete_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example deletes the specified Auto Scaling group and all its instances.

response = client.delete_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
    ForceDelete=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

delete_launch_configuration(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_launch_configuration(
    LaunchConfigurationName='string'
)

Parameters

LaunchConfigurationName (string) --

[REQUIRED]

The name of the launch configuration.

Returns

None

Examples

This example deletes the specified launch configuration.

response = client.delete_launch_configuration(
    LaunchConfigurationName='my-launch-config',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

delete_lifecycle_hook(**kwargs)¶

Deletes the specified lifecycle hook.

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

See also: AWS API Documentation

Request Syntax

response = client.delete_lifecycle_hook(
    LifecycleHookName='string',
    AutoScalingGroupName='string'
)

Parameters

LifecycleHookName (string) --
[REQUIRED]

The name of the lifecycle hook.
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example deletes the specified lifecycle hook.

response = client.delete_lifecycle_hook(
    AutoScalingGroupName='my-auto-scaling-group',
    LifecycleHookName='my-lifecycle-hook',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

delete_notification_configuration(**kwargs)¶

Deletes the specified notification.

See also: AWS API Documentation

Request Syntax

response = client.delete_notification_configuration(
    AutoScalingGroupName='string',
    TopicARN='string'
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
TopicARN (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.

Returns

None

Examples

This example deletes the specified notification from the specified Auto Scaling group.

response = client.delete_notification_configuration(
    AutoScalingGroupName='my-auto-scaling-group',
    TopicARN='arn:aws:sns:us-west-2:123456789012:my-sns-topic',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

delete_policy(**kwargs)¶

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 Deleting a Scaling Policy in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_policy(
    AutoScalingGroupName='string',
    PolicyName='string'
)

Parameters

AutoScalingGroupName (string) -- The name of the Auto Scaling group.
PolicyName (string) --
[REQUIRED]

The name or Amazon Resource Name (ARN) of the policy.

Returns

None

Examples

This example deletes the specified Auto Scaling policy.

response = client.delete_policy(
    AutoScalingGroupName='my-auto-scaling-group',
    PolicyName='ScaleIn',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

delete_scheduled_action(**kwargs)¶

Deletes the specified scheduled action.

See also: AWS API Documentation

Request Syntax

response = client.delete_scheduled_action(
    AutoScalingGroupName='string',
    ScheduledActionName='string'
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ScheduledActionName (string) --
[REQUIRED]

The name of the action to delete.

Returns

None

Examples

This example deletes the specified scheduled action from the specified Auto Scaling group.

response = client.delete_scheduled_action(
    AutoScalingGroupName='my-auto-scaling-group',
    ScheduledActionName='my-scheduled-action',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

delete_tags(**kwargs)¶

Deletes the specified tags.

See also: AWS API Documentation

Request Syntax

response = client.delete_tags(
    Tags=[
        {
            'ResourceId': 'string',
            'ResourceType': 'string',
            'Key': 'string',
            'Value': 'string',
            'PropagateAtLaunch': True|False
        },
    ]
)

Parameters

Tags (list) --

[REQUIRED]

One or more tags.

(dict) --
Describes a tag for an Auto Scaling group.
- ResourceId (string) --
  The name of the group.
- ResourceType (string) --
  The type of resource. The only supported value is auto-scaling-group .
- Key (string) -- [REQUIRED]
  The tag key.
- Value (string) --
  The tag value.
- PropagateAtLaunch (boolean) --
  Determines whether the tag is added to new instances as they are launched in the group.

Returns

None

Examples

This example deletes the specified tag from the specified Auto Scaling group.

response = client.delete_tags(
    Tags=[
        {
            'Key': 'Dept',
            'ResourceId': 'my-auto-scaling-group',
            'ResourceType': 'auto-scaling-group',
            'Value': 'Research',
        },
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_account_limits()¶

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

For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_account_limits()

Return type

dict

Returns

Response Syntax

{
    'MaxNumberOfAutoScalingGroups': 123,
    'MaxNumberOfLaunchConfigurations': 123,
    'NumberOfAutoScalingGroups': 123,
    'NumberOfLaunchConfigurations': 123
}

Response Structure

(dict) --
- MaxNumberOfAutoScalingGroups (integer) --
  The maximum number of groups allowed for your AWS account. The default limit is 200 per AWS Region.
- MaxNumberOfLaunchConfigurations (integer) --
  The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per AWS Region.
- NumberOfAutoScalingGroups (integer) --
  The current number of groups for your AWS account.
- NumberOfLaunchConfigurations (integer) --
  The current number of launch configurations for your AWS account.

Examples

This example describes the Auto Scaling limits for your AWS account.

response = client.describe_account_limits(
)

print(response)

Expected Output:

{
    'MaxNumberOfAutoScalingGroups': 20,
    'MaxNumberOfLaunchConfigurations': 100,
    'NumberOfAutoScalingGroups': 3,
    'NumberOfLaunchConfigurations': 5,
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_adjustment_types()¶

Describes the policy adjustment types for use with PutScalingPolicy .

See also: AWS API Documentation

Request Syntax

response = client.describe_adjustment_types()

Return type

dict

Returns

Response Syntax

{
    'AdjustmentTypes': [
        {
            'AdjustmentType': 'string'
        },
    ]
}

Response Structure

(dict) --
- AdjustmentTypes (list) --
  The policy adjustment types.
  - (dict) --
    Describes a policy adjustment type.
    - AdjustmentType (string) --
      The policy adjustment type. The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .

Examples

This example describes the available adjustment types.

response = client.describe_adjustment_types(
)

print(response)

Expected Output:

{
    'AdjustmentTypes': [
        {
            'AdjustmentType': 'ChangeInCapacity',
        },
        {
            'AdjustmentType': 'ExactCapcity',
        },
        {
            'AdjustmentType': 'PercentChangeInCapacity',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_auto_scaling_groups(**kwargs)¶

Describes one or more Auto Scaling groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_auto_scaling_groups(
    AutoScalingGroupNames=[
        'string',
    ],
    NextToken='string',
    MaxRecords=123
)

Parameters

AutoScalingGroupNames (list) --
The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.
- (string) --
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 50 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'AutoScalingGroups': [
        {
            'AutoScalingGroupName': 'string',
            'AutoScalingGroupARN': 'string',
            'LaunchConfigurationName': 'string',
            'LaunchTemplate': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'MixedInstancesPolicy': {
                'LaunchTemplate': {
                    'LaunchTemplateSpecification': {
                        'LaunchTemplateId': 'string',
                        'LaunchTemplateName': 'string',
                        'Version': 'string'
                    },
                    'Overrides': [
                        {
                            'InstanceType': 'string'
                        },
                    ]
                },
                'InstancesDistribution': {
                    'OnDemandAllocationStrategy': 'string',
                    'OnDemandBaseCapacity': 123,
                    'OnDemandPercentageAboveBaseCapacity': 123,
                    'SpotAllocationStrategy': 'string',
                    'SpotInstancePools': 123,
                    'SpotMaxPrice': 'string'
                }
            },
            'MinSize': 123,
            'MaxSize': 123,
            'DesiredCapacity': 123,
            'DefaultCooldown': 123,
            'AvailabilityZones': [
                'string',
            ],
            'LoadBalancerNames': [
                'string',
            ],
            'TargetGroupARNs': [
                'string',
            ],
            'HealthCheckType': 'string',
            'HealthCheckGracePeriod': 123,
            'Instances': [
                {
                    'InstanceId': 'string',
                    'AvailabilityZone': 'string',
                    'LifecycleState': 'Pending'|'Pending:Wait'|'Pending:Proceed'|'Quarantined'|'InService'|'Terminating'|'Terminating:Wait'|'Terminating:Proceed'|'Terminated'|'Detaching'|'Detached'|'EnteringStandby'|'Standby',
                    'HealthStatus': 'string',
                    'LaunchConfigurationName': 'string',
                    'LaunchTemplate': {
                        'LaunchTemplateId': 'string',
                        'LaunchTemplateName': 'string',
                        'Version': 'string'
                    },
                    'ProtectedFromScaleIn': True|False
                },
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'SuspendedProcesses': [
                {
                    'ProcessName': 'string',
                    'SuspensionReason': 'string'
                },
            ],
            'PlacementGroup': 'string',
            'VPCZoneIdentifier': 'string',
            'EnabledMetrics': [
                {
                    'Metric': 'string',
                    'Granularity': 'string'
                },
            ],
            'Status': 'string',
            'Tags': [
                {
                    'ResourceId': 'string',
                    'ResourceType': 'string',
                    'Key': 'string',
                    'Value': 'string',
                    'PropagateAtLaunch': True|False
                },
            ],
            'TerminationPolicies': [
                'string',
            ],
            'NewInstancesProtectedFromScaleIn': True|False,
            'ServiceLinkedRoleARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- AutoScalingGroups (list) --
  
  The groups.
  - (dict) --
    
    Describes an Auto Scaling group.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - AutoScalingGroupARN (string) --
      
      The Amazon Resource Name (ARN) of the Auto Scaling group.
    - LaunchConfigurationName (string) --
      
      The name of the associated launch configuration.
    - LaunchTemplate (dict) --
      
      The launch template for the group.
      - LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
      - LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
      - Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
    - MixedInstancesPolicy (dict) --
      
      The mixed instances policy for the group.
      - LaunchTemplate (dict) --
        
        The launch template and instance types (overrides).
        
        This parameter must be specified when creating a mixed instances policy.
        
        LaunchTemplateSpecification (dict) --
        
        The launch template to use. You must specify either the launch template ID or launch template name in the request.
        
        LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
        
        LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
        
        Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
        
        Overrides (list) --
        
        Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You must specify between 2 and 20 overrides.
        
        (dict) --
        
        Describes an override for a launch template.
        
        InstanceType (string) --
        
        The instance type.
        
        For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
      - InstancesDistribution (dict) --
        
        The instances distribution to use.
        
        If you leave this parameter unspecified when creating a mixed instances policy, the default values are used.
        
        OnDemandAllocationStrategy (string) --
        
        Indicates how to allocate instance types to fulfill On-Demand capacity.
        
        The only valid value is prioritized , which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.
        
        OnDemandBaseCapacity (integer) --
        
        The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
        
        The default value is 0 . If you leave this parameter set to 0 , On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.
        
        OnDemandPercentageAboveBaseCapacity (integer) --
        
        Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity . The range is 0–100.
        
        The default value is 100 . If you leave this parameter set to 100 , the percentages are 100% for On-Demand Instances and 0% for Spot Instances.
        
        SpotAllocationStrategy (string) --
        
        Indicates how to allocate instances across Spot Instance pools.
        
        If the allocation strategy is lowest-price , the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized , the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity.
        
        The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is lowest-price . The default Spot allocation strategy for the AWS Management Console is capacity-optimized .
        
        Valid values: lowest-price | capacity-optimized
        
        SpotInstancePools (integer) --
        
        The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate . The range is 1–20. The default value is 2 .
        
        Valid only when the Spot allocation strategy is lowest-price .
        
        SpotMaxPrice (string) --
        
        The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.
        
        To remove a value that you previously set, include the parameter but leave the value blank.
    - MinSize (integer) --
      
      The minimum size of the group.
    - MaxSize (integer) --
      
      The maximum size of the group.
    - DesiredCapacity (integer) --
      
      The desired size of the group.
    - DefaultCooldown (integer) --
      
      The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
    - AvailabilityZones (list) --
      
      One or more Availability Zones for the group.
      - (string) --
    - LoadBalancerNames (list) --
      
      One or more load balancers associated with the group.
      - (string) --
    - TargetGroupARNs (list) --
      
      The Amazon Resource Names (ARN) of the target groups for your load balancer.
      - (string) --
    - HealthCheckType (string) --
      
      The service to use for the health checks. The valid values are EC2 and ELB . If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
    - HealthCheckGracePeriod (integer) --
      
      The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
    - Instances (list) --
      
      The EC2 instances associated with the group.
      - (dict) --
        
        Describes an EC2 instance.
        
        InstanceId (string) --
        
        The ID of the instance.
        
        AvailabilityZone (string) --
        
        The Availability Zone in which the instance is running.
        
        LifecycleState (string) --
        
        A description of the current lifecycle state. The Quarantined state is not used.
        
        HealthStatus (string) --
        
        The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
        
        LaunchConfigurationName (string) --
        
        The launch configuration associated with the instance.
        
        LaunchTemplate (dict) --
        
        The launch template for the instance.
        
        LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
        
        LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
        
        Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
        
        ProtectedFromScaleIn (boolean) --
        
        Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
    - CreatedTime (datetime) --
      
      The date and time the group was created.
    - SuspendedProcesses (list) --
      
      The suspended processes associated with the group.
      - (dict) --
        
        Describes an automatic scaling process that has been suspended. For more information, see ProcessType .
        
        ProcessName (string) --
        
        The name of the suspended process.
        
        SuspensionReason (string) --
        
        The reason that the process was suspended.
    - PlacementGroup (string) --
      
      The name of the placement group into which to launch your instances, if any.
    - VPCZoneIdentifier (string) --
      
      One or more subnet IDs, if applicable, separated by commas.
    - EnabledMetrics (list) --
      
      The metrics enabled for the group.
      - (dict) --
        
        Describes an enabled metric.
        
        Metric (string) --
        
        One of the following metrics:
        
        GroupMinSize
        
        GroupMaxSize
        
        GroupDesiredCapacity
        
        GroupInServiceInstances
        
        GroupPendingInstances
        
        GroupStandbyInstances
        
        GroupTerminatingInstances
        
        GroupTotalInstances
        
        Granularity (string) --
        
        The granularity of the metric. The only valid value is 1Minute .
    - Status (string) --
      
      The current state of the group when DeleteAutoScalingGroup is in progress.
    - Tags (list) --
      
      The tags for the group.
      - (dict) --
        
        Describes a tag for an Auto Scaling group.
        
        ResourceId (string) --
        
        The name of the group.
        
        ResourceType (string) --
        
        The type of resource. The only supported value is auto-scaling-group .
        
        Key (string) --
        
        The tag key.
        
        Value (string) --
        
        The tag value.
        
        PropagateAtLaunch (boolean) --
        
        Determines whether the tag is added to new instances as they are launched in the group.
    - TerminationPolicies (list) --
      
      The termination policies for the group.
      - (string) --
    - NewInstancesProtectedFromScaleIn (boolean) --
      
      Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
    - ServiceLinkedRoleARN (string) --
      
      The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the specified Auto Scaling group.

response = client.describe_auto_scaling_groups(
    AutoScalingGroupNames=[
        'my-auto-scaling-group',
    ],
)

print(response)

Expected Output:

{
    'AutoScalingGroups': [
        {
            'AutoScalingGroupARN': 'arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group',
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'AvailabilityZones': [
                'us-west-2c',
            ],
            'CreatedTime': datetime(2013, 8, 19, 20, 53, 25, 0, 231, 0),
            'DefaultCooldown': 300,
            'DesiredCapacity': 1,
            'EnabledMetrics': [
            ],
            'HealthCheckGracePeriod': 300,
            'HealthCheckType': 'EC2',
            'Instances': [
                {
                    'AvailabilityZone': 'us-west-2c',
                    'HealthStatus': 'Healthy',
                    'InstanceId': 'i-4ba0837f',
                    'LaunchConfigurationName': 'my-launch-config',
                    'LifecycleState': 'InService',
                },
            ],
            'LaunchConfigurationName': 'my-launch-config',
            'LoadBalancerNames': [
            ],
            'MaxSize': 1,
            'MinSize': 0,
            'NewInstancesProtectedFromScaleIn': False,
            'SuspendedProcesses': [
            ],
            'Tags': [
            ],
            'TerminationPolicies': [
                'Default',
            ],
            'VPCZoneIdentifier': 'subnet-12345678',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_auto_scaling_instances(**kwargs)¶

Describes one or more Auto Scaling instances.

See also: AWS API Documentation

Request Syntax

response = client.describe_auto_scaling_instances(
    InstanceIds=[
        'string',
    ],
    MaxRecords=123,
    NextToken='string'
)

Parameters

InstanceIds (list) --
The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
- (string) --
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 50 and the maximum value is 50 .
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)

Return type

dict

Returns

Response Syntax

{
    'AutoScalingInstances': [
        {
            'InstanceId': 'string',
            'AutoScalingGroupName': 'string',
            'AvailabilityZone': 'string',
            'LifecycleState': 'string',
            'HealthStatus': 'string',
            'LaunchConfigurationName': 'string',
            'LaunchTemplate': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'ProtectedFromScaleIn': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- AutoScalingInstances (list) --
  
  The instances.
  - (dict) --
    
    Describes an EC2 instance associated with an Auto Scaling group.
    - InstanceId (string) --
      
      The ID of the instance.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group for the instance.
    - AvailabilityZone (string) --
      
      The Availability Zone for the instance.
    - LifecycleState (string) --
      
      The lifecycle state for the instance.
    - HealthStatus (string) --
      
      The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
    - LaunchConfigurationName (string) --
      
      The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
    - LaunchTemplate (dict) --
      
      The launch template for the instance.
      - LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
      - LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
      - Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
    - ProtectedFromScaleIn (boolean) --
      
      Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the specified Auto Scaling instance.

response = client.describe_auto_scaling_instances(
    InstanceIds=[
        'i-4ba0837f',
    ],
)

print(response)

Expected Output:

{
    'AutoScalingInstances': [
        {
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'AvailabilityZone': 'us-west-2c',
            'HealthStatus': 'HEALTHY',
            'InstanceId': 'i-4ba0837f',
            'LaunchConfigurationName': 'my-launch-config',
            'LifecycleState': 'InService',
            'ProtectedFromScaleIn': False,
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_auto_scaling_notification_types()¶

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

See also: AWS API Documentation

Request Syntax

response = client.describe_auto_scaling_notification_types()

Return type

dict

Returns

Response Syntax

{
    'AutoScalingNotificationTypes': [
        'string',
    ]
}

Response Structure

(dict) --
- AutoScalingNotificationTypes (list) --
  The notification types.
  - (string) --

Examples

This example describes the available notification types.

response = client.describe_auto_scaling_notification_types(
)

print(response)

Expected Output:

{
    'AutoScalingNotificationTypes': [
        'autoscaling:EC2_INSTANCE_LAUNCH',
        'autoscaling:EC2_INSTANCE_LAUNCH_ERROR',
        'autoscaling:EC2_INSTANCE_TERMINATE',
        'autoscaling:EC2_INSTANCE_TERMINATE_ERROR',
        'autoscaling:TEST_NOTIFICATION',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_launch_configurations(**kwargs)¶

Describes one or more launch configurations.

See also: AWS API Documentation

Request Syntax

response = client.describe_launch_configurations(
    LaunchConfigurationNames=[
        'string',
    ],
    NextToken='string',
    MaxRecords=123
)

Parameters

LaunchConfigurationNames (list) --
The launch configuration names. If you omit this parameter, all launch configurations are described.
- (string) --
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 50 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'LaunchConfigurations': [
        {
            'LaunchConfigurationName': 'string',
            'LaunchConfigurationARN': 'string',
            'ImageId': 'string',
            'KeyName': 'string',
            'SecurityGroups': [
                'string',
            ],
            'ClassicLinkVPCId': 'string',
            'ClassicLinkVPCSecurityGroups': [
                'string',
            ],
            'UserData': 'string',
            'InstanceType': 'string',
            'KernelId': 'string',
            'RamdiskId': 'string',
            'BlockDeviceMappings': [
                {
                    'VirtualName': 'string',
                    'DeviceName': 'string',
                    'Ebs': {
                        'SnapshotId': 'string',
                        'VolumeSize': 123,
                        'VolumeType': 'string',
                        'DeleteOnTermination': True|False,
                        'Iops': 123,
                        'Encrypted': True|False
                    },
                    'NoDevice': True|False
                },
            ],
            'InstanceMonitoring': {
                'Enabled': True|False
            },
            'SpotPrice': 'string',
            'IamInstanceProfile': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'EbsOptimized': True|False,
            'AssociatePublicIpAddress': True|False,
            'PlacementTenancy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LaunchConfigurations (list) --
  
  The launch configurations.
  - (dict) --
    
    Describes a launch configuration.
    - LaunchConfigurationName (string) --
      
      The name of the launch configuration.
    - LaunchConfigurationARN (string) --
      
      The Amazon Resource Name (ARN) of the launch configuration.
    - ImageId (string) --
      
      The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
      
      For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances .
    - KeyName (string) --
      
      The name of the key pair.
      
      For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances .
    - SecurityGroups (list) --
      
      A list that contains the security groups to assign to the instances in the Auto Scaling group.
      
      For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
      - (string) --
    - ClassicLinkVPCId (string) --
      
      The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
      
      For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .
    - ClassicLinkVPCSecurityGroups (list) --
      
      The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId .
      
      For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .
      - (string) --
    - UserData (string) --
      
      The Base64-encoded user data to make available to the launched EC2 instances.
      
      For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances .
    - InstanceType (string) --
      
      The instance type for the instances.
      
      For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
    - KernelId (string) --
      
      The ID of the kernel associated with the AMI.
    - RamdiskId (string) --
      
      The ID of the RAM disk associated with the AMI.
    - BlockDeviceMappings (list) --
      
      A block device mapping, which specifies the block devices for the instance.
      
      For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances .
      - (dict) --
        
        Describes a block device mapping.
        
        VirtualName (string) --
        
        The name of the virtual device (for example, ephemeral0 ).
        
        DeviceName (string) --
        
        The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh ). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances .
        
        Ebs (dict) --
        
        The information about the Amazon EBS volume.
        
        SnapshotId (string) --
        
        The snapshot ID of the volume to use.
        
        Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize , VolumeSize must be equal or greater than the size of the snapshot.
        
        VolumeSize (integer) --
        
        The volume size, in Gibibytes (GiB).
        
        This can be a number from 1-1,024 for standard , 4-16,384 for io1 , 1-16,384 for gp2 , and 500-16,384 for st1 and sc1 . If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.
        
        Note
        
        At least one of VolumeSize or SnapshotId is required.
        
        VolumeType (string) --
        
        The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .
        
        Valid values: standard | io1 | gp2 | st1 | sc1
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true .
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .
        
        Conditional: This parameter is required when the volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)
        
        Encrypted (boolean) --
        
        Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
        
        Note
        
        If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.
        
        Enabling encryption by default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.
        
        For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK Key Policy for Use with Encrypted Volumes in the Amazon EC2 Auto Scaling User Guide .
        
        NoDevice (boolean) --
        
        Suppresses a device mapping.
        
        If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.
    - InstanceMonitoring (dict) --
      
      Controls whether instances in this group are launched with detailed (true ) or basic (false ) monitoring.
      
      For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide .
      - Enabled (boolean) --
        
        If true , detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
    - SpotPrice (string) --
      
      The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price.
      
      For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .
    - IamInstanceProfile (string) --
      
      The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
      
      For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide .
    - CreatedTime (datetime) --
      
      The creation date and time for the launch configuration.
    - EbsOptimized (boolean) --
      
      Specifies whether the launch configuration is optimized for EBS I/O (true ) or not (false ).
      
      For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances .
    - AssociatePublicIpAddress (boolean) --
      
      For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances.
      
      For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide .
    - PlacementTenancy (string) --
      
      The tenancy of the instance, either default or dedicated . An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
      
      For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide .
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the specified launch configuration.

response = client.describe_launch_configurations(
    LaunchConfigurationNames=[
        'my-launch-config',
    ],
)

print(response)

Expected Output:

{
    'LaunchConfigurations': [
        {
            'AssociatePublicIpAddress': True,
            'BlockDeviceMappings': [
            ],
            'CreatedTime': datetime(2014, 5, 7, 17, 39, 28, 2, 127, 0),
            'EbsOptimized': False,
            'ImageId': 'ami-043a5034',
            'InstanceMonitoring': {
                'Enabled': True,
            },
            'InstanceType': 't1.micro',
            'LaunchConfigurationARN': 'arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config',
            'LaunchConfigurationName': 'my-launch-config',
            'SecurityGroups': [
                'sg-67ef0308',
            ],
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_lifecycle_hook_types()¶

Describes the available types of lifecycle hooks.

The following hook types are supported:

autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING

See also: AWS API Documentation

Request Syntax

response = client.describe_lifecycle_hook_types()

Return type

dict

Returns

Response Syntax

{
    'LifecycleHookTypes': [
        'string',
    ]
}

Response Structure

(dict) --
- LifecycleHookTypes (list) --
  The lifecycle hook types.
  - (string) --

Examples

This example describes the available lifecycle hook types.

response = client.describe_lifecycle_hook_types(
)

print(response)

Expected Output:

{
    'LifecycleHookTypes': [
        'autoscaling:EC2_INSTANCE_LAUNCHING',
        'autoscaling:EC2_INSTANCE_TERMINATING',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_lifecycle_hooks(**kwargs)¶

Describes the lifecycle hooks for the specified Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.describe_lifecycle_hooks(
    AutoScalingGroupName='string',
    LifecycleHookNames=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
LifecycleHookNames (list) --
The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'LifecycleHooks': [
        {
            'LifecycleHookName': 'string',
            'AutoScalingGroupName': 'string',
            'LifecycleTransition': 'string',
            'NotificationTargetARN': 'string',
            'RoleARN': 'string',
            'NotificationMetadata': 'string',
            'HeartbeatTimeout': 123,
            'GlobalTimeout': 123,
            'DefaultResult': 'string'
        },
    ]
}

Response Structure

(dict) --
- LifecycleHooks (list) --
  
  The lifecycle hooks for the specified group.
  - (dict) --
    
    Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances. Used in response to DescribeLifecycleHooks .
    - LifecycleHookName (string) --
      
      The name of the lifecycle hook.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group for the lifecycle hook.
    - LifecycleTransition (string) --
      
      The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:
      - autoscaling:EC2_INSTANCE_LAUNCHING
      - autoscaling:EC2_INSTANCE_TERMINATING
    - NotificationTargetARN (string) --
      
      The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
    - RoleARN (string) --
      
      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
    - NotificationMetadata (string) --
      
      Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
    - HeartbeatTimeout (integer) --
      
      The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.
    - GlobalTimeout (integer) --
      
      The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout , whichever is smaller.
    - DefaultResult (string) --
      
      Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON .

Examples

This example describes the lifecycle hooks for the specified Auto Scaling group.

response = client.describe_lifecycle_hooks(
    AutoScalingGroupName='my-auto-scaling-group',
)

print(response)

Expected Output:

{
    'LifecycleHooks': [
        {
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'DefaultResult': 'ABANDON',
            'GlobalTimeout': 172800,
            'HeartbeatTimeout': 3600,
            'LifecycleHookName': 'my-lifecycle-hook',
            'LifecycleTransition': 'autoscaling:EC2_INSTANCE_LAUNCHING',
            'NotificationTargetARN': 'arn:aws:sns:us-west-2:123456789012:my-sns-topic',
            'RoleARN': 'arn:aws:iam::123456789012:role/my-auto-scaling-role',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_load_balancer_target_groups(**kwargs)¶

Describes the target groups for the specified Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.describe_load_balancer_target_groups(
    AutoScalingGroupName='string',
    NextToken='string',
    MaxRecords=123
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 100 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'LoadBalancerTargetGroups': [
        {
            'LoadBalancerTargetGroupARN': 'string',
            'State': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LoadBalancerTargetGroups (list) --
  
  Information about the target groups.
  - (dict) --
    
    Describes the state of a target group.
    
    If you attach a target group to an existing Auto Scaling group, the initial state 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, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.
    - LoadBalancerTargetGroupARN (string) --
      
      The Amazon Resource Name (ARN) of the target group.
    - State (string) --
      
      The state of the target group.
      - Adding - The Auto Scaling instances are being registered with the target group.
      - Added - All Auto Scaling instances are registered with the target group.
      - InService - At least one Auto Scaling instance passed an ELB health check.
      - Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
      - Removed - All Auto Scaling instances are deregistered from the target group.
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the target groups attached to the specified Auto Scaling group.

response = client.describe_load_balancer_target_groups(
    AutoScalingGroupName='my-auto-scaling-group',
)

print(response)

Expected Output:

{
    'LoadBalancerTargetGroups': [
        {
            'LoadBalancerTargetGroupARN': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
            'State': 'Added',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_load_balancers(**kwargs)¶

Describes the load balancers for the specified Auto Scaling group.

This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.

See also: AWS API Documentation

Request Syntax

response = client.describe_load_balancers(
    AutoScalingGroupName='string',
    NextToken='string',
    MaxRecords=123
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 100 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'LoadBalancers': [
        {
            'LoadBalancerName': 'string',
            'State': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LoadBalancers (list) --
  
  The load balancers.
  - (dict) --
    
    Describes the state of a Classic Load Balancer.
    
    If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService .
    
    If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding . The state transitions to Added after all instances in the group are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.
    - LoadBalancerName (string) --
      
      The name of the load balancer.
    - State (string) --
      
      One of the following load balancer states:
      - Adding - The instances in the group are being registered with the load balancer.
      - Added - All instances in the group are registered with the load balancer.
      - InService - At least one instance in the group passed an ELB health check.
      - Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
      - Removed - All instances in the group are deregistered from the load balancer.
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the load balancers attached to the specified Auto Scaling group.

response = client.describe_load_balancers(
    AutoScalingGroupName='my-auto-scaling-group',
)

print(response)

Expected Output:

{
    'LoadBalancers': [
        {
            'LoadBalancerName': 'my-load-balancer',
            'State': 'Added',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_metric_collection_types()¶

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

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

See also: AWS API Documentation

Request Syntax

response = client.describe_metric_collection_types()

Return type

dict

Returns

Response Syntax

{
    'Metrics': [
        {
            'Metric': 'string'
        },
    ],
    'Granularities': [
        {
            'Granularity': 'string'
        },
    ]
}

Response Structure

(dict) --
- Metrics (list) --
  One or more metrics.
  - (dict) --
    Describes a metric.
    - Metric (string) --
      One of the following metrics:
      - GroupMinSize
      - GroupMaxSize
      - GroupDesiredCapacity
      - GroupInServiceInstances
      - GroupPendingInstances
      - GroupStandbyInstances
      - GroupTerminatingInstances
      - GroupTotalInstances
- Granularities (list) --
  The granularities for the metrics.
  - (dict) --
    Describes a granularity of a metric.
    - Granularity (string) --
      The granularity. The only valid value is 1Minute .

Examples

This example describes the available metric collection types.

response = client.describe_metric_collection_types(
)

print(response)

Expected Output:

{
    'Granularities': [
        {
            'Granularity': '1Minute',
        },
    ],
    'Metrics': [
        {
            'Metric': 'GroupMinSize',
        },
        {
            'Metric': 'GroupMaxSize',
        },
        {
            'Metric': 'GroupDesiredCapacity',
        },
        {
            'Metric': 'GroupInServiceInstances',
        },
        {
            'Metric': 'GroupPendingInstances',
        },
        {
            'Metric': 'GroupTerminatingInstances',
        },
        {
            'Metric': 'GroupStandbyInstances',
        },
        {
            'Metric': 'GroupTotalInstances',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_notification_configurations(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.describe_notification_configurations(
    AutoScalingGroupNames=[
        'string',
    ],
    NextToken='string',
    MaxRecords=123
)

Parameters

AutoScalingGroupNames (list) --
The name of the Auto Scaling group.
- (string) --
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 50 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'NotificationConfigurations': [
        {
            'AutoScalingGroupName': 'string',
            'TopicARN': 'string',
            'NotificationType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NotificationConfigurations (list) --
  
  The notification configurations.
  - (dict) --
    
    Describes a notification.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - TopicARN (string) --
      
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
    - NotificationType (string) --
      
      One of the following event notification types:
      - autoscaling:EC2_INSTANCE_LAUNCH
      - autoscaling:EC2_INSTANCE_LAUNCH_ERROR
      - autoscaling:EC2_INSTANCE_TERMINATE
      - autoscaling:EC2_INSTANCE_TERMINATE_ERROR
      - autoscaling:TEST_NOTIFICATION
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the notification configurations for the specified Auto Scaling group.

response = client.describe_notification_configurations(
    AutoScalingGroupNames=[
        'my-auto-scaling-group',
    ],
)

print(response)

Expected Output:

{
    'NotificationConfigurations': [
        {
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'NotificationType': 'autoscaling:TEST_NOTIFICATION',
            'TopicARN': 'arn:aws:sns:us-west-2:123456789012:my-sns-topic-2',
        },
        {
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'NotificationType': 'autoscaling:TEST_NOTIFICATION',
            'TopicARN': 'arn:aws:sns:us-west-2:123456789012:my-sns-topic',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_policies(**kwargs)¶

Describes the policies for the specified Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.describe_policies(
    AutoScalingGroupName='string',
    PolicyNames=[
        'string',
    ],
    PolicyTypes=[
        'string',
    ],
    NextToken='string',
    MaxRecords=123
)

Parameters

AutoScalingGroupName (string) -- The name of the Auto Scaling group.
PolicyNames (list) --
The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
- (string) --
PolicyTypes (list) --
One or more policy types. The valid values are SimpleScaling , StepScaling , and TargetTrackingScaling .
- (string) --
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'ScalingPolicies': [
        {
            'AutoScalingGroupName': 'string',
            'PolicyName': 'string',
            'PolicyARN': 'string',
            'PolicyType': 'string',
            'AdjustmentType': 'string',
            'MinAdjustmentStep': 123,
            'MinAdjustmentMagnitude': 123,
            'ScalingAdjustment': 123,
            'Cooldown': 123,
            'StepAdjustments': [
                {
                    'MetricIntervalLowerBound': 123.0,
                    'MetricIntervalUpperBound': 123.0,
                    'ScalingAdjustment': 123
                },
            ],
            'MetricAggregationType': 'string',
            'EstimatedInstanceWarmup': 123,
            'Alarms': [
                {
                    'AlarmName': 'string',
                    'AlarmARN': 'string'
                },
            ],
            'TargetTrackingConfiguration': {
                'PredefinedMetricSpecification': {
                    'PredefinedMetricType': 'ASGAverageCPUUtilization'|'ASGAverageNetworkIn'|'ASGAverageNetworkOut'|'ALBRequestCountPerTarget',
                    'ResourceLabel': 'string'
                },
                'CustomizedMetricSpecification': {
                    'MetricName': 'string',
                    'Namespace': 'string',
                    'Dimensions': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
                    'Unit': 'string'
                },
                'TargetValue': 123.0,
                'DisableScaleIn': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ScalingPolicies (list) --
  
  The scaling policies.
  - (dict) --
    
    Describes a scaling policy.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - PolicyName (string) --
      
      The name of the scaling policy.
    - PolicyARN (string) --
      
      The Amazon Resource Name (ARN) of the policy.
    - PolicyType (string) --
      
      The policy type. The valid values are SimpleScaling , StepScaling , and TargetTrackingScaling .
    - AdjustmentType (string) --
      
      The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .
    - MinAdjustmentStep (integer) --
      
      Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    - MinAdjustmentMagnitude (integer) --
      
      The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity , the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError .
    - ScalingAdjustment (integer) --
      
      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
    - Cooldown (integer) --
      
      The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
    - StepAdjustments (list) --
      
      A set of adjustments that enable you to scale based on the size of the alarm breach.
      - (dict) --
        
        Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. Used in combination with PutScalingPolicy .
        
        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.
        
        MetricIntervalLowerBound (float) --
        
        The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
        
        MetricIntervalUpperBound (float) --
        
        The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
        
        The upper bound must be greater than the lower bound.
        
        ScalingAdjustment (integer) --
        
        The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
    - MetricAggregationType (string) --
      
      The aggregation type for the CloudWatch metrics. The valid values are Minimum , Maximum , and Average .
    - EstimatedInstanceWarmup (integer) --
      
      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
    - Alarms (list) --
      
      The CloudWatch alarms related to the policy.
      - (dict) --
        
        Describes an alarm.
        
        AlarmName (string) --
        
        The name of the alarm.
        
        AlarmARN (string) --
        
        The Amazon Resource Name (ARN) of the alarm.
    - TargetTrackingConfiguration (dict) --
      
      A target tracking scaling policy.
      - PredefinedMetricSpecification (dict) --
        
        A predefined metric. You must specify either a predefined metric or a customized metric.
        
        PredefinedMetricType (string) --
        
        The metric type.
        
        ResourceLabel (string) --
        
        Identifies the resource associated with the metric type. The following predefined metrics are available:
        
        ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
        
        ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
        
        ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
        
        ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.
        
        For predefined metric types ASGAverageCPUUtilization , ASGAverageNetworkIn , and ASGAverageNetworkOut , the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget , the parameter must be specified in the format: ``app/load-balancer-name /load-balancer-id /targetgroup/target-group-name /target-group-id `` , where ``app/load-balancer-name /load-balancer-id `` is the final portion of the load balancer ARN, and ``targetgroup/target-group-name /target-group-id `` is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
      - CustomizedMetricSpecification (dict) --
        
        A customized metric. You must specify either a predefined metric or a customized metric.
        
        MetricName (string) --
        
        The name of the metric.
        
        Namespace (string) --
        
        The namespace of the metric.
        
        Dimensions (list) --
        
        The dimensions of the metric.
        
        Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
        
        (dict) --
        
        Describes the dimension of a metric.
        
        Name (string) --
        
        The name of the dimension.
        
        Value (string) --
        
        The value of the dimension.
        
        Statistic (string) --
        
        The statistic of the metric.
        
        Unit (string) --
        
        The unit of the metric.
      - TargetValue (float) --
        
        The target value for the metric.
      - DisableScaleIn (boolean) --
        
        Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false .
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the policies for the specified Auto Scaling group.

response = client.describe_policies(
    AutoScalingGroupName='my-auto-scaling-group',
)

print(response)

Expected Output:

{
    'ScalingPolicies': [
        {
            'AdjustmentType': 'ChangeInCapacity',
            'Alarms': [
            ],
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'PolicyARN': 'arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn',
            'PolicyName': 'ScaleIn',
            'ScalingAdjustment': -1,
        },
        {
            'AdjustmentType': 'PercentChangeInCapacity',
            'Alarms': [
            ],
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'Cooldown': 60,
            'MinAdjustmentStep': 2,
            'PolicyARN': 'arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange',
            'PolicyName': 'ScalePercentChange',
            'ScalingAdjustment': 25,
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_scaling_activities(**kwargs)¶

Describes one or more scaling activities for the specified Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.describe_scaling_activities(
    ActivityIds=[
        'string',
    ],
    AutoScalingGroupName='string',
    MaxRecords=123,
    NextToken='string'
)

Parameters

ActivityIds (list) --
The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
- (string) --
AutoScalingGroupName (string) -- The name of the Auto Scaling group.
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 100 and the maximum value is 100 .
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)

Return type

dict

Returns

Response Syntax

{
    'Activities': [
        {
            'ActivityId': 'string',
            'AutoScalingGroupName': 'string',
            'Description': 'string',
            'Cause': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusCode': 'PendingSpotBidPlacement'|'WaitingForSpotInstanceRequestId'|'WaitingForSpotInstanceId'|'WaitingForInstanceId'|'PreInService'|'InProgress'|'WaitingForELBConnectionDraining'|'MidLifecycleAction'|'WaitingForInstanceWarmup'|'Successful'|'Failed'|'Cancelled',
            'StatusMessage': 'string',
            'Progress': 123,
            'Details': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Activities (list) --
  
  The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
  - (dict) --
    
    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.
    - ActivityId (string) --
      
      The ID of the activity.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - Description (string) --
      
      A friendly, more verbose description of the activity.
    - Cause (string) --
      
      The reason the activity began.
    - StartTime (datetime) --
      
      The start time of the activity.
    - EndTime (datetime) --
      
      The end time of the activity.
    - StatusCode (string) --
      
      The current status of the activity.
    - StatusMessage (string) --
      
      A friendly, more verbose description of the activity status.
    - Progress (integer) --
      
      A value between 0 and 100 that indicates the progress of the activity.
    - Details (string) --
      
      The details about the activity.
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the scaling activities for the specified Auto Scaling group.

response = client.describe_scaling_activities(
    AutoScalingGroupName='my-auto-scaling-group',
)

print(response)

Expected Output:

{
    'Activities': [
        {
            'ActivityId': 'f9f2d65b-f1f2-43e7-b46d-d86756459699',
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'Cause': 'At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1.  At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.',
            'Description': 'Launching a new EC2 instance: i-4ba0837f',
            'Details': 'details',
            'EndTime': datetime(2013, 8, 19, 20, 54, 2, 0, 231, 0),
            'Progress': 100,
            'StartTime': datetime(2013, 8, 19, 20, 53, 29, 0, 231, 0),
            'StatusCode': 'Successful',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_scaling_process_types()¶

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

See also: AWS API Documentation

Request Syntax

response = client.describe_scaling_process_types()

Return type

dict

Returns

Response Syntax

{
    'Processes': [
        {
            'ProcessName': 'string'
        },
    ]
}

Response Structure

(dict) --
- Processes (list) --
  The names of the process types.
  - (dict) --
    Describes a process type.
    
    For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide .
    - ProcessName (string) --
      One of the following processes:
      - Launch
      - Terminate
      - AddToLoadBalancer
      - AlarmNotification
      - AZRebalance
      - HealthCheck
      - ReplaceUnhealthy
      - ScheduledActions

Examples

This example describes the Auto Scaling process types.

response = client.describe_scaling_process_types(
)

print(response)

Expected Output:

{
    'Processes': [
        {
            'ProcessName': 'AZRebalance',
        },
        {
            'ProcessName': 'AddToLoadBalancer',
        },
        {
            'ProcessName': 'AlarmNotification',
        },
        {
            'ProcessName': 'HealthCheck',
        },
        {
            'ProcessName': 'Launch',
        },
        {
            'ProcessName': 'ReplaceUnhealthy',
        },
        {
            'ProcessName': 'ScheduledActions',
        },
        {
            'ProcessName': 'Terminate',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_scheduled_actions(**kwargs)¶

Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, use DescribeScalingActivities .

See also: AWS API Documentation

Request Syntax

response = client.describe_scheduled_actions(
    AutoScalingGroupName='string',
    ScheduledActionNames=[
        'string',
    ],
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    NextToken='string',
    MaxRecords=123
)

Parameters

AutoScalingGroupName (string) -- The name of the Auto Scaling group.
ScheduledActionNames (list) --
The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
- (string) --
StartTime (datetime) -- The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
EndTime (datetime) -- The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 50 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'ScheduledUpdateGroupActions': [
        {
            'AutoScalingGroupName': 'string',
            'ScheduledActionName': 'string',
            'ScheduledActionARN': 'string',
            'Time': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Recurrence': 'string',
            'MinSize': 123,
            'MaxSize': 123,
            'DesiredCapacity': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ScheduledUpdateGroupActions (list) --
  
  The scheduled actions.
  - (dict) --
    
    Describes a scheduled scaling action. Used in response to DescribeScheduledActions .
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - ScheduledActionName (string) --
      
      The name of the scheduled action.
    - ScheduledActionARN (string) --
      
      The Amazon Resource Name (ARN) of the scheduled action.
    - Time (datetime) --
      
      This parameter is no longer used.
    - StartTime (datetime) --
      
      The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z" .
    - EndTime (datetime) --
      
      The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z" .
    - Recurrence (string) --
      
      The recurring schedule for the action, in Unix cron syntax format.
      
      When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    - MinSize (integer) --
      
      The minimum number of instances in the Auto Scaling group.
    - MaxSize (integer) --
      
      The maximum number of instances in the Auto Scaling group.
    - DesiredCapacity (integer) --
      
      The number of instances you prefer to maintain in the group.
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the scheduled actions for the specified Auto Scaling group.

response = client.describe_scheduled_actions(
    AutoScalingGroupName='my-auto-scaling-group',
)

print(response)

Expected Output:

{
    'ScheduledUpdateGroupActions': [
        {
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'DesiredCapacity': 4,
            'MaxSize': 6,
            'MinSize': 2,
            'Recurrence': '30 0 1 12 0',
            'ScheduledActionARN': 'arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action',
            'ScheduledActionName': 'my-scheduled-action',
            'StartTime': datetime(2016, 12, 1, 0, 30, 0, 3, 336, 0),
            'Time': datetime(2016, 12, 1, 0, 30, 0, 3, 336, 0),
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_tags(**kwargs)¶

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_tags(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxRecords=123
)

Parameters

Filters (list) --
One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group ) is 1000.
- (dict) --
  Describes a filter.
  - Name (string) --
    The name of the filter. The valid values are: "auto-scaling-group" , "key" , "value" , and "propagate-at-launch" .
  - Values (list) --
    The value of the filter.
    - (string) --
NextToken (string) -- The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords (integer) -- The maximum number of items to return with this call. The default value is 50 and the maximum value is 100 .

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'ResourceId': 'string',
            'ResourceType': 'string',
            'Key': 'string',
            'Value': 'string',
            'PropagateAtLaunch': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Tags (list) --
  
  One or more tags.
  - (dict) --
    
    Describes a tag for an Auto Scaling group.
    - ResourceId (string) --
      
      The name of the group.
    - ResourceType (string) --
      
      The type of resource. The only supported value is auto-scaling-group .
    - Key (string) --
      
      The tag key.
    - Value (string) --
      
      The tag value.
    - PropagateAtLaunch (boolean) --
      
      Determines whether the tag is added to new instances as they are launched in the group.
- NextToken (string) --
  
  A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Examples

This example describes the tags for the specified Auto Scaling group.

response = client.describe_tags(
    Filters=[
        {
            'Name': 'auto-scaling-group',
            'Values': [
                'my-auto-scaling-group',
            ],
        },
    ],
)

print(response)

Expected Output:

{
    'Tags': [
        {
            'Key': 'Dept',
            'PropagateAtLaunch': True,
            'ResourceId': 'my-auto-scaling-group',
            'ResourceType': 'auto-scaling-group',
            'Value': 'Research',
        },
        {
            'Key': 'Role',
            'PropagateAtLaunch': True,
            'ResourceId': 'my-auto-scaling-group',
            'ResourceType': 'auto-scaling-group',
            'Value': 'WebServer',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

describe_termination_policy_types()¶

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_termination_policy_types()

Return type

dict

Returns

Response Syntax

{
    'TerminationPolicyTypes': [
        'string',
    ]
}

Response Structure

(dict) --
- TerminationPolicyTypes (list) --
  The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance , OldestLaunchConfiguration , NewestInstance , ClosestToNextInstanceHour , Default , OldestLaunchTemplate , and AllocationStrategy .
  - (string) --

Examples

This example describes the available termination policy types.

response = client.describe_termination_policy_types(
)

print(response)

Expected Output:

{
    'TerminationPolicyTypes': [
        'ClosestToNextInstanceHour',
        'Default',
        'NewestInstance',
        'OldestInstance',
        'OldestLaunchConfiguration',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

detach_instances(**kwargs)¶

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 EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.detach_instances(
    InstanceIds=[
        'string',
    ],
    AutoScalingGroupName='string',
    ShouldDecrementDesiredCapacity=True|False
)

Parameters

InstanceIds (list) --
The IDs of the instances. You can specify up to 20 instances.
- (string) --
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ShouldDecrementDesiredCapacity (boolean) --
[REQUIRED]

Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Return type

dict

Returns

Response Syntax

{
    'Activities': [
        {
            'ActivityId': 'string',
            'AutoScalingGroupName': 'string',
            'Description': 'string',
            'Cause': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusCode': 'PendingSpotBidPlacement'|'WaitingForSpotInstanceRequestId'|'WaitingForSpotInstanceId'|'WaitingForInstanceId'|'PreInService'|'InProgress'|'WaitingForELBConnectionDraining'|'MidLifecycleAction'|'WaitingForInstanceWarmup'|'Successful'|'Failed'|'Cancelled',
            'StatusMessage': 'string',
            'Progress': 123,
            'Details': 'string'
        },
    ]
}

Response Structure

(dict) --
- Activities (list) --
  
  The activities related to detaching the instances from the Auto Scaling group.
  - (dict) --
    
    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.
    - ActivityId (string) --
      
      The ID of the activity.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - Description (string) --
      
      A friendly, more verbose description of the activity.
    - Cause (string) --
      
      The reason the activity began.
    - StartTime (datetime) --
      
      The start time of the activity.
    - EndTime (datetime) --
      
      The end time of the activity.
    - StatusCode (string) --
      
      The current status of the activity.
    - StatusMessage (string) --
      
      A friendly, more verbose description of the activity status.
    - Progress (integer) --
      
      A value between 0 and 100 that indicates the progress of the activity.
    - Details (string) --
      
      The details about the activity.

Examples

This example detaches the specified instance from the specified Auto Scaling group.

response = client.detach_instances(
    AutoScalingGroupName='my-auto-scaling-group',
    InstanceIds=[
        'i-93633f9b',
    ],
    ShouldDecrementDesiredCapacity=True,
)

print(response)

Expected Output:

{
    'Activities': [
        {
            'ActivityId': '5091cb52-547a-47ce-a236-c9ccbc2cb2c9',
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'Cause': 'At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.',
            'Description': 'Detaching EC2 instance: i-93633f9b',
            'Details': 'details',
            'Progress': 50,
            'StartTime': datetime(2015, 4, 12, 15, 2, 16, 6, 102, 0),
            'StatusCode': 'InProgress',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

detach_load_balancer_target_groups(**kwargs)¶

Detaches one or more target groups from the specified Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.detach_load_balancer_target_groups(
    AutoScalingGroupName='string',
    TargetGroupARNs=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
TargetGroupARNs (list) --
[REQUIRED]

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example detaches the specified target group from the specified Auto Scaling group

response = client.detach_load_balancer_target_groups(
    AutoScalingGroupName='my-auto-scaling-group',
    TargetGroupARNs=[
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

detach_load_balancers(**kwargs)¶

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 or Network Load Balancers, use DetachLoadBalancerTargetGroups 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 DescribeLoadBalancers . The instances remain running.

See also: AWS API Documentation

Request Syntax

response = client.detach_load_balancers(
    AutoScalingGroupName='string',
    LoadBalancerNames=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
LoadBalancerNames (list) --
[REQUIRED]

The names of the load balancers. You can specify up to 10 load balancers.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example detaches the specified load balancer from the specified Auto Scaling group.

response = client.detach_load_balancers(
    AutoScalingGroupName='my-auto-scaling-group',
    LoadBalancerNames=[
        'my-load-balancer',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

disable_metrics_collection(**kwargs)¶

Disables group metrics for the specified Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.disable_metrics_collection(
    AutoScalingGroupName='string',
    Metrics=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
Metrics (list) --
One or more of the following metrics. If you omit this parameter, all metrics are disabled.
- GroupMinSize
- GroupMaxSize
- GroupDesiredCapacity
- GroupInServiceInstances
- GroupPendingInstances
- GroupStandbyInstances
- GroupTerminatingInstances
- GroupTotalInstances
- (string) --

Returns

None

Examples

This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.

response = client.disable_metrics_collection(
    AutoScalingGroupName='my-auto-scaling-group',
    Metrics=[
        'GroupDesiredCapacity',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

enable_metrics_collection(**kwargs)¶

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.enable_metrics_collection(
    AutoScalingGroupName='string',
    Metrics=[
        'string',
    ],
    Granularity='string'
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
Metrics (list) --
One or more of the following metrics. If you omit this parameter, all metrics are enabled.
- GroupMinSize
- GroupMaxSize
- GroupDesiredCapacity
- GroupInServiceInstances
- GroupPendingInstances
- GroupStandbyInstances
- GroupTerminatingInstances
- GroupTotalInstances
- (string) --
Granularity (string) --
[REQUIRED]

The granularity to associate with the metrics to collect. The only valid value is 1Minute .

Returns

None

Examples

This example enables data collection for the specified Auto Scaling group.

response = client.enable_metrics_collection(
    AutoScalingGroupName='my-auto-scaling-group',
    Granularity='1Minute',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

enter_standby(**kwargs)¶

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.enter_standby(
    InstanceIds=[
        'string',
    ],
    AutoScalingGroupName='string',
    ShouldDecrementDesiredCapacity=True|False
)

Parameters

InstanceIds (list) --
The IDs of the instances. You can specify up to 20 instances.
- (string) --
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ShouldDecrementDesiredCapacity (boolean) --
[REQUIRED]

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

Return type

dict

Returns

Response Syntax

{
    'Activities': [
        {
            'ActivityId': 'string',
            'AutoScalingGroupName': 'string',
            'Description': 'string',
            'Cause': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusCode': 'PendingSpotBidPlacement'|'WaitingForSpotInstanceRequestId'|'WaitingForSpotInstanceId'|'WaitingForInstanceId'|'PreInService'|'InProgress'|'WaitingForELBConnectionDraining'|'MidLifecycleAction'|'WaitingForInstanceWarmup'|'Successful'|'Failed'|'Cancelled',
            'StatusMessage': 'string',
            'Progress': 123,
            'Details': 'string'
        },
    ]
}

Response Structure

(dict) --
- Activities (list) --
  
  The activities related to moving instances into Standby mode.
  - (dict) --
    
    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.
    - ActivityId (string) --
      
      The ID of the activity.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - Description (string) --
      
      A friendly, more verbose description of the activity.
    - Cause (string) --
      
      The reason the activity began.
    - StartTime (datetime) --
      
      The start time of the activity.
    - EndTime (datetime) --
      
      The end time of the activity.
    - StatusCode (string) --
      
      The current status of the activity.
    - StatusMessage (string) --
      
      A friendly, more verbose description of the activity status.
    - Progress (integer) --
      
      A value between 0 and 100 that indicates the progress of the activity.
    - Details (string) --
      
      The details about the activity.

Examples

This example puts the specified instance into standby mode.

response = client.enter_standby(
    AutoScalingGroupName='my-auto-scaling-group',
    InstanceIds=[
        'i-93633f9b',
    ],
    ShouldDecrementDesiredCapacity=True,
)

print(response)

Expected Output:

{
    'Activities': [
        {
            'ActivityId': 'ffa056b4-6ed3-41ba-ae7c-249dfae6eba1',
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'Cause': 'At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.',
            'Description': 'Moving EC2 instance to Standby: i-93633f9b',
            'Details': 'details',
            'Progress': 50,
            'StartTime': datetime(2015, 4, 12, 15, 10, 23, 6, 102, 0),
            'StatusCode': 'InProgress',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

execute_policy(**kwargs)¶

Executes the specified policy.

See also: AWS API Documentation

Request Syntax

response = client.execute_policy(
    AutoScalingGroupName='string',
    PolicyName='string',
    HonorCooldown=True|False,
    MetricValue=123.0,
    BreachThreshold=123.0
)

Parameters

AutoScalingGroupName (string) -- The name of the Auto Scaling group.
PolicyName (string) --
[REQUIRED]

The name or ARN of the policy.
HonorCooldown (boolean) --
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling or TargetTrackingScaling .

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide .
MetricValue (float) --
The metric value to compare to BreachThreshold . This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
BreachThreshold (float) --
The breach threshold for the alarm.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

Returns

None

Examples

This example executes the specified Auto Scaling policy for the specified Auto Scaling group.

response = client.execute_policy(
    AutoScalingGroupName='my-auto-scaling-group',
    HonorCooldown=True,
    PolicyName='ScaleIn',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

exit_standby(**kwargs)¶

Moves the specified instances out of the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.exit_standby(
    InstanceIds=[
        'string',
    ],
    AutoScalingGroupName='string'
)

Parameters

InstanceIds (list) --
The IDs of the instances. You can specify up to 20 instances.
- (string) --
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.

Return type

dict

Returns

Response Syntax

{
    'Activities': [
        {
            'ActivityId': 'string',
            'AutoScalingGroupName': 'string',
            'Description': 'string',
            'Cause': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusCode': 'PendingSpotBidPlacement'|'WaitingForSpotInstanceRequestId'|'WaitingForSpotInstanceId'|'WaitingForInstanceId'|'PreInService'|'InProgress'|'WaitingForELBConnectionDraining'|'MidLifecycleAction'|'WaitingForInstanceWarmup'|'Successful'|'Failed'|'Cancelled',
            'StatusMessage': 'string',
            'Progress': 123,
            'Details': 'string'
        },
    ]
}

Response Structure

(dict) --
- Activities (list) --
  
  The activities related to moving instances out of Standby mode.
  - (dict) --
    
    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.
    - ActivityId (string) --
      
      The ID of the activity.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - Description (string) --
      
      A friendly, more verbose description of the activity.
    - Cause (string) --
      
      The reason the activity began.
    - StartTime (datetime) --
      
      The start time of the activity.
    - EndTime (datetime) --
      
      The end time of the activity.
    - StatusCode (string) --
      
      The current status of the activity.
    - StatusMessage (string) --
      
      A friendly, more verbose description of the activity status.
    - Progress (integer) --
      
      A value between 0 and 100 that indicates the progress of the activity.
    - Details (string) --
      
      The details about the activity.

Examples

This example moves the specified instance out of standby mode.

response = client.exit_standby(
    AutoScalingGroupName='my-auto-scaling-group',
    InstanceIds=[
        'i-93633f9b',
    ],
)

print(response)

Expected Output:

{
    'Activities': [
        {
            'ActivityId': '142928e1-a2dc-453a-9b24-b85ad6735928',
            'AutoScalingGroupName': 'my-auto-scaling-group',
            'Cause': 'At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.',
            'Description': 'Moving EC2 instance out of Standby: i-93633f9b',
            'Details': 'details',
            'Progress': 30,
            'StartTime': datetime(2015, 4, 12, 15, 14, 29, 6, 102, 0),
            'StatusCode': 'PreInService',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

put_lifecycle_hook(**kwargs)¶

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

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(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 pending state using RecordLifecycleActionHeartbeat .
If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction .

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 DescribeLifecycleHooks . If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook .

See also: AWS API Documentation

Request Syntax

response = client.put_lifecycle_hook(
    LifecycleHookName='string',
    AutoScalingGroupName='string',
    LifecycleTransition='string',
    RoleARN='string',
    NotificationTargetARN='string',
    NotificationMetadata='string',
    HeartbeatTimeout=123,
    DefaultResult='string'
)

Parameters

LifecycleHookName (string) --
[REQUIRED]

The name of the lifecycle hook.
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
LifecycleTransition (string) --
The instance state to which you want to attach the lifecycle hook. The valid values are:
- autoscaling:EC2_INSTANCE_LAUNCHING
- autoscaling:EC2_INSTANCE_TERMINATING
Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
RoleARN (string) --
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
NotificationTargetARN (string) --
The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION" .
NotificationMetadata (string) -- Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
HeartbeatTimeout (integer) --
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat .
DefaultResult (string) -- Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON . The default value is ABANDON .

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example creates a lifecycle hook.

response = client.put_lifecycle_hook(
    AutoScalingGroupName='my-auto-scaling-group',
    LifecycleHookName='my-lifecycle-hook',
    LifecycleTransition='autoscaling:EC2_INSTANCE_LAUNCHING',
    NotificationTargetARN='arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn',
    RoleARN='arn:aws:iam::123456789012:role/my-auto-scaling-role',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

put_notification_configuration(**kwargs)¶

Configures 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 Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.put_notification_configuration(
    AutoScalingGroupName='string',
    TopicARN='string',
    NotificationTypes=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
TopicARN (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
NotificationTypes (list) --
[REQUIRED]

The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes .
- (string) --

Returns

None

Examples

This example adds the specified notification to the specified Auto Scaling group.

response = client.put_notification_configuration(
    AutoScalingGroupName='my-auto-scaling-group',
    NotificationTypes=[
        'autoscaling:TEST_NOTIFICATION',
    ],
    TopicARN='arn:aws:sns:us-west-2:123456789012:my-sns-topic',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

put_scaling_policy(**kwargs)¶

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

For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.put_scaling_policy(
    AutoScalingGroupName='string',
    PolicyName='string',
    PolicyType='string',
    AdjustmentType='string',
    MinAdjustmentStep=123,
    MinAdjustmentMagnitude=123,
    ScalingAdjustment=123,
    Cooldown=123,
    MetricAggregationType='string',
    StepAdjustments=[
        {
            'MetricIntervalLowerBound': 123.0,
            'MetricIntervalUpperBound': 123.0,
            'ScalingAdjustment': 123
        },
    ],
    EstimatedInstanceWarmup=123,
    TargetTrackingConfiguration={
        'PredefinedMetricSpecification': {
            'PredefinedMetricType': 'ASGAverageCPUUtilization'|'ASGAverageNetworkIn'|'ASGAverageNetworkOut'|'ALBRequestCountPerTarget',
            'ResourceLabel': 'string'
        },
        'CustomizedMetricSpecification': {
            'MetricName': 'string',
            'Namespace': 'string',
            'Dimensions': [
                {
                    'Name': 'string',
                    'Value': 'string'
                },
            ],
            'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
            'Unit': 'string'
        },
        'TargetValue': 123.0,
        'DisableScaleIn': True|False
    }
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
PolicyName (string) --
[REQUIRED]

The name of the policy.
PolicyType (string) -- The policy type. The valid values are SimpleScaling , StepScaling , and TargetTrackingScaling . If the policy type is null, the value is treated as SimpleScaling .
AdjustmentType (string) --
Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .

Valid only if the policy type is StepScaling or SimpleScaling . For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide .
MinAdjustmentStep (integer) -- Available for backward compatibility. Use MinAdjustmentMagnitude instead.
MinAdjustmentMagnitude (integer) --
The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity , the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError .

This property replaces the MinAdjustmentStep property. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is SimpleScaling or StepScaling .
ScalingAdjustment (integer) --
The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.

Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
Cooldown (integer) --
The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.

Valid only if the policy type is SimpleScaling . For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide .
MetricAggregationType (string) --
The aggregation type for the CloudWatch metrics. The valid values are Minimum , Maximum , and Average . If the aggregation type is null, the value is treated as Average .

Valid only if the policy type is StepScaling .
StepAdjustments (list) --
A set of adjustments that enable you to scale based on the size of the alarm breach.

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
- (dict) --
  Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. Used in combination with PutScalingPolicy .
  
  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.
  - MetricIntervalLowerBound (float) --
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
  - MetricIntervalUpperBound (float) --
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
    
    The upper bound must be greater than the lower bound.
  - ScalingAdjustment (integer) -- [REQUIRED]
    The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
EstimatedInstanceWarmup (integer) --
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

Valid only if the policy type is StepScaling or TargetTrackingScaling .
TargetTrackingConfiguration (dict) --
A target tracking scaling policy. Includes support for predefined or customized metrics.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference .

Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
- PredefinedMetricSpecification (dict) --
  A predefined metric. You must specify either a predefined metric or a customized metric.
  - PredefinedMetricType (string) -- [REQUIRED]
    The metric type.
  - ResourceLabel (string) --
    Identifies the resource associated with the metric type. The following predefined metrics are available:
    - ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
    - ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
    - ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
    - ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.
    For predefined metric types ASGAverageCPUUtilization , ASGAverageNetworkIn , and ASGAverageNetworkOut , the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget , the parameter must be specified in the format: ``app/load-balancer-name /load-balancer-id /targetgroup/target-group-name /target-group-id `` , where ``app/load-balancer-name /load-balancer-id `` is the final portion of the load balancer ARN, and ``targetgroup/target-group-name /target-group-id `` is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
- CustomizedMetricSpecification (dict) --
  A customized metric. You must specify either a predefined metric or a customized metric.
  - MetricName (string) -- [REQUIRED]
    The name of the metric.
  - Namespace (string) -- [REQUIRED]
    The namespace of the metric.
  - Dimensions (list) --
    The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    - (dict) --
      Describes the dimension of a metric.
      - Name (string) -- [REQUIRED]
        The name of the dimension.
      - Value (string) -- [REQUIRED]
        The value of the dimension.
  - Statistic (string) -- [REQUIRED]
    The statistic of the metric.
  - Unit (string) --
    The unit of the metric.
- TargetValue (float) -- [REQUIRED]
  The target value for the metric.
- DisableScaleIn (boolean) --
  Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false .

Return type

dict

Returns

Response Syntax

{
    'PolicyARN': 'string',
    'Alarms': [
        {
            'AlarmName': 'string',
            'AlarmARN': 'string'
        },
    ]
}

Response Structure

(dict) --

Contains the output of PutScalingPolicy.
- PolicyARN (string) --
  
  The Amazon Resource Name (ARN) of the policy.
- Alarms (list) --
  
  The CloudWatch alarms created for the target tracking scaling policy.
  - (dict) --
    
    Describes an alarm.
    - AlarmName (string) --
      
      The name of the alarm.
    - AlarmARN (string) --
      
      The Amazon Resource Name (ARN) of the alarm.

Examples

This example adds the specified policy to the specified Auto Scaling group.

response = client.put_scaling_policy(
    AdjustmentType='ChangeInCapacity',
    AutoScalingGroupName='my-auto-scaling-group',
    PolicyName='ScaleIn',
    ScalingAdjustment=-1,
)

print(response)

Expected Output:

{
    'PolicyARN': 'arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn',
    'ResponseMetadata': {
        '...': '...',
    },
}

put_scheduled_update_group_action(**kwargs)¶

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

For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.put_scheduled_update_group_action(
    AutoScalingGroupName='string',
    ScheduledActionName='string',
    Time=datetime(2015, 1, 1),
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Recurrence='string',
    MinSize=123,
    MaxSize=123,
    DesiredCapacity=123
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ScheduledActionName (string) --
[REQUIRED]

The name of this scaling action.
Time (datetime) -- This parameter is no longer used.
StartTime (datetime) --
The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z" ).

If you specify Recurrence and StartTime , Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
EndTime (datetime) -- The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
Recurrence (string) --
The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *" ). For more information about this format, see Crontab .

When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
MinSize (integer) -- The minimum number of instances in the Auto Scaling group.
MaxSize (integer) -- The maximum number of instances in the Auto Scaling group.
DesiredCapacity (integer) -- The number of EC2 instances that should be running in the Auto Scaling group.

Returns

None

Examples

This example adds the specified scheduled action to the specified Auto Scaling group.

response = client.put_scheduled_update_group_action(
    AutoScalingGroupName='my-auto-scaling-group',
    DesiredCapacity=4,
    EndTime=datetime(2014, 5, 12, 8, 0, 0, 0, 132, 0),
    MaxSize=6,
    MinSize=2,
    ScheduledActionName='my-scheduled-action',
    StartTime=datetime(2014, 5, 12, 8, 0, 0, 0, 132, 0),
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

record_lifecycle_action_heartbeat(**kwargs)¶

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook .

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(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 pending state.
If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.record_lifecycle_action_heartbeat(
    LifecycleHookName='string',
    AutoScalingGroupName='string',
    LifecycleActionToken='string',
    InstanceId='string'
)

Parameters

LifecycleHookName (string) --
[REQUIRED]

The name of the lifecycle hook.
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
LifecycleActionToken (string) -- A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.
InstanceId (string) -- The ID of the instance.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example records a lifecycle action heartbeat to keep the instance in a pending state.

response = client.record_lifecycle_action_heartbeat(
    AutoScalingGroupName='my-auto-scaling-group',
    LifecycleActionToken='bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635',
    LifecycleHookName='my-lifecycle-hook',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

resume_processes(**kwargs)¶

Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.resume_processes(
    AutoScalingGroupName='string',
    ScalingProcesses=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ScalingProcesses (list) --
One or more of the following processes. If you omit this parameter, all processes are specified.
- Launch
- Terminate
- HealthCheck
- ReplaceUnhealthy
- AZRebalance
- AlarmNotification
- ScheduledActions
- AddToLoadBalancer
- (string) --

Returns

None

Examples

This example resumes the specified suspended scaling process for the specified Auto Scaling group.

response = client.resume_processes(
    AutoScalingGroupName='my-auto-scaling-group',
    ScalingProcesses=[
        'AlarmNotification',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

set_desired_capacity(**kwargs)¶

Sets the size of the specified Auto Scaling group.

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

See also: AWS API Documentation

Request Syntax

response = client.set_desired_capacity(
    AutoScalingGroupName='string',
    DesiredCapacity=123,
    HonorCooldown=True|False
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
DesiredCapacity (integer) --
[REQUIRED]

The number of EC2 instances that should be running in the Auto Scaling group.
HonorCooldown (boolean) -- Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

Returns

None

Examples

This example sets the desired capacity for the specified Auto Scaling group.

response = client.set_desired_capacity(
    AutoScalingGroupName='my-auto-scaling-group',
    DesiredCapacity=2,
    HonorCooldown=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

set_instance_health(**kwargs)¶

Sets the health status of the specified instance.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.set_instance_health(
    InstanceId='string',
    HealthStatus='string',
    ShouldRespectGracePeriod=True|False
)

Parameters

InstanceId (string) --
[REQUIRED]

The ID of the instance.
HealthStatus (string) --
[REQUIRED]

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
ShouldRespectGracePeriod (boolean) --
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False , to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup .

Returns

None

Examples

This example sets the health status of the specified instance to Unhealthy.

response = client.set_instance_health(
    HealthStatus='Unhealthy',
    InstanceId='i-93633f9b',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

set_instance_protection(**kwargs)¶

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.set_instance_protection(
    InstanceIds=[
        'string',
    ],
    AutoScalingGroupName='string',
    ProtectedFromScaleIn=True|False
)

Parameters

InstanceIds (list) --
[REQUIRED]

One or more instance IDs.
- (string) --
AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ProtectedFromScaleIn (boolean) --
[REQUIRED]

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Examples

This example enables instance protection for the specified instance.

response = client.set_instance_protection(
    AutoScalingGroupName='my-auto-scaling-group',
    InstanceIds=[
        'i-93633f9b',
    ],
    ProtectedFromScaleIn=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example disables instance protection for the specified instance.

response = client.set_instance_protection(
    AutoScalingGroupName='my-auto-scaling-group',
    InstanceIds=[
        'i-93633f9b',
    ],
    ProtectedFromScaleIn=False,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

suspend_processes(**kwargs)¶

Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

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 Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide .

See also: AWS API Documentation

Request Syntax

response = client.suspend_processes(
    AutoScalingGroupName='string',
    ScalingProcesses=[
        'string',
    ]
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
ScalingProcesses (list) --
One or more of the following processes. If you omit this parameter, all processes are specified.
- Launch
- Terminate
- HealthCheck
- ReplaceUnhealthy
- AZRebalance
- AlarmNotification
- ScheduledActions
- AddToLoadBalancer
- (string) --

Returns

None

Examples

This example suspends the specified scaling process for the specified Auto Scaling group.

response = client.suspend_processes(
    AutoScalingGroupName='my-auto-scaling-group',
    ScalingProcesses=[
        'AlarmNotification',
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

terminate_instance_in_auto_scaling_group(**kwargs)¶

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

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

See also: AWS API Documentation

Request Syntax

response = client.terminate_instance_in_auto_scaling_group(
    InstanceId='string',
    ShouldDecrementDesiredCapacity=True|False
)

Parameters

InstanceId (string) --
[REQUIRED]

The ID of the instance.
ShouldDecrementDesiredCapacity (boolean) --
[REQUIRED]

Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

Return type

dict

Returns

Response Syntax

{
    'Activity': {
        'ActivityId': 'string',
        'AutoScalingGroupName': 'string',
        'Description': 'string',
        'Cause': 'string',
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'StatusCode': 'PendingSpotBidPlacement'|'WaitingForSpotInstanceRequestId'|'WaitingForSpotInstanceId'|'WaitingForInstanceId'|'PreInService'|'InProgress'|'WaitingForELBConnectionDraining'|'MidLifecycleAction'|'WaitingForInstanceWarmup'|'Successful'|'Failed'|'Cancelled',
        'StatusMessage': 'string',
        'Progress': 123,
        'Details': 'string'
    }
}

Response Structure

(dict) --
- Activity (dict) --
  
  A scaling activity.
  - ActivityId (string) --
    
    The ID of the activity.
  - AutoScalingGroupName (string) --
    
    The name of the Auto Scaling group.
  - Description (string) --
    
    A friendly, more verbose description of the activity.
  - Cause (string) --
    
    The reason the activity began.
  - StartTime (datetime) --
    
    The start time of the activity.
  - EndTime (datetime) --
    
    The end time of the activity.
  - StatusCode (string) --
    
    The current status of the activity.
  - StatusMessage (string) --
    
    A friendly, more verbose description of the activity status.
  - Progress (integer) --
    
    A value between 0 and 100 that indicates the progress of the activity.
  - Details (string) --
    
    The details about the activity.

Examples

This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.

response = client.terminate_instance_in_auto_scaling_group(
    InstanceId='i-93633f9b',
    ShouldDecrementDesiredCapacity=False,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

update_auto_scaling_group(**kwargs)¶

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters 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. Scaling activities that are currently in progress aren't affected.

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 event 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 parameters have been set, use DescribeAutoScalingGroups . You can also view the scaling policies for an Auto Scaling group using DescribePolicies . If the group has scaling policies, you can update them using PutScalingPolicy .

See also: AWS API Documentation

Request Syntax

response = client.update_auto_scaling_group(
    AutoScalingGroupName='string',
    LaunchConfigurationName='string',
    LaunchTemplate={
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'Version': 'string'
    },
    MixedInstancesPolicy={
        'LaunchTemplate': {
            'LaunchTemplateSpecification': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'Overrides': [
                {
                    'InstanceType': 'string'
                },
            ]
        },
        'InstancesDistribution': {
            'OnDemandAllocationStrategy': 'string',
            'OnDemandBaseCapacity': 123,
            'OnDemandPercentageAboveBaseCapacity': 123,
            'SpotAllocationStrategy': 'string',
            'SpotInstancePools': 123,
            'SpotMaxPrice': 'string'
        }
    },
    MinSize=123,
    MaxSize=123,
    DesiredCapacity=123,
    DefaultCooldown=123,
    AvailabilityZones=[
        'string',
    ],
    HealthCheckType='string',
    HealthCheckGracePeriod=123,
    PlacementGroup='string',
    VPCZoneIdentifier='string',
    TerminationPolicies=[
        'string',
    ],
    NewInstancesProtectedFromScaleIn=True|False,
    ServiceLinkedRoleARN='string'
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
LaunchConfigurationName (string) --
The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy .

Warning

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 get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection .
LaunchTemplate (dict) --
The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy .

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference .
- LaunchTemplateId (string) --
  The ID of the launch template. You must specify either a template ID or a template name.
- LaunchTemplateName (string) --
  The name of the launch template. You must specify either a template name or a template ID.
- Version (string) --
  The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
MixedInstancesPolicy (dict) --
An embedded object that specifies a mixed instances policy.

In your call to UpdateAutoScalingGroup , you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide .
- LaunchTemplate (dict) --
  The launch template and instance types (overrides).
  
  This parameter must be specified when creating a mixed instances policy.
  - LaunchTemplateSpecification (dict) --
    The launch template to use. You must specify either the launch template ID or launch template name in the request.
    - LaunchTemplateId (string) --
      The ID of the launch template. You must specify either a template ID or a template name.
    - LaunchTemplateName (string) --
      The name of the launch template. You must specify either a template name or a template ID.
    - Version (string) --
      The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
  - Overrides (list) --
    Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You must specify between 2 and 20 overrides.
    - (dict) --
      Describes an override for a launch template.
      - InstanceType (string) --
        The instance type.
        
        For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
- InstancesDistribution (dict) --
  The instances distribution to use.
  
  If you leave this parameter unspecified when creating a mixed instances policy, the default values are used.
  - OnDemandAllocationStrategy (string) --
    Indicates how to allocate instance types to fulfill On-Demand capacity.
    
    The only valid value is prioritized , which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.
  - OnDemandBaseCapacity (integer) --
    The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
    
    The default value is 0 . If you leave this parameter set to 0 , On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.
  - OnDemandPercentageAboveBaseCapacity (integer) --
    Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity . The range is 0–100.
    
    The default value is 100 . If you leave this parameter set to 100 , the percentages are 100% for On-Demand Instances and 0% for Spot Instances.
  - SpotAllocationStrategy (string) --
    Indicates how to allocate instances across Spot Instance pools.
    
    If the allocation strategy is lowest-price , the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized , the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity.
    
    The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is lowest-price . The default Spot allocation strategy for the AWS Management Console is capacity-optimized .
    
    Valid values: lowest-price | capacity-optimized
  - SpotInstancePools (integer) --
    The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate . The range is 1–20. The default value is 2 .
    
    Valid only when the Spot allocation strategy is lowest-price .
  - SpotMaxPrice (string) --
    The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.
    
    To remove a value that you previously set, include the parameter but leave the value blank.
MinSize (integer) -- The minimum size of the Auto Scaling group.
MaxSize (integer) -- The maximum size of the Auto Scaling group.
DesiredCapacity (integer) -- The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
DefaultCooldown (integer) --
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300 . This cooldown period is not used when a scaling-specific cooldown is specified.

Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide .
AvailabilityZones (list) --
One or more Availability Zones for the group.
- (string) --
HealthCheckType (string) -- The service to use for the health checks. The valid values are EC2 and ELB . If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
HealthCheckGracePeriod (integer) --
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0 .

For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide .

Conditional: This parameter is required if you are adding an ELB health check.
PlacementGroup (string) -- The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances .
VPCZoneIdentifier (string) --
A comma-separated list of subnet IDs for virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones , the subnets that you specify for this parameter must reside in those Availability Zones.
TerminationPolicies (list) --
A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide .
- (string) --
NewInstancesProtectedFromScaleIn (boolean) --
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide .
ServiceLinkedRoleARN (string) -- The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide .

Returns

None

Examples

This example updates the launch configuration of the specified Auto Scaling group.

response = client.update_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
    LaunchConfigurationName='new-launch-config',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example updates the minimum size and maximum size of the specified Auto Scaling group.

response = client.update_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
    MaxSize=3,
    MinSize=1,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example enables instance protection for the specified Auto Scaling group.

response = client.update_auto_scaling_group(
    AutoScalingGroupName='my-auto-scaling-group',
    NewInstancesProtectedFromScaleIn=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

Paginators ¶

The available paginators are:

AutoScaling.Paginator.DescribeAutoScalingGroups
AutoScaling.Paginator.DescribeAutoScalingInstances
AutoScaling.Paginator.DescribeLaunchConfigurations
AutoScaling.Paginator.DescribeLoadBalancerTargetGroups
AutoScaling.Paginator.DescribeLoadBalancers
AutoScaling.Paginator.DescribeNotificationConfigurations
AutoScaling.Paginator.DescribePolicies
AutoScaling.Paginator.DescribeScalingActivities
AutoScaling.Paginator.DescribeScheduledActions
AutoScaling.Paginator.DescribeTags

class AutoScaling.Paginator.DescribeAutoScalingGroups¶

paginator = client.get_paginator('describe_auto_scaling_groups')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_auto_scaling_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupNames=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AutoScalingGroupNames (list) --
The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AutoScalingGroups': [
        {
            'AutoScalingGroupName': 'string',
            'AutoScalingGroupARN': 'string',
            'LaunchConfigurationName': 'string',
            'LaunchTemplate': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'MixedInstancesPolicy': {
                'LaunchTemplate': {
                    'LaunchTemplateSpecification': {
                        'LaunchTemplateId': 'string',
                        'LaunchTemplateName': 'string',
                        'Version': 'string'
                    },
                    'Overrides': [
                        {
                            'InstanceType': 'string'
                        },
                    ]
                },
                'InstancesDistribution': {
                    'OnDemandAllocationStrategy': 'string',
                    'OnDemandBaseCapacity': 123,
                    'OnDemandPercentageAboveBaseCapacity': 123,
                    'SpotAllocationStrategy': 'string',
                    'SpotInstancePools': 123,
                    'SpotMaxPrice': 'string'
                }
            },
            'MinSize': 123,
            'MaxSize': 123,
            'DesiredCapacity': 123,
            'DefaultCooldown': 123,
            'AvailabilityZones': [
                'string',
            ],
            'LoadBalancerNames': [
                'string',
            ],
            'TargetGroupARNs': [
                'string',
            ],
            'HealthCheckType': 'string',
            'HealthCheckGracePeriod': 123,
            'Instances': [
                {
                    'InstanceId': 'string',
                    'AvailabilityZone': 'string',
                    'LifecycleState': 'Pending'|'Pending:Wait'|'Pending:Proceed'|'Quarantined'|'InService'|'Terminating'|'Terminating:Wait'|'Terminating:Proceed'|'Terminated'|'Detaching'|'Detached'|'EnteringStandby'|'Standby',
                    'HealthStatus': 'string',
                    'LaunchConfigurationName': 'string',
                    'LaunchTemplate': {
                        'LaunchTemplateId': 'string',
                        'LaunchTemplateName': 'string',
                        'Version': 'string'
                    },
                    'ProtectedFromScaleIn': True|False
                },
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'SuspendedProcesses': [
                {
                    'ProcessName': 'string',
                    'SuspensionReason': 'string'
                },
            ],
            'PlacementGroup': 'string',
            'VPCZoneIdentifier': 'string',
            'EnabledMetrics': [
                {
                    'Metric': 'string',
                    'Granularity': 'string'
                },
            ],
            'Status': 'string',
            'Tags': [
                {
                    'ResourceId': 'string',
                    'ResourceType': 'string',
                    'Key': 'string',
                    'Value': 'string',
                    'PropagateAtLaunch': True|False
                },
            ],
            'TerminationPolicies': [
                'string',
            ],
            'NewInstancesProtectedFromScaleIn': True|False,
            'ServiceLinkedRoleARN': 'string'
        },
    ],

}

Response Structure

(dict) --
- AutoScalingGroups (list) --
  
  The groups.
  - (dict) --
    
    Describes an Auto Scaling group.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - AutoScalingGroupARN (string) --
      
      The Amazon Resource Name (ARN) of the Auto Scaling group.
    - LaunchConfigurationName (string) --
      
      The name of the associated launch configuration.
    - LaunchTemplate (dict) --
      
      The launch template for the group.
      - LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
      - LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
      - Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
    - MixedInstancesPolicy (dict) --
      
      The mixed instances policy for the group.
      - LaunchTemplate (dict) --
        
        The launch template and instance types (overrides).
        
        This parameter must be specified when creating a mixed instances policy.
        
        LaunchTemplateSpecification (dict) --
        
        The launch template to use. You must specify either the launch template ID or launch template name in the request.
        
        LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
        
        LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
        
        Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
        
        Overrides (list) --
        
        Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You must specify between 2 and 20 overrides.
        
        (dict) --
        
        Describes an override for a launch template.
        
        InstanceType (string) --
        
        The instance type.
        
        For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
      - InstancesDistribution (dict) --
        
        The instances distribution to use.
        
        If you leave this parameter unspecified when creating a mixed instances policy, the default values are used.
        
        OnDemandAllocationStrategy (string) --
        
        Indicates how to allocate instance types to fulfill On-Demand capacity.
        
        The only valid value is prioritized , which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.
        
        OnDemandBaseCapacity (integer) --
        
        The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
        
        The default value is 0 . If you leave this parameter set to 0 , On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.
        
        OnDemandPercentageAboveBaseCapacity (integer) --
        
        Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity . The range is 0–100.
        
        The default value is 100 . If you leave this parameter set to 100 , the percentages are 100% for On-Demand Instances and 0% for Spot Instances.
        
        SpotAllocationStrategy (string) --
        
        Indicates how to allocate instances across Spot Instance pools.
        
        If the allocation strategy is lowest-price , the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized , the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity.
        
        The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is lowest-price . The default Spot allocation strategy for the AWS Management Console is capacity-optimized .
        
        Valid values: lowest-price | capacity-optimized
        
        SpotInstancePools (integer) --
        
        The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate . The range is 1–20. The default value is 2 .
        
        Valid only when the Spot allocation strategy is lowest-price .
        
        SpotMaxPrice (string) --
        
        The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.
        
        To remove a value that you previously set, include the parameter but leave the value blank.
    - MinSize (integer) --
      
      The minimum size of the group.
    - MaxSize (integer) --
      
      The maximum size of the group.
    - DesiredCapacity (integer) --
      
      The desired size of the group.
    - DefaultCooldown (integer) --
      
      The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
    - AvailabilityZones (list) --
      
      One or more Availability Zones for the group.
      - (string) --
    - LoadBalancerNames (list) --
      
      One or more load balancers associated with the group.
      - (string) --
    - TargetGroupARNs (list) --
      
      The Amazon Resource Names (ARN) of the target groups for your load balancer.
      - (string) --
    - HealthCheckType (string) --
      
      The service to use for the health checks. The valid values are EC2 and ELB . If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
    - HealthCheckGracePeriod (integer) --
      
      The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
    - Instances (list) --
      
      The EC2 instances associated with the group.
      - (dict) --
        
        Describes an EC2 instance.
        
        InstanceId (string) --
        
        The ID of the instance.
        
        AvailabilityZone (string) --
        
        The Availability Zone in which the instance is running.
        
        LifecycleState (string) --
        
        A description of the current lifecycle state. The Quarantined state is not used.
        
        HealthStatus (string) --
        
        The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
        
        LaunchConfigurationName (string) --
        
        The launch configuration associated with the instance.
        
        LaunchTemplate (dict) --
        
        The launch template for the instance.
        
        LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
        
        LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
        
        Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
        
        ProtectedFromScaleIn (boolean) --
        
        Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
    - CreatedTime (datetime) --
      
      The date and time the group was created.
    - SuspendedProcesses (list) --
      
      The suspended processes associated with the group.
      - (dict) --
        
        Describes an automatic scaling process that has been suspended. For more information, see ProcessType .
        
        ProcessName (string) --
        
        The name of the suspended process.
        
        SuspensionReason (string) --
        
        The reason that the process was suspended.
    - PlacementGroup (string) --
      
      The name of the placement group into which to launch your instances, if any.
    - VPCZoneIdentifier (string) --
      
      One or more subnet IDs, if applicable, separated by commas.
    - EnabledMetrics (list) --
      
      The metrics enabled for the group.
      - (dict) --
        
        Describes an enabled metric.
        
        Metric (string) --
        
        One of the following metrics:
        
        GroupMinSize
        
        GroupMaxSize
        
        GroupDesiredCapacity
        
        GroupInServiceInstances
        
        GroupPendingInstances
        
        GroupStandbyInstances
        
        GroupTerminatingInstances
        
        GroupTotalInstances
        
        Granularity (string) --
        
        The granularity of the metric. The only valid value is 1Minute .
    - Status (string) --
      
      The current state of the group when DeleteAutoScalingGroup is in progress.
    - Tags (list) --
      
      The tags for the group.
      - (dict) --
        
        Describes a tag for an Auto Scaling group.
        
        ResourceId (string) --
        
        The name of the group.
        
        ResourceType (string) --
        
        The type of resource. The only supported value is auto-scaling-group .
        
        Key (string) --
        
        The tag key.
        
        Value (string) --
        
        The tag value.
        
        PropagateAtLaunch (boolean) --
        
        Determines whether the tag is added to new instances as they are launched in the group.
    - TerminationPolicies (list) --
      
      The termination policies for the group.
      - (string) --
    - NewInstancesProtectedFromScaleIn (boolean) --
      
      Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
    - ServiceLinkedRoleARN (string) --
      
      The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

class AutoScaling.Paginator.DescribeAutoScalingInstances¶

paginator = client.get_paginator('describe_auto_scaling_instances')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_auto_scaling_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

InstanceIds (list) --
The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AutoScalingInstances': [
        {
            'InstanceId': 'string',
            'AutoScalingGroupName': 'string',
            'AvailabilityZone': 'string',
            'LifecycleState': 'string',
            'HealthStatus': 'string',
            'LaunchConfigurationName': 'string',
            'LaunchTemplate': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': 'string'
            },
            'ProtectedFromScaleIn': True|False
        },
    ],

}

Response Structure

(dict) --
- AutoScalingInstances (list) --
  
  The instances.
  - (dict) --
    
    Describes an EC2 instance associated with an Auto Scaling group.
    - InstanceId (string) --
      
      The ID of the instance.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group for the instance.
    - AvailabilityZone (string) --
      
      The Availability Zone for the instance.
    - LifecycleState (string) --
      
      The lifecycle state for the instance.
    - HealthStatus (string) --
      
      The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
    - LaunchConfigurationName (string) --
      
      The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
    - LaunchTemplate (dict) --
      
      The launch template for the instance.
      - LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
      - LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
      - Version (string) --
        
        The version number, $Latest , or $Default . If the value is $Latest , Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default , Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default .
    - ProtectedFromScaleIn (boolean) --
      
      Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

class AutoScaling.Paginator.DescribeLaunchConfigurations¶

paginator = client.get_paginator('describe_launch_configurations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_launch_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    LaunchConfigurationNames=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

LaunchConfigurationNames (list) --
The launch configuration names. If you omit this parameter, all launch configurations are described.
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'LaunchConfigurations': [
        {
            'LaunchConfigurationName': 'string',
            'LaunchConfigurationARN': 'string',
            'ImageId': 'string',
            'KeyName': 'string',
            'SecurityGroups': [
                'string',
            ],
            'ClassicLinkVPCId': 'string',
            'ClassicLinkVPCSecurityGroups': [
                'string',
            ],
            'UserData': 'string',
            'InstanceType': 'string',
            'KernelId': 'string',
            'RamdiskId': 'string',
            'BlockDeviceMappings': [
                {
                    'VirtualName': 'string',
                    'DeviceName': 'string',
                    'Ebs': {
                        'SnapshotId': 'string',
                        'VolumeSize': 123,
                        'VolumeType': 'string',
                        'DeleteOnTermination': True|False,
                        'Iops': 123,
                        'Encrypted': True|False
                    },
                    'NoDevice': True|False
                },
            ],
            'InstanceMonitoring': {
                'Enabled': True|False
            },
            'SpotPrice': 'string',
            'IamInstanceProfile': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'EbsOptimized': True|False,
            'AssociatePublicIpAddress': True|False,
            'PlacementTenancy': 'string'
        },
    ],

}

Response Structure

(dict) --
- LaunchConfigurations (list) --
  
  The launch configurations.
  - (dict) --
    
    Describes a launch configuration.
    - LaunchConfigurationName (string) --
      
      The name of the launch configuration.
    - LaunchConfigurationARN (string) --
      
      The Amazon Resource Name (ARN) of the launch configuration.
    - ImageId (string) --
      
      The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
      
      For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances .
    - KeyName (string) --
      
      The name of the key pair.
      
      For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances .
    - SecurityGroups (list) --
      
      A list that contains the security groups to assign to the instances in the Auto Scaling group.
      
      For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
      - (string) --
    - ClassicLinkVPCId (string) --
      
      The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
      
      For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .
    - ClassicLinkVPCSecurityGroups (list) --
      
      The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId .
      
      For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .
      - (string) --
    - UserData (string) --
      
      The Base64-encoded user data to make available to the launched EC2 instances.
      
      For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances .
    - InstanceType (string) --
      
      The instance type for the instances.
      
      For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
    - KernelId (string) --
      
      The ID of the kernel associated with the AMI.
    - RamdiskId (string) --
      
      The ID of the RAM disk associated with the AMI.
    - BlockDeviceMappings (list) --
      
      A block device mapping, which specifies the block devices for the instance.
      
      For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances .
      - (dict) --
        
        Describes a block device mapping.
        
        VirtualName (string) --
        
        The name of the virtual device (for example, ephemeral0 ).
        
        DeviceName (string) --
        
        The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh ). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances .
        
        Ebs (dict) --
        
        The information about the Amazon EBS volume.
        
        SnapshotId (string) --
        
        The snapshot ID of the volume to use.
        
        Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize , VolumeSize must be equal or greater than the size of the snapshot.
        
        VolumeSize (integer) --
        
        The volume size, in Gibibytes (GiB).
        
        This can be a number from 1-1,024 for standard , 4-16,384 for io1 , 1-16,384 for gp2 , and 500-16,384 for st1 and sc1 . If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.
        
        Note
        
        At least one of VolumeSize or SnapshotId is required.
        
        VolumeType (string) --
        
        The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .
        
        Valid values: standard | io1 | gp2 | st1 | sc1
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true .
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .
        
        Conditional: This parameter is required when the volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)
        
        Encrypted (boolean) --
        
        Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
        
        Note
        
        If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.
        
        Enabling encryption by default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.
        
        For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK Key Policy for Use with Encrypted Volumes in the Amazon EC2 Auto Scaling User Guide .
        
        NoDevice (boolean) --
        
        Suppresses a device mapping.
        
        If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.
    - InstanceMonitoring (dict) --
      
      Controls whether instances in this group are launched with detailed (true ) or basic (false ) monitoring.
      
      For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide .
      - Enabled (boolean) --
        
        If true , detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
    - SpotPrice (string) --
      
      The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price.
      
      For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide .
    - IamInstanceProfile (string) --
      
      The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
      
      For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide .
    - CreatedTime (datetime) --
      
      The creation date and time for the launch configuration.
    - EbsOptimized (boolean) --
      
      Specifies whether the launch configuration is optimized for EBS I/O (true ) or not (false ).
      
      For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances .
    - AssociatePublicIpAddress (boolean) --
      
      For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances.
      
      For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide .
    - PlacementTenancy (string) --
      
      The tenancy of the instance, either default or dedicated . An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
      
      For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide .

class AutoScaling.Paginator.DescribeLoadBalancerTargetGroups¶

paginator = client.get_paginator('describe_load_balancer_target_groups')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_load_balancer_target_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'LoadBalancerTargetGroups': [
        {
            'LoadBalancerTargetGroupARN': 'string',
            'State': 'string'
        },
    ],

}

Response Structure

(dict) --
- LoadBalancerTargetGroups (list) --
  
  Information about the target groups.
  - (dict) --
    
    Describes the state of a target group.
    
    If you attach a target group to an existing Auto Scaling group, the initial state 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, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.
    - LoadBalancerTargetGroupARN (string) --
      
      The Amazon Resource Name (ARN) of the target group.
    - State (string) --
      
      The state of the target group.
      - Adding - The Auto Scaling instances are being registered with the target group.
      - Added - All Auto Scaling instances are registered with the target group.
      - InService - At least one Auto Scaling instance passed an ELB health check.
      - Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
      - Removed - All Auto Scaling instances are deregistered from the target group.

class AutoScaling.Paginator.DescribeLoadBalancers¶

paginator = client.get_paginator('describe_load_balancers')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_load_balancers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AutoScalingGroupName (string) --
[REQUIRED]

The name of the Auto Scaling group.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'LoadBalancers': [
        {
            'LoadBalancerName': 'string',
            'State': 'string'
        },
    ],

}

Response Structure

(dict) --
- LoadBalancers (list) --
  
  The load balancers.
  - (dict) --
    
    Describes the state of a Classic Load Balancer.
    
    If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService .
    
    If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding . The state transitions to Added after all instances in the group are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.
    - LoadBalancerName (string) --
      
      The name of the load balancer.
    - State (string) --
      
      One of the following load balancer states:
      - Adding - The instances in the group are being registered with the load balancer.
      - Added - All instances in the group are registered with the load balancer.
      - InService - At least one instance in the group passed an ELB health check.
      - Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
      - Removed - All instances in the group are deregistered from the load balancer.

class AutoScaling.Paginator.DescribeNotificationConfigurations¶

paginator = client.get_paginator('describe_notification_configurations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_notification_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupNames=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AutoScalingGroupNames (list) --
The name of the Auto Scaling group.
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'NotificationConfigurations': [
        {
            'AutoScalingGroupName': 'string',
            'TopicARN': 'string',
            'NotificationType': 'string'
        },
    ],

}

Response Structure

(dict) --
- NotificationConfigurations (list) --
  
  The notification configurations.
  - (dict) --
    
    Describes a notification.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - TopicARN (string) --
      
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
    - NotificationType (string) --
      
      One of the following event notification types:
      - autoscaling:EC2_INSTANCE_LAUNCH
      - autoscaling:EC2_INSTANCE_LAUNCH_ERROR
      - autoscaling:EC2_INSTANCE_TERMINATE
      - autoscaling:EC2_INSTANCE_TERMINATE_ERROR
      - autoscaling:TEST_NOTIFICATION

class AutoScaling.Paginator.DescribePolicies¶

paginator = client.get_paginator('describe_policies')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_policies().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupName='string',
    PolicyNames=[
        'string',
    ],
    PolicyTypes=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AutoScalingGroupName (string) -- The name of the Auto Scaling group.
PolicyNames (list) --
The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
- (string) --
PolicyTypes (list) --
One or more policy types. The valid values are SimpleScaling , StepScaling , and TargetTrackingScaling .
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ScalingPolicies': [
        {
            'AutoScalingGroupName': 'string',
            'PolicyName': 'string',
            'PolicyARN': 'string',
            'PolicyType': 'string',
            'AdjustmentType': 'string',
            'MinAdjustmentStep': 123,
            'MinAdjustmentMagnitude': 123,
            'ScalingAdjustment': 123,
            'Cooldown': 123,
            'StepAdjustments': [
                {
                    'MetricIntervalLowerBound': 123.0,
                    'MetricIntervalUpperBound': 123.0,
                    'ScalingAdjustment': 123
                },
            ],
            'MetricAggregationType': 'string',
            'EstimatedInstanceWarmup': 123,
            'Alarms': [
                {
                    'AlarmName': 'string',
                    'AlarmARN': 'string'
                },
            ],
            'TargetTrackingConfiguration': {
                'PredefinedMetricSpecification': {
                    'PredefinedMetricType': 'ASGAverageCPUUtilization'|'ASGAverageNetworkIn'|'ASGAverageNetworkOut'|'ALBRequestCountPerTarget',
                    'ResourceLabel': 'string'
                },
                'CustomizedMetricSpecification': {
                    'MetricName': 'string',
                    'Namespace': 'string',
                    'Dimensions': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Statistic': 'Average'|'Minimum'|'Maximum'|'SampleCount'|'Sum',
                    'Unit': 'string'
                },
                'TargetValue': 123.0,
                'DisableScaleIn': True|False
            }
        },
    ],

}

Response Structure

(dict) --
- ScalingPolicies (list) --
  
  The scaling policies.
  - (dict) --
    
    Describes a scaling policy.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - PolicyName (string) --
      
      The name of the scaling policy.
    - PolicyARN (string) --
      
      The Amazon Resource Name (ARN) of the policy.
    - PolicyType (string) --
      
      The policy type. The valid values are SimpleScaling , StepScaling , and TargetTrackingScaling .
    - AdjustmentType (string) --
      
      The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity , ExactCapacity , and PercentChangeInCapacity .
    - MinAdjustmentStep (integer) --
      
      Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    - MinAdjustmentMagnitude (integer) --
      
      The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity , the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError .
    - ScalingAdjustment (integer) --
      
      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
    - Cooldown (integer) --
      
      The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
    - StepAdjustments (list) --
      
      A set of adjustments that enable you to scale based on the size of the alarm breach.
      - (dict) --
        
        Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. Used in combination with PutScalingPolicy .
        
        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.
        
        MetricIntervalLowerBound (float) --
        
        The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
        
        MetricIntervalUpperBound (float) --
        
        The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
        
        The upper bound must be greater than the lower bound.
        
        ScalingAdjustment (integer) --
        
        The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
    - MetricAggregationType (string) --
      
      The aggregation type for the CloudWatch metrics. The valid values are Minimum , Maximum , and Average .
    - EstimatedInstanceWarmup (integer) --
      
      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
    - Alarms (list) --
      
      The CloudWatch alarms related to the policy.
      - (dict) --
        
        Describes an alarm.
        
        AlarmName (string) --
        
        The name of the alarm.
        
        AlarmARN (string) --
        
        The Amazon Resource Name (ARN) of the alarm.
    - TargetTrackingConfiguration (dict) --
      
      A target tracking scaling policy.
      - PredefinedMetricSpecification (dict) --
        
        A predefined metric. You must specify either a predefined metric or a customized metric.
        
        PredefinedMetricType (string) --
        
        The metric type.
        
        ResourceLabel (string) --
        
        Identifies the resource associated with the metric type. The following predefined metrics are available:
        
        ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
        
        ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
        
        ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
        
        ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.
        
        For predefined metric types ASGAverageCPUUtilization , ASGAverageNetworkIn , and ASGAverageNetworkOut , the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget , the parameter must be specified in the format: ``app/load-balancer-name /load-balancer-id /targetgroup/target-group-name /target-group-id `` , where ``app/load-balancer-name /load-balancer-id `` is the final portion of the load balancer ARN, and ``targetgroup/target-group-name /target-group-id `` is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.
      - CustomizedMetricSpecification (dict) --
        
        A customized metric. You must specify either a predefined metric or a customized metric.
        
        MetricName (string) --
        
        The name of the metric.
        
        Namespace (string) --
        
        The namespace of the metric.
        
        Dimensions (list) --
        
        The dimensions of the metric.
        
        Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
        
        (dict) --
        
        Describes the dimension of a metric.
        
        Name (string) --
        
        The name of the dimension.
        
        Value (string) --
        
        The value of the dimension.
        
        Statistic (string) --
        
        The statistic of the metric.
        
        Unit (string) --
        
        The unit of the metric.
      - TargetValue (float) --
        
        The target value for the metric.
      - DisableScaleIn (boolean) --
        
        Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false .

class AutoScaling.Paginator.DescribeScalingActivities¶

paginator = client.get_paginator('describe_scaling_activities')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_scaling_activities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ActivityIds=[
        'string',
    ],
    AutoScalingGroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ActivityIds (list) --
The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
- (string) --
AutoScalingGroupName (string) -- The name of the Auto Scaling group.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Activities': [
        {
            'ActivityId': 'string',
            'AutoScalingGroupName': 'string',
            'Description': 'string',
            'Cause': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusCode': 'PendingSpotBidPlacement'|'WaitingForSpotInstanceRequestId'|'WaitingForSpotInstanceId'|'WaitingForInstanceId'|'PreInService'|'InProgress'|'WaitingForELBConnectionDraining'|'MidLifecycleAction'|'WaitingForInstanceWarmup'|'Successful'|'Failed'|'Cancelled',
            'StatusMessage': 'string',
            'Progress': 123,
            'Details': 'string'
        },
    ],

}

Response Structure

(dict) --
- Activities (list) --
  
  The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
  - (dict) --
    
    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.
    - ActivityId (string) --
      
      The ID of the activity.
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - Description (string) --
      
      A friendly, more verbose description of the activity.
    - Cause (string) --
      
      The reason the activity began.
    - StartTime (datetime) --
      
      The start time of the activity.
    - EndTime (datetime) --
      
      The end time of the activity.
    - StatusCode (string) --
      
      The current status of the activity.
    - StatusMessage (string) --
      
      A friendly, more verbose description of the activity status.
    - Progress (integer) --
      
      A value between 0 and 100 that indicates the progress of the activity.
    - Details (string) --
      
      The details about the activity.

class AutoScaling.Paginator.DescribeScheduledActions¶

paginator = client.get_paginator('describe_scheduled_actions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_scheduled_actions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupName='string',
    ScheduledActionNames=[
        'string',
    ],
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

AutoScalingGroupName (string) -- The name of the Auto Scaling group.
ScheduledActionNames (list) --
The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
- (string) --
StartTime (datetime) -- The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
EndTime (datetime) -- The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ScheduledUpdateGroupActions': [
        {
            'AutoScalingGroupName': 'string',
            'ScheduledActionName': 'string',
            'ScheduledActionARN': 'string',
            'Time': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Recurrence': 'string',
            'MinSize': 123,
            'MaxSize': 123,
            'DesiredCapacity': 123
        },
    ],

}

Response Structure

(dict) --
- ScheduledUpdateGroupActions (list) --
  
  The scheduled actions.
  - (dict) --
    
    Describes a scheduled scaling action. Used in response to DescribeScheduledActions .
    - AutoScalingGroupName (string) --
      
      The name of the Auto Scaling group.
    - ScheduledActionName (string) --
      
      The name of the scheduled action.
    - ScheduledActionARN (string) --
      
      The Amazon Resource Name (ARN) of the scheduled action.
    - Time (datetime) --
      
      This parameter is no longer used.
    - StartTime (datetime) --
      
      The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z" .
    - EndTime (datetime) --
      
      The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z" .
    - Recurrence (string) --
      
      The recurring schedule for the action, in Unix cron syntax format.
      
      When StartTime and EndTime are specified with Recurrence , they form the boundaries of when the recurring action starts and stops.
    - MinSize (integer) --
      
      The minimum number of instances in the Auto Scaling group.
    - MaxSize (integer) --
      
      The maximum number of instances in the Auto Scaling group.
    - DesiredCapacity (integer) --
      
      The number of instances you prefer to maintain in the group.

class AutoScaling.Paginator.DescribeTags¶

paginator = client.get_paginator('describe_tags')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_tags().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

Filters (list) --
One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group ) is 1000.
- (dict) --
  Describes a filter.
  - Name (string) --
    The name of the filter. The valid values are: "auto-scaling-group" , "key" , "value" , and "propagate-at-launch" .
  - Values (list) --
    The value of the filter.
    - (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'ResourceId': 'string',
            'ResourceType': 'string',
            'Key': 'string',
            'Value': 'string',
            'PropagateAtLaunch': True|False
        },
    ],

}

Response Structure

(dict) --
- Tags (list) --
  
  One or more tags.
  - (dict) --
    
    Describes a tag for an Auto Scaling group.
    - ResourceId (string) --
      
      The name of the group.
    - ResourceType (string) --
      
      The type of resource. The only supported value is auto-scaling-group .
    - Key (string) --
      
      The tag key.
    - Value (string) --
      
      The tag value.
    - PropagateAtLaunch (boolean) --
      
      Determines whether the tag is added to new instances as they are launched in the group.

Navigation

Table Of Contents

AutoScaling¶

Client¶

Paginators¶

Navigation

AutoScaling ¶

Client ¶

Paginators ¶