---
title: "POST /bots/{botId}/botaliases/"
method: POST
path: "/bots/{botId}/botaliases/"
---

# POST /bots/{botId}/botaliases/

`POST /bots/{botId}/botaliases/`

Gets a list of aliases for the specified bot.

## Path parameters

- `botId` string, required

## Query parameters

- `maxResults` string
- `nextToken` string

## Request body

- object
  - `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>ListBotAliases</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. Use that token in the <code>nextToken</code> parameter to return the next page of results.

## Response `200`

Success

- ListBotAliasesResponse
  - `botAliasSummaries` BotAliasSummary[] — Summary information for the bot aliases 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 aliases available, the <code>nextToken</code> field contains a token to get the next page of results.
    - `botAliasId` string — The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html">DescribeBotAlias</a> operation.
    - `botAliasName` string — The name of the bot alias.
    - `description` string — The description of the bot alias.
    - `botVersion` string — The version of the bot that the bot alias references.
    - `botAliasStatus` 'Creating' | 'Available' | 'Deleting' | 'Failed' — The current state of the bot alias. If the status is <code>Available</code>, the alias is ready for use.
    - `creationDateTime` string, date-time — A timestamp of the date and time that the bot alias was created.
    - `lastUpdatedDateTime` string, date-time — A timestamp of the date and time that the bot alias was last updated.
  - `nextToken` string — A token that indicates whether there are more results to return in a response to the <code>ListBotAliases</code> operation. If the <code>nextToken</code> field is present, you send the contents as the <code>nextToken</code> parameter of a <code>ListBotAliases</code> operation request to get the next page of results.
  - `botId` string — The identifier of the bot associated with the aliases.

## Other responses

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

---

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