Botium Connector for Amazon Q Connect

This is a Botium connector for testing your Amazon Q in Connect chatbot.

Did you read the Botium in a Nutshell articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!

How it works

Botium connects to the Amazon Connect API to start a chat session and interact with your Amazon Q in Connect Assistant.

It can be used as any other Botium connector with all Botium Stack components:

• Botium CLI
• Botium Bindings
• Botium Box

This connector does not extract NLP info, so NLP based asserters wont work using this technology

Requirements

• Node.js and NPM
• An Amazon Connect instance with Amazon Q assistant.
• An IAM user with permissions to use the Amazon Connect API.
• A project directory on your workstation to hold test cases and Botium configuration.

Install Botium and Amazon Q in Connect Connector

When using Botium CLI:

> npm install -g botium-cli
> npm install -g botium-connector-qic
> botium-cli init
> botium-cli run

When using Botium Bindings:

> npm install -g botium-bindings
> npm install -g botium-connector-qic
> botium-bindings init mocha
> npm install && npm run mocha

When using Botium Box:

Already integrated into Botium Box, no setup required

Connecting Amazon Q in Connect to Botium

You have to create an IAM user to enable Botium to access the Amazon Connect API.

• Create an IAM user (see here for help)
  • Important: choose Programmatic access as access type
  • Note access key and secret, you need it later
  • Choose Attach existing policies to user directly to give permissions. A good starting point is the AmazonConnect_FullAccess policy.
  • Feel free to use finer grained policies if you know what you are doing, or read Authentication and Access Control for Amazon Connect.

Create a botium.json with your Amazon Connect and chat configuration:

{
  "botium": {
    "Capabilities": {
      "CONTAINERMODE": "qic",
      "QIC_ASSISTANT_ID": "your-assistant-id",
      "QIC_AWS_REGION": "us-east-1",
      "QIC_AWS_ACCESS_KEY_ID": "your-access-key-id",
      "QIC_AWS_SECRET_ACCESS_KEY": "your-secret-access-key"
    }
  }
}

To check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:

> botium-cli emulator

Botium setup is ready, you can begin to write your BotiumScript files.

Supported Capabilities

Set the capability CONTAINERMODE to qic to activate this connector.

QIC_AWS_REGION

Required. AWS region where your Connect instance is located (e.g., us-east-1).

QIC_AWS_ACCESS_KEY_ID

Required. AWS access key ID for authentication.

QIC_AWS_SECRET_ACCESS_KEY

Required. AWS secret access key for authentication.

QIC_ASSISTANT_ID

Required. The identifier of the Amazon Q assistant.

QIC_CLIENT_TOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, a UUID is generated.

QIC_GENERATE_FILLER_MESSAGE

Enable or disable generation of filler messages. Set to true to enable.