HclsStoresGetResponseBody

pydantic model openapi_client.models.hcls_stores_get_response_body.HclsStoresGetResponseBody

Paginated list of HCLS stores or workflows. For omics-workflows list, items are under workflows; for other hcls_name values, items are under stores. When action=get_presigned_url on omics-workflows, Message/PresignedURL/ HclsWorkflowId/WorkflowS3Path may be returned instead of a list.

Fields:

• count (int | None)

• hcls_workflow_id (str | None)

• message (str | None)

• next_available (str | None)

• presigned_url (str | None)

• stores (List[openapi_client.models.hcls_stores.HclsStores] | None)

• total_count (int | None)

• workflow_s3_path (str | None)

• workflows (List[openapi_client.models.hcls_stores.HclsStores] | None)

field stores: Optional[List[HclsStores]] = None

List of HCLS stores (healthlake, omics-storage, health-imaging).

field workflows: Optional[List[HclsStores]] = None

List of Omics workflows when hcls_name is omics-workflows.

field next_available: Optional[StrictStr] = None

Indicates whether more pages are available.

field count: Optional[StrictInt] = None

Number of items in this page.

field total_count: Optional[StrictInt] = None

Total number of matching items.

field message: Optional[StrictStr] = None (alias 'Message')

Status message (e.g. for get_presigned_url).

field presigned_url: Optional[StrictStr] = None (alias 'PresignedURL')

Presigned S3 URL for workflow definition upload.

field hcls_workflow_id: Optional[StrictStr] = None (alias 'HclsWorkflowId')

Workflow id associated with a generated upload URL.

field workflow_s3_path: Optional[StrictStr] = None (alias 'WorkflowS3Path')

Target S3 path for the workflow definition zip.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of HclsStoresGetResponseBody from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of HclsStoresGetResponseBody from a dict

Return type:

Optional[Self]