ChimeSDKIdentity / Client / create_app_instance_bot

create_app_instance_bot#

ChimeSDKIdentity.Client.create_app_instance_bot(**kwargs)#

Creates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.

See also: AWS API Documentation

Request Syntax

response = client.create_app_instance_bot(
    AppInstanceArn='string',
    Name='string',
    Metadata='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Configuration={
        'Lex': {
            'RespondsTo': 'STANDARD_MESSAGES',
            'InvokedBy': {
                'StandardMessages': 'AUTO'|'ALL'|'MENTIONS'|'NONE',
                'TargetedMessages': 'ALL'|'NONE'
            },
            'LexBotAliasArn': 'string',
            'LocaleId': 'string',
            'WelcomeIntent': 'string'
        }
    }
)
Parameters:

  • AppInstanceArn (string) –

    [REQUIRED]

    The ARN of the AppInstance request.

  • Name (string) – The user’s name.

  • Metadata (string) – The request metadata. Limited to a 1KB string in UTF-8.

  • ClientRequestToken (string) –

    [REQUIRED]

    The unique ID for the client making the request. Use different tokens for different AppInstanceBots.

    This field is autopopulated if not provided.

  • Tags (list) –

    The tags assigned to the AppInstanceBot.

    • (dict) –

      A tag object containing a key-value pair.

      • Key (string) – [REQUIRED]

        The key in a tag.

      • Value (string) – [REQUIRED]

        The value in a tag.

  • Configuration (dict) –

    [REQUIRED]

    Configuration information about the Amazon Lex V2 V2 bot.

    • Lex (dict) – [REQUIRED]

      The configuration for an Amazon Lex V2 bot.

      • RespondsTo (string) –

        Warning

        Deprecated. Use InvokedBy instead.

        Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

      • InvokedBy (dict) –

        Specifies the type of message that triggers a bot.

        • StandardMessages (string) – [REQUIRED]

          Sets standard messages as the bot trigger. For standard messages:

          • ALL: The bot processes all standard messages.

          • AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.

          • MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.

          • NONE: The bot processes no standard messages.

        • TargetedMessages (string) – [REQUIRED]

          Sets targeted messages as the bot trigger. For targeted messages:

          • ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.

          • NONE: The bot processes no targeted messages.

      • LexBotAliasArn (string) – [REQUIRED]

        The ARN of the Amazon Lex V2 bot’s alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

      • LocaleId (string) – [REQUIRED]

        Identifies the Amazon Lex V2 bot’s language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.

      • WelcomeIntent (string) –

        The name of the welcome intent configured in the Amazon Lex V2 bot.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceBotArn': 'string'
}

Response Structure

  • (dict) –

    • AppInstanceBotArn (string) –

      The ARN of the AppinstanceBot.

Exceptions