LexModelsV2 / Client / describe_bot_version

describe_bot_version#

LexModelsV2.Client.describe_bot_version(**kwargs)#

Provides metadata about a version of a bot.

See also: AWS API Documentation

Request Syntax

response = client.describe_bot_version(
    botId='string',
    botVersion='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The identifier of the bot containing the version to return metadata for.

  • botVersion (string) –

    [REQUIRED]

    The version of the bot to return metadata for.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • botId (string) –

      The identifier of the bot that contains the version.

    • botName (string) –

      The name of the bot that contains the version.

    • botVersion (string) –

      The version of the bot that was described.

    • description (string) –

      The description specified for the bot.

    • roleArn (string) –

      The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

    • dataPrivacy (dict) –

      Data privacy settings for the bot version.

      • 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 number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

    • botStatus (string) –

      The current status of the bot. When the status is Available, the bot version is ready for use.

    • failureReasons (list) –

      If the botStatus is Failed, this contains a list of reasons that the version couldn’t be built.

      • (string) –

    • creationDateTime (datetime) –

      A timestamp of the date and time that the bot version was created.

    • parentBotNetworks (list) –

      A list of the networks to which the bot version you described belongs.

      • (dict) –

        A network of bots.

        • botId (string) –

          The identifier of the network of bots assigned by Amazon Lex.

        • botVersion (string) –

          The version of the network of bots.

    • botType (string) –

      The type of the bot in the version that was described.

    • botMembers (list) –

      The members of bot network in the version 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.

Exceptions