transcribe/aws.sdk.kotlin.services.transcribe.model/StartMedicalScribeJobRequest/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).

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.

kmsEncryptionContext

var kmsEncryptionContext: Map<String, String>?

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.

media

var media: Media?

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

medicalScribeJobName

var medicalScribeJobName: String?

A unique name, chosen by you, for your Medical Scribe job.

outputBucketName

var outputBucketName: String?

The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3:// prefix of the specified bucket.

outputEncryptionKmsKeyId

var outputEncryptionKmsKeyId: String?

The KMS key you want to use to encrypt your Medical Scribe output.

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.

Functions

media

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

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

settings

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

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