LexModelsV2 / Client / update_bot

update_bot#

LexModelsV2.Client.update_bot(**kwargs)#

Updates the configuration of an existing bot.

Request Syntax

response = client.update_bot(
    botId='string',
    botName='string',
    description='string',
    roleArn='string',
    dataPrivacy={
        'childDirected': True|False
    },
    idleSessionTTLInSeconds=123,
    botType='Bot'|'BotNetwork',
    botMembers=[
        {
            'botMemberId': 'string',
            'botMemberName': 'string',
            'botMemberAliasId': 'string',
            'botMemberAliasName': 'string',
            'botMemberVersion': 'string'
        },
    ]
)

Parameters:

botId (string) –
[REQUIRED]

The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
botName (string) –
[REQUIRED]

The new name of the bot. The name must be unique in the account that creates the bot.
description (string) – A description of the bot.
roleArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
dataPrivacy (dict) –
[REQUIRED]

Provides information on additional privacy protections Amazon Lex should use with the bot’s data.
- childDirected (boolean) – [REQUIRED]
  
  For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children’s Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
idleSessionTTLInSeconds (integer) –
[REQUIRED]

The time, in seconds, that Amazon Lex should keep information about a user’s conversation with the bot.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
botType (string) – The type of the bot to be updated.
botMembers (list) –
The list of bot members in the network associated with the update action.
- (dict) –
  
  A bot that is a member of a network of bots.
  - botMemberId (string) – [REQUIRED]
    
    The unique ID of a bot that is a member of this network of bots.
  - botMemberName (string) – [REQUIRED]
    
    The unique name of a bot that is a member of this network of bots.
  - botMemberAliasId (string) – [REQUIRED]
    
    The alias ID of a bot that is a member of this network of bots.
  - botMemberAliasName (string) – [REQUIRED]
    
    The alias name of a bot that is a member of this network of bots.
  - botMemberVersion (string) – [REQUIRED]
    
    The version of a bot that is a member of this network of bots.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botName': 'string',
    'description': 'string',
    'roleArn': 'string',
    'dataPrivacy': {
        'childDirected': True|False
    },
    'idleSessionTTLInSeconds': 123,
    'botStatus': 'Creating'|'Available'|'Inactive'|'Deleting'|'Failed'|'Versioning'|'Importing'|'Updating',
    'creationDateTime': datetime(2015, 1, 1),
    'lastUpdatedDateTime': datetime(2015, 1, 1),
    'botType': 'Bot'|'BotNetwork',
    'botMembers': [
        {
            'botMemberId': 'string',
            'botMemberName': 'string',
            'botMemberAliasId': 'string',
            'botMemberAliasName': 'string',
            'botMemberVersion': 'string'
        },
    ]
}

Response Structure

(dict) –
- botId (string) –
  
  The unique identifier of the bot that was updated.
- botName (string) –
  
  The name of the bot after the update.
- description (string) –
  
  The description of the bot after the update.
- roleArn (string) –
  
  The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
- dataPrivacy (dict) –
  
  The data privacy settings for the bot after the update.
  - childDirected (boolean) –
    
    For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children’s Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
- idleSessionTTLInSeconds (integer) –
  
  The session timeout, in seconds, for the bot after the update.
- botStatus (string) –
  
  Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.
- creationDateTime (datetime) –
  
  A timestamp of the date and time that the bot was created.
- lastUpdatedDateTime (datetime) –
  
  A timestamp of the date and time that the bot was last updated.
- botType (string) –
  
  The type of the bot that was updated.
- botMembers (list) –
  
  The list of bot members in the network that was updated.
  - (dict) –
    
    A bot that is a member of a network of bots.
    - botMemberId (string) –
      
      The unique ID of a bot that is a member of this network of bots.
    - botMemberName (string) –
      
      The unique name of a bot that is a member of this network of bots.
    - botMemberAliasId (string) –
      
      The alias ID of a bot that is a member of this network of bots.
    - botMemberAliasName (string) –
      
      The alias name of a bot that is a member of this network of bots.
    - botMemberVersion (string) –
      
      The version of a bot that is a member of this network of bots.

Exceptions

LexModelsV2.Client.exceptions.ThrottlingException
LexModelsV2.Client.exceptions.ServiceQuotaExceededException
LexModelsV2.Client.exceptions.ValidationException
LexModelsV2.Client.exceptions.PreconditionFailedException
LexModelsV2.Client.exceptions.ConflictException
LexModelsV2.Client.exceptions.InternalServerException