aws-sdk-transcribeservice 1.58.0 → 1.59.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transcribeservice/client.rb +226 -50
- data/lib/aws-sdk-transcribeservice/client_api.rb +85 -0
- data/lib/aws-sdk-transcribeservice/types.rb +313 -159
- data/lib/aws-sdk-transcribeservice.rb +1 -1
- metadata +2 -2
@@ -91,6 +91,8 @@ module Aws::TranscribeService
|
|
91
91
|
ListMedicalTranscriptionJobsResponse = Shapes::StructureShape.new(name: 'ListMedicalTranscriptionJobsResponse')
|
92
92
|
ListMedicalVocabulariesRequest = Shapes::StructureShape.new(name: 'ListMedicalVocabulariesRequest')
|
93
93
|
ListMedicalVocabulariesResponse = Shapes::StructureShape.new(name: 'ListMedicalVocabulariesResponse')
|
94
|
+
ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
|
95
|
+
ListTagsForResourceResponse = Shapes::StructureShape.new(name: 'ListTagsForResourceResponse')
|
94
96
|
ListTranscriptionJobsRequest = Shapes::StructureShape.new(name: 'ListTranscriptionJobsRequest')
|
95
97
|
ListTranscriptionJobsResponse = Shapes::StructureShape.new(name: 'ListTranscriptionJobsResponse')
|
96
98
|
ListVocabulariesRequest = Shapes::StructureShape.new(name: 'ListVocabulariesRequest')
|
@@ -142,7 +144,15 @@ module Aws::TranscribeService
|
|
142
144
|
StartTranscriptionJobResponse = Shapes::StructureShape.new(name: 'StartTranscriptionJobResponse')
|
143
145
|
String = Shapes::StringShape.new(name: 'String')
|
144
146
|
StringTargetList = Shapes::ListShape.new(name: 'StringTargetList')
|
147
|
+
Tag = Shapes::StructureShape.new(name: 'Tag')
|
148
|
+
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
149
|
+
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
150
|
+
TagList = Shapes::ListShape.new(name: 'TagList')
|
151
|
+
TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
|
152
|
+
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
153
|
+
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
145
154
|
TimestampMilliseconds = Shapes::IntegerShape.new(name: 'TimestampMilliseconds')
|
155
|
+
TranscribeArn = Shapes::StringShape.new(name: 'TranscribeArn')
|
146
156
|
Transcript = Shapes::StructureShape.new(name: 'Transcript')
|
147
157
|
TranscriptFilter = Shapes::StructureShape.new(name: 'TranscriptFilter')
|
148
158
|
TranscriptFilterType = Shapes::StringShape.new(name: 'TranscriptFilterType')
|
@@ -152,6 +162,8 @@ module Aws::TranscribeService
|
|
152
162
|
TranscriptionJobSummaries = Shapes::ListShape.new(name: 'TranscriptionJobSummaries')
|
153
163
|
TranscriptionJobSummary = Shapes::StructureShape.new(name: 'TranscriptionJobSummary')
|
154
164
|
Type = Shapes::StringShape.new(name: 'Type')
|
165
|
+
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
166
|
+
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
155
167
|
UpdateCallAnalyticsCategoryRequest = Shapes::StructureShape.new(name: 'UpdateCallAnalyticsCategoryRequest')
|
156
168
|
UpdateCallAnalyticsCategoryResponse = Shapes::StructureShape.new(name: 'UpdateCallAnalyticsCategoryResponse')
|
157
169
|
UpdateMedicalVocabularyRequest = Shapes::StructureShape.new(name: 'UpdateMedicalVocabularyRequest')
|
@@ -249,6 +261,7 @@ module Aws::TranscribeService
|
|
249
261
|
CreateLanguageModelRequest.add_member(:base_model_name, Shapes::ShapeRef.new(shape: BaseModelName, required: true, location_name: "BaseModelName"))
|
250
262
|
CreateLanguageModelRequest.add_member(:model_name, Shapes::ShapeRef.new(shape: ModelName, required: true, location_name: "ModelName"))
|
251
263
|
CreateLanguageModelRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, required: true, location_name: "InputDataConfig"))
|
264
|
+
CreateLanguageModelRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
252
265
|
CreateLanguageModelRequest.struct_class = Types::CreateLanguageModelRequest
|
253
266
|
|
254
267
|
CreateLanguageModelResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: CLMLanguageCode, location_name: "LanguageCode"))
|
@@ -261,6 +274,7 @@ module Aws::TranscribeService
|
|
261
274
|
CreateMedicalVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
|
262
275
|
CreateMedicalVocabularyRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
263
276
|
CreateMedicalVocabularyRequest.add_member(:vocabulary_file_uri, Shapes::ShapeRef.new(shape: Uri, required: true, location_name: "VocabularyFileUri"))
|
277
|
+
CreateMedicalVocabularyRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
264
278
|
CreateMedicalVocabularyRequest.struct_class = Types::CreateMedicalVocabularyRequest
|
265
279
|
|
266
280
|
CreateMedicalVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
|
@@ -274,6 +288,7 @@ module Aws::TranscribeService
|
|
274
288
|
CreateVocabularyFilterRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
275
289
|
CreateVocabularyFilterRequest.add_member(:words, Shapes::ShapeRef.new(shape: Words, location_name: "Words"))
|
276
290
|
CreateVocabularyFilterRequest.add_member(:vocabulary_filter_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "VocabularyFilterFileUri"))
|
291
|
+
CreateVocabularyFilterRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
277
292
|
CreateVocabularyFilterRequest.struct_class = Types::CreateVocabularyFilterRequest
|
278
293
|
|
279
294
|
CreateVocabularyFilterResponse.add_member(:vocabulary_filter_name, Shapes::ShapeRef.new(shape: VocabularyFilterName, location_name: "VocabularyFilterName"))
|
@@ -285,6 +300,7 @@ module Aws::TranscribeService
|
|
285
300
|
CreateVocabularyRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
286
301
|
CreateVocabularyRequest.add_member(:phrases, Shapes::ShapeRef.new(shape: Phrases, location_name: "Phrases"))
|
287
302
|
CreateVocabularyRequest.add_member(:vocabulary_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "VocabularyFileUri"))
|
303
|
+
CreateVocabularyRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
288
304
|
CreateVocabularyRequest.struct_class = Types::CreateVocabularyRequest
|
289
305
|
|
290
306
|
CreateVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
|
@@ -469,6 +485,13 @@ module Aws::TranscribeService
|
|
469
485
|
ListMedicalVocabulariesResponse.add_member(:vocabularies, Shapes::ShapeRef.new(shape: Vocabularies, location_name: "Vocabularies"))
|
470
486
|
ListMedicalVocabulariesResponse.struct_class = Types::ListMedicalVocabulariesResponse
|
471
487
|
|
488
|
+
ListTagsForResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: TranscribeArn, required: true, location_name: "ResourceArn"))
|
489
|
+
ListTagsForResourceRequest.struct_class = Types::ListTagsForResourceRequest
|
490
|
+
|
491
|
+
ListTagsForResourceResponse.add_member(:resource_arn, Shapes::ShapeRef.new(shape: TranscribeArn, location_name: "ResourceArn"))
|
492
|
+
ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
493
|
+
ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse
|
494
|
+
|
472
495
|
ListTranscriptionJobsRequest.add_member(:status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "Status"))
|
473
496
|
ListTranscriptionJobsRequest.add_member(:job_name_contains, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "JobNameContains"))
|
474
497
|
ListTranscriptionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
@@ -522,6 +545,7 @@ module Aws::TranscribeService
|
|
522
545
|
MedicalTranscriptionJob.add_member(:content_identification_type, Shapes::ShapeRef.new(shape: MedicalContentIdentificationType, location_name: "ContentIdentificationType"))
|
523
546
|
MedicalTranscriptionJob.add_member(:specialty, Shapes::ShapeRef.new(shape: Specialty, location_name: "Specialty"))
|
524
547
|
MedicalTranscriptionJob.add_member(:type, Shapes::ShapeRef.new(shape: Type, location_name: "Type"))
|
548
|
+
MedicalTranscriptionJob.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
525
549
|
MedicalTranscriptionJob.struct_class = Types::MedicalTranscriptionJob
|
526
550
|
|
527
551
|
MedicalTranscriptionJobSummaries.member = Shapes::ShapeRef.new(shape: MedicalTranscriptionJobSummary)
|
@@ -626,6 +650,7 @@ module Aws::TranscribeService
|
|
626
650
|
StartMedicalTranscriptionJobRequest.add_member(:content_identification_type, Shapes::ShapeRef.new(shape: MedicalContentIdentificationType, location_name: "ContentIdentificationType"))
|
627
651
|
StartMedicalTranscriptionJobRequest.add_member(:specialty, Shapes::ShapeRef.new(shape: Specialty, required: true, location_name: "Specialty"))
|
628
652
|
StartMedicalTranscriptionJobRequest.add_member(:type, Shapes::ShapeRef.new(shape: Type, required: true, location_name: "Type"))
|
653
|
+
StartMedicalTranscriptionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
629
654
|
StartMedicalTranscriptionJobRequest.struct_class = Types::StartMedicalTranscriptionJobRequest
|
630
655
|
|
631
656
|
StartMedicalTranscriptionJobResponse.add_member(:medical_transcription_job, Shapes::ShapeRef.new(shape: MedicalTranscriptionJob, location_name: "MedicalTranscriptionJob"))
|
@@ -645,6 +670,7 @@ module Aws::TranscribeService
|
|
645
670
|
StartTranscriptionJobRequest.add_member(:content_redaction, Shapes::ShapeRef.new(shape: ContentRedaction, location_name: "ContentRedaction"))
|
646
671
|
StartTranscriptionJobRequest.add_member(:identify_language, Shapes::ShapeRef.new(shape: Boolean, location_name: "IdentifyLanguage"))
|
647
672
|
StartTranscriptionJobRequest.add_member(:language_options, Shapes::ShapeRef.new(shape: LanguageOptions, location_name: "LanguageOptions"))
|
673
|
+
StartTranscriptionJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
648
674
|
StartTranscriptionJobRequest.struct_class = Types::StartTranscriptionJobRequest
|
649
675
|
|
650
676
|
StartTranscriptionJobResponse.add_member(:transcription_job, Shapes::ShapeRef.new(shape: TranscriptionJob, location_name: "TranscriptionJob"))
|
@@ -652,6 +678,20 @@ module Aws::TranscribeService
|
|
652
678
|
|
653
679
|
StringTargetList.member = Shapes::ShapeRef.new(shape: NonEmptyString)
|
654
680
|
|
681
|
+
Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
|
682
|
+
Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "Value"))
|
683
|
+
Tag.struct_class = Types::Tag
|
684
|
+
|
685
|
+
TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey)
|
686
|
+
|
687
|
+
TagList.member = Shapes::ShapeRef.new(shape: Tag)
|
688
|
+
|
689
|
+
TagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: TranscribeArn, required: true, location_name: "ResourceArn"))
|
690
|
+
TagResourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, required: true, location_name: "Tags"))
|
691
|
+
TagResourceRequest.struct_class = Types::TagResourceRequest
|
692
|
+
|
693
|
+
TagResourceResponse.struct_class = Types::TagResourceResponse
|
694
|
+
|
655
695
|
Transcript.add_member(:transcript_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "TranscriptFileUri"))
|
656
696
|
Transcript.add_member(:redacted_transcript_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "RedactedTranscriptFileUri"))
|
657
697
|
Transcript.struct_class = Types::Transcript
|
@@ -682,6 +722,7 @@ module Aws::TranscribeService
|
|
682
722
|
TranscriptionJob.add_member(:identify_language, Shapes::ShapeRef.new(shape: Boolean, location_name: "IdentifyLanguage"))
|
683
723
|
TranscriptionJob.add_member(:language_options, Shapes::ShapeRef.new(shape: LanguageOptions, location_name: "LanguageOptions"))
|
684
724
|
TranscriptionJob.add_member(:identified_language_score, Shapes::ShapeRef.new(shape: IdentifiedLanguageScore, location_name: "IdentifiedLanguageScore"))
|
725
|
+
TranscriptionJob.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
685
726
|
TranscriptionJob.struct_class = Types::TranscriptionJob
|
686
727
|
|
687
728
|
TranscriptionJobSummaries.member = Shapes::ShapeRef.new(shape: TranscriptionJobSummary)
|
@@ -700,6 +741,12 @@ module Aws::TranscribeService
|
|
700
741
|
TranscriptionJobSummary.add_member(:identified_language_score, Shapes::ShapeRef.new(shape: IdentifiedLanguageScore, location_name: "IdentifiedLanguageScore"))
|
701
742
|
TranscriptionJobSummary.struct_class = Types::TranscriptionJobSummary
|
702
743
|
|
744
|
+
UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: TranscribeArn, required: true, location_name: "ResourceArn"))
|
745
|
+
UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location_name: "TagKeys"))
|
746
|
+
UntagResourceRequest.struct_class = Types::UntagResourceRequest
|
747
|
+
|
748
|
+
UntagResourceResponse.struct_class = Types::UntagResourceResponse
|
749
|
+
|
703
750
|
UpdateCallAnalyticsCategoryRequest.add_member(:category_name, Shapes::ShapeRef.new(shape: CategoryName, required: true, location_name: "CategoryName"))
|
704
751
|
UpdateCallAnalyticsCategoryRequest.add_member(:rules, Shapes::ShapeRef.new(shape: RuleList, required: true, location_name: "Rules"))
|
705
752
|
UpdateCallAnalyticsCategoryRequest.struct_class = Types::UpdateCallAnalyticsCategoryRequest
|
@@ -1109,6 +1156,18 @@ module Aws::TranscribeService
|
|
1109
1156
|
)
|
1110
1157
|
end)
|
1111
1158
|
|
1159
|
+
api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
|
1160
|
+
o.name = "ListTagsForResource"
|
1161
|
+
o.http_method = "POST"
|
1162
|
+
o.http_request_uri = "/"
|
1163
|
+
o.input = Shapes::ShapeRef.new(shape: ListTagsForResourceRequest)
|
1164
|
+
o.output = Shapes::ShapeRef.new(shape: ListTagsForResourceResponse)
|
1165
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1166
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1167
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1168
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1169
|
+
end)
|
1170
|
+
|
1112
1171
|
api.add_operation(:list_transcription_jobs, Seahorse::Model::Operation.new.tap do |o|
|
1113
1172
|
o.name = "ListTranscriptionJobs"
|
1114
1173
|
o.http_method = "POST"
|
@@ -1196,6 +1255,32 @@ module Aws::TranscribeService
|
|
1196
1255
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1197
1256
|
end)
|
1198
1257
|
|
1258
|
+
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
1259
|
+
o.name = "TagResource"
|
1260
|
+
o.http_method = "POST"
|
1261
|
+
o.http_request_uri = "/"
|
1262
|
+
o.input = Shapes::ShapeRef.new(shape: TagResourceRequest)
|
1263
|
+
o.output = Shapes::ShapeRef.new(shape: TagResourceResponse)
|
1264
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1265
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1266
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1267
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1268
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1269
|
+
end)
|
1270
|
+
|
1271
|
+
api.add_operation(:untag_resource, Seahorse::Model::Operation.new.tap do |o|
|
1272
|
+
o.name = "UntagResource"
|
1273
|
+
o.http_method = "POST"
|
1274
|
+
o.http_request_uri = "/"
|
1275
|
+
o.input = Shapes::ShapeRef.new(shape: UntagResourceRequest)
|
1276
|
+
o.output = Shapes::ShapeRef.new(shape: UntagResourceResponse)
|
1277
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1278
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
1279
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1280
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
1281
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1282
|
+
end)
|
1283
|
+
|
1199
1284
|
api.add_operation(:update_call_analytics_category, Seahorse::Model::Operation.new.tap do |o|
|
1200
1285
|
o.name = "UpdateCallAnalyticsCategory"
|
1201
1286
|
o.http_method = "POST"
|
@@ -106,52 +106,13 @@ module Aws::TranscribeService
|
|
106
106
|
# Amazon Transcribe will use machine learning to automatically
|
107
107
|
# identify the language. To improve the accuracy of language
|
108
108
|
# identification, you can provide an array containing the possible
|
109
|
-
# language codes for the language spoken in your audio.
|
109
|
+
# language codes for the language spoken in your audio. Refer to
|
110
|
+
# [Supported languages and language-specific features][1] for
|
111
|
+
# additional information.
|
110
112
|
#
|
111
|
-
# The following list shows the supported languages and corresponding
|
112
|
-
# language codes for call analytics jobs:
|
113
113
|
#
|
114
|
-
# * Gulf Arabic (ar-AE)
|
115
114
|
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
# * Australian English (en-AU)
|
119
|
-
#
|
120
|
-
# * British English (en-GB)
|
121
|
-
#
|
122
|
-
# * Indian English (en-IN)
|
123
|
-
#
|
124
|
-
# * Irish English (en-IE)
|
125
|
-
#
|
126
|
-
# * Scottish English (en-AB)
|
127
|
-
#
|
128
|
-
# * US English (en-US)
|
129
|
-
#
|
130
|
-
# * Welsh English (en-WL)
|
131
|
-
#
|
132
|
-
# * Spanish (es-ES)
|
133
|
-
#
|
134
|
-
# * US Spanish (es-US)
|
135
|
-
#
|
136
|
-
# * French (fr-FR)
|
137
|
-
#
|
138
|
-
# * Canadian French (fr-CA)
|
139
|
-
#
|
140
|
-
# * German (de-DE)
|
141
|
-
#
|
142
|
-
# * Swiss German (de-CH)
|
143
|
-
#
|
144
|
-
# * Indian Hindi (hi-IN)
|
145
|
-
#
|
146
|
-
# * Italian (it-IT)
|
147
|
-
#
|
148
|
-
# * Japanese (ja-JP)
|
149
|
-
#
|
150
|
-
# * Korean (ko-KR)
|
151
|
-
#
|
152
|
-
# * Portuguese (pt-PT)
|
153
|
-
#
|
154
|
-
# * Brazilian Portuguese (pt-BR)
|
115
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html
|
155
116
|
# @return [String]
|
156
117
|
#
|
157
118
|
# @!attribute [rw] media_sample_rate_hertz
|
@@ -202,7 +163,7 @@ module Aws::TranscribeService
|
|
202
163
|
#
|
203
164
|
# * `Invalid sample rate for audio file`\: The sample rate specified
|
204
165
|
# in the `MediaSampleRateHertz` of the request isn't valid. The
|
205
|
-
# sample rate must be between
|
166
|
+
# sample rate must be between 8,000 and 48,000 Hertz.
|
206
167
|
#
|
207
168
|
# * `The sample rate provided does not match the detected sample
|
208
169
|
# rate`\: The sample rate in the audio file doesn't match the
|
@@ -213,7 +174,7 @@ module Aws::TranscribeService
|
|
213
174
|
# * `Invalid file size: file size too large`\: The size of your audio
|
214
175
|
# file is larger than what Amazon Transcribe Medical can process.
|
215
176
|
# For more information, see *Guidelines and Quotas* in the Amazon
|
216
|
-
# Transcribe Medical Guide
|
177
|
+
# Transcribe Medical Guide.
|
217
178
|
#
|
218
179
|
# * `Invalid number of channels: number of channels too large`\: Your
|
219
180
|
# audio contains more channels than Amazon Transcribe Medical is
|
@@ -327,52 +288,12 @@ module Aws::TranscribeService
|
|
327
288
|
# Amazon Transcribe will use machine learning to identify the language
|
328
289
|
# for you. To improve the ability of Amazon Transcribe to correctly
|
329
290
|
# identify the language, you can provide an array of the languages
|
330
|
-
# that can be present in the audio.
|
331
|
-
#
|
332
|
-
# The following list shows the supported languages and corresponding
|
333
|
-
# language codes for call analytics jobs:
|
291
|
+
# that can be present in the audio. Refer to [Supported languages and
|
292
|
+
# language-specific features][1] for additional information.
|
334
293
|
#
|
335
|
-
# * Gulf Arabic (ar-AE)
|
336
294
|
#
|
337
|
-
# * Mandarin Chinese, Mainland (zh-CN)
|
338
295
|
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
# * British English (en-GB)
|
342
|
-
#
|
343
|
-
# * Indian English (en-IN)
|
344
|
-
#
|
345
|
-
# * Irish English (en-IE)
|
346
|
-
#
|
347
|
-
# * Scottish English (en-AB)
|
348
|
-
#
|
349
|
-
# * US English (en-US)
|
350
|
-
#
|
351
|
-
# * Welsh English (en-WL)
|
352
|
-
#
|
353
|
-
# * Spanish (es-ES)
|
354
|
-
#
|
355
|
-
# * US Spanish (es-US)
|
356
|
-
#
|
357
|
-
# * French (fr-FR)
|
358
|
-
#
|
359
|
-
# * Canadian French (fr-CA)
|
360
|
-
#
|
361
|
-
# * German (de-DE)
|
362
|
-
#
|
363
|
-
# * Swiss German (de-CH)
|
364
|
-
#
|
365
|
-
# * Indian Hindi (hi-IN)
|
366
|
-
#
|
367
|
-
# * Italian (it-IT)
|
368
|
-
#
|
369
|
-
# * Japanese (ja-JP)
|
370
|
-
#
|
371
|
-
# * Korean (ko-KR)
|
372
|
-
#
|
373
|
-
# * Portuguese (pt-PT)
|
374
|
-
#
|
375
|
-
# * Brazilian Portuguese (pt-BR)
|
296
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html
|
376
297
|
# @return [Array<String>]
|
377
298
|
#
|
378
299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CallAnalyticsJobSettings AWS API Documentation
|
@@ -665,6 +586,12 @@ module Aws::TranscribeService
|
|
665
586
|
# tuning_data_s3_uri: "Uri",
|
666
587
|
# data_access_role_arn: "DataAccessRoleArn", # required
|
667
588
|
# },
|
589
|
+
# tags: [
|
590
|
+
# {
|
591
|
+
# key: "TagKey", # required
|
592
|
+
# value: "TagValue", # required
|
593
|
+
# },
|
594
|
+
# ],
|
668
595
|
# }
|
669
596
|
#
|
670
597
|
# @!attribute [rw] language_code
|
@@ -677,10 +604,10 @@ module Aws::TranscribeService
|
|
677
604
|
# create your custom language model.
|
678
605
|
#
|
679
606
|
# If you want to use your custom language model to transcribe audio
|
680
|
-
# with a sample rate of 16
|
607
|
+
# with a sample rate of 16,000 Hz or greater, choose `Wideband`.
|
681
608
|
#
|
682
609
|
# If you want to use your custom language model to transcribe audio
|
683
|
-
# with a sample rate that is less than 16
|
610
|
+
# with a sample rate that is less than 16,000 Hz, choose `Narrowband`.
|
684
611
|
# @return [String]
|
685
612
|
#
|
686
613
|
# @!attribute [rw] model_name
|
@@ -693,13 +620,19 @@ module Aws::TranscribeService
|
|
693
620
|
# required input files to create a custom language model.
|
694
621
|
# @return [Types::InputDataConfig]
|
695
622
|
#
|
623
|
+
# @!attribute [rw] tags
|
624
|
+
# Adds one or more tags, each in the form of a key:value pair, to a
|
625
|
+
# new language model at the time you create this new model.
|
626
|
+
# @return [Array<Types::Tag>]
|
627
|
+
#
|
696
628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateLanguageModelRequest AWS API Documentation
|
697
629
|
#
|
698
630
|
class CreateLanguageModelRequest < Struct.new(
|
699
631
|
:language_code,
|
700
632
|
:base_model_name,
|
701
633
|
:model_name,
|
702
|
-
:input_data_config
|
634
|
+
:input_data_config,
|
635
|
+
:tags)
|
703
636
|
SENSITIVE = []
|
704
637
|
include Aws::Structure
|
705
638
|
end
|
@@ -747,6 +680,12 @@ module Aws::TranscribeService
|
|
747
680
|
# vocabulary_name: "VocabularyName", # required
|
748
681
|
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
|
749
682
|
# vocabulary_file_uri: "Uri", # required
|
683
|
+
# tags: [
|
684
|
+
# {
|
685
|
+
# key: "TagKey", # required
|
686
|
+
# value: "TagValue", # required
|
687
|
+
# },
|
688
|
+
# ],
|
750
689
|
# }
|
751
690
|
#
|
752
691
|
# @!attribute [rw] vocabulary_name
|
@@ -791,12 +730,18 @@ module Aws::TranscribeService
|
|
791
730
|
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary-med
|
792
731
|
# @return [String]
|
793
732
|
#
|
733
|
+
# @!attribute [rw] tags
|
734
|
+
# Adds one or more tags, each in the form of a key:value pair, to a
|
735
|
+
# new medical vocabulary at the time you create this new vocabulary.
|
736
|
+
# @return [Array<Types::Tag>]
|
737
|
+
#
|
794
738
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabularyRequest AWS API Documentation
|
795
739
|
#
|
796
740
|
class CreateMedicalVocabularyRequest < Struct.new(
|
797
741
|
:vocabulary_name,
|
798
742
|
:language_code,
|
799
|
-
:vocabulary_file_uri
|
743
|
+
:vocabulary_file_uri,
|
744
|
+
:tags)
|
800
745
|
SENSITIVE = []
|
801
746
|
include Aws::Structure
|
802
747
|
end
|
@@ -847,6 +792,12 @@ module Aws::TranscribeService
|
|
847
792
|
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
|
848
793
|
# words: ["Word"],
|
849
794
|
# vocabulary_filter_file_uri: "Uri",
|
795
|
+
# tags: [
|
796
|
+
# {
|
797
|
+
# key: "TagKey", # required
|
798
|
+
# value: "TagValue", # required
|
799
|
+
# },
|
800
|
+
# ],
|
850
801
|
# }
|
851
802
|
#
|
852
803
|
# @!attribute [rw] vocabulary_filter_name
|
@@ -892,13 +843,20 @@ module Aws::TranscribeService
|
|
892
843
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets
|
893
844
|
# @return [String]
|
894
845
|
#
|
846
|
+
# @!attribute [rw] tags
|
847
|
+
# Adds one or more tags, each in the form of a key:value pair, to a
|
848
|
+
# new Amazon Transcribe vocabulary filter at the time you create this
|
849
|
+
# new vocabulary filter.
|
850
|
+
# @return [Array<Types::Tag>]
|
851
|
+
#
|
895
852
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilterRequest AWS API Documentation
|
896
853
|
#
|
897
854
|
class CreateVocabularyFilterRequest < Struct.new(
|
898
855
|
:vocabulary_filter_name,
|
899
856
|
:language_code,
|
900
857
|
:words,
|
901
|
-
:vocabulary_filter_file_uri
|
858
|
+
:vocabulary_filter_file_uri,
|
859
|
+
:tags)
|
902
860
|
SENSITIVE = []
|
903
861
|
include Aws::Structure
|
904
862
|
end
|
@@ -933,6 +891,12 @@ module Aws::TranscribeService
|
|
933
891
|
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
|
934
892
|
# phrases: ["Phrase"],
|
935
893
|
# vocabulary_file_uri: "Uri",
|
894
|
+
# tags: [
|
895
|
+
# {
|
896
|
+
# key: "TagKey", # required
|
897
|
+
# value: "TagValue", # required
|
898
|
+
# },
|
899
|
+
# ],
|
936
900
|
# }
|
937
901
|
#
|
938
902
|
# @!attribute [rw] vocabulary_name
|
@@ -944,7 +908,7 @@ module Aws::TranscribeService
|
|
944
908
|
#
|
945
909
|
# @!attribute [rw] language_code
|
946
910
|
# The language code of the vocabulary entries. For a list of languages
|
947
|
-
# and their corresponding language codes, see
|
911
|
+
# and their corresponding language codes, see transcribe-whatis.
|
948
912
|
# @return [String]
|
949
913
|
#
|
950
914
|
# @!attribute [rw] phrases
|
@@ -954,13 +918,13 @@ module Aws::TranscribeService
|
|
954
918
|
# @!attribute [rw] vocabulary_file_uri
|
955
919
|
# The S3 location of the text file that contains the definition of the
|
956
920
|
# custom vocabulary. The URI must be in the same region as the API
|
957
|
-
# endpoint that you are calling. The general form is
|
921
|
+
# endpoint that you are calling. The general form is:
|
958
922
|
#
|
959
923
|
# For more information about S3 object names, see [Object Keys][1] in
|
960
924
|
# the *Amazon S3 Developer Guide*.
|
961
925
|
#
|
962
926
|
# For more information about custom vocabularies, see [Custom
|
963
|
-
#
|
927
|
+
# vocabularies][2].
|
964
928
|
#
|
965
929
|
#
|
966
930
|
#
|
@@ -968,13 +932,20 @@ module Aws::TranscribeService
|
|
968
932
|
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary
|
969
933
|
# @return [String]
|
970
934
|
#
|
935
|
+
# @!attribute [rw] tags
|
936
|
+
# Adds one or more tags, each in the form of a key:value pair, to a
|
937
|
+
# new Amazon Transcribe vocabulary at the time you create this new
|
938
|
+
# vocabulary.
|
939
|
+
# @return [Array<Types::Tag>]
|
940
|
+
#
|
971
941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyRequest AWS API Documentation
|
972
942
|
#
|
973
943
|
class CreateVocabularyRequest < Struct.new(
|
974
944
|
:vocabulary_name,
|
975
945
|
:language_code,
|
976
946
|
:phrases,
|
977
|
-
:vocabulary_file_uri
|
947
|
+
:vocabulary_file_uri,
|
948
|
+
:tags)
|
978
949
|
SENSITIVE = []
|
979
950
|
include Aws::Structure
|
980
951
|
end
|
@@ -1757,9 +1728,10 @@ module Aws::TranscribeService
|
|
1757
1728
|
# @return [String]
|
1758
1729
|
#
|
1759
1730
|
# @!attribute [rw] max_results
|
1760
|
-
# The maximum number of categories to return in
|
1761
|
-
# are fewer results
|
1762
|
-
# results.
|
1731
|
+
# The maximum number of categories to return in each page of results.
|
1732
|
+
# If there are fewer results than the value you specify, only the
|
1733
|
+
# actual results are returned. If you do not specify a value, the
|
1734
|
+
# default of 5 is used.
|
1763
1735
|
# @return [Integer]
|
1764
1736
|
#
|
1765
1737
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategoriesRequest AWS API Documentation
|
@@ -1820,9 +1792,10 @@ module Aws::TranscribeService
|
|
1820
1792
|
# @return [String]
|
1821
1793
|
#
|
1822
1794
|
# @!attribute [rw] max_results
|
1823
|
-
# The maximum number of call analytics jobs to return in
|
1824
|
-
# If there are fewer results
|
1825
|
-
# the actual results.
|
1795
|
+
# The maximum number of call analytics jobs to return in each page of
|
1796
|
+
# results. If there are fewer results than the value you specify, only
|
1797
|
+
# the actual results are returned. If you do not specify a value, the
|
1798
|
+
# default of 5 is used.
|
1826
1799
|
# @return [Integer]
|
1827
1800
|
#
|
1828
1801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobsRequest AWS API Documentation
|
@@ -1894,9 +1867,10 @@ module Aws::TranscribeService
|
|
1894
1867
|
# @return [String]
|
1895
1868
|
#
|
1896
1869
|
# @!attribute [rw] max_results
|
1897
|
-
# The maximum number of language models to return in
|
1898
|
-
# there are fewer results
|
1899
|
-
# actual results.
|
1870
|
+
# The maximum number of language models to return in each page of
|
1871
|
+
# results. If there are fewer results than the value you specify, only
|
1872
|
+
# the actual results are returned. If you do not specify a value, the
|
1873
|
+
# default of 5 is used.
|
1900
1874
|
# @return [Integer]
|
1901
1875
|
#
|
1902
1876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListLanguageModelsRequest AWS API Documentation
|
@@ -1962,9 +1936,10 @@ module Aws::TranscribeService
|
|
1962
1936
|
# @return [String]
|
1963
1937
|
#
|
1964
1938
|
# @!attribute [rw] max_results
|
1965
|
-
# The maximum number of medical transcription jobs to return in
|
1966
|
-
#
|
1967
|
-
#
|
1939
|
+
# The maximum number of medical transcription jobs to return in each
|
1940
|
+
# page of results. If there are fewer results than the value you
|
1941
|
+
# specify, only the actual results are returned. If you do not specify
|
1942
|
+
# a value, the default of 5 is used.
|
1968
1943
|
# @return [Integer]
|
1969
1944
|
#
|
1970
1945
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobsRequest AWS API Documentation
|
@@ -2023,7 +1998,10 @@ module Aws::TranscribeService
|
|
2023
1998
|
# @return [String]
|
2024
1999
|
#
|
2025
2000
|
# @!attribute [rw] max_results
|
2026
|
-
# The maximum number of vocabularies to return in
|
2001
|
+
# The maximum number of vocabularies to return in each page of
|
2002
|
+
# results. If there are fewer results than the value you specify, only
|
2003
|
+
# the actual results are returned. If you do not specify a value, the
|
2004
|
+
# default of 5 is used.
|
2027
2005
|
# @return [Integer]
|
2028
2006
|
#
|
2029
2007
|
# @!attribute [rw] state_equals
|
@@ -2078,6 +2056,43 @@ module Aws::TranscribeService
|
|
2078
2056
|
include Aws::Structure
|
2079
2057
|
end
|
2080
2058
|
|
2059
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2060
|
+
# data as a hash:
|
2061
|
+
#
|
2062
|
+
# {
|
2063
|
+
# resource_arn: "TranscribeArn", # required
|
2064
|
+
# }
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] resource_arn
|
2067
|
+
# Lists all tags associated with a given Amazon Resource Name (ARN).
|
2068
|
+
# @return [String]
|
2069
|
+
#
|
2070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTagsForResourceRequest AWS API Documentation
|
2071
|
+
#
|
2072
|
+
class ListTagsForResourceRequest < Struct.new(
|
2073
|
+
:resource_arn)
|
2074
|
+
SENSITIVE = []
|
2075
|
+
include Aws::Structure
|
2076
|
+
end
|
2077
|
+
|
2078
|
+
# @!attribute [rw] resource_arn
|
2079
|
+
# Lists all tags associated with the given Amazon Resource Name (ARN).
|
2080
|
+
# @return [String]
|
2081
|
+
#
|
2082
|
+
# @!attribute [rw] tags
|
2083
|
+
# Lists all tags associated with the given transcription job,
|
2084
|
+
# vocabulary, or resource.
|
2085
|
+
# @return [Array<Types::Tag>]
|
2086
|
+
#
|
2087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTagsForResourceResponse AWS API Documentation
|
2088
|
+
#
|
2089
|
+
class ListTagsForResourceResponse < Struct.new(
|
2090
|
+
:resource_arn,
|
2091
|
+
:tags)
|
2092
|
+
SENSITIVE = []
|
2093
|
+
include Aws::Structure
|
2094
|
+
end
|
2095
|
+
|
2081
2096
|
# @note When making an API call, you may pass ListTranscriptionJobsRequest
|
2082
2097
|
# data as a hash:
|
2083
2098
|
#
|
@@ -2106,9 +2121,10 @@ module Aws::TranscribeService
|
|
2106
2121
|
# @return [String]
|
2107
2122
|
#
|
2108
2123
|
# @!attribute [rw] max_results
|
2109
|
-
# The maximum number of jobs to return in
|
2110
|
-
# fewer results
|
2111
|
-
# results.
|
2124
|
+
# The maximum number of jobs to return in each page of results. If
|
2125
|
+
# there are fewer results than the value you specify, only the actual
|
2126
|
+
# results are returned. If you do not specify a value, the default of
|
2127
|
+
# 5 is used.
|
2112
2128
|
# @return [Integer]
|
2113
2129
|
#
|
2114
2130
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobsRequest AWS API Documentation
|
@@ -2166,9 +2182,10 @@ module Aws::TranscribeService
|
|
2166
2182
|
# @return [String]
|
2167
2183
|
#
|
2168
2184
|
# @!attribute [rw] max_results
|
2169
|
-
# The maximum number of vocabularies to return in
|
2170
|
-
# there are fewer results
|
2171
|
-
# actual results.
|
2185
|
+
# The maximum number of vocabularies to return in each page of
|
2186
|
+
# results. If there are fewer results than the value you specify, only
|
2187
|
+
# the actual results are returned. If you do not specify a value, the
|
2188
|
+
# default of 5 is used.
|
2172
2189
|
# @return [Integer]
|
2173
2190
|
#
|
2174
2191
|
# @!attribute [rw] state_equals
|
@@ -2238,9 +2255,10 @@ module Aws::TranscribeService
|
|
2238
2255
|
# @return [String]
|
2239
2256
|
#
|
2240
2257
|
# @!attribute [rw] max_results
|
2241
|
-
# The maximum number of filters to return in
|
2242
|
-
# are fewer results
|
2243
|
-
#
|
2258
|
+
# The maximum number of filters to return in each page of results. If
|
2259
|
+
# there are fewer results than the value you specify, only the actual
|
2260
|
+
# results are returned. If you do not specify a value, the default of
|
2261
|
+
# 5 is used.
|
2244
2262
|
# @return [Integer]
|
2245
2263
|
#
|
2246
2264
|
# @!attribute [rw] name_contains
|
@@ -2412,7 +2430,7 @@ module Aws::TranscribeService
|
|
2412
2430
|
#
|
2413
2431
|
# * `Invalid sample rate for audio file`- The sample rate specified in
|
2414
2432
|
# the `MediaSampleRateHertz` of the request isn't valid. The sample
|
2415
|
-
# rate must be between
|
2433
|
+
# rate must be between 8,000 and 48,000 Hertz.
|
2416
2434
|
#
|
2417
2435
|
# * `The sample rate provided does not match the detected sample
|
2418
2436
|
# rate`- The sample rate in the audio file doesn't match the sample
|
@@ -2450,13 +2468,12 @@ module Aws::TranscribeService
|
|
2450
2468
|
#
|
2451
2469
|
# @!attribute [rw] specialty
|
2452
2470
|
# The medical specialty of any clinicians providing a dictation or
|
2453
|
-
# having a conversation.
|
2454
|
-
# for
|
2455
|
-
#
|
2471
|
+
# having a conversation. Refer to [Transcribing a medical
|
2472
|
+
# conversation][1]for a list of supported specialties.
|
2473
|
+
#
|
2456
2474
|
#
|
2457
|
-
# * Family Medicine
|
2458
2475
|
#
|
2459
|
-
#
|
2476
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html
|
2460
2477
|
# @return [String]
|
2461
2478
|
#
|
2462
2479
|
# @!attribute [rw] type
|
@@ -2470,6 +2487,10 @@ module Aws::TranscribeService
|
|
2470
2487
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/what-is-transcribe-med.html
|
2471
2488
|
# @return [String]
|
2472
2489
|
#
|
2490
|
+
# @!attribute [rw] tags
|
2491
|
+
# A key:value pair assigned to a given medical transcription job.
|
2492
|
+
# @return [Array<Types::Tag>]
|
2493
|
+
#
|
2473
2494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionJob AWS API Documentation
|
2474
2495
|
#
|
2475
2496
|
class MedicalTranscriptionJob < Struct.new(
|
@@ -2487,7 +2508,8 @@ module Aws::TranscribeService
|
|
2487
2508
|
:settings,
|
2488
2509
|
:content_identification_type,
|
2489
2510
|
:specialty,
|
2490
|
-
:type
|
2511
|
+
:type,
|
2512
|
+
:tags)
|
2491
2513
|
SENSITIVE = []
|
2492
2514
|
include Aws::Structure
|
2493
2515
|
end
|
@@ -2525,15 +2547,19 @@ module Aws::TranscribeService
|
|
2525
2547
|
# @return [String]
|
2526
2548
|
#
|
2527
2549
|
# @!attribute [rw] output_location_type
|
2528
|
-
# Indicates the location of the transcription job's output.
|
2529
|
-
#
|
2530
|
-
#
|
2531
|
-
# `OutputBucketName` field when the
|
2550
|
+
# Indicates the location of the transcription job's output. This
|
2551
|
+
# field must be the path of an S3 bucket; if you don't already have
|
2552
|
+
# an S3 bucket, one is created based on the path you add.
|
2532
2553
|
# @return [String]
|
2533
2554
|
#
|
2534
2555
|
# @!attribute [rw] specialty
|
2535
|
-
# The medical specialty of the transcription job.
|
2536
|
-
#
|
2556
|
+
# The medical specialty of the transcription job. Refer to
|
2557
|
+
# [Transcribing a medical conversation][1]for a list of supported
|
2558
|
+
# specialties.
|
2559
|
+
#
|
2560
|
+
#
|
2561
|
+
#
|
2562
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html
|
2537
2563
|
# @return [String]
|
2538
2564
|
#
|
2539
2565
|
# @!attribute [rw] content_identification_type
|
@@ -3060,9 +3086,9 @@ module Aws::TranscribeService
|
|
3060
3086
|
# @!attribute [rw] call_analytics_job_name
|
3061
3087
|
# The name of the call analytics job. You can't use the string "."
|
3062
3088
|
# or ".." by themselves as the job name. The name must also be
|
3063
|
-
# unique within an
|
3064
|
-
# job with the same name as a previous call analytics
|
3065
|
-
# `ConflictException` error.
|
3089
|
+
# unique within an Amazon Web Services account. If you try to create a
|
3090
|
+
# call analytics job with the same name as a previous call analytics
|
3091
|
+
# job, you get a `ConflictException` error.
|
3066
3092
|
# @return [String]
|
3067
3093
|
#
|
3068
3094
|
# @!attribute [rw] media
|
@@ -3093,21 +3119,22 @@ module Aws::TranscribeService
|
|
3093
3119
|
# Transcribe saves the output of the analytics job as
|
3094
3120
|
# s3://DOC-EXAMPLEBUCKET1/folder/filename.json
|
3095
3121
|
#
|
3096
|
-
# You can specify an
|
3097
|
-
# output of our analytics job using the
|
3098
|
-
# parameter. If you don't specify a KMS
|
3099
|
-
# the default Amazon S3 key for
|
3100
|
-
# analytics job output that is placed in
|
3122
|
+
# You can specify an Amazon Web Services Key Management Service (KMS)
|
3123
|
+
# key to encrypt the output of our analytics job using the
|
3124
|
+
# `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
|
3125
|
+
# key, Amazon Transcribe uses the default Amazon S3 key for
|
3126
|
+
# server-side encryption of the analytics job output that is placed in
|
3127
|
+
# your S3 bucket.
|
3101
3128
|
# @return [String]
|
3102
3129
|
#
|
3103
3130
|
# @!attribute [rw] output_encryption_kms_key_id
|
3104
|
-
# The Amazon Resource Name (ARN) of the
|
3105
|
-
# used to encrypt the output of the call
|
3106
|
-
# calling the operation must have permission
|
3107
|
-
# key.
|
3131
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services Key
|
3132
|
+
# Management Service key used to encrypt the output of the call
|
3133
|
+
# analytics job. The user calling the operation must have permission
|
3134
|
+
# to use the specified KMS key.
|
3108
3135
|
#
|
3109
|
-
# You use either of the following to identify an
|
3110
|
-
# current account:
|
3136
|
+
# You use either of the following to identify an Amazon Web Services
|
3137
|
+
# KMS key in the current account:
|
3111
3138
|
#
|
3112
3139
|
# * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
|
3113
3140
|
#
|
@@ -3204,6 +3231,12 @@ module Aws::TranscribeService
|
|
3204
3231
|
# content_identification_type: "PHI", # accepts PHI
|
3205
3232
|
# specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
|
3206
3233
|
# type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
|
3234
|
+
# tags: [
|
3235
|
+
# {
|
3236
|
+
# key: "TagKey", # required
|
3237
|
+
# value: "TagValue", # required
|
3238
|
+
# },
|
3239
|
+
# ],
|
3207
3240
|
# }
|
3208
3241
|
#
|
3209
3242
|
# @!attribute [rw] medical_transcription_job_name
|
@@ -3337,9 +3370,13 @@ module Aws::TranscribeService
|
|
3337
3370
|
# The type of speech in the input audio. `CONVERSATION` refers to
|
3338
3371
|
# conversations between two or more speakers, e.g., a conversations
|
3339
3372
|
# between doctors and patients. `DICTATION` refers to single-speaker
|
3340
|
-
# dictated speech,
|
3373
|
+
# dictated speech, such as clinical notes.
|
3341
3374
|
# @return [String]
|
3342
3375
|
#
|
3376
|
+
# @!attribute [rw] tags
|
3377
|
+
# Add tags to an Amazon Transcribe medical transcription job.
|
3378
|
+
# @return [Array<Types::Tag>]
|
3379
|
+
#
|
3343
3380
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJobRequest AWS API Documentation
|
3344
3381
|
#
|
3345
3382
|
class StartMedicalTranscriptionJobRequest < Struct.new(
|
@@ -3354,7 +3391,8 @@ module Aws::TranscribeService
|
|
3354
3391
|
:settings,
|
3355
3392
|
:content_identification_type,
|
3356
3393
|
:specialty,
|
3357
|
-
:type
|
3394
|
+
:type,
|
3395
|
+
:tags)
|
3358
3396
|
SENSITIVE = []
|
3359
3397
|
include Aws::Structure
|
3360
3398
|
end
|
@@ -3409,6 +3447,12 @@ module Aws::TranscribeService
|
|
3409
3447
|
# },
|
3410
3448
|
# identify_language: false,
|
3411
3449
|
# language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN
|
3450
|
+
# tags: [
|
3451
|
+
# {
|
3452
|
+
# key: "TagKey", # required
|
3453
|
+
# value: "TagValue", # required
|
3454
|
+
# },
|
3455
|
+
# ],
|
3412
3456
|
# }
|
3413
3457
|
#
|
3414
3458
|
# @!attribute [rw] transcription_job_name
|
@@ -3423,7 +3467,7 @@ module Aws::TranscribeService
|
|
3423
3467
|
# The language code for the language used in the input media file.
|
3424
3468
|
#
|
3425
3469
|
# To transcribe speech in Modern Standard Arabic (ar-SA), your audio
|
3426
|
-
# or video file must be encoded at a sample rate of
|
3470
|
+
# or video file must be encoded at a sample rate of 16,000 Hz or
|
3427
3471
|
# higher.
|
3428
3472
|
# @return [String]
|
3429
3473
|
#
|
@@ -3568,10 +3612,14 @@ module Aws::TranscribeService
|
|
3568
3612
|
# list.
|
3569
3613
|
#
|
3570
3614
|
# To transcribe speech in Modern Standard Arabic (ar-SA), your audio
|
3571
|
-
# or video file must be encoded at a sample rate of
|
3615
|
+
# or video file must be encoded at a sample rate of 16,000 Hz or
|
3572
3616
|
# higher.
|
3573
3617
|
# @return [Array<String>]
|
3574
3618
|
#
|
3619
|
+
# @!attribute [rw] tags
|
3620
|
+
# Add tags to an Amazon Transcribe transcription job.
|
3621
|
+
# @return [Array<Types::Tag>]
|
3622
|
+
#
|
3575
3623
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJobRequest AWS API Documentation
|
3576
3624
|
#
|
3577
3625
|
class StartTranscriptionJobRequest < Struct.new(
|
@@ -3588,7 +3636,8 @@ module Aws::TranscribeService
|
|
3588
3636
|
:job_execution_settings,
|
3589
3637
|
:content_redaction,
|
3590
3638
|
:identify_language,
|
3591
|
-
:language_options
|
3639
|
+
:language_options,
|
3640
|
+
:tags)
|
3592
3641
|
SENSITIVE = []
|
3593
3642
|
include Aws::Structure
|
3594
3643
|
end
|
@@ -3605,6 +3654,75 @@ module Aws::TranscribeService
|
|
3605
3654
|
include Aws::Structure
|
3606
3655
|
end
|
3607
3656
|
|
3657
|
+
# A key:value pair that adds metadata to a resource used by Amazon
|
3658
|
+
# Transcribe. For example, a tag with the key:value pair
|
3659
|
+
# ‘Department’:’Sales’ might be added to a resource to indicate its use
|
3660
|
+
# by your organization's sales department.
|
3661
|
+
#
|
3662
|
+
# @note When making an API call, you may pass Tag
|
3663
|
+
# data as a hash:
|
3664
|
+
#
|
3665
|
+
# {
|
3666
|
+
# key: "TagKey", # required
|
3667
|
+
# value: "TagValue", # required
|
3668
|
+
# }
|
3669
|
+
#
|
3670
|
+
# @!attribute [rw] key
|
3671
|
+
# The first part of a key:value pair that forms a tag associated with
|
3672
|
+
# a given resource. For example, in the tag ‘Department’:’Sales’, the
|
3673
|
+
# key is 'Department'.
|
3674
|
+
# @return [String]
|
3675
|
+
#
|
3676
|
+
# @!attribute [rw] value
|
3677
|
+
# The second part of a key:value pair that forms a tag associated with
|
3678
|
+
# a given resource. For example, in the tag ‘Department’:’Sales’, the
|
3679
|
+
# value is 'Sales'.
|
3680
|
+
# @return [String]
|
3681
|
+
#
|
3682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Tag AWS API Documentation
|
3683
|
+
#
|
3684
|
+
class Tag < Struct.new(
|
3685
|
+
:key,
|
3686
|
+
:value)
|
3687
|
+
SENSITIVE = []
|
3688
|
+
include Aws::Structure
|
3689
|
+
end
|
3690
|
+
|
3691
|
+
# @note When making an API call, you may pass TagResourceRequest
|
3692
|
+
# data as a hash:
|
3693
|
+
#
|
3694
|
+
# {
|
3695
|
+
# resource_arn: "TranscribeArn", # required
|
3696
|
+
# tags: [ # required
|
3697
|
+
# {
|
3698
|
+
# key: "TagKey", # required
|
3699
|
+
# value: "TagValue", # required
|
3700
|
+
# },
|
3701
|
+
# ],
|
3702
|
+
# }
|
3703
|
+
#
|
3704
|
+
# @!attribute [rw] resource_arn
|
3705
|
+
# The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
|
3706
|
+
# want to tag.
|
3707
|
+
# @return [String]
|
3708
|
+
#
|
3709
|
+
# @!attribute [rw] tags
|
3710
|
+
# The tags you are assigning to a given Amazon Transcribe resource.
|
3711
|
+
# @return [Array<Types::Tag>]
|
3712
|
+
#
|
3713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TagResourceRequest AWS API Documentation
|
3714
|
+
#
|
3715
|
+
class TagResourceRequest < Struct.new(
|
3716
|
+
:resource_arn,
|
3717
|
+
:tags)
|
3718
|
+
SENSITIVE = []
|
3719
|
+
include Aws::Structure
|
3720
|
+
end
|
3721
|
+
|
3722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TagResourceResponse AWS API Documentation
|
3723
|
+
#
|
3724
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
3725
|
+
|
3608
3726
|
# Identifies the location of a transcription.
|
3609
3727
|
#
|
3610
3728
|
# @!attribute [rw] transcript_file_uri
|
@@ -3742,7 +3860,7 @@ module Aws::TranscribeService
|
|
3742
3860
|
# @return [Types::Transcript]
|
3743
3861
|
#
|
3744
3862
|
# @!attribute [rw] start_time
|
3745
|
-
# A timestamp that shows
|
3863
|
+
# A timestamp that shows when the job started processing.
|
3746
3864
|
# @return [Time]
|
3747
3865
|
#
|
3748
3866
|
# @!attribute [rw] creation_time
|
@@ -3771,7 +3889,7 @@ module Aws::TranscribeService
|
|
3771
3889
|
#
|
3772
3890
|
# * `Invalid sample rate for audio file` - The sample rate specified
|
3773
3891
|
# in the `MediaSampleRateHertz` of the request isn't valid. The
|
3774
|
-
# sample rate must be between
|
3892
|
+
# sample rate must be between 8,000 and 48,000 Hertz.
|
3775
3893
|
#
|
3776
3894
|
# * `The sample rate provided does not match the detected sample rate`
|
3777
3895
|
# - The sample rate in the audio file doesn't match the sample rate
|
@@ -3832,6 +3950,10 @@ module Aws::TranscribeService
|
|
3832
3950
|
# language it identified.
|
3833
3951
|
# @return [Float]
|
3834
3952
|
#
|
3953
|
+
# @!attribute [rw] tags
|
3954
|
+
# A key:value pair assigned to a given transcription job.
|
3955
|
+
# @return [Array<Types::Tag>]
|
3956
|
+
#
|
3835
3957
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJob AWS API Documentation
|
3836
3958
|
#
|
3837
3959
|
class TranscriptionJob < Struct.new(
|
@@ -3852,7 +3974,8 @@ module Aws::TranscribeService
|
|
3852
3974
|
:content_redaction,
|
3853
3975
|
:identify_language,
|
3854
3976
|
:language_options,
|
3855
|
-
:identified_language_score
|
3977
|
+
:identified_language_score,
|
3978
|
+
:tags)
|
3856
3979
|
SENSITIVE = []
|
3857
3980
|
include Aws::Structure
|
3858
3981
|
end
|
@@ -3942,6 +4065,37 @@ module Aws::TranscribeService
|
|
3942
4065
|
include Aws::Structure
|
3943
4066
|
end
|
3944
4067
|
|
4068
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
4069
|
+
# data as a hash:
|
4070
|
+
#
|
4071
|
+
# {
|
4072
|
+
# resource_arn: "TranscribeArn", # required
|
4073
|
+
# tag_keys: ["TagKey"], # required
|
4074
|
+
# }
|
4075
|
+
#
|
4076
|
+
# @!attribute [rw] resource_arn
|
4077
|
+
# The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
|
4078
|
+
# want to remove tags from.
|
4079
|
+
# @return [String]
|
4080
|
+
#
|
4081
|
+
# @!attribute [rw] tag_keys
|
4082
|
+
# A list of tag keys you want to remove from a specified Amazon
|
4083
|
+
# Transcribe resource.
|
4084
|
+
# @return [Array<String>]
|
4085
|
+
#
|
4086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UntagResourceRequest AWS API Documentation
|
4087
|
+
#
|
4088
|
+
class UntagResourceRequest < Struct.new(
|
4089
|
+
:resource_arn,
|
4090
|
+
:tag_keys)
|
4091
|
+
SENSITIVE = []
|
4092
|
+
include Aws::Structure
|
4093
|
+
end
|
4094
|
+
|
4095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UntagResourceResponse AWS API Documentation
|
4096
|
+
#
|
4097
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
4098
|
+
|
3945
4099
|
# @note When making an API call, you may pass UpdateCallAnalyticsCategoryRequest
|
3946
4100
|
# data as a hash:
|
3947
4101
|
#
|
@@ -4079,10 +4233,10 @@ module Aws::TranscribeService
|
|
4079
4233
|
# @return [String]
|
4080
4234
|
#
|
4081
4235
|
# @!attribute [rw] vocabulary_file_uri
|
4082
|
-
# The location in Amazon S3 of the text file that contains
|
4083
|
-
#
|
4084
|
-
#
|
4085
|
-
#
|
4236
|
+
# The location in Amazon S3 of the text file that contains your custom
|
4237
|
+
# vocabulary. The URI must be in the same Amazon Web Services Region
|
4238
|
+
# as the resource that you are calling. The following is the format
|
4239
|
+
# for a URI:
|
4086
4240
|
#
|
4087
4241
|
# `
|
4088
4242
|
# https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
|
@@ -4240,7 +4394,7 @@ module Aws::TranscribeService
|
|
4240
4394
|
#
|
4241
4395
|
# @!attribute [rw] language_code
|
4242
4396
|
# The language code of the vocabulary entries. For a list of languages
|
4243
|
-
# and their corresponding language codes, see
|
4397
|
+
# and their corresponding language codes, see transcribe-whatis.
|
4244
4398
|
# @return [String]
|
4245
4399
|
#
|
4246
4400
|
# @!attribute [rw] phrases
|