AWSTranscribeMedicalScribeJob

Objective-C

@interface AWSTranscribeMedicalScribeJob

Swift

class AWSTranscribeMedicalScribeJob

Provides detailed information about a Medical Scribe job.

To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the locations specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

  • Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it’s the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it’s the patient speaking).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSTranscribeMedicalScribeChannelDefinition *> *_Nullable channelDefinitions;

    Swift

    var channelDefinitions: [AWSTranscribeMedicalScribeChannelDefinition]? { get set }

  • The date and time the specified Medical Scribe job finished processing.

    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 Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

    Declaration

    Objective-C

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

    Swift

    var completionTime: Date? { get set }

  • The date and time the specified Medical Scribe 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 Medical Scribe 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 }

  • The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.

    IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

    For more information, see IAM ARNs.

    Declaration

    Objective-C

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

    Swift

    var dataAccessRoleArn: String? { get set }

  • If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

    Declaration

    Objective-C

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

    Swift

    var failureReason: String? { get set }

  • The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMedicalScribeLanguageCode languageCode;

    Swift

    var languageCode: AWSTranscribeMedicalScribeLanguageCode { 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 name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.

    Declaration

    Objective-C

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

    Swift

    var medicalScribeJobName: String? { get set }

  • Provides the status of the specified Medical Scribe job.

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

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeMedicalScribeJobStatus medicalScribeJobStatus;

    Swift

    var medicalScribeJobStatus: AWSTranscribeMedicalScribeJobStatus { get set }

  • The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeMedicalScribeOutput *_Nullable medicalScribeOutput;

    Swift

    var medicalScribeOutput: AWSTranscribeMedicalScribeOutput? { get set }

  • Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

    Declaration

    Objective-C

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

    Swift

    var settings: AWSTranscribeMedicalScribeSettings? { get set }

  • The date and time your Medical Scribe 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 Medical Scribe 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 }

  • Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

    To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

    Declaration

    Objective-C

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

    Swift

    var tags: [AWSTranscribeTag]? { get set }