Menu
AWS CloudFormation
API Reference (API Version 2010-05-15)

DeleteStackInstances

Deletes stack instances for the specified accounts, in the specified regions.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Accounts.member.N

The names of the AWS accounts that you want to delete stack instances for.

Type: Array of strings

Pattern: [0-9]{12}

Required: Yes

OperationId

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

Repeating this stack set 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 AWS CloudFormation performs this stack set operation.

Type: StackSetOperationPreferences object

Required: No

Regions.member.N

The regions where you want to delete stack set instances.

Type: Array of strings

Required: Yes

RetainStacks

Removes the stack instances from the specified stack set, 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 Stack set operation options.

Type: Boolean

Required: Yes

StackSetName

The name or unique ID of the stack set that you want to delete stack instances for.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

OperationId

The unique identifier for this stack set operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Errors

For information about the errors that are common to all actions, see Common Errors.

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 stack set. Only one operation can be performed for a stack set at a given time.

HTTP Status Code: 409

StackSetNotFound

The specified stack set doesn't exist.

HTTP Status Code: 404

StaleRequest

Another operation has been performed on this stack set since the specified operation was performed.

HTTP Status Code: 409

Example

DeleteStackInstances

Sample Request

 
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


<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

For more information about using this API in one of the language-specific AWS SDKs, see the following: