@aws-sdk/client-transcribe 3.53.0 → 3.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/dist-cjs/TranscribeClient.js +13 -13
  3. package/dist-cjs/commands/CreateCallAnalyticsCategoryCommand.js +3 -3
  4. package/dist-cjs/commands/CreateLanguageModelCommand.js +3 -3
  5. package/dist-cjs/commands/CreateMedicalVocabularyCommand.js +3 -3
  6. package/dist-cjs/commands/CreateVocabularyCommand.js +3 -3
  7. package/dist-cjs/commands/CreateVocabularyFilterCommand.js +3 -3
  8. package/dist-cjs/commands/DeleteCallAnalyticsCategoryCommand.js +3 -3
  9. package/dist-cjs/commands/DeleteCallAnalyticsJobCommand.js +3 -3
  10. package/dist-cjs/commands/DeleteLanguageModelCommand.js +3 -3
  11. package/dist-cjs/commands/DeleteMedicalTranscriptionJobCommand.js +3 -3
  12. package/dist-cjs/commands/DeleteMedicalVocabularyCommand.js +3 -3
  13. package/dist-cjs/commands/DeleteTranscriptionJobCommand.js +3 -3
  14. package/dist-cjs/commands/DeleteVocabularyCommand.js +3 -3
  15. package/dist-cjs/commands/DeleteVocabularyFilterCommand.js +3 -3
  16. package/dist-cjs/commands/DescribeLanguageModelCommand.js +3 -3
  17. package/dist-cjs/commands/GetCallAnalyticsCategoryCommand.js +3 -3
  18. package/dist-cjs/commands/GetCallAnalyticsJobCommand.js +3 -3
  19. package/dist-cjs/commands/GetMedicalTranscriptionJobCommand.js +3 -3
  20. package/dist-cjs/commands/GetMedicalVocabularyCommand.js +3 -3
  21. package/dist-cjs/commands/GetTranscriptionJobCommand.js +3 -3
  22. package/dist-cjs/commands/GetVocabularyCommand.js +3 -3
  23. package/dist-cjs/commands/GetVocabularyFilterCommand.js +3 -3
  24. package/dist-cjs/commands/ListCallAnalyticsCategoriesCommand.js +3 -3
  25. package/dist-cjs/commands/ListCallAnalyticsJobsCommand.js +3 -3
  26. package/dist-cjs/commands/ListLanguageModelsCommand.js +3 -3
  27. package/dist-cjs/commands/ListMedicalTranscriptionJobsCommand.js +3 -3
  28. package/dist-cjs/commands/ListMedicalVocabulariesCommand.js +3 -3
  29. package/dist-cjs/commands/ListTagsForResourceCommand.js +3 -3
  30. package/dist-cjs/commands/ListTranscriptionJobsCommand.js +3 -3
  31. package/dist-cjs/commands/ListVocabulariesCommand.js +3 -3
  32. package/dist-cjs/commands/ListVocabularyFiltersCommand.js +3 -3
  33. package/dist-cjs/commands/StartCallAnalyticsJobCommand.js +3 -3
  34. package/dist-cjs/commands/StartMedicalTranscriptionJobCommand.js +3 -3
  35. package/dist-cjs/commands/StartTranscriptionJobCommand.js +3 -3
  36. package/dist-cjs/commands/TagResourceCommand.js +3 -3
  37. package/dist-cjs/commands/UntagResourceCommand.js +3 -3
  38. package/dist-cjs/commands/UpdateCallAnalyticsCategoryCommand.js +3 -3
  39. package/dist-cjs/commands/UpdateMedicalVocabularyCommand.js +3 -3
  40. package/dist-cjs/commands/UpdateVocabularyCommand.js +3 -3
  41. package/dist-cjs/commands/UpdateVocabularyFilterCommand.js +3 -3
  42. package/dist-cjs/endpoints.js +1 -1
  43. package/dist-cjs/protocols/Aws_json1_1.js +250 -250
  44. package/dist-cjs/runtimeConfig.browser.js +4 -4
  45. package/dist-cjs/runtimeConfig.js +9 -9
  46. package/dist-cjs/runtimeConfig.native.js +1 -1
  47. package/dist-es/Transcribe.js +39 -39
  48. package/dist-es/pagination/ListCallAnalyticsCategoriesPaginator.js +4 -4
  49. package/dist-es/pagination/ListCallAnalyticsJobsPaginator.js +4 -4
  50. package/dist-es/pagination/ListLanguageModelsPaginator.js +4 -4
  51. package/dist-es/pagination/ListMedicalTranscriptionJobsPaginator.js +4 -4
  52. package/dist-es/pagination/ListMedicalVocabulariesPaginator.js +4 -4
  53. package/dist-es/pagination/ListTranscriptionJobsPaginator.js +4 -4
  54. package/dist-es/pagination/ListVocabulariesPaginator.js +4 -4
  55. package/dist-es/pagination/ListVocabularyFiltersPaginator.js +4 -4
  56. package/dist-types/Transcribe.d.ts +71 -39
  57. package/dist-types/TranscribeClient.d.ts +2 -2
  58. package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +7 -5
  59. package/dist-types/commands/CreateLanguageModelCommand.d.ts +5 -3
  60. package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +10 -2
  61. package/dist-types/commands/CreateVocabularyCommand.d.ts +7 -2
  62. package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +3 -2
  63. package/dist-types/commands/DeleteCallAnalyticsCategoryCommand.d.ts +2 -1
  64. package/dist-types/commands/DeleteCallAnalyticsJobCommand.d.ts +2 -1
  65. package/dist-types/commands/DeleteLanguageModelCommand.d.ts +2 -1
  66. package/dist-types/commands/DeleteMedicalTranscriptionJobCommand.d.ts +3 -1
  67. package/dist-types/commands/DeleteMedicalVocabularyCommand.d.ts +2 -1
  68. package/dist-types/commands/DeleteTranscriptionJobCommand.d.ts +3 -2
  69. package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
  70. package/dist-types/commands/DeleteVocabularyFilterCommand.d.ts +2 -1
  71. package/dist-types/commands/DescribeLanguageModelCommand.d.ts +7 -5
  72. package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +6 -5
  73. package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +4 -3
  74. package/dist-types/commands/GetTranscriptionJobCommand.d.ts +4 -3
  75. package/dist-types/models/models_0.d.ts +178 -137
  76. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  77. package/dist-types/runtimeConfig.d.ts +1 -1
  78. package/dist-types/runtimeConfig.native.d.ts +3 -3
  79. package/dist-types/ts3.4/TranscribeClient.d.ts +2 -2
  80. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  81. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  82. package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
  83. package/package.json +34 -34
@@ -154,14 +154,14 @@ export interface Media {
154
154
  * <p>The S3 object location of the input media file. The URI must be in the same region as
155
155
  * the API endpoint that you are calling. The general form is:</p>
156
156
  * <p>
157
- * <code> s3://<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey></code>
157
+ * <code>s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey</code>
158
158
  * </p>
159
159
  * <p>For example:</p>
160
160
  * <p>
161
- * <code>s3://AWSDOC-EXAMPLE-BUCKET/example.mp4</code>
161
+ * <code>s3://DOC-EXAMPLE-BUCKET/example.flac</code>
162
162
  * </p>
163
163
  * <p>
164
- * <code>s3://AWSDOC-EXAMPLE-BUCKET/mediadocs/example.mp4</code>
164
+ * <code>s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac</code>
165
165
  * </p>
166
166
  * <p>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
167
167
  * <i>Amazon S3 Developer Guide</i>.</p>
@@ -869,13 +869,16 @@ export declare class ConflictException extends __BaseException {
869
869
  }
870
870
  export interface CreateCallAnalyticsCategoryRequest {
871
871
  /**
872
- * <p>The name that you choose for your category when you create it. </p>
872
+ * <p>A unique name, chosen by you, for your call analytics category. For example,
873
+ * <code>sentiment-positive-last30seconds</code>.</p>
873
874
  */
874
875
  CategoryName: string | undefined;
875
876
  /**
876
- * <p>To create a category, you must specify between 1 and 20 rules. For each rule, you
877
- * specify a filter to be applied to the attributes of the call. For example, you can specify a
878
- * sentiment filter to detect if the customer's sentiment was negative or neutral.</p>
877
+ * <p>Rules make up a call analytics category. When creating a call analytics category,
878
+ * you must create between 1 and 20 rules for your category. For each rule, you
879
+ * specify a filter you want applied to the attributes of a call. For example, you can choose
880
+ * a sentiment filter that detects if a customer's sentiment was positive during the last
881
+ * 30 seconds of the call.</p>
879
882
  */
880
883
  Rules: Rule[] | undefined;
881
884
  }
@@ -887,7 +890,13 @@ export declare namespace CreateCallAnalyticsCategoryRequest {
887
890
  }
888
891
  export interface CreateCallAnalyticsCategoryResponse {
889
892
  /**
890
- * <p>The rules and associated metadata used to create a category.</p>
893
+ * <p>If your audio matches one of your categories, this field contains data on that
894
+ * category and its associated rules. This parameter shows which category is flagged
895
+ * (<code>CategoryName</code>) along with metadata for the rules that match your
896
+ * audio. Metadata includes the rule filter (such as <code>InterruptionFilter</code>,
897
+ * <code>NonTalkTimeFilter</code>, <code>SentimentFilter</code>, and
898
+ * <code>TranscriptFilter</code>) and where in your audio (<code>StartTime</code>
899
+ * and <code>EndTime</code>) the rule has a match.</p>
891
900
  */
892
901
  CategoryProperties?: CategoryProperties;
893
902
  }
@@ -976,31 +985,35 @@ export declare namespace Tag {
976
985
  }
977
986
  export interface CreateLanguageModelRequest {
978
987
  /**
979
- * <p>The language of the input text you're using to train your custom language
980
- * model.</p>
988
+ * <p>The language of your custom language model; note that the language code you
989
+ * select must match the language of your training and tuning data.</p>
981
990
  */
982
991
  LanguageCode: CLMLanguageCode | string | undefined;
983
992
  /**
984
- * <p>The Amazon Transcribe standard language model, or base model used to create your custom
985
- * language model.</p>
986
- * <p>If you want to use your custom language model to transcribe audio with a sample rate
987
- * of 16,000 Hz or greater, choose <code>Wideband</code>.</p>
988
- * <p>If you want to use your custom language model to transcribe audio with a sample rate
989
- * that is less than 16,000 Hz, choose <code>Narrowband</code>.</p>
993
+ * <p>The Amazon Transcribe standard language model, or base model, used to create your
994
+ * custom language model. Amazon Transcribe offers two options for base models: Wideband and
995
+ * Narrowband.</p>
996
+ * <p>If the audio you want to transcribe has a sample rate of 16,000 Hz or greater,
997
+ * choose <code>WideBand</code>. To transcribe audio with a sample rate less than
998
+ * 16,000 Hz, choose <code>NarrowBand</code>.</p>
990
999
  */
991
1000
  BaseModelName: BaseModelName | string | undefined;
992
1001
  /**
993
- * <p>The name you choose for your custom language model when you create it.</p>
1002
+ * <p>The name of your new custom language model.</p>
1003
+ * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1004
+ * Amazon Web Services account. If you try to create a language model with the same name as a
1005
+ * previous language model, you get a <code>ConflictException</code> error.</p>
994
1006
  */
995
1007
  ModelName: string | undefined;
996
1008
  /**
997
- * <p>Contains the data access role and the Amazon S3 prefixes to read the required input files to
998
- * create a custom language model.</p>
1009
+ * <p>Contains your data access role ARN (Amazon Resource Name) and the Amazon S3
1010
+ * locations of your training (<code>S3Uri</code>) and tuning
1011
+ * (<code>TuningDataS3Uri</code>) data.</p>
999
1012
  */
1000
1013
  InputDataConfig: InputDataConfig | undefined;
1001
1014
  /**
1002
- * <p>Adds one or more tags, each in the form of a key:value pair, to a new language model
1003
- * at the time you create this new model.</p>
1015
+ * <p>Optionally add tags, each in the form of a key:value pair, to your new language
1016
+ * model. See also: .</p>
1004
1017
  */
1005
1018
  Tags?: Tag[];
1006
1019
  }
@@ -1017,25 +1030,30 @@ export declare enum ModelStatus {
1017
1030
  }
1018
1031
  export interface CreateLanguageModelResponse {
1019
1032
  /**
1020
- * <p>The language code of the text you've used to create a custom language model.</p>
1033
+ * <p>The language code you selected for your custom language model.</p>
1021
1034
  */
1022
1035
  LanguageCode?: CLMLanguageCode | string;
1023
1036
  /**
1024
- * <p>The Amazon Transcribe standard language model, or base model you've used to create a custom
1025
- * language model.</p>
1037
+ * <p>The Amazon Transcribe standard language model, or base model, you used when creating your
1038
+ * custom language model.</p>
1039
+ * <p>If your audio has a sample rate of 16,000 Hz or greater, this value should be
1040
+ * <code>WideBand</code>. If your audio has a sample rate of less than
1041
+ * 16,000 Hz, this value should be <code>NarrowBand</code>.</p>
1026
1042
  */
1027
1043
  BaseModelName?: BaseModelName | string;
1028
1044
  /**
1029
- * <p>The name you've chosen for your custom language model.</p>
1045
+ * <p>The unique name you chose for your custom language model.</p>
1030
1046
  */
1031
1047
  ModelName?: string;
1032
1048
  /**
1033
- * <p>The data access role and Amazon S3 prefixes you've chosen to create your custom language model.</p>
1049
+ * <p>Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
1050
+ * locations your provided for your training (<code>S3Uri</code>) and tuning
1051
+ * (<code>TuningDataS3Uri</code>) data.</p>
1034
1052
  */
1035
1053
  InputDataConfig?: InputDataConfig;
1036
1054
  /**
1037
- * <p>The status of the custom language model. When the status is
1038
- * <code>COMPLETED</code> the model is ready to use.</p>
1055
+ * <p>The status of your custom language model. When the status shows as
1056
+ * <code>COMPLETED</code>, your model is ready to use.</p>
1039
1057
  */
1040
1058
  ModelStatus?: ModelStatus | string;
1041
1059
  }
@@ -1047,37 +1065,32 @@ export declare namespace CreateLanguageModelResponse {
1047
1065
  }
1048
1066
  export interface CreateMedicalVocabularyRequest {
1049
1067
  /**
1050
- * <p>The name of the custom vocabulary. This case-sensitive name must be unique within
1051
- * an Amazon Web Services account. If you try to create a vocabulary with the same name
1052
- * as a previous vocabulary, you get a <code>ConflictException</code> error.</p>
1068
+ * <p>The name of your new vocabulary.</p>
1069
+ * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1070
+ * Amazon Web Services account. If you try to create a vocabulary with the same name as a
1071
+ * previous vocabulary, you get a <code>ConflictException</code> error.</p>
1053
1072
  */
1054
1073
  VocabularyName: string | undefined;
1055
1074
  /**
1056
- * <p>The language code for the language used for the entries in your custom vocabulary.
1057
- * The language code of your custom vocabulary must match the language code of your
1058
- * transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.</p>
1075
+ * <p>The language code that represents the language of the entries in your custom
1076
+ * vocabulary. Note that U.S. English (<code>en-US</code>) is the only language
1077
+ * supported with Amazon Transcribe Medical.</p>
1059
1078
  */
1060
1079
  LanguageCode: LanguageCode | string | undefined;
1061
1080
  /**
1062
- * <p>The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI
1063
- * must be in the same Amazon Web Services Region as the resource that you're calling. Enter
1064
- * information about your <code>VocabularyFileUri</code> in the following format:</p>
1081
+ * <p>The Amazon S3 location (URI) of the text file that contains your custom vocabulary.
1082
+ * The URI must be in the same Amazon Web Services Region as the resource that you're
1083
+ * calling.</p>
1084
+ * <p>Here's an example URI path:</p>
1065
1085
  * <p>
1066
- * <code>https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey></code>
1067
- * </p>
1068
- * <p>The following is an example URI for a vocabulary file that is stored in Amazon S3:</p>
1069
- * <p>
1070
- * <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
1086
+ * <code>https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt</code>
1071
1087
  * </p>
1072
- * <p>For more information about Amazon S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in
1073
- * the <i>Amazon S3 Developer Guide</i>.</p>
1074
- * <p>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html">Medical Custom
1075
- * Vocabularies</a>.</p>
1076
1088
  */
1077
1089
  VocabularyFileUri: string | undefined;
1078
1090
  /**
1079
1091
  * <p>Adds one or more tags, each in the form of a key:value pair, to a new medical
1080
- * vocabulary at the time you create this new vocabulary.</p>
1092
+ * vocabulary at the time you create the new vocabulary.</p>
1093
+ * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</p>
1081
1094
  */
1082
1095
  Tags?: Tag[];
1083
1096
  }
@@ -1094,28 +1107,27 @@ export declare enum VocabularyState {
1094
1107
  }
1095
1108
  export interface CreateMedicalVocabularyResponse {
1096
1109
  /**
1097
- * <p>The name of the vocabulary. The name must be unique within an Amazon Web Services
1098
- * account and is case sensitive.</p>
1110
+ * <p>The name you chose for your vocabulary.</p>
1099
1111
  */
1100
1112
  VocabularyName?: string;
1101
1113
  /**
1102
- * <p>The language code for the entries in your custom vocabulary. US English (en-US) is the
1103
- * only valid language code for Amazon Transcribe Medical.</p>
1114
+ * <p>The language code you selected for your medical vocabulary. Note that U.S. English
1115
+ * (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>
1104
1116
  */
1105
1117
  LanguageCode?: LanguageCode | string;
1106
1118
  /**
1107
- * <p>The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is
1119
+ * <p>The processing state of your custom medical vocabulary. If the state is
1108
1120
  * <code>READY</code>, you can use the vocabulary in a
1109
1121
  * <code>StartMedicalTranscriptionJob</code> request.</p>
1110
1122
  */
1111
1123
  VocabularyState?: VocabularyState | string;
1112
1124
  /**
1113
- * <p>The date and time that you created the vocabulary.</p>
1125
+ * <p>The date and time you created your custom medical vocabulary.</p>
1114
1126
  */
1115
1127
  LastModifiedTime?: Date;
1116
1128
  /**
1117
- * <p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains
1118
- * information about why the job failed.</p>
1129
+ * <p>If the <code>VocabularyState</code> field is <code>FAILED</code>,
1130
+ * <code>FailureReason</code> contains information about why the job failed.</p>
1119
1131
  */
1120
1132
  FailureReason?: string;
1121
1133
  }
@@ -1127,40 +1139,39 @@ export declare namespace CreateMedicalVocabularyResponse {
1127
1139
  }
1128
1140
  export interface CreateVocabularyRequest {
1129
1141
  /**
1130
- * <p>The name of the vocabulary. The name must be unique within an
1131
- * Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary
1132
- * with the same name as a previous vocabulary you will receive a
1133
- * <code>ConflictException</code> error.</p>
1142
+ * <p>The name of your new vocabulary.</p>
1143
+ * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1144
+ * Amazon Web Services account. If you try to create a vocabulary with the same name as a
1145
+ * previous vocabulary, you get a <code>ConflictException</code> error.</p>
1134
1146
  */
1135
1147
  VocabularyName: string | undefined;
1136
1148
  /**
1137
- * <p>The language code of the vocabulary entries. For a list of languages and their
1138
- * corresponding language codes, see <a>table-language-matrix</a>.</p>
1149
+ * <p>The language code that represents the language of the entries in your custom
1150
+ * vocabulary. Each vocabulary must contain terms in only one language. For a list of
1151
+ * languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
1152
+ * languages</a>.</p>
1139
1153
  */
1140
1154
  LanguageCode: LanguageCode | string | undefined;
1141
1155
  /**
1142
- * <p>An array of strings that contains the vocabulary entries. </p>
1156
+ * <p>Use this flag to include a list of terms within your request.</p>
1157
+ * <p>Note that if you include <code>Phrases</code> in your request, you cannot
1158
+ * use <code>VocabularyFileUri</code>; you must choose one or the other.</p>
1143
1159
  */
1144
1160
  Phrases?: string[];
1145
1161
  /**
1146
- * <p>The S3 location of the text file that contains the definition of the custom vocabulary. The
1147
- * URI must be in the same region as the API endpoint that you are calling. The general form
1148
- * is:</p>
1149
- * <p>
1150
- * <code>https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey> </code>
1151
- * </p>
1152
- * <p>For example:</p>
1153
- * <p>
1154
- * <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
1162
+ * <p>The S3 location of the text file that contains your custom vocabulary. The
1163
+ * URI must be located in the same region as the API endpoint you're calling.</p>
1164
+ * <p>Here's an example URI path:</p>
1165
+ * <p>
1166
+ * <code>https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt</code>
1155
1167
  * </p>
1156
- * <p>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
1157
- * <i>Amazon S3 Developer Guide</i>.</p>
1158
- * <p>For more information about custom vocabularies, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom vocabularies</a>.</p>
1168
+ * <p>Note that if you include <code>VocabularyFileUri</code> in your request, you
1169
+ * cannot use the <code>Phrases</code> flag; you must choose one or the other.</p>
1159
1170
  */
1160
1171
  VocabularyFileUri?: string;
1161
1172
  /**
1162
- * <p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at
1163
- * the time you create this new vocabulary.</p>
1173
+ * <p>Adds one or more tags, each in the form of a key:value pair, to a new
1174
+ * custom vocabulary at the time you create this new vocabulary.</p>
1164
1175
  */
1165
1176
  Tags?: Tag[];
1166
1177
  }
@@ -1172,26 +1183,25 @@ export declare namespace CreateVocabularyRequest {
1172
1183
  }
1173
1184
  export interface CreateVocabularyResponse {
1174
1185
  /**
1175
- * <p>The name of the vocabulary.</p>
1186
+ * <p>The name you chose for your vocabulary.</p>
1176
1187
  */
1177
1188
  VocabularyName?: string;
1178
1189
  /**
1179
- * <p>The language code of the vocabulary entries.</p>
1190
+ * <p>The language code you selected for your vocabulary.</p>
1180
1191
  */
1181
1192
  LanguageCode?: LanguageCode | string;
1182
1193
  /**
1183
- * <p>The processing state of the vocabulary. When the <code>VocabularyState</code> field
1184
- * contains <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code>
1185
- * request.</p>
1194
+ * <p>The processing state of your vocabulary. If the state is <code>READY</code>, you can
1195
+ * use the vocabulary in a <code>StartTranscriptionJob</code> request.</p>
1186
1196
  */
1187
1197
  VocabularyState?: VocabularyState | string;
1188
1198
  /**
1189
- * <p>The date and time that the vocabulary was created.</p>
1199
+ * <p>The date and time you created your custom vocabulary.</p>
1190
1200
  */
1191
1201
  LastModifiedTime?: Date;
1192
1202
  /**
1193
- * <p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains
1194
- * information about why the job failed.</p>
1203
+ * <p>If the <code>VocabularyState</code> field is <code>FAILED</code>,
1204
+ * <code>FailureReason</code> contains information about why the job failed.</p>
1195
1205
  */
1196
1206
  FailureReason?: string;
1197
1207
  }
@@ -1203,9 +1213,10 @@ export declare namespace CreateVocabularyResponse {
1203
1213
  }
1204
1214
  export interface CreateVocabularyFilterRequest {
1205
1215
  /**
1206
- * <p>The vocabulary filter name. The name must be unique within the account that contains
1207
- * it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you
1208
- * get a <code>ConflictException</code> error.</p>
1216
+ * <p>The name of your new vocabulary filter.</p>
1217
+ * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1218
+ * Amazon Web Services account. If you try to create a vocabulary filter with the same name
1219
+ * as a previous vocabulary filter, you get a <code>ConflictException</code> error.</p>
1209
1220
  */
1210
1221
  VocabularyFilterName: string | undefined;
1211
1222
  /**
@@ -1215,25 +1226,25 @@ export interface CreateVocabularyFilterRequest {
1215
1226
  */
1216
1227
  LanguageCode: LanguageCode | string | undefined;
1217
1228
  /**
1218
- * <p>The words to use in the vocabulary filter. Only use characters from the character set
1219
- * defined for custom vocabularies. For a list of character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
1220
- * Vocabularies</a>.</p>
1221
- * <p>If you provide a list of words in the <code>Words</code> parameter, you can't use the
1222
- * <code>VocabularyFilterFileUri</code> parameter.</p>
1229
+ * <p>The words you want in your vocabulary filter. Only use characters specified in the
1230
+ * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character
1231
+ * sets</a> for the language you're transcribing.</p>
1232
+ * <p>Note that if you include <code>Words</code> in your request, you cannot use
1233
+ * <code>VocabularyFilterFileUri</code>; you must choose one or the other.</p>
1223
1234
  */
1224
1235
  Words?: string[];
1225
1236
  /**
1226
1237
  * <p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only
1227
- * use characters from the character set defined for custom vocabularies. For a list of character
1228
- * sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
1238
+ * use characters from the character set defined for custom vocabularies. For a list of
1239
+ * character sets, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
1229
1240
  * Vocabularies</a>.</p>
1230
- * <p>The specified file must be less than 50 KB of UTF-8 characters.</p>
1231
- * <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code>
1232
- * parameter, you can't use the <code>Words</code> parameter.</p>
1241
+ * <p>Your vocabulary filter file must be less than 50 KB in size.</p>
1242
+ * <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you
1243
+ * cannot use <code>Words</code>; you must choose one or the other.</p>
1233
1244
  */
1234
1245
  VocabularyFilterFileUri?: string;
1235
1246
  /**
1236
- * <p>Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary
1247
+ * <p>Adds one or more tags, each in the form of a key:value pair, to a new vocabulary
1237
1248
  * filter at the time you create this new vocabulary filter.</p>
1238
1249
  */
1239
1250
  Tags?: Tag[];
@@ -1250,11 +1261,11 @@ export interface CreateVocabularyFilterResponse {
1250
1261
  */
1251
1262
  VocabularyFilterName?: string;
1252
1263
  /**
1253
- * <p>The language code of the words in the collection.</p>
1264
+ * <p>The language code associated with your vocabulary filter.</p>
1254
1265
  */
1255
1266
  LanguageCode?: LanguageCode | string;
1256
1267
  /**
1257
- * <p>The date and time that the vocabulary filter was modified.</p>
1268
+ * <p>The date and time the vocabulary filter was modified.</p>
1258
1269
  */
1259
1270
  LastModifiedTime?: Date;
1260
1271
  }
@@ -1266,8 +1277,8 @@ export declare namespace CreateVocabularyFilterResponse {
1266
1277
  }
1267
1278
  export interface DeleteCallAnalyticsCategoryRequest {
1268
1279
  /**
1269
- * <p>The name of the call analytics category that you're choosing to delete. The value is case
1270
- * sensitive. </p>
1280
+ * <p>The name of the call analytics category you want to delete. Category names are
1281
+ * case-sensitive.</p>
1271
1282
  */
1272
1283
  CategoryName: string | undefined;
1273
1284
  }
@@ -1299,7 +1310,8 @@ export declare class NotFoundException extends __BaseException {
1299
1310
  }
1300
1311
  export interface DeleteCallAnalyticsJobRequest {
1301
1312
  /**
1302
- * <p>The name of the call analytics job you want to delete.</p>
1313
+ * <p>The name of the call analytics job you want to delete. Job names are
1314
+ * case-sensitive.</p>
1303
1315
  */
1304
1316
  CallAnalyticsJobName: string | undefined;
1305
1317
  }
@@ -1319,7 +1331,7 @@ export declare namespace DeleteCallAnalyticsJobResponse {
1319
1331
  }
1320
1332
  export interface DeleteLanguageModelRequest {
1321
1333
  /**
1322
- * <p>The name of the model you're choosing to delete.</p>
1334
+ * <p>The name of the model you want to delete. Model names are case-sensitive.</p>
1323
1335
  */
1324
1336
  ModelName: string | undefined;
1325
1337
  }
@@ -1331,8 +1343,8 @@ export declare namespace DeleteLanguageModelRequest {
1331
1343
  }
1332
1344
  export interface DeleteMedicalTranscriptionJobRequest {
1333
1345
  /**
1334
- * <p>The name you provide to the <code>DeleteMedicalTranscriptionJob</code> object to
1335
- * delete a transcription job.</p>
1346
+ * <p>The name of the medical transcription job you want to delete. Job names are
1347
+ * case-sensitive.</p>
1336
1348
  */
1337
1349
  MedicalTranscriptionJobName: string | undefined;
1338
1350
  }
@@ -1344,7 +1356,8 @@ export declare namespace DeleteMedicalTranscriptionJobRequest {
1344
1356
  }
1345
1357
  export interface DeleteMedicalVocabularyRequest {
1346
1358
  /**
1347
- * <p>The name of the vocabulary that you want to delete.</p>
1359
+ * <p>The name of the vocabulary that you want to delete. Vocabulary names are
1360
+ * case-sensitive.</p>
1348
1361
  */
1349
1362
  VocabularyName: string | undefined;
1350
1363
  }
@@ -1356,7 +1369,8 @@ export declare namespace DeleteMedicalVocabularyRequest {
1356
1369
  }
1357
1370
  export interface DeleteTranscriptionJobRequest {
1358
1371
  /**
1359
- * <p>The name of the transcription job to be deleted.</p>
1372
+ * <p>The name of the transcription job you want to delete. Job names are
1373
+ * case-sensitive.</p>
1360
1374
  */
1361
1375
  TranscriptionJobName: string | undefined;
1362
1376
  }
@@ -1368,7 +1382,8 @@ export declare namespace DeleteTranscriptionJobRequest {
1368
1382
  }
1369
1383
  export interface DeleteVocabularyRequest {
1370
1384
  /**
1371
- * <p>The name of the vocabulary to delete. </p>
1385
+ * <p>The name of the vocabulary you want to delete. Vocabulary names are
1386
+ * case-sensitive.</p>
1372
1387
  */
1373
1388
  VocabularyName: string | undefined;
1374
1389
  }
@@ -1380,7 +1395,8 @@ export declare namespace DeleteVocabularyRequest {
1380
1395
  }
1381
1396
  export interface DeleteVocabularyFilterRequest {
1382
1397
  /**
1383
- * <p>The name of the vocabulary filter to remove.</p>
1398
+ * <p>The name of the vocabulary filter you want to delete. Vocabulary filter names are
1399
+ * case-sensitive.</p>
1384
1400
  */
1385
1401
  VocabularyFilterName: string | undefined;
1386
1402
  }
@@ -1392,7 +1408,8 @@ export declare namespace DeleteVocabularyFilterRequest {
1392
1408
  }
1393
1409
  export interface DescribeLanguageModelRequest {
1394
1410
  /**
1395
- * <p>The name of the custom language model you submit to get more information.</p>
1411
+ * <p>The name of the custom language model you want described. Model names are
1412
+ * case-sensitive.</p>
1396
1413
  */
1397
1414
  ModelName: string | undefined;
1398
1415
  }
@@ -1434,7 +1451,7 @@ export interface LanguageModel {
1434
1451
  ModelStatus?: ModelStatus | string;
1435
1452
  /**
1436
1453
  * <p>Whether the base model used for the custom language model is up to date. If this field
1437
- * is <code>true</code> then you are running the most up-to-date version of the base model
1454
+ * is <code>false</code> then you are running the most up-to-date version of the base model
1438
1455
  * in your custom language model.</p>
1439
1456
  */
1440
1457
  UpgradeAvailability?: boolean;
@@ -1468,7 +1485,8 @@ export declare namespace DescribeLanguageModelResponse {
1468
1485
  }
1469
1486
  export interface GetCallAnalyticsCategoryRequest {
1470
1487
  /**
1471
- * <p>The name of the category you want information about. This value is case sensitive.</p>
1488
+ * <p>The name of the category you want information about. Category names are case
1489
+ * sensitive.</p>
1472
1490
  */
1473
1491
  CategoryName: string | undefined;
1474
1492
  }
@@ -1480,7 +1498,8 @@ export declare namespace GetCallAnalyticsCategoryRequest {
1480
1498
  }
1481
1499
  export interface GetCallAnalyticsCategoryResponse {
1482
1500
  /**
1483
- * <p>The rules you've defined for a category.</p>
1501
+ * <p>Provides you with the rules associated with the category you specified in your
1502
+ * <code>GetCallAnalyticsCategory</code> request.</p>
1484
1503
  */
1485
1504
  CategoryProperties?: CategoryProperties;
1486
1505
  }
@@ -1493,7 +1512,7 @@ export declare namespace GetCallAnalyticsCategoryResponse {
1493
1512
  export interface GetCallAnalyticsJobRequest {
1494
1513
  /**
1495
1514
  * <p>The name of the analytics job you want information about. This value is case
1496
- * sensitive. </p>
1515
+ * sensitive.</p>
1497
1516
  */
1498
1517
  CallAnalyticsJobName: string | undefined;
1499
1518
  }
@@ -1505,7 +1524,14 @@ export declare namespace GetCallAnalyticsJobRequest {
1505
1524
  }
1506
1525
  export interface GetCallAnalyticsJobResponse {
1507
1526
  /**
1508
- * <p>An object that contains the results of your call analytics job.</p>
1527
+ * <p>An object that contains detailed information about your call analytics job. Returned fields
1528
+ * include: <code>CallAnalyticsJobName</code>, <code>CallAnalyticsJobStatus</code>,
1529
+ * <code>ChannelDefinitions</code>, <code>CompletionTime</code>,
1530
+ * <code>CreationTime</code>, <code>DataAccessRoleArn</code>,
1531
+ * <code>FailureReason</code>, <code>IdentifiedLanguageScore</code>,
1532
+ * <code>LanguageCode</code>, <code>Media</code>, <code>MediaFormat</code>,
1533
+ * <code>MediaSampleRateHertz</code>, <code>Settings</code>, <code>StartTime</code>,
1534
+ * and <code>Transcript</code>.</p>
1509
1535
  */
1510
1536
  CallAnalyticsJob?: CallAnalyticsJob;
1511
1537
  }
@@ -1517,7 +1543,8 @@ export declare namespace GetCallAnalyticsJobResponse {
1517
1543
  }
1518
1544
  export interface GetMedicalTranscriptionJobRequest {
1519
1545
  /**
1520
- * <p>The name of the medical transcription job.</p>
1546
+ * <p>The name of the medical transcription job you want information about. This value is case
1547
+ * sensitive.</p>
1521
1548
  */
1522
1549
  MedicalTranscriptionJobName: string | undefined;
1523
1550
  }
@@ -1751,7 +1778,15 @@ export declare namespace MedicalTranscriptionJob {
1751
1778
  }
1752
1779
  export interface GetMedicalTranscriptionJobResponse {
1753
1780
  /**
1754
- * <p>An object that contains the results of the medical transcription job.</p>
1781
+ * <p>An object that contains detailed information about your medical transcription job.
1782
+ * Returned fields include: <code>CompletionTime</code>,
1783
+ * <code>ContentIdentificationType</code>, <code>CreationTime</code>,
1784
+ * <code>FailureReason</code>, <code>LanguageCode</code>, <code>Media</code>,
1785
+ * <code>MediaFormat</code>, <code>MediaSampleRateHertz</code>,
1786
+ * <code>MedicalTranscriptionJobName</code>, <code>Settings</code>,
1787
+ * <code>Specialty</code>, <code>StartTime</code>, <code>Tags</code>,
1788
+ * <code>Transcript</code>, <code>TranscriptionJobStatus</code>, and
1789
+ * <code>Type</code>.</p>
1755
1790
  */
1756
1791
  MedicalTranscriptionJob?: MedicalTranscriptionJob;
1757
1792
  }
@@ -1763,7 +1798,8 @@ export declare namespace GetMedicalTranscriptionJobResponse {
1763
1798
  }
1764
1799
  export interface GetMedicalVocabularyRequest {
1765
1800
  /**
1766
- * <p>The name of the vocabulary that you want information about. The value is case sensitive. </p>
1801
+ * <p>The name of the medical vocabulary you want information about. This value is case
1802
+ * sensitive.</p>
1767
1803
  */
1768
1804
  VocabularyName: string | undefined;
1769
1805
  }
@@ -1793,13 +1829,16 @@ export interface GetMedicalVocabularyResponse {
1793
1829
  */
1794
1830
  LastModifiedTime?: Date;
1795
1831
  /**
1796
- * <p>If the <code>VocabularyState</code> is <code>FAILED</code>, this field contains information about why
1797
- * the job failed.</p>
1832
+ * <p>If your request returns a <code>VocabularyState</code> that is <code>FAILED</code>,
1833
+ * the <code>FailureReason</code> field contains information about why the request
1834
+ * failed.</p>
1835
+ * <p>For more information, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>
1836
+ * section.</p>
1798
1837
  */
1799
1838
  FailureReason?: string;
1800
1839
  /**
1801
- * <p>The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You
1802
- * can download your vocabulary from the URI for a limited time.</p>
1840
+ * <p>The S3 location where the vocabulary is stored; use this URI to view or download the
1841
+ * vocabulary.</p>
1803
1842
  */
1804
1843
  DownloadUri?: string;
1805
1844
  }
@@ -1941,7 +1980,8 @@ export declare enum SubtitleFormat {
1941
1980
  VTT = "vtt"
1942
1981
  }
1943
1982
  /**
1944
- * <p>Specify the output format for your subtitle file.</p>
1983
+ * <p>Choose the output format for your subtitle file and the S3 location where you want
1984
+ * your file saved.</p>
1945
1985
  */
1946
1986
  export interface SubtitlesOutput {
1947
1987
  /**
@@ -1950,7 +1990,7 @@ export interface SubtitlesOutput {
1950
1990
  */
1951
1991
  Formats?: (SubtitleFormat | string)[];
1952
1992
  /**
1953
- * <p>Choose the output location for your subtitle file. This location must be an S3
1993
+ * <p>Contains the output location for your subtitle file. This location must be an S3
1954
1994
  * bucket.</p>
1955
1995
  */
1956
1996
  SubtitleFileUris?: string[];
@@ -2478,13 +2518,14 @@ export declare namespace ListMedicalTranscriptionJobsResponse {
2478
2518
  export interface ListMedicalVocabulariesRequest {
2479
2519
  /**
2480
2520
  * <p>If the result of your previous request to <code>ListMedicalVocabularies</code> was
2481
- * truncated, include the <code>NextToken</code> to fetch the next set of vocabularies.</p>
2521
+ * truncated, include the <code>NextToken</code> to fetch the next set of
2522
+ * vocabularies.</p>
2482
2523
  */
2483
2524
  NextToken?: string;
2484
2525
  /**
2485
- * <p>The maximum number of vocabularies to return in each page of results. If there are fewer
2486
- * results than the value you specify, only the actual results are returned. If you do not specify
2487
- * a value, the default of 5 is used.</p>
2526
+ * <p>The maximum number of vocabularies to return in each page of results. If there are
2527
+ * fewer results than the value you specify, only the actual results are returned. If you do not
2528
+ * specify a value, the default of 5 is used.</p>
2488
2529
  */
2489
2530
  MaxResults?: number;
2490
2531
  /**
@@ -2540,12 +2581,12 @@ export interface ListMedicalVocabulariesResponse {
2540
2581
  */
2541
2582
  Status?: VocabularyState | string;
2542
2583
  /**
2543
- * <p>The <code>ListMedicalVocabularies</code> operation returns a page of vocabularies at a
2544
- * time. You set the maximum number of vocabularies to return on a page with the
2584
+ * <p>The <code>ListMedicalVocabularies</code> operation returns a page of vocabularies at
2585
+ * a time. You set the maximum number of vocabularies to return on a page with the
2545
2586
  * <code>MaxResults</code> parameter. If there are more jobs in the list will fit on a page,
2546
2587
  * Amazon Transcribe Medical returns the <code>NextPage</code> token. To return the next page of vocabularies,
2547
2588
  * include the token in the next request to the <code>ListMedicalVocabularies</code>
2548
- * operation .</p>
2589
+ * operation.</p>
2549
2590
  */
2550
2591
  NextToken?: string;
2551
2592
  /**
@@ -3075,7 +3116,7 @@ export interface StartMedicalTranscriptionJobRequest {
3075
3116
  */
3076
3117
  Type: Type | string | undefined;
3077
3118
  /**
3078
- * <p>Add tags to an Amazon Transcribe medical transcription job.</p>
3119
+ * <p>Add tags to an Amazon Transcribe Medical transcription job.</p>
3079
3120
  */
3080
3121
  Tags?: Tag[];
3081
3122
  }
@@ -3398,11 +3439,11 @@ export interface UpdateMedicalVocabularyRequest {
3398
3439
  * be in the same Amazon Web Services Region as the resource that you are calling. The following
3399
3440
  * is the format for a URI:</p>
3400
3441
  * <p>
3401
- * <code> https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code>
3442
+ * <code>https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey</code>
3402
3443
  * </p>
3403
3444
  * <p>For example:</p>
3404
3445
  * <p>
3405
- * <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
3446
+ * <code>https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt</code>
3406
3447
  * </p>
3407
3448
  * <p>For more information about Amazon S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
3408
3449
  * <i>Amazon S3 Developer Guide</i>.</p>
@@ -3465,11 +3506,11 @@ export interface UpdateVocabularyRequest {
3465
3506
  * The URI must be in the same region as the API endpoint that you are calling. The general form
3466
3507
  * is:</p>
3467
3508
  * <p>
3468
- * <code>https://s3.<aws-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey></code>
3509
+ * <code>https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey</code>
3469
3510
  * </p>
3470
3511
  * <p>For example:</p>
3471
3512
  * <p>
3472
- * <code>https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt</code>
3513
+ * <code>https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt</code>
3473
3514
  * </p>
3474
3515
  * <p>For more information about S3 object names, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys">Object Keys</a> in the
3475
3516
  * <i>Amazon S3 Developer Guide</i>.</p>