CloudFormation / Client / stop_stack_set_operation

stop_stack_set_operation#

CloudFormation.Client.stop_stack_set_operation(**kwargs)#

Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

See also: AWS API Documentation

Request Syntax

response = client.stop_stack_set_operation(
    StackSetName='string',
    OperationId='string',
    CallAs='SELF'|'DELEGATED_ADMIN'
)
Parameters:

  • StackSetName (string) –

    [REQUIRED]

    The name or unique ID of the stack set that you want to stop the operation for.

  • OperationId (string) –

    [REQUIRED]

    The ID of the stack operation.

  • CallAs (string) –

    [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 stack sets 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • CloudFormation.Client.exceptions.StackSetNotFoundException

  • CloudFormation.Client.exceptions.OperationNotFoundException

  • CloudFormation.Client.exceptions.InvalidOperationException