@aws-sdk/client-transcribe 3.95.0 → 3.102.0

package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts

@@ -7,12 +7,54 @@ export interface StartCallAnalyticsJobCommandInput extends StartCallAnalyticsJob
 export interface StartCallAnalyticsJobCommandOutput extends StartCallAnalyticsJobResponse, __MetadataBearer {
 }
 /**
- * <p>Starts an asynchronous analytics job that not only transcribes the audio recording of a
- *             caller and agent, but also returns additional insights. These insights include how quickly or
- *             loudly the caller or agent was speaking. To retrieve additional insights with your analytics
- *             jobs, create categories. A category is a way to classify analytics jobs based on attributes,
- *             such as a customer's sentiment or a particular phrase being used during the call. For more
- *             information, see the  operation. </p>
+ * <p>Transcribes the audio from a customer service call and applies any additional Request
+ *             Parameters you choose to include in your request.</p>
+ *         <p>In addition to many of the standard transcription features, Call Analytics provides you with
+ *             call characteristics, call summarization, speaker sentiment, and optional redaction of your text
+ *             transcript and your audio file. You can also apply custom categories to flag specified conditions. To
+ *             learn more about these features and insights, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call
+ *                 Analytics</a>.</p>
+ *         <p>If you want to apply categories to your Call Analytics job, you must create them
+ *             before submitting your job request. Categories cannot be retroactively applied to a job. To
+ *             create a new category, use the  operation.
+ *             To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html">Creating
+ *                 categories</a>.</p>
+ *         <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media file
+ *             into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file
+ *             using the <code>Media</code> parameter.</p>
+ *         <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>
+ *             request:</p>
+ *         <ul>
+ *             <li>
+ *                 <p>
+ *                   <code>region</code>: The Amazon Web Services Region where you are making your
+ *                     request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer
+ *                     to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe
+ *                         endpoints and quotas</a>.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>CallAnalyticsJobName</code>: A custom name you create for your transcription job
+ *                     that is unique within your Amazon Web Services account.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>DataAccessRoleArn</code>: The Amazon Resource Name (ARN) of an IAM role that
+ *                     has permissions to access the Amazon S3 bucket that contains your input files.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>Media</code> (<code>MediaFileUri</code> or <code>RedactedMediaFileUri</code>):
+ *                     The Amazon S3 location of your media file.</p>
+ *             </li>
+ *          </ul>
+ *         <note>
+ *             <p>With Call Analytics, you can redact the audio contained in your media file by including
+ *                 <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>, to specify the
+ *                 location of your input audio. If you choose to redact your audio, you can find your redacted
+ *                 media at the location specified in the <code>RedactedMediaFileUri</code> field of your
+ *                 response.</p>
+ *         </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts

@@ -7,7 +7,55 @@ export interface StartMedicalTranscriptionJobCommandInput extends StartMedicalTr
 export interface StartMedicalTranscriptionJobCommandOutput extends StartMedicalTranscriptionJobResponse, __MetadataBearer {
 }
 /**
- * <p>Starts a batch job to transcribe medical speech to text.</p>
+ * <p>Transcribes the audio from a medical dictation or conversation and applies any additional
+ *             Request Parameters you choose to include in your request.</p>
+ *         <p>In addition to many of the standard transcription features, Amazon Transcribe Medical provides
+ *             you with a robust medical vocabulary and, optionally, content identification, which adds flags to
+ *             personal health information (PHI). To learn more about these features, refer to
+ *             <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html">How
+ *                 Amazon Transcribe Medical works</a>.</p>
+ *         <p>To make a <code>StartMedicalTranscriptionJob</code> request, you must first upload your media
+ *             file into an Amazon S3 bucket; you can then specify the S3 location of the file using the
+ *             <code>Media</code> parameter.</p>
+ *         <p>You must include the following parameters in your <code>StartMedicalTranscriptionJob</code>
+ *             request:</p>
+ *         <ul>
+ *             <li>
+ *                 <p>
+ *                   <code>region</code>: The Amazon Web Services Region where you are making your
+ *                     request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer
+ *                     to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe
+ *                         endpoints and quotas</a>.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>MedicalTranscriptionJobName</code>: A custom name you create for your
+ *                     transcription job that is unique within your Amazon Web Services account.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location of
+ *                     your media file.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>LanguageCode</code>: This must be <code>en-US</code>.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>OutputBucketName</code>: The Amazon S3 bucket where you want
+ *                     your transcript stored. If you want your output stored in a sub-folder of this bucket, you must
+ *                     also include <code>OutputKey</code>.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>Specialty</code>: This must be <code>PRIMARYCARE</code>.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>Type</code>: Choose whether your audio is a conversation or a dictation.</p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartTranscriptionJobCommand.d.ts

@@ -7,7 +7,41 @@ export interface StartTranscriptionJobCommandInput extends StartTranscriptionJob
 export interface StartTranscriptionJobCommandOutput extends StartTranscriptionJobResponse, __MetadataBearer {
 }
 /**
- * <p>Starts an asynchronous job to transcribe speech to text.</p>
+ * <p>Transcribes the audio from a media file and applies any additional Request Parameters you
+ *             choose to include in your request.</p>
+ *         <p>To make a <code>StartTranscriptionJob</code> request, you must first upload your media file
+ *             into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file
+ *             using the <code>Media</code> parameter.</p>
+ *             <p>You must include the following parameters in your <code>StartTranscriptionJob</code>
+ *                 request:</p>
+ *             <ul>
+ *             <li>
+ *                     <p>
+ *                   <code>region</code>: The Amazon Web Services Region where you are making your
+ *                         request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer
+ *                         to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe
+ *                             endpoints and quotas</a>.</p>
+ *                 </li>
+ *             <li>
+ *                     <p>
+ *                   <code>TranscriptionJobName</code>: A custom name you create for your transcription
+ *                         job that is unique within your Amazon Web Services account.</p>
+ *                 </li>
+ *             <li>
+ *                     <p>
+ *                   <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location of
+ *                         your media file.</p>
+ *                 </li>
+ *             <li>
+ *                     <p>One of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or
+ *                         <code>IdentifyMultipleLanguages</code>: If you know the language of your media file,
+ *                         specify it using the <code>LanguageCode</code> parameter; you can find all valid language
+ *                         codes in the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.
+ *                         If you don't know the languages spoken in your media, use either
+ *                         <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> and let
+ *                         Amazon Transcribe identify the languages for you.</p>
+ *                 </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TagResourceCommand.d.ts

@@ -7,7 +7,9 @@ export interface TagResourceCommandInput extends TagResourceRequest {
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
- * <p>Tags an Amazon Transcribe resource with the given list of tags.</p>
+ * <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
+ *             resource.</p>
+ *         <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -7,7 +7,9 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
- * <p>Removes specified tags from a specified Amazon Transcribe resource.</p>
+ * <p>Removes the specified tags from the specified Amazon Transcribe resource.</p>
+ *         <p>If you include <code>UntagResource</code> in your request, you must also include
+ *             <code>ResourceArn</code> and <code>TagKeys</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts

@@ -7,9 +7,10 @@ export interface UpdateCallAnalyticsCategoryCommandInput extends UpdateCallAnaly
 export interface UpdateCallAnalyticsCategoryCommandOutput extends UpdateCallAnalyticsCategoryResponse, __MetadataBearer {
 }
 /**
- * <p>Updates the call analytics category with new values. The
- *             <code>UpdateCallAnalyticsCategory</code> operation overwrites all of the existing
- *             information with the values that you provide in the request.</p>
+ * <p>Updates the specified Call Analytics category with new rules. Note that the
+ *             <code>UpdateCallAnalyticsCategory</code> operation overwrites all existing rules contained in
+ *             the specified category. You cannot append additional rules onto an existing category.</p>
+ *         <p>To create a new category, see .</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateMedicalVocabularyCommand.d.ts

@@ -7,10 +7,9 @@ export interface UpdateMedicalVocabularyCommandInput extends UpdateMedicalVocabu
 export interface UpdateMedicalVocabularyCommandOutput extends UpdateMedicalVocabularyResponse, __MetadataBearer {
 }
 /**
- * <p>Updates a vocabulary with new values that you provide in a different text file from
- *             the one you used to create the vocabulary. The <code>UpdateMedicalVocabulary</code>
- *             operation overwrites all of the existing information with the values that you provide in the
- *             request.</p>
+ * <p>Updates an existing custom medical vocabulary with new values. This operation overwrites
+ *             all existing information with your new values; you cannot append new terms onto an existing
+ *             vocabulary.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateVocabularyCommand.d.ts

@@ -7,9 +7,8 @@ export interface UpdateVocabularyCommandInput extends UpdateVocabularyRequest {
 export interface UpdateVocabularyCommandOutput extends UpdateVocabularyResponse, __MetadataBearer {
 }
 /**
- * <p>Updates an existing vocabulary with new values. The
- *             <code>UpdateVocabulary</code> operation overwrites all of the existing information with
- *             the values that you provide in the request. </p>
+ * <p>Updates an existing custom vocabulary with new values. This operation overwrites all existing
+ *             information with your new values; you cannot append new terms onto an existing vocabulary.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateVocabularyFilterCommand.d.ts

@@ -7,7 +7,9 @@ export interface UpdateVocabularyFilterCommandInput extends UpdateVocabularyFilt
 export interface UpdateVocabularyFilterCommandOutput extends UpdateVocabularyFilterResponse, __MetadataBearer {
 }
 /**
- * <p>Updates a vocabulary filter with a new list of filtered words.</p>
+ * <p>Updates an existing custom vocabulary filter with a new list of words. The new list you provide
+ *             overwrites all previous entries; you cannot append new terms onto an existing vocabulary
+ *             filter.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript