Skip to content

Get Bot Channel Associations

lexmodelbuildingservice_get_bot_channel_associations R Documentation

Returns a list of all of the channels associated with the specified bot

Description

Returns a list of all of the channels associated with the specified bot.

The get_bot_channel_associations operation requires permissions for the lex:GetBotChannelAssociations action.

Usage

lexmodelbuildingservice_get_bot_channel_associations(botName, botAlias,
  nextToken, maxResults, nameContains)

Arguments

botName

[required] The name of the Amazon Lex bot in the association.

botAlias

[required] An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

nextToken

A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

maxResults

The maximum number of associations to return in the response. The default is 50.

nameContains

Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the nameContains parameter.

Value

A list with the following syntax: 

list(
  botChannelAssociations = list(
    list(
      name = "string",
      description = "string",
      botAlias = "string",
      botName = "string",
      createdDate = as.POSIXct(
        "2015-01-01"
      ),
      type = "Facebook"|"Slack"|"Twilio-Sms"|"Kik",
      botConfiguration = list(
        "string"
      ),
      status = "IN_PROGRESS"|"CREATED"|"FAILED",
      failureReason = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$get_bot_channel_associations(
  botName = "string",
  botAlias = "string",
  nextToken = "string",
  maxResults = 123,
  nameContains = "string"
)