DescribeSimulationJob

重要

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

描述模擬任務。

請求語法


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

{
   "job": "string"
}

URI 請求參數

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

請求主體

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

job

要描述之模擬任務的 Amazon Resource Name (ARN)。

類型：字串

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

模式：arn:.*

必要：是

回應語法


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",
   "failureReason": "string",
   "iamRole": "string",
   "lastStartedAt": number,
   "lastUpdatedAt": number,
   "loggingConfig": { 
      "recordAllRosTopics": boolean
   },
   "maxJobDurationInSeconds": number,
   "name": "string",
   "networkInterface": { 
      "networkInterfaceId": "string",
      "privateIpAddress": "string",
      "publicIpAddress": "string"
   },
   "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 與版本建立期間的值不相符。