Skip to content

get_workflow_version async

get_workflow_version(
    workflow_id: WorkflowId,
    version_name: WorkflowVersionName,
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    type: Optional[WorkflowType] = None,
    export: Optional[WorkflowExportList] = None,
    workflow_owner_id: Optional[WorkflowOwnerId] = None,
) -> GetWorkflowVersionResponse

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

Parameters:

  • workflow_id (WorkflowId) –

    The workflow's ID. The workflowId is not the UUID.

  • version_name (WorkflowVersionName) –

    The workflow version name.

  • 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 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

Raises:

Source code in docs_src/capo_omics/_services/async_omics.py
async def get_workflow_version(
    self,
    workflow_id: "capo_omics.types.workflow_id.WorkflowId",
    version_name: "capo_omics.types.workflow_version_name.WorkflowVersionName",
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = 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_version_response.GetWorkflowVersionResponse":
    """<p>Gets information about a workflow version. For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html">Workflow versioning in Amazon Web Services HealthOmics</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>

    Args:
        workflow_id: <p>The workflow's ID. The <code>workflowId</code> is not the UUID.</p>
        version_name: <p>The workflow version name.</p>
        type: <p>The workflow's type. </p>
        export: <p>The export format for the workflow.</p>
        workflow_owner_id: <p>The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the <code>GetShare</code> API operation. If you are the workflow owner, you do not need to include this ID.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_omics.types.get_workflow_version_request.GetWorkflowVersionRequest]",
    ) -> AsyncOperationResponse[
        "capo_omics.types.get_workflow_version_response.GetWorkflowVersionResponse"
    ]:
        import capo_omics._operations.omics.get_workflow_version

        (
            output,
            http_response,
        ) = await capo_omics._operations.omics.get_workflow_version.async_get_workflow_version(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkflowVersion")
    )
    input_: capo_omics.types.get_workflow_version_request.GetWorkflowVersionRequest = {
        "workflow_id": workflow_id,
        "version_name": version_name,
    }
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output