View all connectors

Amazon Q

By integrating Amazon Q with DX, you can analyze Amazon Q daily usage metrics and AI assistant interactions. Please refer to the API documentation below and our schema explorer to see what data DX imports.

Prerequisites

To connect Amazon Q to DX, you need:

  • an AWS account with Amazon Q access
  • AWS credentials with appropriate permissions to access Amazon Q data
  • an S3 bucket configured for Amazon Q data storage

Setup instructions

Follow the steps below to connect Amazon Q to DX.

Step 1

Create AWS credentials with the necessary permissions to access Amazon Q data and your S3 bucket.

Step 2

  • Navigate to the connections page in DX and select “+ Connection” in the top right.
  • Enter the following credentials in the connection form:
    • Access Key ID: Your AWS access key ID
    • Secret Access Key: Your AWS secret access key
    • Region: The AWS region where your Amazon Q service and S3 bucket are located
    • Bucket Name: The name of your S3 bucket containing Amazon Q data
    • Connection Name: A descriptive name for this connection (e.g., “Amazon Q Production”)
    • User mapping directory path: Path to the directory containing the user mapping files. (If your user mapping file is in example directory, e.g. example/user_mapping.csv, then the path should be example/)
    • Usage metrics directory path: Path to AWSLogs directory. (If your AWSLogs directory is in example directory, e.g. example/AWSLogs/, then the path should be example/)
  • Click “Add connection” to establish the connection

Note: Your user mapping csv must contain mapping aws_user_uuid and user_email as headers (Refer to the example below).

API reference

The table below lists the specific AWS services and permissions that are used by DX.

Service Documentation
S3 Get Object Link
S3 List Objects V2 Link

Errors

The table below lists potential error codes when adding a connection in DX.

Error Description
no_users_found No users found in the user mapping csv (Please refer above example or provide a valid user mapping csv).
no_usage_metrics_found No usage metrics found in the provided directory (Please refer above example or provide a valid directory).
invalid_credentials Your AWS credentials are not valid or have expired.
invalid_permissions Your AWS credentials do not have the required permissions to access Amazon Q or S3.