AWS API Changes

2018/02/20 - Auto Scaling - 3 updated api methods

Changes Update autoscaling client to latest version

CreateAutoScalingGroup (updated)

Link ¶
Changes (request)

{'ServiceLinkedRoleARN': 'string'}

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

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

See also: AWS API Documentation

Request Syntax

client.create_auto_scaling_group(
    AutoScalingGroupName='string',
    LaunchConfigurationName='string',
    LaunchTemplate={
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'Version': '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'
)

type AutoScalingGroupName:

string

param AutoScalingGroupName:

[REQUIRED]

The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.

type LaunchConfigurationName:

string

param LaunchConfigurationName:

The name of the launch configuration. You must specify one of the following: a launch configuration, a launch template, or an EC2 instance.

type LaunchTemplate:

dict

param LaunchTemplate:

The launch template to use to launch instances. You must specify one of the following: a launch template, a launch configuration, or an EC2 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, Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

type InstanceId:

string

param InstanceId:

The ID of the instance used to create a launch configuration for the group. You must specify one of the following: an EC2 instance, a launch configuration, or a launch template.

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

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

type MinSize:

integer

param MinSize:

[REQUIRED]

The minimum size of the group.

type MaxSize:

integer

param MaxSize:

[REQUIRED]

The maximum size of the group.

type DesiredCapacity:

integer

param DesiredCapacity:

The number of EC2 instances that should be running in the 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. If you do not specify a desired capacity, the default is the minimum size of the group.

type DefaultCooldown:

integer

param DefaultCooldown:

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

type AvailabilityZones:

list

param AvailabilityZones:

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

(string) --

type LoadBalancerNames:

list

param LoadBalancerNames:

One or more Classic Load Balancers. To specify an Application Load Balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.

(string) --

type TargetGroupARNs:

list

param TargetGroupARNs:

The Amazon Resource Names (ARN) of the target groups.

(string) --

type HealthCheckType:

string

param HealthCheckType:

The service to use for the health checks. The valid values are EC2 and ELB.

By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.

type HealthCheckGracePeriod:

integer

param HealthCheckGracePeriod:

The amount of time, in seconds, that 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 is 0.

This parameter is required if you are adding an ELB health check.

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

type PlacementGroup:

string

param PlacementGroup:

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

type VPCZoneIdentifier:

string

param VPCZoneIdentifier:

A comma-separated list of subnet identifiers for your virtual private cloud (VPC).

If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

type TerminationPolicies:

list

param TerminationPolicies:

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

(string) --

type NewInstancesProtectedFromScaleIn:

boolean

param NewInstancesProtectedFromScaleIn:

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

type LifecycleHookSpecificationList:

list

param LifecycleHookSpecificationList:

One or more lifecycle hooks.

(dict) --

Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.

For more information, see Auto Scaling Lifecycle Hooks in the Auto Scaling User Guide.
- 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. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
- NotificationMetadata (string) --
  
  Additional information that you want to include any time 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, Auto Scaling performs the default action. 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.
- NotificationTargetARN (string) --
  
  The ARN of the target that 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.

type Tags:

list

param Tags:

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the 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.

type ServiceLinkedRoleARN:

string

param ServiceLinkedRoleARN:

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, Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist.

returns:

None

DescribeAutoScalingGroups (updated)

Link ¶
Changes (response)

{'AutoScalingGroups': {'ServiceLinkedRoleARN': 'string'}}

Describes one or more Auto Scaling groups.

See also: AWS API Documentation

Request Syntax

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

type AutoScalingGroupNames:

list

param AutoScalingGroupNames:

The names of the Auto Scaling groups. If you omit this parameter, all Auto Scaling groups are described.

(string) --

type NextToken:

string

param NextToken:

The token for the next set of items to return. (You received this token from a previous call.)

type MaxRecords:

integer

param MaxRecords:

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

rtype:

dict

returns:

Response Syntax

{
    'AutoScalingGroups': [
        {
            'AutoScalingGroupName': 'string',
            'AutoScalingGroupARN': 'string',
            'LaunchConfigurationName': 'string',
            'LaunchTemplate': {
                'LaunchTemplateId': 'string',
                'LaunchTemplateName': 'string',
                'Version': '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, Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
    - 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.
    - HealthCheckGracePeriod (integer) --
      
      The amount of time, in seconds, that 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. Note that 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 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, Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, 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 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 Auto 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 you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.
    - VPCZoneIdentifier (string) --
      
      One or more subnet IDs, if applicable, separated by commas.
      
      If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.
    - 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 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) --
  
  The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

UpdateAutoScalingGroup (updated)

Link ¶
Changes (request)

{'ServiceLinkedRoleARN': 'string'}

Updates the configuration for the specified Auto Scaling group.

The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.

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

Note the following:

If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize.
All other optional parameters are left unchanged if not specified.