Skip to content

get_patient_insights_job

Operation

get_patient_insights_job

get_patient_insights_job(request: GetPatientInsightsJobInput | GetPatientInsightsJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPatientInsightsJobInputDict]) -> GetPatientInsightsJobOutput

Get details of a started patient insights job.

Parameters:

Name Type Description Default
request GetPatientInsightsJobInput | GetPatientInsightsJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetPatientInsightsJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPatientInsightsJobOutput

An instance of GetPatientInsightsJobOutput.

get_patient_insights_job async

get_patient_insights_job(request: GetPatientInsightsJobInput | GetPatientInsightsJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPatientInsightsJobInputDict]) -> GetPatientInsightsJobOutput

Get details of a started patient insights job.

Parameters:

Name Type Description Default
request GetPatientInsightsJobInput | GetPatientInsightsJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetPatientInsightsJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPatientInsightsJobOutput

An instance of GetPatientInsightsJobOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetPatientInsightsJobInputDict

Bases: TypedDict

Dictionary form of GetPatientInsightsJobInput.

Attributes

domain_id instance-attribute
domain_id: Required[str]
job_id instance-attribute
job_id: Required[str]

GetPatientInsightsJobInput dataclass

Bases: _SerdeShape

Dataclass for GetPatientInsightsJobInput structure.

Attributes

domain_id class-attribute instance-attribute
domain_id: str | None = ...
job_id class-attribute instance-attribute
job_id: str | None = ...

Output

GetPatientInsightsJobOutput dataclass

Bases: _SerdeShape

Dataclass for GetPatientInsightsJobOutput structure.

Attributes

creation_time class-attribute instance-attribute
creation_time: datetime | None = ...

Date and time the patient insights job was submitted.

encounter_context instance-attribute
input_data_config instance-attribute
input_data_config: InputDataConfig
insights_context instance-attribute
insights_context: InsightsContext
insights_output class-attribute instance-attribute
insights_output: InsightsOutput | None = ...
job_arn instance-attribute
job_arn: str
job_id instance-attribute
job_id: str
job_status instance-attribute
job_status: str
output_data_config instance-attribute
output_data_config: OutputDataConfig
patient_context instance-attribute
response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status_details class-attribute instance-attribute
status_details: str | None = ...

Contains information about the status of a job.

updated_time class-attribute instance-attribute
updated_time: datetime | None = ...

Date and time the patient insights job was last updated.

user_context instance-attribute
user_context: UserContext