aws-sdk-transcribeservice 1.38.0 → 1.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15,16 +15,24 @@ module Aws::TranscribeService
15
15
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
16
16
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
17
17
  ContentRedaction = Shapes::StructureShape.new(name: 'ContentRedaction')
18
+ CreateMedicalVocabularyRequest = Shapes::StructureShape.new(name: 'CreateMedicalVocabularyRequest')
19
+ CreateMedicalVocabularyResponse = Shapes::StructureShape.new(name: 'CreateMedicalVocabularyResponse')
18
20
  CreateVocabularyFilterRequest = Shapes::StructureShape.new(name: 'CreateVocabularyFilterRequest')
19
21
  CreateVocabularyFilterResponse = Shapes::StructureShape.new(name: 'CreateVocabularyFilterResponse')
20
22
  CreateVocabularyRequest = Shapes::StructureShape.new(name: 'CreateVocabularyRequest')
21
23
  CreateVocabularyResponse = Shapes::StructureShape.new(name: 'CreateVocabularyResponse')
22
24
  DataAccessRoleArn = Shapes::StringShape.new(name: 'DataAccessRoleArn')
23
25
  DateTime = Shapes::TimestampShape.new(name: 'DateTime')
26
+ DeleteMedicalTranscriptionJobRequest = Shapes::StructureShape.new(name: 'DeleteMedicalTranscriptionJobRequest')
27
+ DeleteMedicalVocabularyRequest = Shapes::StructureShape.new(name: 'DeleteMedicalVocabularyRequest')
24
28
  DeleteTranscriptionJobRequest = Shapes::StructureShape.new(name: 'DeleteTranscriptionJobRequest')
25
29
  DeleteVocabularyFilterRequest = Shapes::StructureShape.new(name: 'DeleteVocabularyFilterRequest')
26
30
  DeleteVocabularyRequest = Shapes::StructureShape.new(name: 'DeleteVocabularyRequest')
27
31
  FailureReason = Shapes::StringShape.new(name: 'FailureReason')
32
+ GetMedicalTranscriptionJobRequest = Shapes::StructureShape.new(name: 'GetMedicalTranscriptionJobRequest')
33
+ GetMedicalTranscriptionJobResponse = Shapes::StructureShape.new(name: 'GetMedicalTranscriptionJobResponse')
34
+ GetMedicalVocabularyRequest = Shapes::StructureShape.new(name: 'GetMedicalVocabularyRequest')
35
+ GetMedicalVocabularyResponse = Shapes::StructureShape.new(name: 'GetMedicalVocabularyResponse')
28
36
  GetTranscriptionJobRequest = Shapes::StructureShape.new(name: 'GetTranscriptionJobRequest')
29
37
  GetTranscriptionJobResponse = Shapes::StructureShape.new(name: 'GetTranscriptionJobResponse')
30
38
  GetVocabularyFilterRequest = Shapes::StructureShape.new(name: 'GetVocabularyFilterRequest')
@@ -36,6 +44,10 @@ module Aws::TranscribeService
36
44
  KMSKeyId = Shapes::StringShape.new(name: 'KMSKeyId')
37
45
  LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
38
46
  LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
47
+ ListMedicalTranscriptionJobsRequest = Shapes::StructureShape.new(name: 'ListMedicalTranscriptionJobsRequest')
48
+ ListMedicalTranscriptionJobsResponse = Shapes::StructureShape.new(name: 'ListMedicalTranscriptionJobsResponse')
49
+ ListMedicalVocabulariesRequest = Shapes::StructureShape.new(name: 'ListMedicalVocabulariesRequest')
50
+ ListMedicalVocabulariesResponse = Shapes::StructureShape.new(name: 'ListMedicalVocabulariesResponse')
39
51
  ListTranscriptionJobsRequest = Shapes::StructureShape.new(name: 'ListTranscriptionJobsRequest')
40
52
  ListTranscriptionJobsResponse = Shapes::StructureShape.new(name: 'ListTranscriptionJobsResponse')
41
53
  ListVocabulariesRequest = Shapes::StructureShape.new(name: 'ListVocabulariesRequest')
@@ -48,6 +60,11 @@ module Aws::TranscribeService
48
60
  Media = Shapes::StructureShape.new(name: 'Media')
49
61
  MediaFormat = Shapes::StringShape.new(name: 'MediaFormat')
50
62
  MediaSampleRateHertz = Shapes::IntegerShape.new(name: 'MediaSampleRateHertz')
63
+ MedicalTranscript = Shapes::StructureShape.new(name: 'MedicalTranscript')
64
+ MedicalTranscriptionJob = Shapes::StructureShape.new(name: 'MedicalTranscriptionJob')
65
+ MedicalTranscriptionJobSummaries = Shapes::ListShape.new(name: 'MedicalTranscriptionJobSummaries')
66
+ MedicalTranscriptionJobSummary = Shapes::StructureShape.new(name: 'MedicalTranscriptionJobSummary')
67
+ MedicalTranscriptionSetting = Shapes::StructureShape.new(name: 'MedicalTranscriptionSetting')
51
68
  NextToken = Shapes::StringShape.new(name: 'NextToken')
52
69
  NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
53
70
  OutputBucketName = Shapes::StringShape.new(name: 'OutputBucketName')
@@ -57,6 +74,9 @@ module Aws::TranscribeService
57
74
  RedactionOutput = Shapes::StringShape.new(name: 'RedactionOutput')
58
75
  RedactionType = Shapes::StringShape.new(name: 'RedactionType')
59
76
  Settings = Shapes::StructureShape.new(name: 'Settings')
77
+ Specialty = Shapes::StringShape.new(name: 'Specialty')
78
+ StartMedicalTranscriptionJobRequest = Shapes::StructureShape.new(name: 'StartMedicalTranscriptionJobRequest')
79
+ StartMedicalTranscriptionJobResponse = Shapes::StructureShape.new(name: 'StartMedicalTranscriptionJobResponse')
60
80
  StartTranscriptionJobRequest = Shapes::StructureShape.new(name: 'StartTranscriptionJobRequest')
61
81
  StartTranscriptionJobResponse = Shapes::StructureShape.new(name: 'StartTranscriptionJobResponse')
62
82
  String = Shapes::StringShape.new(name: 'String')
@@ -66,6 +86,9 @@ module Aws::TranscribeService
66
86
  TranscriptionJobStatus = Shapes::StringShape.new(name: 'TranscriptionJobStatus')
67
87
  TranscriptionJobSummaries = Shapes::ListShape.new(name: 'TranscriptionJobSummaries')
68
88
  TranscriptionJobSummary = Shapes::StructureShape.new(name: 'TranscriptionJobSummary')
89
+ Type = Shapes::StringShape.new(name: 'Type')
90
+ UpdateMedicalVocabularyRequest = Shapes::StructureShape.new(name: 'UpdateMedicalVocabularyRequest')
91
+ UpdateMedicalVocabularyResponse = Shapes::StructureShape.new(name: 'UpdateMedicalVocabularyResponse')
69
92
  UpdateVocabularyFilterRequest = Shapes::StructureShape.new(name: 'UpdateVocabularyFilterRequest')
70
93
  UpdateVocabularyFilterResponse = Shapes::StructureShape.new(name: 'UpdateVocabularyFilterResponse')
71
94
  UpdateVocabularyRequest = Shapes::StructureShape.new(name: 'UpdateVocabularyRequest')
@@ -92,6 +115,18 @@ module Aws::TranscribeService
92
115
  ContentRedaction.add_member(:redaction_output, Shapes::ShapeRef.new(shape: RedactionOutput, required: true, location_name: "RedactionOutput"))
93
116
  ContentRedaction.struct_class = Types::ContentRedaction
94
117
 
118
+ CreateMedicalVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
119
+ CreateMedicalVocabularyRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
120
+ CreateMedicalVocabularyRequest.add_member(:vocabulary_file_uri, Shapes::ShapeRef.new(shape: Uri, required: true, location_name: "VocabularyFileUri"))
121
+ CreateMedicalVocabularyRequest.struct_class = Types::CreateMedicalVocabularyRequest
122
+
123
+ CreateMedicalVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
124
+ CreateMedicalVocabularyResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
125
+ CreateMedicalVocabularyResponse.add_member(:vocabulary_state, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "VocabularyState"))
126
+ CreateMedicalVocabularyResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "LastModifiedTime"))
127
+ CreateMedicalVocabularyResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
128
+ CreateMedicalVocabularyResponse.struct_class = Types::CreateMedicalVocabularyResponse
129
+
95
130
  CreateVocabularyFilterRequest.add_member(:vocabulary_filter_name, Shapes::ShapeRef.new(shape: VocabularyFilterName, required: true, location_name: "VocabularyFilterName"))
96
131
  CreateVocabularyFilterRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
97
132
  CreateVocabularyFilterRequest.add_member(:words, Shapes::ShapeRef.new(shape: Words, location_name: "Words"))
@@ -116,6 +151,12 @@ module Aws::TranscribeService
116
151
  CreateVocabularyResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
117
152
  CreateVocabularyResponse.struct_class = Types::CreateVocabularyResponse
118
153
 
154
+ DeleteMedicalTranscriptionJobRequest.add_member(:medical_transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "MedicalTranscriptionJobName"))
155
+ DeleteMedicalTranscriptionJobRequest.struct_class = Types::DeleteMedicalTranscriptionJobRequest
156
+
157
+ DeleteMedicalVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
158
+ DeleteMedicalVocabularyRequest.struct_class = Types::DeleteMedicalVocabularyRequest
159
+
119
160
  DeleteTranscriptionJobRequest.add_member(:transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "TranscriptionJobName"))
120
161
  DeleteTranscriptionJobRequest.struct_class = Types::DeleteTranscriptionJobRequest
121
162
 
@@ -125,6 +166,23 @@ module Aws::TranscribeService
125
166
  DeleteVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
126
167
  DeleteVocabularyRequest.struct_class = Types::DeleteVocabularyRequest
127
168
 
169
+ GetMedicalTranscriptionJobRequest.add_member(:medical_transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "MedicalTranscriptionJobName"))
170
+ GetMedicalTranscriptionJobRequest.struct_class = Types::GetMedicalTranscriptionJobRequest
171
+
172
+ GetMedicalTranscriptionJobResponse.add_member(:medical_transcription_job, Shapes::ShapeRef.new(shape: MedicalTranscriptionJob, location_name: "MedicalTranscriptionJob"))
173
+ GetMedicalTranscriptionJobResponse.struct_class = Types::GetMedicalTranscriptionJobResponse
174
+
175
+ GetMedicalVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
176
+ GetMedicalVocabularyRequest.struct_class = Types::GetMedicalVocabularyRequest
177
+
178
+ GetMedicalVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
179
+ GetMedicalVocabularyResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
180
+ GetMedicalVocabularyResponse.add_member(:vocabulary_state, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "VocabularyState"))
181
+ GetMedicalVocabularyResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "LastModifiedTime"))
182
+ GetMedicalVocabularyResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
183
+ GetMedicalVocabularyResponse.add_member(:download_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "DownloadUri"))
184
+ GetMedicalVocabularyResponse.struct_class = Types::GetMedicalVocabularyResponse
185
+
128
186
  GetTranscriptionJobRequest.add_member(:transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "TranscriptionJobName"))
129
187
  GetTranscriptionJobRequest.struct_class = Types::GetTranscriptionJobRequest
130
188
 
@@ -161,6 +219,28 @@ module Aws::TranscribeService
161
219
  LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
162
220
  LimitExceededException.struct_class = Types::LimitExceededException
163
221
 
222
+ ListMedicalTranscriptionJobsRequest.add_member(:status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "Status"))
223
+ ListMedicalTranscriptionJobsRequest.add_member(:job_name_contains, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "JobNameContains"))
224
+ ListMedicalTranscriptionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
225
+ ListMedicalTranscriptionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
226
+ ListMedicalTranscriptionJobsRequest.struct_class = Types::ListMedicalTranscriptionJobsRequest
227
+
228
+ ListMedicalTranscriptionJobsResponse.add_member(:status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "Status"))
229
+ ListMedicalTranscriptionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
230
+ ListMedicalTranscriptionJobsResponse.add_member(:medical_transcription_job_summaries, Shapes::ShapeRef.new(shape: MedicalTranscriptionJobSummaries, location_name: "MedicalTranscriptionJobSummaries"))
231
+ ListMedicalTranscriptionJobsResponse.struct_class = Types::ListMedicalTranscriptionJobsResponse
232
+
233
+ ListMedicalVocabulariesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
234
+ ListMedicalVocabulariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
235
+ ListMedicalVocabulariesRequest.add_member(:state_equals, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "StateEquals"))
236
+ ListMedicalVocabulariesRequest.add_member(:name_contains, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "NameContains"))
237
+ ListMedicalVocabulariesRequest.struct_class = Types::ListMedicalVocabulariesRequest
238
+
239
+ ListMedicalVocabulariesResponse.add_member(:status, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "Status"))
240
+ ListMedicalVocabulariesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
241
+ ListMedicalVocabulariesResponse.add_member(:vocabularies, Shapes::ShapeRef.new(shape: Vocabularies, location_name: "Vocabularies"))
242
+ ListMedicalVocabulariesResponse.struct_class = Types::ListMedicalVocabulariesResponse
243
+
164
244
  ListTranscriptionJobsRequest.add_member(:status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "Status"))
165
245
  ListTranscriptionJobsRequest.add_member(:job_name_contains, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "JobNameContains"))
166
246
  ListTranscriptionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
@@ -178,7 +258,7 @@ module Aws::TranscribeService
178
258
  ListVocabulariesRequest.add_member(:name_contains, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "NameContains"))
179
259
  ListVocabulariesRequest.struct_class = Types::ListVocabulariesRequest
180
260
 
181
- ListVocabulariesResponse.add_member(:status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "Status"))
261
+ ListVocabulariesResponse.add_member(:status, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "Status"))
182
262
  ListVocabulariesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
183
263
  ListVocabulariesResponse.add_member(:vocabularies, Shapes::ShapeRef.new(shape: Vocabularies, location_name: "Vocabularies"))
184
264
  ListVocabulariesResponse.struct_class = Types::ListVocabulariesResponse
@@ -195,6 +275,47 @@ module Aws::TranscribeService
195
275
  Media.add_member(:media_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "MediaFileUri"))
196
276
  Media.struct_class = Types::Media
197
277
 
278
+ MedicalTranscript.add_member(:transcript_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "TranscriptFileUri"))
279
+ MedicalTranscript.struct_class = Types::MedicalTranscript
280
+
281
+ MedicalTranscriptionJob.add_member(:medical_transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "MedicalTranscriptionJobName"))
282
+ MedicalTranscriptionJob.add_member(:transcription_job_status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "TranscriptionJobStatus"))
283
+ MedicalTranscriptionJob.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
284
+ MedicalTranscriptionJob.add_member(:media_sample_rate_hertz, Shapes::ShapeRef.new(shape: MediaSampleRateHertz, location_name: "MediaSampleRateHertz"))
285
+ MedicalTranscriptionJob.add_member(:media_format, Shapes::ShapeRef.new(shape: MediaFormat, location_name: "MediaFormat"))
286
+ MedicalTranscriptionJob.add_member(:media, Shapes::ShapeRef.new(shape: Media, location_name: "Media"))
287
+ MedicalTranscriptionJob.add_member(:transcript, Shapes::ShapeRef.new(shape: MedicalTranscript, location_name: "Transcript"))
288
+ MedicalTranscriptionJob.add_member(:start_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "StartTime"))
289
+ MedicalTranscriptionJob.add_member(:creation_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "CreationTime"))
290
+ MedicalTranscriptionJob.add_member(:completion_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "CompletionTime"))
291
+ MedicalTranscriptionJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
292
+ MedicalTranscriptionJob.add_member(:settings, Shapes::ShapeRef.new(shape: MedicalTranscriptionSetting, location_name: "Settings"))
293
+ MedicalTranscriptionJob.add_member(:specialty, Shapes::ShapeRef.new(shape: Specialty, location_name: "Specialty"))
294
+ MedicalTranscriptionJob.add_member(:type, Shapes::ShapeRef.new(shape: Type, location_name: "Type"))
295
+ MedicalTranscriptionJob.struct_class = Types::MedicalTranscriptionJob
296
+
297
+ MedicalTranscriptionJobSummaries.member = Shapes::ShapeRef.new(shape: MedicalTranscriptionJobSummary)
298
+
299
+ MedicalTranscriptionJobSummary.add_member(:medical_transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "MedicalTranscriptionJobName"))
300
+ MedicalTranscriptionJobSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "CreationTime"))
301
+ MedicalTranscriptionJobSummary.add_member(:start_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "StartTime"))
302
+ MedicalTranscriptionJobSummary.add_member(:completion_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "CompletionTime"))
303
+ MedicalTranscriptionJobSummary.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
304
+ MedicalTranscriptionJobSummary.add_member(:transcription_job_status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "TranscriptionJobStatus"))
305
+ MedicalTranscriptionJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
306
+ MedicalTranscriptionJobSummary.add_member(:output_location_type, Shapes::ShapeRef.new(shape: OutputLocationType, location_name: "OutputLocationType"))
307
+ MedicalTranscriptionJobSummary.add_member(:specialty, Shapes::ShapeRef.new(shape: Specialty, location_name: "Specialty"))
308
+ MedicalTranscriptionJobSummary.add_member(:type, Shapes::ShapeRef.new(shape: Type, location_name: "Type"))
309
+ MedicalTranscriptionJobSummary.struct_class = Types::MedicalTranscriptionJobSummary
310
+
311
+ MedicalTranscriptionSetting.add_member(:show_speaker_labels, Shapes::ShapeRef.new(shape: Boolean, location_name: "ShowSpeakerLabels"))
312
+ MedicalTranscriptionSetting.add_member(:max_speaker_labels, Shapes::ShapeRef.new(shape: MaxSpeakers, location_name: "MaxSpeakerLabels"))
313
+ MedicalTranscriptionSetting.add_member(:channel_identification, Shapes::ShapeRef.new(shape: Boolean, location_name: "ChannelIdentification"))
314
+ MedicalTranscriptionSetting.add_member(:show_alternatives, Shapes::ShapeRef.new(shape: Boolean, location_name: "ShowAlternatives"))
315
+ MedicalTranscriptionSetting.add_member(:max_alternatives, Shapes::ShapeRef.new(shape: MaxAlternatives, location_name: "MaxAlternatives"))
316
+ MedicalTranscriptionSetting.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
317
+ MedicalTranscriptionSetting.struct_class = Types::MedicalTranscriptionSetting
318
+
198
319
  NotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
199
320
  NotFoundException.struct_class = Types::NotFoundException
200
321
 
@@ -210,6 +331,21 @@ module Aws::TranscribeService
210
331
  Settings.add_member(:vocabulary_filter_method, Shapes::ShapeRef.new(shape: VocabularyFilterMethod, location_name: "VocabularyFilterMethod"))
211
332
  Settings.struct_class = Types::Settings
212
333
 
334
+ StartMedicalTranscriptionJobRequest.add_member(:medical_transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "MedicalTranscriptionJobName"))
335
+ StartMedicalTranscriptionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
336
+ StartMedicalTranscriptionJobRequest.add_member(:media_sample_rate_hertz, Shapes::ShapeRef.new(shape: MediaSampleRateHertz, location_name: "MediaSampleRateHertz"))
337
+ StartMedicalTranscriptionJobRequest.add_member(:media_format, Shapes::ShapeRef.new(shape: MediaFormat, location_name: "MediaFormat"))
338
+ StartMedicalTranscriptionJobRequest.add_member(:media, Shapes::ShapeRef.new(shape: Media, required: true, location_name: "Media"))
339
+ StartMedicalTranscriptionJobRequest.add_member(:output_bucket_name, Shapes::ShapeRef.new(shape: OutputBucketName, required: true, location_name: "OutputBucketName"))
340
+ StartMedicalTranscriptionJobRequest.add_member(:output_encryption_kms_key_id, Shapes::ShapeRef.new(shape: KMSKeyId, location_name: "OutputEncryptionKMSKeyId"))
341
+ StartMedicalTranscriptionJobRequest.add_member(:settings, Shapes::ShapeRef.new(shape: MedicalTranscriptionSetting, location_name: "Settings"))
342
+ StartMedicalTranscriptionJobRequest.add_member(:specialty, Shapes::ShapeRef.new(shape: Specialty, required: true, location_name: "Specialty"))
343
+ StartMedicalTranscriptionJobRequest.add_member(:type, Shapes::ShapeRef.new(shape: Type, required: true, location_name: "Type"))
344
+ StartMedicalTranscriptionJobRequest.struct_class = Types::StartMedicalTranscriptionJobRequest
345
+
346
+ StartMedicalTranscriptionJobResponse.add_member(:medical_transcription_job, Shapes::ShapeRef.new(shape: MedicalTranscriptionJob, location_name: "MedicalTranscriptionJob"))
347
+ StartMedicalTranscriptionJobResponse.struct_class = Types::StartMedicalTranscriptionJobResponse
348
+
213
349
  StartTranscriptionJobRequest.add_member(:transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "TranscriptionJobName"))
214
350
  StartTranscriptionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
215
351
  StartTranscriptionJobRequest.add_member(:media_sample_rate_hertz, Shapes::ShapeRef.new(shape: MediaSampleRateHertz, location_name: "MediaSampleRateHertz"))
@@ -258,6 +394,17 @@ module Aws::TranscribeService
258
394
  TranscriptionJobSummary.add_member(:content_redaction, Shapes::ShapeRef.new(shape: ContentRedaction, location_name: "ContentRedaction"))
259
395
  TranscriptionJobSummary.struct_class = Types::TranscriptionJobSummary
260
396
 
397
+ UpdateMedicalVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
398
+ UpdateMedicalVocabularyRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
399
+ UpdateMedicalVocabularyRequest.add_member(:vocabulary_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "VocabularyFileUri"))
400
+ UpdateMedicalVocabularyRequest.struct_class = Types::UpdateMedicalVocabularyRequest
401
+
402
+ UpdateMedicalVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
403
+ UpdateMedicalVocabularyResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
404
+ UpdateMedicalVocabularyResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "LastModifiedTime"))
405
+ UpdateMedicalVocabularyResponse.add_member(:vocabulary_state, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "VocabularyState"))
406
+ UpdateMedicalVocabularyResponse.struct_class = Types::UpdateMedicalVocabularyResponse
407
+
261
408
  UpdateVocabularyFilterRequest.add_member(:vocabulary_filter_name, Shapes::ShapeRef.new(shape: VocabularyFilterName, required: true, location_name: "VocabularyFilterName"))
262
409
  UpdateVocabularyFilterRequest.add_member(:words, Shapes::ShapeRef.new(shape: Words, location_name: "Words"))
263
410
  UpdateVocabularyFilterRequest.add_member(:vocabulary_filter_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "VocabularyFilterFileUri"))
@@ -316,6 +463,18 @@ module Aws::TranscribeService
316
463
  "uid" => "transcribe-2017-10-26",
317
464
  }
318
465
 
466
+ api.add_operation(:create_medical_vocabulary, Seahorse::Model::Operation.new.tap do |o|
467
+ o.name = "CreateMedicalVocabulary"
468
+ o.http_method = "POST"
469
+ o.http_request_uri = "/"
470
+ o.input = Shapes::ShapeRef.new(shape: CreateMedicalVocabularyRequest)
471
+ o.output = Shapes::ShapeRef.new(shape: CreateMedicalVocabularyResponse)
472
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
473
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
474
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
475
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
476
+ end)
477
+
319
478
  api.add_operation(:create_vocabulary, Seahorse::Model::Operation.new.tap do |o|
320
479
  o.name = "CreateVocabulary"
321
480
  o.http_method = "POST"
@@ -340,6 +499,29 @@ module Aws::TranscribeService
340
499
  o.errors << Shapes::ShapeRef.new(shape: ConflictException)
341
500
  end)
342
501
 
502
+ api.add_operation(:delete_medical_transcription_job, Seahorse::Model::Operation.new.tap do |o|
503
+ o.name = "DeleteMedicalTranscriptionJob"
504
+ o.http_method = "POST"
505
+ o.http_request_uri = "/"
506
+ o.input = Shapes::ShapeRef.new(shape: DeleteMedicalTranscriptionJobRequest)
507
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
508
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
509
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
510
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
511
+ end)
512
+
513
+ api.add_operation(:delete_medical_vocabulary, Seahorse::Model::Operation.new.tap do |o|
514
+ o.name = "DeleteMedicalVocabulary"
515
+ o.http_method = "POST"
516
+ o.http_request_uri = "/"
517
+ o.input = Shapes::ShapeRef.new(shape: DeleteMedicalVocabularyRequest)
518
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
519
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
520
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
521
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
522
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
523
+ end)
524
+
343
525
  api.add_operation(:delete_transcription_job, Seahorse::Model::Operation.new.tap do |o|
344
526
  o.name = "DeleteTranscriptionJob"
345
527
  o.http_method = "POST"
@@ -375,6 +557,30 @@ module Aws::TranscribeService
375
557
  o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
376
558
  end)
377
559
 
560
+ api.add_operation(:get_medical_transcription_job, Seahorse::Model::Operation.new.tap do |o|
561
+ o.name = "GetMedicalTranscriptionJob"
562
+ o.http_method = "POST"
563
+ o.http_request_uri = "/"
564
+ o.input = Shapes::ShapeRef.new(shape: GetMedicalTranscriptionJobRequest)
565
+ o.output = Shapes::ShapeRef.new(shape: GetMedicalTranscriptionJobResponse)
566
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
567
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
568
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
569
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
570
+ end)
571
+
572
+ api.add_operation(:get_medical_vocabulary, Seahorse::Model::Operation.new.tap do |o|
573
+ o.name = "GetMedicalVocabulary"
574
+ o.http_method = "POST"
575
+ o.http_request_uri = "/"
576
+ o.input = Shapes::ShapeRef.new(shape: GetMedicalVocabularyRequest)
577
+ o.output = Shapes::ShapeRef.new(shape: GetMedicalVocabularyResponse)
578
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
579
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
580
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
581
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
582
+ end)
583
+
378
584
  api.add_operation(:get_transcription_job, Seahorse::Model::Operation.new.tap do |o|
379
585
  o.name = "GetTranscriptionJob"
380
586
  o.http_method = "POST"
@@ -411,6 +617,40 @@ module Aws::TranscribeService
411
617
  o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
412
618
  end)
413
619
 
620
+ api.add_operation(:list_medical_transcription_jobs, Seahorse::Model::Operation.new.tap do |o|
621
+ o.name = "ListMedicalTranscriptionJobs"
622
+ o.http_method = "POST"
623
+ o.http_request_uri = "/"
624
+ o.input = Shapes::ShapeRef.new(shape: ListMedicalTranscriptionJobsRequest)
625
+ o.output = Shapes::ShapeRef.new(shape: ListMedicalTranscriptionJobsResponse)
626
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
627
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
628
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
629
+ o[:pager] = Aws::Pager.new(
630
+ limit_key: "max_results",
631
+ tokens: {
632
+ "next_token" => "next_token"
633
+ }
634
+ )
635
+ end)
636
+
637
+ api.add_operation(:list_medical_vocabularies, Seahorse::Model::Operation.new.tap do |o|
638
+ o.name = "ListMedicalVocabularies"
639
+ o.http_method = "POST"
640
+ o.http_request_uri = "/"
641
+ o.input = Shapes::ShapeRef.new(shape: ListMedicalVocabulariesRequest)
642
+ o.output = Shapes::ShapeRef.new(shape: ListMedicalVocabulariesResponse)
643
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
644
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
645
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
646
+ o[:pager] = Aws::Pager.new(
647
+ limit_key: "max_results",
648
+ tokens: {
649
+ "next_token" => "next_token"
650
+ }
651
+ )
652
+ end)
653
+
414
654
  api.add_operation(:list_transcription_jobs, Seahorse::Model::Operation.new.tap do |o|
415
655
  o.name = "ListTranscriptionJobs"
416
656
  o.http_method = "POST"
@@ -462,6 +702,18 @@ module Aws::TranscribeService
462
702
  )
463
703
  end)
464
704
 
705
+ api.add_operation(:start_medical_transcription_job, Seahorse::Model::Operation.new.tap do |o|
706
+ o.name = "StartMedicalTranscriptionJob"
707
+ o.http_method = "POST"
708
+ o.http_request_uri = "/"
709
+ o.input = Shapes::ShapeRef.new(shape: StartMedicalTranscriptionJobRequest)
710
+ o.output = Shapes::ShapeRef.new(shape: StartMedicalTranscriptionJobResponse)
711
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
712
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
713
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
714
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
715
+ end)
716
+
465
717
  api.add_operation(:start_transcription_job, Seahorse::Model::Operation.new.tap do |o|
466
718
  o.name = "StartTranscriptionJob"
467
719
  o.http_method = "POST"
@@ -474,6 +726,19 @@ module Aws::TranscribeService
474
726
  o.errors << Shapes::ShapeRef.new(shape: ConflictException)
475
727
  end)
476
728
 
729
+ api.add_operation(:update_medical_vocabulary, Seahorse::Model::Operation.new.tap do |o|
730
+ o.name = "UpdateMedicalVocabulary"
731
+ o.http_method = "POST"
732
+ o.http_request_uri = "/"
733
+ o.input = Shapes::ShapeRef.new(shape: UpdateMedicalVocabularyRequest)
734
+ o.output = Shapes::ShapeRef.new(shape: UpdateMedicalVocabularyResponse)
735
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
736
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
737
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
738
+ o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
739
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
740
+ end)
741
+
477
742
  api.add_operation(:update_vocabulary, Seahorse::Model::Operation.new.tap do |o|
478
743
  o.name = "UpdateVocabulary"
479
744
  o.http_method = "POST"
@@ -6,13 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::TranscribeService
9
- # This class provides a resource oriented interface for TranscribeService.
10
- # To create a resource object:
11
- # resource = Aws::TranscribeService::Resource.new(region: 'us-west-2')
12
- # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
14
- # client = Aws::TranscribeService::Client.new(region: 'us-west-2')
15
- # resource = Aws::TranscribeService::Resource.new(client: client)
9
+
16
10
  class Resource
17
11
 
18
12
  # @param options ({})
@@ -23,12 +23,7 @@ module Aws::TranscribeService
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
- # When you are using the `CreateVocabulary` operation, the `JobName`
27
- # field is a duplicate of a previously entered job name. Resend your
28
- # request with a different name.
29
- #
30
- # When you are using the `UpdateVocabulary` operation, there are two
31
- # jobs running at the same time. Resend the second request later.
26
+ # The resource name already exists.
32
27
  #
33
28
  # @!attribute [rw] message
34
29
  # @return [String]
@@ -42,13 +37,6 @@ module Aws::TranscribeService
42
37
 
43
38
  # Settings for content redaction within a transcription job.
44
39
  #
45
- # You can redact transcripts in US English (en-us). For more information
46
- # see: [Automatic Content Redaction][1]
47
- #
48
- #
49
- #
50
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html
51
- #
52
40
  # @note When making an API call, you may pass ContentRedaction
53
41
  # data as a hash:
54
42
  #
@@ -63,15 +51,14 @@ module Aws::TranscribeService
63
51
  # @return [String]
64
52
  #
65
53
  # @!attribute [rw] redaction_output
66
- # Request parameter where you choose whether to output only the
67
- # redacted transcript or generate an additional unredacted transcript.
54
+ # The output transcript file stored in either the default S3 bucket or
55
+ # in a bucket you specify.
68
56
  #
69
- # When you choose `redacted` Amazon Transcribe outputs a JSON file
70
- # with only the redacted transcript and related information.
57
+ # When you choose `redacted` Amazon Transcribe outputs only the
58
+ # redacted transcript.
71
59
  #
72
60
  # When you choose `redacted_and_unredacted` Amazon Transcribe outputs
73
- # a JSON file with the unredacted transcript and related information
74
- # in addition to the JSON file with the redacted transcript.
61
+ # both the redacted and unredacted transcripts.
75
62
  # @return [String]
76
63
  #
77
64
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ContentRedaction AWS API Documentation
@@ -82,6 +69,101 @@ module Aws::TranscribeService
82
69
  include Aws::Structure
83
70
  end
84
71
 
72
+ # @note When making an API call, you may pass CreateMedicalVocabularyRequest
73
+ # data as a hash:
74
+ #
75
+ # {
76
+ # vocabulary_name: "VocabularyName", # required
77
+ # language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
78
+ # vocabulary_file_uri: "Uri", # required
79
+ # }
80
+ #
81
+ # @!attribute [rw] vocabulary_name
82
+ # The name of the custom vocabulary. This case-sensitive name must be
83
+ # unique within an AWS account. If you try to create a vocabulary with
84
+ # the same name as a previous vocabulary you will receive a
85
+ # `ConflictException` error.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] language_code
89
+ # The language code used for the entries within your custom
90
+ # vocabulary. The language code of your custom vocabulary must match
91
+ # the language code of your transcription job. US English (en-US) is
92
+ # the only language code available for Amazon Transcribe Medical.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] vocabulary_file_uri
96
+ # The Amazon S3 location of the text file you use to define your
97
+ # custom vocabulary. The URI must be in the same AWS region as the API
98
+ # endpoint you're calling. Enter information about your
99
+ # `VocabularyFileUri` in the following format:
100
+ #
101
+ # `
102
+ # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
103
+ # `
104
+ #
105
+ # This is an example of a vocabulary file uri location in Amazon S3:
106
+ #
107
+ # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
108
+ #
109
+ # For more information about S3 object names, see [Object Keys][1] in
110
+ # the *Amazon S3 Developer Guide*.
111
+ #
112
+ # For more information about custom vocabularies, see [Medical Custom
113
+ # Vocabularies][2].
114
+ #
115
+ #
116
+ #
117
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
118
+ # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary-med
119
+ # @return [String]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabularyRequest AWS API Documentation
122
+ #
123
+ class CreateMedicalVocabularyRequest < Struct.new(
124
+ :vocabulary_name,
125
+ :language_code,
126
+ :vocabulary_file_uri)
127
+ include Aws::Structure
128
+ end
129
+
130
+ # @!attribute [rw] vocabulary_name
131
+ # The name of the vocabulary. The name must be unique within an AWS
132
+ # account. It is also case-sensitive.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] language_code
136
+ # The language code you chose to describe the entries in your custom
137
+ # vocabulary. US English (en-US) is the only valid language code for
138
+ # Amazon Transcribe Medical.
139
+ # @return [String]
140
+ #
141
+ # @!attribute [rw] vocabulary_state
142
+ # The processing state of your custom vocabulary in Amazon Transcribe
143
+ # Medical. If the state is `READY` you can use the vocabulary in a
144
+ # `StartMedicalTranscriptionJob` request.
145
+ # @return [String]
146
+ #
147
+ # @!attribute [rw] last_modified_time
148
+ # The date and time you created the vocabulary.
149
+ # @return [Time]
150
+ #
151
+ # @!attribute [rw] failure_reason
152
+ # If the `VocabularyState` field is `FAILED`, this field contains
153
+ # information about why the job failed.
154
+ # @return [String]
155
+ #
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabularyResponse AWS API Documentation
157
+ #
158
+ class CreateMedicalVocabularyResponse < Struct.new(
159
+ :vocabulary_name,
160
+ :language_code,
161
+ :vocabulary_state,
162
+ :last_modified_time,
163
+ :failure_reason)
164
+ include Aws::Structure
165
+ end
166
+
85
167
  # @note When making an API call, you may pass CreateVocabularyFilterRequest
86
168
  # data as a hash:
87
169
  #
@@ -94,7 +176,9 @@ module Aws::TranscribeService
94
176
  #
95
177
  # @!attribute [rw] vocabulary_filter_name
96
178
  # The vocabulary filter name. The name must be unique within the
97
- # account that contains it.
179
+ # account that contains it.If you try to create a vocabulary filter
180
+ # with the same name as a previous vocabulary filter you will receive
181
+ # a `ConflictException` error.
98
182
  # @return [String]
99
183
  #
100
184
  # @!attribute [rw] language_code
@@ -176,7 +260,9 @@ module Aws::TranscribeService
176
260
  #
177
261
  # @!attribute [rw] vocabulary_name
178
262
  # The name of the vocabulary. The name must be unique within an AWS
179
- # account. The name is case-sensitive.
263
+ # account. The name is case-sensitive. If you try to create a
264
+ # vocabulary with the same name as a previous vocabulary you will
265
+ # receive a `ConflictException` error.
180
266
  # @return [String]
181
267
  #
182
268
  # @!attribute [rw] language_code
@@ -192,14 +278,6 @@ module Aws::TranscribeService
192
278
  # custom vocabulary. The URI must be in the same region as the API
193
279
  # endpoint that you are calling. The general form is
194
280
  #
195
- # `
196
- # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
197
- # `
198
- #
199
- # For example:
200
- #
201
- # `https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt`
202
- #
203
281
  # For more information about S3 object names, see [Object Keys][1] in
204
282
  # the *Amazon S3 Developer Guide*.
205
283
  #
@@ -256,6 +334,43 @@ module Aws::TranscribeService
256
334
  include Aws::Structure
257
335
  end
258
336
 
337
+ # @note When making an API call, you may pass DeleteMedicalTranscriptionJobRequest
338
+ # data as a hash:
339
+ #
340
+ # {
341
+ # medical_transcription_job_name: "TranscriptionJobName", # required
342
+ # }
343
+ #
344
+ # @!attribute [rw] medical_transcription_job_name
345
+ # The name you provide to the `DeleteMedicalTranscriptionJob` object
346
+ # to delete a transcription job.
347
+ # @return [String]
348
+ #
349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalTranscriptionJobRequest AWS API Documentation
350
+ #
351
+ class DeleteMedicalTranscriptionJobRequest < Struct.new(
352
+ :medical_transcription_job_name)
353
+ include Aws::Structure
354
+ end
355
+
356
+ # @note When making an API call, you may pass DeleteMedicalVocabularyRequest
357
+ # data as a hash:
358
+ #
359
+ # {
360
+ # vocabulary_name: "VocabularyName", # required
361
+ # }
362
+ #
363
+ # @!attribute [rw] vocabulary_name
364
+ # The name of the vocabulary you are choosing to delete.
365
+ # @return [String]
366
+ #
367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabularyRequest AWS API Documentation
368
+ #
369
+ class DeleteMedicalVocabularyRequest < Struct.new(
370
+ :vocabulary_name)
371
+ include Aws::Structure
372
+ end
373
+
259
374
  # @note When making an API call, you may pass DeleteTranscriptionJobRequest
260
375
  # data as a hash:
261
376
  #
@@ -310,6 +425,95 @@ module Aws::TranscribeService
310
425
  include Aws::Structure
311
426
  end
312
427
 
428
+ # @note When making an API call, you may pass GetMedicalTranscriptionJobRequest
429
+ # data as a hash:
430
+ #
431
+ # {
432
+ # medical_transcription_job_name: "TranscriptionJobName", # required
433
+ # }
434
+ #
435
+ # @!attribute [rw] medical_transcription_job_name
436
+ # The name of the medical transcription job.
437
+ # @return [String]
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJobRequest AWS API Documentation
440
+ #
441
+ class GetMedicalTranscriptionJobRequest < Struct.new(
442
+ :medical_transcription_job_name)
443
+ include Aws::Structure
444
+ end
445
+
446
+ # @!attribute [rw] medical_transcription_job
447
+ # An object that contains the results of the medical transcription
448
+ # job.
449
+ # @return [Types::MedicalTranscriptionJob]
450
+ #
451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJobResponse AWS API Documentation
452
+ #
453
+ class GetMedicalTranscriptionJobResponse < Struct.new(
454
+ :medical_transcription_job)
455
+ include Aws::Structure
456
+ end
457
+
458
+ # @note When making an API call, you may pass GetMedicalVocabularyRequest
459
+ # data as a hash:
460
+ #
461
+ # {
462
+ # vocabulary_name: "VocabularyName", # required
463
+ # }
464
+ #
465
+ # @!attribute [rw] vocabulary_name
466
+ # The name of the vocabulary you are trying to get information about.
467
+ # The value you enter for this request is case-sensitive.
468
+ # @return [String]
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabularyRequest AWS API Documentation
471
+ #
472
+ class GetMedicalVocabularyRequest < Struct.new(
473
+ :vocabulary_name)
474
+ include Aws::Structure
475
+ end
476
+
477
+ # @!attribute [rw] vocabulary_name
478
+ # The valid name that Amazon Transcribe Medical returns.
479
+ # @return [String]
480
+ #
481
+ # @!attribute [rw] language_code
482
+ # The valid language code returned for your vocabulary entries.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] vocabulary_state
486
+ # The processing state of the vocabulary.
487
+ # @return [String]
488
+ #
489
+ # @!attribute [rw] last_modified_time
490
+ # The date and time the vocabulary was last modified with a text file
491
+ # different from what was previously used.
492
+ # @return [Time]
493
+ #
494
+ # @!attribute [rw] failure_reason
495
+ # If the `VocabularyState` is `FAILED`, this field contains
496
+ # information about why the job failed.
497
+ # @return [String]
498
+ #
499
+ # @!attribute [rw] download_uri
500
+ # The Amazon S3 location where the vocabulary is stored. Use this URI
501
+ # to get the contents of the vocabulary. You can download your
502
+ # vocabulary from the URI for a limited time.
503
+ # @return [String]
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabularyResponse AWS API Documentation
506
+ #
507
+ class GetMedicalVocabularyResponse < Struct.new(
508
+ :vocabulary_name,
509
+ :language_code,
510
+ :vocabulary_state,
511
+ :last_modified_time,
512
+ :failure_reason,
513
+ :download_uri)
514
+ include Aws::Structure
515
+ end
516
+
313
517
  # @note When making an API call, you may pass GetTranscriptionJobRequest
314
518
  # data as a hash:
315
519
  #
@@ -470,10 +674,10 @@ module Aws::TranscribeService
470
674
  # @!attribute [rw] allow_deferred_execution
471
675
  # Indicates whether a job should be queued by Amazon Transcribe when
472
676
  # the concurrent execution limit is exceeded. When the
473
- # `AllowDeferredExecution` field is true, jobs are queued and will be
474
- # executed when the number of executing jobs falls below the
475
- # concurrent execution limit. If the field is false, Amazon Transcribe
476
- # returns a `LimitExceededException` exception.
677
+ # `AllowDeferredExecution` field is true, jobs are queued and executed
678
+ # when the number of executing jobs falls below the concurrent
679
+ # execution limit. If the field is false, Amazon Transcribe returns a
680
+ # `LimitExceededException` exception.
477
681
  #
478
682
  # If you specify the `AllowDeferredExecution` field, you must specify
479
683
  # the `DataAccessRoleArn` field.
@@ -481,10 +685,10 @@ module Aws::TranscribeService
481
685
  #
482
686
  # @!attribute [rw] data_access_role_arn
483
687
  # The Amazon Resource Name (ARN) of a role that has access to the S3
484
- # bucket that contains the input files. Amazon Transcribe will assume
485
- # this role to read queued media files. If you have specified an
486
- # output S3 bucket for the transcription results, this role should
487
- # have access to the output bucket as well.
688
+ # bucket that contains the input files. Amazon Transcribe assumes this
689
+ # role to read queued media files. If you have specified an output S3
690
+ # bucket for the transcription results, this role should have access
691
+ # to the output bucket as well.
488
692
  #
489
693
  # If you specify the `AllowDeferredExecution` field, you must specify
490
694
  # the `DataAccessRoleArn` field.
@@ -512,6 +716,147 @@ module Aws::TranscribeService
512
716
  include Aws::Structure
513
717
  end
514
718
 
719
+ # @note When making an API call, you may pass ListMedicalTranscriptionJobsRequest
720
+ # data as a hash:
721
+ #
722
+ # {
723
+ # status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
724
+ # job_name_contains: "TranscriptionJobName",
725
+ # next_token: "NextToken",
726
+ # max_results: 1,
727
+ # }
728
+ #
729
+ # @!attribute [rw] status
730
+ # When specified, returns only medical transcription jobs with the
731
+ # specified status. Jobs are ordered by creation date, with the newest
732
+ # jobs returned first. If you don't specify a status, Amazon
733
+ # Transcribe Medical returns all transcription jobs ordered by
734
+ # creation date.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] job_name_contains
738
+ # When specified, the jobs returned in the list are limited to jobs
739
+ # whose name contains the specified string.
740
+ # @return [String]
741
+ #
742
+ # @!attribute [rw] next_token
743
+ # If you a receive a truncated result in the previous request of
744
+ # `ListMedicalTranscriptionJobs`, include `NextToken` to fetch the
745
+ # next set of jobs.
746
+ # @return [String]
747
+ #
748
+ # @!attribute [rw] max_results
749
+ # The maximum number of medical transcription jobs to return in the
750
+ # response. IF there are fewer results in the list, this response
751
+ # contains only the actual results.
752
+ # @return [Integer]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobsRequest AWS API Documentation
755
+ #
756
+ class ListMedicalTranscriptionJobsRequest < Struct.new(
757
+ :status,
758
+ :job_name_contains,
759
+ :next_token,
760
+ :max_results)
761
+ include Aws::Structure
762
+ end
763
+
764
+ # @!attribute [rw] status
765
+ # The requested status of the medical transcription jobs returned.
766
+ # @return [String]
767
+ #
768
+ # @!attribute [rw] next_token
769
+ # The `ListMedicalTranscriptionJobs` operation returns a page of jobs
770
+ # at a time. The maximum size of the page is set by the `MaxResults`
771
+ # parameter. If the number of jobs exceeds what can fit on a page,
772
+ # Amazon Transcribe Medical returns the `NextPage` token. Include the
773
+ # token in the next request to the `ListMedicalTranscriptionJobs`
774
+ # operation to return in the next page of jobs.
775
+ # @return [String]
776
+ #
777
+ # @!attribute [rw] medical_transcription_job_summaries
778
+ # A list of objects containing summary information for a transcription
779
+ # job.
780
+ # @return [Array<Types::MedicalTranscriptionJobSummary>]
781
+ #
782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobsResponse AWS API Documentation
783
+ #
784
+ class ListMedicalTranscriptionJobsResponse < Struct.new(
785
+ :status,
786
+ :next_token,
787
+ :medical_transcription_job_summaries)
788
+ include Aws::Structure
789
+ end
790
+
791
+ # @note When making an API call, you may pass ListMedicalVocabulariesRequest
792
+ # data as a hash:
793
+ #
794
+ # {
795
+ # next_token: "NextToken",
796
+ # max_results: 1,
797
+ # state_equals: "PENDING", # accepts PENDING, READY, FAILED
798
+ # name_contains: "VocabularyName",
799
+ # }
800
+ #
801
+ # @!attribute [rw] next_token
802
+ # If the result of your previous request to `ListMedicalVocabularies`
803
+ # was truncated, include the `NextToken` to fetch the next set of
804
+ # jobs.
805
+ # @return [String]
806
+ #
807
+ # @!attribute [rw] max_results
808
+ # The maximum number of vocabularies to return in the response.
809
+ # @return [Integer]
810
+ #
811
+ # @!attribute [rw] state_equals
812
+ # When specified, only returns vocabularies with the `VocabularyState`
813
+ # equal to the specified vocabulary state.
814
+ # @return [String]
815
+ #
816
+ # @!attribute [rw] name_contains
817
+ # Returns vocabularies in the list whose name contains the specified
818
+ # string. The search is case-insensitive, `ListMedicalVocabularies`
819
+ # returns both "vocabularyname" and "VocabularyName" in the
820
+ # response list.
821
+ # @return [String]
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalVocabulariesRequest AWS API Documentation
824
+ #
825
+ class ListMedicalVocabulariesRequest < Struct.new(
826
+ :next_token,
827
+ :max_results,
828
+ :state_equals,
829
+ :name_contains)
830
+ include Aws::Structure
831
+ end
832
+
833
+ # @!attribute [rw] status
834
+ # The requested vocabulary state.
835
+ # @return [String]
836
+ #
837
+ # @!attribute [rw] next_token
838
+ # The `ListMedicalVocabularies` operation returns a page of
839
+ # vocabularies at a time. The maximum size of the page is set by the
840
+ # `MaxResults` parameter. If there are more jobs in the list than the
841
+ # page size, Amazon Transcribe Medical returns the `NextPage` token.
842
+ # Include the token in the next request to the
843
+ # `ListMedicalVocabularies` operation to return the next page of jobs.
844
+ # @return [String]
845
+ #
846
+ # @!attribute [rw] vocabularies
847
+ # A list of objects that describe the vocabularies that match the
848
+ # search criteria in the request.
849
+ # @return [Array<Types::VocabularyInfo>]
850
+ #
851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalVocabulariesResponse AWS API Documentation
852
+ #
853
+ class ListMedicalVocabulariesResponse < Struct.new(
854
+ :status,
855
+ :next_token,
856
+ :vocabularies)
857
+ include Aws::Structure
858
+ end
859
+
515
860
  # @note When making an API call, you may pass ListTranscriptionJobsRequest
516
861
  # data as a hash:
517
862
  #
@@ -611,8 +956,8 @@ module Aws::TranscribeService
611
956
  # @!attribute [rw] name_contains
612
957
  # When specified, the vocabularies returned in the list are limited to
613
958
  # vocabularies whose name contains the specified string. The search is
614
- # case-insensitive, `ListVocabularies` will return both
615
- # "vocabularyname" and "VocabularyName" in the response list.
959
+ # case-insensitive, `ListVocabularies` returns both "vocabularyname"
960
+ # and "VocabularyName" in the response list.
616
961
  # @return [String]
617
962
  #
618
963
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabulariesRequest AWS API Documentation
@@ -678,74 +1023,367 @@ module Aws::TranscribeService
678
1023
  # whose name contains the specified string.
679
1024
  # @return [String]
680
1025
  #
681
- # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFiltersRequest AWS API Documentation
1026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFiltersRequest AWS API Documentation
1027
+ #
1028
+ class ListVocabularyFiltersRequest < Struct.new(
1029
+ :next_token,
1030
+ :max_results,
1031
+ :name_contains)
1032
+ include Aws::Structure
1033
+ end
1034
+
1035
+ # @!attribute [rw] next_token
1036
+ # The `ListVocabularyFilters` operation returns a page of collections
1037
+ # at a time. The maximum size of the page is set by the `MaxResults`
1038
+ # parameter. If there are more jobs in the list than the page size,
1039
+ # Amazon Transcribe returns the `NextPage` token. Include the token in
1040
+ # the next request to the `ListVocabularyFilters` operation to return
1041
+ # in the next page of jobs.
1042
+ # @return [String]
1043
+ #
1044
+ # @!attribute [rw] vocabulary_filters
1045
+ # The list of vocabulary filters. It contains at most `MaxResults`
1046
+ # number of filters. If there are more filters, call the
1047
+ # `ListVocabularyFilters` operation again with the `NextToken`
1048
+ # parameter in the request set to the value of the `NextToken` field
1049
+ # in the response.
1050
+ # @return [Array<Types::VocabularyFilterInfo>]
1051
+ #
1052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFiltersResponse AWS API Documentation
1053
+ #
1054
+ class ListVocabularyFiltersResponse < Struct.new(
1055
+ :next_token,
1056
+ :vocabulary_filters)
1057
+ include Aws::Structure
1058
+ end
1059
+
1060
+ # Describes the input media file in a transcription request.
1061
+ #
1062
+ # @note When making an API call, you may pass Media
1063
+ # data as a hash:
1064
+ #
1065
+ # {
1066
+ # media_file_uri: "Uri",
1067
+ # }
1068
+ #
1069
+ # @!attribute [rw] media_file_uri
1070
+ # The S3 object location of the input media file. The URI must be in
1071
+ # the same region as the API endpoint that you are calling. The
1072
+ # general form is:
1073
+ #
1074
+ # For example:
1075
+ #
1076
+ # For more information about S3 object names, see [Object Keys][1] in
1077
+ # the *Amazon S3 Developer Guide*.
1078
+ #
1079
+ #
1080
+ #
1081
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
1082
+ # @return [String]
1083
+ #
1084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Media AWS API Documentation
1085
+ #
1086
+ class Media < Struct.new(
1087
+ :media_file_uri)
1088
+ include Aws::Structure
1089
+ end
1090
+
1091
+ # Identifies the location of a medical transcript.
1092
+ #
1093
+ # @!attribute [rw] transcript_file_uri
1094
+ # The S3 object location of the medical transcript.
1095
+ #
1096
+ # Use this URI to access the medical transcript. This URI points to
1097
+ # the S3 bucket you created to store the medical transcript.
1098
+ # @return [String]
1099
+ #
1100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscript AWS API Documentation
1101
+ #
1102
+ class MedicalTranscript < Struct.new(
1103
+ :transcript_file_uri)
1104
+ include Aws::Structure
1105
+ end
1106
+
1107
+ # The data structure that containts the information for a medical
1108
+ # transcription job.
1109
+ #
1110
+ # @!attribute [rw] medical_transcription_job_name
1111
+ # The name for a given medical transcription job.
1112
+ # @return [String]
1113
+ #
1114
+ # @!attribute [rw] transcription_job_status
1115
+ # The completion status of a medical transcription job.
1116
+ # @return [String]
1117
+ #
1118
+ # @!attribute [rw] language_code
1119
+ # The language code for the language spoken in the source audio file.
1120
+ # US English (en-US) is the only supported language for medical
1121
+ # transcriptions. Any other value you enter for language code results
1122
+ # in a `BadRequestException` error.
1123
+ # @return [String]
1124
+ #
1125
+ # @!attribute [rw] media_sample_rate_hertz
1126
+ # The sample rate, in Hertz, of the source audio containing medical
1127
+ # information.
1128
+ #
1129
+ # If you don't specify the sample rate, Amazon Transcribe Medical
1130
+ # determines it for you. If you choose to specify the sample rate, it
1131
+ # must match the rate detected by Amazon Transcribe Medical. In most
1132
+ # cases, you should leave the `MediaSampleHertz` blank and let Amazon
1133
+ # Transcribe Medical determine the sample rate.
1134
+ # @return [Integer]
1135
+ #
1136
+ # @!attribute [rw] media_format
1137
+ # The format of the input media file.
1138
+ # @return [String]
1139
+ #
1140
+ # @!attribute [rw] media
1141
+ # Describes the input media file in a transcription request.
1142
+ # @return [Types::Media]
1143
+ #
1144
+ # @!attribute [rw] transcript
1145
+ # An object that contains the `MedicalTranscript`. The
1146
+ # `MedicalTranscript` contains the `TranscriptFileUri`.
1147
+ # @return [Types::MedicalTranscript]
1148
+ #
1149
+ # @!attribute [rw] start_time
1150
+ # A timestamp that shows when the job started processing.
1151
+ # @return [Time]
1152
+ #
1153
+ # @!attribute [rw] creation_time
1154
+ # A timestamp that shows when the job was created.
1155
+ # @return [Time]
1156
+ #
1157
+ # @!attribute [rw] completion_time
1158
+ # A timestamp that shows when the job was completed.
1159
+ # @return [Time]
1160
+ #
1161
+ # @!attribute [rw] failure_reason
1162
+ # If the `TranscriptionJobStatus` field is `FAILED`, this field
1163
+ # contains information about why the job failed.
1164
+ #
1165
+ # The `FailureReason` field contains one of the following values:
1166
+ #
1167
+ # * `Unsupported media format`- The media format specified in the
1168
+ # `MediaFormat` field of the request isn't valid. See the
1169
+ # description of the `MediaFormat` field for a list of valid values.
1170
+ #
1171
+ # * `The media format provided does not match the detected media
1172
+ # format`- The media format of the audio file doesn't match the
1173
+ # format specified in the `MediaFormat` field in the request. Check
1174
+ # the media format of your media file and make sure the two values
1175
+ # match.
1176
+ #
1177
+ # * `Invalid sample rate for audio file`- The sample rate specified in
1178
+ # the `MediaSampleRateHertz` of the request isn't valid. The sample
1179
+ # rate must be between 8000 and 48000 Hertz.
1180
+ #
1181
+ # * `The sample rate provided does not match the detected sample
1182
+ # rate`- The sample rate in the audio file doesn't match the sample
1183
+ # rate specified in the `MediaSampleRateHertz` field in the request.
1184
+ # Check the sample rate of your media file and make sure that the
1185
+ # two values match.
1186
+ #
1187
+ # * `Invalid file size: file size too large`- The size of your audio
1188
+ # file is larger than what Amazon Transcribe Medical can process.
1189
+ # For more information, see [Guidlines and Quotas][1] in the *Amazon
1190
+ # Transcribe Medical Guide*
1191
+ #
1192
+ # * `Invalid number of channels: number of channels too large`- Your
1193
+ # audio contains more channels than Amazon Transcribe Medical is
1194
+ # configured to process. To request additional channels, see [Amazon
1195
+ # Transcribe Medical Endpoints and Quotas][2] in the *Amazon Web
1196
+ # Services General Reference*
1197
+ #
1198
+ #
1199
+ #
1200
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits
1201
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html
1202
+ # @return [String]
1203
+ #
1204
+ # @!attribute [rw] settings
1205
+ # Object that contains object.
1206
+ # @return [Types::MedicalTranscriptionSetting]
1207
+ #
1208
+ # @!attribute [rw] specialty
1209
+ # The medical specialty of any clinicians providing a dictation or
1210
+ # having a conversation. `PRIMARYCARE` is the only available setting
1211
+ # for this object. This specialty enables you to generate
1212
+ # transcriptions for the following medical fields:
1213
+ #
1214
+ # * Family Medicine
1215
+ #
1216
+ # ^
1217
+ # @return [String]
1218
+ #
1219
+ # @!attribute [rw] type
1220
+ # The type of speech in the transcription job. `CONVERSATION` is
1221
+ # generally used for patient-physician dialogues. `DICTATION` is the
1222
+ # setting for physicians speaking their notes after seeing a patient.
1223
+ # For more information, see how-it-works-med
1224
+ # @return [String]
1225
+ #
1226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionJob AWS API Documentation
1227
+ #
1228
+ class MedicalTranscriptionJob < Struct.new(
1229
+ :medical_transcription_job_name,
1230
+ :transcription_job_status,
1231
+ :language_code,
1232
+ :media_sample_rate_hertz,
1233
+ :media_format,
1234
+ :media,
1235
+ :transcript,
1236
+ :start_time,
1237
+ :creation_time,
1238
+ :completion_time,
1239
+ :failure_reason,
1240
+ :settings,
1241
+ :specialty,
1242
+ :type)
1243
+ include Aws::Structure
1244
+ end
1245
+
1246
+ # Provides summary information about a transcription job.
1247
+ #
1248
+ # @!attribute [rw] medical_transcription_job_name
1249
+ # The name of a medical transcription job.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] creation_time
1253
+ # A timestamp that shows when the medical transcription job was
1254
+ # created.
1255
+ # @return [Time]
1256
+ #
1257
+ # @!attribute [rw] start_time
1258
+ # A timestamp that shows when the job began processing.
1259
+ # @return [Time]
1260
+ #
1261
+ # @!attribute [rw] completion_time
1262
+ # A timestamp that shows when the job was completed.
1263
+ # @return [Time]
1264
+ #
1265
+ # @!attribute [rw] language_code
1266
+ # The language of the transcript in the source audio file.
1267
+ # @return [String]
1268
+ #
1269
+ # @!attribute [rw] transcription_job_status
1270
+ # The status of the medical transcription job.
1271
+ # @return [String]
1272
+ #
1273
+ # @!attribute [rw] failure_reason
1274
+ # If the `TranscriptionJobStatus` field is `FAILED`, a description of
1275
+ # the error.
1276
+ # @return [String]
1277
+ #
1278
+ # @!attribute [rw] output_location_type
1279
+ # Indicates the location of the transcription job's output.
682
1280
  #
683
- class ListVocabularyFiltersRequest < Struct.new(
684
- :next_token,
685
- :max_results,
686
- :name_contains)
687
- include Aws::Structure
688
- end
689
-
690
- # @!attribute [rw] next_token
691
- # The `ListVocabularyFilters` operation returns a page of collections
692
- # at a time. The maximum size of the page is set by the `MaxResults`
693
- # parameter. If there are more jobs in the list than the page size,
694
- # Amazon Transcribe returns the `NextPage` token. Include the token in
695
- # the next request to the `ListVocabularyFilters` operation to return
696
- # in the next page of jobs.
1281
+ # The `CUSTOMER_BUCKET` is the S3 location provided in the
1282
+ # `OutputBucketName` field when the
697
1283
  # @return [String]
698
1284
  #
699
- # @!attribute [rw] vocabulary_filters
700
- # The list of vocabulary filters. It will contain at most `MaxResults`
701
- # number of filters. If there are more filters, call the
702
- # `ListVocabularyFilters` operation again with the `NextToken`
703
- # parameter in the request set to the value of the `NextToken` field
704
- # in the response.
705
- # @return [Array<Types::VocabularyFilterInfo>]
1285
+ # @!attribute [rw] specialty
1286
+ # The medical specialty of the transcription job. `Primary care` is
1287
+ # the only valid value.
1288
+ # @return [String]
706
1289
  #
707
- # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFiltersResponse AWS API Documentation
1290
+ # @!attribute [rw] type
1291
+ # The speech of the clinician in the input audio.
1292
+ # @return [String]
708
1293
  #
709
- class ListVocabularyFiltersResponse < Struct.new(
710
- :next_token,
711
- :vocabulary_filters)
1294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionJobSummary AWS API Documentation
1295
+ #
1296
+ class MedicalTranscriptionJobSummary < Struct.new(
1297
+ :medical_transcription_job_name,
1298
+ :creation_time,
1299
+ :start_time,
1300
+ :completion_time,
1301
+ :language_code,
1302
+ :transcription_job_status,
1303
+ :failure_reason,
1304
+ :output_location_type,
1305
+ :specialty,
1306
+ :type)
712
1307
  include Aws::Structure
713
1308
  end
714
1309
 
715
- # Describes the input media file in a transcription request.
1310
+ # Optional settings for the StartMedicalTranscriptionJob operation.
716
1311
  #
717
- # @note When making an API call, you may pass Media
1312
+ # @note When making an API call, you may pass MedicalTranscriptionSetting
718
1313
  # data as a hash:
719
1314
  #
720
1315
  # {
721
- # media_file_uri: "Uri",
1316
+ # show_speaker_labels: false,
1317
+ # max_speaker_labels: 1,
1318
+ # channel_identification: false,
1319
+ # show_alternatives: false,
1320
+ # max_alternatives: 1,
1321
+ # vocabulary_name: "VocabularyName",
722
1322
  # }
723
1323
  #
724
- # @!attribute [rw] media_file_uri
725
- # The S3 object location of the input media file. The URI must be in
726
- # the same region as the API endpoint that you are calling. The
727
- # general form is:
1324
+ # @!attribute [rw] show_speaker_labels
1325
+ # Determines whether the transcription job uses speaker recognition to
1326
+ # identify different speakers in the input audio. Speaker recongition
1327
+ # labels individual speakers in the audio file. If you set the
1328
+ # `ShowSpeakerLabels` field to true, you must also set the maximum
1329
+ # number of speaker labels in the `MaxSpeakerLabels` field.
728
1330
  #
729
- # ` s3://<bucket-name>/<keyprefix>/<objectkey> `
1331
+ # You can't set both `ShowSpeakerLabels` and `ChannelIdentification`
1332
+ # in the same request. If you set both, your request returns a
1333
+ # `BadRequestException`.
1334
+ # @return [Boolean]
730
1335
  #
731
- # For example:
1336
+ # @!attribute [rw] max_speaker_labels
1337
+ # The maximum number of speakers to identify in the input audio. If
1338
+ # there are more speakers in the audio than this number, multiple
1339
+ # speakers are identified as a single speaker. If you specify the
1340
+ # `MaxSpeakerLabels` field, you must set the `ShowSpeakerLabels` field
1341
+ # to true.
1342
+ # @return [Integer]
732
1343
  #
733
- # `s3://examplebucket/example.mp4`
1344
+ # @!attribute [rw] channel_identification
1345
+ # Instructs Amazon Transcribe Medical to process each audio channel
1346
+ # separately and then merge the transcription output of each channel
1347
+ # into a single transcription.
734
1348
  #
735
- # `s3://examplebucket/mediadocs/example.mp4`
1349
+ # Amazon Transcribe Medical also produces a transcription of each item
1350
+ # detected on an audio channel, including the start time and end time
1351
+ # of the item and alternative transcriptions of item. The alternative
1352
+ # transcriptions also come with confidence scores provided by Amazon
1353
+ # Transcribe Medical.
736
1354
  #
737
- # For more information about S3 object names, see [Object Keys][1] in
738
- # the *Amazon S3 Developer Guide*.
1355
+ # You can't set both `ShowSpeakerLabels` and `ChannelIdentification`
1356
+ # in the same request. If you set both, your request returns a
1357
+ # `BadRequestException`
1358
+ # @return [Boolean]
739
1359
  #
1360
+ # @!attribute [rw] show_alternatives
1361
+ # Determines whether alternative transcripts are generated along with
1362
+ # the transcript that has the highest confidence. If you set
1363
+ # `ShowAlternatives` field to true, you must also set the maximum
1364
+ # number of alternatives to return in the `MaxAlternatives` field.
1365
+ # @return [Boolean]
740
1366
  #
1367
+ # @!attribute [rw] max_alternatives
1368
+ # The maximum number of alternatives that you tell the service to
1369
+ # return. If you specify the `MaxAlternatives` field, you must set the
1370
+ # `ShowAlternatives` field to true.
1371
+ # @return [Integer]
741
1372
  #
742
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
1373
+ # @!attribute [rw] vocabulary_name
1374
+ # The name of the vocabulary to use when processing a medical
1375
+ # transcription job.
743
1376
  # @return [String]
744
1377
  #
745
- # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Media AWS API Documentation
1378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionSetting AWS API Documentation
746
1379
  #
747
- class Media < Struct.new(
748
- :media_file_uri)
1380
+ class MedicalTranscriptionSetting < Struct.new(
1381
+ :show_speaker_labels,
1382
+ :max_speaker_labels,
1383
+ :channel_identification,
1384
+ :show_alternatives,
1385
+ :max_alternatives,
1386
+ :vocabulary_name)
749
1387
  include Aws::Structure
750
1388
  end
751
1389
 
@@ -798,7 +1436,7 @@ module Aws::TranscribeService
798
1436
  # @!attribute [rw] max_speaker_labels
799
1437
  # The maximum number of speakers to identify in the input audio. If
800
1438
  # there are more speakers in the audio than this number, multiple
801
- # speakers will be identified as a single speaker. If you specify the
1439
+ # speakers are identified as a single speaker. If you specify the
802
1440
  # `MaxSpeakerLabels` field, you must set the `ShowSpeakerLabels` field
803
1441
  # to true.
804
1442
  # @return [Integer]
@@ -858,6 +1496,161 @@ module Aws::TranscribeService
858
1496
  include Aws::Structure
859
1497
  end
860
1498
 
1499
+ # @note When making an API call, you may pass StartMedicalTranscriptionJobRequest
1500
+ # data as a hash:
1501
+ #
1502
+ # {
1503
+ # medical_transcription_job_name: "TranscriptionJobName", # required
1504
+ # language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
1505
+ # media_sample_rate_hertz: 1,
1506
+ # media_format: "mp3", # accepts mp3, mp4, wav, flac
1507
+ # media: { # required
1508
+ # media_file_uri: "Uri",
1509
+ # },
1510
+ # output_bucket_name: "OutputBucketName", # required
1511
+ # output_encryption_kms_key_id: "KMSKeyId",
1512
+ # settings: {
1513
+ # show_speaker_labels: false,
1514
+ # max_speaker_labels: 1,
1515
+ # channel_identification: false,
1516
+ # show_alternatives: false,
1517
+ # max_alternatives: 1,
1518
+ # vocabulary_name: "VocabularyName",
1519
+ # },
1520
+ # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
1521
+ # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
1522
+ # }
1523
+ #
1524
+ # @!attribute [rw] medical_transcription_job_name
1525
+ # The name of the medical transcription job. You can't use the
1526
+ # strings "." or ".." by themselves as the job name. The name must
1527
+ # also be unique within an AWS account. If you try to create a medical
1528
+ # transcription job with the same name as a previous medical
1529
+ # transcription job you will receive a `ConflictException` error.
1530
+ # @return [String]
1531
+ #
1532
+ # @!attribute [rw] language_code
1533
+ # The language code for the language spoken in the input media file.
1534
+ # US English (en-US) is the valid value for medical transcription
1535
+ # jobs. Any other value you enter for language code results in a
1536
+ # `BadRequestException` error.
1537
+ # @return [String]
1538
+ #
1539
+ # @!attribute [rw] media_sample_rate_hertz
1540
+ # The sample rate, in Hertz, of the audio track in the input media
1541
+ # file.
1542
+ #
1543
+ # If you do not specify the media sample rate, Amazon Transcribe
1544
+ # Medical determines the sample rate. If you specify the sample rate,
1545
+ # it must match the rate detected by Amazon Transcribe Medical. In
1546
+ # most cases, you should leave the `MediaSampleRateHertz` field blank
1547
+ # and let Amazon Transcribe Medical determine the sample rate.
1548
+ # @return [Integer]
1549
+ #
1550
+ # @!attribute [rw] media_format
1551
+ # The audio format of the input media file.
1552
+ # @return [String]
1553
+ #
1554
+ # @!attribute [rw] media
1555
+ # Describes the input media file in a transcription request.
1556
+ # @return [Types::Media]
1557
+ #
1558
+ # @!attribute [rw] output_bucket_name
1559
+ # The Amazon S3 location where the transcription is stored.
1560
+ #
1561
+ # You must set `OutputBucketName` for Amazon Transcribe Medical to
1562
+ # store the transcription results. Your transcript appears in the S3
1563
+ # location you specify. When you call the GetMedicalTranscriptionJob,
1564
+ # the operation returns this location in the `TranscriptFileUri`
1565
+ # field. The S3 bucket must have permissions that allow Amazon
1566
+ # Transcribe Medical to put files in the bucket. For more information,
1567
+ # see [Permissions Required for IAM User Roles][1].
1568
+ #
1569
+ # You can specify an AWS Key Management Service (KMS) key to encrypt
1570
+ # the output of your transcription using the
1571
+ # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
1572
+ # key, Amazon Transcribe Medical uses the default Amazon S3 key for
1573
+ # server-side encryption of transcripts that are placed in your S3
1574
+ # bucket.
1575
+ #
1576
+ #
1577
+ #
1578
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
1579
+ # @return [String]
1580
+ #
1581
+ # @!attribute [rw] output_encryption_kms_key_id
1582
+ # The Amazon Resource Name (ARN) of the AWS Key Management Service
1583
+ # (KMS) key used to encrypt the output of the transcription job. The
1584
+ # user calling the StartMedicalTranscriptionJob operation must have
1585
+ # permission to use the specified KMS key.
1586
+ #
1587
+ # You use either of the following to identify a KMS key in the current
1588
+ # account:
1589
+ #
1590
+ # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
1591
+ #
1592
+ # * KMS Key Alias: "alias/ExampleAlias"
1593
+ #
1594
+ # You can use either of the following to identify a KMS key in the
1595
+ # current account or another account:
1596
+ #
1597
+ # * Amazon Resource Name (ARN) of a KMS key in the current account or
1598
+ # another account: "arn:aws:kms:region:account
1599
+ # ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
1600
+ #
1601
+ # * ARN of a KMS Key Alias: "arn:aws:kms:region:account
1602
+ # ID:alias/ExampleAlias"
1603
+ #
1604
+ # If you don't specify an encryption key, the output of the medical
1605
+ # transcription job is encrypted with the default Amazon S3 key
1606
+ # (SSE-S3).
1607
+ #
1608
+ # If you specify a KMS key to encrypt your output, you must also
1609
+ # specify an output location in the `OutputBucketName` parameter.
1610
+ # @return [String]
1611
+ #
1612
+ # @!attribute [rw] settings
1613
+ # Optional settings for the medical transcription job.
1614
+ # @return [Types::MedicalTranscriptionSetting]
1615
+ #
1616
+ # @!attribute [rw] specialty
1617
+ # The medical specialty of any clinician speaking in the input media.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] type
1621
+ # The type of speech in the input audio. `CONVERSATION` refers to
1622
+ # conversations between two or more speakers, e.g., a conversations
1623
+ # between doctors and patients. `DICTATION` refers to single-speaker
1624
+ # dictated speech, e.g., for clinical notes.
1625
+ # @return [String]
1626
+ #
1627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJobRequest AWS API Documentation
1628
+ #
1629
+ class StartMedicalTranscriptionJobRequest < Struct.new(
1630
+ :medical_transcription_job_name,
1631
+ :language_code,
1632
+ :media_sample_rate_hertz,
1633
+ :media_format,
1634
+ :media,
1635
+ :output_bucket_name,
1636
+ :output_encryption_kms_key_id,
1637
+ :settings,
1638
+ :specialty,
1639
+ :type)
1640
+ include Aws::Structure
1641
+ end
1642
+
1643
+ # @!attribute [rw] medical_transcription_job
1644
+ # A batch job submitted to transcribe medical speech to text.
1645
+ # @return [Types::MedicalTranscriptionJob]
1646
+ #
1647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJobResponse AWS API Documentation
1648
+ #
1649
+ class StartMedicalTranscriptionJobResponse < Struct.new(
1650
+ :medical_transcription_job)
1651
+ include Aws::Structure
1652
+ end
1653
+
861
1654
  # @note When making an API call, you may pass StartTranscriptionJobRequest
862
1655
  # data as a hash:
863
1656
  #
@@ -894,7 +1687,9 @@ module Aws::TranscribeService
894
1687
  # @!attribute [rw] transcription_job_name
895
1688
  # The name of the job. Note that you can't use the strings "." or
896
1689
  # ".." by themselves as the job name. The name must also be unique
897
- # within an AWS account.
1690
+ # within an AWS account. If you try to create a transcription job with
1691
+ # the same name as a previous transcription job you will receive a
1692
+ # `ConflictException` error.
898
1693
  # @return [String]
899
1694
  #
900
1695
  # @!attribute [rw] language_code
@@ -1243,6 +2038,92 @@ module Aws::TranscribeService
1243
2038
  include Aws::Structure
1244
2039
  end
1245
2040
 
2041
+ # @note When making an API call, you may pass UpdateMedicalVocabularyRequest
2042
+ # data as a hash:
2043
+ #
2044
+ # {
2045
+ # vocabulary_name: "VocabularyName", # required
2046
+ # language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
2047
+ # vocabulary_file_uri: "Uri",
2048
+ # }
2049
+ #
2050
+ # @!attribute [rw] vocabulary_name
2051
+ # The name of the vocabulary to update. The name is case-sensitive. If
2052
+ # you try to update a vocabulary with the same name as a previous
2053
+ # vocabulary you will receive a `ConflictException` error.
2054
+ # @return [String]
2055
+ #
2056
+ # @!attribute [rw] language_code
2057
+ # The language code of the entries in the updated vocabulary. US
2058
+ # English (en-US) is the only valid language code in Amazon Transcribe
2059
+ # Medical.
2060
+ # @return [String]
2061
+ #
2062
+ # @!attribute [rw] vocabulary_file_uri
2063
+ # The Amazon S3 location of the text file containing the definition of
2064
+ # the custom vocabulary. The URI must be in the same AWS region as the
2065
+ # API endpoint you are calling. You can see the fields you need to
2066
+ # enter for you Amazon S3 location in the example URI here:
2067
+ #
2068
+ # `
2069
+ # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
2070
+ # `
2071
+ #
2072
+ # For example:
2073
+ #
2074
+ # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
2075
+ #
2076
+ # For more information about S3 object names, see [Object Keys][1] in
2077
+ # the *Amazon S3 Developer Guide*.
2078
+ #
2079
+ # For more information about custom vocabularies in Amazon Transcribe
2080
+ # Medical, see [Medical Custom Vocabularies][2].
2081
+ #
2082
+ #
2083
+ #
2084
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
2085
+ # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary
2086
+ # @return [String]
2087
+ #
2088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabularyRequest AWS API Documentation
2089
+ #
2090
+ class UpdateMedicalVocabularyRequest < Struct.new(
2091
+ :vocabulary_name,
2092
+ :language_code,
2093
+ :vocabulary_file_uri)
2094
+ include Aws::Structure
2095
+ end
2096
+
2097
+ # @!attribute [rw] vocabulary_name
2098
+ # The name of the updated vocabulary.
2099
+ # @return [String]
2100
+ #
2101
+ # @!attribute [rw] language_code
2102
+ # The language code for the text file used to update the custom
2103
+ # vocabulary. US English (en-US) is the only language supported in
2104
+ # Amazon Transcribe Medical.
2105
+ # @return [String]
2106
+ #
2107
+ # @!attribute [rw] last_modified_time
2108
+ # The date and time the vocabulary was updated.
2109
+ # @return [Time]
2110
+ #
2111
+ # @!attribute [rw] vocabulary_state
2112
+ # The processing state of the update to the vocabulary. When the
2113
+ # `VocabularyState` field is `READY` the vocabulary is ready to be
2114
+ # used in a `StartMedicalTranscriptionJob` request.
2115
+ # @return [String]
2116
+ #
2117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabularyResponse AWS API Documentation
2118
+ #
2119
+ class UpdateMedicalVocabularyResponse < Struct.new(
2120
+ :vocabulary_name,
2121
+ :language_code,
2122
+ :last_modified_time,
2123
+ :vocabulary_state)
2124
+ include Aws::Structure
2125
+ end
2126
+
1246
2127
  # @note When making an API call, you may pass UpdateVocabularyFilterRequest
1247
2128
  # data as a hash:
1248
2129
  #
@@ -1253,7 +2134,9 @@ module Aws::TranscribeService
1253
2134
  # }
1254
2135
  #
1255
2136
  # @!attribute [rw] vocabulary_filter_name
1256
- # The name of the vocabulary filter to update.
2137
+ # The name of the vocabulary filter to update. If you try to update a
2138
+ # vocabulary filter with the same name as a previous vocabulary filter
2139
+ # you will receive a `ConflictException` error.
1257
2140
  # @return [String]
1258
2141
  #
1259
2142
  # @!attribute [rw] words
@@ -1327,7 +2210,9 @@ module Aws::TranscribeService
1327
2210
  # }
1328
2211
  #
1329
2212
  # @!attribute [rw] vocabulary_name
1330
- # The name of the vocabulary to update. The name is case-sensitive.
2213
+ # The name of the vocabulary to update. The name is case-sensitive. If
2214
+ # you try to update a vocabulary with the same name as a previous
2215
+ # vocabulary you will receive a `ConflictException` error.
1331
2216
  # @return [String]
1332
2217
  #
1333
2218
  # @!attribute [rw] language_code
@@ -1343,14 +2228,8 @@ module Aws::TranscribeService
1343
2228
  # custom vocabulary. The URI must be in the same region as the API
1344
2229
  # endpoint that you are calling. The general form is
1345
2230
  #
1346
- # `
1347
- # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
1348
- # `
1349
- #
1350
2231
  # For example:
1351
2232
  #
1352
- # `https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt`
1353
- #
1354
2233
  # For more information about S3 object names, see [Object Keys][1] in
1355
2234
  # the *Amazon S3 Developer Guide*.
1356
2235
  #