DescribeDeploymentJob - AWS RoboMaker

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

DescribeDeploymentJob

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

重要

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

デプロイジョブを記述します。

リクエストの構文

POST /describeDeploymentJob HTTP/1.1 Content-type: application/json { "job": "string" }

URI リクエストパラメータ

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

リクエストボディ

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

job

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

型: 文字列

長さの制限:最小長は 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", "robotDeploymentSummary": [ { "arn": "string", "deploymentFinishTime": number, "deploymentStartTime": number, "failureCode": "string", "failureReason": "string", "progressDetail": { "currentProgress": "string", "estimatedTimeRemainingSeconds": number, "percentDone": number, "targetResource": "string" }, "status": "string" } ], "status": "string", "tags": { "string" : "string" } }

レスポンス要素

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

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

arn

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

型: 文字列

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

パターン: arn:.*

createdAt

デプロイジョブが作成されたときの、エポックからのミリ秒単位の時間。

型: タイムスタンプ

deploymentApplicationConfigs

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

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

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

deploymentConfig

デプロイ設定。

タイプ:DeploymentConfig オブジェクト

failureCode

デプロイジョブの失敗コード。

型: 文字列

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

robotDeploymentSummary

ロボットデプロイ概要のリスト。

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

status

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

型: 文字列

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

tags

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

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

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

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

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

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

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

エラー

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

InternalServerException

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

HTTP ステータスコード:500

InvalidParameterException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

ThrottlingException

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

HTTP ステータスコード:400

その他の参照資料

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