Skip to content

GetBotChannelAssociationResponse

Source code in docs_src/capo_lex_model_building_service/types/get_bot_channel_association_response.py
class GetBotChannelAssociationResponse(TypedDict, closed=True):
    name: NotRequired[
        "capo_lex_model_building_service.types.bot_channel_name.BotChannelName"
    ]
    """<p>The name of the association between the bot and the channel.</p>"""
    description: NotRequired[
        "capo_lex_model_building_service.types.description.Description"
    ]
    """<p>A description of the association between the bot and the channel.</p>"""
    bot_alias: NotRequired["capo_lex_model_building_service.types.alias_name.AliasName"]
    """<p>An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.</p>"""
    bot_name: NotRequired["capo_lex_model_building_service.types.bot_name.BotName"]
    """<p>The name of the Amazon Lex bot.</p>"""
    created_date: NotRequired[
        "capo_lex_model_building_service.types.timestamp.Timestamp"
    ]
    """<p>The date that the association between the bot and the channel was created.</p>"""
    type: NotRequired["capo_lex_model_building_service.types.channel_type.ChannelType"]
    """<p>The type of the messaging platform.</p>"""
    bot_configuration: NotRequired[
        "capo_lex_model_building_service.types.channel_configuration_map.ChannelConfigurationMap"
    ]
    """<p>Provides information that the messaging platform needs to communicate with the Amazon Lex bot.</p>"""
    status: NotRequired[
        "capo_lex_model_building_service.types.channel_status.ChannelStatus"
    ]
    """<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>"""
    failure_reason: NotRequired["capo_lex_model_building_service.types.string.String"]
    """<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to create the association.</p>"""

bot_alias instance-attribute

bot_alias: NotRequired[AliasName]

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

bot_configuration instance-attribute

bot_configuration: NotRequired[ChannelConfigurationMap]

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

bot_name instance-attribute

bot_name: NotRequired[BotName]

The name of the Amazon Lex bot.

created_date instance-attribute

created_date: NotRequired[Timestamp]

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

description instance-attribute

description: NotRequired[Description]

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

failure_reason instance-attribute

failure_reason: NotRequired[String]

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

name instance-attribute

name: NotRequired[BotChannelName]

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

status instance-attribute

status: NotRequired[ChannelStatus]

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.

type instance-attribute

type: NotRequired[ChannelType]

The type of the messaging platform.