File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (1785 lines) | stat: -rw-r--r-- 85,902 bytes parent folder | download
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
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// A time range, in milliseconds, between two points in your media file. You can
// use StartTime and EndTime to search a custom segment. For example, setting
// StartTime to 10000 and EndTime to 50000 only searches for your specified
// criteria in the audio contained between the 10,000 millisecond mark and the
// 50,000 millisecond mark of your media file. You must use StartTime and EndTime
// as a set; that is, if you include one, you must include both. You can use also
// First to search from the start of the audio until the time that you specify, or
// Last to search from the time that you specify until the end of the audio. For
// example, setting First to 50000 only searches for your specified criteria in
// the audio contained between the start of the media file to the 50,000
// millisecond mark. You can use First and Last independently of each other. If
// you prefer to use percentage instead of milliseconds, see .
type AbsoluteTimeRange struct {

	// The time, in milliseconds, when Amazon Transcribe stops searching for the
	// specified criteria in your audio. If you include EndTime in your request, you
	// must also include StartTime .
	EndTime *int64

	// The time, in milliseconds, from the start of your media file until the
	// specified value. Amazon Transcribe searches for your specified criteria in this
	// time segment.
	First *int64

	// The time, in milliseconds, from the specified value until the end of your media
	// file. Amazon Transcribe searches for your specified criteria in this time
	// segment.
	Last *int64

	// The time, in milliseconds, when Amazon Transcribe starts searching for the
	// specified criteria in your audio. If you include StartTime in your request, you
	// must also include EndTime .
	StartTime *int64

	noSmithyDocumentSerde
}

// Provides detailed information about a Call Analytics job. To view the job's
// status, refer to CallAnalyticsJobStatus . If the status is COMPLETED , the job
// is finished. You can find your completed transcript at the URI specified in
// TranscriptFileUri . If the status is FAILED , FailureReason provides details on
// why your transcription job failed. If you enabled personally identifiable
// information (PII) redaction, the redacted transcript appears at the location
// specified in RedactedTranscriptFileUri . If you chose to redact the audio in
// your media file, you can find your redacted media file at the location specified
// in the RedactedMediaFileUri field of your response.
type CallAnalyticsJob struct {

	// The name of the Call Analytics job. Job names are case sensitive and must be
	// unique within an Amazon Web Services account.
	CallAnalyticsJobName *string

	// Provides the status of the specified Call Analytics job. If the status is
	// COMPLETED , the job is finished and you can find the results at the location
	// specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested
	// transcript redaction). If the status is FAILED , FailureReason provides details
	// on why your transcription job failed.
	CallAnalyticsJobStatus CallAnalyticsJobStatus

	// Indicates which speaker is on which channel.
	ChannelDefinitions []ChannelDefinition

	// The date and time the specified Call Analytics job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// The date and time the specified Call Analytics job request was made. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) you included in your request.
	DataAccessRoleArn *string

	// If CallAnalyticsJobStatus is FAILED , FailureReason contains information about
	// why the Call Analytics job request failed. The FailureReason field contains one
	// of the following values:
	//   - Unsupported media format . The media format specified in MediaFormat isn't
	//   valid. Refer to refer to the MediaFormat parameter for a list of supported
	//   formats.
	//   - The media format provided does not match the detected media format . The
	//   media format specified in MediaFormat doesn't match the format of the input
	//   file. Check the media format of your media file and correct the specified value.
	//
	//   - Invalid sample rate for audio file . The sample rate specified in
	//   MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and
	//   48,000 hertz.
	//   - The sample rate provided does not match the detected sample rate . The
	//   sample rate specified in MediaSampleRateHertz doesn't match the sample rate
	//   detected in your input media file. Check the sample rate of your media file and
	//   correct the specified value.
	//   - Invalid file size: file size too large . The size of your media file is
	//   larger than what Amazon Transcribe can process. For more information, refer to
	//   Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
	//   .
	//   - Invalid number of channels: number of channels too large . Your audio
	//   contains more channels than Amazon Transcribe is able to process. For more
	//   information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
	//   .
	FailureReason *string

	// The confidence score associated with the language identified in your media
	// file. Confidence scores are values between 0 and 1; a larger value indicates a
	// higher probability that the identified language correctly matches the language
	// spoken in your media.
	IdentifiedLanguageScore *float32

	// The language code used to create your Call Analytics job. For a list of
	// supported languages and their associated language codes, refer to the Supported
	// languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table. If you do not know the language spoken in your media file, you can omit
	// this field and let Amazon Transcribe automatically identify the language of your
	// media. To improve the accuracy of language identification, you can include
	// several language codes and Amazon Transcribe chooses the closest match for your
	// transcription.
	LanguageCode LanguageCode

	// Provides the Amazon S3 location of the media file you used in your Call
	// Analytics request.
	Media *Media

	// The format of the input media file.
	MediaFormat MediaFormat

	// The sample rate, in hertz, of the audio track in your input media file.
	MediaSampleRateHertz *int32

	// Provides information on any additional settings that were included in your
	// request. Additional settings include content redaction and language
	// identification settings.
	Settings *CallAnalyticsJobSettings

	// The date and time the specified Call Analytics job began processing. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	// Provides you with the Amazon S3 URI you can use to access your transcript.
	Transcript *Transcript

	noSmithyDocumentSerde
}

// Provides additional optional settings for your request, including content
// redaction, automatic language identification; allows you to apply custom
// language models, custom vocabulary filters, and custom vocabularies.
type CallAnalyticsJobSettings struct {

	// Makes it possible to redact or flag specified personally identifiable
	// information (PII) in your transcript. If you use ContentRedaction , you must
	// also include the sub-parameters: RedactionOutput and RedactionType . You can
	// optionally include PiiEntityTypes to choose which types of PII you want to
	// redact.
	ContentRedaction *ContentRedaction

	// If using automatic language identification in your request and you want to
	// apply a custom language model, a custom vocabulary, or a custom vocabulary
	// filter, include LanguageIdSettings with the relevant sub-parameters (
	// VocabularyName , LanguageModelName , and VocabularyFilterName ).
	// LanguageIdSettings supports two to five language codes. Each language code you
	// include can have an associated custom language model, custom vocabulary, and
	// custom vocabulary filter. The language codes that you specify must match the
	// languages of the associated custom language models, custom vocabularies, and
	// custom vocabulary filters. It's recommended that you include LanguageOptions
	// when using LanguageIdSettings to ensure that the correct language dialect is
	// identified. For example, if you specify a custom vocabulary that is in en-US
	// but Amazon Transcribe determines that the language spoken in your media is en-AU
	// , your custom vocabulary is not applied to your transcription. If you include
	// LanguageOptions and include en-US as the only English language dialect, your
	// custom vocabulary is applied to your transcription. If you want to include a
	// custom language model, custom vocabulary, or custom vocabulary filter with your
	// request but do not want to use automatic language identification, use instead
	// the parameter with the LanguageModelName , VocabularyName , or
	// VocabularyFilterName sub-parameters. For a list of languages supported with Call
	// Analytics, refer to Supported languages and language-specific features (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// .
	LanguageIdSettings map[string]LanguageIdSettings

	// The name of the custom language model you want to use when processing your Call
	// Analytics job. Note that custom language model names are case sensitive. The
	// language of the specified custom language model must match the language code
	// that you specify in your transcription request. If the languages do not match,
	// the custom language model isn't applied. There are no errors or warnings
	// associated with a language mismatch.
	LanguageModelName *string

	// You can specify two or more language codes that represent the languages you
	// think may be present in your media. Including more than five is not recommended.
	// If you're unsure what languages are present, do not include this parameter.
	// Including language options can improve the accuracy of language identification.
	// For a list of languages supported with Call Analytics, refer to the Supported
	// languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table. To transcribe speech in Modern Standard Arabic ( ar-SA ), your media file
	// must be encoded at a sample rate of 16,000 Hz or higher.
	LanguageOptions []LanguageCode

	// Contains GenerateAbstractiveSummary , which is a required parameter if you want
	// to enable Generative call summarization in your Call Analytics request.
	Summarization *Summarization

	// Specify how you want your custom vocabulary filter applied to your transcript.
	// To replace words with *** , choose mask . To delete words, choose remove . To
	// flag words without changing them, choose tag .
	VocabularyFilterMethod VocabularyFilterMethod

	// The name of the custom vocabulary filter you want to include in your Call
	// Analytics transcription request. Custom vocabulary filter names are case
	// sensitive. Note that if you include VocabularyFilterName in your request, you
	// must also include VocabularyFilterMethod .
	VocabularyFilterName *string

	// The name of the custom vocabulary you want to include in your Call Analytics
	// transcription request. Custom vocabulary names are case sensitive.
	VocabularyName *string

	noSmithyDocumentSerde
}

// Provides detailed information about a specific Call Analytics job.
type CallAnalyticsJobSummary struct {

	// The name of the Call Analytics job. Job names are case sensitive and must be
	// unique within an Amazon Web Services account.
	CallAnalyticsJobName *string

	// Provides the status of your Call Analytics job. If the status is COMPLETED , the
	// job is finished and you can find the results at the location specified in
	// TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript
	// redaction). If the status is FAILED , FailureReason provides details on why
	// your transcription job failed.
	CallAnalyticsJobStatus CallAnalyticsJobStatus

	// The date and time the specified Call Analytics job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// The date and time the specified Call Analytics job request was made. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// If CallAnalyticsJobStatus is FAILED , FailureReason contains information about
	// why the Call Analytics job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
	// .
	FailureReason *string

	// The language code used to create your Call Analytics transcription.
	LanguageCode LanguageCode

	// The date and time your Call Analytics job began processing. Timestamps are in
	// the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	noSmithyDocumentSerde
}

// Provides you with the properties of the Call Analytics category you specified
// in your request. This includes the list of rules that define the specified
// category.
type CategoryProperties struct {

	// The name of the Call Analytics category. Category names are case sensitive and
	// must be unique within an Amazon Web Services account.
	CategoryName *string

	// The date and time the specified Call Analytics category was created. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	CreateTime *time.Time

	// The input type associated with the specified category. POST_CALL refers to a
	// category that is applied to batch transcriptions; REAL_TIME refers to a
	// category that is applied to streaming transcriptions.
	InputType InputType

	// The date and time the specified Call Analytics category was last updated.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.
	LastUpdateTime *time.Time

	// The rules used to define a Call Analytics category. Each category can have
	// between 1 and 20 rules.
	Rules []Rule

	noSmithyDocumentSerde
}

// Makes it possible to specify which speaker is on which channel. For example, if
// your agent is the first participant to speak, you would set ChannelId to 0 (to
// indicate the first channel) and ParticipantRole to AGENT (to indicate that it's
// the agent speaking).
type ChannelDefinition struct {

	// Specify the audio channel you want to define.
	ChannelId int32

	// Specify the speaker you want to define. Omitting this parameter is equivalent
	// to specifying both participants.
	ParticipantRole ParticipantRole

	noSmithyDocumentSerde
}

// Makes it possible to redact or flag specified personally identifiable
// information (PII) in your transcript. If you use ContentRedaction , you must
// also include the sub-parameters: RedactionOutput and RedactionType . You can
// optionally include PiiEntityTypes to choose which types of PII you want to
// redact.
type ContentRedaction struct {

	// Specify if you want only a redacted transcript, or if you want a redacted and
	// an unredacted transcript. When you choose redacted Amazon Transcribe creates
	// only a redacted transcript. When you choose redacted_and_unredacted Amazon
	// Transcribe creates a redacted and an unredacted transcript (as two separate
	// files).
	//
	// This member is required.
	RedactionOutput RedactionOutput

	// Specify the category of information you want to redact; PII (personally
	// identifiable information) is the only valid value. You can use PiiEntityTypes
	// to choose which types of PII you want to redact. If you do not include
	// PiiEntityTypes in your request, all PII is redacted.
	//
	// This member is required.
	RedactionType RedactionType

	// Specify which types of personally identifiable information (PII) you want to
	// redact in your transcript. You can include as many types as you'd like, or you
	// can select ALL . If you do not include PiiEntityTypes in your request, all PII
	// is redacted.
	PiiEntityTypes []PiiEntityType

	noSmithyDocumentSerde
}

// Contains the Amazon S3 location of the training data you want to use to create
// a new custom language model, and permissions to access this location. When using
// InputDataConfig , you must include these sub-parameters: S3Uri and
// DataAccessRoleArn . You can optionally include TuningDataS3Uri .
type InputDataConfig struct {

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files. If the role that you
	// specify doesn’t have the appropriate permissions to access the specified Amazon
	// S3 location, your request fails. IAM role ARNs have the format
	// arn:partition:iam::account:role/role-name-with-path . For example:
	// arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns)
	// .
	//
	// This member is required.
	DataAccessRoleArn *string

	// The Amazon S3 location (URI) of the text files you want to use to train your
	// custom language model. Here's an example URI path:
	// s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
	//
	// This member is required.
	S3Uri *string

	// The Amazon S3 location (URI) of the text files you want to use to tune your
	// custom language model. Here's an example URI path:
	// s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
	TuningDataS3Uri *string

	noSmithyDocumentSerde
}

// Flag the presence or absence of interruptions in your Call Analytics
// transcription output. Rules using InterruptionFilter are designed to match:
//   - Instances where an agent interrupts a customer
//   - Instances where a customer interrupts an agent
//   - Either participant interrupting the other
//   - A lack of interruptions
//
// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch)
// for usage examples.
type InterruptionFilter struct {

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for an interruption. See for more detail.
	AbsoluteTimeRange *AbsoluteTimeRange

	// Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to
	// flag speech that contains interruptions.
	Negate *bool

	// Specify the interrupter that you want to flag. Omitting this parameter is
	// equivalent to specifying both participants.
	ParticipantRole ParticipantRole

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for an interruption. See for more detail.
	RelativeTimeRange *RelativeTimeRange

	// Specify the duration of the interruptions in milliseconds. For example, you can
	// flag speech that contains more than 10,000 milliseconds of interruptions.
	Threshold *int64

	noSmithyDocumentSerde
}

// Makes it possible to control how your transcription job is processed.
// Currently, the only JobExecutionSettings modification you can choose is
// enabling job queueing using the AllowDeferredExecution sub-parameter. If you
// include JobExecutionSettings in your request, you must also include the
// sub-parameters: AllowDeferredExecution and DataAccessRoleArn .
type JobExecutionSettings struct {

	// Makes it possible to enable job queuing when your concurrent request limit is
	// exceeded. When AllowDeferredExecution is set to true , transcription job
	// requests are placed in a queue until the number of jobs falls below the
	// concurrent request limit. If AllowDeferredExecution is set to false and the
	// number of transcription job requests exceed the concurrent request limit, you
	// get a LimitExceededException error. If you include AllowDeferredExecution in
	// your request, you must also include DataAccessRoleArn .
	AllowDeferredExecution *bool

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files. If the role that you
	// specify doesn’t have the appropriate permissions to access the specified Amazon
	// S3 location, your request fails. IAM role ARNs have the format
	// arn:partition:iam::account:role/role-name-with-path . For example:
	// arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns)
	// . Note that if you include DataAccessRoleArn in your request, you must also
	// include AllowDeferredExecution .
	DataAccessRoleArn *string

	noSmithyDocumentSerde
}

// Provides information on the speech contained in a discreet utterance when
// multi-language identification is enabled in your request. This utterance
// represents a block of speech consisting of one language, preceded or followed by
// a block of speech in a different language.
type LanguageCodeItem struct {

	// Provides the total time, in seconds, each identified language is spoken in your
	// media.
	DurationInSeconds *float32

	// Provides the language code for each language identified in your media.
	LanguageCode LanguageCode

	noSmithyDocumentSerde
}

// If using automatic language identification in your request and you want to
// apply a custom language model, a custom vocabulary, or a custom vocabulary
// filter, include LanguageIdSettings with the relevant sub-parameters (
// VocabularyName , LanguageModelName , and VocabularyFilterName ). Note that
// multi-language identification ( IdentifyMultipleLanguages ) doesn't support
// custom language models. LanguageIdSettings supports two to five language codes.
// Each language code you include can have an associated custom language model,
// custom vocabulary, and custom vocabulary filter. The language codes that you
// specify must match the languages of the associated custom language models,
// custom vocabularies, and custom vocabulary filters. It's recommended that you
// include LanguageOptions when using LanguageIdSettings to ensure that the
// correct language dialect is identified. For example, if you specify a custom
// vocabulary that is in en-US but Amazon Transcribe determines that the language
// spoken in your media is en-AU , your custom vocabulary is not applied to your
// transcription. If you include LanguageOptions and include en-US as the only
// English language dialect, your custom vocabulary is applied to your
// transcription. If you want to include a custom language model with your request
// but do not want to use automatic language identification, use instead the
// parameter with the LanguageModelName sub-parameter. If you want to include a
// custom vocabulary or a custom vocabulary filter (or both) with your request but
// do not want to use automatic language identification, use instead the parameter
// with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
type LanguageIdSettings struct {

	// The name of the custom language model you want to use when processing your
	// transcription job. Note that custom language model names are case sensitive. The
	// language of the specified custom language model must match the language code
	// that you specify in your transcription request. If the languages do not match,
	// the custom language model isn't applied. There are no errors or warnings
	// associated with a language mismatch.
	LanguageModelName *string

	// The name of the custom vocabulary filter you want to use when processing your
	// transcription job. Custom vocabulary filter names are case sensitive. The
	// language of the specified custom vocabulary filter must match the language code
	// that you specify in your transcription request. If the languages do not match,
	// the custom vocabulary filter isn't applied. There are no errors or warnings
	// associated with a language mismatch. Note that if you include
	// VocabularyFilterName in your request, you must also include
	// VocabularyFilterMethod .
	VocabularyFilterName *string

	// The name of the custom vocabulary you want to use when processing your
	// transcription job. Custom vocabulary names are case sensitive. The language of
	// the specified custom vocabulary must match the language code that you specify in
	// your transcription request. If the languages do not match, the custom vocabulary
	// isn't applied. There are no errors or warnings associated with a language
	// mismatch.
	VocabularyName *string

	noSmithyDocumentSerde
}

// Provides information about a custom language model, including:
//   - The base model name
//   - When the model was created
//   - The location of the files used to train the model
//   - When the model was last modified
//   - The name you chose for the model
//   - The model's language
//   - The model's processing state
//   - Any available upgrades for the base model
type LanguageModel struct {

	// The Amazon Transcribe standard language model, or base model, used to create
	// your custom language model.
	BaseModelName BaseModelName

	// The date and time the specified custom language model was created. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	CreateTime *time.Time

	// If ModelStatus is FAILED , FailureReason contains information about why the
	// custom language model request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
	// .
	FailureReason *string

	// The Amazon S3 location of the input files used to train and tune your custom
	// language model, in addition to the data access role ARN (Amazon Resource Name)
	// that has permissions to access these data.
	InputDataConfig *InputDataConfig

	// The language code used to create your custom language model. Each custom
	// language model must contain terms in only one language, and the language you
	// select for your custom language model must match the language of your training
	// and tuning data. For a list of supported languages and their associated language
	// codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table. Note that US English ( en-US ) is the only language supported with Amazon
	// Transcribe Medical.
	LanguageCode CLMLanguageCode

	// The date and time the specified custom language model was last modified.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time

	// A unique name, chosen by you, for your custom language model. This name is case
	// sensitive, cannot contain spaces, and must be unique within an Amazon Web
	// Services account.
	ModelName *string

	// The status of the specified custom language model. When the status displays as
	// COMPLETED the model is ready for use.
	ModelStatus ModelStatus

	// Shows if a more current base model is available for use with the specified
	// custom language model. If false , your custom language model is using the most
	// up-to-date base model. If true , there is a newer base model available than the
	// one your language model is using. Note that to update a base model, you must
	// recreate the custom language model using the new base model. Base model upgrades
	// for existing custom language models are not supported.
	UpgradeAvailability *bool

	noSmithyDocumentSerde
}

// Describes the Amazon S3 location of the media file you want to use in your
// request. For information on supported media formats, refer to the MediaFormat
// parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
// section in the Amazon S3 Developer Guide.
type Media struct {

	// The Amazon S3 location of the media file you want to transcribe. For example:
	//   - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
	//   - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
	// Note that the Amazon S3 bucket that contains your input media must be located
	// in the same Amazon Web Services Region where you're making your transcription
	// request.
	MediaFileUri *string

	// The Amazon S3 location of the media file you want to redact. For example:
	//   - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
	//   - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
	// Note that the Amazon S3 bucket that contains your input media must be located
	// in the same Amazon Web Services Region where you're making your transcription
	// request. RedactedMediaFileUri produces a redacted audio file in addition to a
	// redacted transcript. It is only supported for Call Analytics (
	// StartCallAnalyticsJob ) transcription requests.
	RedactedMediaFileUri *string

	noSmithyDocumentSerde
}

// Indicates which speaker is on which channel. The options are CLINICIAN and
// PATIENT
type MedicalScribeChannelDefinition struct {

	// Specify the audio channel you want to define.
	//
	// This member is required.
	ChannelId int32

	// Specify the participant that you want to flag. The options are CLINICIAN and
	// PATIENT
	//
	// This member is required.
	ParticipantRole MedicalScribeParticipantRole

	noSmithyDocumentSerde
}

// Provides detailed information about a Medical Scribe job. To view the status of
// the specified Medical Scribe job, check the MedicalScribeJobStatus field. If
// the status is COMPLETED , the job is finished and you can find the results at
// the locations specified in MedicalScribeOutput . If the status is FAILED ,
// FailureReason provides details on why your Medical Scribe job failed.
type MedicalScribeJob struct {

	// Makes it possible to specify which speaker is on which channel. For example, if
	// the clinician is the first participant to speak, you would set ChannelId of the
	// first ChannelDefinition in the list to 0 (to indicate the first channel) and
	// ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking).
	// Then you would set the ChannelId of the second ChannelDefinition in the list to
	// 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate
	// that it's the patient speaking).
	ChannelDefinitions []MedicalScribeChannelDefinition

	// The date and time the specified Medical Scribe job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// The date and time the specified Medical Scribe job request was made. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
	// the Amazon S3 bucket that contains your input files, write to the output bucket,
	// and use your KMS key if supplied. If the role that you specify doesn’t have the
	// appropriate permissions your request fails. IAM role ARNs have the format
	// arn:partition:iam::account:role/role-name-with-path . For example:
	// arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns)
	// .
	DataAccessRoleArn *string

	// If MedicalScribeJobStatus is FAILED , FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
	// .
	FailureReason *string

	// The language code used to create your Medical Scribe job. US English ( en-US )
	// is the only supported language for Medical Scribe jobs.
	LanguageCode MedicalScribeLanguageCode

	// Describes the Amazon S3 location of the media file you want to use in your
	// request. For information on supported media formats, refer to the MediaFormat
	// parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
	// section in the Amazon S3 Developer Guide.
	Media *Media

	// The name of the Medical Scribe job. Job names are case sensitive and must be
	// unique within an Amazon Web Services account.
	MedicalScribeJobName *string

	// Provides the status of the specified Medical Scribe job. If the status is
	// COMPLETED , the job is finished and you can find the results at the location
	// specified in MedicalScribeOutput If the status is FAILED , FailureReason
	// provides details on why your Medical Scribe job failed.
	MedicalScribeJobStatus MedicalScribeJobStatus

	// The location of the output of your Medical Scribe job. ClinicalDocumentUri
	// holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds
	// the Amazon S3 URI for the Transcript.
	MedicalScribeOutput *MedicalScribeOutput

	// Makes it possible to control how your Medical Scribe job is processed using a
	// MedicalScribeSettings object. Specify ChannelIdentification if
	// ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification
	// and ChannelDefinitions are not set. One and only one of ChannelIdentification
	// and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels
	// must also be set. Use Settings to specify a vocabulary or vocabulary filter or
	// both using VocabularyName , VocabularyFilterName . VocabularyFilterMethod must
	// be specified if VocabularyFilterName is set.
	Settings *MedicalScribeSettings

	// The date and time your Medical Scribe job began processing. Timestamps are in
	// the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	// Adds one or more custom tags, each in the form of a key:value pair, to the
	// Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer
	// to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html)
	// .
	Tags []Tag

	noSmithyDocumentSerde
}

// Provides detailed information about a specific Medical Scribe job.
type MedicalScribeJobSummary struct {

	// The date and time the specified Medical Scribe job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// The date and time the specified Medical Scribe job request was made. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// If MedicalScribeJobStatus is FAILED , FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
	// .
	FailureReason *string

	// The language code used to create your Medical Scribe job. US English ( en-US )
	// is the only supported language for Medical Scribe jobs.
	LanguageCode MedicalScribeLanguageCode

	// The name of the Medical Scribe job. Job names are case sensitive and must be
	// unique within an Amazon Web Services account.
	MedicalScribeJobName *string

	// Provides the status of the specified Medical Scribe job. If the status is
	// COMPLETED , the job is finished and you can find the results at the location
	// specified in MedicalScribeOutput If the status is FAILED , FailureReason
	// provides details on why your Medical Scribe job failed.
	MedicalScribeJobStatus MedicalScribeJobStatus

	// The date and time your Medical Scribe job began processing. Timestamps are in
	// the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	noSmithyDocumentSerde
}

// The location of the output of your Medical Scribe job. ClinicalDocumentUri
// holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds
// the Amazon S3 URI for the Transcript.
type MedicalScribeOutput struct {

	// Holds the Amazon S3 URI for the Clinical Document.
	//
	// This member is required.
	ClinicalDocumentUri *string

	// Holds the Amazon S3 URI for the Transcript.
	//
	// This member is required.
	TranscriptFileUri *string

	noSmithyDocumentSerde
}

// Makes it possible to control how your Medical Scribe job is processed using a
// MedicalScribeSettings object. Specify ChannelIdentification if
// ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification
// and ChannelDefinitions are not set. One and only one of ChannelIdentification
// and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels
// must also be set. Use Settings to specify a vocabulary or vocabulary filter or
// both using VocabularyName , VocabularyFilterName . VocabularyFilterMethod must
// be specified if VocabularyFilterName is set.
type MedicalScribeSettings struct {

	// Enables channel identification in multi-channel audio. Channel identification
	// transcribes the audio on each channel independently, then appends the output for
	// each channel into one transcript. For more information, see Transcribing
	// multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html)
	// .
	ChannelIdentification *bool

	// Specify the maximum number of speakers you want to partition in your media.
	// Note that if your media contains more speakers than the specified number,
	// multiple speakers are treated as a single speaker. If you specify the
	// MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
	MaxSpeakerLabels *int32

	// Enables speaker partitioning (diarization) in your Medical Scribe output.
	// Speaker partitioning labels the speech from individual speakers in your media
	// file. If you enable ShowSpeakerLabels in your request, you must also include
	// MaxSpeakerLabels . For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html)
	// .
	ShowSpeakerLabels *bool

	// Specify how you want your custom vocabulary filter applied to your transcript.
	// To replace words with *** , choose mask . To delete words, choose remove . To
	// flag words without changing them, choose tag .
	VocabularyFilterMethod VocabularyFilterMethod

	// The name of the custom vocabulary filter you want to include in your Medical
	// Scribe request. Custom vocabulary filter names are case sensitive. Note that if
	// you include VocabularyFilterName in your request, you must also include
	// VocabularyFilterMethod .
	VocabularyFilterName *string

	// The name of the custom vocabulary you want to include in your Medical Scribe
	// request. Custom vocabulary names are case sensitive.
	VocabularyName *string

	noSmithyDocumentSerde
}

// Provides you with the Amazon S3 URI you can use to access your transcript.
type MedicalTranscript struct {

	// The Amazon S3 location of your transcript. You can use this URI to access or
	// download your transcript. Note that this is the Amazon S3 location you specified
	// in your request using the OutputBucketName parameter.
	TranscriptFileUri *string

	noSmithyDocumentSerde
}

// Provides detailed information about a medical transcription job. To view the
// status of the specified medical transcription job, check the
// TranscriptionJobStatus field. If the status is COMPLETED , the job is finished
// and you can find the results at the location specified in TranscriptFileUri . If
// the status is FAILED , FailureReason provides details on why your transcription
// job failed.
type MedicalTranscriptionJob struct {

	// The date and time the specified medical transcription job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// Indicates whether content identification was enabled for your transcription
	// request.
	ContentIdentificationType MedicalContentIdentificationType

	// The date and time the specified medical transcription job request was made.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// If TranscriptionJobStatus is FAILED , FailureReason contains information about
	// why the transcription job request failed. The FailureReason field contains one
	// of the following values:
	//   - Unsupported media format . The media format specified in MediaFormat isn't
	//   valid. Refer to refer to the MediaFormat parameter for a list of supported
	//   formats.
	//   - The media format provided does not match the detected media format . The
	//   media format specified in MediaFormat doesn't match the format of the input
	//   file. Check the media format of your media file and correct the specified value.
	//
	//   - Invalid sample rate for audio file . The sample rate specified in
	//   MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and
	//   48,000 hertz.
	//   - The sample rate provided does not match the detected sample rate . The
	//   sample rate specified in MediaSampleRateHertz doesn't match the sample rate
	//   detected in your input media file. Check the sample rate of your media file and
	//   correct the specified value.
	//   - Invalid file size: file size too large . The size of your media file is
	//   larger than what Amazon Transcribe can process. For more information, refer to
	//   Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
	//   .
	//   - Invalid number of channels: number of channels too large . Your audio
	//   contains more channels than Amazon Transcribe is able to process. For more
	//   information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
	//   .
	FailureReason *string

	// The language code used to create your medical transcription job. US English (
	// en-US ) is the only supported language for medical transcriptions.
	LanguageCode LanguageCode

	// Describes the Amazon S3 location of the media file you want to use in your
	// request. For information on supported media formats, refer to the MediaFormat
	// parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
	// section in the Amazon S3 Developer Guide.
	Media *Media

	// The format of the input media file.
	MediaFormat MediaFormat

	// The sample rate, in hertz, of the audio track in your input media file.
	MediaSampleRateHertz *int32

	// The name of the medical transcription job. Job names are case sensitive and
	// must be unique within an Amazon Web Services account.
	MedicalTranscriptionJobName *string

	// Provides information on any additional settings that were included in your
	// request. Additional settings include channel identification, alternative
	// transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary
	// filters.
	Settings *MedicalTranscriptionSetting

	// Describes the medical specialty represented in your media.
	Specialty Specialty

	// The date and time the specified medical transcription job began processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	// The tags, each in the form of a key:value pair, assigned to the specified
	// medical transcription job.
	Tags []Tag

	// Provides you with the Amazon S3 URI you can use to access your transcript.
	Transcript *MedicalTranscript

	// Provides the status of the specified medical transcription job. If the status
	// is COMPLETED , the job is finished and you can find the results at the location
	// specified in TranscriptFileUri . If the status is FAILED , FailureReason
	// provides details on why your transcription job failed.
	TranscriptionJobStatus TranscriptionJobStatus

	// Indicates whether the input media is a dictation or a conversation, as
	// specified in the StartMedicalTranscriptionJob request.
	Type Type

	noSmithyDocumentSerde
}

// Provides detailed information about a specific medical transcription job.
type MedicalTranscriptionJobSummary struct {

	// The date and time the specified medical transcription job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// Labels all personal health information (PHI) identified in your transcript. For
	// more information, see Identifying personal health information (PHI) in a
	// transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html) .
	ContentIdentificationType MedicalContentIdentificationType

	// The date and time the specified medical transcription job request was made.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// If TranscriptionJobStatus is FAILED , FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
	// .
	FailureReason *string

	// The language code used to create your medical transcription. US English ( en-US
	// ) is the only supported language for medical transcriptions.
	LanguageCode LanguageCode

	// The name of the medical transcription job. Job names are case sensitive and
	// must be unique within an Amazon Web Services account.
	MedicalTranscriptionJobName *string

	// Indicates where the specified medical transcription output is stored. If the
	// value is CUSTOMER_BUCKET , the location is the Amazon S3 bucket you specified
	// using the OutputBucketName parameter in your request. If you also included
	// OutputKey in your request, your output is located in the path you specified in
	// your request. If the value is SERVICE_BUCKET , the location is a service-managed
	// Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use
	// the URI shown in the TranscriptFileUri field.
	OutputLocationType OutputLocationType

	// Provides the medical specialty represented in your media.
	Specialty Specialty

	// The date and time your medical transcription job began processing. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	// Provides the status of your medical transcription job. If the status is
	// COMPLETED , the job is finished and you can find the results at the location
	// specified in TranscriptFileUri . If the status is FAILED , FailureReason
	// provides details on why your transcription job failed.
	TranscriptionJobStatus TranscriptionJobStatus

	// Indicates whether the input media is a dictation or a conversation, as
	// specified in the StartMedicalTranscriptionJob request.
	Type Type

	noSmithyDocumentSerde
}

// Allows additional optional settings in your request, including channel
// identification, alternative transcriptions, and speaker partitioning. You can
// use that to apply custom vocabularies to your medical transcription job.
type MedicalTranscriptionSetting struct {

	// Enables channel identification in multi-channel audio. Channel identification
	// transcribes the audio on each channel independently, then appends the output for
	// each channel into one transcript. If you have multi-channel audio and do not
	// enable channel identification, your audio is transcribed in a continuous manner
	// and your transcript does not separate the speech by channel. For more
	// information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html)
	// .
	ChannelIdentification *bool

	// Indicate the maximum number of alternative transcriptions you want Amazon
	// Transcribe Medical to include in your transcript. If you select a number greater
	// than the number of alternative transcriptions generated by Amazon Transcribe
	// Medical, only the actual number of alternative transcriptions are included. If
	// you include MaxAlternatives in your request, you must also include
	// ShowAlternatives with a value of true . For more information, see Alternative
	// transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html)
	// .
	MaxAlternatives *int32

	// Specify the maximum number of speakers you want to partition in your media.
	// Note that if your media contains more speakers than the specified number,
	// multiple speakers are treated as a single speaker. If you specify the
	// MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
	MaxSpeakerLabels *int32

	// To include alternative transcriptions within your transcription output, include
	// ShowAlternatives in your transcription request. If you include ShowAlternatives
	// , you must also include MaxAlternatives , which is the maximum number of
	// alternative transcriptions you want Amazon Transcribe Medical to generate. For
	// more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html)
	// .
	ShowAlternatives *bool

	// Enables speaker partitioning (diarization) in your transcription output.
	// Speaker partitioning labels the speech from individual speakers in your media
	// file. If you enable ShowSpeakerLabels in your request, you must also include
	// MaxSpeakerLabels . For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html)
	// .
	ShowSpeakerLabels *bool

	// The name of the custom vocabulary you want to use when processing your medical
	// transcription job. Custom vocabulary names are case sensitive. The language of
	// the specified custom vocabulary must match the language code that you specify in
	// your transcription request. If the languages do not match, the custom vocabulary
	// isn't applied. There are no errors or warnings associated with a language
	// mismatch. US English ( en-US ) is the only valid language for Amazon Transcribe
	// Medical.
	VocabularyName *string

	noSmithyDocumentSerde
}

// Provides the name of the custom language model that was included in the
// specified transcription job. Only use ModelSettings with the LanguageModelName
// sub-parameter if you're not using automatic language identification ( ). If
// using LanguageIdSettings in your request, this parameter contains a
// LanguageModelName sub-parameter.
type ModelSettings struct {

	// The name of the custom language model you want to use when processing your
	// transcription job. Note that custom language model names are case sensitive. The
	// language of the specified custom language model must match the language code
	// that you specify in your transcription request. If the languages do not match,
	// the custom language model isn't applied. There are no errors or warnings
	// associated with a language mismatch.
	LanguageModelName *string

	noSmithyDocumentSerde
}

// Flag the presence or absence of periods of silence in your Call Analytics
// transcription output. Rules using NonTalkTimeFilter are designed to match:
//   - The presence of silence at specified periods throughout the call
//   - The presence of speech at specified periods throughout the call
//
// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch)
// for usage examples.
type NonTalkTimeFilter struct {

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for a period of silence. See for more detail.
	AbsoluteTimeRange *AbsoluteTimeRange

	// Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence
	Negate *bool

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for a period of silence. See for more detail.
	RelativeTimeRange *RelativeTimeRange

	// Specify the duration, in milliseconds, of the period of silence that you want
	// to flag. For example, you can flag a silent period that lasts 30,000
	// milliseconds.
	Threshold *int64

	noSmithyDocumentSerde
}

// A time range, in percentage, between two points in your media file. You can use
// StartPercentage and EndPercentage to search a custom segment. For example,
// setting StartPercentage to 10 and EndPercentage to 50 only searches for your
// specified criteria in the audio contained between the 10 percent mark and the 50
// percent mark of your media file. You can use also First to search from the
// start of the media file until the time that you specify. Or use Last to search
// from the time that you specify until the end of the media file. For example,
// setting First to 10 only searches for your specified criteria in the audio
// contained in the first 10 percent of the media file. If you prefer to use
// milliseconds instead of percentage, see .
type RelativeTimeRange struct {

	// The time, in percentage, when Amazon Transcribe stops searching for the
	// specified criteria in your media file. If you include EndPercentage in your
	// request, you must also include StartPercentage .
	EndPercentage *int32

	// The time, in percentage, from the start of your media file until the specified
	// value. Amazon Transcribe searches for your specified criteria in this time
	// segment.
	First *int32

	// The time, in percentage, from the specified value until the end of your media
	// file. Amazon Transcribe searches for your specified criteria in this time
	// segment.
	Last *int32

	// The time, in percentage, when Amazon Transcribe starts searching for the
	// specified criteria in your media file. If you include StartPercentage in your
	// request, you must also include EndPercentage .
	StartPercentage *int32

	noSmithyDocumentSerde
}

// A rule is a set of criteria that you can specify to flag an attribute in your
// Call Analytics output. Rules define a Call Analytics category. Rules can include
// these parameters: , , , and . To learn more about Call Analytics rules and
// categories, see Creating categories for post-call transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html)
// and Creating categories for real-time transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html)
// . To learn more about Call Analytics, see Analyzing call center audio with Call
// Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html)
// .
//
// The following types satisfy this interface:
//
//	RuleMemberInterruptionFilter
//	RuleMemberNonTalkTimeFilter
//	RuleMemberSentimentFilter
//	RuleMemberTranscriptFilter
type Rule interface {
	isRule()
}

// Flag the presence or absence of interruptions in your Call Analytics
// transcription output. Refer to for more detail.
type RuleMemberInterruptionFilter struct {
	Value InterruptionFilter

	noSmithyDocumentSerde
}

func (*RuleMemberInterruptionFilter) isRule() {}

// Flag the presence or absence of periods of silence in your Call Analytics
// transcription output. Refer to for more detail.
type RuleMemberNonTalkTimeFilter struct {
	Value NonTalkTimeFilter

	noSmithyDocumentSerde
}

func (*RuleMemberNonTalkTimeFilter) isRule() {}

// Flag the presence or absence of specific sentiments in your Call Analytics
// transcription output. Refer to for more detail.
type RuleMemberSentimentFilter struct {
	Value SentimentFilter

	noSmithyDocumentSerde
}

func (*RuleMemberSentimentFilter) isRule() {}

// Flag the presence or absence of specific words or phrases in your Call
// Analytics transcription output. Refer to for more detail.
type RuleMemberTranscriptFilter struct {
	Value TranscriptFilter

	noSmithyDocumentSerde
}

func (*RuleMemberTranscriptFilter) isRule() {}

// Flag the presence or absence of specific sentiments detected in your Call
// Analytics transcription output. Rules using SentimentFilter are designed to
// match:
//   - The presence or absence of a positive sentiment felt by the customer,
//     agent, or both at specified points in the call
//   - The presence or absence of a negative sentiment felt by the customer,
//     agent, or both at specified points in the call
//   - The presence or absence of a neutral sentiment felt by the customer, agent,
//     or both at specified points in the call
//   - The presence or absence of a mixed sentiment felt by the customer, the
//     agent, or both at specified points in the call
//
// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch)
// for usage examples.
type SentimentFilter struct {

	// Specify the sentiments that you want to flag.
	//
	// This member is required.
	Sentiments []SentimentValue

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for the specified sentiments. See for more
	// detail.
	AbsoluteTimeRange *AbsoluteTimeRange

	// Set to TRUE to flag the sentiments that you didn't include in your request. Set
	// to FALSE to flag the sentiments that you specified in your request.
	Negate *bool

	// Specify the participant that you want to flag. Omitting this parameter is
	// equivalent to specifying both participants.
	ParticipantRole ParticipantRole

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for the specified sentiments. See for more
	// detail.
	RelativeTimeRange *RelativeTimeRange

	noSmithyDocumentSerde
}

// Allows additional optional settings in your request, including channel
// identification, alternative transcriptions, and speaker partitioning. You can
// use that to apply custom vocabularies to your transcription job.
type Settings struct {

	// Enables channel identification in multi-channel audio. Channel identification
	// transcribes the audio on each channel independently, then appends the output for
	// each channel into one transcript. For more information, see Transcribing
	// multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html)
	// .
	ChannelIdentification *bool

	// Indicate the maximum number of alternative transcriptions you want Amazon
	// Transcribe to include in your transcript. If you select a number greater than
	// the number of alternative transcriptions generated by Amazon Transcribe, only
	// the actual number of alternative transcriptions are included. If you include
	// MaxAlternatives in your request, you must also include ShowAlternatives with a
	// value of true . For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html)
	// .
	MaxAlternatives *int32

	// Specify the maximum number of speakers you want to partition in your media.
	// Note that if your media contains more speakers than the specified number,
	// multiple speakers are treated as a single speaker. If you specify the
	// MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
	MaxSpeakerLabels *int32

	// To include alternative transcriptions within your transcription output, include
	// ShowAlternatives in your transcription request. If you have multi-channel audio
	// and do not enable channel identification, your audio is transcribed in a
	// continuous manner and your transcript does not separate the speech by channel.
	// If you include ShowAlternatives , you must also include MaxAlternatives , which
	// is the maximum number of alternative transcriptions you want Amazon Transcribe
	// to generate. For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html)
	// .
	ShowAlternatives *bool

	// Enables speaker partitioning (diarization) in your transcription output.
	// Speaker partitioning labels the speech from individual speakers in your media
	// file. If you enable ShowSpeakerLabels in your request, you must also include
	// MaxSpeakerLabels . For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html)
	// .
	ShowSpeakerLabels *bool

	// Specify how you want your custom vocabulary filter applied to your transcript.
	// To replace words with *** , choose mask . To delete words, choose remove . To
	// flag words without changing them, choose tag .
	VocabularyFilterMethod VocabularyFilterMethod

	// The name of the custom vocabulary filter you want to use in your transcription
	// job request. This name is case sensitive, cannot contain spaces, and must be
	// unique within an Amazon Web Services account. Note that if you include
	// VocabularyFilterName in your request, you must also include
	// VocabularyFilterMethod .
	VocabularyFilterName *string

	// The name of the custom vocabulary you want to use in your transcription job
	// request. This name is case sensitive, cannot contain spaces, and must be unique
	// within an Amazon Web Services account.
	VocabularyName *string

	noSmithyDocumentSerde
}

// Generate subtitles for your media file with your transcription request. You can
// choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or
// both) as your output format. Note that your subtitle files are placed in the
// same location as your transcription output.
type Subtitles struct {

	// Specify the output format for your subtitle file; if you select both WebVTT ( vtt
	// ) and SubRip ( srt ) formats, two output files are generated.
	Formats []SubtitleFormat

	// Specify the starting value that is assigned to the first subtitle segment. The
	// default start index for Amazon Transcribe is 0 , which differs from the more
	// widely used standard of 1 . If you're uncertain which value to use, we recommend
	// choosing 1 , as this may improve compatibility with other services.
	OutputStartIndex *int32

	noSmithyDocumentSerde
}

// Provides information about your subtitle file, including format, start index,
// and Amazon S3 location.
type SubtitlesOutput struct {

	// Provides the format of your subtitle files. If your request included both
	// WebVTT ( vtt ) and SubRip ( srt ) formats, both formats are shown.
	Formats []SubtitleFormat

	// Provides the start index value for your subtitle files. If you did not specify
	// a value in your request, the default value of 0 is used.
	OutputStartIndex *int32

	// The Amazon S3 location of your transcript. You can use this URI to access or
	// download your subtitle file. Your subtitle file is stored in the same location
	// as your transcript. If you specified both WebVTT and SubRip subtitle formats,
	// two URIs are provided. If you included OutputBucketName in your transcription
	// job request, this is the URI of that bucket. If you also included OutputKey in
	// your request, your output is located in the path you specified in your request.
	// If you didn't include OutputBucketName in your transcription job request, your
	// subtitle file is stored in a service-managed bucket, and TranscriptFileUri
	// provides you with a temporary URI you can use for secure access to your subtitle
	// file. Temporary URIs for service-managed Amazon S3 buckets are only valid for 15
	// minutes. If you get an AccesDenied error, you can get a new temporary URI by
	// running a GetTranscriptionJob or ListTranscriptionJob request.
	SubtitleFileUris []string

	noSmithyDocumentSerde
}

// Contains GenerateAbstractiveSummary , which is a required parameter if you want
// to enable Generative call summarization in your Call Analytics request.
type Summarization struct {

	// Enables Generative call summarization in your Call Analytics request Generative
	// call summarization provides a summary of the transcript including important
	// components discussed in the conversation. For more information, see Enabling
	// generative call summarization (https://docs.aws.amazon.com/transcribe/latest/dg/tca-enable-summarization.html)
	// .
	//
	// This member is required.
	GenerateAbstractiveSummary *bool

	noSmithyDocumentSerde
}

// Adds metadata, in the form of a key:value pair, to the specified resource. For
// example, you could add the tag Department:Sales to a resource to indicate that
// it pertains to your organization's sales department. You can also use tags for
// tag-based access control. To learn more about tagging, see Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html)
// .
type Tag struct {

	// The first part of a key:value pair that forms a tag associated with a given
	// resource. For example, in the tag Department:Sales , the key is 'Department'.
	//
	// This member is required.
	Key *string

	// The second part of a key:value pair that forms a tag associated with a given
	// resource. For example, in the tag Department:Sales , the value is 'Sales'. Note
	// that you can set the value of a tag to an empty string, but you can't set the
	// value of a tag to null. Omitting the tag value is the same as using an empty
	// string.
	//
	// This member is required.
	Value *string

	noSmithyDocumentSerde
}

// Contains ToxicityCategories , which is a required parameter if you want to
// enable toxicity detection ( ToxicityDetection ) in your transcription request.
type ToxicityDetectionSettings struct {

	// If you include ToxicityDetection in your transcription request, you must also
	// include ToxicityCategories . The only accepted value for this parameter is ALL .
	//
	// This member is required.
	ToxicityCategories []ToxicityCategory

	noSmithyDocumentSerde
}

// Provides you with the Amazon S3 URI you can use to access your transcript.
type Transcript struct {

	// The Amazon S3 location of your redacted transcript. You can use this URI to
	// access or download your transcript. If you included OutputBucketName in your
	// transcription job request, this is the URI of that bucket. If you also included
	// OutputKey in your request, your output is located in the path you specified in
	// your request. If you didn't include OutputBucketName in your transcription job
	// request, your transcript is stored in a service-managed bucket, and
	// RedactedTranscriptFileUri provides you with a temporary URI you can use for
	// secure access to your transcript. Temporary URIs for service-managed Amazon S3
	// buckets are only valid for 15 minutes. If you get an AccesDenied error, you can
	// get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob
	// request.
	RedactedTranscriptFileUri *string

	// The Amazon S3 location of your transcript. You can use this URI to access or
	// download your transcript. If you included OutputBucketName in your
	// transcription job request, this is the URI of that bucket. If you also included
	// OutputKey in your request, your output is located in the path you specified in
	// your request. If you didn't include OutputBucketName in your transcription job
	// request, your transcript is stored in a service-managed bucket, and
	// TranscriptFileUri provides you with a temporary URI you can use for secure
	// access to your transcript. Temporary URIs for service-managed Amazon S3 buckets
	// are only valid for 15 minutes. If you get an AccesDenied error, you can get a
	// new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob
	// request.
	TranscriptFileUri *string

	noSmithyDocumentSerde
}

// Flag the presence or absence of specific words or phrases detected in your Call
// Analytics transcription output. Rules using TranscriptFilter are designed to
// match:
//   - Custom words or phrases spoken by the agent, the customer, or both
//   - Custom words or phrases not spoken by the agent, the customer, or either
//   - Custom words or phrases that occur at a specific time frame
//
// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch)
// and Rule criteria for streaming categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream)
// for usage examples.
type TranscriptFilter struct {

	// Specify the phrases that you want to flag.
	//
	// This member is required.
	Targets []string

	// Flag the presence or absence of an exact match to the phrases that you specify.
	// For example, if you specify the phrase "speak to a manager" as your Targets
	// value, only that exact phrase is flagged. Note that semantic matching is not
	// supported. For example, if your customer says "speak to the manager", instead of
	// "speak to a manager", your content is not flagged.
	//
	// This member is required.
	TranscriptFilterType TranscriptFilterType

	// Makes it possible to specify a time range (in milliseconds) in your audio,
	// during which you want to search for the specified key words or phrases. See for
	// more detail.
	AbsoluteTimeRange *AbsoluteTimeRange

	// Set to TRUE to flag the absence of the phrase that you specified in your
	// request. Set to FALSE to flag the presence of the phrase that you specified in
	// your request.
	Negate *bool

	// Specify the participant that you want to flag. Omitting this parameter is
	// equivalent to specifying both participants.
	ParticipantRole ParticipantRole

	// Makes it possible to specify a time range (in percentage) in your media file,
	// during which you want to search for the specified key words or phrases. See for
	// more detail.
	RelativeTimeRange *RelativeTimeRange

	noSmithyDocumentSerde
}

// Provides detailed information about a transcription job. To view the status of
// the specified transcription job, check the TranscriptionJobStatus field. If the
// status is COMPLETED , the job is finished and you can find the results at the
// location specified in TranscriptFileUri . If the status is FAILED ,
// FailureReason provides details on why your transcription job failed. If you
// enabled content redaction, the redacted transcript can be found at the location
// specified in RedactedTranscriptFileUri .
type TranscriptionJob struct {

	// The date and time the specified transcription job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// Indicates whether redaction was enabled in your transcript.
	ContentRedaction *ContentRedaction

	// The date and time the specified transcription job request was made. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// If TranscriptionJobStatus is FAILED , FailureReason contains information about
	// why the transcription job request failed. The FailureReason field contains one
	// of the following values:
	//   - Unsupported media format . The media format specified in MediaFormat isn't
	//   valid. Refer to refer to the MediaFormat parameter for a list of supported
	//   formats.
	//   - The media format provided does not match the detected media format . The
	//   media format specified in MediaFormat doesn't match the format of the input
	//   file. Check the media format of your media file and correct the specified value.
	//
	//   - Invalid sample rate for audio file . The sample rate specified in
	//   MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and
	//   48,000 hertz.
	//   - The sample rate provided does not match the detected sample rate . The
	//   sample rate specified in MediaSampleRateHertz doesn't match the sample rate
	//   detected in your input media file. Check the sample rate of your media file and
	//   correct the specified value.
	//   - Invalid file size: file size too large . The size of your media file is
	//   larger than what Amazon Transcribe can process. For more information, refer to
	//   Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
	//   .
	//   - Invalid number of channels: number of channels too large . Your audio
	//   contains more channels than Amazon Transcribe is able to process. For more
	//   information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
	//   .
	FailureReason *string

	// The confidence score associated with the language identified in your media
	// file. Confidence scores are values between 0 and 1; a larger value indicates a
	// higher probability that the identified language correctly matches the language
	// spoken in your media.
	IdentifiedLanguageScore *float32

	// Indicates whether automatic language identification was enabled ( TRUE ) for the
	// specified transcription job.
	IdentifyLanguage *bool

	// Indicates whether automatic multi-language identification was enabled ( TRUE )
	// for the specified transcription job.
	IdentifyMultipleLanguages *bool

	// Provides information about how your transcription job was processed. This
	// parameter shows if your request was queued and what data access role was used.
	JobExecutionSettings *JobExecutionSettings

	// The language code used to create your transcription job. This parameter is used
	// with single-language identification. For multi-language identification requests,
	// refer to the plural version of this parameter, LanguageCodes .
	LanguageCode LanguageCode

	// The language codes used to create your transcription job. This parameter is
	// used with multi-language identification. For single-language identification
	// requests, refer to the singular version of this parameter, LanguageCode .
	LanguageCodes []LanguageCodeItem

	// Provides the name and language of all custom language models, custom
	// vocabularies, and custom vocabulary filters that you included in your request.
	LanguageIdSettings map[string]LanguageIdSettings

	// Provides the language codes you specified in your request.
	LanguageOptions []LanguageCode

	// Provides the Amazon S3 location of the media file you used in your request.
	Media *Media

	// The format of the input media file.
	MediaFormat MediaFormat

	// The sample rate, in hertz, of the audio track in your input media file.
	MediaSampleRateHertz *int32

	// Provides information on the custom language model you included in your request.
	ModelSettings *ModelSettings

	// Provides information on any additional settings that were included in your
	// request. Additional settings include channel identification, alternative
	// transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary
	// filters.
	Settings *Settings

	// The date and time the specified transcription job began processing. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	// Indicates whether subtitles were generated with your transcription.
	Subtitles *SubtitlesOutput

	// The tags, each in the form of a key:value pair, assigned to the specified
	// transcription job.
	Tags []Tag

	// Provides information about the toxicity detection settings applied to your
	// transcription.
	ToxicityDetection []ToxicityDetectionSettings

	// Provides you with the Amazon S3 URI you can use to access your transcript.
	Transcript *Transcript

	// The name of the transcription job. Job names are case sensitive and must be
	// unique within an Amazon Web Services account.
	TranscriptionJobName *string

	// Provides the status of the specified transcription job. If the status is
	// COMPLETED , the job is finished and you can find the results at the location
	// specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested
	// transcript redaction). If the status is FAILED , FailureReason provides details
	// on why your transcription job failed.
	TranscriptionJobStatus TranscriptionJobStatus

	noSmithyDocumentSerde
}

// Provides detailed information about a specific transcription job.
type TranscriptionJobSummary struct {

	// The date and time the specified transcription job finished processing.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
	// processing at 12:33 PM UTC-7 on May 4, 2022.
	CompletionTime *time.Time

	// The content redaction settings of the transcription job.
	ContentRedaction *ContentRedaction

	// The date and time the specified transcription job request was made. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	CreationTime *time.Time

	// If TranscriptionJobStatus is FAILED , FailureReason contains information about
	// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
	// .
	FailureReason *string

	// The confidence score associated with the language identified in your media
	// file. Confidence scores are values between 0 and 1; a larger value indicates a
	// higher probability that the identified language correctly matches the language
	// spoken in your media.
	IdentifiedLanguageScore *float32

	// Indicates whether automatic language identification was enabled ( TRUE ) for the
	// specified transcription job.
	IdentifyLanguage *bool

	// Indicates whether automatic multi-language identification was enabled ( TRUE )
	// for the specified transcription job.
	IdentifyMultipleLanguages *bool

	// The language code used to create your transcription.
	LanguageCode LanguageCode

	// The language codes used to create your transcription job. This parameter is
	// used with multi-language identification. For single-language identification, the
	// singular version of this parameter, LanguageCode , is present.
	LanguageCodes []LanguageCodeItem

	// Provides the name of the custom language model that was included in the
	// specified transcription job. Only use ModelSettings with the LanguageModelName
	// sub-parameter if you're not using automatic language identification ( ). If
	// using LanguageIdSettings in your request, this parameter contains a
	// LanguageModelName sub-parameter.
	ModelSettings *ModelSettings

	// Indicates where the specified transcription output is stored. If the value is
	// CUSTOMER_BUCKET , the location is the Amazon S3 bucket you specified using the
	// OutputBucketName parameter in your request. If you also included OutputKey in
	// your request, your output is located in the path you specified in your request.
	// If the value is SERVICE_BUCKET , the location is a service-managed Amazon S3
	// bucket. To access a transcript stored in a service-managed bucket, use the URI
	// shown in the TranscriptFileUri or RedactedTranscriptFileUri field.
	OutputLocationType OutputLocationType

	// The date and time your transcription job began processing. Timestamps are in
	// the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
	// processing at 12:32 PM UTC-7 on May 4, 2022.
	StartTime *time.Time

	// Indicates whether toxicity detection was enabled for the specified
	// transcription job.
	ToxicityDetection []ToxicityDetectionSettings

	// The name of the transcription job. Job names are case sensitive and must be
	// unique within an Amazon Web Services account.
	TranscriptionJobName *string

	// Provides the status of your transcription job. If the status is COMPLETED , the
	// job is finished and you can find the results at the location specified in
	// TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript
	// redaction). If the status is FAILED , FailureReason provides details on why
	// your transcription job failed.
	TranscriptionJobStatus TranscriptionJobStatus

	noSmithyDocumentSerde
}

// Provides information about a custom vocabulary filter, including the language
// of the filter, when it was last modified, and its name.
type VocabularyFilterInfo struct {

	// The language code that represents the language of the entries in your
	// vocabulary filter. Each custom vocabulary filter must contain terms in only one
	// language. A custom vocabulary filter can only be used to transcribe files in the
	// same language as the filter. For example, if you create a custom vocabulary
	// filter using US English ( en-US ), you can only apply this filter to files that
	// contain English audio. For a list of supported languages and their associated
	// language codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
	// table.
	LanguageCode LanguageCode

	// The date and time the specified custom vocabulary filter was last modified.
	// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time

	// A unique name, chosen by you, for your custom vocabulary filter. This name is
	// case sensitive, cannot contain spaces, and must be unique within an Amazon Web
	// Services account.
	VocabularyFilterName *string

	noSmithyDocumentSerde
}

// Provides information about a custom vocabulary, including the language of the
// custom vocabulary, when it was last modified, its name, and the processing
// state.
type VocabularyInfo struct {

	// The language code used to create your custom vocabulary. Each custom vocabulary
	// must contain terms in only one language. A custom vocabulary can only be used to
	// transcribe files in the same language as the custom vocabulary. For example, if
	// you create a custom vocabulary using US English ( en-US ), you can only apply
	// this custom vocabulary to files that contain English audio.
	LanguageCode LanguageCode

	// The date and time the specified custom vocabulary was last modified. Timestamps
	// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
	// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
	LastModifiedTime *time.Time

	// A unique name, chosen by you, for your custom vocabulary. This name is case
	// sensitive, cannot contain spaces, and must be unique within an Amazon Web
	// Services account.
	VocabularyName *string

	// The processing state of your custom vocabulary. If the state is READY , you can
	// use the custom vocabulary in a StartTranscriptionJob request.
	VocabularyState VocabularyState

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde

// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
	Tag   string
	Value []byte

	noSmithyDocumentSerde
}

func (*UnknownUnionMember) isRule() {}