get_hcls_store_job_details

HclsApi.get_hcls_store_job_details(hcls_name, id, jobid, role_id, action=None, s3_file=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get details of an HCLS job

Returns details of a single HCLS import/activation job. For healthlake and health-imaging, action=download_file with s3_file returns a presigned URL for the job manifest, failure, or success file.

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) – StoreId that owns the job. (required)

  • jobid (str) – JobId of the import or activation job. (required)

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

  • action (str) – Optional action. Use download_file to generate a presigned URL for a job artifact.

  • s3_file (str) – Job artifact path/name to download when action is download_file. HealthLake: Manifest.json path or failure filename. HealthImaging: manifest.json, failure.ndjson, or success.ndjson. HealthImaging downloads are only available when job status is completed or failed.

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

HclsJobsByIdGetResponseBody

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /hcls/{hcls_name}/{id}/jobs/{jobid}

Success (HTTP 200)

Successfully returns HCLS job details or download PresignedURL

Errors

HTTP 400

Invalid input parameters

HTTP 500

Something went wrong at backend