MedicalTranscriptionJob

public struct MedicalTranscriptionJob : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A timestamp that shows when the job was completed.

    Declaration

    Swift

    public let completionTime: TimeStamp?

  • A timestamp that shows when the job was created.

    Declaration

    Swift

    public let creationTime: TimeStamp?

  • If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed. The FailureReason field contains one of the following values: Unsupported media format- The media format specified in the MediaFormat field of the request isn’t valid. See the description of the MediaFormat field for a list of valid values. The media format provided does not match the detected media format- The media format of the audio file doesn’t match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match. Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn’t valid. The sample rate must be between 8000 and 48000 Hertz. The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn’t match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match. Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

    Declaration

    Swift

    public let failureReason: String?

  • The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.

    Declaration

    Swift

    public let languageCode: LanguageCode?

  • Undocumented

    Declaration

    Swift

    public let media: Media?

  • The format of the input media file.

    Declaration

    Swift

    public let mediaFormat: MediaFormat?

  • The sample rate, in Hertz, of the source audio containing medical information. If you don’t specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.

    Declaration

    Swift

    public let mediaSampleRateHertz: Int?

  • The name for a given medical transcription job.

    Declaration

    Swift

    public let medicalTranscriptionJobName: String?

  • Object that contains object.

    Declaration

    Swift

    public let settings: MedicalTranscriptionSetting?

  • The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE is the only available setting for this object. This specialty enables you to generate transcriptions for the following medical fields: Family Medicine

    Declaration

    Swift

    public let specialty: Specialty?

  • A timestamp that shows when the job started processing.

    Declaration

    Swift

    public let startTime: TimeStamp?

  • An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

    Declaration

    Swift

    public let transcript: MedicalTranscript?

  • The completion status of a medical transcription job.

    Declaration

    Swift

    public let transcriptionJobStatus: TranscriptionJobStatus?

  • The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see how-it-works-med

    Declaration

    Swift

    public let type: Type?

  • Undocumented

    Declaration

    Swift

    public init(completionTime: TimeStamp? = nil, creationTime: TimeStamp? = nil, failureReason: String? = nil, languageCode: LanguageCode? = nil, media: Media? = nil, mediaFormat: MediaFormat? = nil, mediaSampleRateHertz: Int? = nil, medicalTranscriptionJobName: String? = nil, settings: MedicalTranscriptionSetting? = nil, specialty: Specialty? = nil, startTime: TimeStamp? = nil, transcript: MedicalTranscript? = nil, transcriptionJobStatus: TranscriptionJobStatus? = nil, type: Type? = nil)