LexModelsV2 / Client / describe_bot_resource_generation

describe_bot_resource_generation

LexModelsV2.Client.describe_bot_resource_generation(**kwargs)

Returns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_bot_resource_generation(
    botId='string',
    botVersion='string',
    localeId='string',
    generationId='string'
)

Parameters:

• botId (string) –

  [REQUIRED]

  The unique identifier of the bot for which to return the generation details.

• botVersion (string) –

  [REQUIRED]

  The version of the bot for which to return the generation details.

• localeId (string) –

  [REQUIRED]

  The locale of the bot for which to return the generation details.

• generationId (string) –

  [REQUIRED]

  The unique identifier of the generation request for which to return the generation details.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'generationId': 'string',
    'failureReasons': [
        'string',
    ],
    'generationStatus': 'Failed'|'Complete'|'InProgress',
    'generationInputPrompt': 'string',
    'generatedBotLocaleUrl': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'modelArn': 'string',
    'lastUpdatedDateTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • botId (string) –

    The unique identifier of the bot for which the generation request was made.

  • botVersion (string) –

    The version of the bot for which the generation request was made.

  • localeId (string) –

    The locale of the bot for which the generation request was made.

  • generationId (string) –

    The generation ID for which to return the generation details.

  • failureReasons (list) –

    A list of reasons why the generation of bot resources through natural language description failed.

    • (string) –

  • generationStatus (string) –

    The status of the generation request.

  • generationInputPrompt (string) –

    The prompt used in the generation request.

  • generatedBotLocaleUrl (string) –

    The Amazon S3 location of the generated bot locale configuration.

  • creationDateTime (datetime) –

    The date and time at which the item was generated.

  • modelArn (string) –

    The ARN of the model used to generate the bot resources.

  • lastUpdatedDateTime (datetime) –

    The date and time at which the generated item was updated.

Exceptions

• LexModelsV2.Client.exceptions.ThrottlingException

• LexModelsV2.Client.exceptions.ValidationException

• LexModelsV2.Client.exceptions.ResourceNotFoundException

• LexModelsV2.Client.exceptions.InternalServerException