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”同时匹配“xyzabc”和“abcxyz”。要返回所有机器人通道关联,请使用连字符 ("-") 作为 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 的更多信息,请参阅以下内容: