xref: /aosp_15_r20/external/aws-sdk-java-v2/services/transcribe/src/main/resources/codegen-resources/api-2.json (revision 8a52c7834d808308836a99fc2a6e0ed8db339086) 
1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2017-10-26",
5    "endpointPrefix":"transcribe",
6    "jsonVersion":"1.1",
7    "protocol":"json",
8    "serviceFullName":"Amazon Transcribe Service",
9    "serviceId":"Transcribe",
10    "signatureVersion":"v4",
11    "signingName":"transcribe",
12    "targetPrefix":"Transcribe",
13    "uid":"transcribe-2017-10-26"
14  },
15  "operations":{
16    "CreateVocabulary":{
17      "name":"CreateVocabulary",
18      "http":{
19        "method":"POST",
20        "requestUri":"/"
21      },
22      "input":{"shape":"CreateVocabularyRequest"},
23      "output":{"shape":"CreateVocabularyResponse"},
24      "errors":[
25        {"shape":"BadRequestException"},
26        {"shape":"LimitExceededException"},
27        {"shape":"InternalFailureException"},
28        {"shape":"ConflictException"}
29      ]
30    },
31    "DeleteTranscriptionJob":{
32      "name":"DeleteTranscriptionJob",
33      "http":{
34        "method":"POST",
35        "requestUri":"/"
36      },
37      "input":{"shape":"DeleteTranscriptionJobRequest"},
38      "errors":[
39        {"shape":"LimitExceededException"},
40        {"shape":"BadRequestException"},
41        {"shape":"InternalFailureException"}
42      ]
43    },
44    "DeleteVocabulary":{
45      "name":"DeleteVocabulary",
46      "http":{
47        "method":"POST",
48        "requestUri":"/"
49      },
50      "input":{"shape":"DeleteVocabularyRequest"},
51      "errors":[
52        {"shape":"NotFoundException"},
53        {"shape":"LimitExceededException"},
54        {"shape":"BadRequestException"},
55        {"shape":"InternalFailureException"}
56      ]
57    },
58    "GetTranscriptionJob":{
59      "name":"GetTranscriptionJob",
60      "http":{
61        "method":"POST",
62        "requestUri":"/"
63      },
64      "input":{"shape":"GetTranscriptionJobRequest"},
65      "output":{"shape":"GetTranscriptionJobResponse"},
66      "errors":[
67        {"shape":"BadRequestException"},
68        {"shape":"LimitExceededException"},
69        {"shape":"InternalFailureException"},
70        {"shape":"NotFoundException"}
71      ]
72    },
73    "GetVocabulary":{
74      "name":"GetVocabulary",
75      "http":{
76        "method":"POST",
77        "requestUri":"/"
78      },
79      "input":{"shape":"GetVocabularyRequest"},
80      "output":{"shape":"GetVocabularyResponse"},
81      "errors":[
82        {"shape":"NotFoundException"},
83        {"shape":"LimitExceededException"},
84        {"shape":"InternalFailureException"},
85        {"shape":"BadRequestException"}
86      ]
87    },
88    "ListTranscriptionJobs":{
89      "name":"ListTranscriptionJobs",
90      "http":{
91        "method":"POST",
92        "requestUri":"/"
93      },
94      "input":{"shape":"ListTranscriptionJobsRequest"},
95      "output":{"shape":"ListTranscriptionJobsResponse"},
96      "errors":[
97        {"shape":"BadRequestException"},
98        {"shape":"LimitExceededException"},
99        {"shape":"InternalFailureException"}
100      ]
101    },
102    "ListVocabularies":{
103      "name":"ListVocabularies",
104      "http":{
105        "method":"POST",
106        "requestUri":"/"
107      },
108      "input":{"shape":"ListVocabulariesRequest"},
109      "output":{"shape":"ListVocabulariesResponse"},
110      "errors":[
111        {"shape":"BadRequestException"},
112        {"shape":"LimitExceededException"},
113        {"shape":"InternalFailureException"}
114      ]
115    },
116    "StartTranscriptionJob":{
117      "name":"StartTranscriptionJob",
118      "http":{
119        "method":"POST",
120        "requestUri":"/"
121      },
122      "input":{"shape":"StartTranscriptionJobRequest"},
123      "output":{"shape":"StartTranscriptionJobResponse"},
124      "errors":[
125        {"shape":"BadRequestException"},
126        {"shape":"LimitExceededException"},
127        {"shape":"InternalFailureException"},
128        {"shape":"ConflictException"}
129      ]
130    },
131    "UpdateVocabulary":{
132      "name":"UpdateVocabulary",
133      "http":{
134        "method":"POST",
135        "requestUri":"/"
136      },
137      "input":{"shape":"UpdateVocabularyRequest"},
138      "output":{"shape":"UpdateVocabularyResponse"},
139      "errors":[
140        {"shape":"BadRequestException"},
141        {"shape":"LimitExceededException"},
142        {"shape":"InternalFailureException"},
143        {"shape":"NotFoundException"},
144        {"shape":"ConflictException"}
145      ]
146    }
147  },
148  "shapes":{
149    "BadRequestException":{
150      "type":"structure",
151      "members":{
152        "Message":{"shape":"FailureReason"}
153      },
154      "exception":true
155    },
156    "Boolean":{"type":"boolean"},
157    "ConflictException":{
158      "type":"structure",
159      "members":{
160        "Message":{"shape":"String"}
161      },
162      "exception":true
163    },
164    "CreateVocabularyRequest":{
165      "type":"structure",
166      "required":[
167        "VocabularyName",
168        "LanguageCode",
169        "Phrases"
170      ],
171      "members":{
172        "VocabularyName":{"shape":"VocabularyName"},
173        "LanguageCode":{"shape":"LanguageCode"},
174        "Phrases":{"shape":"Phrases"}
175      }
176    },
177    "CreateVocabularyResponse":{
178      "type":"structure",
179      "members":{
180        "VocabularyName":{"shape":"VocabularyName"},
181        "LanguageCode":{"shape":"LanguageCode"},
182        "VocabularyState":{"shape":"VocabularyState"},
183        "LastModifiedTime":{"shape":"DateTime"},
184        "FailureReason":{"shape":"FailureReason"}
185      }
186    },
187    "DateTime":{"type":"timestamp"},
188    "DeleteTranscriptionJobRequest":{
189      "type":"structure",
190      "required":["TranscriptionJobName"],
191      "members":{
192        "TranscriptionJobName":{"shape":"TranscriptionJobName"}
193      }
194    },
195    "DeleteVocabularyRequest":{
196      "type":"structure",
197      "required":["VocabularyName"],
198      "members":{
199        "VocabularyName":{"shape":"VocabularyName"}
200      }
201    },
202    "FailureReason":{"type":"string"},
203    "GetTranscriptionJobRequest":{
204      "type":"structure",
205      "required":["TranscriptionJobName"],
206      "members":{
207        "TranscriptionJobName":{"shape":"TranscriptionJobName"}
208      }
209    },
210    "GetTranscriptionJobResponse":{
211      "type":"structure",
212      "members":{
213        "TranscriptionJob":{"shape":"TranscriptionJob"}
214      }
215    },
216    "GetVocabularyRequest":{
217      "type":"structure",
218      "required":["VocabularyName"],
219      "members":{
220        "VocabularyName":{"shape":"VocabularyName"}
221      }
222    },
223    "GetVocabularyResponse":{
224      "type":"structure",
225      "members":{
226        "VocabularyName":{"shape":"VocabularyName"},
227        "LanguageCode":{"shape":"LanguageCode"},
228        "VocabularyState":{"shape":"VocabularyState"},
229        "LastModifiedTime":{"shape":"DateTime"},
230        "FailureReason":{"shape":"FailureReason"},
231        "DownloadUri":{"shape":"Uri"}
232      }
233    },
234    "InternalFailureException":{
235      "type":"structure",
236      "members":{
237        "Message":{"shape":"String"}
238      },
239      "exception":true,
240      "fault":true
241    },
242    "LanguageCode":{
243      "type":"string",
244      "enum":[
245        "en-US",
246        "es-US",
247        "en-AU",
248        "fr-CA",
249        "en-GB",
250        "de-DE",
251        "pt-BR",
252        "fr-FR"
253      ]
254    },
255    "LimitExceededException":{
256      "type":"structure",
257      "members":{
258        "Message":{"shape":"String"}
259      },
260      "exception":true
261    },
262    "ListTranscriptionJobsRequest":{
263      "type":"structure",
264      "members":{
265        "Status":{"shape":"TranscriptionJobStatus"},
266        "JobNameContains":{"shape":"TranscriptionJobName"},
267        "NextToken":{"shape":"NextToken"},
268        "MaxResults":{"shape":"MaxResults"}
269      }
270    },
271    "ListTranscriptionJobsResponse":{
272      "type":"structure",
273      "members":{
274        "Status":{"shape":"TranscriptionJobStatus"},
275        "NextToken":{"shape":"NextToken"},
276        "TranscriptionJobSummaries":{"shape":"TranscriptionJobSummaries"}
277      }
278    },
279    "ListVocabulariesRequest":{
280      "type":"structure",
281      "members":{
282        "NextToken":{"shape":"NextToken"},
283        "MaxResults":{"shape":"MaxResults"},
284        "StateEquals":{"shape":"VocabularyState"},
285        "NameContains":{"shape":"VocabularyName"}
286      }
287    },
288    "ListVocabulariesResponse":{
289      "type":"structure",
290      "members":{
291        "Status":{"shape":"TranscriptionJobStatus"},
292        "NextToken":{"shape":"NextToken"},
293        "Vocabularies":{"shape":"Vocabularies"}
294      }
295    },
296    "MaxResults":{
297      "type":"integer",
298      "max":100,
299      "min":1
300    },
301    "MaxSpeakers":{
302      "type":"integer",
303      "max":10,
304      "min":2
305    },
306    "Media":{
307      "type":"structure",
308      "members":{
309        "MediaFileUri":{"shape":"Uri"}
310      }
311    },
312    "MediaFormat":{
313      "type":"string",
314      "enum":[
315        "mp3",
316        "mp4",
317        "wav",
318        "flac"
319      ]
320    },
321    "MediaSampleRateHertz":{
322      "type":"integer",
323      "max":48000,
324      "min":8000
325    },
326    "NextToken":{
327      "type":"string",
328      "max":8192
329    },
330    "NotFoundException":{
331      "type":"structure",
332      "members":{
333        "Message":{"shape":"String"}
334      },
335      "exception":true
336    },
337    "OutputBucketName":{
338      "type":"string",
339      "pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]"
340    },
341    "OutputLocationType":{
342      "type":"string",
343      "enum":[
344        "CUSTOMER_BUCKET",
345        "SERVICE_BUCKET"
346      ]
347    },
348    "Phrase":{
349      "type":"string",
350      "max":256,
351      "min":0
352    },
353    "Phrases":{
354      "type":"list",
355      "member":{"shape":"Phrase"}
356    },
357    "Settings":{
358      "type":"structure",
359      "members":{
360        "VocabularyName":{"shape":"VocabularyName"},
361        "ShowSpeakerLabels":{"shape":"Boolean"},
362        "MaxSpeakerLabels":{"shape":"MaxSpeakers"},
363        "ChannelIdentification":{"shape":"Boolean"}
364      }
365    },
366    "StartTranscriptionJobRequest":{
367      "type":"structure",
368      "required":[
369        "TranscriptionJobName",
370        "LanguageCode",
371        "MediaFormat",
372        "Media"
373      ],
374      "members":{
375        "TranscriptionJobName":{"shape":"TranscriptionJobName"},
376        "LanguageCode":{"shape":"LanguageCode"},
377        "MediaSampleRateHertz":{"shape":"MediaSampleRateHertz"},
378        "MediaFormat":{"shape":"MediaFormat"},
379        "Media":{"shape":"Media"},
380        "OutputBucketName":{"shape":"OutputBucketName"},
381        "Settings":{"shape":"Settings"}
382      }
383    },
384    "StartTranscriptionJobResponse":{
385      "type":"structure",
386      "members":{
387        "TranscriptionJob":{"shape":"TranscriptionJob"}
388      }
389    },
390    "String":{"type":"string"},
391    "Transcript":{
392      "type":"structure",
393      "members":{
394        "TranscriptFileUri":{"shape":"Uri"}
395      }
396    },
397    "TranscriptionJob":{
398      "type":"structure",
399      "members":{
400        "TranscriptionJobName":{"shape":"TranscriptionJobName"},
401        "TranscriptionJobStatus":{"shape":"TranscriptionJobStatus"},
402        "LanguageCode":{"shape":"LanguageCode"},
403        "MediaSampleRateHertz":{"shape":"MediaSampleRateHertz"},
404        "MediaFormat":{"shape":"MediaFormat"},
405        "Media":{"shape":"Media"},
406        "Transcript":{"shape":"Transcript"},
407        "CreationTime":{"shape":"DateTime"},
408        "CompletionTime":{"shape":"DateTime"},
409        "FailureReason":{"shape":"FailureReason"},
410        "Settings":{"shape":"Settings"}
411      }
412    },
413    "TranscriptionJobName":{
414      "type":"string",
415      "max":200,
416      "min":1,
417      "pattern":"^[0-9a-zA-Z._-]+"
418    },
419    "TranscriptionJobStatus":{
420      "type":"string",
421      "enum":[
422        "IN_PROGRESS",
423        "FAILED",
424        "COMPLETED"
425      ]
426    },
427    "TranscriptionJobSummaries":{
428      "type":"list",
429      "member":{"shape":"TranscriptionJobSummary"}
430    },
431    "TranscriptionJobSummary":{
432      "type":"structure",
433      "members":{
434        "TranscriptionJobName":{"shape":"TranscriptionJobName"},
435        "CreationTime":{"shape":"DateTime"},
436        "CompletionTime":{"shape":"DateTime"},
437        "LanguageCode":{"shape":"LanguageCode"},
438        "TranscriptionJobStatus":{"shape":"TranscriptionJobStatus"},
439        "FailureReason":{"shape":"FailureReason"},
440        "OutputLocationType":{"shape":"OutputLocationType"}
441      }
442    },
443    "UpdateVocabularyRequest":{
444      "type":"structure",
445      "required":[
446        "VocabularyName",
447        "LanguageCode",
448        "Phrases"
449      ],
450      "members":{
451        "VocabularyName":{"shape":"VocabularyName"},
452        "LanguageCode":{"shape":"LanguageCode"},
453        "Phrases":{"shape":"Phrases"}
454      }
455    },
456    "UpdateVocabularyResponse":{
457      "type":"structure",
458      "members":{
459        "VocabularyName":{"shape":"VocabularyName"},
460        "LanguageCode":{"shape":"LanguageCode"},
461        "LastModifiedTime":{"shape":"DateTime"},
462        "VocabularyState":{"shape":"VocabularyState"}
463      }
464    },
465    "Uri":{
466      "type":"string",
467      "max":2000,
468      "min":1
469    },
470    "Vocabularies":{
471      "type":"list",
472      "member":{"shape":"VocabularyInfo"}
473    },
474    "VocabularyInfo":{
475      "type":"structure",
476      "members":{
477        "VocabularyName":{"shape":"VocabularyName"},
478        "LanguageCode":{"shape":"LanguageCode"},
479        "LastModifiedTime":{"shape":"DateTime"},
480        "VocabularyState":{"shape":"VocabularyState"}
481      }
482    },
483    "VocabularyName":{
484      "type":"string",
485      "max":200,
486      "min":1,
487      "pattern":"^[0-9a-zA-Z._-]+"
488    },
489    "VocabularyState":{
490      "type":"string",
491      "enum":[
492        "PENDING",
493        "READY",
494        "FAILED"
495      ]
496    }
497  }
498}
499