Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442228254.5 KB

Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the lex:GetBotChannelAssociation action.

get/bots/{botName}/aliases/{aliasName}/channels/{name}

Path parameters

namestring required

The name of the association between the bot and the channel. The name is case sensitive.

botNamestring required

The name of the Amazon Lex bot.

aliasNamestring required

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

Response

Success

namestring

The name of the association between the bot and the channel.

descriptionstring

A description of the association between the bot and the channel.

botAliasstring

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

botNamestring

The name of the Amazon Lex bot.

createdDatestring date-time

The date that the association between the bot and the channel was created.

type'Facebook' | 'Slack' | 'Twilio-Sms' | 'Kik'

The type of the messaging platform.

botConfigurationobject

Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

status'IN_PROGRESS' | 'CREATED' | 'FAILED'
<p>The status of the bot channel. </p> <ul> <li> <p> <code>CREATED</code> - The channel has been created and is ready for use.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Channel creation is in progress.</p> </li> <li> <p> <code>FAILED</code> - There was an error creating the channel. For information about the reason for the failure, see the <code>failureReason</code> field.</p> </li> </ul>
failureReasonstring

If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to create the association.