AWS connect documentation change
Summary
Reorganized documentation structure, expanded details about predefined attribute limits/constraints, added operational guidance for attribute management, and updated API references.
Security assessment
The change moves an existing security note about unencrypted data and PII compliance to a new section but does not introduce new security fixes or vulnerabilities. The warning about unencrypted data is a pre-existing security consideration, not evidence of addressing a newly disclosed issue. No new security features or mitigations are documented.
Diff
diff --git a/connect/latest/adminguide/predefined-attributes.md b/connect/latest/adminguide/predefined-attributes.md index 7d326ae43..b1101b93c 100644 --- a//connect/latest/adminguide/predefined-attributes.md +++ b//connect/latest/adminguide/predefined-attributes.md @@ -5 +5 @@ -Create a predefined attributePredefined attribute management APIsRequired security profile permissionsSystem predefined attributesFrequently asked questions +Important things to knowSystem predefined attributesCreate a predefined attributeUpdate the name of an attribute or valuePredefined attribute management APIs @@ -9 +9 @@ Create a predefined attributePredefined attribute management APIsRequired securi -###### Important +A predefined attributed is made up of a name-value pair. For example, a name such as `language` and values such as `English`, `French`, `Japanese`. You can use predefined attributes to route contacts to an agent or pools of agents within a queue. @@ -11 +11 @@ Create a predefined attributePredefined attribute management APIsRequired securi -This information is not encrypted. We strongly recommend you follow the [Best practices for PII compliance in Amazon Connect](./compliance-validation-best-practices-PII.html). +###### Tip @@ -13 +13 @@ This information is not encrypted. We strongly recommend you follow the [Best pr -Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. A predefined attribute is made up of a name and a value. +You define the level of an agent's proficiency in their user profile, not when you create a predefined attribute. A proficiency level is an indicator, ranging from 1 to 5, of the level of expertise of an agent for a given attribute value. Level 1 is the lowest proficiency, while 5 is the highest. @@ -15 +15 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * You can create up to 128 values per attribute. +You can create and manage predefined attributes manually by using the Amazon Connect admin website; the steps are described in this topic. Or programmatically by using the Predefined attribute management APIs. @@ -17 +17 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * A predefined attribute name can be up to 64 characters long. +###### Contents @@ -19 +19 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * A predefined attribute value can be up to 64 characters long. + * Important things to know @@ -21 +21 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * You can create and manage predefined attributes manually by using the Amazon Connect admin website; the steps are described in this topic. Or programmatically by using the Predefined attribute management APIs. + * System predefined attributes @@ -23 +23 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * Pattern for predefined attribute: `^(?!(aws:|connect:))[\p{L}\p{Z}\p{N}_.:/=+-@']+$` + * Create a predefined attribute @@ -25 +25 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * You can find the service quota for the number of predefined attributes in an Amazon Connect instance here. + * Update the name of an attribute or value @@ -26,0 +27 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u + * Predefined attribute management APIs @@ -30 +30,0 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u -## Create a predefined attribute @@ -32 +32 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - 1. On the navigation menu, choose ****Routing****,**Predefined attributes** , **Add predefined attribute**. +## Important things to know @@ -34 +34 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - 2. In the **Add predefined attributes** section, add the name in the **Predefined attribute** box and value in the **Value** box + * The information in a predefined attribute is not encrypted. We strongly recommend you follow the [Best practices for PII compliance in Amazon Connect](./compliance-validation-best-practices-PII.html). @@ -36 +36 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - 3. Add additional values for the attribute by choosing **Add predefined attribute**. + * You can create up to 500 values per attribute. @@ -38 +38 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - + * A predefined attribute **name** can be up to 100 characters long. @@ -40 +40 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - 4. Choose **Save** to save the attribute and values. + * A predefined attribute **value** can be up to 100 characters long. @@ -42 +42 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - + * The pattern for predefined attribute name and value is `^(?!(aws:|connect:))[\p{L}\p{Z}\p{N}_.:/=+-@']+$`. For example, it can contain any letter, numeric value, whitespace, or `_.:/=+-@'` special characters, but can't start with `aws:` or `connect:`. @@ -44 +44 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - 5. Choose **Refresh** to update the **Predefined attribute management** page with the attributes that have been created. + * You cannot create duplicate predefined attribute names or values. In addition, case sensitivity does not allow you to use duplicate names. For example, a new predefined attribute with the name `language` cannot be created if a predefined attribute with name `Language` exists in your Amazon Connect instance. @@ -45,0 +46 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u + * An attribute can only be deleted if it not associated with any agent. @@ -46,0 +48 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u +Before deleting an attribute, ensure none of the contacts are waiting for an agent with that attribute or the contact will not find a match. @@ -47,0 +50 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u + * For the quota for predefined attributes allowed in an Amazon Connect instance, see [Amazon Connect quotas](./amazon-connect-service-limits.html#connect-quotas). @@ -49 +51,0 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u -## Predefined attribute management APIs @@ -51 +52,0 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * [CreatePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreatePredefinedAttribute.html) @@ -53 +53,0 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * [UpdatePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePredefinedAttribute.html) @@ -55 +55 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * [DeletePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeletePredefinedAttribute.html) +## System predefined attributes @@ -57 +57 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * [DescribePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePredefinedAttribute.html) +System attributes, identified as `connect:`, are predefined attributes set by Amazon Connect. You cannot change or delete the `connect:` name and values. @@ -59 +59 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u - * [ListPredefinedAttributes](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPredefinedAttributes.html) +The following system attributes are available: @@ -60,0 +61 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u + * `connect:Language`. You can add 500 custom values for `connect:Language`. @@ -61,0 +63 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u + * `connect:Subtype`. You cannot change `connect:Subtype` but it can be used in routing criteria for routing. @@ -64 +65,0 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u -## Required security profile permissions for managing predefined attributes @@ -66 +66,0 @@ Predefined attributes are attributes in an Amazon Connect instance that can be u -Before you can add predefined attributes to Amazon Connect, you need the following permissions assigned to your security profile: **Predefined attributes**. The following image shows this security profile permission in the **Routing** section of the **Add/Edit security profile** page. @@ -68 +68 @@ Before you can add predefined attributes to Amazon Connect, you need the followi - +## Create a predefined attribute @@ -70 +70 @@ Before you can add predefined attributes to Amazon Connect, you need the followi -## System predefined attributes + 1. Log in to the Amazon Connect admin website with an **Admin** account, or an account assigned to a security profile that has **Routing** \- **Predefined attributes** \- **Create** permission. @@ -72 +72 @@ Before you can add predefined attributes to Amazon Connect, you need the followi -System attributes, identified as `connect:` are predefined attributes set by Amazon Connect. The `connect:` name and values cannot be changed or deleted. The system attributes available today are `connect:Language` and `connect:Subtype`. You can add 128 custom values for `connect:Language`. You cannot change `connect:Subtype` but it can be used in routing criteria for routing. + 2. In Amazon Connect, on the left navigation menu, choose **Routing** , **Predefined attributes**. @@ -74 +74 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - + 3. On the **Attribute management** page choose **Add attribute** , as shown in the following image. @@ -76 +76 @@ System attributes, identified as `connect:` are predefined attributes set by Ama -## Frequently asked questions + @@ -78 +78 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * **Do I need to define levels on a predefined attribute when I create it?** + 4. On the **Add predefined attribute** page, in the **Details** section, complete the following fields as needed: @@ -80 +80 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * A predefined attributed is made up of a name-value pair. For example, a name such as `language` and values such as `English`, `French`, `Swahili`. + 1. **Name** : Enter a name for the segment attribute. @@ -82 +82 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * A proficiency level is an indicator, ranging from 1 to 5, of the level of expertise of an agent for a given attribute value. It is set in the user profile. Level 1 is the lowest proficiency, while 5 is the highest. + 2. **Use as a Contact search filter** : Choose if you want to enable contact search on this segment attribute. @@ -84 +84 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * **Can I create duplicate predefined attributes? Case sensitivity?** + 3. **Enforce valid values** : Choose to allow only predefined values when using this attribute as a contact segment attribute. @@ -86 +86 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * No, you cannot create predefined attribute with duplicate names or values. In addition, case sensitivity does not allow you to use duplicate names. For example, a new predefined attribute with the name `language` cannot be created if a predefined attribute with name `Language` exists in your Amazon Connect instance. + 5. Choose **Add value** to add values to the attribute. For example, you might enter Sales, Marketing, and Accounts for Business units. @@ -88 +88 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * **Can I delete a attribute if it is already assigned to an agent?** + @@ -90 +90 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * An attribute can only be deleted if it not associated with any agent. + 6. Choose **Save** to save the predefined attribute and values. @@ -92 +91,0 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * Before deleting an attribute, you should ensure none of the contacts are waiting for an agent with that attribute or the contact will not find a match. @@ -94 +93,3 @@ System attributes, identified as `connect:` are predefined attributes set by Ama - * **How can I update the name of an attribute or value?** + + +## Update the name of an attribute or value @@ -102,0 +104,15 @@ System attributes, identified as `connect:` are predefined attributes set by Ama +## Predefined attribute management APIs + + * [CreatePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreatePredefinedAttribute.html) + + * [UpdatePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePredefinedAttribute.html) + + * [DeletePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeletePredefinedAttribute.html) + + * [DescribePredefinedAttribute](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePredefinedAttribute.html) + + * [ListPredefinedAttributes](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPredefinedAttributes.html) + + + +