AWS.Chatbot — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Chatbot

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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:

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.

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

Sending a Request Using Chatbot

var chatbot = new AWS.Chatbot();
chatbot.createChimeWebhookConfiguration(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Chatbot object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var chatbot = new AWS.Chatbot({apiVersion: '2017-10-11'});

You can also set the API version globally in AWS.config.apiVersions using the chatbot service identifier:

AWS.config.apiVersions = {
  chatbot: '2017-10-11',
  // other service API versions
};

var chatbot = new AWS.Chatbot();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Chatbot(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request

Creates an AWS Chatbot configuration for Amazon Chime.

createMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Creates an AWS Chatbot configuration for Microsoft Teams.

createSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Creates an AWS Chatbot confugration for Slack.

deleteChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

deleteMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a Microsoft Teams channel configuration for AWS Chatbot

deleteMicrosoftTeamsConfiguredTeam(params = {}, callback) ⇒ AWS.Request

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.

deleteMicrosoftTeamsUserIdentity(params = {}, callback) ⇒ AWS.Request

Identifes a user level permission for a channel configuration.

deleteSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a Slack channel configuration for AWS Chatbot

deleteSlackUserIdentity(params = {}, callback) ⇒ AWS.Request

Deletes a user level permission for a Slack channel configuration.

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.

describeChimeWebhookConfigurations(params = {}, callback) ⇒ AWS.Request

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

describeSlackChannelConfigurations(params = {}, callback) ⇒ AWS.Request

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

describeSlackUserIdentities(params = {}, callback) ⇒ AWS.Request

Lists all Slack user identities with a mapped role.

describeSlackWorkspaces(params = {}, callback) ⇒ AWS.Request

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

getAccountPreferences(params = {}, callback) ⇒ AWS.Request

Returns AWS Chatbot account preferences.

getMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Returns a Microsoft Teams channel configuration in an AWS account.

listMicrosoftTeamsChannelConfigurations(params = {}, callback) ⇒ AWS.Request

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

listMicrosoftTeamsConfiguredTeams(params = {}, callback) ⇒ AWS.Request

Lists all authorized Microsoft Teams for an AWS Account

listMicrosoftTeamsUserIdentities(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

tagResource(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

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

updateAccountPreferences(params = {}, callback) ⇒ AWS.Request

Updates AWS Chatbot account preferences.

updateChimeWebhookConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a Amazon Chime webhook configuration.

updateMicrosoftTeamsChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Updates an Microsoft Teams channel configuration.

updateSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a Slack channel configuration.