aws iot create-stream

Creates a stream for delivering one or more large files in chunks over MQTT. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a stream for delivering one or more large files in chunks over MQTT

The following create-stream example 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.

aws iot create-stream --cli-input-json file://create-stream.jsonIdentify

Contents of create-stream.json:

{
    "streamId": "stream12345",
    "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
    "files": [
        {
            "fileId": 123,
            "s3Location": {
                "bucket":"codesign-ota-bucket",
                "key":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
            }
        }
    ],
    "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role"
}

Its output

{
    "streamId": "stream12345",
    "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345",
    "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
    "streamVersion": 1
}

For more information, see MQTT-based file delivery in the AWS IoT Developer Guide.

Options

5 in the AWS CLI reference

--descriptionA description of the stream.

--filesThe files to stream.

--role-arnAn IAM role that allows the IoT service principal to access your S3 files.

--stream-idThe stream ID.

--tagsMetadata which can be used to manage streams.