---
title: "POST /bots/{botId}/botversions/{botVersion}/botlocales/"
method: POST
path: "/bots/{botId}/botversions/{botVersion}/botlocales/"
---

# POST /bots/{botId}/botversions/{botVersion}/botlocales/

`POST /bots/{botId}/botversions/{botVersion}/botlocales/`

Gets a list of locales for the specified bot.

## Path parameters

- `botId` string, required
- `botVersion` string, required

## Request body

- object
  - `sortBy` object — Specifies attributes for sorting a list of bot locales.
    - `attribute` 'BotLocaleName' — The bot locale attribute to sort by.
    - `order` 'Ascending' | 'Descending' — Specifies whether to sort the bot locales in ascending or descending order.
  - `filters` BotLocaleFilter[] — 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.
    - `name` 'BotLocaleName', required — The name of the field to filter the list of bots.
    - `values` FilterValue[], required — The value to use for filtering the list of bots.
    - `operator` 'CO' | 'EQ', required — The operator to use for the filter. Specify <code>EQ</code> when the <code>ListBotLocales</code> operation should return only aliases that equal the specified value. Specify <code>CO</code> when the <code>ListBotLocales</code> 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 <code>ListBotLocales</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token as the <code>nextToken</code> parameter to return the next page of results.

## Response `200`

Success

- ListBotLocalesResponse
  - `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 <code>ListBotLocales</code> operation. If the <code>nextToken</code> field is present, you send the contents as the <code>nextToken</code> parameter of a <code>ListBotLocales</code> operation request to get the next page of results.
  - `botLocaleSummaries` BotLocaleSummary[] — Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more locales available, the <code>nextToken</code> field contains a token to get the next page of results.
    - `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` 'Creating' | 'Building' | 'Built' | 'ReadyExpressTesting' | 'Failed' | 'Deleting' | 'NotBuilt' | 'Importing' | 'Processing' — The current status of the bot locale. When the status is <code>Built</code> the locale is ready for use.
    - `lastUpdatedDateTime` string, date-time — A timestamp of the date and time that the bot locale was last updated.
    - `lastBuildSubmittedDateTime` string, date-time — A timestamp of the date and time that the bot locale was last built.

## Other responses

- `480` — ThrottlingException
- `481` — ServiceQuotaExceededException
- `482` — ValidationException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/lexv2-models.md) · [All operations](https://skmtc.net/aws/apis/lexv2-models/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/lexv2-models/versions/6997ba482d72/schema)