Skip to content

get_medical_scribe_stream

Operation

get_medical_scribe_stream

get_medical_scribe_stream(request: GetMedicalScribeStreamInput | GetMedicalScribeStreamInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMedicalScribeStreamInputDict]) -> GetMedicalScribeStreamOutput

Provides details about the specified Amazon Web Services HealthScribe streaming session. To view the status of the streaming session, check the StreamStatus field in the response. To get the details of post-stream analytics, including its status, check the PostStreamAnalyticsResult field in the response.

Parameters:

Name Type Description Default
request GetMedicalScribeStreamInput | GetMedicalScribeStreamInputDict | 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[GetMedicalScribeStreamInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMedicalScribeStreamOutput

An instance of GetMedicalScribeStreamOutput.

get_medical_scribe_stream async

get_medical_scribe_stream(request: GetMedicalScribeStreamInput | GetMedicalScribeStreamInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMedicalScribeStreamInputDict]) -> GetMedicalScribeStreamOutput

Provides details about the specified Amazon Web Services HealthScribe streaming session. To view the status of the streaming session, check the StreamStatus field in the response. To get the details of post-stream analytics, including its status, check the PostStreamAnalyticsResult field in the response.

Parameters:

Name Type Description Default
request GetMedicalScribeStreamInput | GetMedicalScribeStreamInputDict | 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[GetMedicalScribeStreamInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMedicalScribeStreamOutput

An instance of GetMedicalScribeStreamOutput.

Input

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

GetMedicalScribeStreamInputDict

Bases: TypedDict

Dictionary form of GetMedicalScribeStreamInput.

Attributes

session_id instance-attribute
session_id: Required[str]

The identifier of the HealthScribe streaming session you want information about.

GetMedicalScribeStreamInput dataclass

Bases: _SerdeShape

Dataclass for GetMedicalScribeStreamInput structure.

Attributes

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

The identifier of the HealthScribe streaming session you want information about.

Output

GetMedicalScribeStreamOutput dataclass

Bases: _SerdeShape

Dataclass for GetMedicalScribeStreamOutput structure.

Attributes

medical_scribe_stream_details class-attribute instance-attribute
medical_scribe_stream_details: MedicalScribeStreamDetails | None = ...

Provides details about a HealthScribe streaming session.

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.