DescribeLifecycleHooksCommand

Suggest an Edit

Gets information about the lifecycle hooks for the specified Auto Scaling group.

Example Syntax

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

import { AutoScalingClient, DescribeLifecycleHooksCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, DescribeLifecycleHooksCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // DescribeLifecycleHooksType
  AutoScalingGroupName: "STRING_VALUE", // required
  LifecycleHookNames: [ // LifecycleHookNames
    "STRING_VALUE",
  ],
};
const command = new DescribeLifecycleHooksCommand(input);
const response = await client.send(command);
// { // DescribeLifecycleHooksAnswer
//   LifecycleHooks: [ // LifecycleHooks
//     { // LifecycleHook
//       LifecycleHookName: "STRING_VALUE",
//       AutoScalingGroupName: "STRING_VALUE",
//       LifecycleTransition: "STRING_VALUE",
//       NotificationTargetARN: "STRING_VALUE",
//       RoleARN: "STRING_VALUE",
//       NotificationMetadata: "STRING_VALUE",
//       HeartbeatTimeout: Number("int"),
//       GlobalTimeout: Number("int"),
//       DefaultResult: "STRING_VALUE",
//     },
//   ],
// };

Example Usage

 Loading code editor

DescribeLifecycleHooksCommand Input

See DescribeLifecycleHooksCommandInput for more details

Parameter
Type
Description
AutoScalingGroupName
Required
string | undefined

The name of the Auto Scaling group.

LifecycleHookNames
string[] | undefined

The names of one or more lifecycle hooks. If you omit this property, all lifecycle hooks are described.

DescribeLifecycleHooksCommand Output

See DescribeLifecycleHooksCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LifecycleHooks
LifecycleHook[] | undefined

The lifecycle hooks for the specified group.

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.