-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
transcribe-2017-10-26.normal.json
713 lines (713 loc) · 28.1 KB
/
transcribe-2017-10-26.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-10-26",
"endpointPrefix":"transcribe",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Transcribe Service",
"serviceId":"Transcribe",
"signatureVersion":"v4",
"signingName":"transcribe",
"targetPrefix":"Transcribe",
"uid":"transcribe-2017-10-26"
},
"operations":{
"CreateVocabulary":{
"name":"CreateVocabulary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateVocabularyRequest"},
"output":{"shape":"CreateVocabularyResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.</p>"
},
"DeleteVocabulary":{
"name":"DeleteVocabulary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteVocabularyRequest"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes a vocabulary from Amazon Transcribe. </p>"
},
"GetTranscriptionJob":{
"name":"GetTranscriptionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTranscriptionJobRequest"},
"output":{"shape":"GetTranscriptionJobResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Returns information about a transcription job. To see the status of the job, check the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished and you can find the results at the location specified in the <code>TranscriptionFileUri</code> field.</p>"
},
"GetVocabulary":{
"name":"GetVocabulary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetVocabularyRequest"},
"output":{"shape":"GetVocabularyResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Gets information about a vocabulary.</p>"
},
"ListTranscriptionJobs":{
"name":"ListTranscriptionJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTranscriptionJobsRequest"},
"output":{"shape":"ListTranscriptionJobsResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists transcription jobs with the specified status.</p>"
},
"ListVocabularies":{
"name":"ListVocabularies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListVocabulariesRequest"},
"output":{"shape":"ListVocabulariesResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.</p>"
},
"StartTranscriptionJob":{
"name":"StartTranscriptionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartTranscriptionJobRequest"},
"output":{"shape":"StartTranscriptionJobResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Starts an asynchronous job to transcribe speech to text.</p>"
},
"UpdateVocabulary":{
"name":"UpdateVocabulary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateVocabularyRequest"},
"output":{"shape":"UpdateVocabularyResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"NotFoundException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Updates an existing vocabulary with new values. The <code>UpdateVocabulary</code> operation overwrites all of the existing information with the values that you provide in the request.</p>"
}
},
"shapes":{
"BadRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"FailureReason"}
},
"documentation":"<p>Your request didn't pass one or more validation tests. For example, a name already exists when creating a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception <code>Message</code> field for more information.</p>",
"exception":true
},
"Boolean":{"type":"boolean"},
"ConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>When you are using the <code>StartTranscriptionJob</code> operation, the <code>JobName</code> field is a duplicate of a previously entered job name. Resend your request with a different name.</p> <p>When you are using the <code>UpdateVocabulary</code> operation, there are two jobs running at the same time. Resend the second request later.</p>",
"exception":true
},
"CreateVocabularyRequest":{
"type":"structure",
"required":[
"VocabularyName",
"LanguageCode",
"Phrases"
],
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"Phrases":{
"shape":"Phrases",
"documentation":"<p>An array of strings that contains the vocabulary entries. </p>"
}
}
},
"CreateVocabularyResponse":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary. When the <code>VocabularyState</code> field contains <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code> request.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was created.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
}
}
},
"DateTime":{"type":"timestamp"},
"DeleteVocabularyRequest":{
"type":"structure",
"required":["VocabularyName"],
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary to delete. </p>"
}
}
},
"FailureReason":{"type":"string"},
"GetTranscriptionJobRequest":{
"type":"structure",
"required":["TranscriptionJobName"],
"members":{
"TranscriptionJobName":{
"shape":"TranscriptionJobName",
"documentation":"<p>The name of the job.</p>"
}
}
},
"GetTranscriptionJobResponse":{
"type":"structure",
"members":{
"TranscriptionJob":{
"shape":"TranscriptionJob",
"documentation":"<p>An object that contains the results of the transcription job.</p>"
}
}
},
"GetVocabularyRequest":{
"type":"structure",
"required":["VocabularyName"],
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary to return information about. The name is case-sensitive.</p>"
}
}
},
"GetVocabularyResponse":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary to return.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was last modified.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
},
"DownloadUri":{
"shape":"Uri",
"documentation":"<p>The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.</p>"
}
}
},
"InternalFailureException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>There was an internal error. Check the error message and try your request again.</p>",
"exception":true,
"fault":true
},
"LanguageCode":{
"type":"string",
"enum":[
"en-US",
"es-US"
]
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.</p>",
"exception":true
},
"ListTranscriptionJobsRequest":{
"type":"structure",
"members":{
"Status":{
"shape":"TranscriptionJobStatus",
"documentation":"<p>When specified, returns only transcription jobs with the specified status.</p>"
},
"JobNameContains":{
"shape":"TranscriptionJobName",
"documentation":"<p>When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request to <code>ListTranscriptionJobs</code> was truncated, include the <code>NextToken</code> to fetch the next set of jobs.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.</p>"
}
}
},
"ListTranscriptionJobsResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"TranscriptionJobStatus",
"documentation":"<p>The requested status of the jobs returned.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>ListTranscriptionJobs</code> operation returns a page of jobs at a time. The maximum size of the page is set by the <code>MaxResults</code> parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token. Include the token in the next request to the <code>ListTranscriptionJobs</code> operation to return in the next page of jobs.</p>"
},
"TranscriptionJobSummaries":{
"shape":"TranscriptionJobSummaries",
"documentation":"<p>A list of objects containing summary information for a transcription job.</p>"
}
}
},
"ListVocabulariesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request to <code>ListVocabularies</code> was truncated, include the <code>NextToken</code> to fetch the next set of jobs.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.</p>"
},
"StateEquals":{
"shape":"VocabularyState",
"documentation":"<p>When specified, only returns vocabularies with the <code>VocabularyState</code> field equal to the specified state.</p>"
},
"NameContains":{
"shape":"VocabularyName",
"documentation":"<p>When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, <code>ListVocabularies</code> will return both \"vocabularyname\" and \"VocabularyName\" in the response list.</p>"
}
}
},
"ListVocabulariesResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"TranscriptionJobStatus",
"documentation":"<p>The requested vocabulary state.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>ListVocabularies</code> operation returns a page of vocabularies at a time. The maximum size of the page is set by the <code>MaxResults</code> parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token. Include the token in the next request to the <code>ListVocabularies</code> operation to return in the next page of jobs.</p>"
},
"Vocabularies":{
"shape":"Vocabularies",
"documentation":"<p>A list of objects that describe the vocabularies that match the search criteria in the request.</p>"
}
}
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"MaxSpeakers":{
"type":"integer",
"max":10,
"min":2
},
"Media":{
"type":"structure",
"members":{
"MediaFileUri":{
"shape":"Uri",
"documentation":"<p>The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code> https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4</code> </p> <p> <code>https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4</code> </p> <p>For more information about S3 object names, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
}
},
"documentation":"<p>Describes the input media file in a transcription request.</p>"
},
"MediaFormat":{
"type":"string",
"enum":[
"mp3",
"mp4",
"wav",
"flac"
]
},
"MediaSampleRateHertz":{
"type":"integer",
"max":48000,
"min":8000
},
"NextToken":{
"type":"string",
"max":8192
},
"NotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>We can't find the requested resource. Check the name and try your request again.</p>",
"exception":true
},
"OutputBucketName":{
"type":"string",
"pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]"
},
"OutputLocationType":{
"type":"string",
"enum":[
"CUSTOMER_BUCKET",
"SERVICE_BUCKET"
]
},
"Phrase":{
"type":"string",
"max":256,
"min":0
},
"Phrases":{
"type":"list",
"member":{"shape":"Phrase"}
},
"Settings":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of a vocabulary to use when processing the transcription job.</p>"
},
"ShowSpeakerLabels":{
"shape":"Boolean",
"documentation":"<p>Determines whether the transcription job should use speaker recognition to identify different speakers in the input audio. If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the maximum number of speaker labels <code>MaxSpeakerLabels</code> field.</p>"
},
"MaxSpeakerLabels":{
"shape":"MaxSpeakers",
"documentation":"<p>The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>"
}
},
"documentation":"<p>Provides optional settings for the <code>StartTranscriptionJob</code> operation.</p>"
},
"StartTranscriptionJobRequest":{
"type":"structure",
"required":[
"TranscriptionJobName",
"LanguageCode",
"MediaFormat",
"Media"
],
"members":{
"TranscriptionJobName":{
"shape":"TranscriptionJobName",
"documentation":"<p>The name of the job. You can't use the strings \".\" or \"..\" in the job name. The name must be unique within an AWS account.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code for the language used in the input media file.</p>"
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
"documentation":"<p>The sample rate, in Hertz, of the audio track in the input media file. </p>"
},
"MediaFormat":{
"shape":"MediaFormat",
"documentation":"<p>The format of the input media file.</p>"
},
"Media":{
"shape":"Media",
"documentation":"<p>An object that describes the input media for a transcription job.</p>"
},
"OutputBucketName":{
"shape":"OutputBucketName",
"documentation":"<p>The location where the transcription is stored.</p> <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/access-control-managing-permissions.html#auth-role-iam-user\">Permissions Required for IAM User Roles</a>.</p> <p>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</p>"
},
"Settings":{
"shape":"Settings",
"documentation":"<p>A <code>Settings</code> object that provides optional settings for a transcription job.</p>"
}
}
},
"StartTranscriptionJobResponse":{
"type":"structure",
"members":{
"TranscriptionJob":{
"shape":"TranscriptionJob",
"documentation":"<p>An object containing details of the asynchronous transcription job.</p>"
}
}
},
"String":{"type":"string"},
"Transcript":{
"type":"structure",
"members":{
"TranscriptFileUri":{
"shape":"Uri",
"documentation":"<p>The location where the transcription is stored.</p> <p>Use this URI to access the transcription. If you specified an S3 bucket in the <code>OutputBucketName</code> field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location.</p>"
}
},
"documentation":"<p>Identifies the location of a transcription.</p>"
},
"TranscriptionJob":{
"type":"structure",
"members":{
"TranscriptionJobName":{
"shape":"TranscriptionJobName",
"documentation":"<p>The name of the transcription job.</p>"
},
"TranscriptionJobStatus":{
"shape":"TranscriptionJobStatus",
"documentation":"<p>The status of the transcription job.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code for the input speech.</p>"
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
"documentation":"<p>The sample rate, in Hertz, of the audio track in the input media file. </p>"
},
"MediaFormat":{
"shape":"MediaFormat",
"documentation":"<p>The format of the input media file.</p>"
},
"Media":{
"shape":"Media",
"documentation":"<p>An object that describes the input media for the transcription job.</p>"
},
"Transcript":{
"shape":"Transcript",
"documentation":"<p>An object that describes the output of the transcription job.</p>"
},
"CreationTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job was created.</p>"
},
"CompletionTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job was completed.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
},
"Settings":{
"shape":"Settings",
"documentation":"<p>Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.</p>"
}
},
"documentation":"<p>Describes an asynchronous transcription job that was created with the <code>StartTranscriptionJob</code> operation.</p>"
},
"TranscriptionJobName":{
"type":"string",
"max":200,
"min":1,
"pattern":"^[0-9a-zA-Z._-]+"
},
"TranscriptionJobStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"FAILED",
"COMPLETED"
]
},
"TranscriptionJobSummaries":{
"type":"list",
"member":{"shape":"TranscriptionJobSummary"}
},
"TranscriptionJobSummary":{
"type":"structure",
"members":{
"TranscriptionJobName":{
"shape":"TranscriptionJobName",
"documentation":"<p>The name of the transcription job.</p>"
},
"CreationTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job was created.</p>"
},
"CompletionTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job was completed.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code for the input speech.</p>"
},
"TranscriptionJobStatus":{
"shape":"TranscriptionJobStatus",
"documentation":"<p>The status of the transcription job. When the status is <code>COMPLETED</code>, use the <code>GetTranscriptionJob</code> operation to get the results of the transcription.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, a description of the error.</p>"
},
"OutputLocationType":{
"shape":"OutputLocationType",
"documentation":"<p>Indicates the location of the output of the transcription job.</p> <p>If the value is <code>CUSTOMER_BUCKET</code> then the location is the S3 bucket specified in the <code>outputBucketName</code> field when the transcription job was started with the <code>StartTranscriptionJob</code> operation.</p> <p>If the value is <code>SERVICE_BUCKET</code> then the output is stored by Amazon Transcribe and can be retrieved using the URI in the <code>GetTranscriptionJob</code> response's <code>TranscriptFileUri</code> field.</p>"
}
},
"documentation":"<p>Provides a summary of information about a transcription job.</p>"
},
"UpdateVocabularyRequest":{
"type":"structure",
"required":[
"VocabularyName",
"LanguageCode",
"Phrases"
],
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary to update. The name is case-sensitive.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"Phrases":{
"shape":"Phrases",
"documentation":"<p>An array of strings containing the vocabulary entries.</p>"
}
}
},
"UpdateVocabularyResponse":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary that was updated.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was updated.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary. When the <code>VocabularyState</code> field contains <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code> request.</p>"
}
}
},
"Uri":{
"type":"string",
"max":2000,
"min":1
},
"Vocabularies":{
"type":"list",
"member":{"shape":"VocabularyInfo"}
},
"VocabularyInfo":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was last modified.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary. If the state is <code>READY</code> you can use the vocabulary in a <code>StartTranscriptionJob</code> request.</p>"
}
},
"documentation":"<p>Provides information about a custom vocabulary.</p>"
},
"VocabularyName":{
"type":"string",
"max":200,
"min":1,
"pattern":"^[0-9a-zA-Z._-]+"
},
"VocabularyState":{
"type":"string",
"enum":[
"PENDING",
"READY",
"FAILED"
]
}
},
"documentation":"<p>Operations and objects for transcribing speech to text.</p>"
}