/streams/{streamId}

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

Requires permission to access the CreateStream action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/streams/' \ --header 'Content-Type: application/json' \ --data-raw '{ "description": "string", "files": [ { "fileId": 0, "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "roleArn": "stringstringstringst", "tags": [ { "Key": "string", "Value": "string" } ] }'

Request

Path Params

streamId

string

required

The stream ID.

Body Params application/json

description

string

optional

A description of the stream.

<= 2028 characters

Match pattern:

[^\p{C}]+

files

array[object (StreamFile) {2}]

required

The files to stream.

>= 1 items<= 50 items

fileId

integer

optional

The file ID.

>= 0<= 255

s3Location

object

optional

The location of the file in S3.

roleArn

string

required

An IAM role that allows the IoT service principal assumes to access your S3 files.

>= 20 characters<= 2048 characters

Request

Responses