delete_hcls_store

HclsApi.delete_hcls_store(hcls_name, id, role_id, action=None, reference_id=None, readset_id=None, imageset_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Delete an HCLS store or workflow

Deletes an HCLS store or workflow, or a nested resource within a store. With no query action, deletes the entire store/workflow (owner required). omics-storage supports action=delete_reference (reference_id) or delete_readset (readset_id). health-imaging supports action=delete_imageset (imageset_id). If dependent resources block deletion, returns HTTP 400 with DependentResources.

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 delete. (required)

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

  • action (str) – Nested delete action. When omitted, the entire store/workflow is deleted.

  • reference_id (str) – Omics reference id. Required when action is delete_reference.

  • readset_id (str) – Omics read set id. Required when action is delete_readset.

  • imageset_id (str) – HealthImaging ImageSetId. Required when action is delete_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: DELETE /hcls/{hcls_name}/{id}

Success (HTTP 200)

HCLS store, workflow, or nested resource deleted successfully. Response typically includes Message and StoreId or HclsWorkflowId.

Errors

HTTP 400

Missing required request parameters, or deletion blocked by DependentResources.

HTTP 500

Something went wrong at backend