@aws-sdk/client-cloudformation 3.50.0 → 3.53.0

package/dist-types/commands/PublishTypeCommand.d.ts

@@ -7,12 +7,10 @@ export interface PublishTypeCommandInput extends PublishTypeInput {
 export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataBearer {
 }
 /**
- * <p>Publishes the specified extension to the CloudFormation registry as a public extension
- *          in this region. Public extensions are available for use by all CloudFormation users. For
- *          more information on publishing extensions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to make them available for public use</a> in the
- *             <i>CloudFormation CLI User Guide</i>.</p>
- *          <p>To publish an extension, you must be registered as a publisher with CloudFormation. For
- *          more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>
+ * <p>Publishes the specified extension to the CloudFormation registry as a public
+ *          extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to make them available for public use</a> in the
+ *                <i>CloudFormation CLI User Guide</i>.</p>
+ *          <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RecordHandlerProgressCommand.d.ts

@@ -8,7 +8,7 @@ export interface RecordHandlerProgressCommandOutput extends RecordHandlerProgres
 }
 /**
  * <p>Reports progress of a resource handler to CloudFormation.</p>
- *          <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. Do not use this API in your code.</p>
+ *          <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. Don't use this API in your code.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RegisterPublisherCommand.d.ts

@@ -7,12 +7,12 @@ export interface RegisterPublisherCommandInput extends RegisterPublisherInput {
 export interface RegisterPublisherCommandOutput extends RegisterPublisherOutput, __MetadataBearer {
 }
 /**
- * <p>Registers your account as a publisher of public extensions in the CloudFormation
- *          registry. Public extensions are available for use by all CloudFormation users. This
- *          publisher ID applies to your account in all Amazon Web Services Regions.</p>
+ * <p>Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.
+ *          This publisher ID applies to your account in all Amazon Web Services Regions.</p>
  *          <p>For information on requirements for registering as a public extension publisher, see
  *             <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Registering your account to publish CloudFormation
- *             extensions</a> in the <i>CloudFormation CLI User Guide</i>.</p>
+ *             extensions</a> in the <i>CloudFormation CLI User
+ *          Guide</i>.</p>
  *          <p></p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/RegisterTypeCommand.d.ts

@@ -11,16 +11,16 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
  *          extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:</p>
  *          <ul>
  *             <li>
- *                <p>Validating the extension schema</p>
+ *                <p>Validating the extension schema.</p>
  *             </li>
  *             <li>
- *                <p>Determining which handlers, if any, have been specified for the extension</p>
+ *                <p>Determining which handlers, if any, have been specified for the extension.</p>
  *             </li>
  *             <li>
- *                <p>Making the extension available for use in your account</p>
+ *                <p>Making the extension available for use in your account.</p>
  *             </li>
  *          </ul>
- *          <p>For more information on how to develop extensions and ready them for registeration, see
+ *          <p>For more information on how to develop extensions and ready them for registration, see
  *             <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html">Creating Resource
  *             Providers</a> in the <i>CloudFormation CLI User
  *          Guide</i>.</p>
@@ -33,8 +33,7 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
  *             </code> to
  *          monitor the progress of the registration request.</p>
  *          <p>Once you have registered a private extension in your account and region, use <a href="AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For
- *          more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the <i>CloudFormation
- *             User Guide</i>.</p>
+ *          more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the <i>CloudFormation User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RollbackStackCommand.d.ts

@@ -9,7 +9,7 @@ export interface RollbackStackCommandOutput extends RollbackStackOutput, __Metad
 /**
  * <p>When specifying <code>RollbackStack</code>, you preserve the state of previously
  *          provisioned resources when an operation fails. You can check the status of the stack
- *          through the <a>DescribeStacks</a> API.</p>
+ *          through the <a>DescribeStacks</a> operation.</p>
  *          <p>Rolls back the specified stack to the last known stable state from
  *             <code>CREATE_FAILED</code> or <code>UPDATE_FAILED</code> stack statuses.</p>
  *          <p>This operation will delete a stack if it doesn't contain a last known stable state. A

package/dist-types/commands/SetTypeConfigurationCommand.d.ts

@@ -7,14 +7,14 @@ export interface SetTypeConfigurationCommandInput extends SetTypeConfigurationIn
 export interface SetTypeConfigurationCommandOutput extends SetTypeConfigurationOutput, __MetadataBearer {
 }
 /**
- * <p>Specifies the configuration data for a registered CloudFormation extension, in the given
- *          account and region.</p>
+ * <p>Specifies the configuration data for a registered CloudFormation extension, in
+ *          the given account and region.</p>
  *          <p>To view the current configuration data for an extension, refer to the
  *             <code>ConfigurationSchema</code> element of <a href="AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.
  *          For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the
  *             <i>CloudFormation User Guide</i>.</p>
  *          <important>
- *             <p>It is strongly recommended that you use dynamic references to restrict sensitive
+ *             <p>It's strongly recommended that you use dynamic references to restrict sensitive
  *             configuration definitions, such as third-party credentials. For more details on dynamic
  *             references, see <a href="https://docs.aws.amazon.com/">Using dynamic references to specify
  *                template values</a> in the <i>CloudFormation User

package/dist-types/commands/SignalResourceCommand.d.ts

@@ -8,8 +8,8 @@ export interface SignalResourceCommandOutput extends __MetadataBearer {
 }
 /**
  * <p>Sends a signal to the specified resource with a success or failure status. You can use
- *          the SignalResource API in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive
- *          the required number of signals or the timeout period is exceeded. The SignalResource API is
+ *          the <code>SignalResource</code> operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive
+ *          the required number of signals or the timeout period is exceeded. The <code>SignalResource</code> operation is
  *          useful in cases where you want to send signals from anywhere other than an Amazon EC2
  *          instance.</p>
  * @example

package/dist-types/commands/StopStackSetOperationCommand.d.ts

@@ -7,7 +7,7 @@ export interface StopStackSetOperationCommandInput extends StopStackSetOperation
 export interface StopStackSetOperationCommandOutput extends StopStackSetOperationOutput, __MetadataBearer {
 }
 /**
- * <p>Stops an in-progress operation on a stack set and its associated stack instances. </p>
+ * <p>Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TestTypeCommand.d.ts

@@ -19,12 +19,11 @@ export interface TestTypeCommandOutput extends TestTypeOutput, __MetadataBearer
  *                requirements.</p>
  *             </li>
  *          </ul>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing">Testing your public extension prior to publishing</a> in the
- *             <i>CloudFormation CLI User Guide</i>.</p>
- *          <p>If you do not specify a version, CloudFormation uses the default version of the
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing">Testing your public extension prior to publishing</a> in the <i>CloudFormation CLI User Guide</i>.</p>
+ *          <p>If you don't specify a version, CloudFormation uses the default version of the
  *          extension in your account and region for testing.</p>
- *          <p>To perform testing, CloudFormation assumes the execution role specified when the type
- *          was registered. For more information, see <a href="AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
+ *          <p>To perform testing, CloudFormation assumes the execution role specified when
+ *          the type was registered. For more information, see <a href="AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
  *          <p>Once you've initiated testing on an extension using <code>TestType</code>, you can use
  *             <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test status and test
  *          status description for the extension.</p>

package/dist-types/commands/UpdateStackCommand.d.ts

@@ -8,7 +8,7 @@ export interface UpdateStackCommandOutput extends UpdateStackOutput, __MetadataB
 }
 /**
  * <p>Updates a stack as specified in the template. After the call completes successfully, the
- *          stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p>
+ *          stack update starts. You can check the status of the stack through the <a>DescribeStacks</a> action.</p>
  *          <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p>
  *          <p>For more information about creating an update template, updating a stack, and monitoring
  *          the progress of the update, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a

package/dist-types/commands/UpdateStackInstancesCommand.d.ts

@@ -8,11 +8,12 @@ export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesO
 }
 /**
  * <p>Updates the parameter values for stack instances for the specified accounts, within the
- *          specified Regions. A stack instance refers to a stack in a specific account and Region. </p>
- *          <p>You can only update stack instances in Regions and accounts where they already exist; to
- *          create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>. </p>
- *          <p>During stack set updates, any parameters overridden for a stack instance are not
- *          updated, but retain their overridden value.</p>
+ *          specified Amazon Web Services Regions. A stack instance refers to a stack in a specific
+ *          account and Region.</p>
+ *          <p>You can only update stack instances in Amazon Web Services Regions and accounts where
+ *          they already exist; to create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>.</p>
+ *          <p>During stack set updates, any parameters overridden for a stack instance aren't updated,
+ *          but retain their overridden value.</p>
  *          <p>You can only update the parameter <i>values</i> that are specified in the
  *          stack set; to add or delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the stack set template. If you add a parameter to a
  *          template, before you can override the parameter value specified in the stack set you must

package/dist-types/commands/UpdateStackSetCommand.d.ts

@@ -8,7 +8,7 @@ export interface UpdateStackSetCommandOutput extends UpdateStackSetOutput, __Met
 }
 /**
  * <p>Updates the stack set, and associated stack instances in the specified accounts and
- *          Regions.</p>
+ *             Amazon Web Services Regions.</p>
  *          <p>Even if the stack set operation created by updating the stack set fails (completely or
  *          partially, below or above a specified failure tolerance), the stack set is updated with
  *          your changes. Subsequent <a>CreateStackInstances</a> calls on the specified

package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts

@@ -12,7 +12,7 @@ export interface UpdateTerminationProtectionCommandOutput extends UpdateTerminat
  *          unchanged. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a
  *             Stack From Being Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
  *          <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested
- *             stacks</a>, termination protection is set on the root stack and cannot be changed
+ *             stacks</a>, termination protection is set on the root stack and can't be changed
  *          directly on the nested stack.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/index.d.ts

@@ -14,6 +14,7 @@ export * from "./DeleteStackSetCommand";
 export * from "./DeregisterTypeCommand";
 export * from "./DescribeAccountLimitsCommand";
 export * from "./DescribeChangeSetCommand";
+export * from "./DescribeChangeSetHooksCommand";
 export * from "./DescribePublisherCommand";
 export * from "./DescribeStackDriftDetectionStatusCommand";
 export * from "./DescribeStackEventsCommand";

package/dist-types/index.d.ts

@@ -4,3 +4,4 @@ export * from "./commands";
 export * from "./models";
 export * from "./pagination";
 export * from "./waiters";
+export { CloudFormationServiceException } from "./models/CloudFormationServiceException";

package/dist-types/models/CloudFormationServiceException.d.ts

@@ -0,0 +1,10 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * Base exception class for all service exceptions from CloudFormation service.
+ */
+export declare class CloudFormationServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}