Overview

[ADMIN] Set Amazon Web Services configs in Sugar Serve.

Summary

This endpoint sets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve.

Request Arguments

Name Type Description Required
aws_connect_instance_name String The name of the AWS Connect instance False
aws_connect_region String The region assigned to the AWS Connect instance False
aws_connect_identity_provider String The AWS Connect identity provider. Default is "Connect". False
aws_login_url String The login url for SSO authentication for AWS Connect. Only required if identity provider is set to SAML. False
aws_connect_enable_portal_chat Boolean Whether portal chat is enabled. False
aws_connect_api_gateway_url String The API Gateway endpoint URL used to start a chat session. False
aws_connect_contact_flow_id String The ID of the contact flow you wish to use in the Sugar Portal chat. False
aws_connect_instance_id String The AWS Connect instance ID. False

Response

{
    "aws_connect_instance_name": "my-aws-instance",
    "aws_connect_region": "us-east-2"
}

Change Log

Version Change
v11_10 Added Administration/aws POST endpoint.