ChimeSDKIdentity / Client / describe_app_instance_bot

describe_app_instance_bot#

ChimeSDKIdentity.Client.describe_app_instance_bot(**kwargs)#

The AppInstanceBot's information.

Request Syntax

response = client.describe_app_instance_bot(
    AppInstanceBotArn='string'
)

Parameters:

AppInstanceBotArn (string) –

[REQUIRED]

The ARN of the AppInstanceBot.

Return type:

dict

Returns:

Response Syntax

{
    'AppInstanceBot': {
        'AppInstanceBotArn': 'string',
        'Name': 'string',
        'Configuration': {
            'Lex': {
                'RespondsTo': 'STANDARD_MESSAGES',
                'InvokedBy': {
                    'StandardMessages': 'AUTO'|'ALL'|'MENTIONS'|'NONE',
                    'TargetedMessages': 'ALL'|'NONE'
                },
                'LexBotAliasArn': 'string',
                'LocaleId': 'string',
                'WelcomeIntent': 'string'
            }
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'Metadata': 'string'
    }
}

Response Structure

(dict) –
- AppInstanceBot (dict) –
  
  The detials of the AppInstanceBot.
  - AppInstanceBotArn (string) –
    
    The ARN of the AppInstanceBot.
  - Name (string) –
    
    The name of the AppInstanceBot.
  - Configuration (dict) –
    
    The data processing instructions for an AppInstanceBot.
    - Lex (dict) –
      
      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) –
        
        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) –
        
        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) –
        
        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) –
        
        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.
  - CreatedTimestamp (datetime) –
    
    The time at which the AppInstanceBot was created.
  - LastUpdatedTimestamp (datetime) –
    
    The time at which the AppInstanceBot was last updated.
  - Metadata (string) –
    
    The metadata for an AppInstanceBot.

Exceptions

ChimeSDKIdentity.Client.exceptions.BadRequestException
ChimeSDKIdentity.Client.exceptions.ForbiddenException
ChimeSDKIdentity.Client.exceptions.ThrottledClientException
ChimeSDKIdentity.Client.exceptions.UnauthorizedClientException
ChimeSDKIdentity.Client.exceptions.NotFoundException
ChimeSDKIdentity.Client.exceptions.ServiceUnavailableException
ChimeSDKIdentity.Client.exceptions.ServiceFailureException