/streams/{streamId}

The AWS IoT Wireless multi-region endpoint

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

GET

/streams/{streamId}

Gets information about a stream.

Requires permission to access the DescribeStream action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/streams/'

Response Example

200 - Example 1

{
    "streamInfo": {
        "streamId": "string",
        "streamArn": "string",
        "streamVersion": 0,
        "description": "string",
        "files": [],
        "createdAt": "string",
        "lastUpdatedAt": "string",
        "roleArn": "string"
    }
}

Request

Path Params

streamId

string

required

The stream ID.

Responses

🟢200Success

application/json

Body

streamInfo

object

optional

Information about the stream.

streamId

string

optional

The stream ID.

>= 1 characters<= 128 characters

Match pattern:

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

streamArn

string

optional

The stream ARN.

streamVersion

integer

optional

The stream version.

>= 0<= 65535

description

string

optional

The description of the stream.

<= 2028 characters

Match pattern:

[^\p{C}]+

files

array[object (StreamFile) {2}]

optional

The files to stream.

>= 1 items<= 50 items

createdAt

string <date-time>

optional

The date when the stream was created.

lastUpdatedAt

string <date-time>

optional

The date when the stream was last updated.

roleArn

string

optional

An IAM role IoT assumes to access your S3 files.

>= 20 characters<= 2048 characters

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483UnauthorizedException

🟠484ServiceUnavailableException

🟠485InternalFailureException

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

/streams/{streamId}