# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [ActivateOrganizationsAccess](API_ActivateOrganizationsAccess.md) 
+  [ActivateType](API_ActivateType.md) 
+  [BatchDescribeTypeConfigurations](API_BatchDescribeTypeConfigurations.md) 
+  [CancelUpdateStack](API_CancelUpdateStack.md) 
+  [ContinueUpdateRollback](API_ContinueUpdateRollback.md) 
+  [CreateChangeSet](API_CreateChangeSet.md) 
+  [CreateGeneratedTemplate](API_CreateGeneratedTemplate.md) 
+  [CreateStack](API_CreateStack.md) 
+  [CreateStackInstances](API_CreateStackInstances.md) 
+  [CreateStackRefactor](API_CreateStackRefactor.md) 
+  [CreateStackSet](API_CreateStackSet.md) 
+  [DeactivateOrganizationsAccess](API_DeactivateOrganizationsAccess.md) 
+  [DeactivateType](API_DeactivateType.md) 
+  [DeleteChangeSet](API_DeleteChangeSet.md) 
+  [DeleteGeneratedTemplate](API_DeleteGeneratedTemplate.md) 
+  [DeleteStack](API_DeleteStack.md) 
+  [DeleteStackInstances](API_DeleteStackInstances.md) 
+  [DeleteStackSet](API_DeleteStackSet.md) 
+  [DeregisterType](API_DeregisterType.md) 
+  [DescribeAccountLimits](API_DescribeAccountLimits.md) 
+  [DescribeChangeSet](API_DescribeChangeSet.md) 
+  [DescribeChangeSetHooks](API_DescribeChangeSetHooks.md) 
+  [DescribeEvents](API_DescribeEvents.md) 
+  [DescribeGeneratedTemplate](API_DescribeGeneratedTemplate.md) 
+  [DescribeOrganizationsAccess](API_DescribeOrganizationsAccess.md) 
+  [DescribePublisher](API_DescribePublisher.md) 
+  [DescribeResourceScan](API_DescribeResourceScan.md) 
+  [DescribeStackDriftDetectionStatus](API_DescribeStackDriftDetectionStatus.md) 
+  [DescribeStackEvents](API_DescribeStackEvents.md) 
+  [DescribeStackInstance](API_DescribeStackInstance.md) 
+  [DescribeStackRefactor](API_DescribeStackRefactor.md) 
+  [DescribeStackResource](API_DescribeStackResource.md) 
+  [DescribeStackResourceDrifts](API_DescribeStackResourceDrifts.md) 
+  [DescribeStackResources](API_DescribeStackResources.md) 
+  [DescribeStacks](API_DescribeStacks.md) 
+  [DescribeStackSet](API_DescribeStackSet.md) 
+  [DescribeStackSetOperation](API_DescribeStackSetOperation.md) 
+  [DescribeType](API_DescribeType.md) 
+  [DescribeTypeRegistration](API_DescribeTypeRegistration.md) 
+  [DetectStackDrift](API_DetectStackDrift.md) 
+  [DetectStackResourceDrift](API_DetectStackResourceDrift.md) 
+  [DetectStackSetDrift](API_DetectStackSetDrift.md) 
+  [EstimateTemplateCost](API_EstimateTemplateCost.md) 
+  [ExecuteChangeSet](API_ExecuteChangeSet.md) 
+  [ExecuteStackRefactor](API_ExecuteStackRefactor.md) 
+  [GetGeneratedTemplate](API_GetGeneratedTemplate.md) 
+  [GetHookResult](API_GetHookResult.md) 
+  [GetStackPolicy](API_GetStackPolicy.md) 
+  [GetTemplate](API_GetTemplate.md) 
+  [GetTemplateSummary](API_GetTemplateSummary.md) 
+  [ImportStacksToStackSet](API_ImportStacksToStackSet.md) 
+  [ListChangeSets](API_ListChangeSets.md) 
+  [ListExports](API_ListExports.md) 
+  [ListGeneratedTemplates](API_ListGeneratedTemplates.md) 
+  [ListHookResults](API_ListHookResults.md) 
+  [ListImports](API_ListImports.md) 
+  [ListResourceScanRelatedResources](API_ListResourceScanRelatedResources.md) 
+  [ListResourceScanResources](API_ListResourceScanResources.md) 
+  [ListResourceScans](API_ListResourceScans.md) 
+  [ListStackInstanceResourceDrifts](API_ListStackInstanceResourceDrifts.md) 
+  [ListStackInstances](API_ListStackInstances.md) 
+  [ListStackRefactorActions](API_ListStackRefactorActions.md) 
+  [ListStackRefactors](API_ListStackRefactors.md) 
+  [ListStackResources](API_ListStackResources.md) 
+  [ListStacks](API_ListStacks.md) 
+  [ListStackSetAutoDeploymentTargets](API_ListStackSetAutoDeploymentTargets.md) 
+  [ListStackSetOperationResults](API_ListStackSetOperationResults.md) 
+  [ListStackSetOperations](API_ListStackSetOperations.md) 
+  [ListStackSets](API_ListStackSets.md) 
+  [ListTypeRegistrations](API_ListTypeRegistrations.md) 
+  [ListTypes](API_ListTypes.md) 
+  [ListTypeVersions](API_ListTypeVersions.md) 
+  [PublishType](API_PublishType.md) 
+  [RecordHandlerProgress](API_RecordHandlerProgress.md) 
+  [RegisterPublisher](API_RegisterPublisher.md) 
+  [RegisterType](API_RegisterType.md) 
+  [RollbackStack](API_RollbackStack.md) 
+  [SetStackPolicy](API_SetStackPolicy.md) 
+  [SetTypeConfiguration](API_SetTypeConfiguration.md) 
+  [SetTypeDefaultVersion](API_SetTypeDefaultVersion.md) 
+  [SignalResource](API_SignalResource.md) 
+  [StartResourceScan](API_StartResourceScan.md) 
+  [StopStackSetOperation](API_StopStackSetOperation.md) 
+  [TestType](API_TestType.md) 
+  [UpdateGeneratedTemplate](API_UpdateGeneratedTemplate.md) 
+  [UpdateStack](API_UpdateStack.md) 
+  [UpdateStackInstances](API_UpdateStackInstances.md) 
+  [UpdateStackSet](API_UpdateStackSet.md) 
+  [UpdateTerminationProtection](API_UpdateTerminationProtection.md) 
+  [ValidateTemplate](API_ValidateTemplate.md) 

# ActivateOrganizationsAccess
<a name="API_ActivateOrganizationsAccess"></a>

Activate trusted access with AWS Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.

## Errors
<a name="API_ActivateOrganizationsAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationNotFound **   
The specified ID refers to an operation that doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_ActivateOrganizationsAccess_Examples"></a>

### ActivateOrganizationsAccess
<a name="API_ActivateOrganizationsAccess_Example_1"></a>

This example illustrates one usage of ActivateOrganizationsAccess.

#### Sample Request
<a name="API_ActivateOrganizationsAccess_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
    ?Action=ActivateOrganizationsAccess
```

#### Sample Response
<a name="API_ActivateOrganizationsAccess_Example_1_Response"></a>

```
<ActivateOrganizationsAccessResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <ActivateOrganizationsAccessResult/>
  <ResponseMetadata>
    <RequestId>f2038c6a-2ef6-45d0-a045-f2b4d15647ba</RequestId>
  </ResponseMetadata>
</ActivateOrganizationsAccessResponse>
```

## See Also
<a name="API_ActivateOrganizationsAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ActivateOrganizationsAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ActivateOrganizationsAccess) 

# ActivateType
<a name="API_ActivateType"></a>

Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It can also create CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations.

After you activate an extension, you can use [SetTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) to set specific properties for the extension.

To see which extensions have been activated, use [ListTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html). To see configuration details for an extension, use [DescribeType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html).

For more information, see [Activate a third-party public extension in your account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public-activate-extension.html) in the * AWS CloudFormation User Guide*. For information about creating Hooks, see the [CloudFormation Hooks User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html).

## Request Parameters
<a name="API_ActivateType_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** AutoUpdate **   
Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher. Major versions released by the publisher must be manually updated.  
The default is `true`.  
Type: Boolean  
Required: No

 ** ExecutionRoleArn **   
The name of the IAM execution role to use to activate the extension.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `arn:.+:iam::[0-9]{12}:role/.+`   
Required: No

 ** LoggingConfig **   
Contains logging configuration information for an extension.  
Type: [LoggingConfig](API_LoggingConfig.md) object  
Required: No

 ** MajorVersion **   
The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available *minor* version of the major version selected.  
You can specify `MajorVersion` or `VersionBump`, but not both.  
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 100000.  
Required: No

 ** PublicTypeArn **   
The Amazon Resource Name (ARN) of the public extension.  
Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}::type/.+/[0-9a-zA-Z]{12,40}/.+`   
Required: No

 ** PublisherId **   
The ID of the extension publisher.  
Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Pattern: `[0-9a-zA-Z]{12,40}`   
Required: No

 ** Type **   
The extension type.  
Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension.  
Conditional: You must specify `PublicTypeArn`, or `TypeName`, `Type`, and `PublisherId`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

 ** TypeNameAlias **   
An alias to assign to the public extension in this account and Region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.  
An extension alias must be unique within a given account and Region. You can activate the same public resource multiple times in the same account and Region, using different type name aliases.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

 ** VersionBump **   
Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of `AutoUpdate`.  
+  `MAJOR`: CloudFormation updates the extension to the newest major version, if one is available.
+  `MINOR`: CloudFormation updates the extension to the newest minor version, if one is available.
Type: String  
Valid Values: `MAJOR | MINOR`   
Required: No

## Response Elements
<a name="API_ActivateType_ResponseElements"></a>

The following element is returned by the service.

 ** Arn **   
The Amazon Resource Name (ARN) of the activated extension in this account and Region.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+` 

## Errors
<a name="API_ActivateType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## See Also
<a name="API_ActivateType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ActivateType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ActivateType) 

# BatchDescribeTypeConfigurations
<a name="API_BatchDescribeTypeConfigurations"></a>

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region.

For more information, see [Edit configuration data for extensions in your account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_BatchDescribeTypeConfigurations_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **TypeConfigurationIdentifiers.member.N**   
The list of identifiers for the desired extension configurations.  
Type: Array of [TypeConfigurationIdentifier](API_TypeConfigurationIdentifier.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Elements
<a name="API_BatchDescribeTypeConfigurations_ResponseElements"></a>

The following elements are returned by the service.

 **Errors.member.N**   
A list of information concerning any errors generated during the setting of the specified configurations.  
Type: Array of [BatchDescribeTypeConfigurationsError](API_BatchDescribeTypeConfigurationsError.md) objects

 **TypeConfigurations.member.N**   
A list of any of the specified extension configurations from the CloudFormation registry.  
Type: Array of [TypeConfigurationDetails](API_TypeConfigurationDetails.md) objects

 **UnprocessedTypeConfigurations.member.N**   
A list of any of the specified extension configurations that CloudFormation could not process for any reason.  
Type: Array of [TypeConfigurationIdentifier](API_TypeConfigurationIdentifier.md) objects

## Errors
<a name="API_BatchDescribeTypeConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeConfigurationNotFound **   
The specified extension configuration can't be found.  
HTTP Status Code: 404

## See Also
<a name="API_BatchDescribeTypeConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/BatchDescribeTypeConfigurations) 

# CancelUpdateStack
<a name="API_CancelUpdateStack"></a>

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

**Note**  
You can cancel only stacks that are in the `UPDATE_IN_PROGRESS` state.

## Request Parameters
<a name="API_CancelUpdateStack_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ClientRequestToken **   
A unique identifier for this `CancelUpdateStack` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry `CancelUpdateStack` requests to ensure that CloudFormation successfully received them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** StackName **   
If you don't pass a parameter to `StackName`, the API returns a response that describes all resources in the account.  
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:  
 `{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }` 
The name or the unique stack ID that's associated with the stack.  
Type: String  
Required: Yes

## Errors
<a name="API_CancelUpdateStack_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** TokenAlreadyExists **   
A client request token already exists.  
HTTP Status Code: 400

## Examples
<a name="API_CancelUpdateStack_Examples"></a>

### CancelUpdateStack
<a name="API_CancelUpdateStack_Example_1"></a>

This example illustrates one usage of CancelUpdateStack.

#### Sample Request
<a name="API_CancelUpdateStack_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=CancelUpdateStack
 &StackName=MyStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_CancelUpdateStack_Example_1_Response"></a>

```
<CancelUpdateStackResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ResponseMetadata>
    <RequestId>5ccc7dcd-744c-11e5-be70-1b08c228efb3</RequestId>
  </ResponseMetadata>
</CancelUpdateStackResponse>
```

## See Also
<a name="API_CancelUpdateStack_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/CancelUpdateStack) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/CancelUpdateStack) 

# ContinueUpdateRollback
<a name="API_ContinueUpdateRollback"></a>

Continues rolling back a stack from `UPDATE_ROLLBACK_FAILED` to `UPDATE_ROLLBACK_COMPLETE` state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the `UPDATE_ROLLBACK_COMPLETE` state) and then try to update the stack again.

A stack enters the `UPDATE_ROLLBACK_FAILED` state when CloudFormation can't roll back all changes after a failed stack update. For example, this might occur when a stack attempts to roll back to an old database that was deleted outside of CloudFormation. Because CloudFormation doesn't know the instance was deleted, it assumes the instance still exists and attempts to roll back to it, causing the update rollback to fail.

For more information, see [Continue rolling back an update](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) in the * AWS CloudFormation User Guide*. For information for troubleshooting a failed update rollback, see [Update rollback failed](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed).

## Request Parameters
<a name="API_ContinueUpdateRollback_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ClientRequestToken **   
A unique identifier for this `ContinueUpdateRollback` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry `ContinueUpdateRollback` requests to ensure that CloudFormation successfully received them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 **ResourcesToSkip.member.N**   
A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the `UPDATE_FAILED` state because a rollback failed. You can't specify resources that are in the `UPDATE_FAILED` state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the [DescribeStackResources](API_DescribeStackResources.md) action, and view the resource status reason.  
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you [ troubleshoot](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) resources before skipping them. CloudFormation sets the status of the specified resources to `UPDATE_COMPLETE` and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.  
To skip resources that are part of nested stacks, use the following format: `NestedStackName.ResourceLogicalID`. If you want to specify the logical ID of a stack resource (`Type: AWS::CloudFormation::Stack`) in the `ResourcesToSkip` list, then its corresponding embedded stack must be in one of the following states: `DELETE_IN_PROGRESS`, `DELETE_COMPLETE`, or `DELETE_FAILED`.  
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see [Continue rolling back from failed nested stack updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks).
Type: Array of strings  
Pattern: `[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\.[a-zA-Z0-9]+`   
Required: No

 ** RoleARN **   
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.  
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** StackName **   
The name or the unique ID of the stack that you want to continue rolling back.  
Don't specify the name of a nested stack (a stack that was created by using the `AWS::CloudFormation::Stack` resource). Instead, use this operation on the parent stack (the stack that contains the `AWS::CloudFormation::Stack` resource).
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

## Errors
<a name="API_ContinueUpdateRollback_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** TokenAlreadyExists **   
A client request token already exists.  
HTTP Status Code: 400

## Examples
<a name="API_ContinueUpdateRollback_Examples"></a>

### ContinueUpdateRollback
<a name="API_ContinueUpdateRollback_Example_1"></a>

This example illustrates one usage of ContinueUpdateRollback.

#### Sample Request
<a name="API_ContinueUpdateRollback_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ContinueUpdateRollback
 &StackName=MyUpdatRollbackFailedStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_ContinueUpdateRollback_Example_1_Response"></a>

```
<ContinueUpdateRollbackResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ResponseMetadata>
    <RequestId>5ccc7dcd-744c-11e5-be70-1b08c228efb3</RequestId>
  </ResponseMetadata>
</ContinueUpdateRollbackResponse>
```

## See Also
<a name="API_ContinueUpdateRollback_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ContinueUpdateRollback) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ContinueUpdateRollback) 

# CreateChangeSet
<a name="API_CreateChangeSet"></a>

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the `ChangeSetType` parameter, specify `CREATE`. To create a change set for an existing stack, specify `UPDATE` for the `ChangeSetType` parameter. To create a change set for an import operation, specify `IMPORT` for the `ChangeSetType` parameter. After the `CreateChangeSet` call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the [DescribeChangeSet](API_DescribeChangeSet.md) action.

When you are satisfied with the changes the change set will make, execute the change set by using the [ExecuteChangeSet](API_ExecuteChangeSet.md) action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set `IncludeNestedStacks` to `True`.

## Request Parameters
<a name="API_CreateChangeSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Capabilities.member.N**   
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.  
+  `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM` 

  Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
  + If you have IAM resources, you can specify either capability.
  + If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM`.
  + If you don't specify either of these capabilities, CloudFormation returns an `InsufficientCapabilities` error.

  If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
  +  [ AWS::IAM::AccessKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html) 
  +  [ AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html) 
  +  [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html) 
  +  [ AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-managedpolicy.html) 
  +  [ AWS::IAM::Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html) 
  +  [ AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html) 
  +  [ AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html) 
  +  [AWS::IAM::UserToGroupAddition](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html) 

  For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities).
+  `CAPABILITY_AUTO_EXPAND` 

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by CloudFormation.
**Note**  
This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.  
If you want to create a stack from a stack template that contains macros *and* nested stacks, you must create or update the stack directly from the template using the [CreateStack](API_CreateStack.md) or [UpdateStack](API_UpdateStack.md) action, and specifying this capability.

  For more information about macros, see [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
Only one of the `Capabilities` and `ResourceType` parameters can be specified.
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND`   
Required: No

 ** ChangeSetName **   
The name of the change set. The name must be unique among all change sets that are associated with the specified stack.  
A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can't exceed 128 characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*`   
Required: Yes

 ** ChangeSetType **   
The type of change set operation. To create a change set for a new stack, specify `CREATE`. To create a change set for an existing stack, specify `UPDATE`. To create a change set for an import operation, specify `IMPORT`.  
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the `REVIEW_IN_PROGRESS` state until you execute the change set.  
By default, CloudFormation specifies `UPDATE`. You can't use the `UPDATE` type to create a change set for a new stack or the `CREATE` type to create a change set for an existing stack.  
Type: String  
Valid Values: `CREATE | UPDATE | IMPORT`   
Required: No

 ** ClientToken **   
A unique identifier for this `CreateChangeSet` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry `CreateChangeSet` requests to ensure that CloudFormation successfully received them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** DeploymentMode **   
Determines how CloudFormation handles configuration drift during deployment.  
+  `REVERT_DRIFT` – Creates a drift-aware change set that brings actual resource states in line with template definitions. Provides a three-way comparison between actual state, previous deployment state, and desired state.
For more information, see [Using drift-aware change sets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/drift-aware-change-sets.html) in the * AWS CloudFormation User Guide*.  
Type: String  
Valid Values: `REVERT_DRIFT`   
Required: No

 ** Description **   
A description to help you identify this change set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ImportExistingResources **   
Indicates if the change set auto-imports resources that already exist. For more information, see [Import AWS resources into a CloudFormation stack automatically](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/import-resources-automatically.html) in the * AWS CloudFormation User Guide*.  
This parameter can only import resources that have custom names in templates. For more information, see [name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-name.html) in the * AWS CloudFormation User Guide*. To import resources that do not accept custom names, such as EC2 instances, use the `ResourcesToImport` parameter instead.
Type: Boolean  
Required: No

 ** IncludeNestedStacks **   
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to `False`. To include nested sets in a change set, specify `True`.  
Type: Boolean  
Required: No

 **NotificationARNs.member.N**   
The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Required: No

 ** OnStackFailure **   
Determines what action will be taken if stack creation fails. If this parameter is specified, the `DisableRollback` parameter to the [ExecuteChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) API operation must not be specified. This must be one of these values:  
+  `DELETE` - Deletes the change set if the stack creation fails. This is only valid when the `ChangeSetType` parameter is set to `CREATE`. If the deletion of the stack fails, the status of the stack is `DELETE_FAILED`.
+  `DO_NOTHING` - if the stack creation fails, do nothing. This is equivalent to specifying `true` for the `DisableRollback` parameter to the [ExecuteChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) API operation.
+  `ROLLBACK` - if the stack creation fails, roll back the stack. This is equivalent to specifying `false` for the `DisableRollback` parameter to the [ExecuteChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) API operation.
For nested stacks, when the `OnStackFailure` parameter is set to `DELETE` for the change set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to be deleted.  
Type: String  
Valid Values: `DO_NOTHING | ROLLBACK | DELETE`   
Required: No

 **Parameters.member.N**   
A list of `Parameter` structures that specify input parameters for the change set. For more information, see the [Parameter](API_Parameter.md) data type.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 **ResourcesToImport.member.N**   
The resources to import into your stack.  
Type: Array of [ResourceToImport](API_ResourceToImport.md) objects  
Array Members: Maximum number of 200 items.  
Required: No

 **ResourceTypes.member.N**   
Specifies which resource types you can work with, such as `AWS::EC2::Instance` or `Custom::MyCustomInstance`.  
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see [Control CloudFormation access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html) in the * AWS CloudFormation User Guide*.  
Only one of the `Capabilities` and `ResourceType` parameters can be specified.
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** RoleARN **   
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.  
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** RollbackConfiguration **   
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.  
Type: [RollbackConfiguration](API_RollbackConfiguration.md) object  
Required: No

 ** StackName **   
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

 **Tags.member.N**   
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** TemplateBody **   
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.  
Conditional: You must specify only one of the following parameters: `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to `true`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateURL **   
The URL of the file that contains the revised template. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with `https://`. URLs from S3 static websites are not supported.  
Conditional: You must specify only one of the following parameters: `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to `true`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

 ** UsePreviousTemplate **   
Whether to reuse the template that's associated with the stack to create the change set.  
When using templates with the `AWS::LanguageExtensions` transform, provide the template instead of using `UsePreviousTemplate` to ensure new parameter values and Systems Manager parameter updates are applied correctly. For more information, see [AWS::LanguageExtensions transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/transform-aws-languageextensions.html).  
Conditional: You must specify only one of the following parameters: `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to `true`.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_CreateChangeSet_ResponseElements"></a>

The following elements are returned by the service.

 ** Id **   
The Amazon Resource Name (ARN) of the change set.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `arn:[-a-zA-Z0-9:/]*` 

 ** StackId **   
The unique ID of the stack.  
Type: String

## Errors
<a name="API_CreateChangeSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AlreadyExists **   
The resource with the name requested already exists.  
HTTP Status Code: 400

 ** InsufficientCapabilities **   
The template contains resources with capabilities that weren't specified in the Capabilities parameter.  
HTTP Status Code: 400

 ** LimitExceeded **   
The quota for the resource has already been reached.  
For information about resource and stack limitations, see [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.  
HTTP Status Code: 400

## Examples
<a name="API_CreateChangeSet_Examples"></a>

### CreateChangeSet
<a name="API_CreateChangeSet_Example_1"></a>

This example illustrates one usage of CreateChangeSet.

#### Sample Request
<a name="API_CreateChangeSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=CreateChangeSet
 &ChangeSetName=SampleChangeSet
 &Parameters.member.1.ParameterKey=KeyName
 &Parameters.member.1.UsePreviousValue=true
 &Parameters.member.2.ParameterKey=Purpose
 &Parameters.member.2.ParameterValue=production
 &StackName=arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/1a2345b6-0000-00a0-a123-00abc0abc000
 &UsePreviousTemplate=true
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_CreateChangeSet_Example_1_Response"></a>

```
<CreateChangeSetResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <CreateChangeSetResult>
    <Id>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</Id>
  </CreateChangeSetResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</CreateChangeSetResponse>
```

## See Also
<a name="API_CreateChangeSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/CreateChangeSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/CreateChangeSet) 

# CreateGeneratedTemplate
<a name="API_CreateGeneratedTemplate"></a>

Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the `DescribeGeneratedTemplate` API action.

## Request Parameters
<a name="API_CreateGeneratedTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GeneratedTemplateName **   
The name assigned to the generated template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 **Resources.member.N**   
An optional list of resources to be included in the generated template.  
If no resources are specified,the template will be created without any resources. Resources can be added to the template using the `UpdateGeneratedTemplate` API action.  
Type: Array of [ResourceDefinition](API_ResourceDefinition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 500 items.  
Required: No

 ** StackName **   
An optional name or ARN of a stack to use as the base stack for the generated template.  
Type: String  
Required: No

 ** TemplateConfiguration **   
The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.  
Type: [TemplateConfiguration](API_TemplateConfiguration.md) object  
Required: No

## Response Elements
<a name="API_CreateGeneratedTemplate_ResponseElements"></a>

The following element is returned by the service.

 ** GeneratedTemplateId **   
The ID of the generated template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreateGeneratedTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AlreadyExists **   
The resource with the name requested already exists.  
HTTP Status Code: 400

 ** ConcurrentResourcesLimitExceeded **   
No more than 5 generated templates can be in an `InProgress` or `Pending` status at one time. This error is also returned if a generated template that is in an `InProgress` or `Pending` status is attempted to be updated or deleted.  
HTTP Status Code: 429

 ** LimitExceeded **   
The quota for the resource has already been reached.  
For information about resource and stack limitations, see [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.  
HTTP Status Code: 400

## See Also
<a name="API_CreateGeneratedTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/CreateGeneratedTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/CreateGeneratedTemplate) 

# CreateStack
<a name="API_CreateStack"></a>

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the [DescribeStacks](API_DescribeStacks.md) operation.

For more information about creating a stack and monitoring stack progress, see [Managing AWS resources as a single unit with CloudFormation stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_CreateStack_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Capabilities.member.N**   
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.  
+  `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM` 

  Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
  + If you have IAM resources, you can specify either capability.
  + If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM`.
  + If you don't specify either of these capabilities, CloudFormation returns an `InsufficientCapabilities` error.

  If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
  +  [AWS::IAM::AccessKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html) 
  +  [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html) 
  +  [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html) 
  +  [ AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-managedpolicy.html) 
  +  [AWS::IAM::Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html) 
  +  [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html) 
  +  [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html) 
  +  [AWS::IAM::UserToGroupAddition](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html) 

  For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities).
+  `CAPABILITY_AUTO_EXPAND` 

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by CloudFormation.

  If you want to create a stack from a stack template that contains macros *and* nested stacks, you must create the stack directly from the template using this capability.
**Important**  
You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.  
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

  For more information, see [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
Only one of the `Capabilities` and `ResourceType` parameters can be specified.
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND`   
Required: No

 ** ClientRequestToken **   
A unique identifier for this `CreateStack` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry `CreateStack` requests to ensure that CloudFormation successfully received them.  
All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a `CreateStack` operation with the token `token1`, then all the `StackEvents` generated by that operation will have `ClientRequestToken` set as `token1`.  
In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format *Console-StackOperation-ID*, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** DisableRollback **   
Set to `true` to disable rollback of the stack if stack creation failed. You can specify either `DisableRollback` or `OnFailure`, but not both.  
Default: `false`   
Type: Boolean  
Required: No

 ** EnableTerminationProtection **   
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see [Protect CloudFormation stacks from being deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the * AWS CloudFormation User Guide*. Termination protection is deactivated on stacks by default.  
For [nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), termination protection is set on the root stack and can't be changed directly on the nested stack.  
Type: Boolean  
Required: No

 **NotificationARNs.member.N**   
The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Required: No

 ** OnFailure **   
Determines what action will be taken if stack creation fails. This must be one of: `DO_NOTHING`, `ROLLBACK`, or `DELETE`. You can specify either `OnFailure` or `DisableRollback`, but not both.  
Although the default setting is `ROLLBACK`, there is one exception. This exception occurs when a StackSet attempts to deploy a stack instance and the stack instance fails to create successfully. In this case, the `CreateStack` call overrides the default setting and sets the value of `OnFailure` to `DELETE`.
Default: `ROLLBACK`   
Type: String  
Valid Values: `DO_NOTHING | ROLLBACK | DELETE`   
Required: No

 **Parameters.member.N**   
A list of `Parameter` structures that specify input parameters for the stack. For more information, see the [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) data type.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 **ResourceTypes.member.N**   
Specifies which resource types you can work with, such as `AWS::EC2::Instance` or `Custom::MyCustomInstance`.  
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see [Control CloudFormation access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html).  
Only one of the `Capabilities` and `ResourceType` parameters can be specified.
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** RetainExceptOnCreate **   
When set to `true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.  
Default: `false`   
Type: Boolean  
Required: No

 ** RoleARN **   
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.  
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** RollbackConfiguration **   
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.  
Type: [RollbackConfiguration](API_RollbackConfiguration.md) object  
Required: No

 ** StackName **   
The name that's associated with the stack. The name must be unique in the Region in which you are creating the stack.  
A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetical character and can't be longer than 128 characters.
Type: String  
Required: Yes

 ** StackPolicyBody **   
Structure that contains the stack policy body. For more information, see [Prevent updates to stack resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the * AWS CloudFormation User Guide*. You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.  
Required: No

 ** StackPolicyURL **   
Location of a file that contains the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with `https://`. URLs from S3 static websites are not supported.  
You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

 **Tags.member.N**   
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** TemplateBody **   
Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.  
Conditional: You must specify either `TemplateBody` or `TemplateURL`, but not both.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateURL **   
The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`. URLs from S3 static websites are not supported.  
Conditional: You must specify either the `TemplateBody` or the `TemplateURL` parameter, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

 ** TimeoutInMinutes **   
The amount of time that can pass before the stack status becomes `CREATE_FAILED`; if `DisableRollback` is not set or is set to `false`, the stack will be rolled back.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## Response Elements
<a name="API_CreateStack_ResponseElements"></a>

The following elements are returned by the service.

 ** OperationId **   
A unique identifier for this stack operation that can be used to track the operation's progress and events.  
Type: String

 ** StackId **   
Unique identifier of the stack.  
Type: String

## Errors
<a name="API_CreateStack_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AlreadyExists **   
The resource with the name requested already exists.  
HTTP Status Code: 400

 ** InsufficientCapabilities **   
The template contains resources with capabilities that weren't specified in the Capabilities parameter.  
HTTP Status Code: 400

 ** LimitExceeded **   
The quota for the resource has already been reached.  
For information about resource and stack limitations, see [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.  
HTTP Status Code: 400

 ** TokenAlreadyExists **   
A client request token already exists.  
HTTP Status Code: 400

## Examples
<a name="API_CreateStack_Examples"></a>

### CreateStack
<a name="API_CreateStack_Example_1"></a>

This example illustrates one usage of CreateStack.

#### Sample Request
<a name="API_CreateStack_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=CreateStack
 &StackName=MyStack
 &TemplateBody=[Template Document]
 &NotificationARNs.member.1=arn:aws:sns:us-east-1:1234567890:my-topic
 &Parameters.member.1.ParameterKey=AvailabilityZone
 &Parameters.member.1.ParameterValue=us-east-1a
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_CreateStack_Example_1_Response"></a>

```
<CreateStackResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <CreateStackResult>
    <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
  </CreateStackResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</CreateStackResponse>
```

## See Also
<a name="API_CreateStack_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/CreateStack) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/CreateStack) 

# CreateStackInstances
<a name="API_CreateStackInstances"></a>

Creates stack instances for the specified accounts, within the specified AWS Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either `Accounts` or `DeploymentTargets`, and you must specify at least one value for `Regions`.

**Note**  
The maximum number of organizational unit (OUs) supported by a `CreateStackInstances` operation is 50.  
If you need more than 50, consider the following options:  
 *Batch processing:* If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
 *Parent OU strategy:* If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

## Request Parameters
<a name="API_CreateStackInstances_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Accounts.member.N**   
[Self-managed permissions] The account IDs of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.  
You can specify `Accounts` or `DeploymentTargets`, but not both.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** DeploymentTargets **   
[Service-managed permissions] The AWS Organizations accounts in which to create stack instances in the specified AWS Regions.  
You can specify `Accounts` or `DeploymentTargets`, but not both.  
Type: [DeploymentTargets](API_DeploymentTargets.md) object  
Required: No

 ** OperationId **   
The unique identifier for this StackSet operation.  
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.  
Repeating this StackSet operation with a new operation ID retries all stack instances whose status is `OUTDATED`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** OperationPreferences **   
Preferences for how CloudFormation performs this StackSet operation.  
Type: [StackSetOperationPreferences](API_StackSetOperationPreferences.md) object  
Required: No

 **ParameterOverrides.member.N**   
A list of StackSet parameters whose values you want to override in the selected stack instances.  
Any overridden parameter values will be applied to all stack instances in the specified accounts and AWS Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:  
+ To override the current value for a parameter, include the parameter and specify its value.
+ To leave an overridden parameter set to its present value, include the parameter and specify `UsePreviousValue` as `true`. (You can't specify both a value and set `UsePreviousValue` to `true`.)
+ To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don't include the parameter in the list.
+ To leave all parameters set to their present values, don't specify this property at all.
During StackSet updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.  
You can only override the parameter *values* that are specified in the StackSet; to add or delete a parameter itself, use [UpdateStackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update the StackSet template.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 **Regions.member.N**   
The names of one or more AWS Regions where you want to create stack instances using the specified AWS accounts.  
Type: Array of strings  
Pattern: `^[a-zA-Z0-9-]{1,128}$`   
Required: Yes

 ** StackSetName **   
The name or unique ID of the StackSet that you want to create stack instances from.  
Type: String  
Required: Yes

## Response Elements
<a name="API_CreateStackInstances_ResponseElements"></a>

The following element is returned by the service.

 ** OperationId **   
The unique identifier for this StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_CreateStackInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** LimitExceeded **   
The quota for the resource has already been reached.  
For information about resource and stack limitations, see [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.  
HTTP Status Code: 400

 ** OperationIdAlreadyExists **   
The specified operation ID already exists.  
HTTP Status Code: 409

 ** OperationInProgress **   
Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.  
HTTP Status Code: 409

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

 ** StaleRequest **   
Another operation has been performed on this StackSet since the specified operation was performed.  
HTTP Status Code: 409

## Examples
<a name="API_CreateStackInstances_Examples"></a>

### CreateStackInstances
<a name="API_CreateStackInstances_Example_1"></a>

This example illustrates one usage of CreateStackInstances.

#### Sample Request
<a name="API_CreateStackInstances_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=CreateStackInstances
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &Regions.member.1=us-east-1
 &Regions.member.2=us-west-2
 &OperationPreferences.MaxConcurrentCount=5
 &OperationPreferences.FailureTolerancePercentage=10
 &Accounts.member.1=[account]
 &Accounts.member.2=[account]
 &OperationId=c424b651-2fda-4d6f-a4f1-20c0example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_CreateStackInstances_Example_1_Response"></a>

```
<CreateStackInstancesResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <CreateStackInstancesResult>
    <OperationId>c424b651-2fda-4d6f-a4f1-20c0fc62a6fe</OperationId>
  </CreateStackInstancesResult>
  <ResponseMetadata>
    <RequestId>97564c5e-813e-11e7-a9b2-5b163763e702</RequestId>
  </ResponseMetadata>
</CreateStackInstancesResponse>
```

## See Also
<a name="API_CreateStackInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/CreateStackInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/CreateStackInstances) 

# CreateStackRefactor
<a name="API_CreateStackRefactor"></a>

Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.

## Request Parameters
<a name="API_CreateStackRefactor_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Description **   
A description to help you identify the stack refactor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** EnableStackCreation **   
Determines if a new stack is created with the refactor.  
Type: Boolean  
Required: No

 **ResourceMappings.member.N**   
The mappings for the stack resource `Source` and stack resource `Destination`.  
Type: Array of [ResourceMapping](API_ResourceMapping.md) objects  
Required: No

 **StackDefinitions.member.N**   
The stacks being refactored.  
Type: Array of [StackDefinition](API_StackDefinition.md) objects  
Required: Yes

## Response Elements
<a name="API_CreateStackRefactor_ResponseElements"></a>

The following element is returned by the service.

 ** StackRefactorId **   
The ID associated with the stack refactor created from the [CreateStackRefactor](#API_CreateStackRefactor) action.  
Type: String

## Errors
<a name="API_CreateStackRefactor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_CreateStackRefactor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/CreateStackRefactor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/CreateStackRefactor) 

# CreateStackSet
<a name="API_CreateStackSet"></a>

Creates a StackSet.

## Request Parameters
<a name="API_CreateStackSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** AdministrationRoleARN **   
The Amazon Resource Name (ARN) of the IAM role to use to create this StackSet.  
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see [Grant self-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) in the * AWS CloudFormation User Guide*.  
Valid only if the permissions model is `SELF_MANAGED`.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** AutoDeployment **   
Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). For more information, see [Enable or disable automatic deployments for StackSets in AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html) in the * AWS CloudFormation User Guide*.  
Required if the permissions model is `SERVICE_MANAGED`. (Not used with self-managed permissions.)  
Type: [AutoDeployment](API_AutoDeployment.md) object  
Required: No

 ** CallAs **   
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ To create a StackSet with service-managed permissions while signed in to the management account, specify `SELF`.
+ To create a StackSet with service-managed permissions while signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated admin in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.  
Valid only if the permissions model is `SERVICE_MANAGED`.  
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 **Capabilities.member.N**   
In some cases, you must explicitly acknowledge that your StackSet template contains certain capabilities in order for CloudFormation to create the StackSet and related stack instances.  
+  `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM` 

  Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new IAM users. For those StackSets, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
  + If you have IAM resources, you can specify either capability.
  + If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM`.
  + If you don't specify either of these capabilities, CloudFormation returns an `InsufficientCapabilities` error.

  If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
  +  [AWS::IAM::AccessKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html) 
  +  [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html) 
  +  [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html) 
  +  [AWS::IAM::Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html) 
  +  [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html) 
  +  [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html) 
  +  [AWS::IAM::UserToGroupAddition](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html) 

  For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities).
+  `CAPABILITY_AUTO_EXPAND` 

  Some templates reference macros. If your StackSet template references one or more macros, you must create the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To create the StackSet directly, you must acknowledge this capability. For more information, see [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
**Important**  
StackSets with service-managed permissions don't currently support the use of macros in templates. (This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND`   
Required: No

 ** ClientRequestToken **   
A unique identifier for this `CreateStackSet` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another StackSet with the same name. You might retry `CreateStackSet` requests to ensure that CloudFormation successfully received them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** Description **   
A description of the StackSet. You can use the description to identify the StackSet's purpose or other important information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ExecutionRoleName **   
The name of the IAM execution role to use to create the StackSet. If you do not specify an execution role, CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the StackSet operation.  
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their StackSets.  
Valid only if the permissions model is `SELF_MANAGED`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z_0-9+=,.@-]+`   
Required: No

 ** ManagedExecution **   
Describes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.  
Type: [ManagedExecution](API_ManagedExecution.md) object  
Required: No

 **Parameters.member.N**   
The input parameters for the StackSet template.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 ** PermissionModel **   
Describes how the IAM roles required for StackSet operations are created. By default, `SELF-MANAGED` is specified.  
+ With `self-managed` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see [Grant self-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
+ With `service-managed` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see [Activate trusted access for StackSets with AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html).
Type: String  
Valid Values: `SERVICE_MANAGED | SELF_MANAGED`   
Required: No

 ** StackId **   
The stack ID you are importing into a new StackSet. Specify the Amazon Resource Name (ARN) of the stack.  
Type: String  
Required: No

 ** StackSetName **   
The name to associate with the StackSet. The name must be unique in the Region where you create your StackSet.  
A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
Type: String  
Required: Yes

 **Tags.member.N**   
The key-value pairs to associate with this StackSet and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.  
If you specify tags as part of a `CreateStackSet` action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire `CreateStackSet` action fails with an `access denied` error, and the StackSet is not created.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** TemplateBody **   
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.  
Conditional: You must specify either the `TemplateBody` or the `TemplateURL` parameter, but not both.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateURL **   
The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`. S3 static website URLs are not supported.  
Conditional: You must specify either the `TemplateBody` or the `TemplateURL` parameter, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

## Response Elements
<a name="API_CreateStackSet_ResponseElements"></a>

The following element is returned by the service.

 ** StackSetId **   
The ID of the StackSet that you're creating.  
Type: String

## Errors
<a name="API_CreateStackSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CreatedButModified **   
The specified resource exists, but has been changed.  
HTTP Status Code: 409

 ** LimitExceeded **   
The quota for the resource has already been reached.  
For information about resource and stack limitations, see [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.  
HTTP Status Code: 400

 ** NameAlreadyExists **   
The specified name is already in use.  
HTTP Status Code: 409

## Examples
<a name="API_CreateStackSet_Examples"></a>

### CreateStackSet
<a name="API_CreateStackSet_Example_1"></a>

This example illustrates one usage of CreateStackSet.

#### Sample Request
<a name="API_CreateStackSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=CreateStackSet
 &TemplateURL=https://s3.amazonaws.com/cloudformation-stackset-sample-templates-us-east-1/EnableAWSConfig.yml
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &ClientRequestToken=61806005-bde9-46f1-949d-6791example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_CreateStackSet_Example_1_Response"></a>

```
<CreateStackSetResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <CreateStackSetResult>
    <StackSetId>stack-set-example:22f04391-472b-4e36-b11a-727example</StackSetId>
  </CreateStackSetResult>
  <ResponseMetadata>
    <RequestId>ad9647cb-7949-11e7-ac43-9938example</RequestId>
  </ResponseMetadata>
</CreateStackSetResponse>
```

## See Also
<a name="API_CreateStackSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/CreateStackSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/CreateStackSet) 

# DeactivateOrganizationsAccess
<a name="API_DeactivateOrganizationsAccess"></a>

Deactivates trusted access with AWS Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.

## Errors
<a name="API_DeactivateOrganizationsAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationNotFound **   
The specified ID refers to an operation that doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_DeactivateOrganizationsAccess_Examples"></a>

### DeactivateOrganizationsAccess
<a name="API_DeactivateOrganizationsAccess_Example_1"></a>

This example illustrates one usage of DeactivateOrganizationsAccess.

#### Sample Request
<a name="API_DeactivateOrganizationsAccess_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
    ?Action=DeactivateOrganizationsAccess
```

#### Sample Response
<a name="API_DeactivateOrganizationsAccess_Example_1_Response"></a>

```
<DeactivateOrganizationsAccessResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DeactivateOrganizationsAccessResult/>
  <ResponseMetadata>
    <RequestId>f2038c6a-2ef6-45d0-a045-f2b4d15647ba</RequestId>
  </ResponseMetadata>
</DeactivateOrganizationsAccessResponse>
```

## See Also
<a name="API_DeactivateOrganizationsAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeactivateOrganizationsAccess) 

# DeactivateType
<a name="API_DeactivateType"></a>

Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.

Deactivating an extension deletes the configuration details that are associated with it. To temporarily disable a CloudFormation Hook instead, you can use [SetTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html).

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.

To see which extensions are currently activated, use [ListTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListTypes.html).

## Request Parameters
<a name="API_DeactivateType_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Arn **   
The Amazon Resource Name (ARN) for the extension in this account and Region.  
Conditional: You must specify either `Arn`, or `TypeName` and `Type`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+`   
Required: No

 ** Type **   
The extension type.  
Conditional: You must specify either `Arn`, or `TypeName` and `Type`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The type name of the extension in this account and Region. If you specified a type name alias when enabling the extension, use the type name alias.  
Conditional: You must specify either `Arn`, or `TypeName` and `Type`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

## Errors
<a name="API_DeactivateType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## See Also
<a name="API_DeactivateType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeactivateType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeactivateType) 

# DeleteChangeSet
<a name="API_DeleteChangeSet"></a>

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, CloudFormation successfully deleted the change set.

If `IncludeNestedStacks` specifies `True` during the creation of the nested change set, then `DeleteChangeSet` will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of `REVIEW_IN_PROGRESS`.

## Request Parameters
<a name="API_DeleteChangeSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ChangeSetName **   
The name or Amazon Resource Name (ARN) of the change set that you want to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*`   
Required: Yes

 ** StackName **   
If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's associated with it.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: No

## Errors
<a name="API_DeleteChangeSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidChangeSetStatus **   
The specified change set can't be used to update the stack. For example, the change set status might be `CREATE_IN_PROGRESS`, or the stack status might be `UPDATE_IN_PROGRESS`.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteChangeSet_Examples"></a>

### DeleteChangeSet
<a name="API_DeleteChangeSet_Example_1"></a>

This example illustrates one usage of DeleteChangeSet.

#### Sample Request
<a name="API_DeleteChangeSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DeleteChangeSet
 &ChangeSetName=arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DeleteChangeSet_Example_1_Response"></a>

```
<DeleteChangeSetResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DeleteChangeSetResult/>
  <ResponseMetadata>
    <RequestId>5ccc7dcd-744c-11e5-be70-example</RequestId>
  </ResponseMetadata>
</DeleteChangeSetResponse>
```

## See Also
<a name="API_DeleteChangeSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeleteChangeSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeleteChangeSet) 

# DeleteGeneratedTemplate
<a name="API_DeleteGeneratedTemplate"></a>

Deleted a generated template.

## Request Parameters
<a name="API_DeleteGeneratedTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GeneratedTemplateName **   
The name or Amazon Resource Name (ARN) of a generated template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Errors
<a name="API_DeleteGeneratedTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentResourcesLimitExceeded **   
No more than 5 generated templates can be in an `InProgress` or `Pending` status at one time. This error is also returned if a generated template that is in an `InProgress` or `Pending` status is attempted to be updated or deleted.  
HTTP Status Code: 429

 ** GeneratedTemplateNotFound **   
The generated template was not found.  
HTTP Status Code: 404

## See Also
<a name="API_DeleteGeneratedTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeleteGeneratedTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeleteGeneratedTemplate) 

# DeleteStack
<a name="API_DeleteStack"></a>

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the [DescribeStacks](API_DescribeStacks.md) operation if the deletion has been completed successfully.

For more information about deleting a stack, see [Delete a stack from the CloudFormation console](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-delete-stack.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_DeleteStack_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ClientRequestToken **   
A unique identifier for this `DeleteStack` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry `DeleteStack` requests to ensure that CloudFormation successfully received them.  
All events initiated by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a `CreateStack` operation with the token `token1`, then all the `StackEvents` generated by that operation will have `ClientRequestToken` set as `token1`.  
In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format *Console-StackOperation-ID*, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** DeletionMode **   
Specifies the deletion mode for the stack. Possible values are:  
+  `STANDARD` - Use the standard behavior. Specifying this value is the same as not specifying this parameter.
+  `FORCE_DELETE_STACK` - Delete the stack if it's stuck in a `DELETE_FAILED` state due to resource deletion failure.
Type: String  
Valid Values: `STANDARD | FORCE_DELETE_STACK`   
Required: No

 **RetainResources.member.N**   
For stacks in the `DELETE_FAILED` state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained resources.  
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.  
Type: Array of strings  
Required: No

 ** RoleARN **   
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.  
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** StackName **   
The name or the unique stack ID that's associated with the stack.  
Type: String  
Required: Yes

## Errors
<a name="API_DeleteStack_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** TokenAlreadyExists **   
A client request token already exists.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteStack_Examples"></a>

### DeleteStack
<a name="API_DeleteStack_Example_1"></a>

This example illustrates one usage of DeleteStack.

#### Sample Request
<a name="API_DeleteStack_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DeleteStack
 &StackName=MyStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_DeleteStack_Example_1_Response"></a>

```
<DeleteStackResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ResponseMetadata>
    <RequestId>5ccc7dcd-744c-11e5-be70-example</RequestId>
  </ResponseMetadata>
</DeleteStackResponse>
```

## See Also
<a name="API_DeleteStack_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeleteStack) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeleteStack) 

# DeleteStackInstances
<a name="API_DeleteStackInstances"></a>

Deletes stack instances for the specified accounts, in the specified AWS Regions.

**Note**  
The maximum number of organizational unit (OUs) supported by a `DeleteStackInstances` operation is 50.  
If you need more than 50, consider the following options:  
 *Batch processing:* If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
 *Parent OU strategy:* If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

## Request Parameters
<a name="API_DeleteStackInstances_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Accounts.member.N**   
[Self-managed permissions] The account IDs of the AWS accounts that you want to delete stack instances for.  
You can specify `Accounts` or `DeploymentTargets`, but not both.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** DeploymentTargets **   
[Service-managed permissions] The AWS Organizations accounts from which to delete stack instances.  
You can specify `Accounts` or `DeploymentTargets`, but not both.  
Type: [DeploymentTargets](API_DeploymentTargets.md) object  
Required: No

 ** OperationId **   
The unique identifier for this StackSet operation.  
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.  
Repeating this StackSet operation with a new operation ID retries all stack instances whose status is `OUTDATED`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** OperationPreferences **   
Preferences for how CloudFormation performs this StackSet operation.  
Type: [StackSetOperationPreferences](API_StackSetOperationPreferences.md) object  
Required: No

 **Regions.member.N**   
The AWS Regions where you want to delete StackSet instances.  
Type: Array of strings  
Pattern: `^[a-zA-Z0-9-]{1,128}$`   
Required: Yes

 ** RetainStacks **   
Removes the stack instances from the specified StackSet, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.  
For more information, see [StackSet operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).  
Type: Boolean  
Required: Yes

 ** StackSetName **   
The name or unique ID of the StackSet that you want to delete stack instances for.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DeleteStackInstances_ResponseElements"></a>

The following element is returned by the service.

 ** OperationId **   
The unique identifier for this StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_DeleteStackInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationIdAlreadyExists **   
The specified operation ID already exists.  
HTTP Status Code: 409

 ** OperationInProgress **   
Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.  
HTTP Status Code: 409

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

 ** StaleRequest **   
Another operation has been performed on this StackSet since the specified operation was performed.  
HTTP Status Code: 409

## Examples
<a name="API_DeleteStackInstances_Examples"></a>

### DeleteStackInstances
<a name="API_DeleteStackInstances_Example_1"></a>

This example illustrates one usage of DeleteStackInstances.

#### Sample Request
<a name="API_DeleteStackInstances_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DeleteStackInstances
 &Regions.member.1=us-east-1
 &Regions.member.2=us-west-1
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &RetainStacks=false
 &OperationPreferences.MaxConcurrentCount=2
 &OperationPreferences.FailureToleranceCount=1
 &Accounts.member.1=[account]
 &Accounts.member.2=[account]
 &OperationId=a0f49354-a1eb-42b7-9e5d-c0897example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DeleteStackInstances_Example_1_Response"></a>

```
<DeleteStackInstancesResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DeleteStackInstancesResult>
    <OperationId>a0f49354-a1eb-42b7-9e5d-c08977e317a0</OperationId>
  </DeleteStackInstancesResult>
  <ResponseMetadata>
    <RequestId>0f3c3dcc-7945-11e7-a4ac-9503729bf9ee</RequestId>
  </ResponseMetadata>
</DeleteStackInstancesResponse>
```

## See Also
<a name="API_DeleteStackInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeleteStackInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeleteStackInstances) 

# DeleteStackSet
<a name="API_DeleteStackSet"></a>

Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see [DeleteStackInstances](API_DeleteStackInstances.md).

## Request Parameters
<a name="API_DeleteStackSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet that you're deleting. You can obtain this value by running [ListStackSets](API_ListStackSets.md).  
Type: String  
Required: Yes

## Errors
<a name="API_DeleteStackSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OperationInProgress **   
Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.  
HTTP Status Code: 409

 ** StackSetNotEmpty **   
You can't yet delete this StackSet, because it still contains one or more stack instances. Delete all stack instances from the StackSet before deleting the StackSet.  
HTTP Status Code: 409

## Examples
<a name="API_DeleteStackSet_Examples"></a>

### DeleteStackSet
<a name="API_DeleteStackSet_Example_1"></a>

This example illustrates one usage of DeleteStackSet.

#### Sample Request
<a name="API_DeleteStackSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DeleteStackSet
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DeleteStackSet_Example_1_Response"></a>

```
<DeleteStackSetResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DeleteStackSetResult/>
  <ResponseMetadata>
    <RequestId>792b1f2b-7946-11e7-a7db-afc00fexample</RequestId>
  </ResponseMetadata>
</DeleteStackSetResponse>
```

## See Also
<a name="API_DeleteStackSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeleteStackSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeleteStackSet) 

# DeregisterType
<a name="API_DeregisterType"></a>

Marks an extension or extension version as `DEPRECATED` in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use [DescribeType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html).

For more information, see [Remove third-party private extensions from your account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-private-deregister-extension.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_DeregisterType_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Arn **   
The Amazon Resource Name (ARN) of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+`   
Required: No

 ** Type **   
The kind of extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

 ** VersionId **   
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9-]+`   
Required: No

## Errors
<a name="API_DeregisterType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## Examples
<a name="API_DeregisterType_Examples"></a>

### Deregistering an extension version
<a name="API_DeregisterType_Example_1"></a>

The following example removes a specific version of the `My::Resource::Example` resource type from active use in the CloudFormation registry.

#### Sample Request
<a name="API_DeregisterType_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DeregisterType
 &Version=2010-05-15
 &TypeName=My::Resource::Example
 &Type=RESOURCE
 &VersionId=00000002
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191204T181601Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DeregisterType_Example_1_Response"></a>

```
<DeregisterTypeResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DeregisterTypeResult/>
  <ResponseMetadata>
    <RequestId>78c291d1-4463-4845-a600-29221example</RequestId>
  </ResponseMetadata>
</DeregisterTypeResponse>
```

## See Also
<a name="API_DeregisterType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DeregisterType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DeregisterType) 

# DescribeAccountLimits
<a name="API_DescribeAccountLimits"></a>

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see [Understand CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_DescribeAccountLimits_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Elements
<a name="API_DescribeAccountLimits_ResponseElements"></a>

The following elements are returned by the service.

 **AccountLimits.member.N**   
An account limit structure that contain a list of CloudFormation account limits and their values.  
Type: Array of [AccountLimit](API_AccountLimit.md) objects

 ** NextToken **   
If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_DescribeAccountLimits_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeAccountLimits_Examples"></a>

### DescribeAccountLimits
<a name="API_DescribeAccountLimits_Example_1"></a>

This example illustrates one usage of DescribeAccountLimits.

#### Sample Request
<a name="API_DescribeAccountLimits_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeAccountLimits
 &NextToken=[NextToken]
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeAccountLimits_Example_1_Response"></a>

```
<DescribeAccountLimitsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeAccountLimitsResult>
    <AccountLimits>
      <member>
        <Name>StackLimit</Name>
        <Value>20</Value>
      </member>
    </AccountLimits>
  </DescribeAccountLimitsResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</DescribeAccountLimitsResponse>
```

## See Also
<a name="API_DescribeAccountLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeAccountLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeAccountLimits) 

# DescribeChangeSet
<a name="API_DescribeChangeSet"></a>

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see [Update CloudFormation stacks using change sets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_DescribeChangeSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ChangeSetName **   
The name or Amazon Resource Name (ARN) of the change set that you want to describe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*`   
Required: Yes

 ** IncludePropertyValues **   
If `true`, the returned changes include detailed changes in the property values.  
Type: Boolean  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackName **   
If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: No

## Response Elements
<a name="API_DescribeChangeSet_ResponseElements"></a>

The following elements are returned by the service.

 **Capabilities.member.N**   
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.  
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND` 

 **Changes.member.N**   
A list of `Change` structures that describes the resources CloudFormation changes if you execute the change set.  
Type: Array of [Change](API_Change.md) objects

 ** ChangeSetId **   
The Amazon Resource Name (ARN) of the change set.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `arn:[-a-zA-Z0-9:/]*` 

 ** ChangeSetName **   
The name of the change set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*` 

 ** CreationTime **   
The start time when the change set was created, in UTC.  
Type: Timestamp

 ** DeploymentMode **   
The deployment mode specified when the change set was created. Valid value is `REVERT_DRIFT`. Only present for drift-aware change sets.  
Type: String  
Valid Values: `REVERT_DRIFT` 

 ** Description **   
Information about the change set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** ExecutionStatus **   
If the change set execution status is `AVAILABLE`, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an `UNAVAILABLE` state because CloudFormation is still creating it or in an `OBSOLETE` state because the stack was already updated.  
Type: String  
Valid Values: `UNAVAILABLE | AVAILABLE | EXECUTE_IN_PROGRESS | EXECUTE_COMPLETE | EXECUTE_FAILED | OBSOLETE` 

 ** ImportExistingResources **   
Indicates if the change set imports resources that already exist.  
This parameter can only import resources that have [custom names](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-name.html) in templates. To import resources that do not accept custom names, such as EC2 instances, use the [resource import](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html) feature instead.
Type: Boolean

 ** IncludeNestedStacks **   
Verifies if `IncludeNestedStacks` is set to `True`.  
Type: Boolean

 ** NextToken **   
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **NotificationARNs.member.N**   
The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.  
Type: Array of strings  
Array Members: Maximum number of 5 items.

 ** OnStackFailure **   
Determines what action will be taken if stack creation fails. When this parameter is specified, the `DisableRollback` parameter to the [ExecuteChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) API operation must not be specified. This must be one of these values:  
+  `DELETE` - Deletes the change set if the stack creation fails. This is only valid when the `ChangeSetType` parameter is set to `CREATE`. If the deletion of the stack fails, the status of the stack is `DELETE_FAILED`.
+  `DO_NOTHING` - if the stack creation fails, do nothing. This is equivalent to specifying `true` for the `DisableRollback` parameter to the [ExecuteChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) API operation.
+  `ROLLBACK` - if the stack creation fails, roll back the stack. This is equivalent to specifying `false` for the `DisableRollback` parameter to the [ExecuteChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html) API operation.
Type: String  
Valid Values: `DO_NOTHING | ROLLBACK | DELETE` 

 **Parameters.member.N**   
A list of `Parameter` structures that describes the input parameters and their values used to create the change set. For more information, see the [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) data type.  
Type: Array of [Parameter](API_Parameter.md) objects

 ** ParentChangeSetId **   
Specifies the change set ID of the parent change set in the current nested change set hierarchy.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `arn:[-a-zA-Z0-9:/]*` 

 ** RollbackConfiguration **   
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.  
Type: [RollbackConfiguration](API_RollbackConfiguration.md) object

 ** RootChangeSetId **   
Specifies the change set ID of the root change set in the current nested change set hierarchy.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `arn:[-a-zA-Z0-9:/]*` 

 ** StackDriftStatus **   
The drift status of the stack when the change set was created. Valid values:  
+  `DRIFTED` – The stack has drifted from its last deployment.
+  `IN_SYNC` – The stack is in sync with its last deployment.
+  `NOT_CHECKED` – CloudFormation doesn’t currently return this value.
+  `UNKNOWN` – The drift status could not be determined.
Only present for drift-aware change sets.  
Type: String  
Valid Values: `DRIFTED | IN_SYNC | UNKNOWN | NOT_CHECKED` 

 ** StackId **   
The Amazon Resource Name (ARN) of the stack that's associated with the change set.  
Type: String

 ** StackName **   
The name of the stack that's associated with the change set.  
Type: String

 ** Status **   
The current status of the change set, such as `CREATE_PENDING`, `CREATE_COMPLETE`, or `FAILED`.  
Type: String  
Valid Values: `CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | DELETE_PENDING | DELETE_IN_PROGRESS | DELETE_COMPLETE | DELETE_FAILED | FAILED` 

 ** StatusReason **   
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.  
Type: String

 **Tags.member.N**   
If you execute the change set, the tags that will be associated with the stack.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_DescribeChangeSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ChangeSetNotFound **   
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the `ListChangeSets` operation.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeChangeSet_Examples"></a>

### DescribeChangeSet
<a name="API_DescribeChangeSet_Example_1"></a>

This example illustrates one usage of DescribeChangeSet.

#### Sample Request
<a name="API_DescribeChangeSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeChangeSet
 &ChangeSetName=arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeChangeSet_Example_1_Response"></a>

```
<DescribeChangeSetResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeChangeSetResult>
    <StackId>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
    <Status>CREATE_COMPLETE</Status>
    <ChangeSetId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet-direct/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ChangeSetId>
    <StackName>SampleStack</StackName>
    <ChangeSetName>SampleChangeSet-direct</ChangeSetName>
    <NotificationARNs/>
    <CreationTime>2016-03-17T23:35:25.813Z</CreationTime>
    <Capabilities/>
    <Parameters>
      <member>
        <ParameterValue>testing</ParameterValue>
        <ParameterKey>Purpose</ParameterKey>
      </member>
      <member>
        <ParameterValue>MyKeyName</ParameterValue>
        <ParameterKey>KeyPairName</ParameterKey>
      </member>
      <member>
        <ParameterValue>t2.micro</ParameterValue>
        <ParameterKey>InstanceType</ParameterKey>
      </member>
    </Parameters>
    <Changes>
      <member>
        <ResourceChange>
          <Replacement>False</Replacement>
          <Scope>
            <member>Tags</member>
          </Scope>
          <Details>
            <member><ChangeSource>DirectModification</ChangeSource>
              <Target>
                <RequiresRecreation>Never</RequiresRecreation>
                <Attribute>Tags</Attribute>
              </Target>
              <Evaluation>Static</Evaluation>
            </member>
          </Details>
          <LogicalResourceId>MyEC2Instance</LogicalResourceId>
          <Action>Modify</Action>
          <PhysicalResourceId>i-1abc23d4</PhysicalResourceId>
          <ResourceType>AWS::EC2::Instance</ResourceType>
        </ResourceChange>
        <Type>Resource</Type>
      </member>
    </Changes>
  </DescribeChangeSetResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</DescribeChangeSetResponse>
```

## See Also
<a name="API_DescribeChangeSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeChangeSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeChangeSet) 

# DescribeChangeSetHooks
<a name="API_DescribeChangeSetHooks"></a>

Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

## Request Parameters
<a name="API_DescribeChangeSetHooks_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ChangeSetName **   
The name or Amazon Resource Name (ARN) of the change set that you want to describe.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*`   
Required: Yes

 ** LogicalResourceId **   
If specified, lists only the Hooks related to the specified `LogicalResourceId`.  
Type: String  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackName **   
If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want to describe.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: No

## Response Elements
<a name="API_DescribeChangeSetHooks_ResponseElements"></a>

The following elements are returned by the service.

 ** ChangeSetId **   
The change set identifier (stack ID).  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `arn:[-a-zA-Z0-9:/]*` 

 ** ChangeSetName **   
The change set name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*` 

 **Hooks.member.N**   
List of Hook objects.  
Type: Array of [ChangeSetHook](API_ChangeSetHook.md) objects

 ** NextToken **   
Pagination token, `null` or empty if no more results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** StackId **   
The stack identifier (stack ID).  
Type: String

 ** StackName **   
The stack name.  
Type: String

 ** Status **   
Provides the status of the change set Hook.  
Type: String  
Valid Values: `PLANNING | PLANNED | UNAVAILABLE` 

## Errors
<a name="API_DescribeChangeSetHooks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ChangeSetNotFound **   
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the `ListChangeSets` operation.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeChangeSetHooks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeChangeSetHooks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeChangeSetHooks) 

# DescribeEvents
<a name="API_DescribeEvents"></a>

Returns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during deployment.

An operation is any action performed on a stack, including stack lifecycle actions (Create, Update, Delete, Rollback), change set creation, nested stack creation, and automatic rollbacks triggered by failures. Each operation has a unique identifier (Operation ID) and represents a discrete change attempt on the stack.

Returns different types of events including:
+  **Progress events** - Status updates during stack operation execution.
+  **Validation errors** - Failures from CloudFormation Early Validations.
+  **Provisioning errors** - Resource creation and update failures.
+  **Hook invocation errors** - Failures from CloudFormation Hook during stack operations.

**Note**  
One of `ChangeSetName`, `OperationId` or `StackName` must be specified as input.

## Request Parameters
<a name="API_DescribeEvents_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ChangeSetName **   
The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*`   
Required: No

 ** Filters **   
Filters to apply when retrieving events.  
Type: [EventFilter](API_EventFilter.md) object  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** OperationId **   
The unique identifier of the operation for which you want to retrieve events.  
Type: String  
Required: No

 ** StackName **   
The name or unique stack ID for which you want to retrieve events. If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: No

## Response Elements
<a name="API_DescribeEvents_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `DescribeEvents` again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **OperationEvents.member.N**   
A list of operation events that match the specified criteria.  
Type: Array of [OperationEvent](API_OperationEvent.md) objects

## Errors
<a name="API_DescribeEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DescribeEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeEvents) 

# DescribeGeneratedTemplate
<a name="API_DescribeGeneratedTemplate"></a>

Describes a generated template. The output includes details about the progress of the creation of a generated template started by a `CreateGeneratedTemplate` API action or the update of a generated template started with an `UpdateGeneratedTemplate` API action.

## Request Parameters
<a name="API_DescribeGeneratedTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** GeneratedTemplateName **   
The name or Amazon Resource Name (ARN) of a generated template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_DescribeGeneratedTemplate_ResponseElements"></a>

The following elements are returned by the service.

 ** CreationTime **   
The time the generated template was created.  
Type: Timestamp

 ** GeneratedTemplateId **   
The Amazon Resource Name (ARN) of the generated template. The format is `arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}`. For example, `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** GeneratedTemplateName **   
The name of the generated template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** LastUpdatedTime **   
The time the generated template was last updated.  
Type: Timestamp

 ** Progress **   
An object describing the progress of the template generation.  
Type: [TemplateProgress](API_TemplateProgress.md) object

 **Resources.member.N**   
A list of objects describing the details of the resources in the template generation.  
Type: Array of [ResourceDetail](API_ResourceDetail.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 500 items.

 ** StackId **   
The stack ARN of the base stack if a base stack was provided when generating the template.  
Type: String

 ** Status **   
The status of the template generation. Supported values are:  
+  `CreatePending` - the creation of the template is pending.
+  `CreateInProgress` - the creation of the template is in progress.
+  `DeletePending` - the deletion of the template is pending.
+  `DeleteInProgress` - the deletion of the template is in progress.
+  `UpdatePending` - the update of the template is pending.
+  `UpdateInProgress` - the update of the template is in progress.
+  `Failed` - the template operation failed.
+  `Complete` - the template operation is complete.
Type: String  
Valid Values: `CREATE_PENDING | UPDATE_PENDING | DELETE_PENDING | CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | FAILED | COMPLETE` 

 ** StatusReason **   
The reason for the current template generation status. This will provide more details if a failure happened.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** TemplateConfiguration **   
The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.  
Type: [TemplateConfiguration](API_TemplateConfiguration.md) object

 ** TotalWarnings **   
The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.  
Type: Integer  
Valid Range: Minimum value of 0.

## Errors
<a name="API_DescribeGeneratedTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GeneratedTemplateNotFound **   
The generated template was not found.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeGeneratedTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeGeneratedTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeGeneratedTemplate) 

# DescribeOrganizationsAccess
<a name="API_DescribeOrganizationsAccess"></a>

Retrieves information about the account's `OrganizationAccess` status. This API can be called either by the management account or the delegated administrator by using the `CallAs` parameter. This API can also be called without the `CallAs` parameter by the management account.

## Request Parameters
<a name="API_DescribeOrganizationsAccess_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

## Response Elements
<a name="API_DescribeOrganizationsAccess_ResponseElements"></a>

The following element is returned by the service.

 ** Status **   
Presents the status of the `OrganizationAccess`.  
Type: String  
Valid Values: `ENABLED | DISABLED | DISABLED_PERMANENTLY` 

## Errors
<a name="API_DescribeOrganizationsAccess_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationNotFound **   
The specified ID refers to an operation that doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeOrganizationsAccess_Examples"></a>

### DescribeOrganizationsAccess
<a name="API_DescribeOrganizationsAccess_Example_1"></a>

This example illustrates one usage of DescribeOrganizationsAccess.

#### Sample Request
<a name="API_DescribeOrganizationsAccess_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
    ?Action=DescribeOrganizationsAccess
```

#### Sample Response
<a name="API_DescribeOrganizationsAccess_Example_1_Response"></a>

```
<DescribeOrganizationsAccessResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DescribeOrganizationsAccessResult>
    <Status>ENABLED</Status>
  </DescribeOrganizationsAccessResult>
  <ResponseMetadata>
    <RequestId>240f1cd7-48d6-41a6-b61b-65c7c81893e9</RequestId>
  </ResponseMetadata>
</DescribeOrganizationsAccessResponse>
```

## See Also
<a name="API_DescribeOrganizationsAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeOrganizationsAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeOrganizationsAccess) 

# DescribePublisher
<a name="API_DescribePublisher"></a>

Returns information about a CloudFormation extension publisher.

If you don't supply a `PublisherId`, and you have registered as an extension publisher, `DescribePublisher` returns information about your own publisher account.

For more information about registering as a publisher, see:
+  [RegisterPublisher](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html) 
+  [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the * AWS CloudFormation Command Line Interface (CLI) User Guide* 

## Request Parameters
<a name="API_DescribePublisher_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** PublisherId **   
The ID of the extension publisher.  
If you don't supply a `PublisherId`, and you have registered as an extension publisher, `DescribePublisher` returns information about your own publisher account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Pattern: `[0-9a-zA-Z]{12,40}`   
Required: No

## Response Elements
<a name="API_DescribePublisher_ResponseElements"></a>

The following elements are returned by the service.

 ** IdentityProvider **   
The type of account used as the identity provider when registering this publisher with CloudFormation.  
Type: String  
Valid Values: `AWS_Marketplace | GitHub | Bitbucket` 

 ** PublisherId **   
The ID of the extension publisher.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Pattern: `[0-9a-zA-Z]{12,40}` 

 ** PublisherProfile **   
The URL to the publisher's profile with the identity provider.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `(http:|https:)+[^\s]+[\w]` 

 ** PublisherStatus **   
Whether the publisher is verified. Currently, all registered publishers are verified.  
Type: String  
Valid Values: `VERIFIED | UNVERIFIED` 

## Errors
<a name="API_DescribePublisher_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_DescribePublisher_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribePublisher) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribePublisher) 

# DescribeResourceScan
<a name="API_DescribeResourceScan"></a>

Describes details of a resource scan.

## Request Parameters
<a name="API_DescribeResourceScan_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ResourceScanId **   
The Amazon Resource Name (ARN) of the resource scan.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeResourceScan_ResponseElements"></a>

The following elements are returned by the service.

 ** EndTime **   
The time that the resource scan was finished.  
Type: Timestamp

 ** PercentageCompleted **   
The percentage of the resource scan that has been completed.  
Type: Double

 ** ResourceScanId **   
The Amazon Resource Name (ARN) of the resource scan. The format is `arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}`. An example is `arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 `.  
Type: String

 ** ResourcesRead **   
The number of resources that were read. This is only available for scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED`.  
This field may be 0 if the resource scan failed with a `ResourceScanLimitExceededException`.
Type: Integer

 ** ResourcesScanned **   
The number of resources that were listed. This is only available for scans with a `Status` set to `COMPLETE`, `EXPIRED`, or `FAILED `.  
Type: Integer

 **ResourceTypes.member.N**   
The list of resource types for the specified scan. Resource types are only available for scans with a `Status` set to `COMPLETE` or `FAILED `.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.

 **ScanFilters.member.N**   
The scan filters that were used.  
Type: Array of [ScanFilter](API_ScanFilter.md) objects  
Array Members: Fixed number of 1 item.

 ** StartTime **   
The time that the resource scan was started.  
Type: Timestamp

 ** Status **   
Status of the resource scan.    
 **IN\$1PROGRESS**   
The resource scan is still in progress.  
 **COMPLETE**   
The resource scan is complete.  
 **EXPIRED**   
The resource scan has expired.  
 **FAILED**   
The resource scan has failed.
Type: String  
Valid Values: `IN_PROGRESS | FAILED | COMPLETE | EXPIRED` 

 ** StatusReason **   
The reason for the resource scan status, providing more information if a failure happened.  
Type: String

## Errors
<a name="API_DescribeResourceScan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceScanNotFound **   
The resource scan was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeResourceScan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeResourceScan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeResourceScan) 

# DescribeStackDriftDetectionStatus
<a name="API_DescribeStackDriftDetectionStatus"></a>

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has *drifted*, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see [Detect unmanaged configuration changes to stacks and resources with drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

Use [DetectStackDrift](API_DetectStackDrift.md) to initiate a stack drift detection operation. `DetectStackDrift` returns a `StackDriftDetectionId` you can use to monitor the progress of the operation using `DescribeStackDriftDetectionStatus`. Once the drift detection operation has completed, use [DescribeStackResourceDrifts](API_DescribeStackResourceDrifts.md) to return drift information about the stack and its resources.

## Request Parameters
<a name="API_DescribeStackDriftDetectionStatus_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** StackDriftDetectionId **   
The ID of the drift detection results of this operation.  
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Required: Yes

## Response Elements
<a name="API_DescribeStackDriftDetectionStatus_ResponseElements"></a>

The following elements are returned by the service.

 ** DetectionStatus **   
The status of the stack drift detection operation.  
+  `DETECTION_COMPLETE`: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

  If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.
+  `DETECTION_FAILED`: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
+  `DETECTION_IN_PROGRESS`: The stack drift detection operation is currently in progress.
Type: String  
Valid Values: `DETECTION_IN_PROGRESS | DETECTION_FAILED | DETECTION_COMPLETE` 

 ** DetectionStatusReason **   
The reason the stack drift detection operation has its current status.  
Type: String

 ** DriftedStackResourceCount **   
Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of `DETECTION_COMPLETE`. This value will be 0 for stacks whose drift status is `IN_SYNC`.  
Type: Integer

 ** StackDriftDetectionId **   
The ID of the drift detection results of this operation.  
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.

 ** StackDriftStatus **   
Status of the stack's actual configuration compared to its expected configuration.  
+  `DRIFTED`: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
+  `NOT_CHECKED`: CloudFormation hasn't checked if the stack differs from its expected template configuration.
+  `IN_SYNC`: The stack's actual configuration matches its expected template configuration.
+  `UNKNOWN`: CloudFormation could not run drift detection for a resource in the stack. See the `DetectionStatusReason` for details.
Type: String  
Valid Values: `DRIFTED | IN_SYNC | UNKNOWN | NOT_CHECKED` 

 ** StackId **   
The ID of the stack.  
Type: String

 ** Timestamp **   
Time at which the stack drift detection operation was initiated.  
Type: Timestamp

## Errors
<a name="API_DescribeStackDriftDetectionStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeStackDriftDetectionStatus_Examples"></a>

### DescribeStackDriftDetectionStatus
<a name="API_DescribeStackDriftDetectionStatus_Example_1"></a>

This example illustrates one usage of DescribeStackDriftDetectionStatus.

#### Sample Request
<a name="API_DescribeStackDriftDetectionStatus_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackDriftDetectionStatus
 &Version=2010-05-15
 &StackDriftDetectionId=b78ac9b0-dec1-11e7-a451-503a3example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20171211T230005Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackDriftDetectionStatus_Example_1_Response"></a>

```
<DescribeStackDriftDetectionStatusResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeStackDriftDetectionStatusResult>
    <DetectionStatus>DETECTION_COMPLETE</DetectionStatus>
    <StackDriftDetectionId>b78ac9b0-dec1-11e7-a451-503a3example</StackDriftDetectionId>
    <DriftedStackResourceCount>0</DriftedStackResourceCount>
    <StackId>arn:aws:cloudformation:us-east-1:012345678910:stack/example/cb438120-6cc7-11e7-998e-50example</StackId>
    <StackDriftStatus>IN_SYNC</StackDriftStatus>
    <Timestamp>2017-12-11T22:22:04.747Z</Timestamp>
  </DescribeStackDriftDetectionStatusResult>
  <ResponseMetadata>
    <RequestId>f89bbda1-dec1-11e7-83c6-d92bexample</RequestId>
  </ResponseMetadata>
</DescribeStackDriftDetectionStatusResponse>
```

## See Also
<a name="API_DescribeStackDriftDetectionStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus) 

# DescribeStackEvents
<a name="API_DescribeStackEvents"></a>

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see [Understand CloudFormation stack creation events](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html) in the * AWS CloudFormation User Guide*.

**Note**  
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

## Request Parameters
<a name="API_DescribeStackEvents_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackName **   
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:  
+ Running stacks: You can specify either the stack's name or its unique stack ID.
+ Deleted stacks: You must specify the unique stack ID.
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeStackEvents_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **StackEvents.member.N**   
A list of `StackEvents` structures.  
Type: Array of [StackEvent](API_StackEvent.md) objects

## Errors
<a name="API_DescribeStackEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeStackEvents_Examples"></a>

### DescribeStackEvents
<a name="API_DescribeStackEvents_Example_1"></a>

This example illustrates one usage of DescribeStackEvents.

#### Sample Request
<a name="API_DescribeStackEvents_Example_1_Request"></a>

```
            https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackEvents
 &StackName=MyStack
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackEvents_Example_1_Response"></a>

```
<DescribeStackEventsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeStackEventsResult>
    <StackEvents>
      <member>
        <Timestamp>2016-03-15T20:54:31.809Z</Timestamp>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <EventId>1dedea10-eaf0-11e5-8451-500c5242948e</EventId>
        <LogicalResourceId>SampleStack</LogicalResourceId>
        <StackName>SampleStack</StackName>
        <PhysicalResourceIdI>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</PhysicalResourceId>
        <ResourceType>AWS::CloudFormation::Stack</ResourceType>
      </member>
      <member>
        <Timestamp>2016-03-15T20:54:30.174Z</Timestamp>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <EventId>MyEC2Instance-CREATE_COMPLETE-2016-03-15T20:54:30.174Z</EventId>
        <LogicalResourceId>MyEC2Instance</LogicalResourceId>
        <StackName>SampleStack</StackName>
        <PhysicalResourceId>i-1abc23d4</PhysicalResourceId>
        <ResourceProperties>{"ImageId":ami-8fcee4e5",...}</ResourceProperties>
        <ResourceType>AWS::EC2::Instance</ResourceType>
      </member>
      <member>
        <Timestamp>2016-03-15T20:53:17.660Z</Timestamp>
        <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <EventId>MyEC2Instance-CREATE_IN_PROGRESS-2016-03-15T20:53:17.660Z</EventId>
        <LogicalResourceId>MyEC2Instance</LogicalResourceId>
        <ResourceStatusReason>Resource creation Initiated</ResourceStatusReason>
        <StackName>SampleStack</StackName>
        <PhysicalResourceId>i-1abc23d4</PhysicalResourceId>
        <ResourceProperties>{"ImageId":ami-8fcee4e5",...}</ResourceProperties>
        <ResourceType>AWS::EC2::Instance</ResourceType>
      </member>
      <member>
        <Timestamp>2016-03-15T20:53:16.516Z</Timestamp>
        <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <EventId>MyEC2Instance-CREATE_IN_PROGRESS-2016-03-15T20:53:16.516Z</EventId>
        <LogicalResourceId>MyEC2Instance</LogicalResourceId>
        <StackName>SampleStack</StackName>
        <PhysicalResourceId/>
        <ResourceProperties>{"ImageId":ami-8fcee4e5",...}</ResourceProperties>
        <ResourceType>AWS::EC2::Instance</ResourceType>
      </member>
      <member>
        <Timestamp>2016-03-15T20:53:11.231Z</Timestamp>
        <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <EventId>edbf2ac0-eaef-11e5-adeb-500c28903236</EventId>
        <LogicalResourceId>SampleStack</LogicalResourceId>
        <ResourceStatusReason>User Initiated</ResourceStatusReason>
        <StackName>SampleStack</StackName>
        <PhysicalResourceIdI>arn:aws:cloudformation:us-east-1:123456789012:stack/SampleStack/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</PhysicalResourceId>
        <ResourceType>AWS::CloudFormation::Stack</ResourceType>
      </member>
    </StackEvents>
  </DescribeStackEventsResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</DescribeStackEventsResponse>
```

## See Also
<a name="API_DescribeStackEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackEvents) 

# DescribeStackInstance
<a name="API_DescribeStackInstance"></a>

Returns the stack instance that's associated with the specified StackSet, AWS account, and AWS Region.

For a list of stack instances that are associated with a specific StackSet, use [ListStackInstances](API_ListStackInstances.md).

## Request Parameters
<a name="API_DescribeStackInstance_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** StackInstanceAccount **   
The ID of an AWS account that's associated with this stack instance.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: Yes

 ** StackInstanceRegion **   
The name of a Region that's associated with this stack instance.  
Type: String  
Pattern: `^[a-zA-Z0-9-]{1,128}$`   
Required: Yes

 ** StackSetName **   
The name or the unique stack ID of the StackSet that you want to get stack instance information for.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeStackInstance_ResponseElements"></a>

The following element is returned by the service.

 ** StackInstance **   
The stack instance that matches the specified request parameters.  
Type: [StackInstance](API_StackInstance.md) object

## Errors
<a name="API_DescribeStackInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** StackInstanceNotFound **   
The specified stack instance doesn't exist.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeStackInstance_Examples"></a>

### DescribeStackInstance
<a name="API_DescribeStackInstance_Example_1"></a>

This example illustrates one usage of DescribeStackInstance.

#### Sample Request
<a name="API_DescribeStackInstance_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackInstance
 &StackInstanceRegion=ap-northeast-2
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &StackInstanceAccount=012345678910
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackInstance_Example_1_Response"></a>

```
<DescribeStackInstanceResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DescribeStackInstanceResult>
    <StackInstance>
      <DriftStatus>IN_SYNC</DriftStatus>
      <StackSetId>stack-set-example:45331555-4b18-45a1-aa43-ecf5example</StackSetId>
      <StackId>arn:aws:cloudformation:ap-northeast-2:012345678910:stack/StackSet-stack-set-example-0ca3eed7-0b67-4be7-8a71-828641fa5193/ea68eca0-f9c1-11e9-aac0-0aaexample</StackId>
      <ParameterOverrides/>
      <Region>ap-northeast-2</Region>
      <Account>012345678910</Account>
      <LastDriftCheckTimestamp>2019-12-03T20:01:04.511Z</LastDriftCheckTimestamp>
      <Status>CURRENT</Status>
    </StackInstance>
  </DescribeStackInstanceResult>
  <ResponseMetadata>
    <RequestId>afc959f5-a87c-4e16-95a9-ca25example</RequestId>
  </ResponseMetadata>
</DescribeStackInstanceResponse>
```

## See Also
<a name="API_DescribeStackInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackInstance) 

# DescribeStackRefactor
<a name="API_DescribeStackRefactor"></a>

Describes the stack refactor status.

## Request Parameters
<a name="API_DescribeStackRefactor_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** StackRefactorId **   
The ID associated with the stack refactor created from the [CreateStackRefactor](API_CreateStackRefactor.md) action.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeStackRefactor_ResponseElements"></a>

The following elements are returned by the service.

 ** Description **   
A description to help you identify the refactor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** ExecutionStatus **   
The stack refactor execution operation status that's provided after calling the [ExecuteStackRefactor](API_ExecuteStackRefactor.md) action.  
Type: String  
Valid Values: `UNAVAILABLE | AVAILABLE | OBSOLETE | EXECUTE_IN_PROGRESS | EXECUTE_COMPLETE | EXECUTE_FAILED | ROLLBACK_IN_PROGRESS | ROLLBACK_COMPLETE | ROLLBACK_FAILED` 

 ** ExecutionStatusReason **   
A detailed explanation for the stack refactor `ExecutionStatus`.  
Type: String

 **StackIds.member.N**   
The unique ID for each stack.  
Type: Array of strings

 ** StackRefactorId **   
The ID associated with the stack refactor created from the [CreateStackRefactor](API_CreateStackRefactor.md) action.  
Type: String

 ** Status **   
The stack refactor operation status that's provided after calling the [CreateStackRefactor](API_CreateStackRefactor.md) action.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED | DELETE_IN_PROGRESS | DELETE_COMPLETE | DELETE_FAILED` 

 ** StatusReason **   
A detailed explanation for the stack refactor operation `Status`.  
Type: String

## Errors
<a name="API_DescribeStackRefactor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** StackRefactorNotFound **   
The specified stack refactor can't be found.  
HTTP Status Code: 404

## See Also
<a name="API_DescribeStackRefactor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackRefactor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackRefactor) 

# DescribeStackResource
<a name="API_DescribeStackResource"></a>

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

## Request Parameters
<a name="API_DescribeStackResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** LogicalResourceId **   
The logical name of the resource as specified in the template.  
Type: String  
Required: Yes

 ** StackName **   
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:  
+ Running stacks: You can specify either the stack's name or its unique stack ID.
+ Deleted stacks: You must specify the unique stack ID.
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeStackResource_ResponseElements"></a>

The following element is returned by the service.

 ** StackResourceDetail **   
A `StackResourceDetail` structure that contains the description of the specified resource in the specified stack.  
Type: [StackResourceDetail](API_StackResourceDetail.md) object

## Errors
<a name="API_DescribeStackResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeStackResource_Examples"></a>

### DescribeStackResource
<a name="API_DescribeStackResource_Example_1"></a>

This example illustrates one usage of DescribeStackResource.

#### Sample Request
<a name="API_DescribeStackResource_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackResource
 &StackName=MyStack
 &LogicalResourceId=MyDBInstance
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2011-07-08T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackResource_Example_1_Response"></a>

```
<DescribeStackResourceResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeStackResourceResult>
    <StackResourceDetail>
      <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
      <StackName>MyStack</StackName>
      <LogicalResourceId>MyDBInstance</LogicalResourceId>
      <PhysicalResourceId>MyStack_DB1</PhysicalResourceId>
      <ResourceType>AWS::RDS::DBInstance</ResourceType>
      <LastUpdatedTimestamp>2011-07-07T22:27:28Z</LastUpdatedTimestamp>
      <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
    </StackResourceDetail>
  </DescribeStackResourceResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</DescribeStackResourceResponse>
```

## See Also
<a name="API_DescribeStackResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackResource) 

# DescribeStackResourceDrifts
<a name="API_DescribeStackResourceDrifts"></a>

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

For a given stack, there will be one `StackResourceDrift` for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see [Resource type support for imports and drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html).

Use [DetectStackResourceDrift](API_DetectStackResourceDrift.md) to detect drift on individual resources, or [DetectStackDrift](API_DetectStackDrift.md) to detect drift on all supported resources for a given stack.

## Request Parameters
<a name="API_DescribeStackResourceDrifts_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackName **   
The name of the stack for which you want drift information.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

 **StackResourceDriftStatusFilters.member.N**   
The resource drift status values to use as filters for the resource drift results returned.  
+  `DELETED`: The resource differs from its expected template configuration in that the resource has been deleted.
+  `MODIFIED`: One or more resource properties differ from their expected template values.
+  `IN_SYNC`: The resource's actual configuration matches its expected template configuration.
+  `NOT_CHECKED`: CloudFormation doesn't currently return this value.
+  `UNKNOWN`: CloudFormation could not run drift detection for the resource.
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 4 items.  
Valid Values: `IN_SYNC | MODIFIED | DELETED | NOT_CHECKED | UNKNOWN | UNSUPPORTED`   
Required: No

## Response Elements
<a name="API_DescribeStackResourceDrifts_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `DescribeStackResourceDrifts` again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **StackResourceDrifts.member.N**   
Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.  
For a given stack, there will be one `StackResourceDrift` for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see [Resource type support for imports and drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html).  
Type: Array of [StackResourceDrift](API_StackResourceDrift.md) objects

## Errors
<a name="API_DescribeStackResourceDrifts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeStackResourceDrifts_Examples"></a>

### DescribeStackResourceDrifts
<a name="API_DescribeStackResourceDrifts_Example_1"></a>

This example illustrates one usage of DescribeStackResourceDrifts.

#### Sample Request
<a name="API_DescribeStackResourceDrifts_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackResourceDrifts
 &Version=2010-05-15
 &StackName=my-stack-with-resource-drift
 &StackResourceDriftStatusFilters.member.1=MODIFIED
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20171228T233658Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackResourceDrifts_Example_1_Response"></a>

```
<DescribeStackResourceDriftsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeStackResourceDriftsResult>
    <StackResourceDrifts>
      <member>
        <PropertyDifferences>
          <member>
            <ActualValue>120</ActualValue>
            <ExpectedValue>20</ExpectedValue>
            <DifferenceType>NOT_EQUAL</DifferenceType>
            <PropertyPath>/DelaySeconds</PropertyPath>
          </member>
          <member>
            <ActualValue>12</ActualValue>
            <ExpectedValue>10</ExpectedValue>
            <DifferenceType>NOT_EQUAL</DifferenceType>
            <PropertyPath>/RedrivePolicy/maxReceiveCount</PropertyPath>
          </member>
        </PropertyDifferences>
        <PhysicalResourceId>https://sqs.us-east-1.amazonaws.com/012345678910/my-stack-with-resource-drift-Queue-494PBHCO76H4</PhysicalResourceId>
        <ExpectedProperties>{
          "ReceiveMessageWaitTimeSeconds":0,
          "DelaySeconds":20,
          "RedrivePolicy":{
            "deadLetterTargetArn":"arn:aws:sqs:us-east-1:012345678910:my-stack-with-resource-drift-DLQ-1BCY7HHD5QIM3",
            "maxReceiveCount":10
            },
          "MessageRetentionPeriod":345600,
          "MaximumMessageSize":262144,
          "VisibilityTimeout":60,
          "QueueName":"my-stack-with-resource-drift-Queue-494PBHCO76H4"
        }
        </ExpectedProperties>
        <StackResourceDriftStatus>MODIFIED</StackResourceDriftStatus>
        <StackId>arn:aws:cloudformation:us-east-1:012345678910:stack/my-stack-with-resource-drift/489e5570-df85-11e7-a7d9-503acac5c0fd</StackId>
        <LogicalResourceId>Queue</LogicalResourceId>
        <ActualProperties>{
          "ReceiveMessageWaitTimeSeconds":0,
          "DelaySeconds":120,
          "RedrivePolicy":{
            "deadLetterTargetArn":"arn:aws:sqs:us-east-1:012345678910:my-stack-with-resource-drift-DLQ-1BCY7HHD5QIM3",
            "maxReceiveCount":12
            },
          "MessageRetentionPeriod":345600,
          "MaximumMessageSize":262144,
          "VisibilityTimeout":60,
          "QueueName":"my-stack-with-resource-drift-Queue-494PBHCO76H4"
          }
        </ActualProperties>
        <Timestamp>2017-12-28T23:18:45.997Z</Timestamp>
        <ResourceType>AWS::SQS::Queue</ResourceType>
      </member>
    </StackResourceDrifts>
  </DescribeStackResourceDriftsResult>
  <ResponseMetadata>
    <RequestId>fee6d615-ec27-11e7-948a-0bec95751ba6</RequestId>
  </ResponseMetadata>
</DescribeStackResourceDriftsResponse>
```

## See Also
<a name="API_DescribeStackResourceDrifts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackResourceDrifts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackResourceDrifts) 

# DescribeStackResources
<a name="API_DescribeStackResources"></a>

Returns AWS resource descriptions for running and deleted stacks. If `StackName` is specified, all the associated resources that are part of the stack are returned. If `PhysicalResourceId` is specified, the associated resources of the stack that the resource belongs to are returned.

**Note**  
Only the first 100 resources will be returned. If your stack has more resources than this, you should use `ListStackResources` instead.

For deleted stacks, `DescribeStackResources` returns resource information for up to 90 days after the stack has been deleted.

You must specify either `StackName` or `PhysicalResourceId`, but not both. In addition, you can specify `LogicalResourceId` to filter the returned result. For more information about resources, the `LogicalResourceId` and `PhysicalResourceId`, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/).

**Note**  
A `ValidationError` is returned if you specify both `StackName` and `PhysicalResourceId` in the same request.

## Request Parameters
<a name="API_DescribeStackResources_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** LogicalResourceId **   
The logical name of the resource as specified in the template.  
Type: String  
Required: No

 ** PhysicalResourceId **   
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.  
For example, for an Amazon Elastic Compute Cloud (EC2) instance, `PhysicalResourceId` corresponds to the `InstanceId`. You can pass the EC2 `InstanceId` to `DescribeStackResources` to find which stack the instance belongs to and what other resources are part of the stack.  
Required: Conditional. If you don't specify `PhysicalResourceId`, you must specify `StackName`.  
Type: String  
Required: No

 ** StackName **   
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:  
+ Running stacks: You can specify either the stack's name or its unique stack ID.
+ Deleted stacks: You must specify the unique stack ID.
Required: Conditional. If you don't specify `StackName`, you must specify `PhysicalResourceId`.  
Type: String  
Required: No

## Response Elements
<a name="API_DescribeStackResources_ResponseElements"></a>

The following element is returned by the service.

 **StackResources.member.N**   
A list of `StackResource` structures.  
Type: Array of [StackResource](API_StackResource.md) objects

## Errors
<a name="API_DescribeStackResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeStackResources_Examples"></a>

### DescribeStackResources
<a name="API_DescribeStackResources_Example_1"></a>

This example illustrates one usage of DescribeStackResources.

#### Sample Request
<a name="API_DescribeStackResources_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackResources
 &StackName=MyStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackResources_Example_1_Response"></a>

```
<DescribeStackResourcesResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeStackResourcesResult>
    <StackResources>
      <member>
        <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
        <StackName>MyStack</StackName>
        <LogicalResourceId>MyDBInstance</LogicalResourceId>
        <PhysicalResourceId>MyStack_DB1</PhysicalResourceId>
        <ResourceType>AWS::DBInstance</ResourceType>
        <Timestamp>2010-07-27T22:27:28Z</Timestamp>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
      </member>
      <member>
        <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
        <StackName>MyStack</StackName>
        <LogicalResourceId>MyAutoScalingGroup</LogicalResourceId>
        <PhysicalResourceId>MyStack_ASG1</PhysicalResourceId>
        <ResourceType>AWS::AutoScalingGroup</ResourceType>
        <Timestamp>2010-07-27T22:28:28Z</Timestamp>
        <ResourceStatus>CREATE_IN_PROGRESS</ResourceStatus>
      </member>
    </StackResources>
  </DescribeStackResourcesResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</DescribeStackResourcesResponse>
```

## See Also
<a name="API_DescribeStackResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackResources) 

# DescribeStacks
<a name="API_DescribeStacks"></a>

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see [Understand CloudFormation stack creation events](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html) in the * AWS CloudFormation User Guide*.

**Note**  
If the stack doesn't exist, a `ValidationError` is returned.

## Request Parameters
<a name="API_DescribeStacks_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackName **   
If you don't pass a parameter to `StackName`, the API returns a response that describes all resources in the account, which can impact performance. This requires `ListStacks` and `DescribeStacks` permissions.  
Consider using the [ListStacks](API_ListStacks.md) API if you're not passing a parameter to `StackName`.  
The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:  
\$1 "Version": "2012-10-17", "Statement": [\$1 "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:\$1:\$1:stack/\$1/\$1" \$1] \$1
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:  
+ Running stacks: You can specify either the stack's name or its unique stack ID.
+ Deleted stacks: You must specify the unique stack ID.
Type: String  
Required: No

## Response Elements
<a name="API_DescribeStacks_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Stacks.member.N**   
A list of stack structures.  
Type: Array of [Stack](API_Stack.md) objects

## Errors
<a name="API_DescribeStacks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DescribeStacks_Examples"></a>

### DescribeStacks
<a name="API_DescribeStacks_Example_1"></a>

This example illustrates one usage of DescribeStacks.

#### Sample Request
<a name="API_DescribeStacks_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStacks
 &StackName=MyStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStacks_Example_1_Response"></a>

```
<DescribeStacksResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeStacksResult>
    <Stacks>
      <member>
        <StackName>MyStack</StackName>
        <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
        <CreationTime>2010-07-27T22:28:28Z</CreationTime>
        <StackStatus>CREATE_COMPLETE</StackStatus>
        <DisableRollback>false</DisableRollback>
        <Outputs>
          <member>
            <OutputKey>StartPage</OutputKey>
            <OutputValue>http://my-load-balancer.amazonaws.com:80/index.html</OutputValue>
          </member>
        </Outputs>
      </member>
    </Stacks>
  </DescribeStacksResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</DescribeStacksResponse>
```

## See Also
<a name="API_DescribeStacks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStacks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStacks) 

# DescribeStackSet
<a name="API_DescribeStackSet"></a>

Returns the description of the specified StackSet.

**Note**  
This API provides *strongly consistent* reads meaning it will always return the most up-to-date data.

## Request Parameters
<a name="API_DescribeStackSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet whose description you want.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeStackSet_ResponseElements"></a>

The following element is returned by the service.

 ** StackSet **   
The specified StackSet.  
Type: [StackSet](API_StackSet.md) object

## Errors
<a name="API_DescribeStackSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeStackSet_Examples"></a>

### DescribeStackSet
<a name="API_DescribeStackSet_Example_1"></a>

This example illustrates one usage of DescribeStackSet.

#### Sample Request
<a name="API_DescribeStackSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackSet
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackSet_Example_1_Response"></a>

```
<DescribeStackSetResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DescribeStackSetResult>
    <StackSet>
      <Capabilities>
        <member>CAPABILITY_IAM</member>
      </Capabilities>
      <StackSetId>stack-set-example:c14cd6d1-cd17-40bd-82ed-ff97example</StackSetId>
      <TemplateBody>
        [details omitted]
      </TemplateBody>
      <StackSetName>stack-set-example</StackSetName>
      <Description>Enable AWS Config</Description>
      <Parameters>
        <member>
          <ParameterKey>AllSupported</ParameterKey>
          <UsePreviousValue>false</UsePreviousValue>
          <ParameterValue>true</ParameterValue>
        </member>
        <member>
          <ParameterKey>DeliveryChannelName</ParameterKey>
          <UsePreviousValue>false</UsePreviousValue>
          <ParameterValue><Generated></ParameterValue>
        </member>
        <member>
          <ParameterKey>Frequency</ParameterKey>
          <UsePreviousValue>false</UsePreviousValue>
          <ParameterValue>24hours</ParameterValue>
        </member>
        <member>
          <ParameterKey>IncludeGlobalResourceTypes</ParameterKey>
          <UsePreviousValue>false</UsePreviousValue>
          <ParameterValue>true</ParameterValue>
        </member>
        <member>
          <ParameterKey>NotificationEmail</ParameterKey>
          <UsePreviousValue>false</UsePreviousValue>
          <ParameterValue><None></ParameterValue>
        </member>
        <member>
          <ParameterKey>ResourceTypes</ParameterKey>
          <UsePreviousValue>false</UsePreviousValue>
          <ParameterValue><All></ParameterValue>
        </member>
        <member>
          <ParameterKey>TopicArn</ParameterKey>
          <UsePreviousValue>false</UsePreviousValue>
          <ParameterValue><New Topic></ParameterValue>
        </member>
      </Parameters>
      <Tags>
        <member>
          <Value>marketing</Value>
          <Key>business-unit</Key>
        </member>
      </Tags>
      <StackSetDriftDetectionDetails>
        <DriftDetectionStatus>COMPLETED</DriftDetectionStatus>
        <InSyncStackInstancesCount>5</InSyncStackInstancesCount>
        <FailedStackInstancesCount>0</FailedStackInstancesCount>
        <DriftStatus>IN_SYNC</DriftStatus>
        <TotalStackInstancesCount>5</TotalStackInstancesCount>
        <DriftedStackInstancesCount>0</DriftedStackInstancesCount>
        <InProgressStackInstancesCount>0</InProgressStackInstancesCount>
        <LastDriftCheckTimestamp>2019-12-03T20:00:27.877Z</LastDriftCheckTimestamp>
      </StackSetDriftDetectionDetails>
      <Status>ACTIVE</Status>
    </StackSet>
  </DescribeStackSetResult>
  <ResponseMetadata>
    <RequestId>48d13e76-794b-11e7-95e6-f946example</RequestId>
  </ResponseMetadata>
</DescribeStackSetResponse>
```

### How to view which Regions a StackSet has stack instances deployed to.
<a name="API_DescribeStackSet_Example_2"></a>

Use the `DescribeStackSets` API to output a list of Regions. This list consists of Regions where a given StackSet has stack instances deployed.

In the following example, the StackSet named "MyStackSet" has stack instances deployed in Regions "us-east-1" and "us-west-2":

```
{
    "StackSet": {
        "StackSetName": "MyStackSet",
        //...
        "Regions": [
            "us-east-1",
            "us-west-2"
        ]
    }
}
```

## See Also
<a name="API_DescribeStackSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackSet) 

# DescribeStackSetOperation
<a name="API_DescribeStackSetOperation"></a>

Returns the description of the specified StackSet operation.

**Note**  
This API provides *strongly consistent* reads meaning it will always return the most up-to-date data.

## Request Parameters
<a name="API_DescribeStackSetOperation_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** OperationId **   
The unique ID of the StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: Yes

 ** StackSetName **   
The name or the unique stack ID of the StackSet for the stack operation.  
Type: String  
Required: Yes

## Response Elements
<a name="API_DescribeStackSetOperation_ResponseElements"></a>

The following element is returned by the service.

 ** StackSetOperation **   
The specified StackSet operation.  
Type: [StackSetOperation](API_StackSetOperation.md) object

## Errors
<a name="API_DescribeStackSetOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OperationNotFound **   
The specified ID refers to an operation that doesn't exist.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeStackSetOperation_Examples"></a>

### Describing an Update StackSet Operation
<a name="API_DescribeStackSetOperation_Example_1"></a>

The following example returns information about a successful update of a StackSet and its associated stack instances.

#### Sample Request
<a name="API_DescribeStackSetOperation_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackSetOperation
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &OperationId=61806005-bde9-46f1-949d-6791example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackSetOperation_Example_1_Response"></a>

```
<DescribeStackSetOperationResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DescribeStackSetOperationResult>
    <StackSetOperation>
      <StackSetId>stack-set-example:c14cd6d1-cd17-40bd-82ed-ff97example</StackSetId>
      <CreationTimestamp>2017-08-04T18:01:29.508Z</CreationTimestamp>
      <OperationId>ddf16f54-ad62-4d9b-b0ab-3ed8e9example</OperationId>
      <Action>UPDATE</Action>
      <OperationPreferences>
        <FailureToleranceCount>0</FailureToleranceCount>
        <MaxConcurrentCount>1</MaxConcurrentCount>
        <RegionOrder/>
      </OperationPreferences>
      <EndTimestamp>2017-08-04T18:03:43.672Z</EndTimestamp>
      <Status>SUCCEEDED</Status>
    </StackSetOperation>
  </DescribeStackSetOperationResult>
  <ResponseMetadata>
    <RequestId>20133b62-7e1a-11e7-838a-a182example</RequestId>
  </ResponseMetadata>
</DescribeStackSetOperationResponse>
```

### Describing a Drift Detection StackSet Operation
<a name="API_DescribeStackSetOperation_Example_2"></a>

The following example returns information about a drift detection operation run on a StackSet.

#### Sample Request
<a name="API_DescribeStackSetOperation_Example_2_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeStackSetOperation
 &Version=2010-05-15
 &StackSetName=stack-set-drift-example
 &OperationId=9cc082fa-df4c-45cd-b9a8-7e5example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191203T201942Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeStackSetOperation_Example_2_Response"></a>

```
<DescribeStackSetOperationResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DescribeStackSetOperationResult>
    <StackSetOperation>
      <ExecutionRoleName>AWSCloudFormationStackSetExecutionRole</ExecutionRoleName>
      <AdministrationRoleARN>arn:aws:iam::012345678910:role/AWSCloudFormationStackSetAdministrationRole</AdministrationRoleARN>
      <StackSetId>stack-set-drift-example:bd1f4017-d4f9-432e-a73f-8c22eb708dd5</StackSetId>
      <OperationPreferences>
        <RegionOrder/>
      </OperationPreferences>
      <StackSetDriftDetectionDetails>
        <InSyncStackInstancesCount>2</InSyncStackInstancesCount>
        <FailedStackInstancesCount>0</FailedStackInstancesCount>
        <DriftStatus>DRIFTED</DriftStatus>
        <TotalStackInstancesCount>7</TotalStackInstancesCount>
        <DriftedStackInstancesCount>1</DriftedStackInstancesCount>
        <InProgressStackInstancesCount>4</InProgressStackInstancesCount>
        <LastDriftCheckTimestamp>2019-12-04T20:34:28.543Z</LastDriftCheckTimestamp>
      </StackSetDriftDetectionDetails>
      <CreationTimestamp>2019-12-04T20:33:13.673Z</CreationTimestamp>
      <OperationId>9cc082fa-df4c-45cd-b9a8-7e5example</OperationId>
      <Action>DETECT_DRIFT</Action>
      <Status>RUNNING</Status>
    </StackSetOperation>
  </DescribeStackSetOperationResult>
  <ResponseMetadata>
    <RequestId>e81844dc-6121-4b59-923a-e2417example</RequestId>
  </ResponseMetadata>
</DescribeStackSetOperationResponse>
```

## See Also
<a name="API_DescribeStackSetOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeStackSetOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeStackSetOperation) 

# DescribeType
<a name="API_DescribeType"></a>

Returns detailed information about an extension from the CloudFormation registry in your current account and Region.

If you specify a `VersionId`, `DescribeType` returns information about that specific extension version. Otherwise, it returns information about the default extension version.

For more information, see [Edit configuration data for extensions in your account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_DescribeType_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Arn **   
The Amazon Resource Name (ARN) of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+`   
Required: No

 ** PublicVersionNumber **   
The version number of a public third-party extension.  
Type: String  
Length Constraints: Minimum length of 5.  
Pattern: `^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$`   
Required: No

 ** PublisherId **   
The publisher ID of the extension publisher.  
Extensions provided by AWS are not assigned a publisher ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Pattern: `[0-9a-zA-Z]{12,40}`   
Required: No

 ** Type **   
The kind of extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

 ** VersionId **   
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.  
If you specify a `VersionId`, `DescribeType` returns information about that specific extension version. Otherwise, it returns information about the default extension version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9-]+`   
Required: No

## Response Elements
<a name="API_DescribeType_ResponseElements"></a>

The following elements are returned by the service.

 ** Arn **   
The Amazon Resource Name (ARN) of the extension.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

 ** AutoUpdate **   
Whether CloudFormation automatically updates the extension in this account and Region when a new *minor* version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see [Automatically use new versions of extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto) in the * AWS CloudFormation User Guide*.  
Type: Boolean

 ** ConfigurationSchema **   
A JSON string that represent the current configuration data for the extension in this account and Region.  
To set the configuration data for an extension, use [SetTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60000.  
Pattern: `[\s\S]+` 

 ** DefaultVersionId **   
The ID of the default version of the extension. The default version is used when the extension version isn't specified.  
This applies only to private extensions you have registered in your account. For public extensions, both those provided by AWS and published by third parties, CloudFormation returns `null`. For more information, see [RegisterType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).  
To set the default version of an extension, use [SetTypeDefaultVersion](API_SetTypeDefaultVersion.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9-]+` 

 ** DeprecatedStatus **   
The deprecation status of the extension version.  
Valid values include:  
+  `LIVE`: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
+  `DEPRECATED`: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.
For public third-party extensions, CloudFormation returns `null`.  
Type: String  
Valid Values: `LIVE | DEPRECATED` 

 ** Description **   
The description of the extension.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** DocumentationUrl **   
The URL of a page providing detailed documentation for this extension.  
Type: String  
Length Constraints: Maximum length of 4096.

 ** ExecutionRoleArn **   
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see [RegisterType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).  
If the registered extension calls any AWS APIs, you must create an * [IAM execution role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) * that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `arn:.+:iam::[0-9]{12}:role/.+` 

 ** IsActivated **   
Whether the extension is activated in the account and Region.  
This only applies to public third-party extensions. For all other extensions, CloudFormation returns `null`.  
Type: Boolean

 ** IsDefaultVersion **   
Whether the specified extension version is set as the default version.  
This applies only to private extensions you have registered in your account, and extensions published by AWS. For public third-party extensions, whether they are activated in your account, CloudFormation returns `null`.  
Type: Boolean

 ** LastUpdated **   
When the specified extension version was registered. This applies only to:  
+ Private extensions you have registered in your account. For more information, see [RegisterType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
+ Public extensions you have activated in your account with auto-update specified. For more information, see [ActivateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).
Type: Timestamp

 ** LatestPublicVersion **   
The latest version of a public extension *that is available* for use.  
This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns `null`.  
Type: String  
Length Constraints: Minimum length of 5.  
Pattern: `^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$` 

 ** LoggingConfig **   
Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by AWS and published by third parties, CloudFormation returns `null`. For more information, see [RegisterType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).  
Type: [LoggingConfig](API_LoggingConfig.md) object

 ** OriginalTypeArn **   
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

 ** OriginalTypeName **   
For public extensions that have been activated for this account and Region, the type name of the public extension.  
If you specified a `TypeNameAlias` when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of the public extension. For more information, see [Use aliases to refer to extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) in the * AWS CloudFormation User Guide*.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}` 

 ** ProvisioningType **   
For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.  
Valid values include:  
+  `FULLY_MUTABLE`: The resource type includes an update handler to process updates to the type during stack update operations.
+  `IMMUTABLE`: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
+  `NON_PROVISIONABLE`: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.
  + create
  + read
  + delete
Type: String  
Valid Values: `NON_PROVISIONABLE | IMMUTABLE | FULLY_MUTABLE` 

 ** PublicVersionNumber **   
The version number of a public third-party extension.  
This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns `null`.  
Type: String  
Length Constraints: Minimum length of 5.  
Pattern: `^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$` 

 ** PublisherId **   
The publisher ID of the extension publisher.  
This applies only to public third-party extensions. For private registered extensions, and extensions provided by AWS, CloudFormation returns `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Pattern: `[0-9a-zA-Z]{12,40}` 

 **RequiredActivatedTypes.member.N**   
For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.  
Type: Array of [RequiredActivatedType](API_RequiredActivatedType.md) objects

 ** Schema **   
The schema that defines the extension.  
For more information, see [Resource type schema](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) in the * AWS CloudFormation Command Line Interface (CLI) User Guide* and the [CloudFormation Hooks User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16777216.

 ** SourceUrl **   
The URL of the source code for the extension.  
Type: String  
Length Constraints: Maximum length of 4096.

 ** TimeCreated **   
When the specified private extension version was registered or activated in your account.  
Type: Timestamp

 ** Type **   
The kind of extension.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK` 

 ** TypeName **   
The name of the extension.  
If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see [ActivateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}` 

 ** TypeTestsStatus **   
The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify `VersionId`.  
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.  
+  `PASSED`: The extension has passed all its contract tests.

  An extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.
+  `FAILED`: The extension has failed one or more contract tests.
+  `IN_PROGRESS`: Contract tests are currently being performed on the extension.
+  `NOT_TESTED`: Contract tests haven't been performed on the extension.
Type: String  
Valid Values: `PASSED | FAILED | IN_PROGRESS | NOT_TESTED` 

 ** TypeTestsStatusDescription **   
The description of the test status. To return the extension test status of a specific extension version, you must specify `VersionId`.  
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[\s\S]+` 

 ** Visibility **   
The scope at which the extension is visible and usable in CloudFormation operations.  
Valid values include:  
+  `PRIVATE`: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register as `PRIVATE`.
+  `PUBLIC`: The extension is publicly visible and usable within any AWS account.
Type: String  
Valid Values: `PUBLIC | PRIVATE` 

## Errors
<a name="API_DescribeType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## Examples
<a name="API_DescribeType_Examples"></a>

### DescribeType
<a name="API_DescribeType_Example_1"></a>

This example illustrates one usage of DescribeType.

#### Sample Request
<a name="API_DescribeType_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeType
 &Version=2010-05-15
 &TypeName=My::Resource::Example
 &VersionId=00000002
 &Type=RESOURCE
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191203T234428Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeType_Example_1_Response"></a>

```
<DescribeTypeResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeTypeResult>
    <Schema>{
    [details omitted]
}
</Schema>
    <Visibility>PRIVATE</Visibility>
    <DeprecatedStatus>LIVE</DeprecatedStatus>
    <TypeName>My::Resource::Example</TypeName>
    <Description>Resource schema for My::Resource::Example</Description>
    <Type>RESOURCE</Type>
    <SourceUrl>https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-logs.git</SourceUrl>
    <LastUpdated>2019-12-03T23:29:33.321Z</LastUpdated>
    <ProvisioningType>FULLY_MUTABLE</ProvisioningType>
    <TimeCreated>2019-12-03T23:29:33.321Z</TimeCreated>
    <Arn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example/00000002</Arn>
  </DescribeTypeResult>
  <ResponseMetadata>
    <RequestId>8d2dd588-b16f-4096-8516-ee941example</RequestId>
  </ResponseMetadata>
</DescribeTypeResponse>
```

## See Also
<a name="API_DescribeType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeType) 

# DescribeTypeRegistration
<a name="API_DescribeTypeRegistration"></a>

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using [RegisterType](API_RegisterType.md), you can then use [DescribeTypeRegistration](#API_DescribeTypeRegistration) to monitor the progress of that registration request.

Once the registration request has completed, use [DescribeType](API_DescribeType.md) to return detailed information about an extension.

## Request Parameters
<a name="API_DescribeTypeRegistration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** RegistrationToken **   
The identifier for this registration request.  
This registration token is generated by CloudFormation when you initiate a registration request using [RegisterType](API_RegisterType.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: Yes

## Response Elements
<a name="API_DescribeTypeRegistration_ResponseElements"></a>

The following elements are returned by the service.

 ** Description **   
The description of the extension registration request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** ProgressStatus **   
The current status of the extension registration request.  
Type: String  
Valid Values: `COMPLETE | IN_PROGRESS | FAILED` 

 ** TypeArn **   
The Amazon Resource Name (ARN) of the extension being registered.  
For registration requests with a `ProgressStatus` of other than `COMPLETE`, this will be `null`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

 ** TypeVersionArn **   
The Amazon Resource Name (ARN) of this specific version of the extension being registered.  
For registration requests with a `ProgressStatus` of other than `COMPLETE`, this will be `null`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

## Errors
<a name="API_DescribeTypeRegistration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_DescribeTypeRegistration_Examples"></a>

### DescribeTypeRegistration while registration is in progress
<a name="API_DescribeTypeRegistration_Example_1"></a>

The following example shows a typical response to `DescribeTypeRegistration` while CloudFormation is in the process of registering the extension.

#### Sample Request
<a name="API_DescribeTypeRegistration_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeTypeRegistration
 &Version=2010-05-15
 &RegistrationToken=03458954-61b1-44e9-90d8-f1b81example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191203T232905Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeTypeRegistration_Example_1_Response"></a>

```
<DescribeTypeRegistrationResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeTypeRegistrationResult>
    <Description>Deployment is currently in VALIDATION_STAGE of status IN_PROGRESS; Next is DEPLOY_STAGE with status PENDING</Description>
    <ProgressStatus>IN_PROGRESS</ProgressStatus>
  </DescribeTypeRegistrationResult>
  <ResponseMetadata>
    <RequestId>5feae575-40a4-474c-b81c-ca861example</RequestId>
  </ResponseMetadata>
</DescribeTypeRegistrationResponse>
```

### DescribeTypeRegistration once registration complete
<a name="API_DescribeTypeRegistration_Example_2"></a>

The following example shows the response to `DescribeTypeRegistration` once CloudFormation has successfully completed registering the extension.

#### Sample Request
<a name="API_DescribeTypeRegistration_Example_2_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DescribeTypeRegistration
 &Version=2010-05-15
 &RegistrationToken=03458954-61b1-44e9-90d8-f1b81example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191203T233327Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DescribeTypeRegistration_Example_2_Response"></a>

```
<DescribeTypeRegistrationResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DescribeTypeRegistrationResult>
    <Description>Deployment is currently in DEPLOY_STAGE of status COMPLETED; </Description>
    <ProgressStatus>COMPLETE</ProgressStatus>
    <TypeArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example</TypeArn>
    <TypeVersionArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example/00000001</TypeVersionArn>
  </DescribeTypeRegistrationResult>
  <ResponseMetadata>
    <RequestId>2d187120-6f6e-4d43-80f5-99b588example</RequestId>
  </ResponseMetadata>
</DescribeTypeRegistrationResponse>
```

## See Also
<a name="API_DescribeTypeRegistration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DescribeTypeRegistration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DescribeTypeRegistration) 

# DetectStackDrift
<a name="API_DetectStackDrift"></a>

Detects whether a stack's actual configuration differs, or has *drifted*, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see [Detect unmanaged configuration changes to stacks and resources with drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

Use `DetectStackDrift` to detect drift on all supported resources for a given stack, or [DetectStackResourceDrift](API_DetectStackResourceDrift.md) to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see [Resource type support for imports and drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html).

 `DetectStackDrift` can take up to several minutes, depending on the number of resources contained within the stack. Use [DescribeStackDriftDetectionStatus](API_DescribeStackDriftDetectionStatus.md) to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use [DescribeStackResourceDrifts](API_DescribeStackResourceDrifts.md) to return drift information about the stack and its resources.

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform `DetectStackDrift` directly on the nested stack itself.

## Request Parameters
<a name="API_DetectStackDrift_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **LogicalResourceIds.member.N**   
The logical names of any resources you want to use as filters.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Required: No

 ** StackName **   
The name of the stack for which you want to detect drift.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

## Response Elements
<a name="API_DetectStackDrift_ResponseElements"></a>

The following element is returned by the service.

 ** StackDriftDetectionId **   
The ID of the drift detection results of this operation.  
CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.

## Errors
<a name="API_DetectStackDrift_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DetectStackDrift_Examples"></a>

### DetectStackDrift
<a name="API_DetectStackDrift_Example_1"></a>

This example illustrates one usage of DetectStackDrift.

#### Sample Request
<a name="API_DetectStackDrift_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DetectStackDrift
 &Version=2010-05-15
 &StackName=my-stack-with-resource-drift
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20171211T230005Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DetectStackDrift_Example_1_Response"></a>

```
<DetectStackDriftResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DetectStackDriftResult>
    <StackDriftDetectionId>2f2b2d60-df86-11e7-bea1-500c2example</StackDriftDetectionId>
  </DetectStackDriftResult>
  <ResponseMetadata>
    <RequestId>2f07c75d-df86-11e7-8270-89489example</RequestId>
  </ResponseMetadata>
</DetectStackDriftResponse>
```

## See Also
<a name="API_DetectStackDrift_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DetectStackDrift) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DetectStackDrift) 

# DetectStackResourceDrift
<a name="API_DetectStackResourceDrift"></a>

Returns information about whether a resource's actual configuration differs, or has *drifted*, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see [Detect unmanaged configuration changes to stacks and resources with drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

Use `DetectStackResourceDrift` to detect drift on individual resources, or [DetectStackDrift](API_DetectStackDrift.md) to detect drift on all resources in a given stack that support drift detection.

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see [Resource type support for imports and drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html).

## Request Parameters
<a name="API_DetectStackResourceDrift_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** LogicalResourceId **   
The logical name of the resource for which to return drift information.  
Type: String  
Required: Yes

 ** StackName **   
The name of the stack to which the resource belongs.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

## Response Elements
<a name="API_DetectStackResourceDrift_ResponseElements"></a>

The following element is returned by the service.

 ** StackResourceDrift **   
Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.  
Type: [StackResourceDrift](API_StackResourceDrift.md) object

## Errors
<a name="API_DetectStackResourceDrift_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_DetectStackResourceDrift_Examples"></a>

### DetectStackResourceDrift
<a name="API_DetectStackResourceDrift_Example_1"></a>

This example illustrates one usage of DetectStackResourceDrift.

#### Sample Request
<a name="API_DetectStackResourceDrift_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DetectStackResourceDrift
 &Version=2010-05-15
 &LogicalResourceId=Queue
 &StackName=my-stack-with-resource-drift
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20171211T230005Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DetectStackResourceDrift_Example_1_Response"></a>

```
<DetectStackResourceDriftResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <DetectStackResourceDriftResult>
    <StackResourceDrift>
      <PropertyDifferences>
        <member>
          <ActualValue>120</ActualValue>
          <ExpectedValue>20</ExpectedValue>
          <DifferenceType>NOT_EQUAL</DifferenceType>
          <PropertyPath>/DelaySeconds</PropertyPath>
        </member>
        <member>
          <ActualValue>12</ActualValue>
          <ExpectedValue>10</ExpectedValue>
          <DifferenceType>NOT_EQUAL</DifferenceType>
          <PropertyPath>/RedrivePolicy/maxReceiveCount</PropertyPath>
        </member>
      </PropertyDifferences>
      <PhysicalResourceId>https://sqs.us-east-1.amazonaws.com/012345678910/my-stack-with-resource-drift-Queue-494PBHCO76H4</PhysicalResourceId>
      <ExpectedProperties>{
        "ReceiveMessageWaitTimeSeconds":0,
        "DelaySeconds":20,
        "RedrivePolicy":{
          "deadLetterTargetArn":"arn:aws:sqs:us-east-1:012345678910:my-stack-with-resource-drift-DLQ-1BCY7HHD5QIM3",
          "maxReceiveCount":10
          },
        "MessageRetentionPeriod":345600,
        "MaximumMessageSize":262144,
        "VisibilityTimeout":60,
        "QueueName":"my-stack-with-resource-drift-Queue-494PBHCO76H4"
        }
      </ExpectedProperties>
      <StackResourceDriftStatus>MODIFIED</StackResourceDriftStatus>
      <StackId>arn:aws:cloudformation:us-east-1:012345678910:stack/my-stack-with-resource-drift/489e5570-df85-11e7-a7d9-503acac5c0fd</StackId>
      <LogicalResourceId>Queue</LogicalResourceId>
      <ActualProperties>{
        "ReceiveMessageWaitTimeSeconds":0,
        "DelaySeconds":120,
        "RedrivePolicy":{
          "deadLetterTargetArn":"arn:aws:sqs:us-east-1:012345678910:my-stack-with-resource-drift-DLQ-1BCY7HHD5QIM3",
          "maxReceiveCount":12
          },
        "MessageRetentionPeriod":345600,
        "MaximumMessageSize":262144,
        "VisibilityTimeout":60,
        "QueueName":"my-stack-with-resource-drift-Queue-494PBHCO76H4"
        }
      </ActualProperties>
      <Timestamp>2017-12-28T23:51:49.616Z</Timestamp>
      <ResourceType>AWS::SQS::Queue</ResourceType>
    </StackResourceDrift>
  </DetectStackResourceDriftResult>
  <ResponseMetadata>
    <RequestId>1229a48a-ec2a-11e7-a8e5-97a4c2fc6398</RequestId>
  </ResponseMetadata>
</DetectStackResourceDriftResponse>
```

## See Also
<a name="API_DetectStackResourceDrift_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DetectStackResourceDrift) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DetectStackResourceDrift) 

# DetectStackSetDrift
<a name="API_DetectStackSetDrift"></a>

Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. For more information, see [Performing drift detection on CloudFormation StackSets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html).

 `DetectStackSetDrift` returns the `OperationId` of the StackSet drift detection operation. Use this operation id with [DescribeStackSetOperation](API_DescribeStackSetOperation.md) to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the StackSet, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:
+ Use [DescribeStackSet](API_DescribeStackSet.md) to return detailed information about the stack set, including detailed information about the last *completed* drift operation performed on the StackSet. (Information about drift operations that are in progress isn't included.)
+ Use [ListStackInstances](API_ListStackInstances.md) to return a list of stack instances belonging to the StackSet, including the drift status and last drift time checked of each instance.
+ Use [DescribeStackInstance](API_DescribeStackInstance.md) to return detailed information about a specific stack instance, including its drift status and last drift time checked.

You can only run a single drift detection operation on a given StackSet at one time.

To stop a drift detection StackSet operation, use [StopStackSetOperation](API_StopStackSetOperation.md).

## Request Parameters
<a name="API_DetectStackSetDrift_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** OperationId **   
 *The ID of the StackSet operation.*   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** OperationPreferences **   
The user-specified preferences for how CloudFormation performs a StackSet operation.  
For more information about maximum concurrent accounts and failure tolerance, see [StackSet operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).  
Type: [StackSetOperationPreferences](API_StackSetOperationPreferences.md) object  
Required: No

 ** StackSetName **   
The name of the StackSet on which to perform the drift detection operation.  
Type: String  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?`   
Required: Yes

## Response Elements
<a name="API_DetectStackSetDrift_ResponseElements"></a>

The following element is returned by the service.

 ** OperationId **   
The ID of the drift detection StackSet operation.  
You can use this operation ID with [DescribeStackSetOperation](API_DescribeStackSetOperation.md) to monitor the progress of the drift detection operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_DetectStackSetDrift_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationInProgress **   
Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.  
HTTP Status Code: 409

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_DetectStackSetDrift_Examples"></a>

### DetectStackSetDrift
<a name="API_DetectStackSetDrift_Example_1"></a>

This example illustrates one usage of DetectStackSetDrift.

#### Sample Request
<a name="API_DetectStackSetDrift_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=DetectStackSetDrift
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &OperationId=9cc082fa-df4c-45cd-b9a8-7e56example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191203T195756Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_DetectStackSetDrift_Example_1_Response"></a>

```
<DetectStackSetDriftResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <DetectStackSetDriftResult>
    <OperationId>9cc082fa-df4c-45cd-b9a8-7e56example</OperationId>
  </DetectStackSetDriftResult>
  <ResponseMetadata>
    <RequestId>38309f0a-d5f5-4330-b6ca-8eb1example</RequestId>
  </ResponseMetadata>
</DetectStackSetDriftResponse>
```

## See Also
<a name="API_DetectStackSetDrift_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/DetectStackSetDrift) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/DetectStackSetDrift) 

# EstimateTemplateCost
<a name="API_EstimateTemplateCost"></a>

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

## Request Parameters
<a name="API_EstimateTemplateCost_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Parameters.member.N**   
A list of `Parameter` structures that specify input parameters.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 ** TemplateBody **   
Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.  
Conditional: You must pass `TemplateBody` or `TemplateURL`. If both are passed, only `TemplateBody` is used.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateURL **   
The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`. URLs from S3 static websites are not supported.  
Conditional: You must pass `TemplateURL` or `TemplateBody`. If both are passed, only `TemplateBody` is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

## Response Elements
<a name="API_EstimateTemplateCost_ResponseElements"></a>

The following element is returned by the service.

 ** Url **   
An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.  
Type: String

## Errors
<a name="API_EstimateTemplateCost_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_EstimateTemplateCost_Examples"></a>

### EstimateTemplateCost
<a name="API_EstimateTemplateCost_Example_1"></a>

This example illustrates one usage of EstimateTemplateCost.

#### Sample Request
<a name="API_EstimateTemplateCost_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=EstimateTemplateCost
 &TemplateURL= https://s3.amazonaws.com/cloudformation-samples-us-east-1/Drupal_Simple.template
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2011-12-04T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_EstimateTemplateCost_Example_1_Response"></a>

```
<Response xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <EstimateTemplateCostResult>
    <Url>http://calculator.s3.amazonaws.com/calc5.html?key=cf-2e351785-e821-450c-9d58-625e1e1ebfb6</Url>
  </EstimateTemplateCostResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</Response>
```

## See Also
<a name="API_EstimateTemplateCost_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/EstimateTemplateCost) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/EstimateTemplateCost) 

# ExecuteChangeSet
<a name="API_ExecuteChangeSet"></a>

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the [DescribeStacks](API_DescribeStacks.md) action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierarchy, `IncludeNestedStacks` must have been set to `True`.

## Request Parameters
<a name="API_ExecuteChangeSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ChangeSetName **   
The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*`   
Required: Yes

 ** ClientRequestToken **   
A unique identifier for this `ExecuteChangeSet` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry `ExecuteChangeSet` requests to ensure that CloudFormation successfully received them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** DisableRollback **   
Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the `OnStackFailure` parameter to the [CreateChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html) API operation was specified.  
+  `True` - if the stack creation fails, do nothing. This is equivalent to specifying `DO_NOTHING` for the `OnStackFailure` parameter to the [CreateChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html) API operation.
+  `False` - if the stack creation fails, roll back the stack. This is equivalent to specifying `ROLLBACK` for the `OnStackFailure` parameter to the [CreateChangeSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html) API operation.
Default: `True`   
Type: Boolean  
Required: No

 ** RetainExceptOnCreate **   
When set to `true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.  
Default: `false`   
Type: Boolean  
Required: No

 ** StackName **   
If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's associated with the change set you want to execute.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: No

## Errors
<a name="API_ExecuteChangeSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ChangeSetNotFound **   
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the `ListChangeSets` operation.  
HTTP Status Code: 404

 ** InsufficientCapabilities **   
The template contains resources with capabilities that weren't specified in the Capabilities parameter.  
HTTP Status Code: 400

 ** InvalidChangeSetStatus **   
The specified change set can't be used to update the stack. For example, the change set status might be `CREATE_IN_PROGRESS`, or the stack status might be `UPDATE_IN_PROGRESS`.  
HTTP Status Code: 400

 ** TokenAlreadyExists **   
A client request token already exists.  
HTTP Status Code: 400

## Examples
<a name="API_ExecuteChangeSet_Examples"></a>

### ExecuteChangeSet
<a name="API_ExecuteChangeSet_Example_1"></a>

This example illustrates one usage of ExecuteChangeSet.

#### Sample Request
<a name="API_ExecuteChangeSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ExecuteChangeSet
 &ChangeSetName=arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ExecuteChangeSet_Example_1_Response"></a>

```
<ExecuteChangeSetResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ExecuteChangeSetResult/>
  <ResponseMetadata>
    <RequestId>5ccc7dcd-744c-11e5-be70-example</RequestId>
  </ResponseMetadata>
</ExecuteChangeSetResponse>
```

## See Also
<a name="API_ExecuteChangeSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ExecuteChangeSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ExecuteChangeSet) 

# ExecuteStackRefactor
<a name="API_ExecuteStackRefactor"></a>

Executes the stack refactor operation.

## Request Parameters
<a name="API_ExecuteStackRefactor_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** StackRefactorId **   
The ID associated with the stack refactor created from the [CreateStackRefactor](API_CreateStackRefactor.md) action.  
Type: String  
Required: Yes

## Errors
<a name="API_ExecuteStackRefactor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ExecuteStackRefactor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ExecuteStackRefactor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ExecuteStackRefactor) 

# GetGeneratedTemplate
<a name="API_GetGeneratedTemplate"></a>

Retrieves a generated template. If the template is in an `InProgress` or `Pending` status then the template returned will be the template when the template was last in a `Complete` status. If the template has not yet been in a `Complete` status then an empty template will be returned.

## Request Parameters
<a name="API_GetGeneratedTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Format **   
The language to use to retrieve for the generated template. Supported values are:  
+  `JSON` 
+  `YAML` 
Type: String  
Valid Values: `JSON | YAML`   
Required: No

 ** GeneratedTemplateName **   
The name or Amazon Resource Name (ARN) of the generated template. The format is `arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}`. For example, `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_GetGeneratedTemplate_ResponseElements"></a>

The following elements are returned by the service.

 ** Status **   
The status of the template generation. Supported values are:  
+  `CreatePending` - the creation of the template is pending.
+  `CreateInProgress` - the creation of the template is in progress.
+  `DeletePending` - the deletion of the template is pending.
+  `DeleteInProgress` - the deletion of the template is in progress.
+  `UpdatePending` - the update of the template is pending.
+  `UpdateInProgress` - the update of the template is in progress.
+  `Failed` - the template operation failed.
+  `Complete` - the template operation is complete.
Type: String  
Valid Values: `CREATE_PENDING | UPDATE_PENDING | DELETE_PENDING | CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | FAILED | COMPLETE` 

 ** TemplateBody **   
The template body of the generated template, in the language specified by the `Language` parameter.  
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_GetGeneratedTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** GeneratedTemplateNotFound **   
The generated template was not found.  
HTTP Status Code: 404

## See Also
<a name="API_GetGeneratedTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/GetGeneratedTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/GetGeneratedTemplate) 

# GetHookResult
<a name="API_GetHookResult"></a>

Retrieves detailed information and remediation guidance for a Hook invocation result.

If the Hook uses a KMS key to encrypt annotations, callers of the `GetHookResult` operation must have `kms:Decrypt` permissions. For more information, see [AWS KMS key policy and permissions for encrypting AWS CloudFormation Hooks results at rest](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-kms-key-policy.html) in the * CloudFormation Hooks User Guide*.

## Request Parameters
<a name="API_GetHookResult_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** HookResultId **   
The unique identifier (ID) of the Hook invocation result that you want details about. You can get the ID from the [ListHookResults](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListHookResults.html) operation.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: No

## Response Elements
<a name="API_GetHookResult_ResponseElements"></a>

The following elements are returned by the service.

 **Annotations.member.N**   
A list of objects with additional information and guidance that can help you resolve a failed Hook invocation.  
Type: Array of [Annotation](API_Annotation.md) objects

 ** FailureMode **   
The failure mode of the invocation.  
Type: String  
Valid Values: `FAIL | WARN` 

 ** HookResultId **   
The unique identifier of the Hook result.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

 ** HookStatusReason **   
A message that provides additional details about the Hook invocation status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** InvocationPoint **   
The specific point in the provisioning process where the Hook is invoked.  
Type: String  
Valid Values: `PRE_PROVISION` 

 ** InvokedAt **   
The timestamp when the Hook was invoked.  
Type: Timestamp

 ** OriginalTypeName **   
The original public type name of the Hook when an alias is used.  
For example, if you activate `AWS::Hooks::GuardHook` with alias `MyCompany::Custom::GuardHook`, then `TypeName` will be `MyCompany::Custom::GuardHook` and `OriginalTypeName` will be `AWS::Hooks::GuardHook`.   
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 196.

 ** Status **   
The status of the Hook invocation. The following statuses are possible:  
+  `HOOK_IN_PROGRESS`: The Hook is currently running.
+  `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
+  `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
+  `HOOK_FAILED`: The Hook encountered an error during execution.
Type: String  
Valid Values: `HOOK_IN_PROGRESS | HOOK_COMPLETE_SUCCEEDED | HOOK_COMPLETE_FAILED | HOOK_FAILED` 

 ** Target **   
Information about the target of the Hook invocation.  
Type: [HookTarget](API_HookTarget.md) object

 ** TypeArn **   
The Amazon Resource Name (ARN) of the Hook.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/[A-Za-z0-9-]+/?` 

 ** TypeConfigurationVersionId **   
The version identifier of the Hook configuration data that was used during invocation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9-]+` 

 ** TypeName **   
The name of the Hook that was invoked.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 196.

 ** TypeVersionId **   
The version identifier of the Hook that was invoked.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9-]+` 

## Errors
<a name="API_GetHookResult_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** HookResultNotFound **   
The specified target doesn't have any requested Hook invocations.  
HTTP Status Code: 404

## See Also
<a name="API_GetHookResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/GetHookResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/GetHookResult) 

# GetStackPolicy
<a name="API_GetStackPolicy"></a>

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

## Request Parameters
<a name="API_GetStackPolicy_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** StackName **   
The name or unique stack ID that's associated with the stack whose policy you want to get.  
Type: String  
Required: Yes

## Response Elements
<a name="API_GetStackPolicy_ResponseElements"></a>

The following element is returned by the service.

 ** StackPolicyBody **   
Structure that contains the stack policy body. For more information, see [Prevent updates to stack resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the * AWS CloudFormation User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.

## Errors
<a name="API_GetStackPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_GetStackPolicy_Examples"></a>

### GetStackPolicy
<a name="API_GetStackPolicy_Example_1"></a>

This example illustrates one usage of GetStackPolicy.

#### Sample Request
<a name="API_GetStackPolicy_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=GetStackPolicy
 &StackName=MyStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_GetStackPolicy_Example_1_Response"></a>

```
<GetStackPolicyResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <GetStackPolicyResult>
      <StackPolicyBody>"{
      "Statement" : [
        {
          "Effect" : "Deny",
          "Action" : "Update:*",
          "Principal" : "*",
          "Resource" : "LogicalResourceId/ProductionDatabase"
        },
        {
          "Effect" : "Allow",
          "Action" : "Update:*",
          "Principal" : "*",
          "Resource" : "*"
        }
      ]
    }</StackPolicyBody>
  </GetStackPolicyResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</GetStackPolicyResponse>
```

## See Also
<a name="API_GetStackPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/GetStackPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/GetStackPolicy) 

# GetTemplate
<a name="API_GetTemplate"></a>

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, `GetTemplate` returns the template for up to 90 days after the stack has been deleted.

**Note**  
If the template doesn't exist, a `ValidationError` is returned.

## Request Parameters
<a name="API_GetTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ChangeSetName **   
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If you specify a name, you must also specify the `StackName`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*`   
Required: No

 ** StackName **   
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:  
+ Running stacks: You can specify either the stack's name or its unique stack ID.
+ Deleted stacks: You must specify the unique stack ID.
Type: String  
Required: No

 ** TemplateStage **   
For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify `Original`. To get the template after CloudFormation has processed all transforms, specify `Processed`.  
If the template doesn't include transforms, `Original` and `Processed` return the same template. By default, CloudFormation specifies `Processed`.  
Type: String  
Valid Values: `Original | Processed`   
Required: No

## Response Elements
<a name="API_GetTemplate_ResponseElements"></a>

The following elements are returned by the service.

 **StagesAvailable.member.N**   
The stage of the template that you can retrieve. For stacks, the `Original` and `Processed` templates are always available. For change sets, the `Original` template is always available. After CloudFormation finishes creating the change set, the `Processed` template becomes available.  
Type: Array of strings  
Valid Values: `Original | Processed` 

 ** TemplateBody **   
Structure that contains the template body.  
CloudFormation returns the same template that was used when the stack was created.  
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_GetTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ChangeSetNotFound **   
The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the `ListChangeSets` operation.  
HTTP Status Code: 404

## Examples
<a name="API_GetTemplate_Examples"></a>

### GetTemplate
<a name="API_GetTemplate_Example_1"></a>

This example illustrates one usage of GetTemplate.

#### Sample Request
<a name="API_GetTemplate_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=GetTemplate
 &StackName=MyStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_GetTemplate_Example_1_Response"></a>

```
<GetTemplateResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <GetTemplateResult>
    <TemplateBody>"{
    "AWSTemplateFormatVersion" : "2010-09-09",
    "Description" : "Simple example",
    "Resources" : {
      "MySQS" : {
        "Type" : "AWS::SQS::Queue",
        "Properties" : {
        }
      }
    }
  }</TemplateBody>
  </GetTemplateResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</GetTemplateResponse>
```

## See Also
<a name="API_GetTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/GetTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/GetTemplate) 

# GetTemplateSummary
<a name="API_GetTemplateSummary"></a>

Returns information about a new or existing template. The `GetTemplateSummary` action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or StackSet.

You can use the `GetTemplateSummary` action when you submit a template, or you can get template information for a StackSet, or a running or deleted stack.

For deleted stacks, `GetTemplateSummary` returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a `ValidationError` is returned.

## Request Parameters
<a name="API_GetTemplateSummary_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** StackName **   
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.  
Conditional: You must specify only one of the following parameters: `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet from which the stack was created.  
Conditional: You must specify only one of the following parameters: `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.  
Type: String  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?`   
Required: No

 ** TemplateBody **   
Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.  
Conditional: You must specify only one of the following parameters: `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateSummaryConfig **   
Specifies options for the `GetTemplateSummary` API action.  
Type: [TemplateSummaryConfig](API_TemplateSummaryConfig.md) object  
Required: No

 ** TemplateURL **   
The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`.  
Conditional: You must specify only one of the following parameters: `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

## Response Elements
<a name="API_GetTemplateSummary_ResponseElements"></a>

The following elements are returned by the service.

 **Capabilities.member.N**   
The capabilities found within the template. If your template contains IAM resources, you must specify the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` value for this parameter when you use the [CreateStack](API_CreateStack.md) or [UpdateStack](API_UpdateStack.md) actions with your template; otherwise, those actions return an `InsufficientCapabilities` error.  
For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities).  
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND` 

 ** CapabilitiesReason **   
The list of resources that generated the values in the `Capabilities` response element.  
Type: String

 **DeclaredTransforms.member.N**   
A list of the transforms that are declared in the template.  
Type: Array of strings

 ** Description **   
The value that's defined in the `Description` property of the template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** Metadata **   
The value that's defined for the `Metadata` property of the template.  
Type: String

 **Parameters.member.N**   
A list of parameter declarations that describe various properties for each parameter.  
Type: Array of [ParameterDeclaration](API_ParameterDeclaration.md) objects

 **ResourceIdentifierSummaries.member.N**   
A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, `BucketName` is a possible identifier property for an `AWS::S3::Bucket` resource.  
Type: Array of [ResourceIdentifierSummary](API_ResourceIdentifierSummary.md) objects

 **ResourceTypes.member.N**   
A list of all the template resource types that are defined in the template, such as `AWS::EC2::Instance`, `AWS::Dynamo::Table`, and `Custom::MyCustomInstance`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** Version **   
The AWS template format version, which identifies the capabilities of the template.  
Type: String

 ** Warnings **   
An object that contains any warnings returned.  
Type: [Warnings](API_Warnings.md) object

## Errors
<a name="API_GetTemplateSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_GetTemplateSummary_Examples"></a>

### GetTemplateSummary
<a name="API_GetTemplateSummary_Example_1"></a>

This example illustrates one usage of GetTemplateSummary.

#### Sample Request
<a name="API_GetTemplateSummary_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=GetTemplateSummary
 &TemplateURL=https%3A%2F%2Fs3-us-east-1.amazonaws.com%2Fsamplebucketname%2Fsampletemplate.template
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_GetTemplateSummary_Example_1_Response"></a>

```
<GetTemplateSummaryResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <GetTemplateSummaryResult>
    <Description>A sample template description.</Description>
    <Parameters>
      <member>
        <NoEcho>false</NoEcho>
        <ParameterKey>KeyName</ParameterKey>
        <Description>Name of an existing EC2 KeyPair to enable SSH access to the instance</Description>
        <ParameterType>AWS::EC2::KeyPair::KeyName</ParameterType>
      </member>
    </Parameters>
    <Metadata>{"Instances":{"SampleDescription":"Information about the instances"}}</Metadata>
    <Version>2010-09-09</Version>
  </GetTemplateSummaryResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</GetTemplateSummaryResponse>
```

## See Also
<a name="API_GetTemplateSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/GetTemplateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/GetTemplateSummary) 

# ImportStacksToStackSet
<a name="API_ImportStacksToStackSet"></a>

Import existing stacks into a new StackSets. Use the stack import operation to import up to 10 stacks into a new StackSet in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

## Request Parameters
<a name="API_ImportStacksToStackSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ For service managed StackSets, specify `DELEGATED_ADMIN`.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** OperationId **   
A unique, user defined, identifier for the StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** OperationPreferences **   
The user-specified preferences for how CloudFormation performs a StackSet operation.  
For more information about maximum concurrent accounts and failure tolerance, see [StackSet operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).  
Type: [StackSetOperationPreferences](API_StackSetOperationPreferences.md) object  
Required: No

 **OrganizationalUnitIds.member.N**   
The list of OU ID's to which the imported stacks must be mapped as deployment targets.  
Type: Array of strings  
Pattern: `^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$`   
Required: No

 **StackIds.member.N**   
The IDs of the stacks you are importing into a StackSet. You import up to 10 stacks per StackSet at a time.  
Specify either `StackIds` or `StackIdsUrl`.  
Type: Array of strings  
Required: No

 ** StackIdsUrl **   
The Amazon S3 URL which contains list of stack ids to be inputted.  
Specify either `StackIds` or `StackIdsUrl`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Pattern: `(s3://|http(s?)://).+`   
Required: No

 ** StackSetName **   
The name of the StackSet. The name must be unique in the Region where you create your StackSet.  
Type: String  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?`   
Required: Yes

## Response Elements
<a name="API_ImportStacksToStackSet_ResponseElements"></a>

The following element is returned by the service.

 ** OperationId **   
The unique identifier for the StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_ImportStacksToStackSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** LimitExceeded **   
The quota for the resource has already been reached.  
For information about resource and stack limitations, see [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.  
HTTP Status Code: 400

 ** OperationIdAlreadyExists **   
The specified operation ID already exists.  
HTTP Status Code: 409

 ** OperationInProgress **   
Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.  
HTTP Status Code: 409

 ** StackNotFound **   
The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

 ** StaleRequest **   
Another operation has been performed on this StackSet since the specified operation was performed.  
HTTP Status Code: 409

## See Also
<a name="API_ImportStacksToStackSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ImportStacksToStackSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ImportStacksToStackSet) 

# ListChangeSets
<a name="API_ListChangeSets"></a>

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the `CREATE_IN_PROGRESS` or `CREATE_PENDING` state.

## Request Parameters
<a name="API_ListChangeSets_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackName **   
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

## Response Elements
<a name="API_ListChangeSets_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
A list of `ChangeSetSummary` structures that provides the ID and status of each change set for the specified stack.  
Type: Array of [ChangeSetSummary](API_ChangeSetSummary.md) objects

## Errors
<a name="API_ListChangeSets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListChangeSets_Examples"></a>

### ListChangeSets
<a name="API_ListChangeSets_Example_1"></a>

This example illustrates one usage of ListChangeSets.

#### Sample Request
<a name="API_ListChangeSets_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListChangeSets
 &StackName=arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListChangeSets_Example_1_Response"></a>

```
<ListChangeSetsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ListChangeSetsResult>
    <Summaries>
      <member>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <Status>CREATE_COMPLETE</Status>
        <ChangeSetId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ChangeSetId>
        <StackName>SampleStack</StackName>
        <CreationTime>2016-03-16T20:44:05.889Z</CreationTime>
        <ChangeSetName>SampleChangeSet</ChangeSetName>
      </member>
      <member>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <Status>CREATE_COMPLETE</Status>
        <ChangeSetId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet-conditional/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ChangeSetId>
        <StackName>SampleStack</StackName>
        <CreationTime>2016-03-16T21:15:56.398Z</CreationTime>
        <ChangeSetName>SampleChangeSet-conditional</ChangeSetName>
      </member>
      <member>
        <StackId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</StackId>
        <Status>CREATE_COMPLETE</Status>
        <ChangeSetId>arn:aws:cloudformation:us-east-1:123456789012:changeSet/SampleChangeSet-replacement/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ChangeSetId>
        <StackName>SampleStack</StackName>
        <CreationTime>2016-03-16T21:03:37.706Z</CreationTime>
        <ChangeSetName>SampleChangeSet-replacement</ChangeSetName>
      </member>
    </Summaries>
  </ListChangeSetsResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</ListChangeSetsResponse>
```

## See Also
<a name="API_ListChangeSets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListChangeSets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListChangeSets) 

# ListExports
<a name="API_ListExports"></a>

Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the [ Fn::ImportValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html) function.

For more information, see [Get exported outputs from a deployed CloudFormation stack](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html).

## Request Parameters
<a name="API_ListExports_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Elements
<a name="API_ListExports_ResponseElements"></a>

The following elements are returned by the service.

 **Exports.member.N**   
The output for the [ListExports](#API_ListExports) action.  
Type: Array of [Export](API_Export.md) objects

 ** NextToken **   
If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_ListExports_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListExports_Examples"></a>

### ListExports
<a name="API_ListExports_Example_1"></a>

This example illustrates one usage of ListExports.

#### Sample Request
<a name="API_ListExports_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListExports
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListExports_Example_1_Response"></a>

```
<ListExportsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ListExportsResult>
    <Exports>
      <member>
        <Name>mySampleStack1-SecurityGroupID</Name>
        <ExportingStackId>arn:aws:cloudformation:us-east-1:123456789012:stack/mySampleStack1/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ExportingStackId>
        <Value>sg-0a123b45</Value>
      </member>
      <member>
        <Name>mySampleStack1-SubnetID</Name>
        <ExportingStackId>arn:aws:cloudformation:us-east-1:123456789012:stack/mySampleStack1/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ExportingStackId>
        <Value>subnet-0a123b45</Value>
      </member>
      <member>
        <Name>mySampleStack1-VPCID</Name>
        <ExportingStackId>arn:aws:cloudformation:us-east-1:123456789012:stack/mySampleStack1/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ExportingStackId>
        <Value>vpc-0a123b45</Value>
      </member>
      <member>
        <Name>WebSiteURL</Name>
        <ExportingStackId>arn:aws:cloudformation:us-east-1:123456789012:stack/myS3StaticSite/12a3b456-0e10-4ce0-9052-5d484a8c4e5b</ExportingStackId>
        <Value>http://testsite.com.s3-website-us-east-1.amazonaws.com</Value>
      </member>
    </Exports>
  </ListExportsResult>
  <ResponseMetadata>
    <RequestId>5ccc7dcd-744c-11e5-be70-1b08c228efb3</RequestId>
  </ResponseMetadata>
</ListExportsResponse>
```

## See Also
<a name="API_ListExports_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListExports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListExports) 

# ListGeneratedTemplates
<a name="API_ListGeneratedTemplates"></a>

Lists your generated templates in this Region.

## Request Parameters
<a name="API_ListGeneratedTemplates_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can use for the `NextToken` parameter to get the next set of results. By default the `ListGeneratedTemplates` API action will return at most 50 results in each response. The maximum value is 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Elements
<a name="API_ListGeneratedTemplates_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `ListGeneratedTemplates` again and use that value for the `NextToken` parameter. If the request returns all results, `NextToken` is set to an empty string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
A list of summaries of the generated templates.  
Type: Array of [TemplateSummary](API_TemplateSummary.md) objects

## Errors
<a name="API_ListGeneratedTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListGeneratedTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListGeneratedTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListGeneratedTemplates) 

# ListHookResults
<a name="API_ListHookResults"></a>

Returns summaries of invoked Hooks. For more information, see [View invocation summaries for CloudFormation Hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/hooks-view-invocations.html) in the * CloudFormation Hooks User Guide*.

This operation supports the following parameter combinations:
+ No parameters: Returns all Hook invocation summaries.
+  `TypeArn` only: Returns summaries for a specific Hook.
+  `TypeArn` and `Status`: Returns summaries for a specific Hook filtered by status.
+  `TargetId` and `TargetType`: Returns summaries for a specific Hook invocation target.

## Request Parameters
<a name="API_ListHookResults_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** Status **   
Filters results by the status of Hook invocations. Can only be used in combination with `TypeArn`. Valid values are:  
+  `HOOK_IN_PROGRESS`: The Hook is currently running.
+  `HOOK_COMPLETE_SUCCEEDED`: The Hook completed successfully.
+  `HOOK_COMPLETE_FAILED`: The Hook completed but failed validation.
+  `HOOK_FAILED`: The Hook encountered an error during execution.
Type: String  
Valid Values: `HOOK_IN_PROGRESS | HOOK_COMPLETE_SUCCEEDED | HOOK_COMPLETE_FAILED | HOOK_FAILED`   
Required: No

 ** TargetId **   
Filters results by the unique identifier of the target the Hook was invoked against.  
For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the `HookRequestToken` returned by the Cloud Control API request. For more information on the `HookRequestToken`, see [ProgressEvent](https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ProgressEvent.html).  
Required when `TargetType` is specified and cannot be used otherwise.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: No

 ** TargetType **   
Filters results by target type. Currently, only `CHANGE_SET` and `CLOUD_CONTROL` are supported filter options.  
Required when `TargetId` is specified and cannot be used otherwise.  
Type: String  
Valid Values: `CHANGE_SET | STACK | RESOURCE | CLOUD_CONTROL`   
Required: No

 ** TypeArn **   
Filters results by the ARN of the Hook. Can be used alone or in combination with `Status`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/hook/[A-Za-z0-9-]+/?`   
Required: No

## Response Elements
<a name="API_ListHookResults_ResponseElements"></a>

The following elements are returned by the service.

 **HookResults.member.N**   
A list of `HookResultSummary` structures that provides the status and Hook status reason for each Hook invocation for the specified target.  
Type: Array of [HookResultSummary](API_HookResultSummary.md) objects

 ** NextToken **   
Pagination token, `null` or empty if no more results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** TargetId **   
The unique identifier of the Hook invocation target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

 ** TargetType **   
The target type.  
Type: String  
Valid Values: `CHANGE_SET | STACK | RESOURCE | CLOUD_CONTROL` 

## Errors
<a name="API_ListHookResults_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** HookResultNotFound **   
The specified target doesn't have any requested Hook invocations.  
HTTP Status Code: 404

## See Also
<a name="API_ListHookResults_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListHookResults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListHookResults) 

# ListImports
<a name="API_ListImports"></a>

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see [ListExports](API_ListExports.md).

For more information about importing an exported output value, see the [Fn::ImportValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-importvalue.html) function.

## Request Parameters
<a name="API_ListImports_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ExportName **   
The name of the exported output value. CloudFormation returns the stack names that are importing this value.  
Type: String  
Required: Yes

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Elements
<a name="API_ListImports_ResponseElements"></a>

The following elements are returned by the service.

 **Imports.member.N**   
A list of stack names that are importing the specified exported output value.  
Type: Array of strings

 ** NextToken **   
A string that identifies the next page of exports. If there is no additional page, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_ListImports_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListImports_Examples"></a>

### ListExports
<a name="API_ListImports_Example_1"></a>

This example illustrates one usage of ListImports.

#### Sample Request
<a name="API_ListImports_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListImports
 &ExportName=SampleStack-MyExportedValue
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20160316T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListImports_Example_1_Response"></a>

```
<ListImportsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ListImportsResult>
    <Imports>
      <member>Import-SampleStack</member>
    </Imports>
  </ListImportsResult>
  <ResponseMetadata>
    <RequestId>a13656a8-a7b9-11e6-964c-41b56747ddb0</RequestId>
  </ResponseMetadata>
</ListImportsResponse>
```

## See Also
<a name="API_ListImports_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListImports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListImports) 

# ListResourceScanRelatedResources
<a name="API_ListResourceScanRelatedResources"></a>

Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.

## Request Parameters
<a name="API_ListResourceScanRelatedResources_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can use for the `NextToken` parameter to get the next set of results. By default the `ListResourceScanRelatedResources` API action will return up to 100 results in each response. The maximum value is 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 **Resources.member.N**   
The list of resources for which you want to get the related resources. Up to 100 resources can be provided.  
Type: Array of [ScannedResourceIdentifier](API_ScannedResourceIdentifier.md) objects  
Required: Yes

 ** ResourceScanId **   
The Amazon Resource Name (ARN) of the resource scan.  
Type: String  
Required: Yes

## Response Elements
<a name="API_ListResourceScanRelatedResources_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `ListResourceScanRelatedResources` again and use that value for the `NextToken` parameter. If the request returns all results, `NextToken` is set to an empty string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **RelatedResources.member.N**   
List of up to `MaxResults` resources in the specified resource scan related to the specified resources.  
Type: Array of [ScannedResource](API_ScannedResource.md) objects

## Errors
<a name="API_ListResourceScanRelatedResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceScanInProgress **   
A resource scan is currently in progress. Only one can be run at a time for an account in a Region.  
HTTP Status Code: 400

 ** ResourceScanNotFound **   
The resource scan was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListResourceScanRelatedResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListResourceScanRelatedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListResourceScanRelatedResources) 

# ListResourceScanResources
<a name="API_ListResourceScanResources"></a>

Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.

## Request Parameters
<a name="API_ListResourceScanResources_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can use for the `NextToken` parameter to get the next set of results. By default the `ListResourceScanResources` API action will return at most 100 results in each response. The maximum value is 100.  
Type: Integer  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ResourceIdentifier **   
If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).  
Type: String  
Required: No

 ** ResourceScanId **   
The Amazon Resource Name (ARN) of the resource scan.  
Type: String  
Required: Yes

 ** ResourceTypePrefix **   
If specified, the returned resources will be of any of the resource types with the specified prefix.  
Type: String  
Required: No

 ** TagKey **   
If specified, the returned resources will have a matching tag key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** TagValue **   
If specified, the returned resources will have a matching tag value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Elements
<a name="API_ListResourceScanResources_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `ListResourceScanResources` again and use that value for the `NextToken` parameter. If the request returns all results, `NextToken` is set to an empty string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Resources.member.N**   
List of up to `MaxResults` resources in the specified resource scan that match all of the specified filters.  
Type: Array of [ScannedResource](API_ScannedResource.md) objects

## Errors
<a name="API_ListResourceScanResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceScanInProgress **   
A resource scan is currently in progress. Only one can be run at a time for an account in a Region.  
HTTP Status Code: 400

 ** ResourceScanNotFound **   
The resource scan was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListResourceScanResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListResourceScanResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListResourceScanResources) 

# ListResourceScans
<a name="API_ListResourceScans"></a>

List the resource scans from newest to oldest. By default it will return up to 10 resource scans.

## Request Parameters
<a name="API_ListResourceScans_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can use for the `NextToken` parameter to get the next set of results. The default value is 10. The maximum value is 100.  
Type: Integer  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ScanTypeFilter **   
The scan type that you want to get summary information about. The default is `FULL`.  
Type: String  
Valid Values: `FULL | PARTIAL`   
Required: No

## Response Elements
<a name="API_ListResourceScans_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `ListResourceScans` again and use that value for the `NextToken` parameter. If the request returns all results, `NextToken` is set to an empty string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **ResourceScanSummaries.member.N**   
The list of scans returned.  
Type: Array of [ResourceScanSummary](API_ResourceScanSummary.md) objects

## Errors
<a name="API_ListResourceScans_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListResourceScans_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListResourceScans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListResourceScans) 

# ListStackInstanceResourceDrifts
<a name="API_ListStackInstanceResourceDrifts"></a>

Returns drift information for resources in a stack instance.

**Note**  
 `ListStackInstanceResourceDrifts` returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.

## Request Parameters
<a name="API_ListStackInstanceResourceDrifts_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** OperationId **   
The unique ID of the drift operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: Yes

 ** StackInstanceAccount **   
The name of the AWS account that you want to list resource drifts for.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: Yes

 ** StackInstanceRegion **   
The name of the Region where you want to list resource drifts.  
Type: String  
Pattern: `^[a-zA-Z0-9-]{1,128}$`   
Required: Yes

 **StackInstanceResourceDriftStatuses.member.N**   
The resource drift status of the stack instance.   
+  `DELETED`: The resource differs from its expected template configuration in that the resource has been deleted.
+  `MODIFIED`: One or more resource properties differ from their expected template values.
+  `IN_SYNC`: The resource's actual configuration matches its expected template configuration.
+  `NOT_CHECKED`: CloudFormation doesn't currently return this value.
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 4 items.  
Valid Values: `IN_SYNC | MODIFIED | DELETED | NOT_CHECKED | UNKNOWN | UNSUPPORTED`   
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet that you want to list drifted resources for.  
Type: String  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?`   
Required: Yes

## Response Elements
<a name="API_ListStackInstanceResourceDrifts_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the previous paginated request didn't return all of the remaining results, the response object's `NextToken` parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's `NextToken` parameter. If there are no remaining results, the previous response object's `NextToken` parameter is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
A list of `StackInstanceResourceDriftsSummary` structures that contain information about the specified stack instances.  
Type: Array of [StackInstanceResourceDriftsSummary](API_StackInstanceResourceDriftsSummary.md) objects

## Errors
<a name="API_ListStackInstanceResourceDrifts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OperationNotFound **   
The specified ID refers to an operation that doesn't exist.  
HTTP Status Code: 404

 ** StackInstanceNotFound **   
The specified stack instance doesn't exist.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## See Also
<a name="API_ListStackInstanceResourceDrifts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackInstanceResourceDrifts) 

# ListStackInstances
<a name="API_ListStackInstances"></a>

Returns summary information about stack instances that are associated with the specified StackSet. You can filter for stack instances that are associated with a specific AWS account name or Region, or that have a specific status.

## Request Parameters
<a name="API_ListStackInstances_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 **Filters.member.N**   
The filter to apply to stack instances  
Type: Array of [StackInstanceFilter](API_StackInstanceFilter.md) objects  
Array Members: Maximum number of 3 items.  
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackInstanceAccount **   
The name of the AWS account that you want to list stack instances for.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** StackInstanceRegion **   
The name of the Region where you want to list stack instances.  
Type: String  
Pattern: `^[a-zA-Z0-9-]{1,128}$`   
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet that you want to list stack instances for.  
Type: String  
Required: Yes

## Response Elements
<a name="API_ListStackInstances_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `ListStackInstances` again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
A list of `StackInstanceSummary` structures that contain information about the specified stack instances.  
Type: Array of [StackInstanceSummary](API_StackInstanceSummary.md) objects

## Errors
<a name="API_ListStackInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_ListStackInstances_Examples"></a>

### ListStackInstances
<a name="API_ListStackInstances_Example_1"></a>

The following example returns summary information about the stack instances associated with the specified StackSet in the specified account.

#### Sample Request
<a name="API_ListStackInstances_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListStackInstances
 &StackInstanceAccount=012345678910
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &MaxResults=10
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListStackInstances_Example_1_Response"></a>

```
<ListStackInstancesResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <ListStackInstancesResult>
    <Summaries>
      <member>
        <DriftStatus>IN_SYNC</DriftStatus>
        <StackSetId>stack-set-example:45331555-4b18-45a1-aa43-ecf5example</StackSetId>
        <StackId>arn:aws:cloudformation:ap-northeast-2:012345678910:stack/StackSet-stack-set-example-0ca3eed7-0b67-4be7-8a71-828641fa5193/ea68eca0-f9c1-11e9-aac0-0example</StackId>
        <Region>ap-northeast-2</Region>
        <Account>012345678910</Account>
        <LastDriftCheckTimestamp>2019-12-03T20:01:04.511Z</LastDriftCheckTimestamp>
        <Status>CURRENT</Status>
      </member>
      <member>
        <DriftStatus>IN_SYNC</DriftStatus>
        <StackSetId>stack-set-example:45331555-4b18-45a1-aa43-ecf5example</StackSetId>
        <StackId>arn:aws:cloudformation:eu-west-2:012345678910:stack/StackSet-stack-set-example-da07ae82-0478-485e-a32f-c1cb8cec57c2/e0df84a0-f9c1-11e9-bb3e-06afexamplec</StackId>
        <Region>eu-west-2</Region>
        <Account>012345678910</Account>
        <LastDriftCheckTimestamp>2019-12-03T19:59:14.488Z</LastDriftCheckTimestamp>
        <Status>CURRENT</Status>
      </member>
      <member>
        <DriftStatus>IN_SYNC</DriftStatus>
        <StackSetId>stack-set-example:45331555-4b18-45a1-aa43-ecf5example</StackSetId>
        <StackId>arn:aws:cloudformation:us-east-1:012345678910:stack/StackSet-stack-set-example-35588cf5-396d-4469-8a9e-912214ce3a7a/c684ff40-f9c1-11e9-b738-1245bexample</StackId>
        <Region>us-east-1</Region>
        <Account>012345678910</Account>
        <LastDriftCheckTimestamp>2019-12-03T19:58:37.477Z</LastDriftCheckTimestamp>
        <Status>CURRENT</Status>
      </member>
      <member>
        <DriftStatus>IN_SYNC</DriftStatus>
        <StackSetId>stack-set-example:45331555-4b18-45a1-aa43-ecf5example</StackSetId>
        <StackId>arn:aws:cloudformation:us-east-2:012345678910:stack/StackSet-stack-set-example-d3db3374-7683-4e82-bdeb-c388d7b16dc9/d8c208b0-f9c1-11e9-81c9-02300example</StackId>
        <Region>us-east-2</Region>
        <Account>012345678910</Account>
        <LastDriftCheckTimestamp>2019-12-03T20:00:27.570Z</LastDriftCheckTimestamp>
        <Status>CURRENT</Status>
      </member>
      <member>
        <DriftStatus>IN_SYNC</DriftStatus>
        <StackSetId>stack-set-example:45331555-4b18-45a1-aa43-ecf5example</StackSetId>
        <StackId>arn:aws:cloudformation:us-west-2:012345678910:stack/StackSet-stack-set-example-05f9348f-3f6e-4051-9083-8663c59f0352/cffefdf0-f9c1-11e9-a552-02ca0example</StackId>
        <Region>us-west-2</Region>
        <Account>012345678910</Account>
        <LastDriftCheckTimestamp>2019-12-03T19:59:51.501Z</LastDriftCheckTimestamp>
        <Status>CURRENT</Status>
      </member>
    </Summaries>
  </ListStackInstancesResult>
  <ResponseMetadata>
    <RequestId>6a94faf0-5632-4618-9c0a-cf273example</RequestId>
  </ResponseMetadata>
</ListStackInstancesResponse>
```

## See Also
<a name="API_ListStackInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackInstances) 

# ListStackRefactorActions
<a name="API_ListStackRefactorActions"></a>

Lists the stack refactor actions that will be taken after calling the [ExecuteStackRefactor](API_ExecuteStackRefactor.md) action.

## Request Parameters
<a name="API_ListStackRefactorActions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackRefactorId **   
The ID associated with the stack refactor created from the [CreateStackRefactor](API_CreateStackRefactor.md) action.  
Type: String  
Required: Yes

## Response Elements
<a name="API_ListStackRefactorActions_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **StackRefactorActions.member.N**   
The stack refactor actions.  
Type: Array of [StackRefactorAction](API_StackRefactorAction.md) objects

## Errors
<a name="API_ListStackRefactorActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListStackRefactorActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackRefactorActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackRefactorActions) 

# ListStackRefactors
<a name="API_ListStackRefactors"></a>

Lists all account stack refactor operations and their statuses.

## Request Parameters
<a name="API_ListStackRefactors_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **ExecutionStatusFilter.member.N**   
Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes.  
Type: Array of strings  
Valid Values: `UNAVAILABLE | AVAILABLE | OBSOLETE | EXECUTE_IN_PROGRESS | EXECUTE_COMPLETE | EXECUTE_FAILED | ROLLBACK_IN_PROGRESS | ROLLBACK_COMPLETE | ROLLBACK_FAILED`   
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## Response Elements
<a name="API_ListStackRefactors_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **StackRefactorSummaries.member.N**   
Provides a summary of a stack refactor, including the following:  
+  `StackRefactorId` 
+  `Status` 
+  `StatusReason` 
+  `ExecutionStatus` 
+  `ExecutionStatusReason` 
+  `Description` 
Type: Array of [StackRefactorSummary](API_StackRefactorSummary.md) objects

## Errors
<a name="API_ListStackRefactors_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListStackRefactors_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackRefactors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackRefactors) 

# ListStackResources
<a name="API_ListStackResources"></a>

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

## Request Parameters
<a name="API_ListStackResources_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackName **   
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:  
+ Running stacks: You can specify either the stack's name or its unique stack ID.
+ Deleted stacks: You must specify the unique stack ID.
Type: String  
Required: Yes

## Response Elements
<a name="API_ListStackResources_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **StackResourceSummaries.member.N**   
A list of `StackResourceSummary` structures.  
Type: Array of [StackResourceSummary](API_StackResourceSummary.md) objects

## Errors
<a name="API_ListStackResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListStackResources_Examples"></a>

### ListStackResources
<a name="API_ListStackResources_Example_1"></a>

This example illustrates one usage of ListStackResources.

#### Sample Request
<a name="API_ListStackResources_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListStackResources
 &StackName=MyStack
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2011-07-08T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_ListStackResources_Example_1_Response"></a>

```
<ListStackResourcesResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ListStackResourcesResult>
    <StackResourceSummaries>
      <member>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <LogicalResourceId>DBSecurityGroup</LogicalResourceId>
        <LastUpdatedTimestamp>2011-06-21T20:15:58Z</LastUpdatedTimestamp>
        <PhysicalResourceId>gmarcteststack-dbsecuritygroup-1s5m0ez5lkk6w</Physic
alResourceId>
        <ResourceType>AWS::RDS::DBSecurityGroup</ResourceType>
      </member>
      <member>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <LogicalResourceId>SampleDB</LogicalResourceId>
        <LastUpdatedTimestamp>2011-06-21T20:25:57Z</LastUpdatedTimestamp>
        <PhysicalResourceId>MyStack-sampledb-ycwhk1v830lx</PhysicalResour
ceId>
        <ResourceType>AWS::RDS::DBInstance</ResourceType>
      </member>
      <member>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <LogicalResourceId>SampleApplication</LogicalResourceId>
        <LastUpdatedTimestamp>2011-06-21T20:26:12Z</LastUpdatedTimestamp>
        <PhysicalResourceId>MyStack-SampleApplication-1MKNASYR3RBQL</Phys
icalResourceId>
        <ResourceType>AWS::ElasticBeanstalk::Application</ResourceType>
      </member>
      <member>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <LogicalResourceId>SampleEnvironment</LogicalResourceId>
        <LastUpdatedTimestamp>2011-06-21T20:28:48Z</LastUpdatedTimestamp>
        <PhysicalResourceId>myst-Samp-1AGU6ERZX6M3Q</PhysicalResourceId>
        <ResourceType>AWS::ElasticBeanstalk::Environment</ResourceType>
      </member>
      <member>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <LogicalResourceId>AlarmTopic</LogicalResourceId>
        <LastUpdatedTimestamp>2011-06-21T20:29:06Z</LastUpdatedTimestamp>
        <PhysicalResourceId>arn:aws:sns:us-east-1:803981987763:MyStack-Al
armTopic-SW4IQELG7RPJ</PhysicalResourceId>
        <ResourceType>AWS::SNS::Topic</ResourceType>
      </member>
      <member>
        <ResourceStatus>CREATE_COMPLETE</ResourceStatus>
        <LogicalResourceId>CPUAlarmHigh</LogicalResourceId>
        <LastUpdatedTimestamp>2011-06-21T20:29:23Z</LastUpdatedTimestamp>
        <PhysicalResourceId>MyStack-CPUAlarmHigh-POBWQPDJA81F</PhysicalRe
sourceId>
        <ResourceType>AWS::CloudWatch::Alarm</ResourceType>
      </member>
    </StackResourceSummaries>
  </ListStackResourcesResult>
  <ResponseMetadata>
    <RequestId>2d06e36c-ac1d-11e0-a958-example</RequestId>
  </ResponseMetadata>
</ListStackResourcesResponse>
```

## See Also
<a name="API_ListStackResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackResources) 

# ListStacks
<a name="API_ListStacks"></a>

Returns the summary information for stacks whose status matches the specified `StackStatusFilter`. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no `StackStatusFilter` is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

## Request Parameters
<a name="API_ListStacks_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 **StackStatusFilter.member.N**   
Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the `StackStatus` parameter of the [Stack](API_Stack.md) data type.  
Type: Array of strings  
Valid Values: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE | REVIEW_IN_PROGRESS | IMPORT_IN_PROGRESS | IMPORT_COMPLETE | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE`   
Required: No

## Response Elements
<a name="API_ListStacks_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **StackSummaries.member.N**   
A list of `StackSummary` structures that contains information about the specified stacks.  
Type: Array of [StackSummary](API_StackSummary.md) objects

## Errors
<a name="API_ListStacks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListStacks_Examples"></a>

### ListStacks
<a name="API_ListStacks_Example_1"></a>

This example illustrates one usage of ListStacks.

#### Sample Request
<a name="API_ListStacks_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListStacks
 &StackStatusFilter.member.1=CREATE_IN_PROGRESS
 &StackStatusFilter.member.2=DELETE_COMPLETE
 &Version=2010-05-15
 &SignatureVersion=2
 &SignatureMethod=HmacSHA256
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_ListStacks_Example_1_Response"></a>

```
<ListStacksResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ListStacksResult>
    <StackSummaries>
      <member>
        <StackId>
          arn:aws:cloudformation:us-east-1:1234567:stack/TestCreate1/aaaaa
        </StackId>
        <StackStatus>CREATE_IN_PROGRESS</StackStatus>
        <StackName>vpc1</StackName>
        <CreationTime>2011-05-23T15:47:44Z</CreationTime>
        <TemplateDescription>
          Creates one EC2 instance and a load balancer.
        </TemplateDescription>
        <ResourceTypes>
          <member>AWS::EC2::Instance</member>
          <member>AWS::ElasticLoadBalancing::LoadBalancer</member>
        </ResourceTypes>
      </member>
      <member>
        <StackId>
          arn:aws:cloudformation:us-east-1:1234567:stack/TestDelete2/bbbbb
        </StackId>
        <StackStatus>DELETE_COMPLETE</StackStatus>
        <DeletionTime>2011-03-10T16:20:51Z</DeletionTime>
        <StackName>WP1</StackName>
        <CreationTime>2011-03-05T19:57:58Z</CreationTime>
        <TemplateDescription>
          A simple basic CloudFormation Template.
        </TemplateDescription>
        <ResourceTypes>
          <member>AWS::EC2::Instance</member>
        </ResourceTypes>
      </member>
    </StackSummaries>
  </ListStacksResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</ListStacksResponse>
```

## See Also
<a name="API_ListStacks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStacks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStacks) 

# ListStackSetAutoDeploymentTargets
<a name="API_ListStackSetAutoDeploymentTargets"></a>

Returns summary information about deployment targets for a StackSet.

## Request Parameters
<a name="API_ListStackSetAutoDeploymentTargets_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet that you want to get automatic deployment targets for.  
Type: String  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?`   
Required: Yes

## Response Elements
<a name="API_ListStackSetAutoDeploymentTargets_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call [ListStackSetAutoDeploymentTargets](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStackSetAutoDeploymentTargets.html) again and use that value for the `NextToken` parameter. If the request returns all results, `NextToken` is set to an empty string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
An array of summaries of the deployment targets for the StackSet.  
Type: Array of [StackSetAutoDeploymentTargetSummary](API_StackSetAutoDeploymentTargetSummary.md) objects

## Errors
<a name="API_ListStackSetAutoDeploymentTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## See Also
<a name="API_ListStackSetAutoDeploymentTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackSetAutoDeploymentTargets) 

# ListStackSetOperationResults
<a name="API_ListStackSetOperationResults"></a>

Returns summary information about the results of a StackSet operation.

**Note**  
This API provides *eventually consistent* reads meaning it may take some time but will eventually return the most up-to-date data.

## Request Parameters
<a name="API_ListStackSetOperationResults_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 **Filters.member.N**   
The filter to apply to operation results.  
Type: Array of [OperationResultFilter](API_OperationResultFilter.md) objects  
Array Members: Maximum number of 1 item.  
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** OperationId **   
The ID of the StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: Yes

 ** StackSetName **   
The name or unique ID of the StackSet that you want to get operation results for.  
Type: String  
Required: Yes

## Response Elements
<a name="API_ListStackSetOperationResults_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all results, `NextToken` is set to a token. To retrieve the next set of results, call `ListOperationResults` again and assign that token to the request object's `NextToken` parameter. If there are no remaining results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
A list of `StackSetOperationResultSummary` structures that contain information about the specified operation results, for accounts and AWS Regions that are included in the operation.  
Type: Array of [StackSetOperationResultSummary](API_StackSetOperationResultSummary.md) objects

## Errors
<a name="API_ListStackSetOperationResults_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** OperationNotFound **   
The specified ID refers to an operation that doesn't exist.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_ListStackSetOperationResults_Examples"></a>

### ListStackSetOperationResults
<a name="API_ListStackSetOperationResults_Example_1"></a>

This example illustrates one usage of ListStackSetOperationResults.

#### Sample Request
<a name="API_ListStackSetOperationResults_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListStackSetOperationResults
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &OperationId=61806005-bde9-46f1-949d-6791example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListStackSetOperationResults_Example_1_Response"></a>

```
<ListStackSetOperationResultsResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <ListStackSetOperationResultsResult>
    <Summaries>
      <member>
        <StatusReason>Cancelled since failure tolerance has exceeded</StatusReason>
        <Region>us-west-2</Region>
        <Account>[account]</Account>
        <Status>CANCELLED</Status>
      </member>
      <member>
        <AccountGateResult>
          <StatusReason>Account [account] should have 'AWSCloudFormationStackSetAdministrationRole' role with trust relationship to CloudFormation service.</StatusReason>
          <Status>FAILED</Status>
        </AccountGateResult>
        <StatusReason>Account [account] should have 'AWSCloudFormationStackSetAdministrationRole' role with trust relationship to CloudFormation service.</StatusReason>
        <Region>us-east-1</Region>
        <Account>[account]</Account>
        <Status>FAILED</Status>
      </member>
    </Summaries>
  </ListStackSetOperationResultsResult>
  <ResponseMetadata>
    <RequestId>bf662a8d-7e1b-11e7-98fb-db38example</RequestId>
  </ResponseMetadata>
</ListStackSetOperationResultsResponse>
```

### ListStackSetOperationResults
<a name="API_ListStackSetOperationResults_Example_2"></a>

This example illustrates one usage of ListStackSetOperationResults.

#### Sample Request
<a name="API_ListStackSetOperationResults_Example_2_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListStackSetOperationResults
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &OperationId=61806005-bde9-46f1-949d-6791example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListStackSetOperationResults_Example_2_Response"></a>

```
<ListStackSetOperationResultsResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <ListStackSetOperationResultsResult>
    <Summaries>
      <member>
        <AccountGateResult>
          <StatusReason>AWSCloudFormationStackSetAccountGate function not found</StatusReason>
          <Status>SKIPPED</Status>
        </AccountGateResult>
        <Region>us-west-2</Region>
        <Account>[account]</Account>
        <Status>SUCCEEDED</Status>
      </member>
      <member>
        <AccountGateResult>
          <StatusReason>AWSCloudFormationStackSetAccountGate function not found</StatusReason>
          <Status>SKIPPED</Status>
        </AccountGateResult>
        <Region>us-east-1</Region>
        <Account>[account]</Account>
        <Status>SUCCEEDED</Status>
      </member>
    </Summaries>
  </ListStackSetOperationResultsResult>
  <ResponseMetadata>
    <RequestId>ee444e6b-7e1b-11e7-8bb3-1f65example</RequestId>
  </ResponseMetadata>
</ListStackSetOperationResultsResponse>
```

## See Also
<a name="API_ListStackSetOperationResults_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackSetOperationResults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackSetOperationResults) 

# ListStackSetOperations
<a name="API_ListStackSetOperations"></a>

Returns summary information about operations performed on a StackSet.

**Note**  
This API provides *eventually consistent* reads meaning it may take some time but will eventually return the most up-to-date data.

## Request Parameters
<a name="API_ListStackSetOperations_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet that you want to get operation summaries for.  
Type: String  
Required: Yes

## Response Elements
<a name="API_ListStackSetOperations_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all results, `NextToken` is set to a token. To retrieve the next set of results, call `ListOperationResults` again and assign that token to the request object's `NextToken` parameter. If there are no remaining results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
A list of `StackSetOperationSummary` structures that contain summary information about operations for the specified StackSet.  
Type: Array of [StackSetOperationSummary](API_StackSetOperationSummary.md) objects

## Errors
<a name="API_ListStackSetOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_ListStackSetOperations_Examples"></a>

### ListStackSetOperations
<a name="API_ListStackSetOperations_Example_1"></a>

This example illustrates one usage of ListStackSetOperations.

#### Sample Request
<a name="API_ListStackSetOperations_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListStackSetOperations
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &MaxResults=10
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListStackSetOperations_Example_1_Response"></a>

```
<ListStackSetOperationsResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <ListStackSetOperationsResult>
    <Summaries>
       <member>
        <CreationTimestamp>2019-12-03T19:57:57.573Z</CreationTimestamp>
        <OperationId>9cc082fa-df4c-45cd-b9a8-7e563e88418e</OperationId>
        <Action>DETECT_DRIFT</Action>
        <EndTimestamp>2019-12-03T20:01:04.630Z</EndTimestamp>
        <Status>SUCCEEDED</Status>
      </member>
      <member>
        <CreationTimestamp>2017-08-04T18:01:29.508Z</CreationTimestamp>
        <OperationId>ddf16f54-ad62-4d9b-b0ab-3ed8example</OperationId>
        <Action>UPDATE</Action>
        <EndTimestamp>2017-08-04T18:03:43.672Z</EndTimestamp>
        <Status>SUCCEEDED</Status>
      </member>
      <member>
        <CreationTimestamp>2017-08-04T17:40:05.828Z</CreationTimestamp>
        <OperationId>fadffcdd-4ae1-4a26-aa02-cb81example</OperationId>
        <Action>CREATE</Action>
        <EndTimestamp>2017-08-04T17:40:24.107Z</EndTimestamp>
        <Status>FAILED</Status>
      </member>
    </Summaries>
  </ListStackSetOperationsResult>
  <ResponseMetadata>
    <RequestId>39602b0c-7e1b-11e7-a79f-5d957example</RequestId>
  </ResponseMetadata>
</ListStackSetOperationsResponse>
```

## See Also
<a name="API_ListStackSetOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackSetOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackSetOperations) 

# ListStackSets
<a name="API_ListStackSets"></a>

Returns summary information about StackSets that are associated with the user.

**Note**  
This API provides *strongly consistent* reads meaning it will always return the most up-to-date data.
+ [Self-managed permissions] If you set the `CallAs` parameter to `SELF` while signed in to your AWS account, `ListStackSets` returns all self-managed StackSets in your AWS account.
+ [Service-managed permissions] If you set the `CallAs` parameter to `SELF` while signed in to the organization's management account, `ListStackSets` returns all StackSets in the management account.
+ [Service-managed permissions] If you set the `CallAs` parameter to `DELEGATED_ADMIN` while signed in to your member account, `ListStackSets` returns all StackSets with service-managed permissions in the management account.

## Request Parameters
<a name="API_ListStackSets_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** Status **   
The status of the StackSets that you want to get summary information about.  
Type: String  
Valid Values: `ACTIVE | DELETED`   
Required: No

## Response Elements
<a name="API_ListStackSets_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all of the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call `ListStackInstances` again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Summaries.member.N**   
A list of `StackSetSummary` structures that contain information about the user's StackSets.  
Type: Array of [StackSetSummary](API_StackSetSummary.md) objects

## Errors
<a name="API_ListStackSets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ListStackSets_Examples"></a>

### ListStackSets
<a name="API_ListStackSets_Example_1"></a>

This example illustrates one usage of ListStackSets.

#### Sample Request
<a name="API_ListStackSets_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListStackSets
 &Status=ACTIVE
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListStackSets_Example_1_Response"></a>

```
<ListStackSetsResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <ListStackSetsResult>
    <Summaries>
      <member>
        <StackSetName>stack-set-example-one</StackSetName>
        <Description>Description of the StackSet</Description>
        <StackSetId>stack-set-example-one:c14cd6d1-cd17-40bd-82ed-ff97example</StackSetId>
        <Status>ACTIVE</Status>
      </member>
      <member>
        <StackSetName>stack-set-example-two</StackSetName>
        <StackSetId>stack-set-example-two:22f04391-472b-4e36-b11a-727example</StackSetId>
        <Status>ACTIVE</Status>
      </member>
    </Summaries>
  </ListStackSetsResult>
  <ResponseMetadata>
    <RequestId>35ec5187-794a-11e7-8c45-3f18example</RequestId>
  </ResponseMetadata>
</ListStackSetsResponse>
```

## See Also
<a name="API_ListStackSets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListStackSets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListStackSets) 

# ListTypeRegistrations
<a name="API_ListTypeRegistrations"></a>

Returns a list of registration tokens for the specified extension(s).

## Request Parameters
<a name="API_ListTypeRegistrations_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** RegistrationStatusFilter **   
The current status of the extension registration request.  
The default is `IN_PROGRESS`.  
Type: String  
Valid Values: `COMPLETE | IN_PROGRESS | FAILED`   
Required: No

 ** Type **   
The kind of extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeArn **   
The Amazon Resource Name (ARN) of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+`   
Required: No

 ** TypeName **   
The name of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

## Response Elements
<a name="API_ListTypeRegistrations_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **RegistrationTokenList.member.N**   
A list of extension registration tokens.  
Use [DescribeTypeRegistration](API_DescribeTypeRegistration.md) to return detailed information about a type registration request.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_ListTypeRegistrations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListTypeRegistrations_Examples"></a>

### ListTypeRegistrations
<a name="API_ListTypeRegistrations_Example_1"></a>

The example below returns a list of the registration tokens for the three versions of `My::Resource::Example`, a private resource type, that have completed registration.

#### Sample Request
<a name="API_ListTypeRegistrations_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListTypeRegistrations
 &Version=2010-05-15
 &TypeName=My::Resource::Example
 &Type=RESOURCE
 &RegistrationStatusFilter=COMPLETE
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191204T071759Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListTypeRegistrations_Example_1_Response"></a>

```
<ListTypeRegistrationsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ListTypeRegistrationsResult>
    <RegistrationTokenList>
      <member>b5c40e0e-68da-47d2-8ed2-b8db7example</member>
      <member>03458954-61b1-44e9-90d8-f1b8aexample</member>
      <member>356b9e72-7d1e-43aa-83ba-81c2example</member>
    </RegistrationTokenList>
  </ListTypeRegistrationsResult>
  <ResponseMetadata>
    <RequestId>de6b93f6-c68b-4840-9537-eb2357example</RequestId>
  </ResponseMetadata>
</ListTypeRegistrationsResponse>
```

## See Also
<a name="API_ListTypeRegistrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListTypeRegistrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListTypeRegistrations) 

# ListTypes
<a name="API_ListTypes"></a>

Returns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from AWS and third-party publishers.

## Request Parameters
<a name="API_ListTypes_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** DeprecatedStatus **   
The deprecation status of the extension that you want to get summary information about.  
Valid values include:  
+  `LIVE`: The extension is registered for use in CloudFormation operations.
+  `DEPRECATED`: The extension has been deregistered and can no longer be used in CloudFormation operations.
Type: String  
Valid Values: `LIVE | DEPRECATED`   
Required: No

 ** Filters **   
Filter criteria to use in determining which extensions to return.  
Filters must be compatible with `Visibility` to return valid results. For example, specifying `AWS_TYPES` for `Category` and `PRIVATE` for `Visibility` returns an empty list of types, but specifying `PUBLIC` for `Visibility` returns the desired list.  
Type: [TypeFilters](API_TypeFilters.md) object  
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ProvisioningType **   
For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.  
Valid values include:  
+  `FULLY_MUTABLE`: The resource type includes an update handler to process updates to the type during stack update operations.
+  `IMMUTABLE`: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations.
+  `NON_PROVISIONABLE`: The resource type doesn't include create, read, and delete handlers, and therefore can't actually be provisioned.
The default is `FULLY_MUTABLE`.  
Type: String  
Valid Values: `NON_PROVISIONABLE | IMMUTABLE | FULLY_MUTABLE`   
Required: No

 ** Type **   
The type of extension.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** Visibility **   
The scope at which the extensions are visible and usable in CloudFormation operations.  
Valid values include:  
+  `PRIVATE`: Extensions that are visible and usable within this account and Region. This includes:
  + Private extensions you have registered in this account and Region.
  + Public extensions that you have activated in this account and Region.
+  `PUBLIC`: Extensions that are publicly visible and available to be activated within any AWS account. This includes extensions from AWS and third-party publishers.
The default is `PRIVATE`.  
Type: String  
Valid Values: `PUBLIC | PRIVATE`   
Required: No

## Response Elements
<a name="API_ListTypes_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **TypeSummaries.member.N**   
A list of `TypeSummary` structures that contain information about the specified extensions.  
Type: Array of [TypeSummary](API_TypeSummary.md) objects

## Errors
<a name="API_ListTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListTypes_Examples"></a>

### ListTypes
<a name="API_ListTypes_Example_1"></a>

The following example returns summary information for all the private resource types registered in this AWS account.

#### Sample Request
<a name="API_ListTypes_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListTypes
 &Version=2010-05-15
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191204T183443Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListTypes_Example_1_Response"></a>

```
  <ListTypesResult>
    <TypeSummaries>
      <member>
        <LastUpdated>2019-12-04T18:28:15.059Z</LastUpdated>
        <DefaultVersionId>00000003</DefaultVersionId>
        <TypeArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example</TypeArn>
        <TypeName>My::Resource::Example</TypeName>
        <Description>Resource schema for My::Resource::Example</Description>
        <Type>RESOURCE</Type>
      </member>
      <member>
        <LastUpdated>2019-12-04T18:28:15.059Z</LastUpdated>
        <DefaultVersionId>00000001</DefaultVersionId>
        <TypeArn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Second-Example</TypeArn>
        <TypeName>My::Second::Example</TypeName>
        <Description>Resource schema for My::Second::Example</Description>
        <Type>RESOURCE</Type>
      </member>
    </TypeSummaries>
  </ListTypesResult>
  <ResponseMetadata>
    <RequestId>69dc5a34-5462-4e1b-81fb-7a310example</RequestId>
  </ResponseMetadata>
</ListTypesResponse>
```

## See Also
<a name="API_ListTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListTypes) 

# ListTypeVersions
<a name="API_ListTypeVersions"></a>

Returns summary information about the versions of an extension.

## Request Parameters
<a name="API_ListTypeVersions_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Arn **   
The Amazon Resource Name (ARN) of the extension for which you want version summary information.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+`   
Required: No

 ** DeprecatedStatus **   
The deprecation status of the extension versions that you want to get summary information about.  
Valid values include:  
+  `LIVE`: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.
+  `DEPRECATED`: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is `LIVE`.  
Type: String  
Valid Values: `LIVE | DEPRECATED`   
Required: No

 ** MaxResults **   
The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a `NextToken` value that you can assign to the `NextToken` request parameter to get the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** NextToken **   
The token for the next set of items to return. (You received this token from a previous call.)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** PublisherId **   
The publisher ID of the extension publisher.  
Extensions published by Amazon aren't assigned a publisher ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Pattern: `[0-9a-zA-Z]{12,40}`   
Required: No

 ** Type **   
The kind of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension for which you want version summary information.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

## Response Elements
<a name="API_ListTypeVersions_ResponseElements"></a>

The following elements are returned by the service.

 ** NextToken **   
If the request doesn't return all of the remaining results, `NextToken` is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's `NextToken` parameter. If the request returns all results, `NextToken` is set to `null`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **TypeVersionSummaries.member.N**   
A list of `TypeVersionSummary` structures that contain information about the specified extension's versions.  
Type: Array of [TypeVersionSummary](API_TypeVersionSummary.md) objects

## Errors
<a name="API_ListTypeVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_ListTypeVersions_Examples"></a>

### ListTypeRegistrations
<a name="API_ListTypeVersions_Example_1"></a>

The following example returns summary information about the two extension versions with a status of `LIVE` for the private resource type `My::Resource::Example`.

#### Sample Request
<a name="API_ListTypeVersions_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ListTypeRegistrations
 &Version=2010-05-15
 &TypeName=My::Resource::Example
 &Type=RESOURCE
 &DeprecatedStatus=LIVE
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191204T070338Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_ListTypeVersions_Example_1_Response"></a>

```
<ListTypeVersionsResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ListTypeVersionsResult>
    <TypeVersionSummaries>
      <member>
        <VersionId>00000001</VersionId>
        <TypeName>My::Resource::Example</TypeName>
        <Description>Resource schema for My::Resource::Example</Description>
        <TimeCreated>2019-12-03T23:29:33.321Z</TimeCreated>
        <Arn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example/00000001</Arn>
        <Type>RESOURCE</Type>
      </member>
      <member>
        <VersionId>00000002</VersionId>
        <TypeName>My::Resource::Example</TypeName>
        <Description>Resource schema for My::Resource::Example</Description>
        <TimeCreated>2019-12-04T06:58:14.902Z</TimeCreated>
        <Arn>arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example/00000002</Arn>
        <Type>RESOURCE</Type>
      </member>
    </TypeVersionSummaries>
  </ListTypeVersionsResult>
  <ResponseMetadata>
    <RequestId>caedd974-e865-4518-b7f0-a6972example</RequestId>
  </ResponseMetadata>
</ListTypeVersionsResponse>
```

## See Also
<a name="API_ListTypeVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ListTypeVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ListTypeVersions) 

# PublishType
<a name="API_PublishType"></a>

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 about publishing extensions, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see [RegisterPublisher](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html).

## Request Parameters
<a name="API_PublishType_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Arn **   
The Amazon Resource Name (ARN) of the extension.  
Conditional: You must specify `Arn`, or `TypeName` and `Type`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+`   
Required: No

 ** PublicVersionNumber **   
The version number to assign to this version of the extension.  
Use the following format, and adhere to semantic versioning when assigning a version number to your extension:  
 `MAJOR.MINOR.PATCH`   
For more information, see [Semantic Versioning 2.0.0](https://semver.org/).  
If you don't specify a version number, CloudFormation increments the version number by one minor version release.  
You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be `1.0.0`.  
Type: String  
Length Constraints: Minimum length of 5.  
Pattern: `^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(.*)$`   
Required: No

 ** Type **   
The type of the extension.  
Conditional: You must specify `Arn`, or `TypeName` and `Type`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension.  
Conditional: You must specify `Arn`, or `TypeName` and `Type`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

## Response Elements
<a name="API_PublishType_ResponseElements"></a>

The following element is returned by the service.

 ** PublicTypeArn **   
The Amazon Resource Name (ARN) assigned to the public extension upon publication.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

## Errors
<a name="API_PublishType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## See Also
<a name="API_PublishType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/PublishType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/PublishType) 

# RecordHandlerProgress
<a name="API_RecordHandlerProgress"></a>

Reports progress of a resource handler to CloudFormation.

Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). Don't use this API in your code.

## Request Parameters
<a name="API_RecordHandlerProgress_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** BearerToken **   
Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** ClientRequestToken **   
Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** CurrentOperationStatus **   
Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | SUCCESS | FAILED`   
Required: No

 ** ErrorCode **   
Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).  
Type: String  
Valid Values: `NotUpdatable | InvalidRequest | AccessDenied | InvalidCredentials | AlreadyExists | NotFound | ResourceConflict | Throttling | ServiceLimitExceeded | NotStabilized | GeneralServiceException | ServiceInternalError | NetworkFailure | InternalFailure | InvalidTypeConfiguration | HandlerInternalFailure | NonCompliant | Unknown | UnsupportedTarget`   
Required: No

 ** OperationStatus **   
Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | SUCCESS | FAILED`   
Required: Yes

 ** ResourceModel **   
Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.  
Required: No

 ** StatusMessage **   
Reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## Errors
<a name="API_RecordHandlerProgress_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConditionalCheckFailed **   
Error reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). CloudFormation doesn't return this error to users.  
HTTP Status Code: 400

 ** InvalidStateTransition **   
Error reserved for use by the [CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). CloudFormation doesn't return this error to users.  
HTTP Status Code: 400

## See Also
<a name="API_RecordHandlerProgress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/RecordHandlerProgress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/RecordHandlerProgress) 

# RegisterPublisher
<a name="API_RegisterPublisher"></a>

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 AWS Regions.

For information about requirements for registering as a public extension publisher, see [Prerequisite: Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.



## Request Parameters
<a name="API_RegisterPublisher_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** AcceptTermsAndConditions **   
Whether you accept the [Terms and Conditions](https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf) for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to register to publish public extensions to the CloudFormation registry.  
The default is `false`.  
Type: Boolean  
Required: No

 ** ConnectionArn **   
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.  
For more information, see [Prerequisite: Registering your account to publish CloudFormation extensions](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `arn:aws(-[\w]+)*:.+:.+:[0-9]{12}:.+`   
Required: No

## Response Elements
<a name="API_RegisterPublisher_ResponseElements"></a>

The following element is returned by the service.

 ** PublisherId **   
The ID assigned this account by CloudFormation for publishing extensions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 40.  
Pattern: `[0-9a-zA-Z]{12,40}` 

## Errors
<a name="API_RegisterPublisher_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## See Also
<a name="API_RegisterPublisher_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/RegisterPublisher) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/RegisterPublisher) 

# RegisterType
<a name="API_RegisterType"></a>

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your AWS account, and includes:
+ Validating the extension schema.
+ Determining which handlers, if any, have been specified for the extension.
+ Making the extension available for use in your account.

For more information about how to develop extensions and ready them for registration, see [Creating resource types using the CloudFormation CLI](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use [DeregisterType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html) to deregister specific extension versions if necessary.

Once you have initiated a registration request using [RegisterType](#API_RegisterType), you can use [DescribeTypeRegistration](API_DescribeTypeRegistration.md) to monitor the progress of the registration request.

Once you have registered a private extension in your account and Region, use [SetTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) to specify configuration properties for the extension. For more information, see [Edit configuration data for extensions in your account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_RegisterType_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ClientRequestToken **   
A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registration request, even if the request is submitted multiple times.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** ExecutionRoleArn **   
The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.  
For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (`resources.cloudformation.amazonaws.com`). For more information about adding trust relationships, see [Modifying a role trust policy](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy) in the * AWS Identity and Access Management User Guide*.  
If your extension calls AWS APIs in any of its handlers, you must create an * [IAM execution role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) * that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `arn:.+:iam::[0-9]{12}:role/.+`   
Required: No

 ** LoggingConfig **   
Specifies logging configuration information for an extension.  
Type: [LoggingConfig](API_LoggingConfig.md) object  
Required: No

 ** SchemaHandlerPackage **   
A URL to the S3 bucket that contains the extension project package that contains the necessary files for the extension you want to register.  
For information about generating a schema handler package for the extension you want to register, see [submit](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.  
The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) permissions for the schema handler package. For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the * AWS Identity and Access Management User Guide*.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** Type **   
The kind of extension.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension being registered.  
We suggest that extension names adhere to the following patterns:  
+ For resource types, `company_or_organization::service::type`.
+ For modules, `company_or_organization::service::type::MODULE`.
+ For Hooks, `MyCompany::Testing::MyTestHook`.
The following organization namespaces are reserved and can't be used in your extension names:  
+  `Alexa` 
+  `AMZN` 
+  `Amazon` 
+  `AWS` 
+  `Custom` 
+  `Dev` 
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: Yes

## Response Elements
<a name="API_RegisterType_ResponseElements"></a>

The following element is returned by the service.

 ** RegistrationToken **   
The identifier for this registration request.  
Use this registration token when calling [DescribeTypeRegistration](API_DescribeTypeRegistration.md), which returns information about the status and IDs of the extension registration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_RegisterType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

## Examples
<a name="API_RegisterType_Examples"></a>

### RegisterType
<a name="API_RegisterType_Example_1"></a>

This example illustrates one usage of RegisterType.

#### Sample Request
<a name="API_RegisterType_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=RegisterType
 &Version=2010-05-15
 &TypeName=My::Resource::Example
 &SchemaHandlerPackage=[s3 url]
 &Type=RESOURCE
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20171211T230005Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_RegisterType_Example_1_Response"></a>

```
<RegisterTypeResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <RegisterTypeResult>
    <RegistrationToken>f5525280-104e-4d35-bef5-8f1f1example</RegistrationToken>
  </RegisterTypeResult>
  <ResponseMetadata>
    <RequestId>4d121847-1d2b-4ebe-8ca5-499405example</RequestId>
  </ResponseMetadata>
</RegisterTypeResponse>
```

## See Also
<a name="API_RegisterType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/RegisterType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/RegisterType) 

# RollbackStack
<a name="API_RollbackStack"></a>

When specifying `RollbackStack`, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the [DescribeStacks](API_DescribeStacks.md) operation.

Rolls back the specified stack to the last known stable state from `CREATE_FAILED` or `UPDATE_FAILED` stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a `*_COMPLETE`. This includes the following stack statuses.
+  `CREATE_COMPLETE` 
+  `UPDATE_COMPLETE` 
+  `UPDATE_ROLLBACK_COMPLETE` 
+  `IMPORT_COMPLETE` 
+  `IMPORT_ROLLBACK_COMPLETE` 

## Request Parameters
<a name="API_RollbackStack_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ClientRequestToken **   
A unique identifier for this `RollbackStack` request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** RetainExceptOnCreate **   
When set to `true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.  
Default: `false`   
Type: Boolean  
Required: No

 ** RoleARN **   
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** StackName **   
The name that's associated with the stack.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

## Response Elements
<a name="API_RollbackStack_ResponseElements"></a>

The following elements are returned by the service.

 ** OperationId **   
A unique identifier for this rollback operation that can be used to track the operation's progress and events.  
Type: String

 ** StackId **   
Unique identifier of the stack.  
Type: String

## Errors
<a name="API_RollbackStack_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** TokenAlreadyExists **   
A client request token already exists.  
HTTP Status Code: 400

## See Also
<a name="API_RollbackStack_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/RollbackStack) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/RollbackStack) 

# SetStackPolicy
<a name="API_SetStackPolicy"></a>

Sets a stack policy for a specified stack.

## Request Parameters
<a name="API_SetStackPolicy_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** StackName **   
The name or unique stack ID that you want to associate a policy with.  
Type: String  
Required: Yes

 ** StackPolicyBody **   
Structure that contains the stack policy body. For more information, see [Prevent updates to stack resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) in the * AWS CloudFormation User Guide*. You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.  
Required: No

 ** StackPolicyURL **   
Location of a file that contains the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an Amazon S3 bucket in the same AWS Region as the stack. The location for an Amazon S3 bucket must start with `https://`. URLs from S3 static websites are not supported.  
You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

## Errors
<a name="API_SetStackPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_SetStackPolicy_Examples"></a>

### SetStackPolicy
<a name="API_SetStackPolicy_Example_1"></a>

This example illustrates one usage of SetStackPolicy.

#### Sample Request
<a name="API_SetStackPolicy_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=SetStackPolicy
 &StackName=MyStack
 &StackPolicyBody=[Stack Policy Document]
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_SetStackPolicy_Example_1_Response"></a>

```
<SetStackPolicyResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ResponseMetadata>
    <RequestId>e7d8c346-744b-11e5-b40b-example</RequestId>
  </ResponseMetadata>
</SetStackPolicyResponse>
```

## See Also
<a name="API_SetStackPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/SetStackPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/SetStackPolicy) 

# SetTypeConfiguration
<a name="API_SetTypeConfiguration"></a>

Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region.

For more information, see [Edit configuration data for extensions in your account](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-set-configuration.html) in the * AWS CloudFormation User Guide*.

To view the current configuration data for an extension, refer to the `ConfigurationSchema` element of [DescribeType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html).

**Important**  
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more information, see [Specify values stored in other services using dynamic references](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) in the * AWS CloudFormation User Guide*.

For more information about setting the configuration data for resource types, see [Defining the account-level configuration of an extension](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*. For more information about setting the configuration data for Hooks, see the [CloudFormation Hooks User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/hooks-userguide/what-is-cloudformation-hooks.html).

## Request Parameters
<a name="API_SetTypeConfiguration_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Configuration **   
The configuration data for the extension in this account and Region.  
The configuration data must be formatted as JSON and validate against the extension's schema returned in the `Schema` response element of [DescribeType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 204800.  
Pattern: `[\s\S]+`   
Required: Yes

 ** ConfigurationAlias **   
An alias by which to refer to this extension configuration data.  
Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9]{1,256}$`   
Required: No

 ** Type **   
The type of extension.  
Conditional: You must specify `ConfigurationArn`, or `Type` and `TypeName`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeArn **   
The Amazon Resource Name (ARN) for the extension in this account and Region.  
For public extensions, this will be the ARN assigned when you call the [ActivateType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) API operation in this account and Region. For private extensions, this will be the ARN assigned when you call the [RegisterType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) API operation in this account and Region.  
Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+`   
Required: No

 ** TypeName **   
The name of the extension.  
Conditional: You must specify `ConfigurationArn`, or `Type` and `TypeName`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

## Response Elements
<a name="API_SetTypeConfiguration_ResponseElements"></a>

The following element is returned by the service.

 ** ConfigurationArn **   
The Amazon Resource Name (ARN) for the configuration data in this account and Region.  
Conditional: You must specify `ConfigurationArn`, or `Type` and `TypeName`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type-configuration/.+` 

## Errors
<a name="API_SetTypeConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## See Also
<a name="API_SetTypeConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/SetTypeConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/SetTypeConfiguration) 

# SetTypeDefaultVersion
<a name="API_SetTypeDefaultVersion"></a>

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

## Request Parameters
<a name="API_SetTypeDefaultVersion_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Arn **   
The Amazon Resource Name (ARN) of the extension for which you want version summary information.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+`   
Required: No

 ** Type **   
The kind of extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension.  
Conditional: You must specify either `TypeName` and `Type`, or `Arn`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

 ** VersionId **   
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9-]+`   
Required: No

## Errors
<a name="API_SetTypeDefaultVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## Examples
<a name="API_SetTypeDefaultVersion_Examples"></a>

### SetTypeDefaultVersion
<a name="API_SetTypeDefaultVersion_Example_1"></a>

This example illustrates one usage of SetTypeDefaultVersion.

#### Sample Request
<a name="API_SetTypeDefaultVersion_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=SetTypeDefaultVersion
 &Version=2010-05-15
 &TypeName=My::Resource::Example
 &VersionId=00000003
 &Type=RESOURCE
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20191204T182814Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_SetTypeDefaultVersion_Example_1_Response"></a>

```
<SetTypeDefaultVersionResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <SetTypeDefaultVersionResult/>
  <ResponseMetadata>
    <RequestId>dc46ff50-4ab3-485a-a104-bbbd3example</RequestId>
  </ResponseMetadata>
</SetTypeDefaultVersionResponse>
```

## See Also
<a name="API_SetTypeDefaultVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/SetTypeDefaultVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/SetTypeDefaultVersion) 

# SignalResource
<a name="API_SignalResource"></a>

Sends a signal to the specified resource with a success or failure status. You can use the `SignalResource` 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 `SignalResource` operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

## Request Parameters
<a name="API_SignalResource_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** LogicalResourceId **   
The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.  
Type: String  
Required: Yes

 ** StackName **   
The stack name or unique stack ID that includes the resource that you want to signal.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

 ** Status **   
The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.  
Type: String  
Valid Values: `SUCCESS | FAILURE`   
Required: Yes

 ** UniqueId **   
A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

## Errors
<a name="API_SignalResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_SignalResource_Examples"></a>

### SignalResource
<a name="API_SignalResource_Example_1"></a>

This example illustrates one usage of SignalResource.

#### Sample Request
<a name="API_SignalResource_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=SignalResource
 &LogicalResourceId=MyWaitCondition
 &StackName=AWaitingTestStack
 &Status=SUCCESS
 &UniqueId=test-signal
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_SignalResource_Example_1_Response"></a>

```
<SignalResourceResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ResponseMetadata>
    <RequestId>e7d8c346-744b-11e5-b40b-example</RequestId>
  </ResponseMetadata>
</SignalResourceResponse>
```

## See Also
<a name="API_SignalResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/SignalResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/SignalResource) 

# StartResourceScan
<a name="API_StartResourceScan"></a>

Starts a scan of the resources in this account in this Region. You can the status of a scan using the `ListResourceScans` API action.

## Request Parameters
<a name="API_StartResourceScan_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** ClientRequestToken **   
A unique identifier for this `StartResourceScan` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 **ScanFilters.member.N**   
The scan filters to use.  
Type: Array of [ScanFilter](API_ScanFilter.md) objects  
Array Members: Fixed number of 1 item.  
Required: No

## Response Elements
<a name="API_StartResourceScan_ResponseElements"></a>

The following element is returned by the service.

 ** ResourceScanId **   
The Amazon Resource Name (ARN) of the resource scan. The format is `arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}`. An example is `arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 `.  
Type: String

## Errors
<a name="API_StartResourceScan_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceScanInProgress **   
A resource scan is currently in progress. Only one can be run at a time for an account in a Region.  
HTTP Status Code: 400

 ** ResourceScanLimitExceeded **   
The limit on resource scans has been exceeded. Reasons include:  
+ Exceeded the daily quota for resource scans.
+ A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.
+ The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.
HTTP Status Code: 400

## See Also
<a name="API_StartResourceScan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/StartResourceScan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/StartResourceScan) 

# StopStackSetOperation
<a name="API_StopStackSetOperation"></a>

Stops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

## Request Parameters
<a name="API_StopStackSetOperation_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** CallAs **   
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the StackSet uses service-managed permissions.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** OperationId **   
The ID of the stack operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: Yes

 ** StackSetName **   
The name or unique ID of the StackSet that you want to stop the operation for.  
Type: String  
Required: Yes

## Errors
<a name="API_StopStackSetOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationNotFound **   
The specified ID refers to an operation that doesn't exist.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

## Examples
<a name="API_StopStackSetOperation_Examples"></a>

### StopStackSetOperation
<a name="API_StopStackSetOperation_Example_1"></a>

This example illustrates one usage of StopStackSetOperation.

#### Sample Request
<a name="API_StopStackSetOperation_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=StopStackSetOperation
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &OperationId=61806005-bde9-46f1-949d-6791example
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_StopStackSetOperation_Example_1_Response"></a>

```
<StopStackSetOperationResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <StopStackSetOperationResult/>
  <ResponseMetadata>
    <RequestId>dded5cd7-8140-11e7-bc66-f9191example</RequestId>
  </ResponseMetadata>
</StopStackSetOperationResponse>
```

## See Also
<a name="API_StopStackSetOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/StopStackSetOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/StopStackSetOperation) 

# TestType
<a name="API_TestType"></a>

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
+ For resource types, this includes passing all contracts tests defined for the type.
+ For modules, this includes determining if the module's model meets all necessary requirements.

For more information, see [Testing your public extension before publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.

If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see [RegisterType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).

Once you've initiated testing on an extension using `TestType`, you can pass the returned `TypeVersionArn` into [DescribeType](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) to monitor the current test status and test status description for the extension.

An extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) in the * AWS CloudFormation Command Line Interface (CLI) User Guide*.

## Request Parameters
<a name="API_TestType_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** Arn **   
The Amazon Resource Name (ARN) of the extension.  
Conditional: You must specify `Arn`, or `TypeName` and `Type`.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+`   
Required: No

 ** LogDeliveryBucket **   
The S3 bucket to which CloudFormation delivers the contract test execution logs.  
CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of `PASSED` or `FAILED`.  
The user calling `TestType` must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:  
+  `GetObject` 
+  `PutObject` 
For more information, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html) in the * AWS Identity and Access Management User Guide*.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[\s\S]+`   
Required: No

 ** Type **   
The type of the extension to test.  
Conditional: You must specify `Arn`, or `TypeName` and `Type`.  
Type: String  
Valid Values: `RESOURCE | MODULE | HOOK`   
Required: No

 ** TypeName **   
The name of the extension to test.  
Conditional: You must specify `Arn`, or `TypeName` and `Type`.  
Type: String  
Length Constraints: Minimum length of 10. Maximum length of 204.  
Pattern: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}`   
Required: No

 ** VersionId **   
The version of the extension to test.  
You can specify the version id with either `Arn`, or with `TypeName` and `Type`.  
If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[A-Za-z0-9-]+`   
Required: No

## Response Elements
<a name="API_TestType_ResponseElements"></a>

The following element is returned by the service.

 ** TypeVersionArn **   
The Amazon Resource Name (ARN) of the extension.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+` 

## Errors
<a name="API_TestType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CFNRegistry **   
An error occurred during a CloudFormation registry operation.    
 ** Message **   
A message with details about the error that occurred.
HTTP Status Code: 400

 ** TypeNotFound **   
The specified extension doesn't exist in the CloudFormation registry.  
HTTP Status Code: 404

## See Also
<a name="API_TestType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/TestType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/TestType) 

# UpdateGeneratedTemplate
<a name="API_UpdateGeneratedTemplate"></a>

Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the `DeletionPolicy` and `UpdateReplacePolicy` settings. You can check the status of the update to the generated template using the `DescribeGeneratedTemplate` API action.

## Request Parameters
<a name="API_UpdateGeneratedTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **AddResources.member.N**   
An optional list of resources to be added to the generated template.  
Type: Array of [ResourceDefinition](API_ResourceDefinition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 500 items.  
Required: No

 ** GeneratedTemplateName **   
The name or Amazon Resource Name (ARN) of a generated template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** NewGeneratedTemplateName **   
An optional new name to assign to the generated template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** RefreshAllResources **   
If `true`, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.  
Type: Boolean  
Required: No

 **RemoveResources.member.N**   
A list of logical ids for resources to remove from the generated template.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 500 items.  
Required: No

 ** TemplateConfiguration **   
The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.  
Type: [TemplateConfiguration](API_TemplateConfiguration.md) object  
Required: No

## Response Elements
<a name="API_UpdateGeneratedTemplate_ResponseElements"></a>

The following element is returned by the service.

 ** GeneratedTemplateId **   
The Amazon Resource Name (ARN) of the generated template. The format is `arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}`. For example, `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_UpdateGeneratedTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AlreadyExists **   
The resource with the name requested already exists.  
HTTP Status Code: 400

 ** GeneratedTemplateNotFound **   
The generated template was not found.  
HTTP Status Code: 404

 ** LimitExceeded **   
The quota for the resource has already been reached.  
For information about resource and stack limitations, see [CloudFormation quotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the * AWS CloudFormation User Guide*.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateGeneratedTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/UpdateGeneratedTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/UpdateGeneratedTemplate) 

# UpdateStack
<a name="API_UpdateStack"></a>

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 through the [DescribeStacks](API_DescribeStacks.md) action.

To get a copy of the template for an existing stack, you can use the [GetTemplate](API_GetTemplate.md) action.

For more information about updating a stack and monitoring the progress of the update, see [Managing AWS resources as a single unit with CloudFormation stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the * AWS CloudFormation User Guide*.

## Request Parameters
<a name="API_UpdateStack_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Capabilities.member.N**   
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.  
+  `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM` 

  Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
  + If you have IAM resources, you can specify either capability.
  + If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM`.
  + If you don't specify either of these capabilities, CloudFormation returns an `InsufficientCapabilities` error.

  If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.
  +  [ AWS::IAM::AccessKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html) 
  +  [ AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html) 
  +  [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html) 
  +  [ AWS::IAM::ManagedPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-managedpolicy.html) 
  +  [AWS::IAM::Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html) 
  +  [ AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html) 
  +  [ AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html) 
  +  [AWS::IAM::UserToGroupAddition](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html) 

  For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities).
+  `CAPABILITY_AUTO_EXPAND` 

  Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by CloudFormation.

  If you want to update a stack from a stack template that contains macros *and* nested stacks, you must update the stack directly from the template using this capability.
**Important**  
You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.  
Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.

  For more information, see [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
Only one of the `Capabilities` and `ResourceType` parameters can be specified.
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND`   
Required: No

 ** ClientRequestToken **   
A unique identifier for this `UpdateStack` request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry `UpdateStack` requests to ensure that CloudFormation successfully received them.  
All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a `CreateStack` operation with the token `token1`, then all the `StackEvents` generated by that operation will have `ClientRequestToken` set as `token1`.  
In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format *Console-StackOperation-ID*, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** DisableRollback **   
Preserve the state of previously provisioned resources when an operation fails.  
Default: `False`   
Type: Boolean  
Required: No

 **NotificationARNs.member.N**   
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification topics.  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Required: No

 **Parameters.member.N**   
A list of `Parameter` structures that specify input parameters for the stack. For more information, see the [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) data type.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 **ResourceTypes.member.N**   
Specifies which resource types you can work with, such as `AWS::EC2::Instance` or `Custom::MyCustomInstance`.  
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see [Control CloudFormation access with AWS Identity and Access Management](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html).  
Only one of the `Capabilities` and `ResourceType` parameters can be specified.
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** RetainExceptOnCreate **   
When set to `true`, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of `Retain`.  
Default: `false`   
Type: Boolean  
Required: No

 ** RoleARN **   
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.  
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** RollbackConfiguration **   
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.  
Type: [RollbackConfiguration](API_RollbackConfiguration.md) object  
Required: No

 ** StackName **   
The name or unique stack ID of the stack to update.  
Type: String  
Required: Yes

 ** StackPolicyBody **   
Structure that contains a new stack policy body. You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.  
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.  
Required: No

 ** StackPolicyDuringUpdateBody **   
Structure that contains the temporary overriding stack policy body. You can specify either the `StackPolicyDuringUpdateBody` or the `StackPolicyDuringUpdateURL` parameter, but not both.  
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.  
Required: No

 ** StackPolicyDuringUpdateURL **   
Location of a file that contains the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with `https://`. URLs from S3 static websites are not supported.  
You can specify either the `StackPolicyDuringUpdateBody` or the `StackPolicyDuringUpdateURL` parameter, but not both.  
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you don't specify a stack policy, the current policy that is associated with the stack will be used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

 ** StackPolicyURL **   
Location of a file that contains the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with `https://`. URLs from S3 static websites are not supported.  
You can specify either the `StackPolicyBody` or the `StackPolicyURL` parameter, but not both.  
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you don't specify a stack policy, the current policy that is associated with the stack is unchanged.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

 **Tags.member.N**   
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.  
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** TemplateBody **   
Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.  
Conditional: You must specify only one of the following parameters: `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to `true`.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateURL **   
The URL of a file that contains the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`.  
Conditional: You must specify only one of the following parameters: `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to `true`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

 ** UsePreviousTemplate **   
Reuse the existing template that is associated with the stack that you are updating.  
When using templates with the `AWS::LanguageExtensions` transform, provide the template instead of using `UsePreviousTemplate` to ensure new parameter values and Systems Manager parameter updates are applied correctly. For more information, see [AWS::LanguageExtensions transform](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/transform-aws-languageextensions.html).  
Conditional: You must specify only one of the following parameters: `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to `true`.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_UpdateStack_ResponseElements"></a>

The following elements are returned by the service.

 ** OperationId **   
A unique identifier for this update operation that can be used to track the operation's progress and events.  
Type: String

 ** StackId **   
Unique identifier of the stack.  
Type: String

## Errors
<a name="API_UpdateStack_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InsufficientCapabilities **   
The template contains resources with capabilities that weren't specified in the Capabilities parameter.  
HTTP Status Code: 400

 ** TokenAlreadyExists **   
A client request token already exists.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateStack_Examples"></a>

### UpdateStack
<a name="API_UpdateStack_Example_1"></a>

This example illustrates one usage of UpdateStack.

#### Sample Request
<a name="API_UpdateStack_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=UpdateStack
 &StackName=MyStack
 &TemplateBody=[Template Document]
 &Parameters.member.1.ParameterKey=AvailabilityZone
 &Parameters.member.1.ParameterValue=us-east-1a
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_UpdateStack_Example_1_Response"></a>

```
<UpdateStackResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <UpdateStackResult>
    <StackId>arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83</StackId>
  </UpdateStackResult>
  <ResponseMetadata>
    <RequestId>b9b4b068-3a41-11e5-94eb-example</RequestId>
  </ResponseMetadata>
</UpdateStackResponse>
```

## See Also
<a name="API_UpdateStack_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/UpdateStack) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/UpdateStack) 

# UpdateStackInstances
<a name="API_UpdateStackInstances"></a>

Updates the parameter values for stack instances for the specified accounts, within the specified AWS Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in AWS Regions and accounts where they already exist; to create additional stack instances, use [CreateStackInstances](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html).

During StackSet updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.

You can only update the parameter *values* that are specified in the StackSet. To add or delete a parameter itself, use [UpdateStackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use [UpdateStackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using `UpdateStackInstances`.

**Note**  
The maximum number of organizational unit (OUs) supported by a `UpdateStackInstances` operation is 50.  
If you need more than 50, consider the following options:  
 *Batch processing:* If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
 *Parent OU strategy:* If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

## Request Parameters
<a name="API_UpdateStackInstances_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Accounts.member.N**   
[Self-managed permissions] The account IDs of one or more AWS accounts in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and AWS Regions.  
You can specify `Accounts` or `DeploymentTargets`, but not both.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 ** DeploymentTargets **   
[Service-managed permissions] The AWS Organizations accounts in which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.  
You can specify `Accounts` or `DeploymentTargets`, but not both.  
Type: [DeploymentTargets](API_DeploymentTargets.md) object  
Required: No

 ** OperationId **   
The unique identifier for this StackSet operation.  
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** OperationPreferences **   
Preferences for how CloudFormation performs this StackSet operation.  
Type: [StackSetOperationPreferences](API_StackSetOperationPreferences.md) object  
Required: No

 **ParameterOverrides.member.N**   
A list of input parameters whose values you want to update for the specified stack instances.  
Any overridden parameter values will be applied to all stack instances in the specified accounts and AWS Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance update operations:  
+ To override the current value for a parameter, include the parameter and specify its value.
+ To leave an overridden parameter set to its present value, include the parameter and specify `UsePreviousValue` as `true`. (You can't specify both a value and set `UsePreviousValue` to `true`.)
+ To set an overridden parameter back to the value specified in the StackSet, specify a parameter list but don't include the parameter in the list.
+ To leave all parameters set to their present values, don't specify this property at all.
During StackSet updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.  
You can only override the parameter *values* that are specified in the StackSet. To add or delete a parameter itself, use `UpdateStackSet` to update the StackSet template. If you add a parameter to a template, before you can override the parameter value specified in the StackSet you must first use [UpdateStackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update all stack instances with the updated template and parameter value specified in the StackSet. Once a stack instance has been updated with the new parameter, you can then override the parameter value using `UpdateStackInstances`.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 **Regions.member.N**   
The names of one or more AWS Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and AWS Regions.  
Type: Array of strings  
Pattern: `^[a-zA-Z0-9-]{1,128}$`   
Required: Yes

 ** StackSetName **   
The name or unique ID of the StackSet associated with the stack instances.  
Type: String  
Pattern: `[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?`   
Required: Yes

## Response Elements
<a name="API_UpdateStackInstances_ResponseElements"></a>

The following element is returned by the service.

 ** OperationId **   
The unique identifier for this StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_UpdateStackInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationIdAlreadyExists **   
The specified operation ID already exists.  
HTTP Status Code: 409

 ** OperationInProgress **   
Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.  
HTTP Status Code: 409

 ** StackInstanceNotFound **   
The specified stack instance doesn't exist.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

 ** StaleRequest **   
Another operation has been performed on this StackSet since the specified operation was performed.  
HTTP Status Code: 409

## See Also
<a name="API_UpdateStackInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/UpdateStackInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/UpdateStackInstances) 

# UpdateStackSet
<a name="API_UpdateStackSet"></a>

Updates the StackSet and associated stack instances in the specified accounts and AWS Regions.

Even if the StackSet operation created by updating the StackSet fails (completely or partially, below or above a specified failure tolerance), the StackSet is updated with your changes. Subsequent [CreateStackInstances](API_CreateStackInstances.md) calls on the specified StackSet use the updated StackSet.

**Note**  
The maximum number of organizational unit (OUs) supported by a `UpdateStackSet` operation is 50.  
If you need more than 50, consider the following options:  
 *Batch processing:* If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.
 *Parent OU strategy:* If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

## Request Parameters
<a name="API_UpdateStackSet_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 **Accounts.member.N**   
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the AWS Regions in which to update StackSet instances.  
To update *all* the stack instances associated with this StackSet, don't specify the `Accounts` or `Regions` properties.  
If the StackSet update includes changes to the template (that is, if the `TemplateBody` or `TemplateURL` properties are specified), or the `Parameters` property, CloudFormation marks all stack instances with a status of `OUTDATED` prior to updating the stack instances in the specified accounts and AWS Regions. If the StackSet update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and AWS Regions, while leaving all other stack instances with their existing stack instance status.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** AdministrationRoleARN **   
[Self-managed permissions] The Amazon Resource Name (ARN) of the IAM role to use to update this StackSet.  
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see [Grant self-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html) in the * AWS CloudFormation User Guide*.  
If you specified a customized administrator role when you created the StackSet, you must specify a customized administrator role, even if it is the same customized administrator role used with this StackSet previously.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Required: No

 ** AutoDeployment **   
[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see [Enable or disable automatic deployments for StackSets in AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html) in the * AWS CloudFormation User Guide*.  
If you specify `AutoDeployment`, don't specify `DeploymentTargets` or `Regions`.  
Type: [AutoDeployment](API_AutoDeployment.md) object  
Required: No

 ** CallAs **   
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.  
By default, `SELF` is specified. Use `SELF` for StackSets with self-managed permissions.  
+ If you are signed in to the management account, specify `SELF`.
+ If you are signed in to a delegated administrator account, specify `DELEGATED_ADMIN`.

  Your AWS account must be registered as a delegated administrator in the management account. For more information, see [Register a delegated administrator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the * AWS CloudFormation User Guide*.
Type: String  
Valid Values: `SELF | DELEGATED_ADMIN`   
Required: No

 **Capabilities.member.N**   
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the StackSet and its associated stack instances.  
+  `CAPABILITY_IAM` and `CAPABILITY_NAMED_IAM` 

  Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new IAM users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.

  The following IAM resources require you to specify either the `CAPABILITY_IAM` or `CAPABILITY_NAMED_IAM` capability.
  + If you have IAM resources, you can specify either capability.
  + If you have IAM resources with custom names, you *must* specify `CAPABILITY_NAMED_IAM`.
  + If you don't specify either of these capabilities, CloudFormation returns an `InsufficientCapabilities` error.

  If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.
  +  [AWS::IAM::AccessKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-accesskey.html) 
  +  [AWS::IAM::Group](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-group.html) 
  +  [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-instanceprofile.html) 
  +  [AWS::IAM::Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-policy.html) 
  +  [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-role.html) 
  +  [AWS::IAM::User](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html) 
  +  [AWS::IAM::UserToGroupAddition](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-usertogroupaddition.html) 

  For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities).
+  `CAPABILITY_AUTO_EXPAND` 

  Some templates reference macros. If your StackSet template references one or more macros, you must update the StackSet directly from the processed template, without first reviewing the resulting changes in a change set. To update the StackSet directly, you must acknowledge this capability. For more information, see [Perform custom processing on CloudFormation templates with template macros](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
**Important**  
StackSets with service-managed permissions do not currently support the use of macros in templates. (This includes the [AWS::Include](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html) and [AWS::Serverless](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a StackSet with service-managed permissions, if you reference a macro in your template the StackSet operation will fail.
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND`   
Required: No

 ** DeploymentTargets **   
[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.  
To update all the stack instances associated with this StackSet, do not specify `DeploymentTargets` or `Regions`.  
If the StackSet update includes changes to the template (that is, if `TemplateBody` or `TemplateURL` is specified), or the `Parameters`, CloudFormation marks all stack instances with a status of `OUTDATED` prior to updating the stack instances in the specified accounts and AWS Regions. If the StackSet update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.  
Type: [DeploymentTargets](API_DeploymentTargets.md) object  
Required: No

 ** Description **   
A brief description of updates that you are making.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ExecutionRoleName **   
[Self-managed permissions] The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the StackSet operation.  
Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their StackSets.  
If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a customized execution role, CloudFormation performs the update using the role previously associated with the StackSet, so long as you have permissions to perform operations on the StackSet.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z_0-9+=,.@-]+`   
Required: No

 ** ManagedExecution **   
Describes whether CloudFormation performs non-conflicting operations concurrently and queues conflicting operations.  
Type: [ManagedExecution](API_ManagedExecution.md) object  
Required: No

 ** OperationId **   
The unique ID for this StackSet operation.  
The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You might retry StackSet operation requests to ensure that CloudFormation successfully received them.  
Repeating this StackSet operation with a new operation ID retries all stack instances whose status is `OUTDATED`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*`   
Required: No

 ** OperationPreferences **   
Preferences for how CloudFormation performs this StackSet operation.  
Type: [StackSetOperationPreferences](API_StackSetOperationPreferences.md) object  
Required: No

 **Parameters.member.N**   
A list of input parameters for the StackSet template.  
Type: Array of [Parameter](API_Parameter.md) objects  
Required: No

 ** PermissionModel **   
Describes how the IAM roles required for StackSet operations are created. You cannot modify `PermissionModel` if there are stack instances associated with your stack set.  
+ With `self-managed` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see [Grant self-managed permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
+ With `service-managed` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see [Activate trusted access for StackSets with AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html).
Type: String  
Valid Values: `SERVICE_MANAGED | SELF_MANAGED`   
Required: No

 **Regions.member.N**   
The AWS Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update StackSet instances.  
To update *all* the stack instances associated with this StackSet, do not specify the `Accounts` or `Regions` properties.  
If the StackSet update includes changes to the template (that is, if the `TemplateBody` or `TemplateURL` properties are specified), or the `Parameters` property, CloudFormation marks all stack instances with a status of `OUTDATED` prior to updating the stack instances in the specified accounts and Regions. If the StackSet update does not include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.  
Type: Array of strings  
Pattern: `^[a-zA-Z0-9-]{1,128}$`   
Required: No

 ** StackSetName **   
The name or unique ID of the StackSet that you want to update.  
Type: String  
Required: Yes

 **Tags.member.N**   
The key-value pairs to associate with this StackSet and the stacks created from it. CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.  
If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this StackSet. This means:  
+ If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
+ If you specify *any* tags using this parameter, you must specify *all* the tags that you want associated with this StackSet, even tags you've specified before (for example, when creating the StackSet or during a previous update of the StackSet.). Any tags that you don't include in the updated list of tags are removed from the StackSet, and therefore from the stacks and resources as well.
+ If you specify an empty value, CloudFormation removes all currently associated tags.
If you specify new tags as part of an `UpdateStackSet` action, CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the StackSet from the list of tags you specify, CloudFormation assumes that you want to remove those tags from the StackSet, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire `UpdateStackSet` action fails with an `access denied` error, and the StackSet is not updated.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** TemplateBody **   
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.  
Conditional: You must specify only one of the following parameters: `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateURL **   
The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`. S3 static website URLs are not supported.  
Conditional: You must specify only one of the following parameters: `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

 ** UsePreviousTemplate **   
Use the existing template that's associated with the StackSet that you're updating.  
Conditional: You must specify only one of the following parameters: `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_UpdateStackSet_ResponseElements"></a>

The following element is returned by the service.

 ** OperationId **   
The unique ID for this StackSet operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][-a-zA-Z0-9]*` 

## Errors
<a name="API_UpdateStackSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidOperation **   
The specified operation isn't valid.  
HTTP Status Code: 400

 ** OperationIdAlreadyExists **   
The specified operation ID already exists.  
HTTP Status Code: 409

 ** OperationInProgress **   
Another operation is currently in progress for this StackSet. Only one operation can be performed for a stack set at a given time.  
HTTP Status Code: 409

 ** StackInstanceNotFound **   
The specified stack instance doesn't exist.  
HTTP Status Code: 404

 ** StackSetNotFound **   
The specified StackSet doesn't exist.  
HTTP Status Code: 404

 ** StaleRequest **   
Another operation has been performed on this StackSet since the specified operation was performed.  
HTTP Status Code: 409

## Examples
<a name="API_UpdateStackSet_Examples"></a>

### UpdateStackSet
<a name="API_UpdateStackSet_Example_1"></a>

This example illustrates one usage of UpdateStackSet.

#### Sample Request
<a name="API_UpdateStackSet_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=UpdateStackSet
 &Version=2010-05-15
 &StackSetName=stack-set-example
 &OperationPreferences.MaxConcurrentCount=2
 &OperationPreferences.FailureToleranceCount=1
 &UsePreviousTemplate=true
 &Tags.member.1.Key=new_key
 &Tags.member.1.Value=new_value
 &OperationId=bb1764f4-3dea-4c39-bd65-066aexample
 &X-Amz-Algorithm=AWS4-HMAC-SHA256
 &X-Amz-Credential=[Access key ID and scope]
 &X-Amz-Date=20170810T233349Z
 &X-Amz-SignedHeaders=content-type;host
 &X-Amz-Signature=[Signature]
```

#### Sample Response
<a name="API_UpdateStackSet_Example_1_Response"></a>

```
<UpdateStackSetResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
  <UpdateStackSetResult>
    <OperationId>bb1764f4-3dea-4c39-bd65-066aexamplef</OperationId>
  </UpdateStackSetResult>
  <ResponseMetadata>
    <RequestId>32d4839e-7e24-11e7-b656-d39aexample</RequestId>
  </ResponseMetadata>
</UpdateStackSetResponse>
```

## See Also
<a name="API_UpdateStackSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/UpdateStackSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/UpdateStackSet) 

# UpdateTerminationProtection
<a name="API_UpdateTerminationProtection"></a>

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see [Protect a CloudFormation stack from being deleted](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the * AWS CloudFormation User Guide*.

For [nested stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), termination protection is set on the root stack and can't be changed directly on the nested stack.

## Request Parameters
<a name="API_UpdateTerminationProtection_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** EnableTerminationProtection **   
Whether to enable termination protection on the specified stack.  
Type: Boolean  
Required: Yes

 ** StackName **   
The name or unique ID of the stack for which you want to set termination protection.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)`   
Required: Yes

## Response Elements
<a name="API_UpdateTerminationProtection_ResponseElements"></a>

The following element is returned by the service.

 ** StackId **   
The unique ID of the stack.  
Type: String

## Errors
<a name="API_UpdateTerminationProtection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_UpdateTerminationProtection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/UpdateTerminationProtection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/UpdateTerminationProtection) 

# ValidateTemplate
<a name="API_ValidateTemplate"></a>

Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.

## Request Parameters
<a name="API_ValidateTemplate_RequestParameters"></a>

 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

 ** TemplateBody **   
Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.  
Conditional: You must pass `TemplateURL` or `TemplateBody`. If both are passed, only `TemplateBody` is used.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TemplateURL **   
The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with `https://`.  
Conditional: You must pass `TemplateURL` or `TemplateBody`. If both are passed, only `TemplateBody` is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5120.  
Required: No

## Response Elements
<a name="API_ValidateTemplate_ResponseElements"></a>

The following elements are returned by the service.

 **Capabilities.member.N**   
The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY\$1IAM or CAPABILITY\$1NAMED\$1IAM value for this parameter when you use the [CreateStack](API_CreateStack.md) or [UpdateStack](API_UpdateStack.md) actions with your template; otherwise, those actions return an InsufficientCapabilities error.  
For more information, see [Acknowledging IAM resources in CloudFormation templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities).  
Type: Array of strings  
Valid Values: `CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND` 

 ** CapabilitiesReason **   
The list of resources that generated the values in the `Capabilities` response element.  
Type: String

 **DeclaredTransforms.member.N**   
A list of the transforms that are declared in the template.  
Type: Array of strings

 ** Description **   
The description found within the template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 **Parameters.member.N**   
A list of `TemplateParameter` structures.  
Type: Array of [TemplateParameter](API_TemplateParameter.md) objects

## Errors
<a name="API_ValidateTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## Examples
<a name="API_ValidateTemplate_Examples"></a>

### ValidateTemplate
<a name="API_ValidateTemplate_Example_1"></a>

This example illustrates one usage of ValidateTemplate.

#### Sample Request
<a name="API_ValidateTemplate_Example_1_Request"></a>

```
https://cloudformation.us-east-1.amazonaws.com/
 ?Action=ValidateTemplate
 &TemplateBody=http://myTemplateRepository/TemplateOne.template
 &Version=2010-05-15
 &SignatureVersion=2
 &Timestamp=2010-07-27T22%3A26%3A28.000Z
 &AWSAccessKeyId=[AWS Access KeyID]
 &Signature=[Signature]
```

#### Sample Response
<a name="API_ValidateTemplate_Example_1_Response"></a>

```
<ValidateTemplateResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
  <ValidateTemplateResult>
    <Description></Description>
    <Parameters>
      <member>
        <NoEcho>false</NoEcho>
        <ParameterKey>InstanceType</ParameterKey>
        <Description>Type of instance to launch</Description>
        <DefaultValue>m1.small</DefaultValue>
      </member>
      <member>
        <NoEcho>false</NoEcho>
        <ParameterKey>WebServerPort</ParameterKey>
        <Description>The TCP port for the Web Server</Description>
        <DefaultValue>8888</DefaultValue>
      </member>
      <member>
        <NoEcho>false</NoEcho>
        <ParameterKey>KeyName</ParameterKey>
        <Description>Name of an existing EC2 KeyPair to enable SSH access into the server</Description>
      </member>
    </Parameters>
  </ValidateTemplateResult>
  <ResponseMetadata>
    <RequestId>0be7b6e8-e4a0-11e0-a5bd-example</RequestId>
  </ResponseMetadata>
</ValidateTemplateResponse>
```

## See Also
<a name="API_ValidateTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudformation-2010-05-15/ValidateTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudformation-2010-05-15/ValidateTemplate)