Auto Scaling

{'InstanceId': 'string'}

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

Request Syntax

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

type LifecycleHookName

string

param LifecycleHookName

[REQUIRED]

The name of the lifecycle hook.

type AutoScalingGroupName

string

param AutoScalingGroupName

[REQUIRED]

The name of the group for the lifecycle hook.

type LifecycleActionToken

string

param LifecycleActionToken

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

type LifecycleActionResult

string

param LifecycleActionResult

[REQUIRED]

The action for the group to take. This parameter can be either CONTINUE or ABANDON .

type InstanceId

string

param InstanceId

The ID of the instance.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

{'InstanceId': 'string'}

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

Request Syntax

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

type LifecycleHookName

string

param LifecycleHookName

[REQUIRED]

The name of the lifecycle hook.

type AutoScalingGroupName

string

param AutoScalingGroupName

[REQUIRED]

The name of the Auto Scaling group for the hook.

type LifecycleActionToken

string

param LifecycleActionToken

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

type InstanceId

string

param InstanceId

The ID of the instance.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --