Skip to content

Describe a lifecycle hook.

GET
/v1/projects/{projectId}/asg/groups/{autoScalingGroupId}/hooks/{hookName}
Code sample: Shell / cURL
curl --request GET \
--url https://stratum.example.com/v1/projects/example/asg/groups/example/hooks/example \
--header 'Authorization: Bearer <token>'

Cedar-gated on asg:DescribeAutoScalingGroup.

projectId
required
string
/^p-[a-z0-9-]+$/
autoScalingGroupId
required
string
/^asg-[a-z0-9]+$/
hookName
required
string
/^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$/

The hook.

Media typeapplication/json

A lifecycle hook: a pause on a transition plus an API. A launching hook holds a new instance at Pending:Wait once it is running; a terminating hook holds an instance at Terminating:Wait (deregistered from its target groups, the drain running alongside). Whoever the tenant already runs — the instance agent, a user-data script, their CI — answers with CompleteLifecycleAction, or extends the wait with a heartbeat; a hook nobody answers times out to defaultResult. No auto-fire at 2.0.

object
id
required

lh-…; stable across replacements of the same name.

string
autoScalingGroupId
required
string
name
required
string
transition
required
string
Allowed values: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
defaultResult
required

Applied when the hook times out. On a launching hook ABANDON terminates the instance and the group launches a replacement; on a terminating hook it terminates at once without waiting for the drain.

string
Allowed values: CONTINUE ABANDON
heartbeatTimeoutSeconds
required

The wait, restarted by every heartbeat (30–7200, default 3600).

integer
notificationMetadata

Free-form JSON handed to the caller (surfaced on the instance’s hook state; the platform does not interpret it).

createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example

{
"transition": "autoscaling:EC2_INSTANCE_LAUNCHING",
"defaultResult": "CONTINUE"
}

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}