GET

/bots/{botName}/aliases/{aliasName}/channels/

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

<p> Returns a list of all of the channels associated with the specified bot. </p> <p>The <code>GetBotChannelAssociations</code> operation requires permissions for the <code>lex:GetBotChannelAssociations</code> action.</p>

Access Token Required: API Key

Path Parameters

botNamestringrequired

The name of the Amazon Lex bot in the association.

aliasNamestringrequired

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

Query Params

nextTokenstring

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

maxResultsinteger

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

nameContainsstring

Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use a hyphen ("-") as the <code>nameContains</code> parameter.

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/{aliasName}/channels/' \
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