リクエストの構文 URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

サポート終了通知: 2025 AWS 年 9 月 10 日、は AWS RoboMaker のサポートを終了します。2025 年 9 月 10 日以降、 AWS RoboMaker コンソールまたは AWS RoboMaker リソースにアクセスできなくなります。コンテナ化されたシミュレーションの実行に役立つ AWS Batch への移行の詳細については、このブログ記事を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DescribeSimulationJob

重要

シミュレーションジョブを記述します。

リクエストの構文


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

{
   "job": "string"
}

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

job

記述されるシミュレーションジョブの Amazon リソースネーム (ARN)。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 1224 です。

Pattern: 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: シミュレーションアプリケーションバンドルをダウンロードできませんでした。
BadPermissionsS3Output: お客様が用意した S3 バケットに出力を発行できません。
BadPermissionsCloudwatchLogs: お客様が用意した CloudWatch Logs リソースにログを発行できません。
SubnetIpLimitExceeded: サブネット IP 限界を超えました
ENILimitExceeded: ENI 限界を超えました。
BadPermissionsUserCredentials: 提供されたロールを使用できません。
InvalidBundleRobotApplication: ロボットバンドルを抽出できません (無効な形式、バンドルエラー、またはその他の問題)。
InvalidBundleSimulationApplication: シミュレーションバンドルを抽出できません (無効な形式、バンドルエラー、またはその他の問題)。
RobotApplicationVersionMismatchedEtag: RobotApplication の Etag がバージョン作成時の値と一致しません。
SimulationApplicationVersionMismatchedEtag: SimulationApplication の Etag がバージョンの作成時の値と一致しません。