LexModelsV2 / Client / list_bot_locales

list_bot_locales#

LexModelsV2.Client.list_bot_locales(**kwargs)#

Gets a list of locales for the specified bot.

See also: AWS API Documentation

Request Syntax

response = client.list_bot_locales(
    botId='string',
    botVersion='string',
    sortBy={
        'attribute': 'BotLocaleName',
        'order': 'Ascending'|'Descending'
    },
    filters=[
        {
            'name': 'BotLocaleName',
            'values': [
                'string',
            ],
            'operator': 'CO'|'EQ'
        },
    ],
    maxResults=123,
    nextToken='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The identifier of the bot to list locales for.

  • botVersion (string) –

    [REQUIRED]

    The version of the bot to list locales for.

  • sortBy (dict) –

    Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

    • attribute (string) – [REQUIRED]

      The bot locale attribute to sort by.

    • order (string) – [REQUIRED]

      Specifies whether to sort the bot locales in ascending or descending order.

  • filters (list) –

    Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.

    • (dict) –

      Filters responses returned by the ListBotLocales operation.

      • name (string) – [REQUIRED]

        The name of the field to filter the list of bots.

      • values (list) – [REQUIRED]

        The value to use for filtering the list of bots.

        • (string) –

      • operator (string) – [REQUIRED]

        The operator to use for the filter. Specify EQ when the ListBotLocales operation should return only aliases that equal the specified value. Specify CO when the ListBotLocales operation should return aliases that contain the specified value.

  • maxResults (integer) – The maximum number of aliases 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 ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'nextToken': 'string',
    'botLocaleSummaries': [
        {
            'localeId': 'string',
            'localeName': 'string',
            'description': 'string',
            'botLocaleStatus': 'Creating'|'Building'|'Built'|'ReadyExpressTesting'|'Failed'|'Deleting'|'NotBuilt'|'Importing'|'Processing',
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'lastBuildSubmittedDateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • botId (string) –

      The identifier of the bot to list locales for.

    • botVersion (string) –

      The version of the bot.

    • nextToken (string) –

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

    • botLocaleSummaries (list) –

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

      • (dict) –

        Summary information about bot locales returned by the ListBotLocales operation.

        • localeId (string) –

          The language and locale of the bot locale.

        • localeName (string) –

          The name of the bot locale.

        • description (string) –

          The description of the bot locale.

        • botLocaleStatus (string) –

          The current status of the bot locale. When the status is Built the locale is ready for use.

        • lastUpdatedDateTime (datetime) –

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

        • lastBuildSubmittedDateTime (datetime) –

          A timestamp of the date and time that the bot locale was last built.

Exceptions