« blib/lib/Paws/Transcribe/Settings.pm
↑ Summary
blib/lib/Paws/Transcribe/StartMedicalTranscriptionJobResponse.pm »
| 1 | |||
| 2 | package Paws::Transcribe::StartMedicalTranscriptionJob; | ||
| 3 | use Moose; | ||
| 4 | has ContentIdentificationType => (is => 'ro', isa => 'Str'); | ||
| 5 | has LanguageCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Media => (is => 'ro', isa => 'Paws::Transcribe::Media', required => 1); | ||
| 7 | has MediaFormat => (is => 'ro', isa => 'Str'); | ||
| 8 | has MediaSampleRateHertz => (is => 'ro', isa => 'Int'); | ||
| 9 | has MedicalTranscriptionJobName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has OutputBucketName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has OutputEncryptionKMSKeyId => (is => 'ro', isa => 'Str'); | ||
| 12 | has OutputKey => (is => 'ro', isa => 'Str'); | ||
| 13 | has Settings => (is => 'ro', isa => 'Paws::Transcribe::MedicalTranscriptionSetting'); | ||
| 14 | has Specialty => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | |||
| 17 | use MooseX::ClassAttribute; | ||
| 18 | |||
| 19 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartMedicalTranscriptionJob'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transcribe::StartMedicalTranscriptionJobResponse'); | ||
| 21 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::Transcribe::StartMedicalTranscriptionJob - Arguments for method StartMedicalTranscriptionJob on L<Paws::Transcribe> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method StartMedicalTranscriptionJob on the | ||
| 33 | L<Amazon Transcribe Service|Paws::Transcribe> service. Use the attributes of this class | ||
| 34 | as arguments to method StartMedicalTranscriptionJob. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartMedicalTranscriptionJob. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $transcribe = Paws->service('Transcribe'); | ||
| 41 | my $StartMedicalTranscriptionJobResponse = | ||
| 42 | $transcribe->StartMedicalTranscriptionJob( | ||
| 43 | LanguageCode => 'af-ZA', | ||
| 44 | Media => { | ||
| 45 | MediaFileUri => 'MyUri', # min: 1, max: 2000; OPTIONAL | ||
| 46 | }, | ||
| 47 | MedicalTranscriptionJobName => 'MyTranscriptionJobName', | ||
| 48 | OutputBucketName => 'MyOutputBucketName', | ||
| 49 | Specialty => 'PRIMARYCARE', | ||
| 50 | Type => 'CONVERSATION', | ||
| 51 | ContentIdentificationType => 'PHI', # OPTIONAL | ||
| 52 | MediaFormat => 'mp3', # OPTIONAL | ||
| 53 | MediaSampleRateHertz => 1, # OPTIONAL | ||
| 54 | OutputEncryptionKMSKeyId => 'MyKMSKeyId', # OPTIONAL | ||
| 55 | OutputKey => 'MyOutputKey', # OPTIONAL | ||
| 56 | Settings => { | ||
| 57 | ChannelIdentification => 1, # OPTIONAL | ||
| 58 | MaxAlternatives => 1, # min: 2, max: 10; OPTIONAL | ||
| 59 | MaxSpeakerLabels => 1, # min: 2, max: 10; OPTIONAL | ||
| 60 | ShowAlternatives => 1, # OPTIONAL | ||
| 61 | ShowSpeakerLabels => 1, # OPTIONAL | ||
| 62 | VocabularyName => 'MyVocabularyName', # min: 1, max: 200; OPTIONAL | ||
| 63 | }, # OPTIONAL | ||
| 64 | ); | ||
| 65 | |||
| 66 | # Results: | ||
| 67 | my $MedicalTranscriptionJob = | ||
| 68 | $StartMedicalTranscriptionJobResponse->MedicalTranscriptionJob; | ||
| 69 | |||
| 70 | # Returns a L<Paws::Transcribe::StartMedicalTranscriptionJobResponse> object. | ||
| 71 | |||
| 72 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 73 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transcribe/StartMedicalTranscriptionJob> | ||
| 74 | |||
| 75 | =head1 ATTRIBUTES | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ContentIdentificationType => Str | ||
| 79 | |||
| 80 | You can configure Amazon Transcribe Medical to label content in the | ||
| 81 | transcription output. If you specify C<PHI>, Amazon Transcribe Medical | ||
| 82 | labels the personal health information (PHI) that it identifies in the | ||
| 83 | transcription output. | ||
| 84 | |||
| 85 | Valid values are: C<"PHI"> | ||
| 86 | |||
| 87 | =head2 B<REQUIRED> LanguageCode => Str | ||
| 88 | |||
| 89 | The language code for the language spoken in the input media file. US | ||
| 90 | English (en-US) is the valid value for medical transcription jobs. Any | ||
| 91 | other value you enter for language code results in a | ||
| 92 | C<BadRequestException> error. | ||
| 93 | |||
| 94 | Valid values are: C<"af-ZA">, C<"ar-AE">, C<"ar-SA">, C<"cy-GB">, C<"da-DK">, C<"de-CH">, C<"de-DE">, C<"en-AB">, C<"en-AU">, C<"en-GB">, C<"en-IE">, C<"en-IN">, C<"en-US">, C<"en-WL">, C<"es-ES">, C<"es-US">, C<"fa-IR">, C<"fr-CA">, C<"fr-FR">, C<"ga-IE">, C<"gd-GB">, C<"he-IL">, C<"hi-IN">, C<"id-ID">, C<"it-IT">, C<"ja-JP">, C<"ko-KR">, C<"ms-MY">, C<"nl-NL">, C<"pt-BR">, C<"pt-PT">, C<"ru-RU">, C<"ta-IN">, C<"te-IN">, C<"tr-TR">, C<"zh-CN"> | ||
| 95 | |||
| 96 | =head2 B<REQUIRED> Media => L<Paws::Transcribe::Media> | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 MediaFormat => Str | ||
| 103 | |||
| 104 | The audio format of the input media file. | ||
| 105 | |||
| 106 | Valid values are: C<"mp3">, C<"mp4">, C<"wav">, C<"flac">, C<"ogg">, C<"amr">, C<"webm"> | ||
| 107 | |||
| 108 | =head2 MediaSampleRateHertz => Int | ||
| 109 | |||
| 110 | The sample rate, in Hertz, of the audio track in the input media file. | ||
| 111 | |||
| 112 | If you do not specify the media sample rate, Amazon Transcribe Medical | ||
| 113 | determines the sample rate. If you specify the sample rate, it must | ||
| 114 | match the rate detected by Amazon Transcribe Medical. In most cases, | ||
| 115 | you should leave the C<MediaSampleRateHertz> field blank and let Amazon | ||
| 116 | Transcribe Medical determine the sample rate. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> MedicalTranscriptionJobName => Str | ||
| 121 | |||
| 122 | The name of the medical transcription job. You can't use the strings | ||
| 123 | "C<.>" or "C<..>" by themselves as the job name. The name must also be | ||
| 124 | unique within an AWS account. If you try to create a medical | ||
| 125 | transcription job with the same name as a previous medical | ||
| 126 | transcription job, you get a C<ConflictException> error. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 B<REQUIRED> OutputBucketName => Str | ||
| 131 | |||
| 132 | The Amazon S3 location where the transcription is stored. | ||
| 133 | |||
| 134 | You must set C<OutputBucketName> for Amazon Transcribe Medical to store | ||
| 135 | the transcription results. Your transcript appears in the S3 location | ||
| 136 | you specify. When you call the GetMedicalTranscriptionJob, the | ||
| 137 | operation returns this location in the C<TranscriptFileUri> field. The | ||
| 138 | S3 bucket must have permissions that allow Amazon Transcribe Medical to | ||
| 139 | put files in the bucket. For more information, see Permissions Required | ||
| 140 | for IAM User Roles | ||
| 141 | (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user). | ||
| 142 | |||
| 143 | You can specify an AWS Key Management Service (KMS) key to encrypt the | ||
| 144 | output of your transcription using the C<OutputEncryptionKMSKeyId> | ||
| 145 | parameter. If you don't specify a KMS key, Amazon Transcribe Medical | ||
| 146 | uses the default Amazon S3 key for server-side encryption of | ||
| 147 | transcripts that are placed in your S3 bucket. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 OutputEncryptionKMSKeyId => Str | ||
| 152 | |||
| 153 | The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) | ||
| 154 | key used to encrypt the output of the transcription job. The user | ||
| 155 | calling the StartMedicalTranscriptionJob operation must have permission | ||
| 156 | to use the specified KMS key. | ||
| 157 | |||
| 158 | You use either of the following to identify a KMS key in the current | ||
| 159 | account: | ||
| 160 | |||
| 161 | =over | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | KMS Key Alias: "alias/ExampleAlias" | ||
| 170 | |||
| 171 | =back | ||
| 172 | |||
| 173 | You can use either of the following to identify a KMS key in the | ||
| 174 | current account or another account: | ||
| 175 | |||
| 176 | =over | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | Amazon Resource Name (ARN) of a KMS key in the current account or | ||
| 181 | another account: "arn:aws:kms:region:account | ||
| 182 | ID:key/1234abcd-12ab-34cd-56ef-1234567890ab" | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | ARN of a KMS Key Alias: "arn:aws:kms:region:account | ||
| 187 | ID:alias/ExampleAlias" | ||
| 188 | |||
| 189 | =back | ||
| 190 | |||
| 191 | If you don't specify an encryption key, the output of the medical | ||
| 192 | transcription job is encrypted with the default Amazon S3 key (SSE-S3). | ||
| 193 | |||
| 194 | If you specify a KMS key to encrypt your output, you must also specify | ||
| 195 | an output location in the C<OutputBucketName> parameter. | ||
| 196 | |||
| 197 | |||
| 198 | |||
| 199 | =head2 OutputKey => Str | ||
| 200 | |||
| 201 | You can specify a location in an Amazon S3 bucket to store the output | ||
| 202 | of your medical transcription job. | ||
| 203 | |||
| 204 | If you don't specify an output key, Amazon Transcribe Medical stores | ||
| 205 | the output of your transcription job in the Amazon S3 bucket you | ||
| 206 | specified. By default, the object key is | ||
| 207 | "your-transcription-job-name.json". | ||
| 208 | |||
| 209 | You can use output keys to specify the Amazon S3 prefix and file name | ||
| 210 | of the transcription output. For example, specifying the Amazon S3 | ||
| 211 | prefix, "folder1/folder2/", as an output key would lead to the output | ||
| 212 | being stored as "folder1/folder2/your-transcription-job-name.json". If | ||
| 213 | you specify "my-other-job-name.json" as the output key, the object key | ||
| 214 | is changed to "my-other-job-name.json". You can use an output key to | ||
| 215 | change both the prefix and the file name, for example | ||
| 216 | "folder/my-other-job-name.json". | ||
| 217 | |||
| 218 | If you specify an output key, you must also specify an S3 bucket in the | ||
| 219 | C<OutputBucketName> parameter. | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | =head2 Settings => L<Paws::Transcribe::MedicalTranscriptionSetting> | ||
| 224 | |||
| 225 | Optional settings for the medical transcription job. | ||
| 226 | |||
| 227 | |||
| 228 | |||
| 229 | =head2 B<REQUIRED> Specialty => Str | ||
| 230 | |||
| 231 | The medical specialty of any clinician speaking in the input media. | ||
| 232 | |||
| 233 | Valid values are: C<"PRIMARYCARE"> | ||
| 234 | |||
| 235 | =head2 B<REQUIRED> Type => Str | ||
| 236 | |||
| 237 | The type of speech in the input audio. C<CONVERSATION> refers to | ||
| 238 | conversations between two or more speakers, e.g., a conversations | ||
| 239 | between doctors and patients. C<DICTATION> refers to single-speaker | ||
| 240 | dictated speech, e.g., for clinical notes. | ||
| 241 | |||
| 242 | Valid values are: C<"CONVERSATION">, C<"DICTATION"> | ||
| 243 | |||
| 244 | |||
| 245 | =head1 SEE ALSO | ||
| 246 | |||
| 247 | This class forms part of L<Paws>, documenting arguments for method StartMedicalTranscriptionJob in L<Paws::Transcribe> | ||
| 248 | |||
| 249 | =head1 BUGS and CONTRIBUTIONS | ||
| 250 | |||
| 251 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 252 | |||
| 253 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 254 | |||
| 255 | =cut | ||
| 256 |