feat(client-cloudformation): CloudFormation now supports GetHookResult API with annotations to retrieve structured compliance check results and remediation guidance for each evaluated resource, replacing the previous single-message limitation with detailed validation outcomes.

Author: awstools

clients/client-cloudformation/README.md

@@ -14,8 +14,8 @@ Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto
 applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
 <p>With CloudFormation, you declare all your resources and dependencies in a template file. The
 template defines a collection of resources as a single unit called a stack. CloudFormation creates
-and deletes all member resources of the stack together and manages all dependencies between the
-resources for you.</p>
+and deletes all member resources of the stack together and manages all dependencies between
+the resources for you.</p>
 <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
 <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
 about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
@@ -574,6 +574,14 @@ GetGeneratedTemplate
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudformation/command/GetGeneratedTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/GetGeneratedTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/GetGeneratedTemplateCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetHookResult
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudformation/command/GetHookResultCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/GetHookResultCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/GetHookResultCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-cloudformation/src/CloudFormation.ts

@@ -220,6 +220,11 @@ import {
   GetGeneratedTemplateCommandInput,
   GetGeneratedTemplateCommandOutput,
 } from "./commands/GetGeneratedTemplateCommand";
+import {
+  GetHookResultCommand,
+  GetHookResultCommandInput,
+  GetHookResultCommandOutput,
+} from "./commands/GetHookResultCommand";
 import {
   GetStackPolicyCommand,
   GetStackPolicyCommandInput,
@@ -450,6 +455,7 @@ const commands = {
   ExecuteChangeSetCommand,
   ExecuteStackRefactorCommand,
   GetGeneratedTemplateCommand,
+  GetHookResultCommand,
   GetStackPolicyCommand,
   GetTemplateCommand,
   GetTemplateSummaryCommand,
@@ -930,7 +936,6 @@ export interface CloudFormation {
   /**
    * @see {@link DescribeStackEventsCommand}
    */
-  describeStackEvents(): Promise<DescribeStackEventsCommandOutput>;
   describeStackEvents(
     args: DescribeStackEventsCommandInput,
     options?: __HttpHandlerOptions
@@ -1229,6 +1234,18 @@ export interface CloudFormation {
     cb: (err: any, data?: GetGeneratedTemplateCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetHookResultCommand}
+   */
+  getHookResult(): Promise<GetHookResultCommandOutput>;
+  getHookResult(args: GetHookResultCommandInput, options?: __HttpHandlerOptions): Promise<GetHookResultCommandOutput>;
+  getHookResult(args: GetHookResultCommandInput, cb: (err: any, data?: GetHookResultCommandOutput) => void): void;
+  getHookResult(
+    args: GetHookResultCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetHookResultCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetStackPolicyCommand}
    */
@@ -1898,16 +1915,16 @@ export interface CloudFormation {
 /**
  * <fullname>CloudFormation</fullname>
  *          <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
- *    repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
- *    Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective
- *    applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
+ *       repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
+ *       Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective
+ *       applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
  *          <p>With CloudFormation, you declare all your resources and dependencies in a template file. The
- *    template defines a collection of resources as a single unit called a stack. CloudFormation creates
- *    and deletes all member resources of the stack together and manages all dependencies between the
- *    resources for you.</p>
+ *       template defines a collection of resources as a single unit called a stack. CloudFormation creates
+ *       and deletes all member resources of the stack together and manages all dependencies between
+ *       the resources for you.</p>
  *          <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
  *          <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
- *    about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
+ *       about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
  * @public
  */
 export class CloudFormation extends CloudFormationClient implements CloudFormation {}

clients/client-cloudformation/src/CloudFormationClient.ts

@@ -186,6 +186,7 @@ import {
   GetGeneratedTemplateCommandInput,
   GetGeneratedTemplateCommandOutput,
 } from "./commands/GetGeneratedTemplateCommand";
+import { GetHookResultCommandInput, GetHookResultCommandOutput } from "./commands/GetHookResultCommand";
 import { GetStackPolicyCommandInput, GetStackPolicyCommandOutput } from "./commands/GetStackPolicyCommand";
 import { GetTemplateCommandInput, GetTemplateCommandOutput } from "./commands/GetTemplateCommand";
 import { GetTemplateSummaryCommandInput, GetTemplateSummaryCommandOutput } from "./commands/GetTemplateSummaryCommand";
@@ -340,6 +341,7 @@ export type ServiceInputTypes =
   | ExecuteChangeSetCommandInput
   | ExecuteStackRefactorCommandInput
   | GetGeneratedTemplateCommandInput
+  | GetHookResultCommandInput
   | GetStackPolicyCommandInput
   | GetTemplateCommandInput
   | GetTemplateSummaryCommandInput
@@ -433,6 +435,7 @@ export type ServiceOutputTypes =
   | ExecuteChangeSetCommandOutput
   | ExecuteStackRefactorCommandOutput
   | GetGeneratedTemplateCommandOutput
+  | GetHookResultCommandOutput
   | GetStackPolicyCommandOutput
   | GetTemplateCommandOutput
   | GetTemplateSummaryCommandOutput
@@ -680,16 +683,16 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
 /**
  * <fullname>CloudFormation</fullname>
  *          <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
- *    repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
- *    Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective
- *    applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
+ *       repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
+ *       Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective
+ *       applications without creating or configuring the underlying Amazon Web Services infrastructure.</p>
  *          <p>With CloudFormation, you declare all your resources and dependencies in a template file. The
- *    template defines a collection of resources as a single unit called a stack. CloudFormation creates
- *    and deletes all member resources of the stack together and manages all dependencies between the
- *    resources for you.</p>
+ *       template defines a collection of resources as a single unit called a stack. CloudFormation creates
+ *       and deletes all member resources of the stack together and manages all dependencies between
+ *       the resources for you.</p>
  *          <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
  *          <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
- *    about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
+ *       about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
  * @public
  */
 export class CloudFormationClient extends __Client<

clients/client-cloudformation/src/commands/ActivateTypeCommand.ts

@@ -37,8 +37,7 @@ export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __Metadat
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public-activate-extension.html">Activate a
  *         third-party public extension in your account</a> in the
  *         <i>CloudFormation User Guide</i>. For information about creating Hooks, see the
- *         <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation
- *         Hooks User Guide</a>.</p>
+ *         <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation Hooks User Guide</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-cloudformation/src/commands/DescribeChangeSetHooksCommand.ts

@@ -27,8 +27,8 @@ export interface DescribeChangeSetHooksCommandInput extends DescribeChangeSetHoo
 export interface DescribeChangeSetHooksCommandOutput extends DescribeChangeSetHooksOutput, __MetadataBearer {}
 
 /**
- * <p>Returns hook-related information for the change set and a list of changes that CloudFormation
- *       makes when you run the change set.</p>
+ * <p>Returns Hook-related information for the change set and a list of changes that
+ *       CloudFormation makes when you run the change set.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-cloudformation/src/commands/DescribeStackEventsCommand.ts

@@ -43,7 +43,7 @@ export interface DescribeStackEventsCommandOutput extends DescribeStackEventsOut
  * const config = {}; // type is CloudFormationClientConfig
  * const client = new CloudFormationClient(config);
  * const input = { // DescribeStackEventsInput
- *   StackName: "STRING_VALUE",
+ *   StackName: "STRING_VALUE", // required
  *   NextToken: "STRING_VALUE",
  * };
  * const command = new DescribeStackEventsCommand(input);

clients/client-cloudformation/src/commands/GetHookResultCommand.ts

@@ -0,0 +1,119 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { CloudFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFormationClient";
+import { commonParams } from "../endpoint/EndpointParameters";
+import { GetHookResultInput, GetHookResultOutput } from "../models/models_0";
+import { GetHookResult } from "../schemas/schemas_0";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetHookResultCommand}.
+ */
+export interface GetHookResultCommandInput extends GetHookResultInput {}
+/**
+ * @public
+ *
+ * The output of {@link GetHookResultCommand}.
+ */
+export interface GetHookResultCommandOutput extends GetHookResultOutput, __MetadataBearer {}
+
+/**
+ * <p>Retrieves detailed information and remediation guidance for a Hook invocation
+ *       result.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { CloudFormationClient, GetHookResultCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
+ * // const { CloudFormationClient, GetHookResultCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
+ * // import type { CloudFormationClientConfig } from "@aws-sdk/client-cloudformation";
+ * const config = {}; // type is CloudFormationClientConfig
+ * const client = new CloudFormationClient(config);
+ * const input = { // GetHookResultInput
+ *   HookResultId: "STRING_VALUE",
+ * };
+ * const command = new GetHookResultCommand(input);
+ * const response = await client.send(command);
+ * // { // GetHookResultOutput
+ * //   HookResultId: "STRING_VALUE",
+ * //   InvocationPoint: "PRE_PROVISION",
+ * //   FailureMode: "FAIL" || "WARN",
+ * //   TypeName: "STRING_VALUE",
+ * //   OriginalTypeName: "STRING_VALUE",
+ * //   TypeVersionId: "STRING_VALUE",
+ * //   TypeConfigurationVersionId: "STRING_VALUE",
+ * //   TypeArn: "STRING_VALUE",
+ * //   Status: "HOOK_IN_PROGRESS" || "HOOK_COMPLETE_SUCCEEDED" || "HOOK_COMPLETE_FAILED" || "HOOK_FAILED",
+ * //   HookStatusReason: "STRING_VALUE",
+ * //   InvokedAt: new Date("TIMESTAMP"),
+ * //   Target: { // HookTarget
+ * //     TargetType: "RESOURCE", // required
+ * //     TargetTypeName: "STRING_VALUE", // required
+ * //     TargetId: "STRING_VALUE", // required
+ * //     Action: "CREATE" || "UPDATE" || "DELETE" || "IMPORT", // required
+ * //   },
+ * //   Annotations: [ // AnnotationList
+ * //     { // Annotation
+ * //       AnnotationName: "STRING_VALUE",
+ * //       Status: "PASSED" || "FAILED" || "SKIPPED",
+ * //       StatusMessage: "STRING_VALUE",
+ * //       RemediationMessage: "STRING_VALUE",
+ * //       RemediationLink: "STRING_VALUE",
+ * //       SeverityLevel: "INFORMATIONAL" || "LOW" || "MEDIUM" || "HIGH" || "CRITICAL",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetHookResultCommandInput - {@link GetHookResultCommandInput}
+ * @returns {@link GetHookResultCommandOutput}
+ * @see {@link GetHookResultCommandInput} for command's `input` shape.
+ * @see {@link GetHookResultCommandOutput} for command's `response` shape.
+ * @see {@link CloudFormationClientResolvedConfig | config} for CloudFormationClient's `config` shape.
+ *
+ * @throws {@link HookResultNotFoundException} (client fault)
+ *  <p>The specified target doesn't have any requested Hook invocations.</p>
+ *
+ * @throws {@link CloudFormationServiceException}
+ * <p>Base exception class for all service exceptions from CloudFormation service.</p>
+ *
+ *
+ * @public
+ */
+export class GetHookResultCommand extends $Command
+  .classBuilder<
+    GetHookResultCommandInput,
+    GetHookResultCommandOutput,
+    CloudFormationClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep(commonParams)
+  .m(function (this: any, Command: any, cs: any, config: CloudFormationClientResolvedConfig, o: any) {
+    return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())];
+  })
+  .s("CloudFormation", "GetHookResult", {})
+  .n("CloudFormationClient", "GetHookResultCommand")
+  .sc(GetHookResult)
+  .build() {
+  /** @internal type navigation helper, not in runtime. */
+  protected declare static __types: {
+    api: {
+      input: GetHookResultInput;
+      output: GetHookResultOutput;
+    };
+    sdk: {
+      input: GetHookResultCommandInput;
+      output: GetHookResultCommandOutput;
+    };
+  };
+}

clients/client-cloudformation/src/commands/ListHookResultsCommand.ts

@@ -40,8 +40,8 @@ export interface ListHookResultsCommandOutput extends ListHookResultsOutput, __M
  *             </li>
  *             <li>
  *                <p>
- *                   <code>TypeArn</code> and <code>Status</code>: Returns summaries for a specific
- *           Hook filtered by status.</p>
+ *                   <code>TypeArn</code> and <code>Status</code>: Returns summaries for a specific Hook
+ *           filtered by status.</p>
  *             </li>
  *             <li>
  *                <p>

clients/client-cloudformation/src/commands/ListStackSetOperationResultsCommand.ts

@@ -5,7 +5,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { CloudFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFormationClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { ListStackSetOperationResultsInput, ListStackSetOperationResultsOutput } from "../models/models_0";
+import { ListStackSetOperationResultsInput, ListStackSetOperationResultsOutput } from "../models/models_1";
 import { ListStackSetOperationResults } from "../schemas/schemas_0";
 
 /**

clients/client-cloudformation/src/commands/ListStackSetOperationsCommand.ts

@@ -5,7 +5,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { CloudFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFormationClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { ListStackSetOperationsInput, ListStackSetOperationsOutput } from "../models/models_0";
+import { ListStackSetOperationsInput, ListStackSetOperationsOutput } from "../models/models_1";
 import { ListStackSetOperations } from "../schemas/schemas_0";
 
 /**