Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can click “Customize cookies” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To continue without accepting these cookies, click “Continue without accepting.” To make more detailed choices or learn more, click “Customize cookies.”

Skip to content

/AWS1/CL_ASC=>COMPLETELIFECYCLEACTION()

About CompleteLifecycleAction

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:

  1. (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

  2. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

  3. (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.

  4. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  5. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.

  6. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.

Method Signature

IMPORTING

Required arguments:

IV_LIFECYCLEHOOKNAME TYPE /AWS1/ASCASCIISTRINGMAXLEN255 /AWS1/ASCASCIISTRINGMAXLEN255

The name of the lifecycle hook.

IV_AUTOSCALINGGROUPNAME TYPE /AWS1/ASCRESOURCENAME /AWS1/ASCRESOURCENAME

The name of the Auto Scaling group.

IV_LIFECYCLEACTIONRESULT TYPE /AWS1/ASCLIFECYCLEACTIONRESULT /AWS1/ASCLIFECYCLEACTIONRESULT

The action for the group to take. You can specify either CONTINUE or ABANDON.

Optional arguments:

IV_LIFECYCLEACTIONTOKEN TYPE /AWS1/ASCLIFECYCLEACTIONTOKEN /AWS1/ASCLIFECYCLEACTIONTOKEN

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.

IV_INSTANCEID TYPE /AWS1/ASCXMLSTRINGMAXLEN19 /AWS1/ASCXMLSTRINGMAXLEN19

The ID of the instance.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_ASCCOMPLLCACTANSWER /AWS1/CL_ASCCOMPLLCACTANSWER

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC