stop_workflow ¶

def stop_workflow(
    self,
    id: "capo_migrationhuborchestrator.types.migration_workflow_id.MigrationWorkflowId",
    *,
    config_overrides: Optional[MigrationHubOrchestratorClientConfig] = None,
) -> "capo_migrationhuborchestrator.types.stop_migration_workflow_response.StopMigrationWorkflowResponse":
    """<p>Stop an ongoing migration workflow.</p>

    Args:
        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.stop_migration_workflow_request.StopMigrationWorkflowRequest]",
    ) -> OperationResponse[
        "capo_migrationhuborchestrator.types.stop_migration_workflow_response.StopMigrationWorkflowResponse"
    ]:
        import capo_migrationhuborchestrator._operations.aws_migration_hub_orchestrator.stop_workflow

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopWorkflow")
    )
    input_: capo_migrationhuborchestrator.types.stop_migration_workflow_request.StopMigrationWorkflowRequest = {
        "id": id
    }

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