AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

ListStreams

列出您的 AWS 账户中的所有流。

https

请求语法:

GET /streams?maxResults=maxResults&nextToken=nextToken&isAscendingOrder=ascendingOrder

URI 请求参数:

名称

类型

请求?

描述

maxResults

MaxResults

一次性返回的最大结果数。

nextToken

NextToken

用于获取下一组结果的令牌。

ascendingOrder

AscendingOrder

设置为 true 时,将按照升序返回流的列表。

响应语法:

Content-type: application/json { "streams": [ { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string" } ], "nextToken": "string" }

响应正文参数:

名称

类型

请求?

描述

streams

StreamsSummary

流的列表。

nextToken

NextToken

用于获取下一组结果的令牌。

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

cli

摘要:

aws iot list-streams \ [--max-results <value>] \ [--next-token <value>] \ [--ascending-order | --no-ascending-order] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "maxResults": "integer", "nextToken": "string", "ascendingOrder": "boolean" }

cli-input-json 字段:

名称

类型

描述

maxResults

integer

范围 - 最大值:250,最小值:1

一次性返回的最大结果数。

nextToken

字符串

用于获取下一组结果的令牌。

ascendingOrder

布尔值

设置为 true 时,将按照升序返回流的列表。

输出:

{ "streams": [ { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string" } ], "nextToken": "string" }

cli 输出字段:

名称

类型

描述

streams

列表

成员:StreamSummary

流的列表。

streamId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9_-]+

流 ID。

streamArn

字符串

流 ARN。

streamVersion

integer

范围 – 最大值:65535,最小值:0

流版本。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

流的描述。

nextToken

字符串

用于获取下一组结果的令牌。

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。