本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribeWorld
描述了一個世界。
請求語法
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
-
自紀元以來的時間，以毫秒為單位，建立世界的時間。
類型：Timestamp
- generationJob
-
產生世界的世界生成任務的 Amazon 資源名稱（arn）。
類型：字串
長度限制：長度下限為 1。最大長度為 1224。
模式：
arn:.* -
包含貼附至世界的標籤鍵和標籤值的地圖。
類型：字串到字串映射
地圖項目：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
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
