GetBots - Amazon Lex V1
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

如果您使用的是 Amazon Lex V2，請改參閱 Amazon Lex V2 指南。

 

如果您使用的是 Amazon Lex V1，建議您將機器人升級至 Amazon Lex V2。我們不再將新功能新增至 V1，強烈建議所有新機器人都使用 V2。

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

GetBots

傳回機器人資訊，如下所示：

  • 如果您提供nameContains欄位，回應會包含名稱包含指定字串之所有機器人$LATEST版本的資訊。

  • 如果您未指定nameContains欄位，作業會傳回所有機器人$LATEST版本的相關資訊。

這項操作需要 lex:GetBots 動作的許可。

請求語法

GET /bots/?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken HTTP/1.1

URI 請求參數

請求會使用下列 URI 參數。

maxResults

要求傳回的回應中要傳回的最大機器人數目。預設為 10。

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

nameContains

要在機器人名稱中符合的子字串。如果機器人名稱的任何部分與子字串相符，則會傳回機器人。例如，「xyz」符合「XYZ」和「阿布扎克」兩者。

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

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

nextToken

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

請求主體

請求沒有請求主體。

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "bots": [ 
      { 
         "createdDate": number,
         "description": "string",
         "lastUpdatedDate": number,
         "name": "string",
         "status": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}

回應元素

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

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

bots

botMetadata物件陣列，每個機器人都有一個項目。

類型：BotMetadata 物件陣列

nextToken

如果響應被截斷，則它包含一個分頁令牌，您可以在下一個請求中指定該標記以獲取機器人的下一頁。

類型：字串

錯誤

BadRequestException

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

HTTP 狀態碼：400

InternalFailureException

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

HTTP 狀態碼：500

LimitExceededException

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

HTTP 狀態碼：429

NotFoundException

找不到要求中指定的資源。請檢查資源，然後再試一次。

HTTP 狀態碼：404

另請參閱

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