update_hcls_store

HclsApi.update_hcls_store(hcls_name, id, role_id, hcls_stores, content_type=None, action=None, read_set_id=None, imageset_id=None, latest_versionid=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update an HCLS store or workflow

Updates an HCLS store or workflow, or performs a related update action. omics-storage with action=activate_read_set activates an archived read set (read_set_id required). omics-workflows updates Description and/or DatasetAccess (Owner max 1 dataset). healthlake / health-imaging update store metadata (IsAutoTerminateEnabled, AutoTerminationTime, Description, Keywords, DisplayName), or with action=update_imageset update DICOM imageset metadata (imageset_id and latest_versionid required).

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 or HclsWorkflowId to update. (required)

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

  • hcls_stores (HclsStores) – (required)

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

  • action (str) – Update action. activate_read_set for omics-storage archived read sets; update_imageset for health-imaging DICOM metadata updates.

  • read_set_id (str) – Omics read set id to activate. Required when action is activate_read_set. Read set must be in ARCHIVED status.

  • imageset_id (str) – HealthImaging ImageSetId. Required when action is update_imageset.

  • latest_versionid (str) – Latest imageset version id. Required when action is update_imageset.

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

Success (HTTP 200)

HCLS store/workflow updated successfully, or nested update/activation started

Errors

HTTP 400

Missing required request parameters

HTTP 500

Something went wrong at backend