本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
DescribeWorldGenerationJob
描述世界生成作业。
请求语法
POST /describeWorldGenerationJob HTTP/1.1
Content-type: application/json
{
"job": "string"
}URI 请求参数
该请求不使用任何 URI 参数。
请求体
请求接受采用 JSON 格式的以下数据。
- job
-
需描述的世界生成作业的 Amazon 资源名称（ARN）。
类型：字符串
长度限制：长度下限为 1。最大长度为 1224。
模式：
arn:.*必需：是
响应语法
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"clientRequestToken": "string",
"createdAt": number,
"failureCode": "string",
"failureReason": "string",
"finishedWorldsSummary": {
"failureSummary": {
"failures": [
{
"failureCode": "string",
"failureCount": number,
"sampleFailureReason": "string"
}
],
"totalFailureCount": number
},
"finishedCount": number,
"succeededWorlds": [ "string" ]
},
"status": "string",
"tags": {
"string" : "string"
},
"template": "string",
"worldCount": {
"floorplanCount": number,
"interiorCountPerFloorplan": number
},
"worldTags": {
"string" : "string"
}
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- arn
-
世界生成作业的 Amazon 资源名称（ARN）。
类型：字符串
长度限制：长度下限为 1。最大长度为 1224。
模式：
arn:.* - clientRequestToken
-
用于确保请求的幂等性而提供的唯一、区分大小写的标识符。
类型：字符串
长度限制：长度下限为 1。长度上限为 64。
模式：
[a-zA-Z0-9_\-=]* - createdAt
-
创建世界生成作业的时间，用从纪元开始的毫秒数表示。
类型：时间戳
- failureCode
-
世界生成作业失败时的失败代码：
- InternalServiceError
-
内部服务错误。
- LimitExceeded
-
请求的资源超过了允许的最大数量，或者并发流请求的数量超过了允许的最大数量。
- ResourceNotFound
-
找不到指定资源。
- RequestThrottled
-
请求已被阻止。
- InvalidInput
-
请求输入参数无效。
类型：字符串
有效值：
InternalServiceError | LimitExceeded | ResourceNotFound | RequestThrottled | InvalidInput | AllWorldGenerationFailed - failureReason
-
世界生成作业失败的原因。
类型：字符串
长度约束：最小长度为 0。最大长度为 1024。
模式：
.* - finishedWorldsSummary
-
关于已完成世界的汇总信息。
类型：FinishedWorldsSummary 对象
- status
-
世界生成作业的状态：
- 待处理
-
世界生成作业请求待处理。
- Running
-
世界生成作业正在运行。
- 已完成
-
世界生成作业已完成。
- 失败
-
世界生成作业失败。请参阅
failureCode了解更多信息。 - PartialFailed
-
有些世界没有生成。
- 已取消
-
世界生成作业已取消。
- 正在取消
-
世界生成作业正在取消。
类型：字符串
有效值：
Pending | Running | Completed | Failed | PartialFailed | Canceling | Canceled -
包含附加到世界生成作业的标签键和标签值的映射。
类型：字符串到字符串映射
映射条目：最低 0 项。最多 50 项。
密钥长度限制：最小长度为 1。长度上限为 128。
键模式：
[a-zA-Z0-9 _.\-\/+=:]*值长度限制：最小长度为 0。最大长度为 256。
价值模式：
[a-zA-Z0-9 _.\-\/+=:]* - template
-
世界模板的 Amazon 资源名称（ARN）。
类型：字符串
长度限制：长度下限为 1。最大长度为 1224。
模式：
arn:.* - worldCount
-
有关世界计数的信息。
类型：WorldCount 对象
- worldTags
-
包含附加到生成器作业的标签键和标签值的映射。
类型：字符串到字符串映射
映射条目：最低 0 项。最多 50 项。
密钥长度限制：最小长度为 1。长度上限为 128。
键模式：
[a-zA-Z0-9 _.\-\/+=:]*值长度限制：最小长度为 0。最大长度为 256。
价值模式：
[a-zA-Z0-9 _.\-\/+=:]*
错误
有关所有操作的常见错误信息，请参阅常见错误。
- InternalServerException
-
AWS RoboMaker 遇到了服务问题。重新尝试您的调用。
HTTP 状态代码：500
- InvalidParameterException
-
在请求中指定的参数无效、不受支持，或无法使用。请求的消息解释错误值。
HTTP 状态代码：400
- ResourceNotFoundException
-
指定的资源不存在。
HTTP 状态代码：400
- ThrottlingException
-
AW RoboMaker S 暂时无法处理该请求。重新尝试您的调用。
HTTP 状态代码：400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
