LexModelsV2 / Client / list_bot_resource_generations

list_bot_resource_generations#

LexModelsV2.Client.list_bot_resource_generations(**kwargs)#

Lists the generation requests made for a bot locale.

See also: AWS API Documentation

Request Syntax

response = client.list_bot_resource_generations(
    botId='string',
    botVersion='string',
    localeId='string',
    sortBy={
        'attribute': 'creationStartTime'|'lastUpdatedTime',
        'order': 'Ascending'|'Descending'
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The unique identifier of the bot whose generation requests you want to view.

  • botVersion (string) –

    [REQUIRED]

    The version of the bot whose generation requests you want to view.

  • localeId (string) –

    [REQUIRED]

    The locale of the bot whose generation requests you want to view.

  • sortBy (dict) –

    An object containing information about the attribute and the method by which to sort the results

    • attribute (string) – [REQUIRED]

      The attribute by which to sort the generation request information. You can sort by the following attributes.

      • creationStartTime – The time at which the generation request was created.

      • lastUpdatedTime – The time at which the generation request was last updated.

    • order (string) – [REQUIRED]

      The order by which to sort the generation request information.

  • maxResults (integer) – The maximum number of results to return in the response.

  • nextToken (string) – If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • botId (string) –

      The unique identifier of the bot for which the generation requests were made.

    • botVersion (string) –

      The version of the bot for which the generation requests were made.

    • localeId (string) –

      The locale of the bot for which the generation requests were made.

    • generationSummaries (list) –

      A list of objects, each containing information about a generation request for the bot locale.

      • (dict) –

        Contains information about a generation request made for the bot locale.

        • generationId (string) –

          The unique identifier of the generation request.

        • generationStatus (string) –

          The status of the generation request.

        • creationDateTime (datetime) –

          The date and time at which the generation request was made.

        • lastUpdatedDateTime (datetime) –

          The date and time at which the generation request was last updated.

    • nextToken (string) –

      If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

Exceptions