@aws-sdk/client-chatbot

Description

AWS SDK for JavaScript Chatbot Client for Node.js, Browser and React Native.

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.

Installing

To install this package, simply type add or install @aws-sdk/client-chatbot
using your favorite package manager:
- npm install @aws-sdk/client-chatbot
- yarn add @aws-sdk/client-chatbot
- pnpm add @aws-sdk/client-chatbot

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ChatbotClient and
the commands you need, for example ListCustomActionsCommand:

``js
// ES5 example
const { ChatbotClient, ListCustomActionsCommand } = require("@aws-sdk/client-chatbot");
`

`ts
// ES6+ example
import { ChatbotClient, ListCustomActionsCommand } from "@aws-sdk/client-chatbot";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new ChatbotClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListCustomActionsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-chatbot";
const client = new AWS.Chatbot({ region: "REGION" });

// async/await.
try {
const data = await client.listCustomActions(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listCustomActions(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listCustomActions(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-chatbot` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AssociateToConfiguration

Command API Reference / Input / Output

CreateChimeWebhookConfiguration

Command API Reference / Input / Output

CreateCustomAction

Command API Reference / Input / Output

CreateMicrosoftTeamsChannelConfiguration

Command API Reference / Input / Output

CreateSlackChannelConfiguration

Command API Reference / Input / Output

DeleteChimeWebhookConfiguration

Command API Reference / Input / Output

DeleteCustomAction

Command API Reference / Input / Output

DeleteMicrosoftTeamsChannelConfiguration

Command API Reference / Input / Output

DeleteMicrosoftTeamsConfiguredTeam

Command API Reference / Input / Output

DeleteMicrosoftTeamsUserIdentity

Command API Reference / Input / Output

DeleteSlackChannelConfiguration

Command API Reference / Input / Output

DeleteSlackUserIdentity

Command API Reference / Input / Output

DeleteSlackWorkspaceAuthorization

Command API Reference / Input / Output

DescribeChimeWebhookConfigurations

Command API Reference / Input / Output

DescribeSlackChannelConfigurations

Command API Reference / Input / Output

DescribeSlackUserIdentities

Command API Reference / Input / Output

DescribeSlackWorkspaces

Command API Reference / Input / Output

DisassociateFromConfiguration

Command API Reference / Input / Output

GetAccountPreferences

Command API Reference / Input / Output

GetCustomAction

Command API Reference / Input / Output

GetMicrosoftTeamsChannelConfiguration

Command API Reference / Input / Output

ListAssociations

Command API Reference / Input / Output

ListCustomActions

Command API Reference / Input / Output

ListMicrosoftTeamsChannelConfigurations

Command API Reference / Input / Output

ListMicrosoftTeamsConfiguredTeams

Command API Reference / Input / Output

ListMicrosoftTeamsUserIdentities

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccountPreferences

Command API Reference / Input / Output

UpdateChimeWebhookConfiguration

Command API Reference / Input / Output

UpdateCustomAction

Command API Reference / Input / Output

UpdateMicrosoftTeamsChannelConfiguration

Command API Reference / Input / Output

UpdateSlackChannelConfiguration

Command API Reference / Input / Output