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

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

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

CreateSimulationJob

重要

シミュレーションジョブを作成します。

注記

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 で入手できます。

注記

ファイル数は 100 個、全 DataSourceConfig オブジェクトの合計サイズは 25GB に制限されます。

型: DataSourceConfig オブジェクトの配列

配列メンバー：最小数は 1 項目です。最大数は 6 項目です。

必須：いいえ

failureBehavior

シミュレーションジョブの失敗動作。

続行: 4XX エラーコード後の最大タイムアウト期間中もインスタンスが実行されるようにします。
失敗: シミュレーションジョブを停止し、インスタンスを終了します。

型: 文字列

有効な値: Fail | Continue

必須：いいえ

iamRole

シミュレーションインスタンスがユーザーに代わって関連するポリシーでAWSAPIs指定されたを呼び出すことを許可するIAMロール名。これは、シミュレーションジョブに認証情報が渡される方法になります。

タイプ: 文字列

長さの制限：最小長は 1 です。最大長は 255 です。

Pattern: 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。少なくとも 1 つのセキュリティグループと 1 つのサブネット 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"
   }
}

レスポンス要素

アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。

次のデータは、サービスによって 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 が値と一致しません。
SimulationApplicationVersionMismatchedEtag: のバージョン作成時にのタグ SimulationApplication が値と一致しません。