@aws-sdk/client-transcribe 3.215.0 → 3.218.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 (49) hide show
  1. package/README.md +7 -9
  2. package/dist-cjs/models/models_0.js +8 -3
  3. package/dist-cjs/protocols/Aws_json1_1.js +3 -0
  4. package/dist-es/models/models_0.js +5 -0
  5. package/dist-es/protocols/Aws_json1_1.js +3 -0
  6. package/dist-types/Transcribe.d.ts +234 -251
  7. package/dist-types/TranscribeClient.d.ts +9 -11
  8. package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +12 -22
  9. package/dist-types/commands/CreateLanguageModelCommand.d.ts +3 -4
  10. package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +12 -11
  11. package/dist-types/commands/CreateVocabularyCommand.d.ts +10 -9
  12. package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +9 -8
  13. package/dist-types/commands/DeleteCallAnalyticsCategoryCommand.d.ts +2 -2
  14. package/dist-types/commands/DeleteCallAnalyticsJobCommand.d.ts +3 -2
  15. package/dist-types/commands/DeleteLanguageModelCommand.d.ts +3 -3
  16. package/dist-types/commands/DeleteMedicalTranscriptionJobCommand.d.ts +3 -3
  17. package/dist-types/commands/DeleteMedicalVocabularyCommand.d.ts +2 -2
  18. package/dist-types/commands/DeleteTranscriptionJobCommand.d.ts +3 -2
  19. package/dist-types/commands/DeleteVocabularyCommand.d.ts +3 -3
  20. package/dist-types/commands/DeleteVocabularyFilterCommand.d.ts +3 -3
  21. package/dist-types/commands/DescribeLanguageModelCommand.d.ts +3 -5
  22. package/dist-types/commands/GetCallAnalyticsCategoryCommand.d.ts +1 -2
  23. package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +11 -10
  24. package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +6 -6
  25. package/dist-types/commands/GetMedicalVocabularyCommand.d.ts +5 -6
  26. package/dist-types/commands/GetTranscriptionJobCommand.d.ts +8 -8
  27. package/dist-types/commands/GetVocabularyCommand.d.ts +6 -6
  28. package/dist-types/commands/GetVocabularyFilterCommand.d.ts +1 -6
  29. package/dist-types/commands/ListCallAnalyticsCategoriesCommand.d.ts +3 -3
  30. package/dist-types/commands/ListCallAnalyticsJobsCommand.d.ts +3 -4
  31. package/dist-types/commands/ListLanguageModelsCommand.d.ts +3 -4
  32. package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +3 -4
  33. package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +3 -4
  34. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  35. package/dist-types/commands/ListTranscriptionJobsCommand.d.ts +3 -4
  36. package/dist-types/commands/ListVocabulariesCommand.d.ts +3 -4
  37. package/dist-types/commands/ListVocabularyFiltersCommand.d.ts +1 -2
  38. package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts +28 -26
  39. package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +20 -20
  40. package/dist-types/commands/StartTranscriptionJobCommand.d.ts +29 -29
  41. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  42. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  43. package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts +3 -2
  44. package/dist-types/commands/UpdateMedicalVocabularyCommand.d.ts +3 -3
  45. package/dist-types/commands/UpdateVocabularyCommand.d.ts +3 -2
  46. package/dist-types/commands/UpdateVocabularyFilterCommand.d.ts +3 -3
  47. package/dist-types/models/models_0.d.ts +1349 -1305
  48. package/dist-types/ts3.4/models/models_0.d.ts +7 -0
  49. package/package.json +4 -4
@@ -162,9 +162,8 @@ declare type TranscribeClientResolvedConfigType = __SmithyResolvedConfiguration<
162
162
  export interface TranscribeClientResolvedConfig extends TranscribeClientResolvedConfigType {
163
163
  }
164
164
  /**
165
- * <p>Amazon Transcribe offers three main types of batch transcription:
166
- * <b>Standard</b>, <b>Medical</b>, and
167
- * <b>Call Analytics</b>.</p>
165
+ * <p>Amazon Transcribe offers three main types of batch transcription: <b>Standard</b>, <b>Medical</b>, and
166
+ * <b>Call Analytics</b>.</p>
168
167
  * <ul>
169
168
  * <li>
170
169
  * <p>
@@ -173,17 +172,16 @@ export interface TranscribeClientResolvedConfig extends TranscribeClientResolved
173
172
  * </li>
174
173
  * <li>
175
174
  * <p>
176
- * <b>Medical transcriptions</b> are tailored to medical
177
- * professionals and incorporate medical terms. A common use case for this service is
178
- * transcribing doctor-patient dialogue into after-visit notes. Refer to
179
- * for details.</p>
175
+ * <b>Medical transcriptions</b> are tailored to
176
+ * medical professionals and incorporate medical terms. A common use case for this
177
+ * service is transcribing doctor-patient dialogue into after-visit notes. Refer to
178
+ * for details.</p>
180
179
  * </li>
181
180
  * <li>
182
181
  * <p>
183
- * <b>Call Analytics transcriptions</b> are designed for use
184
- * with call center audio on two different channels; if you're looking for insight into customer
185
- * service calls, use this option. Refer to for
186
- * details.</p>
182
+ * <b>Call Analytics transcriptions</b> are designed
183
+ * for use with call center audio on two different channels; if you're looking for
184
+ * insight into customer service calls, use this option. Refer to for details.</p>
187
185
  * </li>
188
186
  * </ul>
189
187
  */
@@ -9,30 +9,20 @@ export interface CreateCallAnalyticsCategoryCommandOutput extends CreateCallAnal
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new Call Analytics category.</p>
12
- * <p>All categories are automatically applied to your Call Analytics jobs. Note that in order to apply
13
- * your categories to your jobs, you must create them before submitting your job request, as
14
- * categories cannot be applied retroactively.</p>
12
+ * <p>All categories are automatically applied to your Call Analytics transcriptions. Note that in
13
+ * order to apply categories to your transcriptions, you must create them before submitting your
14
+ * transcription request, as categories cannot be applied retroactively.</p>
15
+ * <p>When creating a new category, you can use the <code>InputType</code> parameter to
16
+ * label the category as a batch category (<code>POST_CALL</code>) or a streaming category
17
+ * (<code>REAL_TIME</code>). Batch categories can only be applied to batch transcriptions and
18
+ * streaming categories can only be applied to streaming transcriptions. If you do not include
19
+ * <code>InputType</code>, your category is created as a batch category by default.</p>
15
20
  * <p>Call Analytics categories are composed of rules. For each category, you must create
16
- * between 1 and 20 rules. Rules can include these parameters: ,
17
- * , , and
18
- * .</p>
21
+ * between 1 and 20 rules. Rules can include these parameters: , , , and .</p>
19
22
  * <p>To update an existing category, see .</p>
20
- * <p>To learn more about:</p>
21
- * <ul>
22
- * <li>
23
- * <p>Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html">Creating categories</a>
24
- * </p>
25
- * </li>
26
- * <li>
27
- * <p>Using rules, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules">Rule
28
- * criteria</a> and refer to the data type</p>
29
- * </li>
30
- * <li>
31
- * <p>Call Analytics, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call
32
- * Analytics</a>
33
- * </p>
34
- * </li>
35
- * </ul>
23
+ * <p>To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for batch
24
+ * transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
25
+ * streaming transcriptions</a>.</p>
36
26
  * @example
37
27
  * Use a bare-bones client and the command you need to make an API call.
38
28
  * ```javascript
@@ -9,11 +9,11 @@ export interface CreateLanguageModelCommandOutput extends CreateLanguageModelRes
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new custom language model.</p>
12
- * <p>When creating a new language model, you must specify:</p>
12
+ * <p>When creating a new custom language model, you must specify:</p>
13
13
  * <ul>
14
14
  * <li>
15
- * <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample
16
- * rates under 16,000 Hz) base model</p>
15
+ * <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband
16
+ * (audio sample rates under 16,000 Hz) base model</p>
17
17
  * </li>
18
18
  * <li>
19
19
  * <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
@@ -25,7 +25,6 @@ export interface CreateLanguageModelCommandOutput extends CreateLanguageModelRes
25
25
  * <p>A unique name for your model</p>
26
26
  * </li>
27
27
  * </ul>
28
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
31
30
  * ```javascript
@@ -9,17 +9,18 @@ export interface CreateMedicalVocabularyCommandOutput extends CreateMedicalVocab
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new custom medical vocabulary.</p>
12
- * <p>Prior to creating a new medical vocabulary, you must first upload a text file that contains
13
- * your new entries, phrases, and terms into an Amazon S3 bucket. Note that this differs from
14
- * , where you can include a list of terms within
15
- * your request using the <code>Phrases</code> flag; <code>CreateMedicalVocabulary</code>
16
- * does not support the <code>Phrases</code> flag.</p>
17
- * <p>Each language has a character set that contains all allowed characters for that specific
18
- * language. If you use unsupported characters, your vocabulary request fails. Refer to
19
- * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
20
- * Custom Vocabularies</a> to get the character set for your language.</p>
21
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
22
- * vocabulary</a>.</p>
12
+ * <p>Before creating a new custom medical vocabulary, you must first upload a text file
13
+ * that contains your new entries, phrases, and terms into an Amazon S3 bucket.
14
+ * Note that this differs from , where you can
15
+ * include a list of terms within your request using the <code>Phrases</code> flag;
16
+ * <code>CreateMedicalVocabulary</code> does not support the <code>Phrases</code>
17
+ * flag.</p>
18
+ * <p>Each language has a character set that contains all allowed characters for that
19
+ * specific language. If you use unsupported characters, your custom vocabulary request
20
+ * fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your
21
+ * language.</p>
22
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
23
+ * vocabularies</a>.</p>
23
24
  * @example
24
25
  * Use a bare-bones client and the command you need to make an API call.
25
26
  * ```javascript
@@ -9,15 +9,16 @@ export interface CreateVocabularyCommandOutput extends CreateVocabularyResponse,
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new custom vocabulary.</p>
12
- * <p>When creating a new vocabulary, you can either upload a text file that contains your new
13
- * entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request, or
14
- * you can include a list of terms directly in your request using the <code>Phrases</code> flag.</p>
15
- * <p>Each language has a character set that contains all allowed characters for that specific
16
- * language. If you use unsupported characters, your vocabulary request fails. Refer to
17
- * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
18
- * Custom Vocabularies</a> to get the character set for your language.</p>
19
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
20
- * vocabulary</a>.</p>
12
+ * <p>When creating a new custom vocabulary, you can either upload a text file that contains
13
+ * your new entries, phrases, and terms into an Amazon S3 bucket and include the
14
+ * URI in your request. Or you can include a list of terms directly in your request using
15
+ * the <code>Phrases</code> flag.</p>
16
+ * <p>Each language has a character set that contains all allowed characters for that
17
+ * specific language. If you use unsupported characters, your custom vocabulary request
18
+ * fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your
19
+ * language.</p>
20
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
21
+ * vocabularies</a>.</p>
21
22
  * @example
22
23
  * Use a bare-bones client and the command you need to make an API call.
23
24
  * ```javascript
@@ -9,14 +9,15 @@ export interface CreateVocabularyFilterCommandOutput extends CreateVocabularyFil
9
9
  }
10
10
  /**
11
11
  * <p>Creates a new custom vocabulary filter.</p>
12
- * <p>You can use vocabulary filters to mask, delete, or flag specific words from your transcript.
13
- * Vocabulary filters are commonly used to mask profanity in transcripts.</p>
14
- * <p>Each language has a character set that contains all allowed characters for that specific
15
- * language. If you use unsupported characters, your vocabulary filter request fails. Refer to
16
- * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
17
- * Custom Vocabularies</a> to get the character set for your language.</p>
18
- * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
19
- * words</a>.</p>
12
+ * <p>You can use custom vocabulary filters to mask, delete, or flag specific words from
13
+ * your transcript. Custom vocabulary filters are commonly used to mask profanity in
14
+ * transcripts.</p>
15
+ * <p>Each language has a character set that contains all allowed characters for that
16
+ * specific language. If you use unsupported characters, your custom vocabulary filter
17
+ * request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
18
+ * Vocabularies</a> to get the character set for your language.</p>
19
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Vocabulary
20
+ * filtering</a>.</p>
20
21
  * @example
21
22
  * Use a bare-bones client and the command you need to make an API call.
22
23
  * ```javascript
@@ -8,8 +8,8 @@ export interface DeleteCallAnalyticsCategoryCommandInput extends DeleteCallAnaly
8
8
  export interface DeleteCallAnalyticsCategoryCommandOutput extends DeleteCallAnalyticsCategoryResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a Call Analytics category. To use this operation, specify the name of the category
12
- * you want to delete using <code>CategoryName</code>. Category names are case
11
+ * <p>Deletes a Call Analytics category. To use this operation, specify the name of the
12
+ * category you want to delete using <code>CategoryName</code>. Category names are case
13
13
  * sensitive.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
@@ -8,8 +8,9 @@ export interface DeleteCallAnalyticsJobCommandInput extends DeleteCallAnalyticsJ
8
8
  export interface DeleteCallAnalyticsJobCommandOutput extends DeleteCallAnalyticsJobResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a Call Analytics job. To use this operation, specify the name of the job you want to
12
- * delete using <code>CallAnalyticsJobName</code>. Job names are case sensitive.</p>
11
+ * <p>Deletes a Call Analytics job. To use this operation, specify the name of the job you
12
+ * want to delete using <code>CallAnalyticsJobName</code>. Job names are case
13
+ * sensitive.</p>
13
14
  * @example
14
15
  * Use a bare-bones client and the command you need to make an API call.
15
16
  * ```javascript
@@ -8,9 +8,9 @@ export interface DeleteLanguageModelCommandInput extends DeleteLanguageModelRequ
8
8
  export interface DeleteLanguageModelCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a custom language model. To use this operation, specify the name of the language
12
- * model you want to delete using <code>ModelName</code>. Language model names are case
13
- * sensitive.</p>
11
+ * <p>Deletes a custom language model. To use this operation, specify the name of the
12
+ * language model you want to delete using <code>ModelName</code>. custom language model
13
+ * names are case sensitive.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -8,9 +8,9 @@ export interface DeleteMedicalTranscriptionJobCommandInput extends DeleteMedical
8
8
  export interface DeleteMedicalTranscriptionJobCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a medical transcription job. To use this operation, specify the name of the job you
12
- * want to delete using <code>MedicalTranscriptionJobName</code>. Job names are case
13
- * sensitive.</p>
11
+ * <p>Deletes a medical transcription job. To use this operation, specify the name of the
12
+ * job you want to delete using <code>MedicalTranscriptionJobName</code>. Job names are
13
+ * case sensitive.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -9,8 +9,8 @@ export interface DeleteMedicalVocabularyCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Deletes a custom medical vocabulary. To use this operation, specify the name of the
12
- * vocabulary you want to delete using <code>VocabularyName</code>. Vocabulary names are
13
- * case sensitive.</p>
12
+ * custom vocabulary you want to delete using <code>VocabularyName</code>. Custom
13
+ * vocabulary names are case sensitive.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -8,8 +8,9 @@ export interface DeleteTranscriptionJobCommandInput extends DeleteTranscriptionJ
8
8
  export interface DeleteTranscriptionJobCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a transcription job. To use this operation, specify the name of the job you want to
12
- * delete using <code>TranscriptionJobName</code>. Job names are case sensitive.</p>
11
+ * <p>Deletes a transcription job. To use this operation, specify the name of the job you
12
+ * want to delete using <code>TranscriptionJobName</code>. Job names are case
13
+ * sensitive.</p>
13
14
  * @example
14
15
  * Use a bare-bones client and the command you need to make an API call.
15
16
  * ```javascript
@@ -8,9 +8,9 @@ export interface DeleteVocabularyCommandInput extends DeleteVocabularyRequest {
8
8
  export interface DeleteVocabularyCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you
12
- * want to delete using <code>VocabularyName</code>. Vocabulary names are case
13
- * sensitive.</p>
11
+ * <p>Deletes a custom vocabulary. To use this operation, specify the name of the custom
12
+ * vocabulary you want to delete using <code>VocabularyName</code>. Custom vocabulary names
13
+ * are case sensitive.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -8,9 +8,9 @@ export interface DeleteVocabularyFilterCommandInput extends DeleteVocabularyFilt
8
8
  export interface DeleteVocabularyFilterCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter
12
- * you want to delete using <code>VocabularyFilterName</code>. Vocabulary filter names are
13
- * case sensitive.</p>
11
+ * <p>Deletes a custom vocabulary filter. To use this operation, specify the name of the
12
+ * custom vocabulary filter you want to delete using <code>VocabularyFilterName</code>.
13
+ * Custom vocabulary filter names are case sensitive.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -9,14 +9,12 @@ export interface DescribeLanguageModelCommandOutput extends DescribeLanguageMode
9
9
  }
10
10
  /**
11
11
  * <p>Provides information about the specified custom language model.</p>
12
- * <p>This operation also shows if the base language model you used to create your custom
13
- * language model has been updated. If Amazon Transcribe has updated the base model, you
14
- * can create a new custom language model using the updated base model.</p>
12
+ * <p>This operation also shows if the base language model that you used to create your
13
+ * custom language model has been updated. If Amazon Transcribe has updated the base
14
+ * model, you can create a new custom language model using the updated base model.</p>
15
15
  * <p>If you tried to create a new custom language model and the request wasn't successful,
16
16
  * you can use <code>DescribeLanguageModel</code> to help identify the reason for this
17
17
  * failure.</p>
18
- * <p>To get a list of your custom language models, use the
19
- * operation.</p>
20
18
  * @example
21
19
  * Use a bare-bones client and the command you need to make an API call.
22
20
  * ```javascript
@@ -9,8 +9,7 @@ export interface GetCallAnalyticsCategoryCommandOutput extends GetCallAnalyticsC
9
9
  }
10
10
  /**
11
11
  * <p>Provides information about the specified Call Analytics category.</p>
12
- * <p>To get a list of your Call Analytics categories, use the
13
- * operation.</p>
12
+ * <p>To get a list of your Call Analytics categories, use the operation.</p>
14
13
  * @example
15
14
  * Use a bare-bones client and the command you need to make an API call.
16
15
  * ```javascript
@@ -9,16 +9,17 @@ export interface GetCallAnalyticsJobCommandOutput extends GetCallAnalyticsJobRes
9
9
  }
10
10
  /**
11
11
  * <p>Provides information about the specified Call Analytics job.</p>
12
- * <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status is
13
- * <code>COMPLETED</code>, the job is finished. You can find your completed transcript at
14
- * the URI specified in <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
15
- * <code>FailureReason</code> provides details on why your transcription job failed.</p>
16
- * <p>If you enabled personally identifiable information (PII) redaction, the redacted transcript
17
- * appears at the location specified in <code>RedactedTranscriptFileUri</code>.</p>
18
- * <p>If you chose to redact the audio in your media file, you can find your redacted media file
19
- * at the location specified in <code>RedactedMediaFileUri</code>.</p>
20
- * <p>To get a list of your Call Analytics jobs, use the
21
- * operation.</p>
12
+ * <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
13
+ * is <code>COMPLETED</code>, the job is finished. You can find your completed transcript
14
+ * at the URI specified in <code>TranscriptFileUri</code>. If the status is
15
+ * <code>FAILED</code>, <code>FailureReason</code> provides details on why your
16
+ * transcription job failed.</p>
17
+ * <p>If you enabled personally identifiable information (PII) redaction, the redacted
18
+ * transcript appears at the location specified in
19
+ * <code>RedactedTranscriptFileUri</code>.</p>
20
+ * <p>If you chose to redact the audio in your media file, you can find your redacted media
21
+ * file at the location specified in <code>RedactedMediaFileUri</code>.</p>
22
+ * <p>To get a list of your Call Analytics jobs, use the operation.</p>
22
23
  * @example
23
24
  * Use a bare-bones client and the command you need to make an API call.
24
25
  * ```javascript
@@ -10,12 +10,12 @@ export interface GetMedicalTranscriptionJobCommandOutput extends GetMedicalTrans
10
10
  /**
11
11
  * <p>Provides information about the specified medical transcription job.</p>
12
12
  * <p>To view the status of the specified medical transcription job, check the
13
- * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the
14
- * job is finished and you can find the results at the location specified in
15
- * <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
16
- * <code>FailureReason</code> provides details on why your transcription job failed.</p>
17
- * <p>To get a list of your medical transcription jobs, use the
18
- * operation.</p>
13
+ * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
14
+ * the job is finished. You can find the results at the location specified in
15
+ * <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
16
+ * <code>FailureReason</code> provides details on why your transcription job
17
+ * failed.</p>
18
+ * <p>To get a list of your medical transcription jobs, use the operation.</p>
19
19
  * @example
20
20
  * Use a bare-bones client and the command you need to make an API call.
21
21
  * ```javascript
@@ -9,12 +9,11 @@ export interface GetMedicalVocabularyCommandOutput extends GetMedicalVocabularyR
9
9
  }
10
10
  /**
11
11
  * <p>Provides information about the specified custom medical vocabulary.</p>
12
- * <p>To view the status of the specified medical vocabulary, check the
13
- * <code>VocabularyState</code> field. If the status is <code>READY</code>, your vocabulary
14
- * is available to use. If the status is <code>FAILED</code>, <code>FailureReason</code> provides
15
- * details on why your vocabulary failed.</p>
16
- * <p>To get a list of your custom medical vocabularies, use the
17
- * operation.</p>
12
+ * <p>To view the status of the specified custom medical vocabulary, check the
13
+ * <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
14
+ * vocabulary is available to use. If the status is <code>FAILED</code>,
15
+ * <code>FailureReason</code> provides details on why your vocabulary failed.</p>
16
+ * <p>To get a list of your custom medical vocabularies, use the operation.</p>
18
17
  * @example
19
18
  * Use a bare-bones client and the command you need to make an API call.
20
19
  * ```javascript
@@ -10,14 +10,14 @@ export interface GetTranscriptionJobCommandOutput extends GetTranscriptionJobRes
10
10
  /**
11
11
  * <p>Provides information about the specified transcription job.</p>
12
12
  * <p>To view the status of the specified transcription job, check the
13
- * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the
14
- * job is finished and you can find the results at the location specified in
15
- * <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
16
- * <code>FailureReason</code> provides details on why your transcription job failed.</p>
17
- * <p>If you enabled content redaction, the redacted transcript
18
- * can be found at the location specified in <code>RedactedTranscriptFileUri</code>.</p>
19
- * <p>To get a list of your transcription jobs, use the
20
- * operation.</p>
13
+ * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
14
+ * the job is finished. You can find the results at the location specified in
15
+ * <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
16
+ * <code>FailureReason</code> provides details on why your transcription job
17
+ * failed.</p>
18
+ * <p>If you enabled content redaction, the redacted transcript can be found at the location
19
+ * specified in <code>RedactedTranscriptFileUri</code>.</p>
20
+ * <p>To get a list of your transcription jobs, use the operation.</p>
21
21
  * @example
22
22
  * Use a bare-bones client and the command you need to make an API call.
23
23
  * ```javascript
@@ -9,12 +9,12 @@ export interface GetVocabularyCommandOutput extends GetVocabularyResponse, __Met
9
9
  }
10
10
  /**
11
11
  * <p>Provides information about the specified custom vocabulary.</p>
12
- * <p>To view the status of the specified vocabulary, check the <code>VocabularyState</code>
13
- * field. If the status is <code>READY</code>, your vocabulary is available to use. If the status
14
- * is <code>FAILED</code>, <code>FailureReason</code> provides details on why your
15
- * vocabulary failed.</p>
16
- * <p>To get a list of your custom vocabularies, use the
17
- * operation.</p>
12
+ * <p>To view the status of the specified custom vocabulary, check the
13
+ * <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
14
+ * vocabulary is available to use. If the status is <code>FAILED</code>,
15
+ * <code>FailureReason</code> provides details on why your custom vocabulary
16
+ * failed.</p>
17
+ * <p>To get a list of your custom vocabularies, use the operation.</p>
18
18
  * @example
19
19
  * Use a bare-bones client and the command you need to make an API call.
20
20
  * ```javascript
@@ -9,12 +9,7 @@ export interface GetVocabularyFilterCommandOutput extends GetVocabularyFilterRes
9
9
  }
10
10
  /**
11
11
  * <p>Provides information about the specified custom vocabulary filter.</p>
12
- * <p>To view the status of the specified vocabulary filter, check the <code>VocabularyState</code>
13
- * field. If the status is <code>READY</code>, your vocabulary is available to use. If the status is
14
- * <code>FAILED</code>, <code>FailureReason</code> provides details on why your vocabulary
15
- * filter failed.</p>
16
- * <p>To get a list of your custom vocabulary filters, use the
17
- * operation.</p>
12
+ * <p>To get a list of your custom vocabulary filters, use the operation.</p>
18
13
  * @example
19
14
  * Use a bare-bones client and the command you need to make an API call.
20
15
  * ```javascript
@@ -8,9 +8,9 @@ export interface ListCallAnalyticsCategoriesCommandInput extends ListCallAnalyti
8
8
  export interface ListCallAnalyticsCategoriesCommandOutput extends ListCallAnalyticsCategoriesResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Provides a list of Call Analytics categories, including all rules that make up each category.</p>
12
- * <p>To get detailed information about a specific Call Analytics category, use the
13
- * operation.</p>
11
+ * <p>Provides a list of Call Analytics categories, including all rules that make up each
12
+ * category.</p>
13
+ * <p>To get detailed information about a specific Call Analytics category, use the operation.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -8,10 +8,9 @@ export interface ListCallAnalyticsJobsCommandInput extends ListCallAnalyticsJobs
8
8
  export interface ListCallAnalyticsJobsCommandOutput extends ListCallAnalyticsJobsResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are
12
- * specified, all Call Analytics jobs are returned.</p>
13
- * <p>To get detailed information about a specific Call Analytics job, use the
14
- * operation.</p>
11
+ * <p>Provides a list of Call Analytics jobs that match the specified criteria. If no
12
+ * criteria are specified, all Call Analytics jobs are returned.</p>
13
+ * <p>To get detailed information about a specific Call Analytics job, use the operation.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
@@ -8,10 +8,9 @@ export interface ListLanguageModelsCommandInput extends ListLanguageModelsReques
8
8
  export interface ListLanguageModelsCommandOutput extends ListLanguageModelsResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Provides a list of custom language models that match the specified criteria. If no criteria
12
- * are specified, all language models are returned.</p>
13
- * <p>To get detailed information about a specific custom language model, use the
14
- * operation.</p>
11
+ * <p>Provides a list of custom language models that match the specified criteria. If no
12
+ * criteria are specified, all custom language models are returned.</p>
13
+ * <p>To get detailed information about a specific custom language model, use the operation.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
@@ -8,10 +8,9 @@ export interface ListMedicalTranscriptionJobsCommandInput extends ListMedicalTra
8
8
  export interface ListMedicalTranscriptionJobsCommandOutput extends ListMedicalTranscriptionJobsResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Provides a list of medical transcription jobs that match the specified criteria. If no criteria are
12
- * specified, all medical transcription jobs are returned.</p>
13
- * <p>To get detailed information about a specific medical transcription job, use the
14
- * operation.</p>
11
+ * <p>Provides a list of medical transcription jobs that match the specified criteria. If no
12
+ * criteria are specified, all medical transcription jobs are returned.</p>
13
+ * <p>To get detailed information about a specific medical transcription job, use the operation.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
@@ -8,10 +8,9 @@ export interface ListMedicalVocabulariesCommandInput extends ListMedicalVocabula
8
8
  export interface ListMedicalVocabulariesCommandOutput extends ListMedicalVocabulariesResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Provides a list of custom medical vocabularies that match the specified criteria. If no
12
- * criteria are specified, all custom medical vocabularies are returned.</p>
13
- * <p>To get detailed information about a specific custom medical vocabulary, use the
14
- * operation.</p>
11
+ * <p>Provides a list of custom medical vocabularies that match the specified criteria. If
12
+ * no criteria are specified, all custom medical vocabularies are returned.</p>
13
+ * <p>To get detailed information about a specific custom medical vocabulary, use the operation.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
@@ -10,7 +10,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
10
10
  /**
11
11
  * <p>Lists all tags associated with the specified transcription job, vocabulary, model, or
12
12
  * resource.</p>
13
- * <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>
13
+ * <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
14
+ * resources</a>.</p>
14
15
  * @example
15
16
  * Use a bare-bones client and the command you need to make an API call.
16
17
  * ```javascript
@@ -8,10 +8,9 @@ export interface ListTranscriptionJobsCommandInput extends ListTranscriptionJobs
8
8
  export interface ListTranscriptionJobsCommandOutput extends ListTranscriptionJobsResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Provides a list of transcription jobs that match the specified criteria. If no criteria are
12
- * specified, all transcription jobs are returned.</p>
13
- * <p>To get detailed information about a specific transcription job, use the
14
- * operation.</p>
11
+ * <p>Provides a list of transcription jobs that match the specified criteria. If no
12
+ * criteria are specified, all transcription jobs are returned.</p>
13
+ * <p>To get detailed information about a specific transcription job, use the operation.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
@@ -8,10 +8,9 @@ export interface ListVocabulariesCommandInput extends ListVocabulariesRequest {
8
8
  export interface ListVocabulariesCommandOutput extends ListVocabulariesResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Provides a list of custom vocabularies that match the specified criteria. If no criteria are
12
- * specified, all custom vocabularies are returned.</p>
13
- * <p>To get detailed information about a specific custom vocabulary, use the
14
- * operation.</p>
11
+ * <p>Provides a list of custom vocabularies that match the specified criteria. If no
12
+ * criteria are specified, all custom vocabularies are returned.</p>
13
+ * <p>To get detailed information about a specific custom vocabulary, use the operation.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
@@ -10,8 +10,7 @@ export interface ListVocabularyFiltersCommandOutput extends ListVocabularyFilter
10
10
  /**
11
11
  * <p>Provides a list of custom vocabulary filters that match the specified criteria. If no
12
12
  * criteria are specified, all custom vocabularies are returned.</p>
13
- * <p>To get detailed information about a specific custom vocabulary filter, use the
14
- * operation.</p>
13
+ * <p>To get detailed information about a specific custom vocabulary filter, use the operation.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript