RecordLifecycleActionHeartbeat (smaws-clients.Smaws_Client_AutoScaling.RecordLifecycleActionHeartbeat)

Module Smaws_Client_AutoScaling.RecordLifecycleActionHeartbeat

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.

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsQuery.error
  | `ResourceContentionFault of Types.resource_contention_fault ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.record_lifecycle_action_heartbeat_type ->
  (Types.record_lifecycle_action_heartbeat_answer,
    [> Smaws_Lib.Protocols.AwsQuery.error
    | `ResourceContentionFault of Types.resource_contention_fault ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.record_lifecycle_action_heartbeat_type ->
  (Types.record_lifecycle_action_heartbeat_answer Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsQuery.error
    | `ResourceContentionFault of Types.resource_contention_fault ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result