get_hcls_store_run_details

HclsApi.get_hcls_store_run_details(hcls_name, id, runid, role_id, action=None, limit=None, marker=None, task_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get details of an HCLS workflow run

Returns details of a single Omics workflow run, or a related action result. With no action, returns the workflow run item. action=list_run_tasks lists tasks for the run (supports limit and marker). action=get_logs returns CloudWatch/S3 log content; with task_id returns a presigned URL for that task’s logs, otherwise may trigger async log generation. action=download_logs returns a PresignedURL for the aggregated run log file (requires S3LogPath on the run).

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 that owns the run. (required)

  • runid (str) – WorkflowRunId to retrieve. (required)

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

  • action (str) – Optional nested action for tasks or logs.

  • limit (str) – Page size for list_run_tasks. Default is 20.

  • marker (str) – Pagination marker for list_run_tasks.

  • task_id (str) – Workflow run task id. When provided with action=get_logs, returns a presigned URL for that task’s logs.

  • _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:

HclGetWorkflowRunResponseBody

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /hcls/{hcls_name}/{id}/runs/{runid}

Success (HTTP 200)

Successfully returns HCLS workflow run details or action result

Errors

HTTP 400

Invalid input parameters

HTTP 500

Something went wrong at backend