ARCRegionswitch / Client / update_plan_execution

update_plan_execution

ARCRegionswitch.Client.update_plan_execution(**kwargs)

Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.

See also: AWS API Documentation

Request Syntax

response = client.update_plan_execution(
    planArn='string',
    executionId='string',
    action='switchToGraceful'|'switchToUngraceful'|'pause'|'resume',
    comment='string'
)
Parameters:

  • planArn (string) –

    [REQUIRED]

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

  • executionId (string) –

    [REQUIRED]

    The execution identifier of a plan execution.

  • action (string) –

    [REQUIRED]

    The action specified for a plan execution, for example, Switch to Graceful or Pause.

  • comment (string) – An optional comment about the plan execution.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • ARCRegionswitch.Client.exceptions.ResourceNotFoundException

  • ARCRegionswitch.Client.exceptions.IllegalStateException

  • ARCRegionswitch.Client.exceptions.AccessDeniedException