DescribeSimulationJob - AWS RoboMaker

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeSimulationJob

描述模擬工作。

請求語法

POST /describeSimulationJob HTTP/1.1 Content-type: application/json { "job": "string" }

URI 請求參數

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

請求主體

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

job

要描述的模擬任務的 Amazon 資源名稱 (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 資源名稱 (ARN)。

類型:字串

長度限制:長度下限為 1。最大長度為 1224。

模式:arn:.*

clientRequestToken

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

類型:字串

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

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

compute

計算模擬工作的資訊。

類型:ComputeResponse 物件

dataSources

模擬工作的資料來源。

類型:DataSource 物件陣列

failureBehavior

模擬工作的失敗行為。

類型:字串

有效值:Fail | Continue

failureCode

模擬工作失敗時的失敗代碼:

InternalServiceError

內部服務錯誤。

RobotApplicationCrash

機器人應用程序異常退出。

SimulationApplicationCrash

模擬應用程式異常結束。

BadPermissionsRobotApplication

無法下載機器人應用程式套件。

BadPermissionsSimulationApplication

無法下載模擬應用程式套裝軟體。

BadPermissions輸出

無法將輸出發佈到客戶提供的 S3 儲存貯體。

BadPermissionsCloudwatchLogs

無法將記錄檔發佈至客戶提供的 CloudWatch 記錄檔資源。

SubnetIpLimitExceeded

超過子網路 IP 限制。

埃尼 LimitExceeded

超過 ENI 限制。

BadPermissionsUserCredentials

無法使用提供的角色。

InvalidBundleRobotApplication

無法解壓縮自動機制套件 (無效的格式、捆綁錯誤或其他問題)。

InvalidBundleSimulationApplication

無法解壓縮模擬套件 (格式無效、捆綁錯誤或其他問題)。

RobotApplicationVersionMismatchedEtag

的 RobotApplication ETag 在版本建立期間不符合值。

SimulationApplicationVersionMismatchedEtag

的 SimulationApplication ETag 在版本建立期間不符合值。

類型:字串

有效值:InternalServiceError | RobotApplicationCrash | SimulationApplicationCrash | RobotApplicationHealthCheckFailure | SimulationApplicationHealthCheckFailure | BadPermissionsRobotApplication | BadPermissionsSimulationApplication | BadPermissionsS3Object | BadPermissionsS3Output | BadPermissionsCloudwatchLogs | SubnetIpLimitExceeded | ENILimitExceeded | BadPermissionsUserCredentials | InvalidBundleRobotApplication | InvalidBundleSimulationApplication | InvalidS3Resource | ThrottlingError | LimitExceeded | MismatchedEtag | RobotApplicationVersionMismatchedEtag | SimulationApplicationVersionMismatchedEtag | ResourceNotFound | RequestThrottled | BatchTimedOut | BatchCanceled | InvalidInput | WrongRegionS3Bucket | WrongRegionS3Output | WrongRegionRobotApplication | WrongRegionSimulationApplication | UploadContentMismatchError

failureReason

有關模擬工作失敗原因的詳細資訊。如需疑難排解的詳細資訊,請參閱疑難排解

類型:字串

長度限制:長度下限為 0。長度上限為 1024。

模式:.*

iamRole

允許模擬執行個體代表您呼叫在其關聯政策中指定的 AWS API 的 IAM 角色。

類型:字串

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

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

lastStartedAt

自紀元以來的時間 (以毫秒為單位),模擬工作上次啟動的時間。

類型:Timestamp

lastUpdatedAt

自紀元以來的時間 (以毫秒為單位),模擬工作上次更新的時間。

類型:Timestamp

loggingConfig

記錄組態。

類型:LoggingConfig 物件

maxJobDurationInSeconds

工作持續時間上限 (以秒計)。此值必須是 8 天 (691,200 秒) 或更少。

類型:Long

name

模擬工作的名稱。

類型:字串

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

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

networkInterface

模擬工作的網路介面資訊。

類型:NetworkInterface 物件

outputLocation

由模擬工作產生的輸出檔案的位置。

類型:OutputLocation 物件

robotApplications

機器人應用程序列表。

類型:RobotApplicationConfig 物件陣列

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

simulationApplications

模擬應用程式的清單。

類型:SimulationApplicationConfig 物件陣列

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

simulationTimeMillis

模擬工作執行持續時間 (毫秒)。

類型:Long

status

模擬工作的狀態。

類型:字串

有效值:Pending | Preparing | Running | Restarting | Completed | Failed | RunningFailed | Terminating | Terminated | Canceled

tags

新增至指定模擬工作的所有標籤清單。

類型:字串到字串映射

地圖項目:0 個項目的最小數目。項目數上限為 50。

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

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

值長度限制:最小長度為 0。長度上限為 256。

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

vpcConfig

VPC 組態。

類型:VPCConfigResponse 物件

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InternalServerException

AWS RoboMaker 遇到服務問題。請再次嘗試呼叫。

HTTP 狀態碼:500

InvalidParameterException

在請求中指定的一個參數無效、未支援或無法使用。傳回之訊息會提供錯誤值的說明。

HTTP 狀態碼:400

ResourceNotFoundException

指定的資源不存在。

HTTP 狀態碼:400

ThrottlingException

AWS 暫 RoboMaker 時無法處理請求。請再次嘗試呼叫。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: