Amazon Connect Service Update: SDK release for user defined predefined attributes.

Author: AWS

.changes/next-release/feature-AmazonConnectService-4e65e56.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon Connect Service",
+    "contributor": "",
+    "description": "SDK release for user defined predefined attributes."
+}

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

@@ -666,7 +666,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "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>"
+      "documentation":"<p>Creates a new predefined attribute for the specified Amazon Connect instance. A <i>predefined attribute</i> is made up of a name and a value.</p> <p>For the predefined attributes per instance quota, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas\">Amazon Connect quotas</a>.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). 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> </li> <li> <p>Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html\">Use contact segment attributes</a>.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
     },
     "CreatePrompt":{
       "name":"CreatePrompt",
@@ -1681,7 +1681,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "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>"
+      "documentation":"<p>Describes a predefined attribute for the specified Amazon Connect instance. A <i>predefined attribute</i> is made up of a name and a value. You can use predefined attributes for:</p> <ul> <li> <p>Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). 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> </li> <li> <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html\">Use contact segment attributes</a>.</p> </li> </ul> <p>For the predefined attributes per instance quota, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas\">Amazon Connect quotas</a>.</p> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
     },
     "DescribePrompt":{
       "name":"DescribePrompt",
@@ -2809,7 +2809,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "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>"
+      "documentation":"<p>Lists predefined attributes for the specified Amazon Connect instance. A <i>predefined attribute</i> is made up of a name and a value. You can use predefined attributes for:</p> <ul> <li> <p>Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). 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> </li> <li> <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html\">Use contact segment attributes</a>.</p> </li> </ul> <p>For the predefined attributes per instance quota, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas\">Amazon Connect quotas</a>.</p> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
     },
     "ListPrompts":{
       "name":"ListPrompts",
@@ -3466,7 +3466,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "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>"
+      "documentation":"<p>Searches predefined attributes that meet certain criteria. A <i>predefined attribute</i> is made up of a name and a value. You can use predefined attributes for:</p> <ul> <li> <p>Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). 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> </li> <li> <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html\">Use contact segment attributes</a>.</p> </li> </ul> <p>For the predefined attributes per instance quota, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas\">Amazon Connect quotas</a>.</p> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
     },
     "SearchPrompts":{
       "name":"SearchPrompts",
@@ -4446,7 +4446,7 @@
         {"shape":"ThrottlingException"},
         {"shape":"InternalServiceException"}
       ],
-      "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>"
+      "documentation":"<p>Updates a predefined attribute for the specified Amazon Connect instance. A <i>predefined attribute</i> is made up of a name and a value.</p> <p>For the predefined attributes per instance quota, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas\">Amazon Connect quotas</a>.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). 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> </li> <li> <p>Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html\">Use contact segment attributes</a>.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
     },
     "UpdatePrompt":{
       "name":"UpdatePrompt",
@@ -7936,7 +7936,8 @@
     "ContactSearchSummarySegmentAttributes":{
       "type":"map",
       "key":{"shape":"SegmentAttributeName"},
-      "value":{"shape":"ContactSearchSummarySegmentAttributeValue"}
+      "value":{"shape":"ContactSearchSummarySegmentAttributeValue"},
+      "sensitive":true
     },
     "ContactState":{
       "type":"string",
@@ -8753,8 +8754,7 @@
       "type":"structure",
       "required":[
         "InstanceId",
-        "Name",
-        "Values"
+        "Name"
       ],
       "members":{
         "InstanceId":{
@@ -8770,6 +8770,14 @@
         "Values":{
           "shape":"PredefinedAttributeValues",
           "documentation":"<p> The values of the predefined attribute. </p>"
+        },
+        "Purposes":{
+          "shape":"PredefinedAttributePurposeNameList",
+          "documentation":"<p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>"
+        },
+        "AttributeConfiguration":{
+          "shape":"InputPredefinedAttributeConfiguration",
+          "documentation":"<p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>"
         }
       }
     },
@@ -12217,6 +12225,7 @@
       "members":{},
       "documentation":"<p>An empty value.</p>"
     },
+    "EnableValueValidationOnAssociation":{"type":"boolean"},
     "EncryptionConfig":{
       "type":"structure",
       "required":[
@@ -14979,6 +14988,16 @@
       "type":"list",
       "member":{"shape":"ContactInitiationMethod"}
     },
+    "InputPredefinedAttributeConfiguration":{
+      "type":"structure",
+      "members":{
+        "EnableValueValidationOnAssociation":{
+          "shape":"EnableValueValidationOnAssociation",
+          "documentation":"<p>When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for the predefined attribute key.</p>"
+        }
+      },
+      "documentation":"<p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>"
+    },
     "Instance":{
       "type":"structure",
       "members":{
@@ -15391,6 +15410,7 @@
       "type":"list",
       "member":{"shape":"IpCidr"}
     },
+    "IsReadOnly":{"type":"boolean"},
     "IvrRecordingTrack":{
       "type":"string",
       "enum":["ALL"]
@@ -19074,6 +19094,14 @@
           "shape":"PredefinedAttributeValues",
           "documentation":"<p>The values of the predefined attribute.</p>"
         },
+        "Purposes":{
+          "shape":"PredefinedAttributePurposeNameList",
+          "documentation":"<p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>"
+        },
+        "AttributeConfiguration":{
+          "shape":"PredefinedAttributeConfiguration",
+          "documentation":"<p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>"
+        },
         "LastModifiedTime":{
           "shape":"Timestamp",
           "documentation":"<p>Last modified time.</p>"
@@ -19085,11 +19113,36 @@
       },
       "documentation":"<p>Information about a predefined attribute.</p>"
     },
+    "PredefinedAttributeConfiguration":{
+      "type":"structure",
+      "members":{
+        "EnableValueValidationOnAssociation":{
+          "shape":"EnableValueValidationOnAssociation",
+          "documentation":"<p>When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the values are predefined in attributes. The contact will store only valid and predefined values for teh predefined attribute key.</p>"
+        },
+        "IsReadOnly":{
+          "shape":"IsReadOnly",
+          "documentation":"<p>A boolean flag used to indicate whether a predefined attribute should be displayed in the Amazon Connect admin website.</p>"
+        }
+      },
+      "documentation":"<p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>"
+    },
     "PredefinedAttributeName":{
       "type":"string",
-      "max":64,
+      "max":100,
       "min":1
     },
+    "PredefinedAttributePurposeName":{
+      "type":"string",
+      "max":100,
+      "min":1
+    },
+    "PredefinedAttributePurposeNameList":{
+      "type":"list",
+      "member":{"shape":"PredefinedAttributePurposeName"},
+      "max":10,
+      "min":0
+    },
     "PredefinedAttributeSearchConditionList":{
       "type":"list",
       "member":{"shape":"PredefinedAttributeSearchCriteria"}
@@ -19115,14 +19168,14 @@
     },
     "PredefinedAttributeStringValue":{
       "type":"string",
-      "max":64,
+      "max":100,
       "min":1
     },
     "PredefinedAttributeStringValuesList":{
       "type":"list",
       "member":{"shape":"PredefinedAttributeStringValue"},
-      "max":128,
-      "min":1
+      "max":500,
+      "min":0
     },
     "PredefinedAttributeSummary":{
       "type":"structure",
@@ -22530,11 +22583,23 @@
         "ValueInteger":{
           "shape":"SegmentAttributeValueInteger",
           "documentation":"<p>The value of a segment attribute.</p>"
+        },
+        "ValueList":{
+          "shape":"SegmentAttributeValueList",
+          "documentation":"<p>The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.</p>"
+        },
+        "ValueArn":{
+          "shape":"SegmentAttributeValueString",
+          "documentation":"<p>The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.</p>"
         }
       },
       "documentation":"<p>A value for a segment attribute. This is structured as a map where the key is <code>valueString</code> and the value is a string.</p>"
     },
     "SegmentAttributeValueInteger":{"type":"integer"},
+    "SegmentAttributeValueList":{
+      "type":"list",
+      "member":{"shape":"SegmentAttributeValue"}
+    },
     "SegmentAttributeValueMap":{
       "type":"map",
       "key":{"shape":"SegmentAttributeName"},
@@ -25040,7 +25105,7 @@
         },
         "SegmentAttributes":{
           "shape":"SegmentAttributes",
-          "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p> <p>Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.</p>"
+          "documentation":"<p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</p> <p>Attribute keys can include only alphanumeric, -, and _.</p> <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p> <p>Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.</p>"
         },
         "QueueInfo":{
           "shape":"QueueInfoInput",
@@ -25560,6 +25625,14 @@
         "Values":{
           "shape":"PredefinedAttributeValues",
           "documentation":"<p>The values of the predefined attribute.</p>"
+        },
+        "Purposes":{
+          "shape":"PredefinedAttributePurposeNameList",
+          "documentation":"<p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>"
+        },
+        "AttributeConfiguration":{
+          "shape":"InputPredefinedAttributeConfiguration",
+          "documentation":"<p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>"
         }
       }
     },