Skip to content

delete_workflow async

delete_workflow(
    id: MigrationWorkflowId,
    *,
    config_overrides: Optional[AsyncMigrationHubOrchestratorClientConfig] = None,
) -> DeleteMigrationWorkflowResponse

Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.

Parameters:

Raises:

Source code in docs_src/capo_migrationhuborchestrator/_services/async_migration_hub_orchestrator.py
async def delete_workflow(
    self,
    id: "capo_migrationhuborchestrator.types.migration_workflow_id.MigrationWorkflowId",
    *,
    config_overrides: Optional[AsyncMigrationHubOrchestratorClientConfig] = None,
) -> "capo_migrationhuborchestrator.types.delete_migration_workflow_response.DeleteMigrationWorkflowResponse":
    """<p>Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.</p>

    Args:
        id: <p>The ID of the migration workflow you want to delete.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_migrationhuborchestrator.types.delete_migration_workflow_request.DeleteMigrationWorkflowRequest]",
    ) -> AsyncOperationResponse[
        "capo_migrationhuborchestrator.types.delete_migration_workflow_response.DeleteMigrationWorkflowResponse"
    ]:
        import capo_migrationhuborchestrator._operations.aws_migration_hub_orchestrator.delete_workflow

        (
            output,
            http_response,
        ) = await capo_migrationhuborchestrator._operations.aws_migration_hub_orchestrator.delete_workflow.async_delete_workflow(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWorkflow")
    )
    input_: capo_migrationhuborchestrator.types.delete_migration_workflow_request.DeleteMigrationWorkflowRequest = {
        "id": id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output