TranscriptionJob

Gets and sets the property CompletionTime.

The date and time the specified transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

Gets and sets the property ContentRedaction.

Indicates whether redaction was enabled in your transcript.

Gets and sets the property CreationTime.

The date and time the specified transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Gets and sets the property FailureReason.

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

Gets and sets the property IdentifiedLanguageScore.

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

Gets and sets the property IdentifyLanguage.

Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

Gets and sets the property IdentifyMultipleLanguages.

Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

Gets and sets the property JobExecutionSettings.

Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

Gets and sets the property LanguageCode.

The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

Gets and sets the property LanguageCodes.

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Gets and sets the property LanguageIdSettings.

Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Gets and sets the property LanguageOptions.

Provides the language codes you specified in your request.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Gets and sets the property Media.

Provides the Amazon S3 location of the media file you used in your request.

Gets and sets the property MediaFormat.

The format of the input media file.

Gets and sets the property MediaSampleRateHertz.

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

Gets and sets the property ModelSettings.

Provides information on the custom language model you included in your request.

Gets and sets the property Settings.

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Gets and sets the property StartTime.

The date and time the specified transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Gets and sets the property Subtitles.

Indicates whether subtitles were generated with your transcription.

Gets and sets the property Tags.

The tags, each in the form of a key:value pair, assigned to the specified transcription job.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Gets and sets the property ToxicityDetection.

Provides information about the toxicity detection settings applied to your transcription.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Gets and sets the property Transcript.

Provides you with the Amazon S3 URI you can use to access your transcript.

Gets and sets the property TranscriptionJobName.

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

Gets and sets the property TranscriptionJobStatus.

Provides the status of the specified transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.