feat(client-lex-models-v2): This release updates type for Channel fie…

…ld in SessionSpecification and UtteranceSpecification
aws · Jul 20, 2023 · 1f77d0a · 1f77d0a
1 parent 8acc64c
commit 1f77d0a
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 83 deletions.
diff --git a/clients/client-lex-models-v2/src/commands/DescribeSlotTypeCommand.ts b/clients/client-lex-models-v2/src/commands/DescribeSlotTypeCommand.ts
@@ -14,7 +14,8 @@ import {
 } from "@smithy/types";
 
 import { LexModelsV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LexModelsV2Client";
-import { DescribeSlotTypeRequest, DescribeSlotTypeResponse } from "../models/models_1";
+import { DescribeSlotTypeRequest } from "../models/models_0";
+import { DescribeSlotTypeResponse } from "../models/models_1";
 import { de_DescribeSlotTypeCommand, se_DescribeSlotTypeCommand } from "../protocols/Aws_restJson1";
 
 /**

diff --git a/clients/client-lex-models-v2/src/commands/ListIntentStageMetricsCommand.ts b/clients/client-lex-models-v2/src/commands/ListIntentStageMetricsCommand.ts
@@ -36,7 +36,7 @@ export interface ListIntentStageMetricsCommandOutput extends ListIntentStageMetr
 
 /**
  * @public
- * <p>Retrieves summary metrics for the intent stages in your bot. The following fields are required:</p>
+ * <p>Retrieves summary metrics for the stages within intents in your bot. The following fields are required:</p>
  *          <ul>
  *             <li>
  *                <p>

diff --git a/clients/client-lex-models-v2/src/commands/ListSessionAnalyticsDataCommand.ts b/clients/client-lex-models-v2/src/commands/ListSessionAnalyticsDataCommand.ts
@@ -81,7 +81,7 @@ export interface ListSessionAnalyticsDataCommandOutput extends ListSessionAnalyt
  * //       botAliasId: "STRING_VALUE",
  * //       botVersion: "STRING_VALUE",
  * //       localeId: "STRING_VALUE",
- * //       channel: "Facebook" || "Slack" || "TwilioSms",
+ * //       channel: "STRING_VALUE",
  * //       sessionId: "STRING_VALUE",
  * //       conversationStartTime: new Date("TIMESTAMP"),
  * //       conversationEndTime: new Date("TIMESTAMP"),

diff --git a/clients/client-lex-models-v2/src/commands/ListUtteranceAnalyticsDataCommand.ts b/clients/client-lex-models-v2/src/commands/ListUtteranceAnalyticsDataCommand.ts
@@ -36,7 +36,20 @@ export interface ListUtteranceAnalyticsDataCommandOutput extends ListUtteranceAn
 
 /**
  * @public
- * <p>Retrieves a list of metadata for individual user utterances to your bot. The <code>startDateTime</code> and <code>endDateTime</code> fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:</p>
+ * <note>
+ *             <p>To use this API operation, your IAM role must have permissions to
+ *             perform the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html">ListAggregatedUtterances</a> operation, which provides access to
+ *             utterance-related analytics. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html">Viewing utterance
+ *                statistics</a> for the IAM policy to apply to the IAM role.</p>
+ *          </note>
+ *          <p>Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>startDateTime</code> and <code>endDateTime</code> – Define a time range for which you want to retrieve results.</p>
+ *             </li>
+ *          </ul>
+ *          <p>Of the optional fields, you can organize the results in the following ways:</p>
  *          <ul>
  *             <li>
  *                <p>Use the <code>filters</code> field to filter the results and the <code>sortBy</code> field to specify the values by which to sort the results.</p>
@@ -82,7 +95,7 @@ export interface ListUtteranceAnalyticsDataCommandOutput extends ListUtteranceAn
  * //       botVersion: "STRING_VALUE",
  * //       localeId: "STRING_VALUE",
  * //       sessionId: "STRING_VALUE",
- * //       channel: "Facebook" || "Slack" || "TwilioSms",
+ * //       channel: "STRING_VALUE",
  * //       mode: "Speech" || "Text" || "DTMF" || "MultiMode",
  * //       conversationStartTime: new Date("TIMESTAMP"),
  * //       conversationEndTime: new Date("TIMESTAMP"),

diff --git a/clients/client-lex-models-v2/src/commands/ListUtteranceMetricsCommand.ts b/clients/client-lex-models-v2/src/commands/ListUtteranceMetricsCommand.ts
@@ -36,7 +36,13 @@ export interface ListUtteranceMetricsCommandOutput extends ListUtteranceMetricsR
 
 /**
  * @public
- * <p>Retrieves summary metrics for the utterances in your bot. The following fields are required:</p>
+ * <note>
+ *             <p>To use this API operation, your IAM role must have permissions to
+ *             perform the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html">ListAggregatedUtterances</a> operation, which provides access to
+ *             utterance-related analytics. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html">Viewing utterance
+ *                statistics</a> for the IAM policy to apply to the IAM role.</p>
+ *          </note>
+ *          <p>Retrieves summary metrics for the utterances in your bot. The following fields are required:</p>
  *          <ul>
  *             <li>
  *                <p>

diff --git a/clients/client-lex-models-v2/src/models/models_0.ts b/clients/client-lex-models-v2/src/models/models_0.ts
@@ -2120,7 +2120,7 @@ export interface AnalyticsUtteranceMetricResult {
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>UtteranceTimeStamp</code> – The date and time of the utterance.</p>
+   *                   <code>UtteranceTimestamp</code> – The date and time of the utterance.</p>
    *             </li>
    *          </ul>
    */
@@ -2929,21 +2929,6 @@ export interface BotAliasTestExecutionTarget {
   localeId: string | undefined;
 }
 
-/**
- * @public
- * @enum
- */
-export const BotChannelType = {
-  Facebook: "Facebook",
-  Slack: "Slack",
-  TwilioSms: "TwilioSms",
-} as const;
-
-/**
- * @public
- */
-export type BotChannelType = (typeof BotChannelType)[keyof typeof BotChannelType];
-
 /**
  * @public
  * <p>Provides the identity of a the bot that was exported.</p>
@@ -7820,6 +7805,33 @@ export interface DescribeSlotRequest {
   intentId: string | undefined;
 }
 
+/**
+ * @public
+ */
+export interface DescribeSlotTypeRequest {
+  /**
+   * <p>The identifier of the slot type.</p>
+   */
+  slotTypeId: string | undefined;
+
+  /**
+   * <p>The identifier of the bot associated with the slot type.</p>
+   */
+  botId: string | undefined;
+
+  /**
+   * <p>The version of the bot associated with the slot type.</p>
+   */
+  botVersion: string | undefined;
+
+  /**
+   * <p>The identifier of the language and locale of the slot type to
+   *          describe. The string must match one of the supported locales. For more
+   *          information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
+   */
+  localeId: string | undefined;
+}
+
 /**
  * @internal
  */

diff --git a/clients/client-lex-models-v2/src/models/models_1.ts b/clients/client-lex-models-v2/src/models/models_1.ts
@@ -38,7 +38,6 @@ import {
   BotAliasStatus,
   BotAliasSummary,
   BotAliasTestExecutionTarget,
-  BotChannelType,
   BotFilter,
   BotLocaleFilter,
   BotLocaleSortBy,
@@ -109,33 +108,6 @@ import {
   WaitAndContinueSpecification,
 } from "./models_0";
 
-/**
- * @public
- */
-export interface DescribeSlotTypeRequest {
-  /**
-   * <p>The identifier of the slot type.</p>
-   */
-  slotTypeId: string | undefined;
-
-  /**
-   * <p>The identifier of the bot associated with the slot type.</p>
-   */
-  botId: string | undefined;
-
-  /**
-   * <p>The version of the bot associated with the slot type.</p>
-   */
-  botVersion: string | undefined;
-
-  /**
-   * <p>The identifier of the language and locale of the slot type to
-   *          describe. The string must match one of the supported locales. For more
-   *          information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
-   */
-  localeId: string | undefined;
-}
-
 /**
  * @public
  */
@@ -2716,7 +2688,7 @@ export interface SessionSpecification {
   /**
    * <p>The channel that is integrated with the bot that the session was held with.</p>
    */
-  channel?: BotChannelType | string;
+  channel?: string;
 
   /**
    * <p>The identifier of the session.</p>
@@ -3809,7 +3781,7 @@ export interface UtteranceDataSortBy {
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>UtteranceTimeStamp</code> – The date and time of the utterance.</p>
+   *                   <code>UtteranceTimestamp</code> – The date and time of the utterance.</p>
    *             </li>
    *          </ul>
    */
@@ -3948,7 +3920,7 @@ export interface UtteranceSpecification {
   /**
    * <p>The channel that is integrated with the bot that the utterance was made to.</p>
    */
-  channel?: BotChannelType | string;
+  channel?: string;
 
   /**
    * <p>The mode of the session. The possible values are as follows:</p>