HclsStores

pydantic model openapi_client.models.hcls_stores.HclsStores

HCLS store or workflow resource. Used as create/update request body and as detail response. Required fields depend on hcls_name and operation. Create omics-storage: StoreName, StoreType (omics-reference|omics-sequence). Create healthlake/health-imaging: StoreName, StoreType, IsAutoTerminateEnabled, Keywords. Create omics-workflows: WorkflowName, WorkflowEngine (WDL|NEXTFLOW), StorageCapacity, WorkflowS3Path.

Fields:

• access_type (str | None)

• auto_termination_time (str | None)

• cost_tags (Dict[str, Any] | None)

• created_by (str | None)

• creation_time (str | None)

• dataset_access (openapi_client.models.hcls_stores_dataset_access.HclsStoresDatasetAccess | None)

• dependent_resources (List[openapi_client.models.hcls_stores_dependent_resources_inner.HclsStoresDependentResourcesInner] | None)

• description (str | None)

• display_name (str | None)

• flex_view_connection_status (str | None)

• hcls_workflow_id (str | None)

• image_sets (List[Dict[str, Any]] | None)

• is_auto_terminate_enabled (bool | None)

• keywords (List[str] | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• main (str | None)

• message (str | None)

• omics_workflow_id (str | None)

• status (str | None)

• storage_capacity (int | None)

• store_arn (str | None)

• store_config (openapi_client.models.hcls_stores_store_config.HclsStoresStoreConfig | None)

• store_id (str | None)

• store_name (str | None)

• store_type (str | None)

• workflow_engine (str | None)

• workflow_name (str | None)

• workflow_params (Dict[str, Any] | None)

• workflow_role_arn (str | None)

• workflow_s3_path (str | None)

field store_name: Optional[StrictStr] = None (alias 'StoreName')

Unique store name. Omics/HealthLake pattern typically alphanumeric with underscore/hyphen; health-imaging limited to 1-30 chars matching ^[A-Za-z0-9_-]{1,30}$.

field store_id: Optional[StrictStr] = None (alias 'StoreId')

System-generated store identifier (response).

field omics_workflow_id: Optional[StrictStr] = None (alias 'OmicsWorkflowId')

Underlying AWS Omics workflow id (response).

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

Amorphic workflow identifier (response / omics-workflows).

field workflow_name: Optional[StrictStr] = None (alias 'WorkflowName')

Workflow name for omics-workflows create. Pattern ^[w-]{1,128}$.

field display_name: Optional[StrictStr] = None (alias 'DisplayName')

Human-friendly display name. Defaults to StoreName/WorkflowName when omitted.

field description: Optional[StrictStr] = None (alias 'Description')

Optional free-text description.

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

Keywords/tags for the store or workflow. Required for healthlake/health-imaging create.

field store_type: Optional[StrictStr] = None (alias 'StoreType')

Store type for store create operations.

field store_arn: Optional[StrictStr] = None (alias 'StoreArn')

AWS ARN of the underlying store (response).

field access_type: Optional[StrictStr] = None (alias 'AccessType')

Caller access level on the resource (response).

field store_config: Optional[HclsStoresStoreConfig] = None (alias 'StoreConfig')

field is_auto_terminate_enabled: Optional[StrictBool] = None (alias 'IsAutoTerminateEnabled')

Whether auto-termination is enabled (required for healthlake/health-imaging create).

field auto_termination_time: Optional[StrictStr] = None (alias 'AutoTerminationTime')

Auto-termination timestamp/config when auto-terminate is enabled.

field image_sets: Optional[List[Dict[str, Any]]] = None (alias 'imageSets')

Nested imageset summaries when returned with store details.

field main: Optional[StrictStr] = None (alias 'Main')

Main workflow entry file (omics-workflows).

field workflow_engine: Optional[StrictStr] = None (alias 'WorkflowEngine')

Workflow engine for omics-workflows create.

field storage_capacity: Optional[Annotated[int, Field(le=20000, strict=True, ge=1)]] = None (alias 'StorageCapacity')

Workflow storage capacity in GB (1-20000) for omics-workflows.

field workflow_role_arn: Optional[StrictStr] = None (alias 'WorkflowRoleArn')

IAM role ARN used to run the workflow (response).

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

S3 path to the workflow definition zip (required for create).

field workflow_params: Optional[Dict[str, Any]] = None (alias 'WorkflowParams')

Default/declared workflow parameters.

field dataset_access: Optional[HclsStoresDatasetAccess] = None (alias 'DatasetAccess')

field flex_view_connection_status: Optional[StrictStr] = None (alias 'FlexViewConnectionStatus')

FlexView integration status for health-imaging stores.

field status: Optional[StrictStr] = None (alias 'Status')

Resource lifecycle status (e.g. creating, active, failed).

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

Status or operation message.

field cost_tags: Optional[Dict[str, Any]] = None (alias 'CostTags')

Optional cost allocation tags when cost management is enabled.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

field dependent_resources: Optional[List[HclsStoresDependentResourcesInner]] = None (alias 'DependentResources')

Resources that depend on this store (returned on blocked deletes).

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 HclsStores 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 HclsStores from a dict

Return type:

Optional[Self]