GetBotChannelAssociations - Amazon Lex V1

如果您使用的是 Amazon Lex V2,請參閱 Amazon Lex V2 指南

 

如果您使用的是 Amazon Lex V1,我們建議您將機器人升級到 Amazon Lex V2。我們不再向 V1 添加新功能,強烈建議所有新機器人使用 V2。

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

GetBotChannelAssociations

傳回與指定機器人相關聯的所有通道清單。

GetBotChannelAssociations業需要lex:GetBotChannelAssociations動作的權限。

請求語法

GET /bots/botName/aliases/aliasName/channels/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1

URI 請求參數

請求會使用下列 URI 參數。

aliasName

指向正在建立此關聯之特定 Amazon Lex 機器人版本的別名。

長度限制:長度下限為 1。長度上限為 100。

模式:^(-|^([A-Za-z]_?)+$)$

必要:是

botName

關聯中 Amazon Lex 機器人的名稱。

長度約束:最小長度為 2。長度上限為 50。

模式:^([A-Za-z]_?)+$

必要:是

maxResults

要在回應中傳回的關聯數目上限。預設值為 50。

有效範圍:最小值為 1。最大值為 50。

nameContains

要在通道關聯名稱中匹配的子字符串。如果其名稱的任何部分與子字符串匹配,則將返回關聯。例如,「xyz」符合「XYZ」和「阿布扎克」兩者。若要傳回所有機器人通道關聯,請使用連字號 (「-」) 作為nameContains參數。

長度限制:長度下限為 1。長度上限為 100。

模式:^([A-Za-z]_?)+$

nextToken

用於獲取關聯下一頁的分頁令牌。如果截斷對此呼叫的回應,Amazon Lex 會在回應中傳回分頁權杖。要獲取關聯的下一頁,請在下一個請求中指定分頁令牌。

請求主體

請求沒有請求主體。

回應語法

HTTP/1.1 200 Content-type: application/json { "botChannelAssociations": [ { "botAlias": "string", "botConfiguration": { "string" : "string" }, "botName": "string", "createdDate": number, "description": "string", "failureReason": "string", "name": "string", "status": "string", "type": "string" } ], "nextToken": "string" }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

botChannelAssociations

物件陣列 (每個關聯各一個),提供 Amazon Lex 機器人及其與通道關聯的相關資訊。

類型:BotChannelAssociation 物件陣列

nextToken

一個分頁令牌,用於獲取關聯的下一頁。如果截斷對此呼叫的回應,Amazon Lex 會在回應中傳回分頁權杖。要獲取關聯的下一頁,請在下一個請求中指定分頁令牌。

類型:字串

錯誤

BadRequestException

請求的格式不正確。例如,值無效或缺少必填欄位。請檢查欄位值,然後再試一次。

HTTP 狀態碼:400

InternalFailureException

發生內部 Amazon Lex 錯誤。請再次嘗試您的請求。

HTTP 狀態碼:500

LimitExceededException

請求超過限制。請再次嘗試您的請求。

HTTP 狀態碼:429

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: