AWS IoT
开发人员指南
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

CreateStream

创建一个流,以便通过 MQTT 以分块形式传送一个或多个大文件。流将来自 S3 之类的源的数据字节打包为 MQTT 消息,以块或数据块的形式传输。您可以将一个或多个文件与一个流关联。与流关联的文件的总大小不能超过 2 MB。创建流时版本为 0 。如果创建流使用的 streamID 与曾经存在但在过去 90 天内删除的流相同,我们会将版本增加 1 来重新使用旧的流。

请求语法:

POST /streams/streamId Content-type: application/json { "description": "string", "files": [ { "fileId": "integer", "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "roleArn": "string" }

URI 请求参数:

名称

类型

请求?

描述

streamId

StreamId

流 ID。

请求正文参数:

名称

类型

请求?

描述

description

StreamDescription

流的描述。

files

StreamFiles

要流式处理的文件。

roleArn

RoleArn

一个 IAM 角色,IoT 服务委托人可以代入该角色以访问您的 S3 文件。

响应语法:

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

响应正文参数:

名称

类型

请求?

描述

streamId

StreamId

流 ID。

streamArn

StreamArn

流 ARN。

description

StreamDescription

流的描述。

streamVersion

StreamVersion

流的版本。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ResourceAlreadyExistsException

该资源已存在。

HTTP 响应代码:409

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

CLI

摘要:

aws iot create-stream \ --stream-id <value> \ [--description <value>] \ --files <value> \ --role-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "streamId": "string", "description": "string", "files": [ { "fileId": "integer", "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "roleArn": "string" }

cli-input-json 字段:

名称

类型

描述

streamId

字符串

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

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

流 ID。

description

字符串

最大长度:2028

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

流的描述。

files

列表

成员:StreamFile

要流式处理的文件。

StreamFile

StreamFile

fileId

integer

java 类:java.lang.Integer

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

文件 ID。

s3Location

S3 位置

S3 中文件的位置。

bucket

字符串

最小长度:1

包含要流式处理的文件的 S3 存储桶。

key

字符串

最小长度:1

S3 存储桶中要流式处理的文件的名称。

version

字符串

文件版本。

roleArn

字符串

最大长度:2048,最小长度:20

一个 IAM 角色,IoT 服务委托人可以代入该角色以访问您的 S3 文件。

输出:

{ "streamId": "string", "streamArn": "string", "description": "string", "streamVersion": "integer" }

cli 输出字段:

名称

类型

描述

streamId

字符串

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

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

流 ID。

streamArn

字符串

流 ARN。

description

字符串

最大长度:2028

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

流的描述。

streamVersion

integer

java 类:java.lang.Integer

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

流的版本。

本页内容: