How can I troubleshoot OpenSearch Service domain connect errors to QuickSight?

Short description

Before you connect QuickSight to your OpenSearch Service domain, verify the following conditions:

• Your domain is version 7.7 or higher.
• Your OpenSearch version is 1.0 or higher.
• Your OpenSearch Service domain is in the same AWS Region and account as QuickSight.

Note: Amazon OpenSearch Service supports OpenSearch and legacy Elasticsearch OSS up to 7.10.

Resolution

Follow these troubleshooting steps for your use case.

Unsupported engine version error

When connecting to an OpenSearch Service domain, you might receive the following error:

"Your database uses an unsupported engine version. Please review supported versions."

This error occurs when the compatibility mode isn't activated on the OpenSearch Service domain. OpenSearch version 1.0 introduces a domain setting named Enable compatibility mode. Some OpenSearch Service clients and plugins check the cluster version before connecting. Compatibility mode sets OpenSearch Service to report its version as 7.10 so that these clients continue to work. When compatible mode is activated, QuickSight identifies the correct version and the connection is established successfully.

To activate compatibility mode, run the following command:

PUT /_cluster/settings{
     "persistent": {
          "compatibility.override_main_response_version": true
     }
}

Cursor not enabled or unable to prepare this table error

When importing the OpenSearch Service domain data into SPICE, you might receive one of the following errors:

"Can't perform this Action. The domain X has not enabled cursor."

"Unable to prepare this table."

To activate SQL cursor in your OpenSearch Service domain, run the following command:

PUT _opendistro/_sql/settings{
     "transient": {
          "opendistro.sql.cursor.enabled": "true"
     },
     "persistent": {
          "opendistro.sql.cursor.enabled": "true"
     }
}

Connection error forbidden

If you have fine-grained access control activated on OpenSearch Dashboards in your OpenSearch Service domain, you might receive the following error:

"GENERAL_SQL_EXCEPTION. Connection error forbidden."

This error occurs because the QuickSight service role isn't mapped to an OpenSearch Service role.

To resolve this error, follow the instructions to add permissions to a domain to allow access from QuickSight.

Related information

Using Amazon OpenSearch Service with Amazon QuickSight

Supported data sources

Connecting to a VPC with Amazon QuickSight

Operational best practices for Amazon OpenSearch Service