CreateReportPlan - AWS Backup
AnforderungssyntaxURIAnforderungsparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

CreateReportPlan

Erstellt einen Berichtsplan. Ein Berichtsplan ist ein Dokument, das Informationen über den Inhalt des Berichts und darüber, wo er geliefert AWS Backup werden soll, enthält.

Wenn Sie CreateReportPlan mit einem Plan aufrufen, der bereits existiert, erhalten Sie ein AlreadyExistsException-Beispiel.

Anforderungssyntax

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

URIAnforderungsparameter

Die Anfrage verwendet keine URI Parameter.

Anforderungstext

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

IdempotencyToken

Eine vom Kunden gewählte Zeichenfolge, mit der Sie zwischen ansonsten identischen Aufrufen an CreateReportPlanInput unterscheiden können. Der erneute Versuch einer erfolgreichen Anforderung mit demselben Idempotenz-Token führt zu einer Erfolgsmeldung, ohne dass Maßnahmen ergriffen werden.

Typ: Zeichenfolge

Erforderlich: Nein

ReportDeliveryChannel

Eine Struktur, die Informationen darüber enthält, wo und wie Sie Ihre Berichte liefern, insbesondere Ihren Amazon-S3-Bucket-Namen, das S3-Schlüsselpräfix und die Formate Ihrer Berichte.

Typ: ReportDeliveryChannel Objekt

Erforderlich: Ja

ReportPlanDescription

Eine optionale Beschreibung des Berichtsplans mit maximal 1 024 Zeichen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.

Pattern: .*\S.*

Erforderlich: Nein

ReportPlanName

Der eindeutige Name des Berichtsplans. Der Name muss eine Länge von maximal 256 Zeichen haben, die mit einem Buchstaben beginnen und aus Buchstaben (a–z, A–Z), Zahlen (0–9) und Unterstriche (_) bestehen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

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

Erforderlich: Ja

ReportPlanTags

Die Tags, die dem Berichtsplan zugewiesen werden sollen.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Erforderlich: Nein

ReportSetting

Identifiziert die Berichtsvorlage für den Bericht. Berichte werden mithilfe einer Berichtsvorlage erstellt. Die Berichtsvorlagen sind:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

Wenn es sich bei der Berichtsvorlage um RESOURCE_COMPLIANCE_REPORT oder handeltCONTROL_COMPLIANCE_REPORT, beschreibt diese API Ressource auch den Berichtsbereich von AWS-Regionen und die Frameworks.

Typ: ReportSetting Objekt

Erforderlich: Ja

Antwortsyntax

HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "ReportPlanArn": "string",
   "ReportPlanName": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Dienst im JSON Format zurückgegeben.

CreationTime

Datum und Uhrzeit der Erstellung eines Backup-Tresors im Unix-Format und in koordinierter Weltzeit (UTC). Der Wert von CreationTime ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

ReportPlanArn

Ein Amazon-Ressourcenname (ARN), der eine Ressource eindeutig identifiziert. Das Format von ARN hängt vom Ressourcentyp ab.

Typ: Zeichenfolge

ReportPlanName

Der eindeutige Name des Berichtsplans.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

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

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

AlreadyExistsException

Die erforderliche Ressource ist bereits vorhanden.

HTTPStatuscode: 400

InvalidParameterValueException

Zeigt an, dass etwas mit dem Wert eines Parameters nicht stimmt. Beispielsweise liegt der Wert außerhalb des zulässigen Bereichs.

HTTPStatuscode: 400

LimitExceededException

Ein Limit in der Anforderung wurde überschritten, z. B. die maximale Anzahl von Elementen, die in einer Anforderung zulässig sind.

HTTPStatuscode: 400

MissingParameterValueException

Zeigt an, dass ein erforderlicher Parameter fehlt.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anforderung ist aufgrund eines temporären Fehlers des Servers fehlgeschlagen.

HTTPStatuscode: 500

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: