LexModelsV2 / Client / describe_bot

describe_bot#

LexModelsV2.Client.describe_bot(**kwargs)#

Provides metadata information about a bot.

Request Syntax

response = client.describe_bot(
    botId='string'
)

Parameters:

botId (string) –

[REQUIRED]

The unique identifier of the bot to describe.

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'
        },
    ],
    'failureReasons': [
        'string',
    ]
}

Response Structure

(dict) –
- botId (string) –
  
  The unique identifier of the bot.
- botName (string) –
  
  The name of the bot.
- description (string) –
  
  The description of the bot.
- roleArn (string) –
  
  The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
- dataPrivacy (dict) –
  
  Settings for managing data privacy of the bot and its conversations with users.
  - 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 maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
- botStatus (string) –
  
  The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
- 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 described.
- botMembers (list) –
  
  The list of bots in the network that was described.
  - (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.
- failureReasons (list) –
  
  If the botStatus is Failed, this contains a list of reasons that the bot couldn’t be built.
  - (string) –

Exceptions

LexModelsV2.Client.exceptions.ThrottlingException
LexModelsV2.Client.exceptions.ServiceQuotaExceededException
LexModelsV2.Client.exceptions.ValidationException
LexModelsV2.Client.exceptions.ResourceNotFoundException
LexModelsV2.Client.exceptions.InternalServerException