Registry / aws / amplify-category-interactions

amplify-category-interactions

library4.3.2jsnpmunverified

Amplify CLI plugin for managing interactions resources (e.g., Amazon Lex chatbots) within an AWS Amplify project. Version 4.3.2 is the latest stable release. This plugin provides CLI commands to add, update, push, and remove interactions resources. It is part of the Amplify CLI ecosystem and relies on the Amplify core infrastructure. Key differentiators: tightly integrated with Amplify CLI workflow, supports Lex bots, and automatically generates CloudFormation templates. Release cadence follows Amplify CLI releases, approximately monthly.

aws crm-productivity

npm install amplify-category-interactions

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AMPLIFY-CATEGORY-I

amplify-category-interactions

awsjavascriptv4.3.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import interactionsPlugin from '@aws-amplify/amplify-category-interactions';

✗ const interactionsPlugin = require('@aws-amplify/amplify-category-interactions');

ESM only; TypeScript ships types. Default export is the plugin instance.

InteractionsResourceManager

✓ import { InteractionsResourceManager } from '@aws-amplify/amplify-category-interactions';

Named export for resource management utilities.

type InteractionsConfig

✓ import type { InteractionsConfig } from '@aws-amplify/amplify-category-interactions';

✗ const { InteractionsConfig } = require('@aws-amplify/amplify-category-interactions');

Type-only import for TypeScript users; avoid runtime usage.

Shows how to add and push a Lex bot resource using the interactions plugin API.

import { addResource, pushResources } from '@aws-amplify/amplify-category-interactions'; import { $TSContext } from 'amplify-cli-core'; async function setupInteractions(context: $TSContext) { // Add a Lex bot resource await addResource(context, { name: 'myChatbot', botName: 'OrderFlowers', botAlias: '$LATEST', sessionTimeout: 5, // Additional config }); // Push resources to cloud await pushResources(context); }

Debug

Known issues

breakingv4 dropped support for Node.js 12 and earlier.

fix

Upgrade to Node.js 14 or later.

affects: >=4.0.0

breakingv3 migrated from AWS SDK v2 to v3 for Lex runtime calls.

fix

Update any custom Lex client code to use @aws-sdk/client-lex-runtime-service.

affects: >=3.0.0 <4.0.0

deprecatedThe `interactions add` command's `--slots` parameter is deprecated in favor of `--intent` object.

fix

Use `--intent '{"name":"IntentName","slots":{}}'` instead.

affects: >=2.0.0

gotchaPlugin must be installed after Amplify CLI or the `amplify interactions` commands won't be recognized.

fix

Run `npm install -g @aws-amplify/amplify-category-interactions` after installing `@aws-amplify/cli`.

affects: >=1.0.0

gotchaResource names must be alphanumeric and unique within a project; collisions cause silent overwrites.

fix

Use `amplify interactions status` to list existing resources before adding.

affects: >=1.0.0

deprecatedThe `amplify interactions configure` command has been removed in v3.0.0.

fix

Use `amplify interactions update` to modify existing resources.

affects: >=3.0.0

Errors

Common errors & fixes

Cannot find module '@aws-amplify/amplify-category-interactions'

Plugin not installed globally or not linked in the project.

fix

Run `npm install -g @aws-amplify/amplify-category-interactions`.

amplify interactions add only supports Lex bots, not any other service

Misunderstanding of what the plugin does.

fix

Use `amplify interactions add` only for Amazon Lex resources.

Resource 'myBot' already exists in this project.

Duplicate resource name.

fix

Use `amplify interactions update` to modify existing resource or remove first.

Invalid bot alias: $LATEST is not allowed for session timeout > 0

Lex requires a specific alias version for persistent sessions.

fix

Use a numeric alias version (e.g., '1') or create an alias in the Lex console.

Upgrade

Version history

4.3.2latest on npm

Audit

Dependencies

amplify-clirequiredCore Amplify CLI required to use this plugin

@aws-amplify/amplify-category-interactionsrequiredPlugin package name for interactions

Agent activity

43 hits · last 30 days

node

Perplexity

OpenAI (training)

Resources

githubhttps://github.com/aws-amplify/amplify-cli ↗

packagehttps://www.npmjs.com/package/amplify-category-interactions ↗

homepagehttps://aws.amazon.com/amplify/ ↗