/streams/{streamId}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

PUT

/streams/{streamId}

Updates an existing stream. The stream version will be incremented by one.

Requires permission to access the UpdateStream action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT '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"
}'

Response Example

200 - Example 1

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

Request

Path Params

streamId

string

required

The stream ID.

Body Params application/json

description

string

optional

The description of the stream.

<= 2028 characters

Match pattern:

[^\p{C}]+

files

array[object (StreamFile) {2}]

optional

The files associated with the 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

optional

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

>= 20 characters<= 2048 characters

Examples

Responses

🟢200Success

application/json

Body

streamId

string

optional

The stream ID.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

streamArn

string

optional

The stream ARN.

description

string

optional

A description of the stream.

<= 2028 characters

Match pattern:

[^\p{C}]+

streamVersion

integer

optional

The stream version.

>= 0<= 65535

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483UnauthorizedException

🟠484ServiceUnavailableException

🟠485InternalFailureException

Modified at 2022-09-10 23:12:14

/streams/{streamId}

/things/{thingName}