docs(client-transcribe): Updating documentation for post call analytics job queueing.

awstools · awstools · commit 1c074ec16912 · 2025-03-03T19:23:31.000Z
diff --git a/clients/client-transcribe/src/commands/StartCallAnalyticsJobCommand.ts b/clients/client-transcribe/src/commands/StartCallAnalyticsJobCommand.ts
@@ -44,7 +44,9 @@ export interface StartCallAnalyticsJobCommandOutput extends StartCallAnalyticsJo
  *          <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>Note that job queuing is enabled by default for Call Analytics jobs.</p>
+ *          <p>Job queuing is available for Call Analytics jobs. If you pass a <code>DataAccessRoleArn</code>
+ *             in your request and you exceed your Concurrent Job Limit, your job will automatically be
+ *             added to a queue to be processed once your concurrent job count is below the limit.</p>
  *          <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>
  *             request:</p>
  *          <ul>
@@ -61,12 +63,6 @@ export interface StartCallAnalyticsJobCommandOutput extends StartCallAnalyticsJo
  *             </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>
diff --git a/clients/client-transcribe/src/models/models_0.ts b/clients/client-transcribe/src/models/models_0.ts
@@ -1552,11 +1552,12 @@ export interface ClinicalNoteGenerationSettings {
    * <p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>
    *          <ul>
    *             <li>
-   *                <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint,
-   *                 History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p>
+   *                <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.
+   *                 </p>
    *             </li>
    *             <li>
-   *                <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p>
+   *                <p>GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention,
+   *                     Response, Progress, and Plan.</p>
    *             </li>
    *          </ul>
    * @public
diff --git a/codegen/sdk-codegen/aws-models/transcribe.json b/codegen/sdk-codegen/aws-models/transcribe.json
@@ -585,7 +585,7 @@
         "NoteTemplate": {
           "target": "com.amazonaws.transcribe#MedicalScribeNoteTemplate",
           "traits": {
-            "smithy.api#documentation": "<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>\n         <ul>\n            <li>\n               <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint, \n                History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p>\n            </li>\n            <li>\n               <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p>\n            </li>\n         </ul>"
+            "smithy.api#documentation": "<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>\n         <ul>\n            <li>\n               <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.\n                </p>\n            </li>\n            <li>\n               <p>GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention,\n                    Response, Progress, and Plan.</p>\n            </li>\n         </ul>"
           }
         }
       },
@@ -5280,7 +5280,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Transcribes the audio from a customer service call and applies any additional Request\n            Parameters you choose to include in your request.</p>\n         <p>In addition to many standard transcription features, Call Analytics provides you with\n            call characteristics, call summarization, speaker sentiment, and optional redaction of\n            your text transcript and your audio file. You can also apply custom categories to flag\n            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\n                center audio with Call Analytics</a>.</p>\n         <p>If you want to apply categories to your Call Analytics job, you must create them\n            before submitting your job request. Categories cannot be retroactively applied to a job.\n            To create a new category, use the \n            operation. 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 post-call \n                transcriptions</a> and <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html\">Creating categories for \n                    real-time transcriptions</a>.</p>\n         <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media\n            file into an Amazon S3 bucket; you can then specify the Amazon S3\n            location of the file using the <code>Media</code> parameter.</p>\n         <p>Note that job queuing is enabled by default for Call Analytics jobs.</p>\n         <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>\n            request:</p>\n         <ul>\n            <li>\n               <p>\n                  <code>region</code>: The Amazon Web Services Region where you are making your\n                    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\n                        quotas</a>.</p>\n            </li>\n            <li>\n               <p>\n                  <code>CallAnalyticsJobName</code>: A custom name that you create for your\n                    transcription job that's unique within your Amazon Web Services account.</p>\n            </li>\n            <li>\n               <p>\n                  <code>DataAccessRoleArn</code>: The Amazon Resource Name (ARN) of an IAM role\n                    that has permissions to access the Amazon S3 bucket that contains your\n                    input files.</p>\n            </li>\n            <li>\n               <p>\n                  <code>Media</code> (<code>MediaFileUri</code> or\n                        <code>RedactedMediaFileUri</code>): The Amazon S3 location of your\n                    media file.</p>\n            </li>\n         </ul>\n         <note>\n            <p>With Call Analytics, you can redact the audio contained in your media file by\n                including <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>,\n                to specify the location of your input audio. If you choose to redact your audio, you\n                can find your redacted media at the location specified in the\n                    <code>RedactedMediaFileUri</code> field of your response.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Transcribes the audio from a customer service call and applies any additional Request\n            Parameters you choose to include in your request.</p>\n         <p>In addition to many standard transcription features, Call Analytics provides you with\n            call characteristics, call summarization, speaker sentiment, and optional redaction of\n            your text transcript and your audio file. You can also apply custom categories to flag\n            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\n                center audio with Call Analytics</a>.</p>\n         <p>If you want to apply categories to your Call Analytics job, you must create them\n            before submitting your job request. Categories cannot be retroactively applied to a job.\n            To create a new category, use the \n            operation. 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 post-call \n                transcriptions</a> and <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html\">Creating categories for \n                    real-time transcriptions</a>.</p>\n         <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media\n            file into an Amazon S3 bucket; you can then specify the Amazon S3\n            location of the file using the <code>Media</code> parameter.</p>\n         <p>Job queuing is available for Call Analytics jobs. If you pass a <code>DataAccessRoleArn</code> \n            in your request and you exceed your Concurrent Job Limit, your job will automatically be \n            added to a queue to be processed once your concurrent job count is below the limit.</p>\n         <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>\n            request:</p>\n         <ul>\n            <li>\n               <p>\n                  <code>region</code>: The Amazon Web Services Region where you are making your\n                    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\n                        quotas</a>.</p>\n            </li>\n            <li>\n               <p>\n                  <code>CallAnalyticsJobName</code>: A custom name that you create for your\n                    transcription job that's unique within your Amazon Web Services account.</p>\n            </li>\n            <li>\n               <p>\n                  <code>Media</code> (<code>MediaFileUri</code> or\n                        <code>RedactedMediaFileUri</code>): The Amazon S3 location of your\n                    media file.</p>\n            </li>\n         </ul>\n         <note>\n            <p>With Call Analytics, you can redact the audio contained in your media file by\n                including <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>,\n                to specify the location of your input audio. If you choose to redact your audio, you\n                can find your redacted media at the location specified in the\n                    <code>RedactedMediaFileUri</code> field of your response.</p>\n         </note>",
         "smithy.api#http": {
           "method": "PUT",
           "uri": "/callanalyticsjobs/{CallAnalyticsJobName}",

Original file line number	Diff line number	Diff line change
`@@ -585,7 +585,7 @@`
`585`	`585`	`"NoteTemplate": {`
`586`	`586`	`"target": "com.amazonaws.transcribe#MedicalScribeNoteTemplate",`
`587`	`587`	`"traits": {`
`588`		- "smithy.api#documentation": "<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>\n <ul>\n <li>\n <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint, \n History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p>\n </li>\n <li>\n <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p>\n </li>\n </ul>"
	`588`	+ "smithy.api#documentation": "<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p>\n <ul>\n <li>\n <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Examples of sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.\n </p>\n </li>\n <li>\n <p>GIRPP: Provides summaries based on the patients progress toward goals. Examples of sections include Goal, Intervention,\n Response, Progress, and Plan.</p>\n </li>\n </ul>"
`589`	`589`	`}`
`590`	`590`	`}`
`591`	`591`	`},`
`@@ -5280,7 +5280,7 @@`
`5280`	`5280`	`}`
`5281`	`5281`	`],`
`5282`	`5282`	`"traits": {`
`5283`		- "smithy.api#documentation": "<p>Transcribes the audio from a customer service call and applies any additional Request\n Parameters you choose to include in your request.</p>\n <p>In addition to many standard transcription features, Call Analytics provides you with\n call characteristics, call summarization, speaker sentiment, and optional redaction of\n your text transcript and your audio file. You can also apply custom categories to flag\n 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\n center audio with Call Analytics</a>.</p>\n <p>If you want to apply categories to your Call Analytics job, you must create them\n before submitting your job request. Categories cannot be retroactively applied to a job.\n To create a new category, use the \n operation. 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 post-call \n transcriptions</a> and <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html\">Creating categories for \n real-time transcriptions</a>.</p>\n <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the <code>Media</code> parameter.</p>\n <p>Note that job queuing is enabled by default for Call Analytics jobs.</p>\n <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>\n request:</p>\n <ul>\n <li>\n <p>\n <code>region</code>: The Amazon Web Services Region where you are making your\n 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\n quotas</a>.</p>\n </li>\n <li>\n <p>\n <code>CallAnalyticsJobName</code>: A custom name that you create for your\n transcription job that's unique within your Amazon Web Services account.</p>\n </li>\n <li>\n <p>\n <code>DataAccessRoleArn</code>: The Amazon Resource Name (ARN) of an IAM role\n that has permissions to access the Amazon S3 bucket that contains your\n input files.</p>\n </li>\n <li>\n <p>\n <code>Media</code> (<code>MediaFileUri</code> or\n <code>RedactedMediaFileUri</code>): The Amazon S3 location of your\n media file.</p>\n </li>\n </ul>\n <note>\n <p>With Call Analytics, you can redact the audio contained in your media file by\n including <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>,\n to specify the location of your input audio. If you choose to redact your audio, you\n can find your redacted media at the location specified in the\n <code>RedactedMediaFileUri</code> field of your response.</p>\n </note>",
	`5283`	+ "smithy.api#documentation": "<p>Transcribes the audio from a customer service call and applies any additional Request\n Parameters you choose to include in your request.</p>\n <p>In addition to many standard transcription features, Call Analytics provides you with\n call characteristics, call summarization, speaker sentiment, and optional redaction of\n your text transcript and your audio file. You can also apply custom categories to flag\n 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\n center audio with Call Analytics</a>.</p>\n <p>If you want to apply categories to your Call Analytics job, you must create them\n before submitting your job request. Categories cannot be retroactively applied to a job.\n To create a new category, use the \n operation. 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 post-call \n transcriptions</a> and <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html\">Creating categories for \n real-time transcriptions</a>.</p>\n <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the Amazon S3\n location of the file using the <code>Media</code> parameter.</p>\n <p>Job queuing is available for Call Analytics jobs. If you pass a <code>DataAccessRoleArn</code> \n in your request and you exceed your Concurrent Job Limit, your job will automatically be \n added to a queue to be processed once your concurrent job count is below the limit.</p>\n <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>\n request:</p>\n <ul>\n <li>\n <p>\n <code>region</code>: The Amazon Web Services Region where you are making your\n 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\n quotas</a>.</p>\n </li>\n <li>\n <p>\n <code>CallAnalyticsJobName</code>: A custom name that you create for your\n transcription job that's unique within your Amazon Web Services account.</p>\n </li>\n <li>\n <p>\n <code>Media</code> (<code>MediaFileUri</code> or\n <code>RedactedMediaFileUri</code>): The Amazon S3 location of your\n media file.</p>\n </li>\n </ul>\n <note>\n <p>With Call Analytics, you can redact the audio contained in your media file by\n including <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>,\n to specify the location of your input audio. If you choose to redact your audio, you\n can find your redacted media at the location specified in the\n <code>RedactedMediaFileUri</code> field of your response.</p>\n </note>",
`5284`	`5284`	`"smithy.api#http": {`
`5285`	`5285`	`"method": "PUT",`
`5286`	`5286`	`"uri": "/callanalyticsjobs/{CallAnalyticsJobName}",`