AWS API Changes

2023/06/22 - Amazon Chime SDK Identity - 3 updated api methods

Changes AppInstanceBots can be configured to be invoked or not using the Target or the CHIME.mentions attribute for ChannelMessages

CreateAppInstanceBot (updated)

Link ¶
Changes (request)

{'Configuration': {'Lex': {'InvokedBy': {'StandardMessages': 'AUTO | ALL | '
                                                             'MENTIONS | NONE',
                                         'TargetedMessages': 'ALL | NONE'}}}}

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

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'
        }
    }
)

type AppInstanceArn:

string

param AppInstanceArn:

[REQUIRED]

The ARN of the AppInstance request.

type Name:

string

param Name:

The user's name.

type Metadata:

string

param Metadata:

The request metadata. Limited to a 1KB string in UTF-8.

type ClientRequestToken:

string

param ClientRequestToken:

[REQUIRED]

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

This field is autopopulated if not provided.

type Tags:

list

param Tags:

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.

type Configuration:

dict

param Configuration:

[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.

rtype:

dict

returns:

Response Syntax

{
    'AppInstanceBotArn': 'string'
}

Response Structure

(dict) --
- AppInstanceBotArn (string) --
  
  The ARN of the AppinstanceBot.

DescribeAppInstanceBot (updated)

Link ¶
Changes (response)

{'AppInstanceBot': {'Configuration': {'Lex': {'InvokedBy': {'StandardMessages': 'AUTO '
                                                                                '| '
                                                                                'ALL '
                                                                                '| '
                                                                                'MENTIONS '
                                                                                '| '
                                                                                'NONE',
                                                            'TargetedMessages': 'ALL '
                                                                                '| '
                                                                                'NONE'}}}}}

The AppInstanceBot's information.

See also: AWS API Documentation

Request Syntax

client.describe_app_instance_bot(
    AppInstanceBotArn='string'
)

type AppInstanceBotArn:

string

param AppInstanceBotArn:

[REQUIRED]

The ARN of the AppInstanceBot.

rtype:

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.

UpdateAppInstanceBot (updated)

Link ¶
Changes (request)

{'Configuration': {'Lex': {'InvokedBy': {'StandardMessages': 'AUTO | ALL | '
                                                             'MENTIONS | NONE',
                                         'TargetedMessages': 'ALL | NONE'},
                           'LexBotAliasArn': 'string',
                           'LocaleId': 'string',
                           'RespondsTo': 'STANDARD_MESSAGES',
                           'WelcomeIntent': 'string'}}}

Updates the name and metadata of an AppInstanceBot.

See also: AWS API Documentation

Request Syntax

client.update_app_instance_bot(
    AppInstanceBotArn='string',
    Name='string',
    Metadata='string',
    Configuration={
        'Lex': {
            'RespondsTo': 'STANDARD_MESSAGES',
            'InvokedBy': {
                'StandardMessages': 'AUTO'|'ALL'|'MENTIONS'|'NONE',
                'TargetedMessages': 'ALL'|'NONE'
            },
            'LexBotAliasArn': 'string',
            'LocaleId': 'string',
            'WelcomeIntent': 'string'
        }
    }
)

type AppInstanceBotArn:

string

param AppInstanceBotArn:

[REQUIRED]

The ARN of the AppInstanceBot.

type Name:

string

param Name:

[REQUIRED]

The name of the AppInstanceBot.

type Metadata:

string

param Metadata:

[REQUIRED]

The metadata of the AppInstanceBot.

type Configuration:

dict

param Configuration:

The configuration for the bot update.

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.

rtype:

dict

returns:

Response Syntax

{
    'AppInstanceBotArn': 'string'
}

Response Structure

(dict) --
- AppInstanceBotArn (string) --
  
  The ARN of the AppInstanceBot.