|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { CloudFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFormationClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { ListHookResultsInput, ListHookResultsOutput } from "../models/models_0"; |
| 10 | +import { de_ListHookResultsCommand, se_ListHookResultsCommand } from "../protocols/Aws_query"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link ListHookResultsCommand}. |
| 21 | + */ |
| 22 | +export interface ListHookResultsCommandInput extends ListHookResultsInput {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link ListHookResultsCommand}. |
| 27 | + */ |
| 28 | +export interface ListHookResultsCommandOutput extends ListHookResultsOutput, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.</p> |
| 32 | + * @example |
| 33 | + * Use a bare-bones client and the command you need to make an API call. |
| 34 | + * ```javascript |
| 35 | + * import { CloudFormationClient, ListHookResultsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import |
| 36 | + * // const { CloudFormationClient, ListHookResultsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import |
| 37 | + * const client = new CloudFormationClient(config); |
| 38 | + * const input = { // ListHookResultsInput |
| 39 | + * TargetType: "CHANGE_SET" || "STACK" || "RESOURCE" || "CLOUD_CONTROL", // required |
| 40 | + * TargetId: "STRING_VALUE", // required |
| 41 | + * NextToken: "STRING_VALUE", |
| 42 | + * }; |
| 43 | + * const command = new ListHookResultsCommand(input); |
| 44 | + * const response = await client.send(command); |
| 45 | + * // { // ListHookResultsOutput |
| 46 | + * // TargetType: "CHANGE_SET" || "STACK" || "RESOURCE" || "CLOUD_CONTROL", |
| 47 | + * // TargetId: "STRING_VALUE", |
| 48 | + * // HookResults: [ // HookResultSummaries |
| 49 | + * // { // HookResultSummary |
| 50 | + * // InvocationPoint: "PRE_PROVISION", |
| 51 | + * // FailureMode: "FAIL" || "WARN", |
| 52 | + * // TypeName: "STRING_VALUE", |
| 53 | + * // TypeVersionId: "STRING_VALUE", |
| 54 | + * // TypeConfigurationVersionId: "STRING_VALUE", |
| 55 | + * // Status: "HOOK_IN_PROGRESS" || "HOOK_COMPLETE_SUCCEEDED" || "HOOK_COMPLETE_FAILED" || "HOOK_FAILED", |
| 56 | + * // HookStatusReason: "STRING_VALUE", |
| 57 | + * // }, |
| 58 | + * // ], |
| 59 | + * // NextToken: "STRING_VALUE", |
| 60 | + * // }; |
| 61 | + * |
| 62 | + * ``` |
| 63 | + * |
| 64 | + * @param ListHookResultsCommandInput - {@link ListHookResultsCommandInput} |
| 65 | + * @returns {@link ListHookResultsCommandOutput} |
| 66 | + * @see {@link ListHookResultsCommandInput} for command's `input` shape. |
| 67 | + * @see {@link ListHookResultsCommandOutput} for command's `response` shape. |
| 68 | + * @see {@link CloudFormationClientResolvedConfig | config} for CloudFormationClient's `config` shape. |
| 69 | + * |
| 70 | + * @throws {@link HookResultNotFoundException} (client fault) |
| 71 | + * <p>The specified target doesn't have any requested Hook invocations.</p> |
| 72 | + * |
| 73 | + * @throws {@link CloudFormationServiceException} |
| 74 | + * <p>Base exception class for all service exceptions from CloudFormation service.</p> |
| 75 | + * |
| 76 | + * @public |
| 77 | + */ |
| 78 | +export class ListHookResultsCommand extends $Command |
| 79 | + .classBuilder< |
| 80 | + ListHookResultsCommandInput, |
| 81 | + ListHookResultsCommandOutput, |
| 82 | + CloudFormationClientResolvedConfig, |
| 83 | + ServiceInputTypes, |
| 84 | + ServiceOutputTypes |
| 85 | + >() |
| 86 | + .ep(commonParams) |
| 87 | + .m(function (this: any, Command: any, cs: any, config: CloudFormationClientResolvedConfig, o: any) { |
| 88 | + return [ |
| 89 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 90 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 91 | + ]; |
| 92 | + }) |
| 93 | + .s("CloudFormation", "ListHookResults", {}) |
| 94 | + .n("CloudFormationClient", "ListHookResultsCommand") |
| 95 | + .f(void 0, void 0) |
| 96 | + .ser(se_ListHookResultsCommand) |
| 97 | + .de(de_ListHookResultsCommand) |
| 98 | + .build() { |
| 99 | + /** @internal type navigation helper, not in runtime. */ |
| 100 | + protected declare static __types: { |
| 101 | + api: { |
| 102 | + input: ListHookResultsInput; |
| 103 | + output: ListHookResultsOutput; |
| 104 | + }; |
| 105 | + sdk: { |
| 106 | + input: ListHookResultsCommandInput; |
| 107 | + output: ListHookResultsCommandOutput; |
| 108 | + }; |
| 109 | + }; |
| 110 | +} |
0 commit comments