list_hcls_stores

HclsApi.list_hcls_stores(hcls_name, role_id, limit=None, offset=None, sortorder=None, sortby=None, projection_expression=None, filter_expression=None, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List user-accessible HCLS stores and workflows

Returns the list of HCLS stores or workflows that the caller can access. Behavior depends on hcls_name: healthlake / omics-storage / health-imaging return stores; omics-workflows returns workflows. For omics-workflows, action=get_presigned_url returns a workflow definition upload presigned URL instead of the list.

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)

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

  • limit (str) – Maximum number of items to return. Default is 100. Maximum allowed is 1000.

  • offset (str) – 1-based page offset for pagination. Default is 1 (internally converted to 0-based).

  • sortorder (str) – Sort direction for the result set. Default is desc.

  • sortby (str) – Attribute to sort by. Default is LastModifiedTime for stores/workflows lists.

  • projection_expression (str) – Comma-separated list of attributes to include in each returned item. When omitted, all attributes are returned.

  • filter_expression (str) – Filter expression to narrow results (attribute-based filter supported by the backend).

  • action (str) – Optional action for omics-workflows. Use get_presigned_url to obtain a presigned S3 URL for uploading a workflow definition zip.

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

HclsStoresGetResponseBody

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /hcls/{hcls_name}

Success (HTTP 200)

Successful API response

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend