feat(client-connect): Authentication profiles are Amazon Connect reso…

…urces (in gated preview) that allow you to configure authentication settings for users in your contact center. This release adds support for new ListAuthenticationProfiles, DescribeAuthenticationProfile and UpdateAuthenticationProfile APIs.
aws · Jul 1, 2024 · 67d4def · 67d4def
1 parent 3927da6
commit 67d4def
Show file tree

Hide file tree

Showing 19 changed files with 1,710 additions and 269 deletions.
diff --git a/clients/client-connect/README.md b/clients/client-connect/README.md
@@ -6,6 +6,20 @@
 
 AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native.
 
+<ul>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html">Amazon Connect
+actions</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Service.html">Amazon Connect
+data types</a>
+</p>
+</li>
+</ul>
 <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
 manage a customer contact center and provide reliable customer engagement at any scale.</p>
 <p>Amazon Connect provides metrics and real-time reporting that enable you to optimize
@@ -780,6 +794,14 @@ DescribeAgentStatus
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/DescribeAgentStatusCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DescribeAgentStatusCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DescribeAgentStatusCommandOutput/)
 
+</details>
+<details>
+<summary>
+DescribeAuthenticationProfile
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/DescribeAuthenticationProfileCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DescribeAuthenticationProfileCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DescribeAuthenticationProfileCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -1196,6 +1218,14 @@ ListApprovedOrigins
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/ListApprovedOriginsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListApprovedOriginsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListApprovedOriginsCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListAuthenticationProfiles
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/ListAuthenticationProfilesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListAuthenticationProfilesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ListAuthenticationProfilesCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -1852,6 +1882,14 @@ UpdateAgentStatus
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/UpdateAgentStatusCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/UpdateAgentStatusCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/UpdateAgentStatusCommandOutput/)
 
+</details>
+<details>
+<summary>
+UpdateAuthenticationProfile
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/UpdateAuthenticationProfileCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/UpdateAuthenticationProfileCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/UpdateAuthenticationProfileCommandOutput/)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-connect/src/Connect.ts b/clients/client-connect/src/Connect.ts
@@ -325,6 +325,11 @@ import {
   DescribeAgentStatusCommandInput,
   DescribeAgentStatusCommandOutput,
 } from "./commands/DescribeAgentStatusCommand";
+import {
+  DescribeAuthenticationProfileCommand,
+  DescribeAuthenticationProfileCommandInput,
+  DescribeAuthenticationProfileCommandOutput,
+} from "./commands/DescribeAuthenticationProfileCommand";
 import {
   DescribeContactCommand,
   DescribeContactCommandInput,
@@ -585,6 +590,11 @@ import {
   ListApprovedOriginsCommandInput,
   ListApprovedOriginsCommandOutput,
 } from "./commands/ListApprovedOriginsCommand";
+import {
+  ListAuthenticationProfilesCommand,
+  ListAuthenticationProfilesCommandInput,
+  ListAuthenticationProfilesCommandOutput,
+} from "./commands/ListAuthenticationProfilesCommand";
 import { ListBotsCommand, ListBotsCommandInput, ListBotsCommandOutput } from "./commands/ListBotsCommand";
 import {
   ListContactEvaluationsCommand,
@@ -951,6 +961,11 @@ import {
   UpdateAgentStatusCommandInput,
   UpdateAgentStatusCommandOutput,
 } from "./commands/UpdateAgentStatusCommand";
+import {
+  UpdateAuthenticationProfileCommand,
+  UpdateAuthenticationProfileCommandInput,
+  UpdateAuthenticationProfileCommandOutput,
+} from "./commands/UpdateAuthenticationProfileCommand";
 import {
   UpdateContactAttributesCommand,
   UpdateContactAttributesCommandInput,
@@ -1246,6 +1261,7 @@ const commands = {
   DeleteViewVersionCommand,
   DeleteVocabularyCommand,
   DescribeAgentStatusCommand,
+  DescribeAuthenticationProfileCommand,
   DescribeContactCommand,
   DescribeContactEvaluationCommand,
   DescribeContactFlowCommand,
@@ -1298,6 +1314,7 @@ const commands = {
   ListAgentStatusesCommand,
   ListAnalyticsDataAssociationsCommand,
   ListApprovedOriginsCommand,
+  ListAuthenticationProfilesCommand,
   ListBotsCommand,
   ListContactEvaluationsCommand,
   ListContactFlowModulesCommand,
@@ -1380,6 +1397,7 @@ const commands = {
   UntagContactCommand,
   UntagResourceCommand,
   UpdateAgentStatusCommand,
+  UpdateAuthenticationProfileCommand,
   UpdateContactCommand,
   UpdateContactAttributesCommand,
   UpdateContactEvaluationCommand,
@@ -2539,6 +2557,23 @@ export interface Connect {
     cb: (err: any, data?: DescribeAgentStatusCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DescribeAuthenticationProfileCommand}
+   */
+  describeAuthenticationProfile(
+    args: DescribeAuthenticationProfileCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DescribeAuthenticationProfileCommandOutput>;
+  describeAuthenticationProfile(
+    args: DescribeAuthenticationProfileCommandInput,
+    cb: (err: any, data?: DescribeAuthenticationProfileCommandOutput) => void
+  ): void;
+  describeAuthenticationProfile(
+    args: DescribeAuthenticationProfileCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DescribeAuthenticationProfileCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DescribeContactCommand}
    */
@@ -3369,6 +3404,23 @@ export interface Connect {
     cb: (err: any, data?: ListApprovedOriginsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListAuthenticationProfilesCommand}
+   */
+  listAuthenticationProfiles(
+    args: ListAuthenticationProfilesCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListAuthenticationProfilesCommandOutput>;
+  listAuthenticationProfiles(
+    args: ListAuthenticationProfilesCommandInput,
+    cb: (err: any, data?: ListAuthenticationProfilesCommandOutput) => void
+  ): void;
+  listAuthenticationProfiles(
+    args: ListAuthenticationProfilesCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListAuthenticationProfilesCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListBotsCommand}
    */
@@ -4637,6 +4689,23 @@ export interface Connect {
     cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link UpdateAuthenticationProfileCommand}
+   */
+  updateAuthenticationProfile(
+    args: UpdateAuthenticationProfileCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdateAuthenticationProfileCommandOutput>;
+  updateAuthenticationProfile(
+    args: UpdateAuthenticationProfileCommandInput,
+    cb: (err: any, data?: UpdateAuthenticationProfileCommandOutput) => void
+  ): void;
+  updateAuthenticationProfile(
+    args: UpdateAuthenticationProfileCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateAuthenticationProfileCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link UpdateContactCommand}
    */
@@ -5383,7 +5452,21 @@ export interface Connect {
 }
 
 /**
- * <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
+ * <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html">Amazon Connect
+ *        actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Service.html">Amazon Connect
+ *        data types</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
  *    manage a customer contact center and provide reliable customer engagement at any scale.</p>
  *          <p>Amazon Connect provides metrics and real-time reporting that enable you to optimize
  *    contact routing. You can also resolve customer issues more efficiently by getting customers in

diff --git a/clients/client-connect/src/ConnectClient.ts b/clients/client-connect/src/ConnectClient.ts
@@ -241,6 +241,10 @@ import {
   DescribeAgentStatusCommandInput,
   DescribeAgentStatusCommandOutput,
 } from "./commands/DescribeAgentStatusCommand";
+import {
+  DescribeAuthenticationProfileCommandInput,
+  DescribeAuthenticationProfileCommandOutput,
+} from "./commands/DescribeAuthenticationProfileCommand";
 import { DescribeContactCommandInput, DescribeContactCommandOutput } from "./commands/DescribeContactCommand";
 import {
   DescribeContactEvaluationCommandInput,
@@ -383,6 +387,10 @@ import {
   ListApprovedOriginsCommandInput,
   ListApprovedOriginsCommandOutput,
 } from "./commands/ListApprovedOriginsCommand";
+import {
+  ListAuthenticationProfilesCommandInput,
+  ListAuthenticationProfilesCommandOutput,
+} from "./commands/ListAuthenticationProfilesCommand";
 import { ListBotsCommandInput, ListBotsCommandOutput } from "./commands/ListBotsCommand";
 import {
   ListContactEvaluationsCommandInput,
@@ -594,6 +602,10 @@ import { TransferContactCommandInput, TransferContactCommandOutput } from "./com
 import { UntagContactCommandInput, UntagContactCommandOutput } from "./commands/UntagContactCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { UpdateAgentStatusCommandInput, UpdateAgentStatusCommandOutput } from "./commands/UpdateAgentStatusCommand";
+import {
+  UpdateAuthenticationProfileCommandInput,
+  UpdateAuthenticationProfileCommandOutput,
+} from "./commands/UpdateAuthenticationProfileCommand";
 import {
   UpdateContactAttributesCommandInput,
   UpdateContactAttributesCommandOutput,
@@ -833,6 +845,7 @@ export type ServiceInputTypes =
   | DeleteViewVersionCommandInput
   | DeleteVocabularyCommandInput
   | DescribeAgentStatusCommandInput
+  | DescribeAuthenticationProfileCommandInput
   | DescribeContactCommandInput
   | DescribeContactEvaluationCommandInput
   | DescribeContactFlowCommandInput
@@ -885,6 +898,7 @@ export type ServiceInputTypes =
   | ListAgentStatusesCommandInput
   | ListAnalyticsDataAssociationsCommandInput
   | ListApprovedOriginsCommandInput
+  | ListAuthenticationProfilesCommandInput
   | ListBotsCommandInput
   | ListContactEvaluationsCommandInput
   | ListContactFlowModulesCommandInput
@@ -967,6 +981,7 @@ export type ServiceInputTypes =
   | UntagContactCommandInput
   | UntagResourceCommandInput
   | UpdateAgentStatusCommandInput
+  | UpdateAuthenticationProfileCommandInput
   | UpdateContactAttributesCommandInput
   | UpdateContactCommandInput
   | UpdateContactEvaluationCommandInput
@@ -1088,6 +1103,7 @@ export type ServiceOutputTypes =
   | DeleteViewVersionCommandOutput
   | DeleteVocabularyCommandOutput
   | DescribeAgentStatusCommandOutput
+  | DescribeAuthenticationProfileCommandOutput
   | DescribeContactCommandOutput
   | DescribeContactEvaluationCommandOutput
   | DescribeContactFlowCommandOutput
@@ -1140,6 +1156,7 @@ export type ServiceOutputTypes =
   | ListAgentStatusesCommandOutput
   | ListAnalyticsDataAssociationsCommandOutput
   | ListApprovedOriginsCommandOutput
+  | ListAuthenticationProfilesCommandOutput
   | ListBotsCommandOutput
   | ListContactEvaluationsCommandOutput
   | ListContactFlowModulesCommandOutput
@@ -1222,6 +1239,7 @@ export type ServiceOutputTypes =
   | UntagContactCommandOutput
   | UntagResourceCommandOutput
   | UpdateAgentStatusCommandOutput
+  | UpdateAuthenticationProfileCommandOutput
   | UpdateContactAttributesCommandOutput
   | UpdateContactCommandOutput
   | UpdateContactEvaluationCommandOutput
@@ -1440,7 +1458,21 @@ export type ConnectClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
 export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfigType {}
 
 /**
- * <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
+ * <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html">Amazon Connect
+ *        actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Service.html">Amazon Connect
+ *        data types</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>Amazon Connect is a cloud-based contact center solution that you use to set up and
  *    manage a customer contact center and provide reliable customer engagement at any scale.</p>
  *          <p>Amazon Connect provides metrics and real-time reporting that enable you to optimize
  *    contact routing. You can also resolve customer issues more efficiently by getting customers in