StartScanJob - AWS Backup

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.

StartScanJob

Startet das Scannen von Aufträgen für bestimmte Ressourcen.

Anforderungssyntax

PUT /scan/job HTTP/1.1 Content-type: application/json { "BackupVaultName": "string", "IamRoleArn": "string", "IdempotencyToken": "string", "MalwareScanner": "string", "RecoveryPointArn": "string", "ScanBaseRecoveryPointArn": "string", "ScanMode": "string", "ScannerRoleArn": "string" }

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

BackupVaultName

Der Name eines logischen Containers, in dem die Sicherungen gespeichert werden. Backup-Tresore werden anhand von Namen identifiziert, die für das Konto, mit dem sie erstellt wurden, und für die AWS Region, in der sie erstellt wurden, eindeutig sind.

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

Typ: Zeichenfolge

Erforderlich: Ja

IamRoleArn

Gibt den ARN der IAM-Rolle an, der zum Erstellen des Ziel-Wiederherstellungspunkts verwendet wurde; zum Beispiel arn:aws:iam::123456789012:role/S3Access.

Typ: Zeichenfolge

Erforderlich: Ja

IdempotencyToken

Eine vom Kunden gewählte Zeichenfolge, mit der Sie zwischen ansonsten identischen Aufrufen an StartScanJob 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

MalwareScanner

Gibt den Malware-Scanner an, der während des Scanauftrags verwendet wurde. Unterstützt derzeit nurGUARDDUTY.

Typ: Zeichenfolge

Zulässige Werte: GUARDDUTY

Erforderlich: Ja

RecoveryPointArn

Ein Amazon-Ressourcenname (ARN), der einen Wiederherstellungspunkt eindeutig identifiziert. Dies ist Ihr Ziel-Erholungspunkt für einen vollständigen Scan. Wenn Sie einen inkrementellen Scan ausführen, ist dies Ihr Erholungspunkt, der nach der Auswahl Ihres Basiswiederherstellungspunkts erstellt wurde.

Typ: Zeichenfolge

Erforderlich: Ja

ScanBaseRecoveryPointArn

Ein ARN, der den Basiswiederherstellungspunkt, der für das inkrementelle Scannen verwendet werden soll, eindeutig identifiziert.

Typ: Zeichenfolge

Erforderlich: Nein

ScanMode

Gibt den für den Scanauftrag verwendeten Scantyp an.

Beinhaltet:

  • FULL_SCANscannt die gesamte Datenlinie innerhalb des Backups.

  • INCREMENTAL_SCANscannt den Datenunterschied zwischen dem Zielwiederherstellungspunkt und dem Basiswiederherstellungspunkt-ARN.

Typ: Zeichenfolge

Zulässige Werte: FULL_SCAN | INCREMENTAL_SCAN

Erforderlich: Ja

ScannerRoleArn

Der ARN für die IAM-Scannerrolle wurde angegeben.

Typ: Zeichenfolge

Erforderlich: Ja

Antwortsyntax

HTTP/1.1 201 Content-type: application/json { "CreationDate": number, "ScanJobId": "string" }

Antwortelemente

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

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

CreationDate

Das Datum und die Uhrzeit der Erstellung eines Backup-Auftrags im Unix-Zeitformat und in der koordinierten Weltzeit (UTC). Der Wert von CreationDate ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

ScanJobId

Identifiziert eindeutig eine Anfrage AWS Backup zur Sicherung einer Ressource.

Typ: Zeichenfolge

Fehler

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

InvalidParameterValueException

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

Context

Type

HTTP-Statuscode: 400

InvalidRequestException

Zeigt an, dass etwas mit der Eingabe für die Anforderung nicht stimmt. Beispielsweise ist ein Parameter vom falschen Typ.

Context

Type

HTTP-Statuscode: 400

LimitExceededException

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

Context

Type

HTTP-Statuscode: 400

MissingParameterValueException

Zeigt an, dass ein erforderlicher Parameter fehlt.

Context

Type

HTTP-Statuscode: 400

ResourceNotFoundException

Eine Ressource, die für die Aktion erforderlich ist, ist nicht vorhanden.

Context

Type

HTTP-Statuscode: 400

ServiceUnavailableException

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

Context

Type

HTTP Status Code: 500

Weitere Informationen finden Sie unter:

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