AWSTranscribeMedicalTranscriptionJob

Objective-C

@interface AWSTranscribeMedicalTranscriptionJob

Swift

class AWSTranscribeMedicalTranscriptionJob

The data structure that contains the information for a medical transcription job.

  • A timestamp that shows when the job was completed.

    Declaration

    Objective-C

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

    Swift

    var completionTime: Date? { get set }
  • Shows the type of content that you’ve configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you’ve configured the job to identify personal health information (PHI) in the transcription output.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMedicalContentIdentificationType contentIdentificationType;

    Swift

    var contentIdentificationType: AWSTranscribeMedicalContentIdentificationType { get set }
  • A timestamp that shows when the job was created.

    Declaration

    Objective-C

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

    Swift

    var creationTime: Date? { get set }
  • 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 8,000 and 48,000 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

    Objective-C

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

    Swift

    var failureReason: String? { get set }
  • 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

    Objective-C

    @property (nonatomic) AWSTranscribeLanguageCode languageCode;

    Swift

    var languageCode: AWSTranscribeLanguageCode { get set }
  • Describes the input media file in a transcription request.

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

    Declaration

    Objective-C

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

    Swift

    var mediaSampleRateHertz: NSNumber? { get set }
  • The name for a given medical transcription job.

    Declaration

    Objective-C

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

    Swift

    var medicalTranscriptionJobName: String? { get set }
  • Object that contains object.

    Declaration

    Objective-C

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

    Swift

    var settings: AWSTranscribeMedicalTranscriptionSetting? { get set }
  • The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeSpecialty specialty;

    Swift

    var specialty: AWSTranscribeSpecialty { get set }
  • A timestamp that shows when the job started processing.

    Declaration

    Objective-C

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

    Swift

    var startTime: Date? { get set }
  • A key:value pair assigned to a given medical transcription job.

    Declaration

    Objective-C

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

    Swift

    var tags: [AWSTranscribeTag]? { get set }
  • An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

    Declaration

    Objective-C

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

    Swift

    var transcript: AWSTranscribeMedicalTranscript? { get set }
  • The completion status of a medical transcription job.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeTranscriptionJobStatus transcriptionJobStatus;

    Swift

    var transcriptionJobStatus: AWSTranscribeTranscriptionJobStatus { get set }
  • 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 What is Amazon Transcribe Medical?.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeTypes types;

    Swift

    var types: AWSTranscribeTypes { get set }