Skip to content

delete_workflow

delete_workflow(
    workflow_id: WorkflowId, *, config_overrides: Optional[TransferClientConfig] = None
) -> None

Deletes the specified workflow.

Parameters:

  • workflow_id (WorkflowId) –

    A unique identifier for the workflow.

Raises:

Source code in docs_src/capo_transfer/_services/transfer.py
def delete_workflow(
    self,
    workflow_id: "capo_transfer.types.workflow_id.WorkflowId",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
) -> None:
    """<p>Deletes the specified workflow.</p>

    Args:
        workflow_id: <p>A unique identifier for the workflow.</p>

    Raises:
        capo_transfer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.delete_workflow_request.DeleteWorkflowRequest]",
    ) -> OperationResponse[None]:
        import capo_transfer._operations.transfer_service.delete_workflow

        output, http_response = (
            capo_transfer._operations.transfer_service.delete_workflow.delete_workflow(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWorkflow")
    )
    input_: capo_transfer.types.delete_workflow_request.DeleteWorkflowRequest = {
        "workflow_id": workflow_id
    }

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