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

Builder

Properties

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.

identifyLanguage

var identifyLanguage: Boolean?

Enables automatic language identification in your transcription job request. Use this parameter if your media file contains only one language. If your media contains multiple languages, use IdentifyMultipleLanguages instead.

identifyMultipleLanguages

var identifyMultipleLanguages: Boolean?

Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language. If your media contains only one language, use IdentifyLanguage instead.

jobExecutionSettings

var jobExecutionSettings: JobExecutionSettings?

Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

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.

languageCode

var languageCode: LanguageCode?

The language code that represents the language spoken in the input media file.

languageIdSettings

var languageIdSettings: Map<LanguageCode, LanguageIdSettings>?

If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification (IdentifyMultipleLanguages) doesn't support custom language models.

languageOptions

var languageOptions: List<LanguageCode>?

You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.

media

var media: Media?

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

mediaFormat

var mediaFormat: MediaFormat?

Specify the format of your input media file.

mediaSampleRateHertz

var mediaSampleRateHertz: Int?

The sample rate, in hertz, of the audio track in your input media file.

modelSettings

var modelSettings: ModelSettings?

Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.

outputBucketName

var outputBucketName: String?

The name of the Amazon S3 bucket where you want your transcription 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 transcription output.

outputKey

var outputKey: String?

Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).

settings

var settings: Settings?

Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters.

subtitles

var subtitles: Subtitles?

Produces subtitle files for your input media. You can specify WebVTT (.vtt) and SubRip (.srt) formats.