AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Provides detailed information about a medical transcription job.

To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

Inheritance Hierarchy

System.Object
  Amazon.TranscribeService.Model.MedicalTranscriptionJob

Namespace: Amazon.TranscribeService.Model
Assembly: AWSSDK.TranscribeService.dll
Version: 3.x.y.z

Syntax

C#
public class MedicalTranscriptionJob

The MedicalTranscriptionJob type exposes the following members

Constructors

NameDescription
Public Method MedicalTranscriptionJob()

Properties

NameTypeDescription
Public Property CompletionTime System.DateTime

Gets and sets the property CompletionTime.

The date and time the specified medical 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.

Public Property ContentIdentificationType Amazon.TranscribeService.MedicalContentIdentificationType

Gets and sets the property ContentIdentificationType.

Indicates whether content identification was enabled for your transcription request.

Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

The date and time the specified medical 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.

Public Property FailureReason System.String

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 16,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.

Public Property LanguageCode Amazon.TranscribeService.LanguageCode

Gets and sets the property LanguageCode.

The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

Public Property Media Amazon.TranscribeService.Model.Media

Gets and sets the property Media.

Public Property MediaFormat Amazon.TranscribeService.MediaFormat

Gets and sets the property MediaFormat.

The format of the input media file.

Public Property MediaSampleRateHertz System.Int32

Gets and sets the property MediaSampleRateHertz.

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

Public Property MedicalTranscriptionJobName System.String

Gets and sets the property MedicalTranscriptionJobName.

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

Public Property Settings Amazon.TranscribeService.Model.MedicalTranscriptionSetting

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.

Public Property Specialty Amazon.TranscribeService.Specialty

Gets and sets the property Specialty.

Describes the medical specialty represented in your media.

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

The date and time the specified medical 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.

Public Property Tags System.Collections.Generic.List<Amazon.TranscribeService.Model.Tag>

Gets and sets the property Tags.

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

Public Property Transcript Amazon.TranscribeService.Model.MedicalTranscript

Gets and sets the property Transcript.

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

Public Property TranscriptionJobStatus Amazon.TranscribeService.TranscriptionJobStatus

Gets and sets the property TranscriptionJobStatus.

Provides the status of the specified medical transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

Public Property Type Amazon.TranscribeService.Type

Gets and sets the property Type.

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5