Amazon Connect Service Update: This release supports adding RoutingCriteria via UpdateContactRoutingData public API.

Author: AWS

.changes/next-release/feature-AmazonConnectService-5bcfc1b.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon Connect Service",
+    "contributor": "",
+    "description": "This release supports adding RoutingCriteria via UpdateContactRoutingData public API."
+}

services/connect/src/main/resources/codegen-resources/service-2.json

@@ -514,7 +514,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <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>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>"
+      "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <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>"
     },
     "CreateIntegrationAssociation":{
       "name":"CreateIntegrationAssociation",
@@ -584,7 +584,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Creates a new predefined attribute for the specified Amazon Connect instance.</p>"
+      "documentation":"<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>"
     },
     "CreatePrompt":{
       "name":"CreatePrompt",
@@ -697,7 +697,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Creates a security profile.</p>"
+      "documentation":"<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>"
     },
     "CreateTaskTemplate":{
       "name":"CreateTaskTemplate",
@@ -986,7 +986,7 @@
         {"shape":"InternalServiceException"},
         {"shape":"InvalidRequestException"}
       ],
-      "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Deletes the Amazon Connect instance.</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>"
+      "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</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>"
     },
     "DeleteIntegrationAssociation":{
       "name":"DeleteIntegrationAssociation",
@@ -1052,7 +1052,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Deletes a queue.</p>"
+      "documentation":"<p>Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.</p>"
     },
     "DeleteQuickConnect":{
       "name":"DeleteQuickConnect",
@@ -1476,7 +1476,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Describes a predefined attribute for the specified Amazon Connect instance.</p>"
+      "documentation":"<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>"
     },
     "DescribePrompt":{
       "name":"DescribePrompt",
@@ -1578,7 +1578,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Gets basic information about the security profle.</p>"
+      "documentation":"<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>"
     },
     "DescribeTrafficDistributionGroup":{
       "name":"DescribeTrafficDistributionGroup",
@@ -2500,7 +2500,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Lists predefined attributes for the specified Amazon Connect instance.</p>"
+      "documentation":"<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>"
     },
     "ListPrompts":{
       "name":"ListPrompts",
@@ -2688,7 +2688,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Lists the permissions granted to a security profile.</p>"
+      "documentation":"<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>"
     },
     "ListSecurityProfiles":{
       "name":"ListSecurityProfiles",
@@ -2705,7 +2705,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<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>. 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>"
     },
     "ListTagsForResource":{
       "name":"ListTagsForResource",
@@ -3122,7 +3122,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Predefined attributes that meet certain criteria.</p>"
+      "documentation":"<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>"
     },
     "SearchPrompts":{
       "name":"SearchPrompts",
@@ -3225,7 +3225,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Searches security profiles in an Amazon Connect instance, with optional filtering.</p>"
+      "documentation":"<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>"
     },
     "SearchUserHierarchyGroups":{
       "name":"SearchUserHierarchyGroups",
@@ -3951,7 +3951,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Updates a predefined attribute for the specified Amazon Connect instance.</p>"
+      "documentation":"<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>"
     },
     "UpdatePrompt":{
       "name":"UpdatePrompt",
@@ -4195,7 +4195,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "documentation":"<p>Updates a security profile.</p>"
+      "documentation":"<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>"
     },
     "UpdateTaskTemplate":{
       "name":"UpdateTaskTemplate",
@@ -4842,10 +4842,10 @@
       "members":{
         "AgentIds":{
           "shape":"AgentIds",
-          "documentation":"<p>An object to specify a list of agents, by Agent ID.</p>"
+          "documentation":"<p>An object to specify a list of agents, by user ID.</p>"
         }
       },
-      "documentation":"<p>Can be used to define a list of preferred agents to target the contact within the queue. Note that agents must have the queue in their routing profile in order to be offered the contact.</p>"
+      "documentation":"<p>Can be used to define a list of preferred agents to target the contact to within the queue.&#x2028; Note that agents must have the queue in their routing profile in order to be offered the&#x2028; contact.</p>"
     },
     "AgentsMinOneMaxHundred":{
       "type":"list",
@@ -15303,10 +15303,10 @@
       "members":{
         "AgentsCriteria":{
           "shape":"AgentsCriteria",
-          "documentation":"<p>An object to define <code>AgentIds</code>.</p>"
+          "documentation":"<p>An object to define agentIds.</p>"
         }
       },
-      "documentation":"<p>An object to define <code>AgentsCriteria</code>.</p>"
+      "documentation":"<p>An object to define AgentsCriteria.</p>"
     },
     "MaxResult10":{
       "type":"integer",
@@ -17933,6 +17933,44 @@
       },
       "documentation":"<p>Latest routing criteria on the contact.</p>"
     },
+    "RoutingCriteriaInput":{
+      "type":"structure",
+      "members":{
+        "Steps":{
+          "shape":"RoutingCriteriaInputSteps",
+          "documentation":"<p>When Amazon Connect does not find an available agent meeting the requirements in a step for&#x2028; a given step duration, the routing criteria will move on to the next step sequentially until a&#x2028; join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.</p>"
+        }
+      },
+      "documentation":"<p>An object to define the RoutingCriteria.</p>"
+    },
+    "RoutingCriteriaInputStep":{
+      "type":"structure",
+      "members":{
+        "Expiry":{
+          "shape":"RoutingCriteriaInputStepExpiry",
+          "documentation":"<p>An object to specify the expiration of a routing step.</p>"
+        },
+        "Expression":{
+          "shape":"Expression",
+          "documentation":"<p>A tagged union to specify expression for a routing step.</p>"
+        }
+      },
+      "documentation":"<p>Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, Name, or Value.</p>"
+    },
+    "RoutingCriteriaInputStepExpiry":{
+      "type":"structure",
+      "members":{
+        "DurationInSeconds":{
+          "shape":"DurationInSeconds",
+          "documentation":"<p>The number of seconds that the contact will be routed only to agents matching this routing&#x2028; step, if expiry was configured for this routing step.</p>"
+        }
+      },
+      "documentation":"<p>Specify whether this routing criteria step should apply for only a limited amount of time,&#x2028; or if it should never expire.</p>"
+    },
+    "RoutingCriteriaInputSteps":{
+      "type":"list",
+      "member":{"shape":"RoutingCriteriaInputStep"}
+    },
     "RoutingCriteriaStepStatus":{
       "type":"string",
       "enum":[
@@ -21643,6 +21681,10 @@
         "QueuePriority":{
           "shape":"QueuePriority",
           "documentation":"<p>Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.</p>"
+        },
+        "RoutingCriteria":{
+          "shape":"RoutingCriteriaInput",
+          "documentation":"<p>Updates the routing criteria on the contact. These properties can be used to change how a&#x2028; contact is routed within the queue.</p>"
         }
       }
     },