CreateSimulationJob

重要

支援終止通知：2025 年 9 月 10 日， AWS 將停止對 AWS RoboMaker 的支援。2025 年 9 月 10 日之後，您將無法再存取 AWS RoboMaker 主控台或 AWS RoboMaker 資源。如需有關轉換至 AWS Batch 以協助執行容器化模擬的詳細資訊，請參閱此部落格文章。

建立模擬任務。

注意

模擬任務會在 90 天後過期並遭到刪除。他們不再可供存取。

請求語法


POST /createSimulationJob HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "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" 
   },
   "vpcConfig": { 
      "assignPublicIp": boolean,
      "securityGroups": [ "string" ],
      "subnets": [ "string" ]
   }
}

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

clientRequestToken

您提供的唯一且區分大小寫的識別符，以確保請求的等冪性。

類型：字串

長度限制：長度下限為 1。長度上限為 64。

模式：[a-zA-Z0-9_\-=]*

必要：否

compute

模擬任務的運算資訊。

類型：Compute 物件

必要：否

dataSources

指定資料來源，將唯讀檔案從 S3 掛載到模擬中。這些檔案可在下取得/opt/robomaker/datasources/data_source_name。

注意

對於所有DataSourceConfig物件，限制為 100 個檔案和 25GB 的合併大小。

類型：DataSourceConfig 物件陣列

陣列成員：項目數下限為 1。項目數上限為 6。

必要：否

failureBehavior

模擬任務的失敗行為。

Continue: 在4XX錯誤碼之後，會讓執行個體在其最長逾時持續時間內持續執行。
失敗: 停止模擬任務並終止執行個體。

類型：字串

有效值:Fail | Continue

必要：否

iamRole

允許模擬執行個體代表您呼叫其相關聯政策中指定的 AWS APIs 的 IAM 角色名稱。這就是將登入資料傳入模擬任務的方式。

類型：字串

長度限制：長度下限為 1。長度上限為 255。

模式：arn:aws:iam::\w+:role/.*

必要：是

loggingConfig

記錄組態。

類型：LoggingConfig 物件

必要：否

maxJobDurationInSeconds

模擬任務持續時間上限，以秒為單位（最多 14 天或 1，209，600 秒。達到 maxJobDurationInSeconds 時，模擬任務的狀態將轉換為 Completed。

類型：Long

必要：是

outputLocation

模擬任務產生的輸出檔案位置。

類型：OutputLocation 物件

必要：否

robotApplications

要在模擬任務中使用的機器人應用程式。

類型：RobotApplicationConfig 物件陣列

陣列成員：固定項目數為 1。

必要：否

simulationApplications

要在模擬任務中使用的模擬應用程式。

類型：SimulationApplicationConfig 物件陣列

陣列成員：固定項目數為 1。

必要：否

tags

包含附加至模擬任務之標籤索引鍵和標籤值的映射。

類型：字串到字串映射

映射項目：0 個項目的最小數量。項目數上限為 50。

索引鍵長度限制：長度下限為 1。長度上限為 128。

金鑰模式：[a-zA-Z0-9 _.\-\/+=:]*

值長度限制：長度下限為 0。長度上限為 256。

值模式：[a-zA-Z0-9 _.\-\/+=:]*

必要：否

vpcConfig

如果您的模擬任務存取 VPC 中的資源，您會提供此參數，以識別安全群組 IDs和子網路 IDs的清單。這些必須屬於相同的 VPC。您必須提供至少一個安全群組和一個子網路 ID。

類型：VPCConfig 物件

必要：否

回應語法


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientRequestToken": "string",
   "compute": { 
      "computeType": "string",
      "gpuUnitLimit": number,
      "simulationUnitLimit": number
   },
   "dataSources": [ 
      { 
         "destination": "string",
         "name": "string",
         "s3Bucket": "string",
         "s3Keys": [ 
            { 
               "etag": "string",
               "s3Key": "string"
            }
         ],
         "type": "string"
      }
   ],
   "failureBehavior": "string",
   "failureCode": "string",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "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"
            }
         ]
      }
   ],
   "simulationTimeMillis": number,
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "vpcConfig": { 
      "assignPublicIp": boolean,
      "securityGroups": [ "string" ],
      "subnets": [ "string" ],
      "vpcId": "string"
   }
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

arn

模擬任務的 Amazon Resource Name (ARN)。

類型：字串

長度限制：長度下限為 1。長度上限為 1224。

模式：arn:.*

clientRequestToken

您提供的唯一且區分大小寫的識別符，以確保請求的等冪性。

類型：字串

長度限制：長度下限為 1。長度上限為 64。

模式：[a-zA-Z0-9_\-=]*

compute

模擬任務的運算資訊。

類型：ComputeResponse 物件

dataSources

模擬任務的資料來源。

類型：DataSource 物件陣列

failureBehavior

模擬任務的失敗行為。

類型：字串

有效值:Fail | Continue

failureCode

模擬任務失敗時的失敗代碼：

InternalServiceError: 內部服務錯誤。
RobotApplicationCrash: 機器人應用程式異常結束。
SimulationApplicationCrash: 模擬應用程式異常結束。
BadPermissionsRobotApplication: 無法下載機器人應用程式套件。
BadPermissionsSimulationApplication: 無法下載模擬應用程式套件。
BadPermissionsS3Output: 無法將輸出發佈至客戶提供的 S3 儲存貯體。
BadPermissionsCloudwatchLogs: 無法將日誌發佈至客戶提供的 CloudWatch Logs 資源。
SubnetIpLimitExceeded: 超過子網路 IP 限制。
ENILimitExceeded: 超過 ENI 限制。
BadPermissionsUserCredentials: 無法使用提供的角色。
InvalidBundleRobotApplication: 無法擷取機器人套件（無效的格式、綁定錯誤或其他問題）。
InvalidBundleSimulationApplication: 無法擷取模擬套件（無效的格式、綁定錯誤或其他問題）。
RobotApplicationVersionMismatchedEtag: RobotApplication 的 Etag 與版本建立期間的值不相符。
SimulationApplicationVersionMismatchedEtag: SimulationApplication 的 Etag 與版本建立期間的值不相符。