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

# GET /bots/{botId}/botaliases/{botAliasId}/

`GET /bots/{botId}/botaliases/{botAliasId}/`

Get information about a specific bot alias.

## Path parameters

- `botAliasId` string, required
- `botId` string, required

## Response `200`

Success

- DescribeBotAliasResponse
  - `botAliasId` string — The identifier of the bot alias.
  - `botAliasName` string — The name of the bot alias.
  - `description` string — The description of the bot alias.
  - `botVersion` string — The version of the bot associated with the bot alias.
  - `botAliasLocaleSettings` object — The locale settings that are unique to the alias.
  - `conversationLogSettings` object — Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
    - `textLogSettings` TextLogSetting[] — The Amazon CloudWatch Logs settings for logging text and metadata.
      - `enabled` boolean, required — Determines whether conversation logs should be stored for an alias.
      - `destination` TextLogDestination, required — Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
        - `cloudWatch` object, required — Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
          - `cloudWatchLogGroupArn` string, required — The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
          - `logPrefix` string, required — The prefix of the log stream name within the log group that you specified
    - `audioLogSettings` AudioLogSetting[] — The Amazon S3 settings for logging audio to an S3 bucket.
      - `enabled` boolean, required — Determines whether audio logging in enabled for the bot.
      - `destination` AudioLogDestination, required — The location of audio log files collected when conversation logging is enabled for a bot.
        - `s3Bucket` object, required — The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the <code>roleArn</code> parameter of the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html">CreateBot</a> operation must have permission to write to this bucket.
          - `kmsKeyArn` string — The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
          - `s3BucketArn` string, required — The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
          - `logPrefix` string, required — The S3 prefix to assign to audio log files.
  - `sentimentAnalysisSettings` SentimentAnalysisSettings — Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
    - `detectSentiment` boolean, required — Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
  - `botAliasHistoryEvents` BotAliasHistoryEvent[] — A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
    - `botVersion` string — The version of the bot that was used in the event.
    - `startDate` string, date-time — The date and time that the event started.
    - `endDate` string, date-time — The date and time that the event ended.
  - `botAliasStatus` 'Creating' | 'Available' | 'Deleting' | 'Failed' — The current status of the alias. When the alias is <code>Available</code>, the alias is ready for use with your bot.
  - `botId` string — The identifier of the bot associated with the bot alias.
  - `creationDateTime` string, date-time — A timestamp of the date and time that the alias was created.
  - `lastUpdatedDateTime` string, date-time — A timestamp of the date and time that the alias was last updated.
  - `parentBotNetworks` ParentBotNetwork[] — A list of the networks to which the bot alias you described belongs.
    - `botId` string, required — The identifier of the network of bots assigned by Amazon Lex.
    - `botVersion` string, required — The version of the network of bots.

## Other responses

- `480` — ThrottlingException
- `481` — ServiceQuotaExceededException
- `482` — ValidationException
- `483` — ResourceNotFoundException
- `484` — 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)