Skip to content

Commit 61ad5ad

Browse files
author
awstools
committed
feat(client-cloudformation): ListHookResults API now supports retrieving invocation results for all CloudFormation Hooks (previously limited to create change set and Cloud Control operations) with new optional parameters for filtering by Hook status and ARN.
1 parent 0bdbd8e commit 61ad5ad

35 files changed

+1090
-843
lines changed

clients/client-cloudformation/src/CloudFormation.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,6 +1337,7 @@ export interface CloudFormation {
13371337
/**
13381338
* @see {@link ListHookResultsCommand}
13391339
*/
1340+
listHookResults(): Promise<ListHookResultsCommandOutput>;
13401341
listHookResults(
13411342
args: ListHookResultsCommandInput,
13421343
options?: __HttpHandlerOptions

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,18 @@ export interface ActivateTypeCommandInput extends ActivateTypeInput {}
2828
export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Activates a public third-party extension, making it available for use in stack templates.
32-
* Once you have activated a public third-party extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For
33-
* more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
34-
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
31+
* <p>Activates a public third-party extension, such as a resource or module, to make it
32+
* available for use in stack templates in your current account and Region. It can also create
33+
* CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation
34+
* provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.</p>
35+
* <p>After you activate an extension, you can use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to set specific properties for the extension.</p>
36+
* <p>To see which extensions have been activated, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html">ListTypes</a>. To see
37+
* configuration details for an extension, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>
38+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public-activate-extension.html">Activate a
39+
* third-party public extension in your account</a> in the
40+
* <i>CloudFormation User Guide</i>. For information about creating Hooks, see the
41+
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html">CloudFormation
42+
* Hooks User Guide</a>.</p>
3543
* @example
3644
* Use a bare-bones client and the command you need to make an API call.
3745
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface BatchDescribeTypeConfigurationsCommandOutput
3434

3535
/**
3636
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation
37-
* registry for the account and Region.</p>
37+
* registry in your current account and Region.</p>
3838
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html">Edit configuration
3939
* data for extensions in your account</a> in the
4040
* <i>CloudFormation User Guide</i>.</p>

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

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,18 @@ export interface ContinueUpdateRollbackCommandInput extends ContinueUpdateRollba
2828
export interface ContinueUpdateRollbackCommandOutput extends ContinueUpdateRollbackOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues
32-
* rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of
33-
* the failure, you can manually <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed">fix the error</a> and continue the rollback. By continuing the rollback, you can return
34-
* your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try
31+
* <p>Continues rolling back a stack from <code>UPDATE_ROLLBACK_FAILED</code> to
32+
* <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can
33+
* manually fix the error and continue the rollback. By continuing the rollback, you can return
34+
* your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state) and then try
3535
* to update the stack again.</p>
36-
* <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll
37-
* back all changes after a failed stack update. For example, you might have a stack that's
38-
* rolling back to an old database instance that was deleted outside of CloudFormation. Because
39-
* CloudFormation doesn't know the database was deleted, it assumes that the database instance still
40-
* exists and attempts to roll back to it, causing the update rollback to fail.</p>
36+
* <p>A stack enters the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll
37+
* back all changes after a failed stack update. For example, this might occur when a stack
38+
* attempts to roll back to an old database that was deleted outside of CloudFormation. Because
39+
* CloudFormation doesn't know the instance was deleted, it assumes the instance still exists and
40+
* attempts to roll back to it, causing the update rollback to fail.</p>
41+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html">Continue rolling back an update</a> in the <i>CloudFormation User Guide</i>. For
42+
* information for troubleshooting a failed update rollback, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed">Update rollback failed</a>.</p>
4143
* @example
4244
* Use a bare-bones client and the command you need to make an API call.
4345
* ```javascript

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,14 @@ export interface CreateStackInstancesCommandOutput extends CreateStackInstancesO
122122
* <p>The specified operation ID already exists.</p>
123123
*
124124
* @throws {@link OperationInProgressException} (client fault)
125-
* <p>Another operation is currently in progress for this stack set. Only one operation can be performed for a stack
125+
* <p>Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack
126126
* set at a given time.</p>
127127
*
128128
* @throws {@link StackSetNotFoundException} (client fault)
129-
* <p>The specified stack set doesn't exist.</p>
129+
* <p>The specified StackSet doesn't exist.</p>
130130
*
131131
* @throws {@link StaleRequestException} (client fault)
132-
* <p>Another operation has been performed on this stack set since the specified operation was performed.</p>
132+
* <p>Another operation has been performed on this StackSet since the specified operation was performed.</p>
133133
*
134134
* @throws {@link CloudFormationServiceException}
135135
* <p>Base exception class for all service exceptions from CloudFormation service.</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface CreateStackSetCommandInput extends CreateStackSetInput {}
2828
export interface CreateStackSetCommandOutput extends CreateStackSetOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a stack set.</p>
31+
* <p>Creates a StackSet.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,15 @@ export interface DeactivateTypeCommandInput extends DeactivateTypeInput {}
2828
export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deactivates a public extension that was previously activated in this account and
32-
* Region.</p>
31+
* <p>Deactivates a public third-party extension, such as a resource or module, or a CloudFormation
32+
* Hook when you no longer use it.</p>
33+
* <p>Deactivating an extension deletes the configuration details that are associated with it.
34+
* To temporary disable a CloudFormation Hook instead, you can use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a>.</p>
3335
* <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes
3436
* stack update operations where the stack template includes the extension, even if no updates
3537
* are being made to the extension. In addition, deactivated extensions aren't automatically
3638
* updated if a new version of the extension is released.</p>
39+
* <p>To see which extensions are currently activated, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html">ListTypes</a>.</p>
3740
* @example
3841
* Use a bare-bones client and the command you need to make an API call.
3942
* ```javascript

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,14 @@ export interface DeleteStackInstancesCommandOutput extends DeleteStackInstancesO
107107
* <p>The specified operation ID already exists.</p>
108108
*
109109
* @throws {@link OperationInProgressException} (client fault)
110-
* <p>Another operation is currently in progress for this stack set. Only one operation can be performed for a stack
110+
* <p>Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack
111111
* set at a given time.</p>
112112
*
113113
* @throws {@link StackSetNotFoundException} (client fault)
114-
* <p>The specified stack set doesn't exist.</p>
114+
* <p>The specified StackSet doesn't exist.</p>
115115
*
116116
* @throws {@link StaleRequestException} (client fault)
117-
* <p>Another operation has been performed on this stack set since the specified operation was performed.</p>
117+
* <p>Another operation has been performed on this StackSet since the specified operation was performed.</p>
118118
*
119119
* @throws {@link CloudFormationServiceException}
120120
* <p>Base exception class for all service exceptions from CloudFormation service.</p>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface DeleteStackSetCommandInput extends DeleteStackSetInput {}
2828
export interface DeleteStackSetCommandOutput extends DeleteStackSetOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a stack set. Before you can delete a stack set, all its member stack instances
32-
* must be deleted. For more information about how to complete this, see <a>DeleteStackInstances</a>.</p>
31+
* <p>Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must
32+
* be deleted. For more information about how to complete this, see <a>DeleteStackInstances</a>.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript
@@ -53,12 +53,12 @@ export interface DeleteStackSetCommandOutput extends DeleteStackSetOutput, __Met
5353
* @see {@link CloudFormationClientResolvedConfig | config} for CloudFormationClient's `config` shape.
5454
*
5555
* @throws {@link OperationInProgressException} (client fault)
56-
* <p>Another operation is currently in progress for this stack set. Only one operation can be performed for a stack
56+
* <p>Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack
5757
* set at a given time.</p>
5858
*
5959
* @throws {@link StackSetNotEmptyException} (client fault)
60-
* <p>You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack
61-
* instances from the stack set before deleting the stack set.</p>
60+
* <p>You can't yet delete this StackSet, because it still contains one or more stack instances. Delete all stack
61+
* instances from the StackSet before deleting the StackSet.</p>
6262
*
6363
* @throws {@link CloudFormationServiceException}
6464
* <p>Base exception class for all service exceptions from CloudFormation service.</p>

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __Met
3939
* of that extension. If you do deregister the default version of an extension, the extension
4040
* type itself is deregistered as well and marked as deprecated.</p>
4141
* <p>To view the deprecation status of an extension or extension version, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>
42+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.html">Remove
43+
* third-party private extensions from your account</a> in the
44+
* <i>CloudFormation User Guide</i>.</p>
4245
* @example
4346
* Use a bare-bones client and the command you need to make an API call.
4447
* ```javascript

0 commit comments

Comments
 (0)