Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

RecordLifecycleActionHeartbeatCommand

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 the PutLifecycleHook API call.

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

(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.
(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.
(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 wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AutoScalingClient, RecordLifecycleActionHeartbeatCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, RecordLifecycleActionHeartbeatCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // RecordLifecycleActionHeartbeatType
  LifecycleHookName: "STRING_VALUE", // required
  AutoScalingGroupName: "STRING_VALUE", // required
  LifecycleActionToken: "STRING_VALUE",
  InstanceId: "STRING_VALUE",
};
const command = new RecordLifecycleActionHeartbeatCommand(input);
const response = await client.send(command);
// {};

Example Usage

There was an error loading the code editor. Retry

RecordLifecycleActionHeartbeatCommand Input

See RecordLifecycleActionHeartbeatCommandInput for more details

Parameter	Type	Description
`AutoScalingGroupName` Required	`string \| undefined`	The name of the Auto Scaling group.
`LifecycleHookName` Required	`string \| undefined`	The name of the lifecycle hook.
`InstanceId`	`string \| undefined`	The ID of the instance.
`LifecycleActionToken`	`string \| undefined`	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.

RecordLifecycleActionHeartbeatCommand Output

See RecordLifecycleActionHeartbeatCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.

Throws

Name	Fault	Details
ResourceContentionFault	server	You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
AutoScalingServiceException		Base exception class for all service exceptions from AutoScaling service.

Getting Started