BotChannelAssociation ¶

class BotChannelAssociation(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 text description of the association you are creating. </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 to which this association is being made. </p> <note> <p>Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.</p> </note>"""
    created_date: NotRequired[
        "capo_lex_model_building_service.types.timestamp.Timestamp"
    ]
    """<p>The date that the association between the Amazon Lex bot and the channel was created. </p>"""
    type: NotRequired["capo_lex_model_building_service.types.channel_type.ChannelType"]
    """<p>Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.</p>"""
    bot_configuration: NotRequired[
        "capo_lex_model_building_service.types.channel_configuration_map.ChannelConfigurationMap"
    ]
    """<p>Provides information necessary to communicate with the messaging platform. </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>"""