get_workflow ¶

get_workflow(
    id: WorkflowId,
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    type: Optional[WorkflowType] = None,
    export: Optional[WorkflowExportList] = None,
    workflow_owner_id: Optional[WorkflowOwnerId] = None,
) -> GetWorkflowResponse

Gets all information about a workflow using its ID.

If a workflow is shared with you, you cannot export the workflow.

For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.

Parameters:

id (WorkflowId) –

The workflow's ID.
type (Optional[WorkflowType], default: None ) –

The workflow's type.
export (Optional[WorkflowExportList], default: None ) –

The export format for the workflow.
workflow_owner_id (Optional[WorkflowOwnerId], default: None ) –

The ID of the workflow owner.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

The request cannot be applied to the target resource in its current state.
InternalServerException –

An unexpected error occurred. Try the request again.
RequestTimeoutException –

The request timed out.
ResourceNotFoundException –

The target resource was not found in the current Region.
ServiceQuotaExceededException –

The request exceeds a service quota.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_omics/_services/omics.py

def get_workflow(
    self,
    id: "capo_omics.types.workflow_id.WorkflowId",
    *,
    config_overrides: Optional[OmicsClientConfig] = None,
    type: Optional["capo_omics.types.workflow_type.WorkflowType"] = None,
    export: Optional[
        "capo_omics.types.workflow_export_list.WorkflowExportList"
    ] = None,
    workflow_owner_id: Optional[
        "capo_omics.types.workflow_owner_id.WorkflowOwnerId"
    ] = None,
) -> "capo_omics.types.get_workflow_response.GetWorkflowResponse":
    """<p>Gets all information about a workflow using its ID.</p> <p>If a workflow is shared with you, you cannot export the workflow.</p> <p>For more information about your workflow status, see <a href="https://docs.aws.amazon.com/omics/latest/dev/using-get-workflow.html">Verify the workflow status</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>

    Args:
        id: <p>The workflow's ID.</p>
        type: <p>The workflow's type.</p>
        export: <p>The export format for the workflow.</p>
        workflow_owner_id: <p>The ID of the workflow owner.</p>

    Raises:
        capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_omics.errors.conflict_exception.ConflictException: <p>The request cannot be applied to the target resource in its current state.</p>
        capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
        capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
        capo_omics.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found in the current Region.</p>
        capo_omics.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds a service quota.</p>
        capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_omics.types.get_workflow_request.GetWorkflowRequest]",
    ) -> OperationResponse[
        "capo_omics.types.get_workflow_response.GetWorkflowResponse"
    ]:
        import capo_omics._operations.omics.get_workflow

        output, http_response = (
            capo_omics._operations.omics.get_workflow.get_workflow(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkflow")
    )
    input_: capo_omics.types.get_workflow_request.GetWorkflowRequest = {"id": id}
    if type is not None:
        input_["type"] = type
    if export is not None:
        input_["export"] = export
    if workflow_owner_id is not None:
        input_["workflow_owner_id"] = workflow_owner_id

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