HclsJobsByIdGetResponseBody

pydantic model openapi_client.models.hcls_jobs_by_id_get_response_body.HclsJobsByIdGetResponseBody

HCLS job details. For download_file actions, Message and PresignedURL may be returned. HealthLake/HealthImaging jobs may include ManifestFile, FailureFile, SuccessFile, FailedFiles.

Fields:

• created_by (str | None)

• creation_time (str | None)

• description (str | None)

• end_time (str | None)

• failed_files (List[str] | None)

• failure_file (str | None)

• import_job_config (openapi_client.models.hcls_jobs_by_id_get_response_body_import_job_config.HclsJobsByIdGetResponseBodyImportJobConfig | None)

• job_id (str | None)

• job_name (str | None)

• job_status (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• manifest_file (str | None)

• message (str | None)

• presigned_url (str | None)

• sources (List[openapi_client.models.hcls_jobs_by_id_get_response_body_sources_inner.HclsJobsByIdGetResponseBodySourcesInner] | None)

• start_time (str | None)

• store_id (str | None)

• success_file (str | None)

• trigger_source (str | None)

field job_id: Optional[StrictStr] = None (alias 'JobId')

Unique job identifier.

field job_name: Optional[StrictStr] = None (alias 'JobName')

User-provided job name.

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

field job_status: Optional[StrictStr] = None (alias 'JobStatus')

Job status (e.g. starting, running, completed, failed, completed_with_errors).

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

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

field start_time: Optional[StrictStr] = None (alias 'StartTime')

field end_time: Optional[StrictStr] = None (alias 'EndTime')

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

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

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

field trigger_source: Optional[StrictStr] = None (alias 'TriggerSource')

How the job was triggered (API, schedule, etc.).

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

Parent HCLS store id.

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

Presigned URL when action=download_file.

field failed_files: Optional[List[StrictStr]] = None (alias 'FailedFiles')

Failed file names for HealthLake completed_with_errors/failed jobs.

field import_job_config: Optional[HclsJobsByIdGetResponseBodyImportJobConfig] = None (alias 'ImportJobConfig')

field sources: Optional[List[HclsJobsByIdGetResponseBodySourcesInner]] = None (alias 'Sources')

field manifest_file: Optional[StrictStr] = None (alias 'ManifestFile')

field failure_file: Optional[StrictStr] = None (alias 'FailureFile')

field success_file: Optional[StrictStr] = None (alias 'SuccessFile')

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

Return type:

Optional[Self]