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.

Properties

Link copied to clipboard
abstract override val config: ChatbotClient.Config

ChatbotClient's configuration

Functions

Link copied to clipboard

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

Link copied to clipboard

Creates an AWS Chatbot configuration for Amazon Chime.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Creates an AWS Chatbot confugration for Slack.

Link copied to clipboard

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

Link copied to clipboard

Deletes a custom action.

Link copied to clipboard

Deletes a Microsoft Teams channel configuration for AWS Chatbot

Link copied to clipboard

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.

Link copied to clipboard

Identifes a user level permission for a channel configuration.

Link copied to clipboard

Deletes a Slack channel configuration for AWS Chatbot

Link copied to clipboard

Deletes a user level permission for a Slack channel configuration.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun describeChimeWebhookConfigurations(input: DescribeChimeWebhookConfigurationsRequest = DescribeChimeWebhookConfigurationsRequest { }): DescribeChimeWebhookConfigurationsResponse

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

Link copied to clipboard
abstract suspend fun describeSlackChannelConfigurations(input: DescribeSlackChannelConfigurationsRequest = DescribeSlackChannelConfigurationsRequest { }): DescribeSlackChannelConfigurationsResponse

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

Link copied to clipboard
abstract suspend fun describeSlackUserIdentities(input: DescribeSlackUserIdentitiesRequest = DescribeSlackUserIdentitiesRequest { }): DescribeSlackUserIdentitiesResponse

Lists all Slack user identities with a mapped role.

Link copied to clipboard
abstract suspend fun describeSlackWorkspaces(input: DescribeSlackWorkspacesRequest = DescribeSlackWorkspacesRequest { }): DescribeSlackWorkspacesResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun getAccountPreferences(input: GetAccountPreferencesRequest = GetAccountPreferencesRequest { }): GetAccountPreferencesResponse

Returns AWS Chatbot account preferences.

Link copied to clipboard

Returns a custom action.

Link copied to clipboard

Returns a Microsoft Teams channel configuration in an AWS account.

Link copied to clipboard

Lists resources associated with a channel configuration.

Link copied to clipboard
abstract suspend fun listCustomActions(input: ListCustomActionsRequest = ListCustomActionsRequest { }): ListCustomActionsResponse

Lists custom actions defined in this account.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listMicrosoftTeamsConfiguredTeams(input: ListMicrosoftTeamsConfiguredTeamsRequest = ListMicrosoftTeamsConfiguredTeamsRequest { }): ListMicrosoftTeamsConfiguredTeamsResponse

Lists all authorized Microsoft Teams for an AWS Account

Link copied to clipboard
abstract suspend fun listMicrosoftTeamsUserIdentities(input: ListMicrosoftTeamsUserIdentitiesRequest = ListMicrosoftTeamsUserIdentitiesRequest { }): ListMicrosoftTeamsUserIdentitiesResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun updateAccountPreferences(input: UpdateAccountPreferencesRequest = UpdateAccountPreferencesRequest { }): UpdateAccountPreferencesResponse

Updates AWS Chatbot account preferences.

Link copied to clipboard

Updates a Amazon Chime webhook configuration.

Link copied to clipboard

Updates a custom action.

Link copied to clipboard

Inherited functions

Link copied to clipboard

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

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates an AWS Chatbot configuration for Amazon Chime.

Link copied to clipboard

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

Link copied to clipboard

Creates an AWS Chatbot configuration for Microsoft Teams.

Link copied to clipboard

Creates an AWS Chatbot confugration for Slack.

Link copied to clipboard

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

Link copied to clipboard

Deletes a custom action.

Link copied to clipboard

Deletes a Microsoft Teams channel configuration for AWS Chatbot

Link copied to clipboard

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.

Link copied to clipboard

Identifes a user level permission for a channel configuration.

Link copied to clipboard

Deletes a Slack channel configuration for AWS Chatbot

Link copied to clipboard

Deletes a user level permission for a Slack channel configuration.

Link copied to clipboard

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.

Link copied to clipboard

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

Link copied to clipboard

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

Link copied to clipboard

Lists all Slack user identities with a mapped role.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns AWS Chatbot account preferences.

Link copied to clipboard

Returns a custom action.

Link copied to clipboard

Returns a Microsoft Teams channel configuration in an AWS account.

Link copied to clipboard

Lists resources associated with a channel configuration.

Link copied to clipboard

Lists custom actions defined in this account.

Link copied to clipboard

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

Link copied to clipboard

Lists all authorized Microsoft Teams for an AWS Account

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun ChatbotClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

Link copied to clipboard

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

Link copied to clipboard

Updates AWS Chatbot account preferences.

Link copied to clipboard

Updates a Amazon Chime webhook configuration.

Link copied to clipboard

Updates a custom action.

Link copied to clipboard
Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.