StartReportJob - AWS Backup

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

StartReportJob

指定したレポートプランのオンデマンドレポートジョブを開始します。

リクエストの構文

POST /audit/report-jobs/reportPlanName HTTP/1.1 Content-type: application/json { "IdempotencyToken": "string" }

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

reportPlanName

レポートプランの一意の名前。

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

パターン:[a-zA-Z][_a-zA-Z0-9]*

必須: はい

リクエストボディ

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

IdempotencyToken

別の StartReportJobInput への同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。

タイプ: 文字列

必須: いいえ

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "ReportJobId": "string" }

レスポンス要素

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

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

ReportJobId

レポートジョブの識別子。一意のランダムに生成された UTF-8 エンコード Unicode 文字列 (最大 1,024 バイト長)。レポートジョブ ID を編集することはできません。

型: 文字列

エラー

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

InvalidParameterValueException

パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。

HTTP ステータスコード:400

MissingParameterValueException

必須パラメータがないことを示します。

HTTP ステータスコード:400

ResourceNotFoundException

アクションに必要なリソースは存在しません。

HTTP ステータスコード:400

ServiceUnavailableException

サーバーの一時的障害のため、リクエストは失敗しました。

HTTP ステータスコード:500

その他の参照資料

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