AWS connect documentation change
Summary
Updated terminology from 'third-party applications' to 'integrations', restructured configuration steps, added 'Integration type' field, and clarified MCP server instance association constraints.
Security assessment
The changes primarily involve rebranding and restructuring documentation without introducing new security features or addressing specific vulnerabilities. The added note about MCP server instance association restricts configuration but does not explicitly mitigate a disclosed security issue.
Diff
diff --git a/connect/latest/adminguide/3p-apps.md b/connect/latest/adminguide/3p-apps.md index 52d98cdd6..1b707e83b 100644 --- a//connect/latest/adminguide/3p-apps.md +++ b//connect/latest/adminguide/3p-apps.md @@ -5 +5 @@ -RequirementsHow to integrate a third-party applicationDelete third-party applications +RequirementsHow to add an integrationDelete integrations @@ -23 +23 @@ If you are a developer interested in building a third-party application, see the - * How to integrate a third-party application + * How to add an integration @@ -25 +25 @@ If you are a developer interested in building a third-party application, see the - * Delete third-party applications + * Delete integrations @@ -31 +31 @@ If you are a developer interested in building a third-party application, see the - * [MCP server applications](./3p-apps-mcp-server.html) + * [Integrate an MCP server](./3p-apps-mcp-server.html) @@ -80 +80 @@ JSON -## How to integrate a third-party application +## Integrations @@ -84 +84 @@ JSON -To integrate third-party applications into your instances, ensure that your instance is using a Service-Linked Role (SLR). If your instance currently does not use an SLR but you wish to integrate third-party applications, you will need to migrate to an SLR. Third-party applications can only be integrated and used in instances that are using an SLR. For more information, see [For instances created before October 2018](./connect-slr.html#migrate-slr). +To add an integration to your instances, ensure that your instance is using a Service-Linked Role (SLR). If your instance currently does not use an SLR but you wish to add an integration, you will need to migrate to an SLR. Integration can only be add to instances that are using an SLR. For more information, see [For instances created before October 2018](./connect-slr.html#migrate-slr). @@ -88 +88 @@ To integrate third-party applications into your instances, ensure that your inst - 2. On the left navigation pane, choose **Third-party applications**. If you do not see this menu, it's because it is not available in your region. To check the regions where this feature is available, see [Availability of Amazon Connect features by Region](./regions.html). + 2. On the left navigation pane, choose **Integrations**. If you do not see this menu, it's because it is not available in your region. To check the regions where this feature is available, see [Availability of Amazon Connect features by Region](./regions.html). @@ -90 +90 @@ To integrate third-party applications into your instances, ensure that your inst - 3. On the **Third-party applications** page, choose **Add application**. + 3. On the **Integrations** page, choose **Add integration**. @@ -92 +92 @@ To integrate third-party applications into your instances, ensure that your inst - + @@ -94 +94 @@ To integrate third-party applications into your instances, ensure that your inst - 4. On the **Add application** page, enter: + 4. On the **Add integration** page, enter: @@ -98 +98 @@ To integrate third-party applications into your instances, ensure that your inst - 1. **Display name** : A friendly name for the application. This name is displayed on security profiles and to your agents on the tab in the agent workspace. You can come back and change this name. + 1. **Display name** : A friendly name for the integration. This name is displayed on security profiles and to your agents on the tab in the agent workspace. You can come back and change this name. @@ -100 +100 @@ To integrate third-party applications into your instances, ensure that your inst - 2. **Application identifier** : The official name that is unique for your application. If you have only one application per access URL, we recommend that you use the origin of the access URL. You cannot change this name. + 2. **Description (optional)** : You may optionally provide any description for this integration. This description is not displayed to agents. @@ -102 +102 @@ To integrate third-party applications into your instances, ensure that your inst - 3. **Description (optional)** : You may optionally provide any description for this application. This description is not displayed to agents. + 3. **Integration type** : Indicates whether the integration is a standard web application, service, or MCP server. This determines how the integration will be accessed within the system. @@ -104 +104 @@ To integrate third-party applications into your instances, ensure that your inst - 4. **Application type** : Indicates whether the application is a standard web application, service, or MCP server. This determines how the application will be integrated and accessed within the system. + 4. **Integration identifier** : The official name that is unique for integrations of type standard application or service. If you have only one application per access URL, we recommend that you use the origin of the access URL. You cannot change this name. @@ -106 +106 @@ To integrate third-party applications into your instances, ensure that your inst - 5. **Contact Scope** : Indicates whether the application refreshes for each contact or refreshes only with each new browser session. This setting affects how frequently the application updates its data. + 5. **Initialization timeout** : The maximum time allowed to establish a connection with the workspace. The time allowed is in milliseconds. This setting helps manage connection issues and ensures timely application startup. @@ -108 +108 @@ To integrate third-party applications into your instances, ensure that your inst - 6. **Initialization timeout** : The maximum time allowed to establish a connection with the workspace. The time allowed is in milliseconds. This setting helps manage connection issues and ensures timely application startup. + 2. **Application details** @@ -110 +110,5 @@ To integrate third-party applications into your instances, ensure that your inst - 2. **Access** + 1. **Contact Scope** : Indicates whether the web application refreshes for each contact or refreshes only with each new browser session. This setting affects how frequently the application updates its data. + + 2. **Initialization timeout** : The maximum time allowed to establish a connection with the workspace. The time allowed is in milliseconds. This setting helps manage connection issues and ensures timely application startup. + + 3. **Access** @@ -146 +150 @@ Here's what you can do if the app cannot be iframed: - 3. Add permissions to [events and requests](./3p-apps-events-requests.html). + 4. Add permissions to [events and requests](./3p-apps-events-requests.html). @@ -152 +156 @@ The following is an example of how you can onboard a new application and assign - 4. **Instance association** + 5. **Instance association** @@ -156 +160,5 @@ The following is an example of how you can onboard a new application and assign - 2. While associating the application to an instance is optional, you will not be able to use this application until you associate it with instance(s). + 2. While associating the integration with an instance is optional, you will not be able to use this application until you associate it with instance(s). + +###### Note + +For MCP servers, you can only select the instance that is configured with the selected Gateway's Discovery URL. @@ -158 +166 @@ The following is an example of how you can onboard a new application and assign - + @@ -162 +170 @@ The following is an example of how you can onboard a new application and assign - + @@ -166 +174 @@ The following is an example of how you can onboard a new application and assign - + @@ -168 +176 @@ The following is an example of how you can onboard a new application and assign - 5. Choose **Save**. + 5. Choose **Add integration**. @@ -170 +178 @@ The following is an example of how you can onboard a new application and assign - 6. If the application was successfully created, you will be returned to the **Third-party applications** page, you will see a success banner, and you should see the application on the list. + 6. If the integration was successfully created, you will be sent to the **Integration details** page, and you will see a success banner. @@ -172 +180 @@ The following is an example of how you can onboard a new application and assign - + @@ -181 +189 @@ You can edit certain attributes of an existing app, such as its Display Name, Ac -## Delete third-party applications +## Delete integrations @@ -183 +191 @@ You can edit certain attributes of an existing app, such as its Display Name, Ac -If you no longer want to use a third-party application in the foreseeable future, you can delete it. If you temporarily want to stop using it, but you may want to use it again in the foreseeable future, we recommend that you disassociate it from an instance to avoid having to add it again. To delete third-party applications, navigate to the AWS Management Console, select an application, and choose **Delete**. +If you no longer want to use an integration in the foreseeable future, you can delete it. If you temporarily want to stop using it, but you may want to use it again in the foreseeable future, we recommend that you disassociate it from an instance to avoid having to add it again. To delete integrations, navigate to the AWS Management Console, select an integration, and choose **Delete**. @@ -187 +195 @@ If you no longer want to use a third-party application in the foreseeable future - * The operation will fail if the application is associated with any instance. You will first have to disassociate the application from any instance. Then you can come back and delete. + * The operation will fail if the integration is associated with any instance. You will first have to disassociate the integration from any instance. Then you can come back and delete it. @@ -194 +202 @@ If you no longer want to use a third-party application in the foreseeable future -If you created an application before Dec 15, 2023, then you may encounter issues when updating the association of the application to instance(s). This is because you need to make updates to your IAM policy. +If you created an integration before Dec 15, 2023, then you may encounter issues when updating the association of the integration to instance(s). This is because you need to make updates to your IAM policy. @@ -196 +204 @@ If you created an application before Dec 15, 2023, then you may encounter issues - +