AWSTranscribeMedicalTranscriptionJob

Objective-C

@interface AWSTranscribeMedicalTranscriptionJob

Swift

class AWSTranscribeMedicalTranscriptionJob

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.

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable completionTime;

    Swift

    var completionTime: Date? { get set }

  • Indicates whether content identification was enabled for your transcription request.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMedicalContentIdentificationType contentIdentificationType;

    Swift

    var contentIdentificationType: AWSTranscribeMedicalContentIdentificationType { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationTime;

    Swift

    var creationTime: Date? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable failureReason;

    Swift

    var failureReason: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeLanguageCode languageCode;

    Swift

    var languageCode: AWSTranscribeLanguageCode { get set }

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

    For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeMedia *_Nullable media;

    Swift

    var media: AWSTranscribeMedia? { get set }

  • The format of the input media file.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMediaFormat mediaFormat;

    Swift

    var mediaFormat: AWSTranscribeMediaFormat { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable mediaSampleRateHertz;

    Swift

    var mediaSampleRateHertz: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable medicalTranscriptionJobName;

    Swift

    var medicalTranscriptionJobName: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeMedicalTranscriptionSetting *_Nullable settings;

    Swift

    var settings: AWSTranscribeMedicalTranscriptionSetting? { get set }

  • Describes the medical specialty represented in your media.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeSpecialty specialty;

    Swift

    var specialty: AWSTranscribeSpecialty { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startTime;

    Swift

    var startTime: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSTranscribeTag *> *_Nullable tags;

    Swift

    var tags: [AWSTranscribeTag]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeMedicalTranscript *_Nullable transcript;

    Swift

    var transcript: AWSTranscribeMedicalTranscript? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeTranscriptionJobStatus transcriptionJobStatus;

    Swift

    var transcriptionJobStatus: AWSTranscribeTranscriptionJobStatus { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeTypes types;

    Swift

    var types: AWSTranscribeTypes { get set }