DescribeStream
获取有关流的信息。
请求语法:
GET /streams/
streamId
URI 请求参数:
名称 |
类型 |
请求? |
描述 |
---|---|---|---|
streamId |
StreamId |
是 |
流 ID。 |
响应语法:
Content-type: application/json { "streamInfo": { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string", "files": [ { "fileId": "integer", "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "roleArn": "string" } }
响应正文参数:
名称 |
类型 |
请求? |
描述 |
---|---|---|---|
streamInfo |
StreamInfo |
否 |
有关流的信息。 |
错误:
InvalidRequestException
-
请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。
HTTP 响应代码:400
ResourceNotFoundException
-
指定的资源不存在。
HTTP 响应代码:404
ThrottlingException
-
速率超过限制。
HTTP 响应代码:429
UnauthorizedException
-
您没有权限执行此操作。
HTTP 响应代码:401
ServiceUnavailableException
-
服务暂时不可用。
HTTP 响应代码:503
InternalFailureException
-
出现意外错误。
HTTP 响应代码:500
CLI
摘要:
aws iot describe-stream \ --stream-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json
format:
{ "streamId": "string" }
cli-input-json
字段:
名称 |
类型 |
描述 |
---|---|---|
streamId |
字符串 最大长度:128,最小长度:1 模式:[a-zA-Z0-9_-]+ |
流 ID。 |
输出:
{ "streamInfo": { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string", "files": [ { "fileId": "integer", "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "roleArn": "string" } }
cli 输出字段:
名称 |
类型 |
描述 |
---|---|---|
streamInfo |
StreamInfo |
有关流的信息。 |
streamId |
字符串 最大长度:128,最小长度:1 模式:[a-zA-Z0-9_-]+ |
流 ID。 |
streamArn |
字符串 |
流 ARN。 |
streamVersion |
integer java 类:java.lang.Integer 范围 – 最大值:65535,最小值:0 |
流版本。 |
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 |
字符串 |
文件版本。 |
createdAt |
timestamp |
创建流的日期。 |
lastUpdatedAt |
timestamp |
上次更新流的日期。 |
roleArn |
字符串 最大长度:2048,最小长度:20 |
AWS IoT 代入以访问您的 S3 文件的 IAM 角色。 |