SyncDeploymentJob - AWS RoboMaker

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

SyncDeploymentJob

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

重要

この API はサポートされなくなりました。詳細については、「サポートポリシー」ページの 2022 年 5 月 2 日の更新をご覧ください。

フリート内のロボットを最新のデプロイに同期させます。これは、デプロイ後にロボットが追加された場合に便利です。

リクエストの構文

POST /syncDeploymentJob HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "fleet": "string" }

URI リクエストパラメータ

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

リクエストボディ

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

clientRequestToken

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

型: 文字列

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

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

必須:はい

fleet

同期のターゲットフリート。

型: 文字列

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

Pattern: arn:.*

必須:はい

レスポンスの構文

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" }

レスポンス要素

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

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

arn

同期リクエストの Amazon リソースネーム (ARN)。

型: 文字列

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

パターン: arn:.*

createdAt

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

型: タイムスタンプ

deploymentApplicationConfigs

デプロイアプリケーション設定に関する情報。

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

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

deploymentConfig

デプロイ設定に関する情報。

タイプ:DeploymentConfig オブジェクト

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 はバージョン作成中の値と一致しません。

型: 文字列

有効な値:ResourceNotFound | EnvironmentSetupError | EtagMismatch | FailureThresholdBreached | RobotDeploymentAborted | RobotDeploymentNoResponse | RobotAgentConnectionTimeout | GreengrassDeploymentFailed | InvalidGreengrassGroup | MissingRobotArchitecture | MissingRobotApplicationArchitecture | MissingRobotDeploymentResource | GreengrassGroupVersionDoesNotExist | LambdaDeleted | ExtractingBundleFailure | PreLaunchFileFailure | PostLaunchFileFailure | BadPermissionError | DownloadConditionFailed | BadLambdaAssociated | InternalServerError | RobotApplicationDoesNotExist | DeploymentFleetDoesNotExist | FleetDeploymentTimeout

failureReason

ジョブが失敗した場合の失敗の理由。

型: 文字列

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

パターン: .*

fleet

フリートの Amazon リソースネーム (ARN)。

タイプ: 文字列

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

パターン: arn:.*

status

同期ジョブのステータス。

型: 文字列

有効な値:Pending | Preparing | InProgress | Failed | Succeeded | Canceled

エラー

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

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 を使用する方法の詳細については、以下を参照してください。