CreateSimulationJob - AWS RoboMaker

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

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

関連ポリシーで指定されたAWS APIがシミュレーションインスタンスによって呼び出されるようにする 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 内のリソースにアクセスする場合は、セキュリティグループ ID とサブネット ID のリストを識別するこのパラメータを指定します。これらは同じ 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" } }

レスポンス要素

アクションが成功すると、サービスは 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

シミュレーションアプリケーションバンドルをダウンロードできませんでした。

BadPermissionsS3 アウトプット

お客様が用意した S3 バケットに出力を発行できません。

BadPermissionsCloudwatchLogs

CloudWatch お客様が提供した Logs リソースにログを公開できません。

SubnetIpLimitExceeded

サブネット IP 限界を超えました

ENI LimitExceeded

ENI 限界を超えました。

BadPermissionsUserCredentials

提供されたロールを使用できません。

InvalidBundleRobotApplication

ロボットバンドルを抽出できません (無効な形式、バンドルエラー、またはその他の問題)。

InvalidBundleSimulationApplication

シミュレーションバンドルを抽出できません (無効な形式、バンドルエラー、またはその他の問題)。

RobotApplicationVersionMismatchedEtag

バージョン作成中に Etag RobotApplication の値が一致しない。

SimulationApplicationVersionMismatchedEtag

Etag for SimulationApplication はバージョン作成中の値と一致しません。

型: 文字列

有効な値: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

iamRole

関連ポリシーで指定されたAWS APIがシミュレーションジョブによって呼び出されるようにする IAM ロール。

型: 文字列

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

パターン: arn:aws:iam::\w+:role/.*

lastStartedAt

シミュレーションジョブが最後に開始されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

lastUpdatedAt

シミュレーションジョブが最後に更新されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

loggingConfig

ログ処理の設定。

タイプ:LoggingConfig オブジェクト

maxJobDurationInSeconds

最大シミュレーションジョブ時間 (秒)。

型: 長整数

outputLocation

シミュレーションジョブの出力ファイルの場所。

タイプ:OutputLocation オブジェクト

robotApplications

シミュレーションジョブで使用されたロボットアプリケーション。

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

配列メンバー: 定数は 1 項目です。

simulationApplications

シミュレーションジョブにより使用されたシミュレーションアプリケーション。

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

配列メンバー: 定数は 1 項目です。

simulationTimeMillis

シミュレーションジョブの実行時間 (ミリ秒)。

型: 長整数

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 オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

IdempotentParameterMismatchException

リクエストは、前の、しかし同一ではないリクエストと同じクライアントトークンを使用します。リクエストが同一でない限り、異なるリクエストでクライアントトークンを再利用しないでください。

HTTP ステータスコード:400

InternalServerException

AWS RoboMaker にサービスの問題が発生しました。もう一度やり直してください。

HTTP ステータスコード:500

InvalidParameterException

リクエストで指定されたパラメータが無効であるか、サポートされていないか、または使用できません。返されたメッセージはエラー値の説明を提供します。​

HTTP ステータスコード:400

LimitExceededException

リクエストされたリソースが最大許容数を超えているか、または同時ストリームリクエストの数が最大許容数を超えています。

HTTP ステータスコード:400

ResourceNotFoundException

指定されたリソースは存在しません。

HTTP ステータスコード:400

ServiceUnavailableException

サーバーの一時的な障害により、リクエストは失敗しました。

HTTP ステータスコード: 503

ThrottlingException

AWS RoboMaker は一時的にリクエストを処理できません。もう一度やり直してください。

HTTP ステータスコード:400

その他の参照資料

言語固有の AWS SDK の 1 つでこの API を使用する方法の詳細については、以下を参照してください。