ChatbotClient

The AWS Chatbot API Reference provides descriptions, API request parameters, and the XML response for each of the AWS Chatbot API actions.

AWS Chatbot APIs are currently available in the following Regions:

  • US East (Ohio) - us-east-2

  • US West (Oregon) - us-west-2

  • Asia Pacific (Singapore) - ap-southeast-1

  • Europe (Ireland) - eu-west-1

The AWS Chatbot console can only be used in US East (Ohio). Your configuration data however, is stored in each of the relevant available Regions.

Your AWS CloudTrail events are logged in whatever Region you call from, not US East (N. Virginia) by default.

Installation

NPM
npm install @aws-sdk/client-chatbot
Yarn
yarn add @aws-sdk/client-chatbot
pnpm
pnpm add @aws-sdk/client-chatbot

ChatbotClient Operations

Command
Summary
AssociateToConfigurationCommand

Links a resource (for example, a custom action) to a channel configuration.

CreateChimeWebhookConfigurationCommand

Creates an AWS Chatbot configuration for Amazon Chime.

CreateCustomActionCommand

Creates a custom action that can be invoked as an alias or as a button on a notification.

CreateMicrosoftTeamsChannelConfigurationCommand

Creates an AWS Chatbot configuration for Microsoft Teams.

CreateSlackChannelConfigurationCommand

Creates an AWS Chatbot confugration for Slack.

DeleteChimeWebhookConfigurationCommand

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

DeleteCustomActionCommand

Deletes a custom action.

DeleteMicrosoftTeamsChannelConfigurationCommand

Deletes a Microsoft Teams channel configuration for AWS Chatbot

DeleteMicrosoftTeamsConfiguredTeamCommand

Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.

DeleteMicrosoftTeamsUserIdentityCommand

Identifes a user level permission for a channel configuration.

DeleteSlackChannelConfigurationCommand

Deletes a Slack channel configuration for AWS Chatbot

DeleteSlackUserIdentityCommand

Deletes a user level permission for a Slack channel configuration.

DeleteSlackWorkspaceAuthorizationCommand

Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.

DescribeChimeWebhookConfigurationsCommand

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

DescribeSlackChannelConfigurationsCommand

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

DescribeSlackUserIdentitiesCommand

Lists all Slack user identities with a mapped role.

DescribeSlackWorkspacesCommand

List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.

DisassociateFromConfigurationCommand

Unlink a resource, for example a custom action, from a channel configuration.

GetAccountPreferencesCommand

Returns AWS Chatbot account preferences.

GetCustomActionCommand

Returns a custom action.

GetMicrosoftTeamsChannelConfigurationCommand

Returns a Microsoft Teams channel configuration in an AWS account.

ListAssociationsCommand

Lists resources associated with a channel configuration.

ListCustomActionsCommand

Lists custom actions defined in this account.

ListMicrosoftTeamsChannelConfigurationsCommand

Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.

ListMicrosoftTeamsConfiguredTeamsCommand

Lists all authorized Microsoft Teams for an AWS Account

ListMicrosoftTeamsUserIdentitiesCommand

A list all Microsoft Teams user identities with a mapped role.

ListTagsForResourceCommand

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

TagResourceCommand

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

UntagResourceCommand

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

UpdateAccountPreferencesCommand

Updates AWS Chatbot account preferences.

UpdateChimeWebhookConfigurationCommand

Updates a Amazon Chime webhook configuration.

UpdateCustomActionCommand

Updates a custom action.

UpdateMicrosoftTeamsChannelConfigurationCommand

Updates an Microsoft Teams channel configuration.

UpdateSlackChannelConfigurationCommand

Updates a Slack channel configuration.

ChatbotClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: ChatbotClientConfig