CreateMetadataTransferJob - AWS IoT TwinMaker

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateMetadataTransferJob

创建新的元数据传输作业。

请求语法

POST /metadata-transfer-jobs HTTP/1.1 Content-type: application/json { "description": "string", "destination": { "iotTwinMakerConfiguration": { "workspace": "string" }, "s3Configuration": { "location": "string" }, "type": "string" }, "metadataTransferJobId": "string", "sources": [ { "iotSiteWiseConfiguration": { "filters": [ { ... } ] }, "iotTwinMakerConfiguration": { "filters": [ { ... } ], "workspace": "string" }, "s3Configuration": { "location": "string" }, "type": "string" } ] }

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

description

元数据传输作业描述。

类型:字符串

长度约束:最小长度为 0。最大长度为 2048。

模式:.*

必需:否

destination

元数据传输作业目标。

类型:DestinationConfiguration 对象

必需:是

metadataTransferJobId

元数据传输作业 ID。

类型:字符串

长度限制:长度下限为 1。长度上限为 128。

模式:[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

必需:否

sources

元数据传输作业源。

类型:SourceConfiguration 对象数组

数组成员:固定数量为 1 项。

必需:是

响应语法

HTTP/1.1 200 Content-type: application/json { "arn": "string", "creationDateTime": number, "metadataTransferJobId": "string", "status": { "error": { "code": "string", "message": "string" }, "queuedPosition": number, "state": "string" } }

响应元素

如果此操作成功,则该服务将会发送回 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

元数据传输任务创建 DateTime 属性。

类型:时间戳

metadataTransferJobId

元数据传输作业 ID。

类型:字符串

长度限制:长度下限为 1。长度上限为 128。

模式:[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

status

元数据传输作业响应状态。

类型:MetadataTransferJobStatus 对象

错误

有关所有操作的常见错误信息,请参阅常见错误

AccessDeniedException

访问被拒绝。

HTTP 状态代码:403

ConflictException

发生冲突。

HTTP 状态代码:409

InternalServerException

出现意外错误。

HTTP 状态代码:500

ResourceNotFoundException

未找到资源。

HTTP 状态代码:404

ServiceQuotaExceededException

已超出服务限额。

HTTP 状态代码:402

ThrottlingException

速率超过限制。

HTTP 状态代码:429

ValidationException

失败

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: