start_hcls_store_run

HclsApi.start_hcls_store_run(hcls_name, id, role_id, hcls_workflow_run, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Start an HCLS workflow run

Starts a new Omics workflow run for the given workflow. Only supported when hcls_name is omics-workflows and the workflow Status is active. Requires WorkflowRunName and WorkflowRunLogLevel (off, fatal, error, or all). StorageCapacity is optional (1-20000; defaults from workflow/store config). WorkflowRunParams is an optional object of workflow input parameters. Caller needs editor access on the workflow.

Parameters:

  • hcls_name (str) – HCLS service type. Valid values: healthlake (FHIR datastore), omics-storage (Omics reference/sequence stores), omics-workflows (Omics workflows), health-imaging (HealthImaging datastore). (required)

  • id (str) – HclsWorkflowId to start a run for. (required)

  • role_id (str) – Amorphic role identifier used for authorization. (required)

  • hcls_workflow_run (HclsWorkflowRun) – (required)

  • content_type (str) – Request content type. Use application/json for JSON bodies.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

Status

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /hcls/{hcls_name}/{id}/runs

Success (HTTP 200)

Successfully started the HCLS workflow run. Response typically includes Message and WorkflowRunId.

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend