feat(client-connect): This release supports adding RoutingCriteria vi…

…a UpdateContactRoutingData public API.
aws · Aug 9, 2024 · 1c86676 · 1c86676
1 parent 61505ca
commit 1c86676
Show file tree

Hide file tree

Showing 20 changed files with 351 additions and 70 deletions.
diff --git a/clients/client-connect/src/commands/CreateInstanceCommand.ts b/clients/client-connect/src/commands/CreateInstanceCommand.ts
@@ -36,6 +36,8 @@ export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __M
  *          <p>Initiates an Amazon Connect instance with all the supported channels enabled. It does
  *    not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It
  *    also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. </p>
+ *          <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html">Create an Amazon Connect
+ *     instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
  *          <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days.
  * If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances.
  * You must wait 30 days before you can restart creating and deleting instances in your account.</p>

diff --git a/clients/client-connect/src/commands/CreatePredefinedAttributeCommand.ts b/clients/client-connect/src/commands/CreatePredefinedAttributeCommand.ts
@@ -28,7 +28,10 @@ export interface CreatePredefinedAttributeCommandInput extends CreatePredefinedA
 export interface CreatePredefinedAttributeCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Creates a new predefined attribute for the specified Amazon Connect instance.</p>
+ * <p>Creates a new predefined attribute for the specified Amazon Connect instance. <i>Predefined
+ *     attributes</i> are attributes in an Amazon Connect instance that can be used to route
+ *    contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
+ *     predefined attributes for routing contacts to agents</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/CreateSecurityProfileCommand.ts b/clients/client-connect/src/commands/CreateSecurityProfileCommand.ts
@@ -29,6 +29,10 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil
 
 /**
  * <p>Creates a security profile.</p>
+ *          <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
+ *      <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
+ *    user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
+ *     permissions</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/DeleteInstanceCommand.ts b/clients/client-connect/src/commands/DeleteInstanceCommand.ts
@@ -29,7 +29,9 @@ export interface DeleteInstanceCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>This API is in preview release for Amazon Connect and is subject to change.</p>
- *          <p>Deletes the Amazon Connect instance.</p>
+ *          <p>Deletes the Amazon Connect instance. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.html">Delete your
+ *      Amazon Connect instance</a> in the <i>Amazon Connect Administrator
+ *     Guide</i>.</p>
  *          <p>Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days.
  * If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances.
  * You must wait 30 days before you can restart creating and deleting instances in your account.</p>

diff --git a/clients/client-connect/src/commands/DeleteQueueCommand.ts b/clients/client-connect/src/commands/DeleteQueueCommand.ts
@@ -28,7 +28,7 @@ export interface DeleteQueueCommandInput extends DeleteQueueRequest {}
 export interface DeleteQueueCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a queue.</p>
+ * <p>Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.</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/DescribePredefinedAttributeCommand.ts b/clients/client-connect/src/commands/DescribePredefinedAttributeCommand.ts
@@ -33,7 +33,10 @@ export interface DescribePredefinedAttributeCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Describes a predefined attribute for the specified Amazon Connect instance.</p>
+ * <p>Describes a predefined attribute for the specified Amazon Connect instance. <i>Predefined
+ *     attributes</i> are attributes in an Amazon Connect instance that can be used to route
+ *    contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
+ *     predefined attributes for routing contacts to agents</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/DescribeSecurityProfileCommand.ts b/clients/client-connect/src/commands/DescribeSecurityProfileCommand.ts
@@ -28,7 +28,11 @@ export interface DescribeSecurityProfileCommandInput extends DescribeSecurityPro
 export interface DescribeSecurityProfileCommandOutput extends DescribeSecurityProfileResponse, __MetadataBearer {}
 
 /**
- * <p>Gets basic information about the security profle.</p>
+ * <p>Gets basic information about the security profile.</p>
+ *          <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
+ *      <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
+ *    user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
+ *     permissions</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/ListPredefinedAttributesCommand.ts b/clients/client-connect/src/commands/ListPredefinedAttributesCommand.ts
@@ -28,7 +28,10 @@ export interface ListPredefinedAttributesCommandInput extends ListPredefinedAttr
 export interface ListPredefinedAttributesCommandOutput extends ListPredefinedAttributesResponse, __MetadataBearer {}
 
 /**
- * <p>Lists predefined attributes for the specified Amazon Connect instance.</p>
+ * <p>Lists predefined attributes for the specified Amazon Connect instance. <i>Predefined
+ *     attributes</i> are attributes in an Amazon Connect instance that can be used to route
+ *    contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
+ *     predefined attributes for routing contacts to agents</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/ListSecurityProfilePermissionsCommand.ts b/clients/client-connect/src/commands/ListSecurityProfilePermissionsCommand.ts
@@ -34,6 +34,10 @@ export interface ListSecurityProfilePermissionsCommandOutput
 
 /**
  * <p>Lists the permissions granted to a security profile.</p>
+ *          <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
+ *      <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
+ *    user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
+ *     permissions</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/ListSecurityProfilesCommand.ts b/clients/client-connect/src/commands/ListSecurityProfilesCommand.ts
@@ -30,7 +30,9 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR
 /**
  * <p>Provides summary information about the security profiles for the specified Amazon Connect instance.</p>
  *          <p>For more information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
- *      <i>Amazon Connect Administrator Guide</i>.</p>
+ *      <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
+ *    user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
+ *     permissions</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/SearchPredefinedAttributesCommand.ts b/clients/client-connect/src/commands/SearchPredefinedAttributesCommand.ts
@@ -28,7 +28,10 @@ export interface SearchPredefinedAttributesCommandInput extends SearchPredefined
 export interface SearchPredefinedAttributesCommandOutput extends SearchPredefinedAttributesResponse, __MetadataBearer {}
 
 /**
- * <p>Predefined attributes that meet certain criteria.</p>
+ * <p>Searches predefined attributes that meet certain criteria. <i>Predefined
+ *     attributes</i> are attributes in an Amazon Connect instance that can be used to route
+ *    contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
+ *     predefined attributes for routing contacts to agents</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/SearchSecurityProfilesCommand.ts b/clients/client-connect/src/commands/SearchSecurityProfilesCommand.ts
@@ -30,6 +30,10 @@ export interface SearchSecurityProfilesCommandOutput extends SearchSecurityProfi
 /**
  * <p>Searches security profiles in an Amazon Connect instance, with optional
  *    filtering.</p>
+ *          <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
+ *      <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
+ *    user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
+ *     permissions</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/UpdateContactRoutingDataCommand.ts b/clients/client-connect/src/commands/UpdateContactRoutingDataCommand.ts
@@ -52,6 +52,56 @@ export interface UpdateContactRoutingDataCommandOutput extends UpdateContactRout
  *   ContactId: "STRING_VALUE", // required
  *   QueueTimeAdjustmentSeconds: Number("int"),
  *   QueuePriority: Number("long"),
+ *   RoutingCriteria: { // RoutingCriteriaInput
+ *     Steps: [ // RoutingCriteriaInputSteps
+ *       { // RoutingCriteriaInputStep
+ *         Expiry: { // RoutingCriteriaInputStepExpiry
+ *           DurationInSeconds: Number("int"),
+ *         },
+ *         Expression: { // Expression
+ *           AttributeCondition: { // AttributeCondition
+ *             Name: "STRING_VALUE",
+ *             Value: "STRING_VALUE",
+ *             ProficiencyLevel: Number("float"),
+ *             MatchCriteria: { // MatchCriteria
+ *               AgentsCriteria: { // AgentsCriteria
+ *                 AgentIds: [ // AgentIds
+ *                   "STRING_VALUE",
+ *                 ],
+ *               },
+ *             },
+ *             ComparisonOperator: "STRING_VALUE",
+ *           },
+ *           AndExpression: [ // Expressions
+ *             {
+ *               AttributeCondition: {
+ *                 Name: "STRING_VALUE",
+ *                 Value: "STRING_VALUE",
+ *                 ProficiencyLevel: Number("float"),
+ *                 MatchCriteria: {
+ *                   AgentsCriteria: {
+ *                     AgentIds: [
+ *                       "STRING_VALUE",
+ *                     ],
+ *                   },
+ *                 },
+ *                 ComparisonOperator: "STRING_VALUE",
+ *               },
+ *               AndExpression: [
+ *                 "<Expression>",
+ *               ],
+ *               OrExpression: [
+ *                 "<Expression>",
+ *               ],
+ *             },
+ *           ],
+ *           OrExpression: [
+ *             "<Expression>",
+ *           ],
+ *         },
+ *       },
+ *     ],
+ *   },
  * };
  * const command = new UpdateContactRoutingDataCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-connect/src/commands/UpdatePredefinedAttributeCommand.ts b/clients/client-connect/src/commands/UpdatePredefinedAttributeCommand.ts
@@ -28,7 +28,10 @@ export interface UpdatePredefinedAttributeCommandInput extends UpdatePredefinedA
 export interface UpdatePredefinedAttributeCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Updates a predefined attribute for the specified Amazon Connect instance.</p>
+ * <p>Updates a predefined attribute for the specified Amazon Connect instance. <i>Predefined
+ *     attributes</i> are attributes in an Amazon Connect instance that can be used to route
+ *    contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
+ *     predefined attributes for routing contacts to agents</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/UpdateSecurityProfileCommand.ts b/clients/client-connect/src/commands/UpdateSecurityProfileCommand.ts
@@ -29,6 +29,10 @@ export interface UpdateSecurityProfileCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>Updates a security profile.</p>
+ *          <p>For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the
+ *      <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and
+ *    user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile
+ *     permissions</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/models/models_0.ts b/clients/client-connect/src/models/models_0.ts
@@ -615,14 +615,14 @@ export interface AgentQualityMetrics {
 }
 
 /**
- * <p>Can be used to define a list of preferred agents to target the contact within the queue.
+ * <p>Can be used to define a list of preferred agents to target the contact to within the queue.
  *    Note that agents must have the queue in their routing profile in order to be offered the
  *    contact.</p>
  * @public
  */
 export interface AgentsCriteria {
   /**
-   * <p>An object to specify a list of agents, by Agent ID.</p>
+   * <p>An object to specify a list of agents, by user ID.</p>
    * @public
    */
   AgentIds?: string[];
@@ -7056,12 +7056,12 @@ export interface Expiry {
 }
 
 /**
- * <p>An object to define <code>AgentsCriteria</code>.</p>
+ * <p>An object to define AgentsCriteria.</p>
  * @public
  */
 export interface MatchCriteria {
   /**
-   * <p>An object to define <code>AgentIds</code>.</p>
+   * <p>An object to define agentIds.</p>
    * @public
    */
   AgentsCriteria?: AgentsCriteria;

diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts
@@ -8869,31 +8869,27 @@ export interface RealTimeContactAnalysisSegmentPostContactSummary {
   Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined;
 
   /**
-   * <p>If the summary failed to be generated, one of the following failure codes
-   *    occurs:</p>
+   * <p>If the summary failed to be generated, one of the following failure codes occurs:</p>
    *          <ul>
    *             <li>
    *                <p>
-   *                   <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached
-   *      your service quota.</p>
+   *                   <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service
+   *      quota.</p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have
-   *      at least one turn from both the participants in order to generate the
-   *      summary.</p>
+   *                   <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have at least
+   *      one turn from both the participants in order to generate the summary.</p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be
-   *      provided because it failed to meet system safety guidelines.</p>
+   *                   <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be provided because it
+   *      failed to meet system safety guidelines.</p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for
-   *      example, you're using a
-   *      <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a>
-   *      that isn't supported by generative AI-powered post-contact summaries.
+   *                   <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for example, you're
+   *      using a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a> that isn't supported by generative AI-powered post-contact summaries.
    *     </p>
    *             </li>
    *             <li>