リクエストの構文 URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

CreateDeploymentJob

このアクションは非推奨になりました。

重要

この API はサポートされなくなったため、使用した場合はエラーがスローされます。詳細については、「サポートポリシー」ページの 2022 年 1 月 31 日の更新情報を参照してください。

特定のバージョンのロボットアプリケーションをフリート内のロボットにデプロイします。

ロボットアプリケーションには、整合性のために番号付きの applicationVersion が必要です。新しいバージョンを作成するには、CreateRobotApplicationVersion を使用するか、または「ロボットアプリケーションバージョンの作成」を参照してください。

注記

90 日後、デプロイメントジョブは期限切れになり、削除されます。これらのジョブにはアクセスできなくなります。

リクエストの構文


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

{
   "clientRequestToken": "string",
   "deploymentApplicationConfigs": [ 
      { 
         "application": "string",
         "applicationVersion": "string",
         "launchConfig": { 
            "environmentVariables": { 
               "string" : "string" 
            },
            "launchFile": "string",
            "packageName": "string",
            "postLaunchFile": "string",
            "preLaunchFile": "string"
         }
      }
   ],
   "deploymentConfig": { 
      "concurrentDeploymentPercentage": number,
      "downloadConditionFile": { 
         "bucket": "string",
         "etag": "string",
         "key": "string"
      },
      "failureThresholdPercentage": number,
      "robotDeploymentTimeoutInSeconds": number
   },
   "fleet": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI リクエストパラメータ

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

リクエストボディ

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

clientRequestToken

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

型: 文字列

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

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

必須：はい

deploymentApplicationConfigs

デプロイアプリケーションの設定。

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

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

必須: はい

deploymentConfig

リクエストされたデプロイ設定。

タイプ：DeploymentConfig オブジェクト

必須: いいえ

fleet

デプロイするフリートの Amazon リソースネーム (ARN)。

型: 文字列

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

Pattern: arn:.*

必須：はい

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",
   "createdAt": number,
   "deploymentApplicationConfigs": [ 
      { 
         "application": "string",
         "applicationVersion": "string",
         "launchConfig": { 
            "environmentVariables": { 
               "string" : "string" 
            },
            "launchFile": "string",
            "packageName": "string",
            "postLaunchFile": "string",
            "preLaunchFile": "string"
         }
      }
   ],
   "deploymentConfig": { 
      "concurrentDeploymentPercentage": number,
      "downloadConditionFile": { 
         "bucket": "string",
         "etag": "string",
         "key": "string"
      },
      "failureThresholdPercentage": number,
      "robotDeploymentTimeoutInSeconds": number
   },
   "failureCode": "string",
   "failureReason": "string",
   "fleet": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}

レスポンス要素

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

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

arn

デプロイジョブの Amazon リソースネーム (ARN)。

型: 文字列

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

パターン: arn:.*

createdAt

フリートが作成されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

deploymentApplicationConfigs

デプロイアプリケーションの設定。

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

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

deploymentConfig

デプロイ設定。

タイプ：DeploymentConfig オブジェクト

failureCode

シミュレーションジョブが失敗した場合の失敗コード:

BadPermissionError: AWS Greengrass では、他のサービスにアクセスする場合にサービスレベルロールの許可が必要です。このロールには AWSGreengrassResourceAccessRolePolicy マネージドポリシーが含まれている必要があります。
ExtractingBundleFailure: ロボットアプリケーションをバンドルから抽出できませんでした。
FailureThresholdBreached: 更新できなかったロボットの割合が、デプロイのために設定されている割合を超えました。
GreengrassDeploymentFailed: ロボットアプリケーションをロボットにデプロイできませんでした。
GreengrassGroupVersionDoesNotExist: ロボットに関連付けられている AWS Greengrass グループまたはバージョンが見つかりません。
InternalServerError: 内部エラーが発生しました。リクエストを再試行してください。それでも問題が解決しない場合は、詳細をお知らせください。
MissingRobotApplicationArchitecture: ロボットアプリケーションには、ロボットのアーキテクチャに一致するソースがありません。
MissingRobotDeploymentResource: ロボットアプリケーションに対して指定された 1 つ以上のリソースが見つかりません。例えば、ロボットアプリケーションには正しい起動パッケージと起動ファイルがありますか?
PostLaunchFileFailure: 起動後スクリプトが失敗しました。
PreLaunchFileFailure: 起動前スクリプトが失敗しました。
ResourceNotFound: 1 つ以上のデプロイリソースが見つかりません。例えば、ロボットアプリケーションのソースバンドルはまだ存在していますか?
RobotDeploymentNoResponse: ロボットからの反応がありません。電源が入っていないか、インターネットに接続されていない可能性があります。

型: 文字列

failureReason

デプロイジョブが失敗した場合の失敗の理由。

型: 文字列

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

パターン: .*

fleet

デプロイジョブのターゲットフリート。

型: 文字列

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

パターン: arn:.*

status

デプロイジョブのステータス。

型: 文字列

tags

デプロイジョブに追加されたすべてのタグのリスト。

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

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

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

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

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

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

エラー

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

ConcurrentDeploymentException

障害割合のしきい値割合が満たされました。

HTTP ステータスコード：400

IdempotentParameterMismatchException

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

HTTP ステータスコード：400

InternalServerException

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

HTTP ステータスコード：500

InvalidParameterException

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

HTTP ステータスコード：400

LimitExceededException

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

HTTP ステータスコード：400

ResourceNotFoundException

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

HTTP ステータスコード：400

ThrottlingException

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

HTTP ステータスコード：400

その他の参照資料

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CancelWorldGenerationJob

CreateFleet