get_bot_channel_association

LexModelBuildingService.Client.get_bot_channel_association(**kwargs)

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

This operation requires permissions for the lex:GetBotChannelAssociation action.

See also: AWS API Documentation

Request Syntax

response = client.get_bot_channel_association(
    name='string',
    botName='string',
    botAlias='string'
)

Parameters

• name (string) --

  [REQUIRED]

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

• botName (string) --

  [REQUIRED]

  The name of the Amazon Lex bot.

• botAlias (string) --

  [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'botAlias': 'string',
    'botName': 'string',
    'createdDate': datetime(2015, 1, 1),
    'type': 'Facebook'|'Slack'|'Twilio-Sms'|'Kik',
    'botConfiguration': {
        'string': 'string'
    },
    'status': 'IN_PROGRESS'|'CREATED'|'FAILED',
    'failureReason': 'string'
}

Response Structure

• (dict) --

  • name (string) --

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

  • description (string) --

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

  • botAlias (string) --

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

  • botName (string) --

    The name of the Amazon Lex bot.

  • createdDate (datetime) --

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

  • type (string) --

    The type of the messaging platform.

  • botConfiguration (dict) --

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

    • (string) --
      • (string) --

  • status (string) --

    The status of the bot channel.

    • CREATED - The channel has been created and is ready for use.
    • IN_PROGRESS - Channel creation is in progress.
    • FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.

  • failureReason (string) --

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

Exceptions

• LexModelBuildingService.Client.exceptions.NotFoundException
• LexModelBuildingService.Client.exceptions.LimitExceededException
• LexModelBuildingService.Client.exceptions.InternalFailureException
• LexModelBuildingService.Client.exceptions.BadRequestException