CreateReportPlan - AWS Backup

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

CreateReportPlan

レポート計画を作成します。レポートプランは、レポートの内容と AWS Backup 、 がレポートを提供する場所に関する情報を含むドキュメントです。

CreateReportPlan すでに存在するプランで電話する場合は、AlreadyExistsException の例外を受信します。

リクエストの構文

POST /audit/report-plans HTTP/1.1 Content-type: application/json { "IdempotencyToken": "string", "ReportDeliveryChannel": { "Formats": [ "string" ], "S3BucketName": "string", "S3KeyPrefix": "string" }, "ReportPlanDescription": "string", "ReportPlanName": "string", "ReportPlanTags": { "string" : "string" }, "ReportSetting": { "Accounts": [ "string" ], "FrameworkArns": [ "string" ], "NumberOfFrameworks": number, "OrganizationUnits": [ "string" ], "Regions": [ "string" ], "ReportTemplate": "string" } }

URI リクエストパラメータ

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

リクエスト本文

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

IdempotencyToken

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

型: 文字列

必須: いいえ

ReportDeliveryChannel

レポートを配信する場所および方法について。特に Amazon S3 バケット名、S3 key prefix、レポートの形式に関する情報を含む構造。

型: ReportDeliveryChannel オブジェクト

必須:はい

ReportPlanDescription

最大 1,024 文字までのレポートプランの任意の記述。

型: 文字列

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

パターン: .*\S.*

必須: いいえ

ReportPlanName

レポートプランの一意の名前。名前は文字から始まる1~256文字で、文字 (a~z、A~Z)、数字 (0~9)、およびアンダースコア (_)により構成されます。

型: 文字列

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

Pattern: [a-zA-Z][_a-zA-Z0-9]*

必須:はい

ReportPlanTags

レポートプランに割り当てるタグ。

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

必須:いいえ

ReportSetting

レポートのレポートテンプレートを識別します。レポートは、レポートテンプレートを使用して構築されます。レポートテンプレートは次のとおりです。 

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

レポートテンプレートが RESOURCE_COMPLIANCE_REPORTまたは の場合CONTROL_COMPLIANCE_REPORT、このAPIリソースは AWS リージョン および フレームワークによるレポートカバレッジについても説明します。

型: ReportSetting オブジェクト

必須:はい

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "CreationTime": number, "ReportPlanArn": "string", "ReportPlanName": "string" }

レスポンス要素

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

次のデータは、 サービスによって JSON 形式で返されます。

CreationTime

Unix 形式と協定世界時 () でバックアップボールトが作成された日時UTC。CreationTime の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。

型: タイムスタンプ

ReportPlanArn

リソースを一意に識別する Amazon リソースネーム (ARN)。の形式は、リソースタイプARNによって異なります。

型: 文字列

ReportPlanName

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

型: 文字列

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

Pattern: [a-zA-Z][_a-zA-Z0-9]*

エラー

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

AlreadyExistsException

必要なリソースは既に存在します。

HTTP ステータスコード: 400

InvalidParameterValueException

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

HTTP ステータスコード: 400

LimitExceededException

たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。

HTTP ステータスコード: 400

MissingParameterValueException

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

HTTP ステータスコード: 400

ServiceUnavailableException

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

HTTP ステータスコード: 500

以下の資料も参照してください。

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