AWS connect documentation change
Summary
Updated product name references from 'Amazon Connect' to 'Connect Customer' throughout the contact attributes documentation
Security assessment
The changes are purely branding/nomenclature updates replacing 'Amazon Connect' with 'Connect Customer'. No security vulnerabilities, configurations, or features are modified, added, or referenced. The technical descriptions of attributes (including authentication methods) remain unchanged.
Diff
diff --git a/connect/latest/adminguide/connect-attrib-list.md b/connect/latest/adminguide/connect-attrib-list.md index b69cf31de..1eb0d5cd8 100644 --- a//connect/latest/adminguide/connect-attrib-list.md +++ b//connect/latest/adminguide/connect-attrib-list.md @@ -9 +9 @@ System attributesSegment attributesViews attributesCapabilities attributesAgent -# List of available contact attributes in Amazon Connect and their JSONPath references +# List of available contact attributes in Connect Customer and their JSONPath references @@ -11 +11 @@ System attributesSegment attributesViews attributesCapabilities attributesAgent -The following tables describe the contact attributes available in Amazon Connect. +The following tables describe the contact attributes available in Connect Customer. @@ -68 +68 @@ The JSONPath reference for each attribute is provided so you can [create dynamic -These are predefined attributes in Amazon Connect. You can reference system attributes, but you cannot create them. +These are predefined attributes in Connect Customer. You can reference system attributes, but you cannot create them. @@ -82 +82 @@ To Email Address List | The full list of To email addresses on the inbound email -Customer callback number | The number that Amazon Connect uses to call back the customer. This number can be the one used for a queued callback, or when an agent is dialing from the CCP. Transfer to callback queue functionality, or for an agent dialing from the CCP. The default value is the number that the customer used to call your contact center. However, it can be overwritten with the [Set callback number](./set-callback-number.html) block. This attribute is not included in contact records, and it's not accessible in Lambda input. However, you can copy the attribute to a user-defined attribute with the [Set contact attributes](./set-contact-attributes.html) block, which is included in contact records. You can also pass this attribute as a Lambda input parameter in an [AWS Lambda function](./invoke-lambda-function-block.html) block, which is not included in contact records. | System | not applicable +Customer callback number | The number that Connect Customer uses to call back the customer. This number can be the one used for a queued callback, or when an agent is dialing from the CCP. Transfer to callback queue functionality, or for an agent dialing from the CCP. The default value is the number that the customer used to call your contact center. However, it can be overwritten with the [Set callback number](./set-callback-number.html) block. This attribute is not included in contact records, and it's not accessible in Lambda input. However, you can copy the attribute to a user-defined attribute with the [Set contact attributes](./set-contact-attributes.html) block, which is included in contact records. You can also pass this attribute as a Lambda input parameter in an [AWS Lambda function](./invoke-lambda-function-block.html) block, which is not included in contact records. | System | not applicable @@ -93 +93 @@ Channel | The method used to contact your contact center: VOICE, CHAT, TASK, EMA -Instance ARN | The ARN for your Amazon Connect instance. | System | $.InstanceARN +Instance ARN | The ARN for your Connect Customer instance. | System | $.InstanceARN @@ -103 +103 @@ Queue Outbound Caller ID number type | The type of the outbound caller ID number -Tags | The tags used to organize, track, or control access for this resource. For more information about tags, see [Add tags to resources in Amazon Connect](./tagging.html) and [Set up granular billing for a detailed view of your Amazon Connect usage](./granular-billing.html). | System | $.Tags +Tags | The tags used to organize, track, or control access for this resource. For more information about tags, see [Add tags to resources in Connect Customer](./tagging.html) and [Set up granular billing for a detailed view of your Connect Customer usage](./granular-billing.html). | System | $.Tags @@ -143 +143 @@ Associated Customer Id | The customer's identifier number. This is either a cust -Authentication Method | An Amazon Connect-managed authentication workflow or customer-managed authentication workflow. | `CONNECT` | `CUSTOM` | ValueString | $.SegmentAttributes['connect:CustomerAuthentication']['AuthenticationMethod'] +Authentication Method | An Connect Customer-managed authentication workflow or customer-managed authentication workflow. | `CONNECT` | `CUSTOM` | ValueString | $.SegmentAttributes['connect:CustomerAuthentication']['AuthenticationMethod'] @@ -147 +147 @@ Amazon SES Virus Verdict | When the email comes into your contact center, Amazon -User-defined attributes | You can choose any user-defined attribute and store it on the contact under segment attributes. The attribute must be predefined before it can be used to store values on contact. See [Use contact segment attributes](./use-contact-segment-attributes.html). | If no values are predefined, Amazon Connect allows all string values. This is also the case when the [Enforce valid values](./use-contact-segment-attributes.html) option on the **Add predefined attributes** page is not selected. When the **Enforce valid values** option is selected and values are predefined, the contact stores only valid and predefined values for the predefined attribute key. (If using the API, see the [EnableValueValidationOnAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_InputPredefinedAttributeConfiguration.html) parameter.) | String | $.SegmentAttributes['Attribute_key_name'] +User-defined attributes | You can choose any user-defined attribute and store it on the contact under segment attributes. The attribute must be predefined before it can be used to store values on contact. See [Use contact segment attributes](./use-contact-segment-attributes.html). | If no values are predefined, Connect Customer allows all string values. This is also the case when the [Enforce valid values](./use-contact-segment-attributes.html) option on the **Add predefined attributes** page is not selected. When the **Enforce valid values** option is selected and values are predefined, the contact stores only valid and predefined values for the predefined attribute key. (If using the API, see the [EnableValueValidationOnAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_InputPredefinedAttributeConfiguration.html) parameter.) | String | $.SegmentAttributes['Attribute_key_name'] @@ -151 +151 @@ User-defined attributes | You can choose any user-defined attribute and store it -The following table lists the Views attributes available in Amazon Connect. +The following table lists the Views attributes available in Connect Customer. @@ -160 +160 @@ View result data | The output data from the user's interaction with the view bas -The following table lists the Capabilities attributes available in Amazon Connect. These attributes support the screen and video sharing capabilities. For more information, see [Set up in-app, web, video calling, and screen sharing capabilities](./inapp-calling.html). +The following table lists the Capabilities attributes available in Connect Customer. These attributes support the screen and video sharing capabilities. For more information, see [Set up in-app, web, video calling, and screen sharing capabilities](./inapp-calling.html). @@ -171 +171 @@ Customer video capability | The video sharing capability that is enabled for the -The following table lists the agent attributes available in Amazon Connect. +The following table lists the agent attributes available in Connect Customer. @@ -175,3 +175,3 @@ Attribute | Description | Type | JSONPath Reference -Agent User name | The user name an agent uses to log in to Amazon Connect. | System | $.Agent.UserName -Agent First name | The agent’s first name as entered in their Amazon Connect user account. | System | $.Agent.FirstName -Agent Last name | The agent’s last name as entered in their Amazon Connect user account. | System | $.Agent.LastName +Agent User name | The user name an agent uses to log in to Connect Customer. | System | $.Agent.UserName +Agent First name | The agent’s first name as entered in their Connect Customer user account. | System | $.Agent.FirstName +Agent Last name | The agent’s last name as entered in their Connect Customer user account. | System | $.Agent.LastName @@ -275 +275 @@ InitialMessage | The initial message supplied by the customer on a web chat or S -The following table lists the email attributes available in Amazon Connect. +The following table lists the email attributes available in Connect Customer. @@ -309 +309 @@ Dialog state | The last dialog state returned from an Amazon Lex bot. The value -The following table lists the attributes that are used with Amazon Connect Cases. +The following table lists the attributes that are used with Connect Customer Cases. @@ -313 +313 @@ Attribute | Description | Type | JSONPath Reference | Where the data comes from -Case ID | Unique Identifier of the case in UUID format (for example, 689b0bea-aa29-4340-896d-4ca3ce9b6226) | text | $.Case.case_id | Amazon Connect +Case ID | Unique Identifier of the case in UUID format (for example, 689b0bea-aa29-4340-896d-4ca3ce9b6226) | text | $.Case.case_id | Connect Customer @@ -315,5 +315,5 @@ Case Reason | The reason for opening the case | single-select | $.Case.case_rea -Created By | The identity of the user who created the case. | user | $.Case.created_by | Amazon Connect -Customer | The API is a customer profile ID. On the **Cases: Fields** page, the customer's name is displayed. | text | $.Case.customer_id | Amazon Connect -Date/Time Closed | The date and time the case was last closed. It does not guarantee that a case is closed. If a case is reopened, this field contains the date/time stamp of the last time the status was changed to closed. | date-time | $.Case.last_closed_datetime | Amazon Connect -Date/Time Opened | The date and time the case was opened. | date-time | $.Case.created_datetime | Amazon Connect -Date/Time Updated | The date and time the case was last updated. | date-time | $.Case.last_updated_datetime | Amazon Connect +Created By | The identity of the user who created the case. | user | $.Case.created_by | Connect Customer +Customer | The API is a customer profile ID. On the **Cases: Fields** page, the customer's name is displayed. | text | $.Case.customer_id | Connect Customer +Date/Time Closed | The date and time the case was last closed. It does not guarantee that a case is closed. If a case is reopened, this field contains the date/time stamp of the last time the status was changed to closed. | date-time | $.Case.last_closed_datetime | Connect Customer +Date/Time Opened | The date and time the case was opened. | date-time | $.Case.created_datetime | Connect Customer +Date/Time Updated | The date and time the case was last updated. | date-time | $.Case.last_updated_datetime | Connect Customer @@ -338 +338 @@ where `AttributeName` is the attribute name, or the key of the key-value pair re -For example, if the function returns a contact ID, reference the attribute with `$.LambdaInvocation.ResultData.ContactId`. When referencing a contact ID returned from Amazon Connect, the JSONPath is `$.ContactId`. +For example, if the function returns a contact ID, reference the attribute with `$.LambdaInvocation.ResultData.ContactId`. When referencing a contact ID returned from Connect Customer, the JSONPath is `$.ContactId`. @@ -340 +340 @@ For example, if the function returns a contact ID, reference the attribute with -For more information about using attributes in Lambda functions, see [Grant Amazon Connect access to your AWS Lambda functions](./connect-lambda-functions.html). +For more information about using attributes in Lambda functions, see [Grant Connect Customer access to your AWS Lambda functions](./connect-lambda-functions.html). @@ -346 +346 @@ These attributes are not included in contact records, not passed to the next Lam -For all other attributes Amazon Connect defines the key and value. For user-defined attributes, however, you provide a name for the key and the value. +For all other attributes Connect Customer defines the key and value. For user-defined attributes, however, you provide a name for the key and the value. @@ -348 +348 @@ For all other attributes Amazon Connect defines the key and value. For user-defi -Use user-defined attributes in situations where you want to store values in a contact flow, and then refer to those values later. For example, if you integrate Amazon Connect and a CRM or other system, you might want to get input from the customer such as their member number. Then you can use that member number retrieve information about the member from the CRM, and/or use the member number throughout the flow, etc. +Use user-defined attributes in situations where you want to store values in a contact flow, and then refer to those values later. For example, if you integrate Connect Customer and a CRM or other system, you might want to get input from the customer such as their member number. Then you can use that member number retrieve information about the member from the CRM, and/or use the member number throughout the flow, etc. @@ -355 +355 @@ Any name you choose | A user-defined attribute has two parts: - * Value: this is can be any value you choose. You can enter several paragraphs worth of text if you want! (For the **Max size of the contact record attributes section** , see [Amazon Connect feature specifications](./feature-limits.html).) + * Value: this is can be any value you choose. You can enter several paragraphs worth of text if you want! (For the **Max size of the contact record attributes section** , see [Connect Customer feature specifications](./feature-limits.html).) @@ -411 +411 @@ These attributes are not included in contact records, not passed to the next mod -The following table lists the flow modules attributes available in Amazon Connect. +The following table lists the flow modules attributes available in Connect Customer. @@ -482 +482 @@ AppleQuickReplyCapability | Whether the customer device supports quick replies. -The following table lists the attributes that are used with Amazon Connect Customer Profiles. +The following table lists the attributes that are used with Connect Customer Customer Profiles. @@ -520 +520 @@ Case | A customer's standard Case. | text | $.Customer.Case.CaseId $.Customer -You can use data in Amazon Pinpoint [segments](https://docs.aws.amazon.com/pinpoint/latest/userguide/segments-building.html) list to customize experiences in Amazon Connect flows. To reference data in a segment list, use **$.Attributes.`attribute coming in the segment`**. For example, if you have a segment with two columns "Attributes.FirstName" and "Attributes.ItemDescription, you would refer to them as: +You can use data in Amazon Pinpoint [segments](https://docs.aws.amazon.com/pinpoint/latest/userguide/segments-building.html) list to customize experiences in Connect Customer flows. To reference data in a segment list, use **$.Attributes.`attribute coming in the segment`**. For example, if you have a segment with two columns "Attributes.FirstName" and "Attributes.ItemDescription, you would refer to them as: @@ -545 +545 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -How contact attributes work in Amazon Connect +How contact attributes work in Connect Customer