GetWorkspace - AWS IoT TwinMaker

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

GetWorkspace

检索有关工作区的信息。

请求语法

GET /workspaces/workspaceId HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

workspaceId

工作区的 ID。

长度限制:最小长度为 0。最大长度为 2048。

模式:[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_-]+

必需:是

请求体

该请求没有请求正文。

响应语法

HTTP/1.1 200 Content-type: application/json { "arn": "string", "creationDateTime": number, "description": "string", "linkedServices": [ "string" ], "role": "string", "s3Location": "string", "updateDateTime": number, "workspaceId": "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

创建工作区的日期和时间。

类型:时间戳

description

工作区的描述。

类型:字符串

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

模式:.*

linkedServices

链接到工作区的服务列表。

类型:字符串数组

模式:[a-zA-Z_0-9]+

role

与工作区关联的执行角色的 ARN。

类型:字符串

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

模式:arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*

s3Location

存储与工作空间关联的资源的 Amazon S3 存储桶的 ARN。

类型:字符串

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

模式:.*(^arn:((aws)|(aws-cn)|(aws-us-gov)):s3:::)([a-zA-Z0-9_-]+$).*

updateDateTime

上次更新工作区的日期和时间。

类型:时间戳

workspaceId

工作区的 ID。

类型:字符串

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

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

错误

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

InternalServerException

出现意外错误。

HTTP 状态代码:500

ResourceNotFoundException

未找到资源。

HTTP 状态代码:404

ServiceQuotaExceededException

已超出服务限额。

HTTP 状态代码:402

ThrottlingException

速率超过限制。

HTTP 状态代码:429

ValidationException

失败

HTTP 状态代码:400

另请参阅

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