本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateScene
创建场景
请求语法
POST /workspaces/workspaceId
/scenes HTTP/1.1
Content-type: application/json
{
"capabilities": [ "string
" ],
"contentLocation": "string
",
"description": "string
",
"sceneId": "string
",
"sceneMetadata": {
"string
" : "string
"
},
"tags": {
"string
" : "string
"
}
}
URI 请求参数
请求使用以下 URI 参数。
- workspaceId
-
包含场景的工作区 ID。
长度限制:长度下限为 1。最大长度为 128。
模式:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+
必需:是
请求体
请求接受采用 JSON 格式的以下数据。
- capabilities
-
场景用于进行自身渲染的功能列表。
类型:字符串数组
数组成员:最少 0 项。最多 50 项。
长度约束:最小长度为 0。最大长度为 256。
模式:
.*
必需:否
- contentLocation
-
指定内容定义文件位置的相对路径。
类型:字符串
长度约束:最小长度为 0。最大长度为 256。
模式:
[sS]3://[A-Za-z0-9._/-]+
必需:是
- description
-
此场景的描述。
类型:字符串
长度约束:最小长度为 0。最大长度为 2048。
模式:
.*
必需:否
- sceneId
-
场景的 ID
类型:字符串
长度限制:长度下限为 1。最大长度为 128。
模式:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+
必需:是
- sceneMetadata
-
请求元数据。
类型:字符串到字符串映射
映射条目:最低 0 项。最多 50 项。
密钥长度限制:最小长度为 1。最大长度为 256。
键模式:
[a-zA-Z_\-0-9]+
值长度限制:最小长度为 0。最大长度为 2048。
价值模式:
.*
必需:否
-
可用于管理场景的元数据。
类型:字符串到字符串映射
映射条目:最低 0 项。最多 50 项。
密钥长度限制:最小长度为 1。最大长度为 128。
键模式:
([\p{L}\p{Z}\p{N}_.:/=+\-@]*)
值长度限制:最小长度为 1。最大长度为 256。
价值模式:
.*
必需:否
响应语法
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDateTime": number
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- arn
-
场景的 ARN。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
模式:
arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+
- creationDateTime
-
创建场景的日期和时间。
类型:时间戳
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- AccessDeniedException
-
访问被拒绝。
HTTP 状态代码:403
- ConflictException
-
发生冲突。
HTTP 状态代码:409
- InternalServerException
-
出现意外错误。
HTTP 状态代码:500
- ServiceQuotaExceededException
-
已超出服务限额。
HTTP 状态代码:402
- ThrottlingException
-
速率超过限制。
HTTP 状态代码:429
- ValidationException
-
失败
HTTP 状态代码:400
另请参阅
有关以特定语言之一使用此 API 的更多信息 AWS SDKs,请参阅以下内容: