@aws-sdk/client-connect 3.977.0 → 3.980.0

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

@@ -27,23 +27,27 @@ declare const GetContactMetricsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Retrieves the position of the contact in the queue.</p>
+ * <p>Retrieves contact metric data for a specified contact.</p>
  *          <p>
  *             <b>Use cases</b>
  *          </p>
- *          <p>Following are common uses cases for position in queue:</p>
+ *          <p>Following are common use cases for position in queue and estimated wait time:</p>
  *          <ul>
  *             <li>
- *                <p>Understand the expected wait experience of a contact.</p>
+ *                <p>Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience.
+ *     </p>
  *             </li>
  *             <li>
- *                <p>Inform customers of their position in queue and potentially offer a callback.</p>
+ *                <p>Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold.
+ *     </p>
  *             </li>
  *             <li>
- *                <p>Make data-driven routing decisions between primary and alternative queues.</p>
+ *                <p>Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues.
+ *     </p>
  *             </li>
  *             <li>
- *                <p>Enhance queue visibility and leverage agent proficiencies to streamline contact routing.</p>
+ *                <p>Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable.
+ *     </p>
  *             </li>
  *          </ul>
  *          <p>
@@ -51,8 +55,7 @@ declare const GetContactMetricsCommand_base: {
  *          </p>
  *          <ul>
  *             <li>
- *                <p>The only way to retrieve the position of the contact in queue is by using this API. You can't retrieve the
- *      position by using flows and attributes.</p>
+ *                <p>Metrics are only available while the contact is actively in queue.</p>
  *             </li>
  *             <li>
  *                <p>For more information, see the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Position in queue</a> metric in the <i>Amazon Connect Administrator Guide</i>. </p>
@@ -73,7 +76,7 @@ declare const GetContactMetricsCommand_base: {
  *   ContactId: "STRING_VALUE", // required
  *   Metrics: [ // ContactMetrics // required
  *     { // ContactMetricInfo
- *       Name: "POSITION_IN_QUEUE", // required
+ *       Name: "ESTIMATED_WAIT_TIME" || "POSITION_IN_QUEUE", // required
  *     },
  *   ],
  * };
@@ -82,7 +85,7 @@ declare const GetContactMetricsCommand_base: {
  * // { // GetContactMetricsResponse
  * //   MetricResults: [ // ContactMetricResults
  * //     { // ContactMetricResult
- * //       Name: "POSITION_IN_QUEUE", // required
+ * //       Name: "ESTIMATED_WAIT_TIME" || "POSITION_IN_QUEUE", // required
  * //       Value: { // ContactMetricValue Union: only one key present
  * //         Number: Number("double"),
  * //       },

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

@@ -104,7 +104,7 @@ declare const GetCurrentMetricDataCommand_base: {
  *   ],
  *   CurrentMetrics: [ // CurrentMetrics // required
  *     { // CurrentMetric
- *       Name: "AGENTS_ONLINE" || "AGENTS_AVAILABLE" || "AGENTS_ON_CALL" || "AGENTS_NON_PRODUCTIVE" || "AGENTS_AFTER_CONTACT_WORK" || "AGENTS_ERROR" || "AGENTS_STAFFED" || "CONTACTS_IN_QUEUE" || "OLDEST_CONTACT_AGE" || "CONTACTS_SCHEDULED" || "AGENTS_ON_CONTACT" || "SLOTS_ACTIVE" || "SLOTS_AVAILABLE",
+ *       Name: "AGENTS_ONLINE" || "AGENTS_AVAILABLE" || "AGENTS_ON_CALL" || "AGENTS_NON_PRODUCTIVE" || "AGENTS_AFTER_CONTACT_WORK" || "AGENTS_ERROR" || "AGENTS_STAFFED" || "CONTACTS_IN_QUEUE" || "OLDEST_CONTACT_AGE" || "CONTACTS_SCHEDULED" || "AGENTS_ON_CONTACT" || "SLOTS_ACTIVE" || "SLOTS_AVAILABLE" || "ESTIMATED_WAIT_TIME",
  *       MetricId: "STRING_VALUE",
  *       Unit: "SECONDS" || "COUNT" || "PERCENT",
  *     },
@@ -113,7 +113,7 @@ declare const GetCurrentMetricDataCommand_base: {
  *   MaxResults: Number("int"),
  *   SortCriteria: [ // CurrentMetricSortCriteriaMaxOne
  *     { // CurrentMetricSortCriteria
- *       SortByMetric: "AGENTS_ONLINE" || "AGENTS_AVAILABLE" || "AGENTS_ON_CALL" || "AGENTS_NON_PRODUCTIVE" || "AGENTS_AFTER_CONTACT_WORK" || "AGENTS_ERROR" || "AGENTS_STAFFED" || "CONTACTS_IN_QUEUE" || "OLDEST_CONTACT_AGE" || "CONTACTS_SCHEDULED" || "AGENTS_ON_CONTACT" || "SLOTS_ACTIVE" || "SLOTS_AVAILABLE",
+ *       SortByMetric: "AGENTS_ONLINE" || "AGENTS_AVAILABLE" || "AGENTS_ON_CALL" || "AGENTS_NON_PRODUCTIVE" || "AGENTS_AFTER_CONTACT_WORK" || "AGENTS_ERROR" || "AGENTS_STAFFED" || "CONTACTS_IN_QUEUE" || "OLDEST_CONTACT_AGE" || "CONTACTS_SCHEDULED" || "AGENTS_ON_CONTACT" || "SLOTS_ACTIVE" || "SLOTS_AVAILABLE" || "ESTIMATED_WAIT_TIME",
  *       SortOrder: "ASCENDING" || "DESCENDING",
  *     },
  *   ],
@@ -145,7 +145,7 @@ declare const GetCurrentMetricDataCommand_base: {
  * //       Collections: [ // CurrentMetricDataCollections
  * //         { // CurrentMetricData
  * //           Metric: { // CurrentMetric
- * //             Name: "AGENTS_ONLINE" || "AGENTS_AVAILABLE" || "AGENTS_ON_CALL" || "AGENTS_NON_PRODUCTIVE" || "AGENTS_AFTER_CONTACT_WORK" || "AGENTS_ERROR" || "AGENTS_STAFFED" || "CONTACTS_IN_QUEUE" || "OLDEST_CONTACT_AGE" || "CONTACTS_SCHEDULED" || "AGENTS_ON_CONTACT" || "SLOTS_ACTIVE" || "SLOTS_AVAILABLE",
+ * //             Name: "AGENTS_ONLINE" || "AGENTS_AVAILABLE" || "AGENTS_ON_CALL" || "AGENTS_NON_PRODUCTIVE" || "AGENTS_AFTER_CONTACT_WORK" || "AGENTS_ERROR" || "AGENTS_STAFFED" || "CONTACTS_IN_QUEUE" || "OLDEST_CONTACT_AGE" || "CONTACTS_SCHEDULED" || "AGENTS_ON_CONTACT" || "SLOTS_ACTIVE" || "SLOTS_AVAILABLE" || "ESTIMATED_WAIT_TIME",
  * //             MetricId: "STRING_VALUE",
  * //             Unit: "SECONDS" || "COUNT" || "PERCENT",
  * //           },

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

@@ -147,6 +147,23 @@ declare const SearchContactsCommand_base: {
  *     ActiveRegions: [ // ActiveRegionList
  *       "STRING_VALUE",
  *     ],
+ *     ContactTags: { // ControlPlaneTagFilter
+ *       OrConditions: [ // TagOrConditionList
+ *         [ // TagAndConditionList
+ *           { // TagCondition
+ *             TagKey: "STRING_VALUE",
+ *             TagValue: "STRING_VALUE",
+ *           },
+ *         ],
+ *       ],
+ *       AndConditions: [
+ *         {
+ *           TagKey: "STRING_VALUE",
+ *           TagValue: "STRING_VALUE",
+ *         },
+ *       ],
+ *       TagCondition: "<TagCondition>",
+ *     },
  *   },
  *   MaxResults: Number("int"),
  *   NextToken: "STRING_VALUE",
@@ -300,6 +317,9 @@ declare const SearchContactsCommand_base: {
  * //         ActivationTimestamp: new Date("TIMESTAMP"),
  * //         Index: Number("int"),
  * //       },
+ * //       Tags: { // ContactTagMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
  * //       GlobalResiliencyMetadata: { // GlobalResiliencyMetadata
  * //         ActiveRegion: "STRING_VALUE",
  * //         OriginRegion: "STRING_VALUE",

package/dist-types/models/enums.d.ts

@@ -1865,6 +1865,7 @@ export type Visibility = (typeof Visibility)[keyof typeof Visibility];
  * @enum
  */
 export declare const ContactMetricName: {
+    readonly ESTIMATED_WAIT_TIME: "ESTIMATED_WAIT_TIME";
     readonly POSITION_IN_QUEUE: "POSITION_IN_QUEUE";
 };
 /**
@@ -1886,6 +1887,7 @@ export declare const CurrentMetricName: {
     readonly AGENTS_STAFFED: "AGENTS_STAFFED";
     readonly CONTACTS_IN_QUEUE: "CONTACTS_IN_QUEUE";
     readonly CONTACTS_SCHEDULED: "CONTACTS_SCHEDULED";
+    readonly ESTIMATED_WAIT_TIME: "ESTIMATED_WAIT_TIME";
     readonly OLDEST_CONTACT_AGE: "OLDEST_CONTACT_AGE";
     readonly SLOTS_ACTIVE: "SLOTS_ACTIVE";
     readonly SLOTS_AVAILABLE: "SLOTS_AVAILABLE";

package/dist-types/models/models_1.d.ts

@@ -5273,12 +5273,14 @@ export interface GetContactAttributesResponse {
     Attributes?: Record<string, string> | undefined;
 }
 /**
- * <p>The object that contains information about metric being requested.</p>
+ * <p>Contains the details of a metric to be retrieved for a contact. Use this object to specify which
+ *    contact level metrics you want to include in your GetContactMetrics request.</p>
  * @public
  */
 export interface ContactMetricInfo {
     /**
-     * <p>The name of the metric being retrieved in type String.</p>
+     * <p>The name of the metric to retrieve. Supported values are POSITION_IN_QUEUE (returns the contact's
+     *    current position in the queue) and ESTIMATED_WAIT_TIME (returns the predicted wait time in seconds).</p>
      * @public
      */
     Name: ContactMetricName | undefined;
@@ -5298,13 +5300,15 @@ export interface GetContactMetricsRequest {
      */
     ContactId: string | undefined;
     /**
-     * <p>A list of contact-level metrics to retrieve.</p>
+     * <p>A list of contact level metrics to retrieve.Supported metrics include POSITION_IN_QUEUE (the contact's
+     *    current position in the queue) and ESTIMATED_WAIT_TIME (the predicted time in seconds until the contact is
+     *    connected to an agent)</p>
      * @public
      */
     Metrics: ContactMetricInfo[] | undefined;
 }
 /**
- * <p>Object which contains the number.</p>
+ * <p>Contains the numeric value of a contact metric result.</p>
  * @public
  */
 export type ContactMetricValue = ContactMetricValue.NumberMember | ContactMetricValue.$UnknownMember;
@@ -5313,7 +5317,9 @@ export type ContactMetricValue = ContactMetricValue.NumberMember | ContactMetric
  */
 export declare namespace ContactMetricValue {
     /**
-     * <p>The number of type Double. This number is the contact's position in queue.</p>
+     * <p>The numeric value of the metric result. For POSITION_IN_QUEUE, this represents the contact's
+     *    current position in the queue (e.g., 3.00 means third in line). For ESTIMATED_WAIT_TIME, this represents
+     *    the predicted wait time in seconds (e.g., 120.00 means approximately 2 minutes).</p>
      * @public
      */
     interface NumberMember {
@@ -5337,17 +5343,20 @@ export declare namespace ContactMetricValue {
     }
 }
 /**
- * <p>Object containing information about metric requested for the contact.</p>
+ * <p>Contains the result of a requested metric for the contact. This object is returned as part of the
+ *    GetContactMetrics response and includes both the metric name and its calculated value.</p>
  * @public
  */
 export interface ContactMetricResult {
     /**
-     * <p>The name of the metric being retrieved in type String.</p>
+     * <p>The name of the metric that was retrieved. This corresponds to the metric name specified in the
+     *    request, such as POSITION_IN_QUEUE or ESTIMATED_WAIT_TIME.</p>
      * @public
      */
     Name: ContactMetricName | undefined;
     /**
-     * <p>Object result associated with the metric received.</p>
+     * <p>The calculated value for the requested metric. This object contains the numeric result based on
+     *    the contact's current state in the queue.</p>
      * @public
      */
     Value: ContactMetricValue | undefined;
@@ -5357,13 +5366,15 @@ export interface ContactMetricResult {
  */
 export interface GetContactMetricsResponse {
     /**
-     * <p>A list of metric results containing the calculated values for each requested metric. Each result includes the
-     *    metric name and its corresponding calculated value.</p>
+     * <p>A list of metric results containing the calculated values for each requested metric. Each result includes
+     *    the metric name and its corresponding value. For example, POSITION_IN_QUEUE returns a numeric value representing
+     *    the contact's position in queue, and ESTIMATED_WAIT_TIME returns the predicted wait time in seconds.</p>
      * @public
      */
     MetricResults?: ContactMetricResult[] | undefined;
     /**
-     * <p>The unique identifier of the contact for which metrics were retrieved.</p>
+     * <p>The unique identifier of the contact for which metrics were retrieved. This matches the ContactId provided
+     *    in the request.</p>
      * @public
      */
     Id?: string | undefined;
@@ -5608,6 +5619,21 @@ export interface GetCurrentMetricDataRequest {
      *                <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-real-time">Scheduled</a>
      *                </p>
      *             </dd>
+     *             <dt>ESTIMATED_WAIT_TIME</dt>
+     *             <dd>
+     *                <p>Unit: SECONDS</p>
+     *                <p>This metric supports filter and grouping combination only used for core routing purpose.
+     *               Valid filter and grouping use cases:
+     *           </p>
+     *                <ul>
+     *                   <li>
+     *                      <p>Filter by a list of [Queues] and a list of [Channels], group by [“QUEUE”, “CHANNEL”]</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>Filter by a singleton list of [Queue], a singleton list of [Channel], a list of [RoutingStepExpression], group by [“ROUTING_STEP_EXPRESSION”].</p>
+     *                   </li>
+     *                </ul>
+     *             </dd>
      *             <dt>OLDEST_CONTACT_AGE</dt>
      *             <dd>
      *                <p>Unit: SECONDS</p>

package/dist-types/models/models_2.d.ts

@@ -6115,6 +6115,20 @@ export interface SearchCriteria {
      * @public
      */
     ActiveRegions?: string[] | undefined;
+    /**
+     * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>. This accepts an
+     *     <code>OR</code> of <code>AND</code> (List of List) input where:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Top level list specifies conditions that need to be applied with <code>OR</code> operator</p>
+     *             </li>
+     *             <li>
+     *                <p>Inner list specifies conditions that need to be applied with <code>AND</code> operator.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    ContactTags?: ControlPlaneTagFilter | undefined;
 }
 /**
  * <p>A structure that defines the field name to sort by and a sort order.</p>

package/dist-types/models/models_3.d.ts

@@ -6933,6 +6933,11 @@ export interface ContactSearchSummary {
      * @public
      */
     RoutingCriteria?: RoutingCriteria | undefined;
+    /**
+     * <p>Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.</p>
+     * @public
+     */
+    Tags?: Record<string, string> | undefined;
     /**
      * <p>Additional routing information for contacts created in ACGR instances.</p>
      * @public