GET

/bots/{botName}/aliases/

http://models.lex.{region}.amazonaws.com/bots/{botName}/aliases/

Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the <code>lex:GetBotAliases</code> action.

Access Token Required: API Key

Path Parameters

botNamestringrequired

The name of the bot.

Query Params

nextTokenstring

A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

maxResultsinteger

The maximum number of aliases to return in the response. The default is 50. .

nameContainsstring

Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://models.lex.{region}.amazonaws.com/bots/{botName}/aliases/' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET