ARCRegionswitch / Client / update_plan_execution_step

update_plan_execution_step

ARCRegionswitch.Client.update_plan_execution_step(**kwargs)

Updates a specific step in an in-progress plan execution. This operation allows you to modify the step’s comment or action.

See also: AWS API Documentation

Request Syntax

response = client.update_plan_execution_step(
    planArn='string',
    executionId='string',
    comment='string',
    stepName='string',
    actionToTake='switchToUngraceful'|'skip'
)
Parameters:
  • planArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the plan containing the execution step to update.

  • executionId (string) –

    [REQUIRED]

    The unique identifier of the plan execution containing the step to update.

  • comment (string) –

    [REQUIRED]

    An optional comment about the plan execution.

  • stepName (string) –

    [REQUIRED]

    The name of the execution step to update.

  • actionToTake (string) –

    [REQUIRED]

    The updated action to take for the step. This can be used to skip or retry a step.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • ARCRegionswitch.Client.exceptions.ResourceNotFoundException

  • ARCRegionswitch.Client.exceptions.AccessDeniedException