AWS Chatbot¶

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:

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.

Usage¶

chatbot(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- chatbot(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`associate_to_configuration`	Links a resource (for example, a custom action) to a channel configuration
`create_chime_webhook_configuration`	Creates an AWS Chatbot configuration for Amazon Chime
`create_custom_action`	Creates a custom action that can be invoked as an alias or as a button on a notification
`create_microsoft_teams_channel_configuration`	Creates an AWS Chatbot configuration for Microsoft Teams
`create_slack_channel_configuration`	Creates an AWS Chatbot confugration for Slack
`delete_chime_webhook_configuration`	Deletes a Amazon Chime webhook configuration for AWS Chatbot
`delete_custom_action`	Deletes a custom action
`delete_microsoft_teams_channel_configuration`	Deletes a Microsoft Teams channel configuration for AWS Chatbot
`delete_microsoft_teams_configured_team`	Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team
`delete_microsoft_teams_user_identity`	Identifes a user level permission for a channel configuration
`delete_slack_channel_configuration`	Deletes a Slack channel configuration for AWS Chatbot
`delete_slack_user_identity`	Deletes a user level permission for a Slack channel configuration
`delete_slack_workspace_authorization`	Deletes the Slack workspace authorization that allows channels to be configured in that workspace
`describe_chime_webhook_configurations`	Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn
`describe_slack_channel_configurations`	Lists Slack channel configurations optionally filtered by ChatConfigurationArn
`describe_slack_user_identities`	Lists all Slack user identities with a mapped role
`describe_slack_workspaces`	List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot
`disassociate_from_configuration`	Unlink a resource, for example a custom action, from a channel configuration
`get_account_preferences`	Returns AWS Chatbot account preferences
`get_custom_action`	Returns a custom action
`get_microsoft_teams_channel_configuration`	Returns a Microsoft Teams channel configuration in an AWS account
`list_associations`	Lists resources associated with a channel configuration
`list_custom_actions`	Lists custom actions defined in this account
`list_microsoft_teams_channel_configurations`	Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account
`list_microsoft_teams_configured_teams`	Lists all authorized Microsoft Teams for an AWS Account
`list_microsoft_teams_user_identities`	A list all Microsoft Teams user identities with a mapped role
`list_tags_for_resource`	Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify
`tag_resource`	Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN)
`untag_resource`	Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN)
`update_account_preferences`	Updates AWS Chatbot account preferences
`update_chime_webhook_configuration`	Updates a Amazon Chime webhook configuration
`update_custom_action`	Updates a custom action
`update_microsoft_teams_channel_configuration`	Updates an Microsoft Teams channel configuration
`update_slack_channel_configuration`	Updates a Slack channel configuration

Examples¶

svc <- chatbot()
svc$associate_to_configuration(
  Foo = 123
)