delete_stack_instances¶
Operation¶
async
¶
delete_stack_instances(input: DeleteStackInstancesInput, plugins: list[Plugin] | None = None) -> DeleteStackInstancesOutput
Deletes stack instances for the specified accounts, in the specified Amazon Web Services 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteStackInstancesInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DeleteStackInstancesOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteStackInstancesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.
You can specify Accounts or DeploymentTargets, but not both.
class-attribute
instance-attribute
¶
call_as: str | None = ...
[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 Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
class-attribute
instance-attribute
¶
deployment_targets: DeploymentTargets | None = ...
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
You can specify Accounts or DeploymentTargets, but not both.
class-attribute
instance-attribute
¶
operation_id: str | None = ...
The unique identifier for this StackSet operation.
If you don't specify an operation ID, the SDK generates one automatically.
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.
class-attribute
instance-attribute
¶
operation_preferences: StackSetOperationPreferences | None = ...
Preferences for how CloudFormation performs this StackSet operation.
class-attribute
instance-attribute
¶
The Amazon Web Services Regions where you want to delete StackSet instances.
class-attribute
instance-attribute
¶
retain_stacks: bool | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteStackInstancesOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
operation_id: str | None = ...
The unique identifier for this StackSet operation.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.