本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
ListWorlds
列出世界。
請求語法
POST /listWorlds HTTP/1.1
Content-type: application/json
{
"filters": [
{
"name": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string"
}URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- filters
-
可選的過濾器來限制結果。您可以使用
status。類型：Filter 物件陣列
陣列成員：固定項目數為 1。
必要：否
- maxResults
-
使用此參數時，
ListWorlds只返回maxResults結果與nextToken響應元素一起在單個頁面中。初始請求的剩餘結果可以通過發送帶有返回nextToken值的另一個ListWorlds請求來查看。此值可以介於 1 和 100 之間。如果未使用此參數，則會ListWorlds傳回最多 100 個結果，並傳回一個nextToken值 (如果適用)。類型：整數
必要：否
- nextToken
-
如果先前的分頁請求未返回所有剩餘的結果，則響應對象的
nextToken參數值被設置為令牌。要檢索下一組結果，請ListWorlds再次調用並將該令牌分配給請求對象的nextToken參數。如果沒有剩餘的結果，先前的響應對象的 NextToken 參數設置為 null。類型：字串
長度限制：長度下限為 1。長度上限為 2048。
模式：
[a-zA-Z0-9_.\-\/+=]*必要：否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"worldSummaries": [
{
"arn": "string",
"createdAt": number,
"generationJob": "string",
"template": "string"
}
]
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- nextToken
-
如果先前的分頁請求未返回所有剩餘的結果，則響應對象的
nextToken參數值被設置為令牌。要檢索下一組結果，請ListWorlds再次調用並將該令牌分配給請求對象的nextToken參數。如果沒有剩餘的結果，先前的響應對象的 NextToken 參數設置為 null。類型：字串
長度限制：長度下限為 1。長度上限為 2048。
模式：
[a-zA-Z0-9_.\-\/+=]* - worldSummaries
-
世界的摘要信息。
類型：WorldSummary 物件陣列
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InternalServerException
-
AWS RoboMaker 遇到服務問題。請再次嘗試呼叫。
HTTP 狀態碼：500
- InvalidParameterException
-
在請求中指定的一個參數無效、未支援或無法使用。傳回之訊息會提供錯誤值的說明。
HTTP 狀態碼：400
- ThrottlingException
-
AWS 暫 RoboMaker 時無法處理請求。請再次嘗試呼叫。
HTTP 狀態碼：400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
