Skip to content

delete_workflow_step

delete_workflow_step(
    id: StepId,
    step_group_id: StepGroupId,
    workflow_id: MigrationWorkflowId,
    *,
    config_overrides: Optional[MigrationHubOrchestratorClientConfig] = None,
) -> DeleteWorkflowStepResponse

Delete a step in a migration workflow. Pause the workflow to delete a running step.

Parameters:

  • id (StepId) –

    The ID of the step you want to delete.

  • step_group_id (StepGroupId) –

    The ID of the step group that contains the step you want to delete.

  • workflow_id (MigrationWorkflowId) –

    The ID of the migration workflow.

Raises:

Source code in docs_src/capo_migrationhuborchestrator/_services/migration_hub_orchestrator.py
def delete_workflow_step(
    self,
    id: "capo_migrationhuborchestrator.types.step_id.StepId",
    step_group_id: "capo_migrationhuborchestrator.types.step_group_id.StepGroupId",
    workflow_id: "capo_migrationhuborchestrator.types.migration_workflow_id.MigrationWorkflowId",
    *,
    config_overrides: Optional[MigrationHubOrchestratorClientConfig] = None,
) -> "capo_migrationhuborchestrator.types.delete_workflow_step_response.DeleteWorkflowStepResponse":
    """<p>Delete a step in a migration workflow. Pause the workflow to delete a running step.</p>

    Args:
        id: <p>The ID of the step you want to delete.</p>
        step_group_id: <p>The ID of the step group that contains the step you want to delete.</p>
        workflow_id: <p>The ID of the migration workflow.</p>

    Raises:
        capo_migrationhuborchestrator.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_migrationhuborchestrator.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_migrationhuborchestrator.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource is not available.</p>
        capo_migrationhuborchestrator.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_migrationhuborchestrator.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_migrationhuborchestrator.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_migrationhuborchestrator.types.delete_workflow_step_request.DeleteWorkflowStepRequest]",
    ) -> OperationResponse[
        "capo_migrationhuborchestrator.types.delete_workflow_step_response.DeleteWorkflowStepResponse"
    ]:
        import capo_migrationhuborchestrator._operations.aws_migration_hub_orchestrator.delete_workflow_step

        output, http_response = (
            capo_migrationhuborchestrator._operations.aws_migration_hub_orchestrator.delete_workflow_step.delete_workflow_step(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWorkflowStep")
    )
    input_: capo_migrationhuborchestrator.types.delete_workflow_step_request.DeleteWorkflowStepRequest = {
        "id": id,
        "step_group_id": step_group_id,
        "workflow_id": workflow_id,
    }

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