View a markdown version of this page

GetJob - Amazon Location Service

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

GetJob

GetJob オペレーションは、現在のステータス、設定、タイムスタンプ、エラー情報など、特定のジョブに関する情報を取得します。このオペレーションを使用して、ジョブの進行状況をモニタリングし、設定の詳細を確認します。完了したジョブの場合、この情報を使用して、結果にアクセスする前に正常に処理されたことを確認できます。

詳細については、Amazon Location Service API リファレンスGetJob」を参照してください。

この API のリクエスト、レスポンス、CLI コマンドの例については、「ジョブの進行状況をモニタリングする方法」を参照してください。

ユースケース

  • ジョブのステータスと進行状況のモニタリング: 保留中、実行中、完了状態を通じてジョブのライフサイクルの進行状況を追跡し、処理が完了し、結果がダウンロード可能になったタイミングを判断します。ワークフロー管理とレポートのジョブステータスをモニタリングします。

  • エラー診断: 処理の問題をトラブルシューティングするための特定のエラーメッセージや失敗の理由など、ジョブが失敗したときに詳細なエラー情報を取得します。

  • 設定の検証: 処理を開始する前に、入力/出力の場所、実行ロール、リクエストされた機能など、ジョブ設定の詳細を確認します。

リクエストを理解する

GetJob リクエストでは、特定のジョブに関する包括的な情報を取得するために 1 つのパラメータのみが必要です。このシンプルなリクエスト構造により、ジョブのステータスを簡単にモニタリングし、詳細な設定と処理情報を取得できます。

リクエストには、次のパラメータが含まれます。

ジョブ識別

情報を取得するジョブを指定する必須パラメータ。

  • JobId: 取得するジョブの一意の識別子。パターン に一致する 1~100 文字にする必要があります[-._\w]+。これは、ジョブの作成時に StartJobオペレーションによって返される識別子と同じです。

レスポンスを理解する

GetJob レスポンスは、現在のステータス、完全な設定、処理タイムスタンプ、エラー情報など、指定されたジョブに関する情報を提供します。このレスポンスを使用して、ジョブのステータスをモニタリングし、発生する可能性のあるエラーをトラブルシューティングできます。

レスポンスには、次のフィールドが含まれます。

ジョブ識別

一意の識別子と基本的なジョブ情報。

  • JobId: モニタリングおよび管理オペレーションに使用される一意のジョブ識別子。

  • JobArn: 内のジョブを一意に識別する ARN AWS。

  • Name: ジョブの作成時に指定した場合、人間が読み取れるジョブ名。

ジョブのステータスとライフサイクル

現在のジョブの状態と処理タイムライン情報。

  • Status: 処理状態 (保留中、実行中、完了、失敗、キャンセル、またはキャンセル済み) を示す現在のジョブステータス。

  • CreatedAt: ISO 8601 形式のジョブ作成タイムスタンプ。

  • UpdatedAt: ISO 8601 形式の最終ステータス更新タイムスタンプ。

  • EndedAt: ISO 8601 形式のジョブ完了タイムスタンプ。ターミナル状態のジョブにのみ存在します。

ジョブ設定

作成時に指定されたとおりにジョブ設定を完了します。

  • Action: 実行中のオペレーションのタイプ (現在ValidateAddressは のみサポートされています)。

  • ExecutionRoleArn: ジョブの実行中に Amazon S3 バケットにアクセスするために使用する IAM ロール ARN。

  • InputOptions: Amazon S3 の場所とデータ形式を含む入力設定。

  • OutputOptions: Amazon S3 の送信先と結果形式を含む出力設定。

  • ActionOptions: Positionや など、ジョブにリクエストされたオプションの追加機能CountrySpecificAttributes

エラー情報

ジョブが失敗すると、問題の診断と解決に役立つエラーの詳細がレスポンスに含まれます。

  • Error: 失敗に関する詳細を含むJobErrorオブジェクト。このオブジェクトには、次のフィールドが含まれます。

    • Code: 失敗のタイプを識別するエラーコード。

    • Messages: トラブルシューティングのための追加のコンテキストを提供する人間が読み取れるメッセージのリスト。