Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListBotLocales

Gets a list of locales for the specified bot.

Request Syntax


POST /bots/botId/botversions/botVersion/botlocales/ HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "operator": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "sortBy": { 
      "attribute": "string",
      "order": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

botId

The identifier of the bot to list locales for.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The version of the bot to list locales for.

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^(DRAFT|[0-9]+)$

Required: Yes

Request Body

The request accepts the following data in JSON format.

filters

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.

Type: Array of BotLocaleFilter objects

Array Members: Fixed number of 1 item.

Required: No

maxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

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.

Type: String

Required: No

sortBy

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

Type: BotLocaleSortBy object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "botLocaleSummaries": [ 
      { 
         "botLocaleStatus": "string",
         "description": "string",
         "lastBuildSubmittedDateTime": number,
         "lastUpdatedDateTime": number,
         "localeId": "string",
         "localeName": "string"
      }
   ],
   "botVersion": "string",
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot to list locales for.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botLocaleSummaries

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.

Type: Array of BotLocaleSummary objects

botVersion

The version of the bot.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^(DRAFT|[0-9]+)$

nextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400