transcribe/aws.sdk.kotlin.services.transcribe.model/MedicalScribeJob/Builder

Builder

Properties

var channelDefinitions: List<MedicalScribeChannelDefinition>?

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).

completionTime

var completionTime: Instant?

The date and time the specified Medical Scribe job finished processing.

creationTime

var creationTime: Instant?

The date and time the specified Medical Scribe job request was made.

dataAccessRoleArn

var dataAccessRoleArn: String?

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.

failureReason

var failureReason: String?

If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

languageCode

var languageCode: MedicalScribeLanguageCode?

The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

media

var media: Media?

Describes the Amazon S3 location of the media file you want to use in your request.

medicalScribeJobName

var medicalScribeJobName: String?

The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.

medicalScribeJobStatus

var medicalScribeJobStatus: MedicalScribeJobStatus?

Provides the status of the specified Medical Scribe job.

medicalScribeOutput

var medicalScribeOutput: MedicalScribeOutput?

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.

settings

var settings: MedicalScribeSettings?

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.

startTime

var startTime: Instant?

The date and time your Medical Scribe job began processing.

Functions

media

fun media(block: Media.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.transcribe.model.Media inside the given block

medicalScribeOutput

fun medicalScribeOutput(block: MedicalScribeOutput.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.transcribe.model.MedicalScribeOutput inside the given block

settings

fun settings(block: MedicalScribeSettings.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.transcribe.model.MedicalScribeSettings inside the given block