StartSimulationJobBatch - AWS RoboMaker

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

StartSimulationJobBatch

新しいシミュレーションジョブバッチを開始します。バッチは 1 つまたは複数の SimulationJobRequest オブジェクトを使用して定義されます。

リクエストの構文

POST /startSimulationJobBatch HTTP/1.1 Content-type: application/json { "batchPolicy": { "maxConcurrency": number, "timeoutInSeconds": number }, "clientRequestToken": "string", "createSimulationJobRequests": [ { "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" }, "useDefaultApplications": boolean, "vpcConfig": { "assignPublicIp": boolean, "securityGroups": [ "string" ], "subnets": [ "string" ] } } ], "tags": { "string" : "string" } }

URI リクエストパラメータ

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

リクエストボディ

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

batchPolicy

バッチポリシー。

タイプ:BatchPolicy オブジェクト

必須: いいえ

clientRequestToken

リクエストのべき等のために割り当てる一意の識別子 (大文字と小文字を区別)。

型: 文字列

長さの制限:最小長は 1 です。最大長は 64 文字です。

パターン: [a-zA-Z0-9_\-=]*

必須: いいえ

createSimulationJobRequests

バッチで作成するシミュレーションジョブリクエストのリスト。

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

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

必須: はい

tags

デプロイジョブバッチにアタッチされているタグキーとタグ値を含むマップ。

型: 文字列間のマッピング

マップエントリ: 最小数は 0 項目です。最大数は 50 項目です。

キーの長さ制限: 最小長さは 1 です。最大長は 128 です。

キーパターン: [a-zA-Z0-9 _.\-\/+=:]*

値の長さの制限: 最小長は 0 です。最大長は 256 です。

値のパターン: [a-zA-Z0-9 _.\-\/+=:]*

必須: いいえ

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "arn": "string", "batchPolicy": { "maxConcurrency": number, "timeoutInSeconds": number }, "clientRequestToken": "string", "createdAt": number, "createdRequests": [ { "arn": "string", "computeType": "string", "dataSourceNames": [ "string" ], "lastUpdatedAt": number, "name": "string", "robotApplicationNames": [ "string" ], "simulationApplicationNames": [ "string" ], "status": "string" } ], "failedRequests": [ { "failedAt": number, "failureCode": "string", "failureReason": "string", "request": { "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" }, "useDefaultApplications": boolean, "vpcConfig": { "assignPublicIp": boolean, "securityGroups": [ "string" ], "subnets": [ "string" ] } } } ], "failureCode": "string", "failureReason": "string", "pendingRequests": [ { "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" }, "useDefaultApplications": boolean, "vpcConfig": { "assignPublicIp": boolean, "securityGroups": [ "string" ], "subnets": [ "string" ] } } ], "status": "string", "tags": { "string" : "string" } }

レスポンス要素

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

サービスから以下のデータが JSON 形式で返されます。

arn

バッチの Amazon リソースネーム (ARN)。

タイプ: 文字列

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

パターン: arn:.*

batchPolicy

バッチポリシー。

タイプ:BatchPolicy オブジェクト

clientRequestToken

リクエストのべき等のために割り当てる一意の識別子 (大文字と小文字を区別)。

型: 文字列

長さの制限:最小長は 1 です。最大長は 64 文字です。

パターン: [a-zA-Z0-9_\-=]*

createdAt

シミュレーションジョブバッチが作成されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

createdRequests

作成されたシミュレーションジョブリクエスト概要のリスト。

タイプ:SimulationJobSummary オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。

failedRequests

失敗したシミュレーションジョブリクエストのリスト。シミュレーションジョブに対してリクエストを作成できませんでした。失敗したリクエストにはシミュレーションジョブ ID がありません。

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

failureCode

シミュレーションジョブバッチが失敗した場合の失敗コード。

型: 文字列

有効な値:InternalServiceError

failureReason

シミュレーションジョブバッチが失敗した理由。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 1,024 です。

パターン: .*

pendingRequests

保留中のシミュレーションジョブリクエストのリスト。これらのリクエストはシミュレーションジョブに対してまだ作成されていません。

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

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

status

シミュレーションジョブバッチのステータス。

保留中

シミュレーションジョブバッチリクエストが保留中です。

InProgress

シミュレーションジョブバッチが進行中です。

[失敗]

シミュレーションジョブバッチが失敗しました。内部障害 (InternalServiceError など) により、1 つまたは複数のシミュレーションジョブリクエストを完了できませんでした 詳細については、「failureCode」と「 failureReason」 を参照してください。

完了

シミュレーションバッチジョブが完了しました。バッチは、(1) バッチ内に保留中のシミュレーションジョブリクエストがなく、失敗したシミュレーションジョブリクエストがいずれも InternalServiceError を原因としない場合、および (2) 作成されたすべてのシミュレーションジョブが終了状態に達したとき (例えば Completed または Failed ) に完了となります。

キャンセル

シミュレーションバッチジョブがキャンセルされました。

キャンセル中

シミュレーションバッチジョブをキャンセルしています。

完了中

シミュレーションバッチジョブを完了しています。

TimingOut

シミュレーションバッチジョブがタイムアウトしています。

バッチがタイムアウトし、内部障害(InternalServiceError など) のために失敗していた保留中のリクエストがある場合の場合、バッチステータスは Failed になります。このような失敗リクエストがない場合、バッチステータスは TimedOut になります。

TimedOut

シミュレーションバッチジョブがタイムアウトしました。

型: 文字列

有効な値:Pending | InProgress | Failed | Completed | Canceled | Canceling | Completing | TimingOut | TimedOut

tags

デプロイジョブバッチにアタッチされているタグキーとタグ値を含むマップ。

型: 文字列間のマッピング

マップエントリ: 最小数は 0 項目です。最大数は 50 項目です。

キーの長さ制限: 最小長さは 1 です。最大長は 128 です。

キーパターン: [a-zA-Z0-9 _.\-\/+=:]*

値の長さの制限: 最小長は 0 です。最大長は 256 です。

値のパターン: [a-zA-Z0-9 _.\-\/+=:]*

エラー

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

IdempotentParameterMismatchException

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

HTTP ステータスコード:400

InternalServerException

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

HTTP ステータスコード:500

InvalidParameterException

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

HTTP ステータスコード:400

LimitExceededException

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

HTTP ステータスコード:400

ThrottlingException

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

HTTP ステータスコード:400

その他の参照資料

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