LexModelsV2 / Client / list_bot_recommendations

list_bot_recommendations#

LexModelsV2.Client.list_bot_recommendations(**kwargs)#

Get a list of bot recommendations that meet the specified criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_bot_recommendations(
    botId='string',
    botVersion='string',
    localeId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The unique identifier of the bot that contains the bot recommendation list.

  • botVersion (string) –

    [REQUIRED]

    The version of the bot that contains the bot recommendation list.

  • localeId (string) –

    [REQUIRED]

    The identifier of the language and locale of the bot recommendation list.

  • maxResults (integer) – The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

  • nextToken (string) – If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'botRecommendationSummaries': [
        {
            'botRecommendationStatus': 'Processing'|'Deleting'|'Deleted'|'Downloading'|'Updating'|'Available'|'Failed'|'Stopping'|'Stopped',
            'botRecommendationId': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • botId (string) –

      The unique identifier of the bot that contains the bot recommendation list.

    • botVersion (string) –

      The version of the bot that contains the bot recommendation list.

    • localeId (string) –

      The identifier of the language and locale of the bot recommendation list.

    • botRecommendationSummaries (list) –

      Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.

      • (dict) –

        A summary of the bot recommendation.

        • botRecommendationStatus (string) –

          The status of the bot recommendation.

          If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

        • botRecommendationId (string) –

          The unique identifier of the bot recommendation to be updated.

        • creationDateTime (datetime) –

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

        • lastUpdatedDateTime (datetime) –

          A timestamp of the date and time that the bot recommendation was last updated.

    • nextToken (string) –

      A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.

Exceptions