/
var
/
www
/
html
/
sugardemo
/
include
/
api
/
help
/
Upload File
HOME
<!-- /* * Your installation or use of this SugarCRM file is subject to the applicable * terms available at * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/. * If you do not agree to all of the applicable terms or do not have the * authority to bind the entity as an authorized representative, then do not * install or use this SugarCRM file. * * Copyright (C) SugarCRM Inc. All rights reserved. */ --> <h2>Overview</h2> <span class="lead"> [ADMIN] Set Amazon Web Services configs in Sugar Serve. </span> <h2>Summary</h2> <span class="lead"> This endpoint sets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve. </span> <h2>Request Arguments</h2> <table class="table table-hover"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead> <tbody> <tr> <td> aws_connect_instance_name </td> <td> String </td> <td> The name of the AWS Connect instance </td> <td> False </td> </tr> <tr> <td> aws_connect_region </td> <td> String </td> <td> The region assigned to the AWS Connect instance </td> <td> False </td> </tr> <tr> <td> aws_connect_identity_provider </td> <td> String </td> <td> The AWS Connect identity provider. Default is "Connect". </td> <td> False </td> </tr> <tr> <td> aws_login_url </td> <td> String </td> <td> The login url for SSO authentication for AWS Connect. Only required if identity provider is set to SAML. </td> <td> False </td> </tr> <tr> <td> aws_connect_enable_portal_chat </td> <td> Boolean </td> <td> Whether portal chat is enabled. </td> <td> False </td> </tr> <tr> <td> aws_connect_api_gateway_url </td> <td> String </td> <td> The API Gateway endpoint URL used to start a chat session. </td> <td> False </td> </tr> <tr> <td> aws_connect_contact_flow_id </td> <td> String </td> <td> The ID of the contact flow you wish to use in the Sugar Portal chat. </td> <td> False </td> </tr> <tr> <td> aws_connect_instance_id </td> <td> String </td> <td> The AWS Connect instance ID. </td> <td> False </td> </tr> </tbody> </table> <h3>Response</h3> <pre class="pre-scrollable"> { "aws_connect_instance_name": "my-aws-instance", "aws_connect_region": "us-east-2" } </pre> <h2>Change Log</h2> <table class="table table-hover"> <tr> <th>Version</th> <th>Change</th> </tr> <tr> <td> v11_10 </td> <td> Added <code>Administration/aws</code> POST endpoint. </td> </tr> </table>