feat(client-connect): This release adds a new MonitorContact API for initiating monitoring of ongoing Voice and Chat contacts.

awstools · awstools · commit 2adc9d0774cf · 2022-11-16T19:31:42.000Z
diff --git a/clients/client-connect/src/Connect.ts b/clients/client-connect/src/Connect.ts
@@ -499,6 +499,11 @@ import {
   ListUserHierarchyGroupsCommandOutput,
 } from "./commands/ListUserHierarchyGroupsCommand";
 import { ListUsersCommand, ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand";
+import {
+  MonitorContactCommand,
+  MonitorContactCommandInput,
+  MonitorContactCommandOutput,
+} from "./commands/MonitorContactCommand";
 import {
   PutUserStatusCommand,
   PutUserStatusCommandInput,
@@ -3043,8 +3048,9 @@ export class Connect extends ConnectClient {
   /**
    * <p>Dismisses contacts from an agent’s CCP and returns the agent to an available state, which
    *    allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a
-   *    <code>MISSED</code>, <code>ERROR</code>, <code>ENDED</code>, or <code>REJECTED</code> state in the
-   *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">Agent Event Stream</a>.</p>
+   *     <code>MISSED</code>, <code>ERROR</code>, <code>ENDED</code>, or <code>REJECTED</code> state in
+   *    the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">Agent
+   *     Event Stream</a>.</p>
    */
   public dismissUserContact(
     args: DismissUserContactCommandInput,
@@ -4337,6 +4343,39 @@ export class Connect extends ConnectClient {
     }
   }
 
+  /**
+   * <p>Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by
+   *    <i>userId</i> will be set to silent monitoring mode on the contact.</p>
+   */
+  public monitorContact(
+    args: MonitorContactCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<MonitorContactCommandOutput>;
+  public monitorContact(
+    args: MonitorContactCommandInput,
+    cb: (err: any, data?: MonitorContactCommandOutput) => void
+  ): void;
+  public monitorContact(
+    args: MonitorContactCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: MonitorContactCommandOutput) => void
+  ): void;
+  public monitorContact(
+    args: MonitorContactCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: MonitorContactCommandOutput) => void),
+    cb?: (err: any, data?: MonitorContactCommandOutput) => void
+  ): Promise<MonitorContactCommandOutput> | void {
+    const command = new MonitorContactCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
+
   /**
    * <p>Changes the current status of a user or agent in Amazon Connect. If the agent is
    *    currently handling a contact, this sets the agent's next status.</p>
diff --git a/clients/client-connect/src/ConnectClient.ts b/clients/client-connect/src/ConnectClient.ts
@@ -336,6 +336,7 @@ import {
   ListUserHierarchyGroupsCommandOutput,
 } from "./commands/ListUserHierarchyGroupsCommand";
 import { ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand";
+import { MonitorContactCommandInput, MonitorContactCommandOutput } from "./commands/MonitorContactCommand";
 import { PutUserStatusCommandInput, PutUserStatusCommandOutput } from "./commands/PutUserStatusCommand";
 import { ReleasePhoneNumberCommandInput, ReleasePhoneNumberCommandOutput } from "./commands/ReleasePhoneNumberCommand";
 import { ReplicateInstanceCommandInput, ReplicateInstanceCommandOutput } from "./commands/ReplicateInstanceCommand";
@@ -621,6 +622,7 @@ export type ServiceInputTypes =
   | ListUseCasesCommandInput
   | ListUserHierarchyGroupsCommandInput
   | ListUsersCommandInput
+  | MonitorContactCommandInput
   | PutUserStatusCommandInput
   | ReleasePhoneNumberCommandInput
   | ReplicateInstanceCommandInput
@@ -785,6 +787,7 @@ export type ServiceOutputTypes =
   | ListUseCasesCommandOutput
   | ListUserHierarchyGroupsCommandOutput
   | ListUsersCommandOutput
+  | MonitorContactCommandOutput
   | PutUserStatusCommandOutput
   | ReleasePhoneNumberCommandOutput
   | ReplicateInstanceCommandOutput
diff --git a/clients/client-connect/src/commands/DismissUserContactCommand.ts b/clients/client-connect/src/commands/DismissUserContactCommand.ts
@@ -31,8 +31,9 @@ export interface DismissUserContactCommandOutput extends DismissUserContactRespo
 /**
  * <p>Dismisses contacts from an agent’s CCP and returns the agent to an available state, which
  *    allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a
- *    <code>MISSED</code>, <code>ERROR</code>, <code>ENDED</code>, or <code>REJECTED</code> state in the
- *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">Agent Event Stream</a>.</p>
+ *     <code>MISSED</code>, <code>ERROR</code>, <code>ENDED</code>, or <code>REJECTED</code> state in
+ *    the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">Agent
+ *     Event Stream</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-connect/src/commands/ListLambdaFunctionsCommand.ts b/clients/client-connect/src/commands/ListLambdaFunctionsCommand.ts
@@ -14,8 +14,12 @@ import {
 } from "@aws-sdk/types";
 
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
-import { ListLambdaFunctionsRequest, ListLambdaFunctionsRequestFilterSensitiveLog } from "../models/models_0";
-import { ListLambdaFunctionsResponse, ListLambdaFunctionsResponseFilterSensitiveLog } from "../models/models_1";
+import {
+  ListLambdaFunctionsRequest,
+  ListLambdaFunctionsRequestFilterSensitiveLog,
+  ListLambdaFunctionsResponse,
+  ListLambdaFunctionsResponseFilterSensitiveLog,
+} from "../models/models_1";
 import {
   deserializeAws_restJson1ListLambdaFunctionsCommand,
   serializeAws_restJson1ListLambdaFunctionsCommand,
diff --git a/clients/client-connect/src/commands/MonitorContactCommand.ts b/clients/client-connect/src/commands/MonitorContactCommand.ts
@@ -0,0 +1,115 @@
+// smithy-typescript generated code
+import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
+import {
+  MonitorContactRequest,
+  MonitorContactRequestFilterSensitiveLog,
+  MonitorContactResponse,
+  MonitorContactResponseFilterSensitiveLog,
+} from "../models/models_1";
+import {
+  deserializeAws_restJson1MonitorContactCommand,
+  serializeAws_restJson1MonitorContactCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface MonitorContactCommandInput extends MonitorContactRequest {}
+export interface MonitorContactCommandOutput extends MonitorContactResponse, __MetadataBearer {}
+
+/**
+ * <p>Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by
+ *    <i>userId</i> will be set to silent monitoring mode on the contact.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectClient, MonitorContactCommand } from "@aws-sdk/client-connect"; // ES Modules import
+ * // const { ConnectClient, MonitorContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import
+ * const client = new ConnectClient(config);
+ * const command = new MonitorContactCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link MonitorContactCommandInput} for command's `input` shape.
+ * @see {@link MonitorContactCommandOutput} for command's `response` shape.
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
+ *
+ */
+export class MonitorContactCommand extends $Command<
+  MonitorContactCommandInput,
+  MonitorContactCommandOutput,
+  ConnectClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  public static getEndpointParameterInstructions(): EndpointParameterInstructions {
+    return {
+      UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
+      Endpoint: { type: "builtInParams", name: "endpoint" },
+      Region: { type: "builtInParams", name: "region" },
+      UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" },
+    };
+  }
+
+  constructor(readonly input: MonitorContactCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: ConnectClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<MonitorContactCommandInput, MonitorContactCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+    this.middlewareStack.use(
+      getEndpointPlugin(configuration, MonitorContactCommand.getEndpointParameterInstructions())
+    );
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "ConnectClient";
+    const commandName = "MonitorContactCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: MonitorContactRequestFilterSensitiveLog,
+      outputFilterSensitiveLog: MonitorContactResponseFilterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: MonitorContactCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_restJson1MonitorContactCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<MonitorContactCommandOutput> {
+    return deserializeAws_restJson1MonitorContactCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}
diff --git a/clients/client-connect/src/commands/index.ts b/clients/client-connect/src/commands/index.ts
@@ -105,6 +105,7 @@ export * from "./ListTrafficDistributionGroupsCommand";
 export * from "./ListUseCasesCommand";
 export * from "./ListUserHierarchyGroupsCommand";
 export * from "./ListUsersCommand";
+export * from "./MonitorContactCommand";
 export * from "./PutUserStatusCommand";
 export * from "./ReleasePhoneNumberCommand";
 export * from "./ReplicateInstanceCommand";
diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts
@@ -218,6 +218,11 @@ export interface AgentStatusSummary {
   Type?: AgentStatusType | string;
 }
 
+export enum MonitorCapability {
+  BARGE = "BARGE",
+  SILENT_MONITOR = "SILENT_MONITOR",
+}
+
 export interface AssociateApprovedOriginRequest {
   /**
    * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
@@ -824,6 +829,7 @@ export interface ClaimPhoneNumberRequest {
    *             request. If not provided, the Amazon Web Services
    *             SDK populates this field. For more information about idempotency, see
    *             <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
+   *
    *          <p>Pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>
    *          </p>
    */
@@ -4119,7 +4125,8 @@ export interface DismissUserContactRequest {
   UserId: string | undefined;
 
   /**
-   * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
+   * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
+   *    instance.</p>
    */
   InstanceId: string | undefined;
 
@@ -4226,10 +4233,20 @@ export interface GetCurrentMetricDataRequest {
   /**
    * <p>The grouping applied to the metrics returned. For example, when grouped by
    *     <code>QUEUE</code>, the metrics returned apply to each queue rather than aggregated for all
-   *    queues. If you group by <code>CHANNEL</code>, you should include a Channels filter.
-   *    VOICE, CHAT, and TASK channels are supported.</p>
-   *          <p>If no <code>Grouping</code> is included in the request, a summary of metrics is
-   *    returned.</p>
+   *    queues. </p>
+   *          <ul>
+   *             <li>
+   *                <p>If you group by <code>CHANNEL</code>, you should include a Channels filter.
+   *     VOICE, CHAT, and TASK channels are supported.</p>
+   *             </li>
+   *             <li>
+   *                <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing profile filter.</p>
+   *             </li>
+   *             <li>
+   *                <p>If no <code>Grouping</code> is included in the request, a summary of metrics is
+   *     returned.</p>
+   *             </li>
+   *          </ul>
    */
   Groupings?: (Grouping | string)[];
 
@@ -6002,24 +6019,6 @@ export interface ListIntegrationAssociationsResponse {
   NextToken?: string;
 }
 
-export interface ListLambdaFunctionsRequest {
-  /**
-   * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
-   */
-  InstanceId: string | undefined;
-
-  /**
-   * <p>The token for the next set of results. Use the value returned in the previous
-   * response in the next request to retrieve the next set of results.</p>
-   */
-  NextToken?: string;
-
-  /**
-   * <p>The maximum number of results to return per page.</p>
-   */
-  MaxResults?: number;
-}
-
 /**
  * @internal
  */
@@ -7764,10 +7763,3 @@ export const ListIntegrationAssociationsResponseFilterSensitiveLog = (
 ): any => ({
   ...obj,
 });
-
-/**
- * @internal
- */
-export const ListLambdaFunctionsRequestFilterSensitiveLog = (obj: ListLambdaFunctionsRequest): any => ({
-  ...obj,
-});
diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts
diff --git a/clients/client-connect/src/protocols/Aws_restJson1.ts b/clients/client-connect/src/protocols/Aws_restJson1.ts
