GetBots - Amazon Lex V1

终止支持通知:2025年9月15日, AWS 我们将停止对Amazon Lex V1的支持。2025 年 9 月 15 日之后,您将无法再访问亚马逊 Lex V1 主机或 Amazon Lex V1 资源。如果您使用的是 Amazon Lex V2,请改为参阅 Amazon Lex 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”同时匹配“xyzabc”和“abcxyz”。

长度限制:最小长度为 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

另请参阅

有关以特定语言之一使用此 API 的更多信息 AWS SDKs,请参阅以下内容: