本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
StartSimulationJobBatch
開始新的模擬工作批次。批次是使用一或多個SimulationJobRequest物件定義的。
請求語法
POST /startSimulationJobBatch HTTP/1.1
Content-type: application/json
{
"batchPolicy": {
"maxConcurrency": number,
"timeoutInSeconds": number
},
"clientRequestToken": "string",
"createSimulationJobRequests": [
{
"compute": {
"computeType": "string",
"gpuUnitLimit": number,
"simulationUnitLimit": number
},
"dataSources": [
{
"destination": "string",
"name": "string",
"s3Bucket": "string",
"s3Keys": [ "string" ],
"type": "string"
}
],
"failureBehavior": "string",
"iamRole": "string",
"loggingConfig": {
"recordAllRosTopics": boolean
},
"maxJobDurationInSeconds": number,
"outputLocation": {
"s3Bucket": "string",
"s3Prefix": "string"
},
"robotApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean
}
],
"simulationApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean,
"worldConfigs": [
{
"world": "string"
}
]
}
],
"tags": {
"string" : "string"
},
"useDefaultApplications": boolean,
"vpcConfig": {
"assignPublicIp": boolean,
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
}
],
"tags": {
"string" : "string"
}
}URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- batchPolicy
-
批次原則。
類型：BatchPolicy 物件
必要：否
- clientRequestToken
-
您提供的唯一，區分大小寫的標識符，以確保請求的冪等性。
類型：字串
長度限制：長度下限為 1。長度上限為 64。
模式：
[a-zA-Z0-9_\-=]*必要：否
- createSimulationJobRequests
-
要在批次中建立的模擬工作請求清單。
類型：SimulationJobRequest 物件陣列
陣列成員：項目數下限為 1。項目數上限為 1000。
必要：是
-
包含附加至部署工作批次的標籤鍵和標籤值的對映。
類型：字串到字串映射
地圖項目：0 個項目的最小數目。項目數上限為 50。
索引鍵長度限制：長度下限為 1。長度上限為 128。
金鑰模式：
[a-zA-Z0-9 _.\-\/+=:]*值長度限制：最小長度為 0。長度上限為 256。
值模式：
[a-zA-Z0-9 _.\-\/+=:]*必要：否
回應語法
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"batchPolicy": {
"maxConcurrency": number,
"timeoutInSeconds": number
},
"clientRequestToken": "string",
"createdAt": number,
"createdRequests": [
{
"arn": "string",
"computeType": "string",
"dataSourceNames": [ "string" ],
"lastUpdatedAt": number,
"name": "string",
"robotApplicationNames": [ "string" ],
"simulationApplicationNames": [ "string" ],
"status": "string"
}
],
"failedRequests": [
{
"failedAt": number,
"failureCode": "string",
"failureReason": "string",
"request": {
"compute": {
"computeType": "string",
"gpuUnitLimit": number,
"simulationUnitLimit": number
},
"dataSources": [
{
"destination": "string",
"name": "string",
"s3Bucket": "string",
"s3Keys": [ "string" ],
"type": "string"
}
],
"failureBehavior": "string",
"iamRole": "string",
"loggingConfig": {
"recordAllRosTopics": boolean
},
"maxJobDurationInSeconds": number,
"outputLocation": {
"s3Bucket": "string",
"s3Prefix": "string"
},
"robotApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean
}
],
"simulationApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean,
"worldConfigs": [
{
"world": "string"
}
]
}
],
"tags": {
"string" : "string"
},
"useDefaultApplications": boolean,
"vpcConfig": {
"assignPublicIp": boolean,
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
}
}
],
"failureCode": "string",
"failureReason": "string",
"pendingRequests": [
{
"compute": {
"computeType": "string",
"gpuUnitLimit": number,
"simulationUnitLimit": number
},
"dataSources": [
{
"destination": "string",
"name": "string",
"s3Bucket": "string",
"s3Keys": [ "string" ],
"type": "string"
}
],
"failureBehavior": "string",
"iamRole": "string",
"loggingConfig": {
"recordAllRosTopics": boolean
},
"maxJobDurationInSeconds": number,
"outputLocation": {
"s3Bucket": "string",
"s3Prefix": "string"
},
"robotApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean
}
],
"simulationApplications": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"command": [ "string" ],
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"portForwardingConfig": {
"portMappings": [
{
"applicationPort": number,
"enableOnPublicIp": boolean,
"jobPort": number
}
]
},
"streamUI": boolean
},
"tools": [
{
"command": "string",
"exitBehavior": "string",
"name": "string",
"streamOutputToCloudWatch": boolean,
"streamUI": boolean
}
],
"uploadConfigurations": [
{
"name": "string",
"path": "string",
"uploadBehavior": "string"
}
],
"useDefaultTools": boolean,
"useDefaultUploadConfigurations": boolean,
"worldConfigs": [
{
"world": "string"
}
]
}
],
"tags": {
"string" : "string"
},
"useDefaultApplications": boolean,
"vpcConfig": {
"assignPublicIp": boolean,
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
}
],
"status": "string",
"tags": {
"string" : "string"
}
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- arn
-
批次的 Amazon 資源名稱 (arn)。
類型：字串
長度限制：長度下限為 1。最大長度為 1224。
模式：
arn:.* - batchPolicy
-
批次原則。
類型：BatchPolicy 物件
- clientRequestToken
-
您提供的唯一，區分大小寫的標識符，以確保請求的冪等性。
類型：字串
長度限制：長度下限為 1。長度上限為 64。
模式：
[a-zA-Z0-9_\-=]* - createdAt
-
建立模擬工作批次之後的時間 (以毫秒為單位)。
類型：Timestamp
- createdRequests
-
已建立的模擬工作請求摘要清單。
類型：SimulationJobSummary 物件陣列
陣列成員：項目數下限為 0。項目數上限為 100。
- failedRequests
-
失敗的模擬工作請求清單。無法將請求建立到模擬工作中。失敗的請求沒有模擬工作 ID。
類型：FailedCreateSimulationJobRequest 物件陣列
- failureCode
-
模擬工作批次失敗時的失敗代碼。
類型：字串
有效值:
InternalServiceError - failureReason
-
模擬工作批次失敗的原因。
類型：字串
長度限制：長度下限為 0。長度上限為 1024。
模式：
.* - pendingRequests
-
擱置模擬工作請求的清單。這些請求尚未建立至模擬工作。
類型：SimulationJobRequest 物件陣列
陣列成員：項目數下限為 1。項目數上限為 1000。
- status
-
模擬工作批次的狀態。
- 待定
-
模擬工作批次請求處於擱置狀態。
- InProgress
-
模擬工作批次正在進行中。
- 失敗
-
模擬工作批次失敗。由於內部故障（如
InternalServiceError），一個或多個模擬工作請求無法完成。如需詳細資訊，請參閱failureCode和failureReason。 - 已完成
-
模擬批次工作已完成。如果 (1) 批次中沒有擱置的模擬工作請求，且失敗的模擬工作請求都不是因為 (2) 所有建立的模擬工作都達到終止狀態 (例如，
Completed或Failed)，則批次即完成。InternalServiceError - 已取消
-
已取消模擬批次工作。
- 取消
-
模擬批次工作正在取消。
- 完成
-
模擬批次工作正在完成。
- TimingOut
-
模擬工作批次已逾時。
如果批次逾時，且有擱置的要求因內部失敗 (例如
InternalServiceError) 而失敗，則批次狀態會是Failed。如果沒有這樣的失敗請求，批次狀態將是TimedOut。 - TimedOut
-
模擬批次工作逾時。
類型：字串
有效值:
Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut -
包含附加至部署工作批次的標籤鍵和標籤值的對映。
類型：字串到字串映射
地圖項目：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
- ThrottlingException
-
AWS 暫 RoboMaker 時無法處理請求。請再次嘗試呼叫。
HTTP 狀態碼：400
另請參閲
如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
