DescribeWorld - AWS RoboMaker

终止支持通知:2025 年 9 月 10 日, AWS 将停止对的支持。 AWS RoboMaker2025 年 9 月 10 日之后,您将无法再访问 AWS RoboMaker 控制台或 AWS RoboMaker 资源。有关过渡 AWS Batch 到以帮助运行容器化仿真的更多信息,请访问此博客文章。

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

DescribeWorld

重要

终止支持通知:2025 年 9 月 10 日, AWS 将停止对的支持。 AWS RoboMaker2025 年 9 月 10 日之后,您将无法再访问 AWS RoboMaker 控制台或 AWS RoboMaker 资源。有关过渡 AWS Batch 到以帮助运行容器化仿真的更多信息,请访问此博客文章。

描述世界。

请求语法

POST /describeWorld HTTP/1.1 Content-type: application/json { "world": "string" }

URI请求参数

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

请求正文

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

world

您要描述世界的 Amazon 资源名称(ARN)。

类型:字符串

长度限制:长度下限为 1。最大长度为 1224。

模式:arn:.*

必需:是

响应语法

HTTP/1.1 200 Content-type: application/json { "arn": "string", "createdAt": number, "generationJob": "string", "tags": { "string" : "string" }, "template": "string", "worldDescriptionBody": "string" }

响应元素

如果操作成功,服务将发回 HTTP 200 响应。

以下数据由服务以JSON格式返回。

arn

世界的 Amazon 资源名称(ARN)。

类型:字符串

长度限制:长度下限为 1。最大长度为 1224。

模式:arn:.*

createdAt

创建世界的时间,用从纪元开始的毫秒数表示。

类型:时间戳

generationJob

生成世界的世界生成作业的 Amazon 资源名称(ARN)。

类型:字符串

长度限制:长度下限为 1。最大长度为 1224。

模式:arn:.*

tags

包含附加到世界的标签键和标签值的映射。

类型:字符串到字符串映射

映射条目:最低 0 项。最多 50 项。

密钥长度限制:最小长度为 1。长度上限为 128。

键模式:[a-zA-Z0-9 _.\-\/+=:]*

值长度限制:最小长度为 0。最大长度为 256。

价值模式:[a-zA-Z0-9 _.\-\/+=:]*

template

世界模板。

类型:字符串

长度限制:长度下限为 1。最大长度为 1224。

模式:arn:.*

worldDescriptionBody

返回描述世界内容的JSON格式化字符串。

类型:字符串

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

模式:[\S\s]+

错误

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

InternalServerException

AWS RoboMaker 遇到了服务问题。重新尝试您的调用。

HTTP状态码:500

InvalidParameterException

在请求中指定的参数无效、不受支持,或无法使用。请求的消息解释错误值。

HTTP状态码:400

ResourceNotFoundException

指定的资源不存在。

HTTP状态码:400

ThrottlingException

AWS RoboMaker 暂时无法处理请求。重新尝试您的调用。

HTTP状态码:400

另请参阅

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