aws-elixir

View Source AWS.Chatbot (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

associate_to_configuration(client, input, options \\ [])

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

create_chime_webhook_configuration(client, input, options \\ [])

Creates an AWS Chatbot configuration for Amazon Chime.

create_custom_action(client, input, options \\ [])

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

create_microsoft_teams_channel_configuration(client, input, options \\ [])

Creates an AWS Chatbot configuration for Microsoft Teams.

create_slack_channel_configuration(client, input, options \\ [])

Creates an AWS Chatbot confugration for Slack.

delete_chime_webhook_configuration(client, input, options \\ [])

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

delete_custom_action(client, input, options \\ [])

Deletes a custom action.

delete_microsoft_teams_channel_configuration(client, input, options \\ [])

Deletes a Microsoft Teams channel configuration for AWS Chatbot

delete_microsoft_teams_configured_team(client, input, options \\ [])

Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team.

delete_microsoft_teams_user_identity(client, input, options \\ [])

Identifes a user level permission for a channel configuration.

delete_slack_channel_configuration(client, input, options \\ [])

Deletes a Slack channel configuration for AWS Chatbot

delete_slack_user_identity(client, input, options \\ [])

Deletes a user level permission for a Slack channel configuration.

delete_slack_workspace_authorization(client, input, options \\ [])

Deletes the Slack workspace authorization that allows channels to be configured in that workspace.

describe_chime_webhook_configurations(client, input, options \\ [])

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

describe_slack_channel_configurations(client, input, options \\ [])

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

describe_slack_user_identities(client, input, options \\ [])

Lists all Slack user identities with a mapped role.

describe_slack_workspaces(client, input, options \\ [])

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

disassociate_from_configuration(client, input, options \\ [])

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

get_account_preferences(client, input, options \\ [])

Returns AWS Chatbot account preferences.

get_custom_action(client, input, options \\ [])

Returns a custom action.

get_microsoft_teams_channel_configuration(client, input, options \\ [])

Returns a Microsoft Teams channel configuration in an AWS account.

list_associations(client, input, options \\ [])

Lists resources associated with a channel configuration.

list_custom_actions(client, input, options \\ [])

Lists custom actions defined in this account.

list_microsoft_teams_channel_configurations(client, input, options \\ [])

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

list_microsoft_teams_configured_teams(client, input, options \\ [])

Lists all authorized Microsoft Teams for an AWS Account

list_microsoft_teams_user_identities(client, input, options \\ [])

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

list_tags_for_resource(client, input, options \\ [])

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.

metadata()
tag_resource(client, input, options \\ [])

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).

untag_resource(client, input, options \\ [])

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN).

update_account_preferences(client, input, options \\ [])

Updates AWS Chatbot account preferences.

update_chime_webhook_configuration(client, input, options \\ [])

Updates a Amazon Chime webhook configuration.

update_custom_action(client, input, options \\ [])

Updates a custom action.

update_microsoft_teams_channel_configuration(client, input, options \\ [])

Updates an Microsoft Teams channel configuration.

update_slack_channel_configuration(client, input, options \\ [])

Updates a Slack channel configuration.

Link to this section Functions

Link to this function

associate_to_configuration(client, input, options \\ [])

View Source

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

Link to this function

create_chime_webhook_configuration(client, input, options \\ [])

View Source

Creates an AWS Chatbot configuration for Amazon Chime.

Link to this function

create_custom_action(client, input, options \\ [])

View Source

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

Link to this function

create_microsoft_teams_channel_configuration(client, input, options \\ [])

View Source

Creates an AWS Chatbot configuration for Microsoft Teams.

Link to this function

create_slack_channel_configuration(client, input, options \\ [])

View Source

Creates an AWS Chatbot confugration for Slack.

Link to this function

delete_chime_webhook_configuration(client, input, options \\ [])

View Source

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

Link to this function

delete_custom_action(client, input, options \\ [])

View Source

Deletes a custom action.

Link to this function

delete_microsoft_teams_channel_configuration(client, input, options \\ [])

View Source

Deletes a Microsoft Teams channel configuration for AWS Chatbot

Link to this function

delete_microsoft_teams_configured_team(client, input, options \\ [])

View Source

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 to this function

delete_microsoft_teams_user_identity(client, input, options \\ [])

View Source

Identifes a user level permission for a channel configuration.

Link to this function

delete_slack_channel_configuration(client, input, options \\ [])

View Source

Deletes a Slack channel configuration for AWS Chatbot

Link to this function

delete_slack_user_identity(client, input, options \\ [])

View Source

Deletes a user level permission for a Slack channel configuration.

Link to this function

delete_slack_workspace_authorization(client, input, options \\ [])

View Source

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 to this function

describe_chime_webhook_configurations(client, input, options \\ [])

View Source

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

Link to this function

describe_slack_channel_configurations(client, input, options \\ [])

View Source

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

Link to this function

describe_slack_user_identities(client, input, options \\ [])

View Source

Lists all Slack user identities with a mapped role.

Link to this function

describe_slack_workspaces(client, input, options \\ [])

View Source

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

Link to this function

disassociate_from_configuration(client, input, options \\ [])

View Source

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

Link to this function

get_account_preferences(client, input, options \\ [])

View Source

Returns AWS Chatbot account preferences.

Link to this function

get_custom_action(client, input, options \\ [])

View Source

Returns a custom action.

Link to this function

get_microsoft_teams_channel_configuration(client, input, options \\ [])

View Source

Returns a Microsoft Teams channel configuration in an AWS account.

Link to this function

list_associations(client, input, options \\ [])

View Source

Lists resources associated with a channel configuration.

Link to this function

list_custom_actions(client, input, options \\ [])

View Source

Lists custom actions defined in this account.

Link to this function

list_microsoft_teams_channel_configurations(client, input, options \\ [])

View Source

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

Link to this function

list_microsoft_teams_configured_teams(client, input, options \\ [])

View Source

Lists all authorized Microsoft Teams for an AWS Account

Link to this function

list_microsoft_teams_user_identities(client, input, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

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 to this function

metadata()

View Source
Link to this function

tag_resource(client, input, options \\ [])

View Source

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 to this function

untag_resource(client, input, options \\ [])

View Source

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 to this function

update_account_preferences(client, input, options \\ [])

View Source

Updates AWS Chatbot account preferences.

Link to this function

update_chime_webhook_configuration(client, input, options \\ [])

View Source

Updates a Amazon Chime webhook configuration.

Link to this function

update_custom_action(client, input, options \\ [])

View Source

Updates a custom action.

Link to this function

update_microsoft_teams_channel_configuration(client, input, options \\ [])

View Source

Updates an Microsoft Teams channel configuration.

Link to this function

update_slack_channel_configuration(client, input, options \\ [])

View Source

Updates a Slack channel configuration.