feat(client-connect): This release adds support for updating phone nu…

…mber metadata, such as phone number description.
aws · Oct 20, 2023 · 963f743 · 963f743
1 parent c7bb839
commit 963f743
Show file tree

Hide file tree

Showing 19 changed files with 672 additions and 144 deletions.
diff --git a/clients/client-connect/README.md b/clients/client-connect/README.md
@@ -12,9 +12,9 @@ manage a customer contact center and provide reliable customer engagement at any
 contact routing. You can also resolve customer issues more efficiently by getting customers in
 touch with the appropriate agents.</p>
 <p>There are limits to the number of Amazon Connect resources that you can create. There
-are also limits to the number of requests that you can make per second. For more information, see
-<a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
-Guide</i>.</p>
+are also limits to the number of requests that you can make per second. For more information,
+seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
+Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
 <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
 a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
 
@@ -1684,6 +1684,14 @@ UpdatePhoneNumber
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/classes/updatephonenumbercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/interfaces/updatephonenumbercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/interfaces/updatephonenumbercommandoutput.html)
 
+</details>
+<details>
+<summary>
+UpdatePhoneNumberMetadata
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/classes/updatephonenumbermetadatacommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/interfaces/updatephonenumbermetadatacommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/interfaces/updatephonenumbermetadatacommandoutput.html)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-connect/src/Connect.ts b/clients/client-connect/src/Connect.ts
@@ -850,6 +850,11 @@ import {
   UpdatePhoneNumberCommandInput,
   UpdatePhoneNumberCommandOutput,
 } from "./commands/UpdatePhoneNumberCommand";
+import {
+  UpdatePhoneNumberMetadataCommand,
+  UpdatePhoneNumberMetadataCommandInput,
+  UpdatePhoneNumberMetadataCommandOutput,
+} from "./commands/UpdatePhoneNumberMetadataCommand";
 import {
   UpdatePromptCommand,
   UpdatePromptCommandInput,
@@ -1163,6 +1168,7 @@ const commands = {
   UpdateInstanceStorageConfigCommand,
   UpdateParticipantRoleConfigCommand,
   UpdatePhoneNumberCommand,
+  UpdatePhoneNumberMetadataCommand,
   UpdatePromptCommand,
   UpdateQueueHoursOfOperationCommand,
   UpdateQueueMaxContactsCommand,
@@ -4074,6 +4080,23 @@ export interface Connect {
     cb: (err: any, data?: UpdatePhoneNumberCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link UpdatePhoneNumberMetadataCommand}
+   */
+  updatePhoneNumberMetadata(
+    args: UpdatePhoneNumberMetadataCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdatePhoneNumberMetadataCommandOutput>;
+  updatePhoneNumberMetadata(
+    args: UpdatePhoneNumberMetadataCommandInput,
+    cb: (err: any, data?: UpdatePhoneNumberMetadataCommandOutput) => void
+  ): void;
+  updatePhoneNumberMetadata(
+    args: UpdatePhoneNumberMetadataCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdatePhoneNumberMetadataCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link UpdatePromptCommand}
    */
@@ -4510,9 +4533,9 @@ export interface Connect {
  *    contact routing. You can also resolve customer issues more efficiently by getting customers in
  *    touch with the appropriate agents.</p>
  *          <p>There are limits to the number of Amazon Connect resources that you can create. There
- *    are also limits to the number of requests that you can make per second. For more information, see
- *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
- *     Guide</i>.</p>
+ *    are also limits to the number of requests that you can make per second. For more information,
+ *    seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
+ *     Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
  *          <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
  *    a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
  */

diff --git a/clients/client-connect/src/ConnectClient.ts b/clients/client-connect/src/ConnectClient.ts
@@ -543,6 +543,10 @@ import {
   UpdateParticipantRoleConfigCommandOutput,
 } from "./commands/UpdateParticipantRoleConfigCommand";
 import { UpdatePhoneNumberCommandInput, UpdatePhoneNumberCommandOutput } from "./commands/UpdatePhoneNumberCommand";
+import {
+  UpdatePhoneNumberMetadataCommandInput,
+  UpdatePhoneNumberMetadataCommandOutput,
+} from "./commands/UpdatePhoneNumberMetadataCommand";
 import { UpdatePromptCommandInput, UpdatePromptCommandOutput } from "./commands/UpdatePromptCommand";
 import {
   UpdateQueueHoursOfOperationCommandInput,
@@ -825,6 +829,7 @@ export type ServiceInputTypes =
   | UpdateInstanceStorageConfigCommandInput
   | UpdateParticipantRoleConfigCommandInput
   | UpdatePhoneNumberCommandInput
+  | UpdatePhoneNumberMetadataCommandInput
   | UpdatePromptCommandInput
   | UpdateQueueHoursOfOperationCommandInput
   | UpdateQueueMaxContactsCommandInput
@@ -1040,6 +1045,7 @@ export type ServiceOutputTypes =
   | UpdateInstanceStorageConfigCommandOutput
   | UpdateParticipantRoleConfigCommandOutput
   | UpdatePhoneNumberCommandOutput
+  | UpdatePhoneNumberMetadataCommandOutput
   | UpdatePromptCommandOutput
   | UpdateQueueHoursOfOperationCommandOutput
   | UpdateQueueMaxContactsCommandOutput
@@ -1245,9 +1251,9 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig
  *    contact routing. You can also resolve customer issues more efficiently by getting customers in
  *    touch with the appropriate agents.</p>
  *          <p>There are limits to the number of Amazon Connect resources that you can create. There
- *    are also limits to the number of requests that you can make per second. For more information, see
- *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
- *     Guide</i>.</p>
+ *    are also limits to the number of requests that you can make per second. For more information,
+ *    seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
+ *     Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
  *          <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
  *    a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
  */

diff --git a/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts b/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts
@@ -44,7 +44,7 @@ export interface CreateTrafficDistributionGroupCommandOutput
  * @public
  * <p>Creates a traffic distribution group given an Amazon Connect instance that has been replicated. </p>
  *          <note>
- *             <p>You can change the <code>SignInConfig</code> distribution only for a
+ *             <p>The <code>SignInConfig</code> distribution is available only on a
  * default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the
  * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html">TrafficDistributionGroup</a>
  *  data type). If you call

diff --git a/clients/client-connect/src/commands/CreateUserCommand.ts b/clients/client-connect/src/commands/CreateUserCommand.ts
@@ -38,6 +38,12 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
 /**
  * @public
  * <p>Creates a user account for the specified Amazon Connect instance.</p>
+ *          <important>
+ *             <p>Certain <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html">UserIdentityInfo</a> parameters
+ *     are required in some situations. For example, <code>Email</code> is required if you are using
+ *     SAML for identity management. <code>FirstName</code> and <code>LastName</code> are required if
+ *     you are using Amazon Connect or SAML for identity management.</p>
+ *          </important>
  *          <p>For information about how to create user accounts using the Amazon Connect console, see
  *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html">Add
  *     Users</a> in the <i>Amazon Connect Administrator Guide</i>.</p>

diff --git a/clients/client-connect/src/commands/GetFederationTokenCommand.ts b/clients/client-connect/src/commands/GetFederationTokenCommand.ts
@@ -41,7 +41,13 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo
 
 /**
  * @public
- * <p>Retrieves a token for federation.</p>
+ * <p>Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is
+ *    for the Amazon Connect user which corresponds to the IAM credentials that were
+ *    used to invoke this action. </p>
+ *          <p>For more information about how SAML sign-in works in Amazon Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html ">Configure SAML with
+ *      IAM for Amazon Connect in the <i>Amazon Connect Administrator
+ *      Guide</i>.</a>
+ *          </p>
  *          <note>
  *             <p>This API doesn't support root users. If you try to invoke GetFederationToken with root
  *     credentials, an error message similar to the following one appears: </p>

diff --git a/clients/client-connect/src/commands/GetMetricDataCommand.ts b/clients/client-connect/src/commands/GetMetricDataCommand.ts
@@ -40,6 +40,15 @@ export interface GetMetricDataCommandOutput extends GetMetricDataResponse, __Met
  * <p>Gets historical metric data from the specified Amazon Connect instance.</p>
  *          <p>For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics
  *     Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
+ *          <note>
+ *             <p>We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API. It
+ *     provides more flexibility, features, and the ability to query longer time ranges than
+ *      <code>GetMetricData</code>. Use it to retrieve historical agent and contact metrics for the
+ *     last 3 months, at varying intervals. You can also use it to build custom dashboards to measure
+ *     historical queue and agent performance. For example, you can track the number of incoming
+ *     contacts for the last 7 days, with data split by day, to see how contact volume changed per day
+ *     of the week.</p>
+ *          </note>
  * @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/SearchUsersCommand.ts b/clients/client-connect/src/commands/SearchUsersCommand.ts
@@ -38,7 +38,7 @@ export interface SearchUsersCommandOutput extends SearchUsersResponse, __Metadat
 
 /**
  * @public
- * <p>Searches users in an Amazon Connect instance, with optional filtering.</p>
+ * <p>Searches users in an Amazon Connect instance, with optional filtering. </p>
  *          <note>
  *             <p>
  *                <code>AfterContactWorkTimeLimit</code> is returned in milliseconds. </p>

diff --git a/clients/client-connect/src/commands/StartTaskContactCommand.ts b/clients/client-connect/src/commands/StartTaskContactCommand.ts
@@ -37,7 +37,57 @@ export interface StartTaskContactCommandOutput extends StartTaskContactResponse,
 
 /**
  * @public
- * <p>Initiates a flow to start a new task.</p>
+ * <p>Initiates a flow to start a new task contact. For more information about task contacts, see
+ *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html">Concepts: Tasks in
+ *      Amazon Connect</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
+ *          <p>When using <code>PreviousContactId</code> and <code>RelatedContactId</code> input
+ *    parameters, note the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>PreviousContactId</code>
+ *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Any updates to user-defined task contact attributes on any contact linked through the
+ *        same <code>PreviousContactId</code> will affect every contact in the chain.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts
+ *        can be created that share the same <code>PreviousContactId</code>.</p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>RelatedContactId</code>
+ *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>Copies contact attributes from the related task contact to the new contact.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Any update on attributes in a new task contact does not update attributes on previous
+ *        contact.</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>There’s no limit on the number of task contacts that can be created that use the same
+ *         <code>RelatedContactId</code>.</p>
+ *                   </li>
+ *                </ul>
+ *             </li>
+ *          </ul>
+ *          <p>In addition, when calling StartTaskContact include only one of these parameters:
+ *     <code>ContactFlowID</code>, <code>QuickConnectID</code>, or <code>TaskTemplateID</code>. Only
+ *    one parameter is required as long as the task template has a flow configured to run it. If more
+ *    than one parameter is specified, or only the <code>TaskTemplateID</code> is specified but it does
+ *    not have a flow configured, the request returns an error because Amazon Connect cannot
+ *    identify the unique flow to run when the task is created.</p>
+ *          <p>A <code>ServiceQuotaExceededException</code> occurs when the number of open tasks exceeds
+ *    the active tasks quota or there are already 12 tasks referencing the same
+ *     <code>PreviousContactId</code>. For more information about service quotas for task contacts, see
+ *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect service quotas</a> in the <i>Amazon Connect Administrator
+ *     Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript