Amazon Web Services, Inc.

AWS Chatbot

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…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 34

Custom action

  • POSTCreate custom action/create-custom-actionCreates a custom action that can be invoked as an alias or as a button on a notification.
  • POSTDelete custom action/delete-custom-actionDeletes a custom action.
  • POSTGet custom action/get-custom-actionReturns a custom action.
  • POSTList custom actions/list-custom-actionsLists custom actions defined in this account.
  • POSTUpdate custom action/update-custom-actionUpdates a custom action.
  • POSTAssociate to configuration/associate-to-configurationLinks a resource (for example, a custom action) to a channel configuration.
  • POSTCreate chime webhook configuration/create-chime-webhook-configurationCreates an AWS Chatbot configuration for Amazon Chime.
  • POSTCreate microsoft teams channel configuration/create-ms-teams-channel-configurationCreates an AWS Chatbot configuration for Microsoft Teams.
  • POSTCreate slack channel configuration/create-slack-channel-configurationCreates an AWS Chatbot confugration for Slack.
  • POSTDelete chime webhook configuration/delete-chime-webhook-configurationDeletes a Amazon Chime webhook configuration for AWS Chatbot.
  • POSTDelete microsoft teams channel configuration/delete-ms-teams-channel-configurationDeletes a Microsoft Teams channel configuration for AWS Chatbot
  • POSTDelete microsoft teams configured team/delete-ms-teams-configured-teamsDeletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must…
  • POSTDelete microsoft teams user identity/delete-ms-teams-user-identityIdentifes a user level permission for a channel configuration.
  • POSTDelete slack channel configuration/delete-slack-channel-configurationDeletes a Slack channel configuration for AWS Chatbot
  • POSTDelete slack user identity/delete-slack-user-identityDeletes a user level permission for a Slack channel configuration.
  • POSTDelete slack workspace authorization/delete-slack-workspace-authorizationDeletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to…
  • POSTDescribe chime webhook configurations/describe-chime-webhook-configurationsLists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn
  • POSTDescribe slack channel configurations/describe-slack-channel-configurationsLists Slack channel configurations optionally filtered by ChatConfigurationArn
  • POSTDescribe slack user identities/describe-slack-user-identitiesLists all Slack user identities with a mapped role.
  • POSTDescribe slack workspaces/describe-slack-workspacesList all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.
  • POSTDisassociate from configuration/disassociate-from-configurationUnlink a resource, for example a custom action, from a channel configuration.
  • POSTGet account preferences/get-account-preferencesReturns AWS Chatbot account preferences.
  • POSTGet microsoft teams channel configuration/get-ms-teams-channel-configurationReturns a Microsoft Teams channel configuration in an AWS account.
  • POSTList associations/list-associationsLists resources associated with a channel configuration.
  • POSTList microsoft teams channel configurations/list-ms-teams-channel-configurationsLists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.
  • POSTList microsoft teams configured teams/list-ms-teams-configured-teamsLists all authorized Microsoft Teams for an AWS Account
  • POSTList microsoft teams user identities/list-ms-teams-user-identitiesA list all Microsoft Teams user identities with a mapped role.
  • POSTList tags for resource/list-tags-for-resourceLists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
  • POSTTag resource/tag-resourceAttaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
  • POSTUntag resource/untag-resourceDetaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
  • POSTUpdate account preferences/update-account-preferencesUpdates AWS Chatbot account preferences.
  • POSTUpdate chime webhook configuration/update-chime-webhook-configurationUpdates a Amazon Chime webhook configuration.
  • POSTUpdate microsoft teams channel configuration/update-ms-teams-channel-configurationUpdates an Microsoft Teams channel configuration.
  • POSTUpdate slack channel configuration/update-slack-channel-configurationUpdates a Slack channel configuration.

API details

Base URL
https://chatbot.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
34 operations on 34 pathsPOST 34
Main resources
Custom action 5
Description format
AWS Smithy model, API version 2017-10-11

How to test the AWS Chatbot in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Chatbot collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create custom action” (POST /create-custom-action), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Chatbot?

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… It is listed under Developer tools and has 34 endpoints.

Who publishes the AWS Chatbot?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Chatbot?

Requests go to https://chatbot.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Chatbot?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Chatbot have?

34 operations on 34 paths (34 POST). The largest groups are Custom action.

Is forking the AWS Chatbot free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.