Values.MedicalScribeJobSourceProvides detailed information about a Medical Scribe job. To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the locations specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
type nonrec t = {medicalScribeJobName : TranscriptionJobName.t option;The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
*)medicalScribeJobStatus : MedicalScribeJobStatus.t option;Provides the status of the specified Medical Scribe job. If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
*)languageCode : MedicalScribeLanguageCode.t option;The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
*)media : Media.t option;medicalScribeOutput : MedicalScribeOutput.t option;The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
*)startTime : DateTime.t option;The date and time your Medical Scribe job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
*)creationTime : DateTime.t option;The date and time the specified Medical Scribe job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
*)completionTime : DateTime.t option;The date and time the specified Medical Scribe job finished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
*)failureReason : FailureReason.t option;If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
*)settings : MedicalScribeSettings.t option;Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
*)dataAccessRoleArn : DataAccessRoleArn.t option;The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
*)channelDefinitions : MedicalScribeChannelDefinitions.t option;Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
*)medicalScribeContextProvided : Boolean.t option;Indicates whether the MedicalScribeContext object was provided when the Medical Scribe job was started.
*)}val make :
?medicalScribeJobName:??? ->
?medicalScribeJobStatus:??? ->
?languageCode:??? ->
?media:??? ->
?medicalScribeOutput:??? ->
?startTime:??? ->
?creationTime:??? ->
?completionTime:??? ->
?failureReason:??? ->
?settings:??? ->
?dataAccessRoleArn:??? ->
?channelDefinitions:??? ->
?medicalScribeContextProvided:??? ->
?tags:??? ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of Boolean.t
| `Enum of string
| `List of
[> `Structure of
(string
* [> `Enum of string
| `Integer of MedicalScribeChannelId.t
| `String of TagKey.t ])
list ]
list
| `String of TranscriptionJobName.t
| `Structure of
(string
* [> `Boolean of Boolean.t
| `Enum of string
| `Integer of MaxSpeakers.t
| `String of Uri_.t
| `Structure of (string * [> `Enum of string ]) list ])
list
| `Timestamp of DateTime.t ])
list ]