Skip to content

list_workflow_versions async

list_workflow_versions(
    workflow_id: WorkflowId,
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    type: Optional[WorkflowType] = None,
    workflow_owner_id: Optional[WorkflowOwnerId] = None,
    starting_token: Optional[WorkflowVersionListToken] = None,
    max_results: Optional[int] = None,
) -> ListWorkflowVersionsResponse

Lists the workflow versions for the specified workflow. 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.

  • type (Optional[WorkflowType], default: None ) –

    The workflow type.

  • 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.

  • starting_token (Optional[WorkflowVersionListToken], default: None ) –

    Specify the pagination token from a previous request to retrieve the next page of results.

  • max_results (Optional[int], default: None ) –

    The maximum number of workflows to return in one page of results.

Raises:

Source code in docs_src/capo_omics/_services/async_omics.py
async def list_workflow_versions(
    self,
    workflow_id: "capo_omics.types.workflow_id.WorkflowId",
    *,
    config_overrides: Optional[AsyncOmicsClientConfig] = None,
    type: Optional["capo_omics.types.workflow_type.WorkflowType"] = None,
    workflow_owner_id: Optional[
        "capo_omics.types.workflow_owner_id.WorkflowOwnerId"
    ] = None,
    starting_token: Optional[
        "capo_omics.types.workflow_version_list_token.WorkflowVersionListToken"
    ] = None,
    max_results: Optional[int] = None,
) -> (
    "capo_omics.types.list_workflow_versions_response.ListWorkflowVersionsResponse"
):
    """<p>Lists the workflow versions for the specified workflow. 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>
        type: <p>The workflow type.</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>
        starting_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of workflows to return in one page of results.</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.list_workflow_versions_request.ListWorkflowVersionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_omics.types.list_workflow_versions_response.ListWorkflowVersionsResponse"
    ]:
        import capo_omics._operations.omics.list_workflow_versions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkflowVersions")
    )
    input_: capo_omics.types.list_workflow_versions_request.ListWorkflowVersionsRequest = {
        "workflow_id": workflow_id
    }
    if type is not None:
        input_["type"] = type
    if workflow_owner_id is not None:
        input_["workflow_owner_id"] = workflow_owner_id
    if starting_token is not None:
        input_["starting_token"] = starting_token
    if max_results is not None:
        input_["max_results"] = max_results

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