Skip to content

update_plan_execution_step

update_plan_execution_step(
    plan_arn: PlanArn,
    execution_id: ExecutionId,
    comment: ExecutionComment,
    step_name: str,
    action_to_take: UpdatePlanExecutionStepAction,
    *,
    config_overrides: Optional[ARCRegionswitchClientConfig] = None,
) -> UpdatePlanExecutionStepResponse

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

Parameters:

  • plan_arn (PlanArn) –

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

  • execution_id (ExecutionId) –

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

  • comment (ExecutionComment) –

    An optional comment about the plan execution.

  • step_name (str) –

    The name of the execution step to update.

  • action_to_take (UpdatePlanExecutionStepAction) –

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

Raises:

Source code in docs_src/capo_arc_region_switch/_services/arc_regionswitch.py
def update_plan_execution_step(
    self,
    plan_arn: "capo_arc_region_switch.types.plan_arn.PlanArn",
    execution_id: "capo_arc_region_switch.types.execution_id.ExecutionId",
    comment: "capo_arc_region_switch.types.execution_comment.ExecutionComment",
    step_name: str,
    action_to_take: "capo_arc_region_switch.types.update_plan_execution_step_action.UpdatePlanExecutionStepAction",
    *,
    config_overrides: Optional[ARCRegionswitchClientConfig] = None,
) -> "capo_arc_region_switch.types.update_plan_execution_step_response.UpdatePlanExecutionStepResponse":
    """<p>Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.</p>

    Args:
        plan_arn: <p>The Amazon Resource Name (ARN) of the plan containing the execution step to update.</p>
        execution_id: <p>The unique identifier of the plan execution containing the step to update.</p>
        comment: <p>An optional comment about the plan execution.</p>
        step_name: <p>The name of the execution step to update.</p>
        action_to_take: <p>The updated action to take for the step. This can be used to skip or retry a step.</p>

    Raises:
        capo_arc_region_switch.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p>HTTP Status Code: 403</p>
        capo_arc_region_switch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p> <p>HTTP Status Code: 404</p>
        capo_arc_region_switch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_arc_region_switch.types.update_plan_execution_step_request.UpdatePlanExecutionStepRequest]",
    ) -> OperationResponse[
        "capo_arc_region_switch.types.update_plan_execution_step_response.UpdatePlanExecutionStepResponse"
    ]:
        import capo_arc_region_switch._operations.arc_region_switch.update_plan_execution_step

        output, http_response = (
            capo_arc_region_switch._operations.arc_region_switch.update_plan_execution_step.update_plan_execution_step(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePlanExecutionStep")
    )
    input_: capo_arc_region_switch.types.update_plan_execution_step_request.UpdatePlanExecutionStepRequest = {
        "plan_arn": plan_arn,
        "execution_id": execution_id,
        "comment": comment,
        "step_name": step_name,
        "action_to_take": action_to_take,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output