本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
CreateWorldGenerationJob
使用指定的樣板建立世界。
請求語法
POST /createWorldGenerationJob HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"tags": {
"string" : "string"
},
"template": "string",
"worldCount": {
"floorplanCount": number,
"interiorCountPerFloorplan": number
},
"worldTags": {
"string" : "string"
}
}URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- clientRequestToken
-
您提供的唯一，區分大小寫的標識符，以確保請求的冪等性。
類型：字串
長度限制：長度下限為 1。長度上限為 64。
模式：
[a-zA-Z0-9_\-=]*必要：否
-
包含貼附至世界產生器工作的標籤鍵和標籤值的地圖。
類型：字串到字串映射
地圖項目：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 _.\-\/+=:]*必要：否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"clientRequestToken": "string",
"createdAt": number,
"failureCode": "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
-
建立世界產生器工作之後的時間 (以毫秒為單位)。
類型：Timestamp
- failureCode
-
如果失敗，則世界發電機作業的故障代碼：
- InternalServiceError
-
內部服務錯誤。
- LimitExceeded
-
請求的資源超過允許的最大數量，或者並發流請求的數量超過允許的最大數量。
- ResourceNotFound
-
找不到指定的資源。
- RequestThrottled
-
請求受到調節。
- InvalidInput
-
請求中的輸入參數無效。
類型：字串
有效值:
InternalServiceError | LimitExceeded | ResourceNotFound | RequestThrottled | InvalidInput | AllWorldGenerationFailed - status
-
世界發電機工作的狀態。
- 待定
-
世界生成器工作請求正在待處理。
- 執行中
-
世界產生器工作正在執行中。
- 已完成
-
世界發電機工作完成。
- 失敗
-
世界發電機工作失敗了。如需詳細資訊，請參閱
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 _.\-\/+=:]*
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- IdempotentParameterMismatchException
-
請求使用了與先前請求 (但為非相同請求) 相同的用戶端字符。請勿以不同請求重複使用用戶端字符，除非請求相同。
HTTP 狀態碼：400
- InternalServerException
-
AWS RoboMaker 遇到服務問題。請再次嘗試呼叫。
HTTP 狀態碼：500
- InvalidParameterException
-
在請求中指定的一個參數無效、未支援或無法使用。傳回之訊息會提供錯誤值的說明。
HTTP 狀態碼：400
- LimitExceededException
-
請求的資源超過允許的最大數量，或者並發流請求的數量超過允許的最大數量。
HTTP 狀態碼：400
- ResourceNotFoundException
-
指定的資源不存在。
HTTP 狀態碼：400
- ServiceUnavailableException
-
由於伺服器暫時故障，請求失敗。
HTTP 狀態碼：503
- ThrottlingException
-
AWS 暫 RoboMaker 時無法處理請求。請再次嘗試呼叫。
HTTP 狀態碼：400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
