# Prüfungsbefehle ## Verwalten von Prüfungseinstellungen Konfigurieren Sie mit `UpdateAccountAuditConfiguration` die Audit-Einstellungen für Ihr Konto. Mit diesem Befehl können Sie die Prüfungen aktivieren, die für Audits verfügbar sein sollen, optionale Benachrichtigungen einrichten und Berechtigungen konfigurieren. Überprüfen Sie diese Einstellungen mit `DescribeAccountAuditConfiguration`. Verwenden Sie `DeleteAccountAuditConfiguration` zum Löschen Ihrer Audit-Einstellungen. Damit werden alle Standardwerte wiederhergestellt und Audits auf effiziente Weise deaktiviert, da alle Prüfungen standardmäßig deaktiviert sind. ### UpdateAccountAuditConfiguration Konfiguriert erstmals oder von neuem die Device Defender-Audit-Einstellungen für dieses Konto. Die Einstellungen legen u. a. fest, wie Audit-Benachrichtigungen gesendet werden und welche Prüfungen aktiviert oder deaktiviert sind. **Syntax** ``` aws iot update-account-audit-configuration \ [--role-arn ] \ [--audit-notification-target-configurations ] \ [--audit-check-configurations ] \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "roleArn": "string", "auditNotificationTargetConfigurations": { "string": { "targetArn": "string", "roleArn": "string", "enabled": "boolean" } }, "auditCheckConfigurations": { "string": { "enabled": "boolean" } } } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | roleArn | Zeichenfolge Länge max. 2048, min. 20 | Der ARN der Rolle, die AWS IoT zum Zugriff auf Informationen zu Ihren Geräten, Richtlinien, Zertifikaten und anderen Elemente berechtigt, wenn ein Audit durchgeführt wird. | | auditNotificationTargetConfigurations | map | Informationen über die Ziele, an die Audit-Benachrichtigungen gesendet werden. | | targetArn | Zeichenfolge | Der ARN des Ziels (SNS-Thema), an das Audit-Benachrichtigungen gesendet werden. | | roleArn | Zeichenfolge Länge max. 2048, min. 20 | Der ARN der Rolle, die die Berechtigung zum Senden von Benachrichtigungen an das Ziel erteilt. | | aktiviert | boolesch | True, wenn Benachrichtigungen an das Ziel aktiviert sind. | | auditCheckConfigurations | map | Gibt an, welche Audit-Prüfungen für dieses Konto aktiviert und deaktiviert sind. Zeigen Sie mit `DescribeAccountAuditConfiguration` die Liste aller Prüfungen an, einschließlich derjenigen, die derzeit aktiviert sind. Mit dem Sammeln bestimmter Daten wird möglicherweise sofort begonnen, wenn bestimmte Prüfungen aktiviert werden. Wenn eine Prüfung deaktiviert ist, werden alle bisher gesammelten Informationen bezüglich der Prüfung gelöscht wird. Sie können keine Prüfungen deaktivieren, die Teil eines geplanten Audits sind. Sie müssen zuerst die Prüfung aus dem geplanten Audit oder das geplante Audit selbst löschen. Dieser Parameter ist beim ersten Aufruf von `UpdateAccountAuditConfiguration` erforderlich und muss mindestens eine aktivierte Prüfung angeben. | | aktiviert | boolesch | True, wenn diese Audit-Prüfung für dieses Konto aktiviert ist. | | Konfiguration | map | (Optional) Benutzerdefinierte Konfigurationen für bestimmte Auditprüfungen, z. B. `CERT_AGE_THRESHOLD_IN_DAYS` und `CERT_EXPIRATION_THRESHOLD_IN_DAYS`, mit denen Sie festlegen können, wann Sie über das Alter eines Zertifikats und dessen bevorstehenden Ablauf benachrichtigt werden möchten. | Output Keine **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ### DescribeAccountAuditConfiguration Ruft Informationen zu den Device Defender Audit-Einstellungen für dieses Konto ab. Die Einstellungen legen u. a. fest, wie Audit-Benachrichtigungen gesendet werden und welche Prüfungen aktiviert oder deaktiviert sind. **Syntax** ``` aws iot describe-account-audit-configuration \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { } ``` Output ``` { "roleArn": "string", "auditNotificationTargetConfigurations": { "string": { "targetArn": "string", "roleArn": "string", "enabled": "boolean" } }, "auditCheckConfigurations": { "string": { "enabled": "boolean" } } } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | roleArn | Zeichenfolge Länge max. 2048, min. 20 | Der ARN der Rolle, die AWS IoT zum Zugriff auf Informationen zu Ihren Geräten, Richtlinien, Zertifikaten und anderen Elemente berechtigt, wenn ein Audit durchgeführt wird. Beim ersten Aufruf von `UpdateAccountAuditConfiguration` ist dieser Parameter erforderlich. | | auditNotificationTargetConfigurations | map | Informationen über die Ziele, an die Audit-Benachrichtigungen für dieses Konto gesendet werden. | | targetArn | Zeichenfolge | Der ARN des Ziels (SNS-Thema), an das Audit-Benachrichtigungen gesendet werden. | | roleArn | Zeichenfolge Länge max. 2048, min. 20 | Der ARN der Rolle, die die Berechtigung zum Senden von Benachrichtigungen an das Ziel erteilt. | | aktiviert | boolesch | True, wenn Benachrichtigungen an das Ziel aktiviert sind. | | auditCheckConfigurations | map | Gibt an, welche Audit-Prüfungen für dieses Konto aktiviert und deaktiviert sind. | | aktiviert | boolesch | True, wenn diese Audit-Prüfung für dieses Konto aktiviert ist. | | Konfiguration | map | (Optional) Stellt spezielle Konfigurationen für bestimmte Auditprüfungen bereit, z. B. zum maximal zulässigen Zertifikatalter oder zur Anzahl der Tage vor dem Ablauf, bei deren Erreichen eine Warnung ausgelöst werden soll. | **Fehler** `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ### DeleteAccountAuditConfiguration Stellt die Standardeinstellungen für Device Defender-Audits für dieses Konto wieder her. Alle Konfigurationsdaten, die Sie eingegeben haben, werden gelöscht, und alle Auditprüfungen werden auf „Deaktiviert“ zurückgesetzt. **Syntax** ``` aws iot delete-account-audit-configuration \ [--delete-scheduled-audits | --no-delete-scheduled-audits] \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "deleteScheduledAudits": "boolean" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | deleteScheduledAudits | boolesch | Ist diese Option auf „true“ gesetzt, werden alle geplanten Audits gelöscht. | Output Keine **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ResourceNotFoundException` Die angegebene Ressource ist nicht vorhanden. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ## Planen von Audits Erstellen Sie einen oder mehrere geplante Audits mithilfe von `CreateScheduledAudit`. Mit diesem Befehl können Sie die Prüfungen angeben, die Sie während eines Audits durchführen möchten, und wie oft der Audit ausgeführt werden soll. Verfolgen Sie Ihre geplanten Audits mit `ListScheduledAudits` und `DescribeScheduledAudit`. Ändern Sie einen vorhandenen geplanten Audit mit mit `UpdateScheduledAudit` oder löschen Sie ihn mit `DeleteScheduledAudit`. ### CreateScheduledAudit Erstellt einen geplanten Audit, der in einem angegebenen Zeitintervall ausgeführt wird. **Syntax** ``` aws iot create-scheduled-audit \ --frequency \ [--day-of-month ] \ [--day-of-week ] \ --target-check-names \ [--tags ] \ --scheduled-audit-name \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string", "targetCheckNames": [ "string" ], "tags": [ { "Key": "string", "Value": "string" } ], "scheduledAuditName": "string" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | frequency | Zeichenfolge | Wie oft der geplante Audit stattfindet. Kann entweder DAILY, WEEKLY, BIWEEKLY oder MONTHLY sein. Der tatsächliche Startzeitpunkt der einzelnen Prüfungen wird vom System bestimmt. enum: DAILY \$1 WEEKLY \$1 BIWEEKLY \$1 MONTHLY | | dayOfMonth | Zeichenfolge pattern: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | Das Tag des Monats, an dem der geplante Audit stattfindet. Kann 1 bis 31 oder LAST sein. Dieses Feld ist erforderlich, wenn der Parameter `frequency` auf MONTHLY eingestellt ist. Wenn die Tage 29-31 angegeben werden und der Monat nicht so viele Tage hat, erfolgt der Audit am Tag LAST des Monats. | | dayOfWeek | Zeichenfolge | Das Tag der Woche, an dem der geplante Audit stattfindet. Kann entweder SUN, MON, TUE,WED, THU, FRI oder SAT sein. Dieses Feld ist erforderlich, wenn der Parameter `frequency` auf WEEKLY oder BIWEEKLY eingestellt ist. enum: SUN \$1 MON \$1 TUE \$1 WED \$1 THU \$1 FRI \$1 SAT | | targetCheckNames | auflisten member: AuditCheckName | Gibt an, welche Prüfungen während des geplanten Audits ausgeführt werden. Die Prüfungen müssen für Ihr Konto aktiviert sein. (Verwenden Sie `DescribeAccountAuditConfiguration`, um die Liste aller Prüfungen, einschließlich aller aktivierten, anzuzeigen, oder `UpdateAccountAuditConfiguration`, um auszuwählen, welche Prüfungen aktiviert sind.) | | tags | auflisten member: Tag java class: java.util.List | Metadaten, die zum Verwalten der geplanten Prüfung verwendet werden können. | | Schlüssel | Zeichenfolge | Der Tag-Schlüssel. | | Wert | Zeichenfolge | Der Tag-Wert. | | scheduledAuditName | Zeichenfolge length- max:128 min:1 pattern: [a-zA-Z0-9\$1-]\$1 | Der Name, den Sie dem geplanten Audit zuweisen möchten. (Maximal 128 Zeichen) | Output ``` { "scheduledAuditArn": "string" } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | scheduledAuditArn | Zeichenfolge | Der ARN des geplanten Audits. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. `LimitExceededException` Ein Grenzwert wurde überschritten. ### ListScheduledAudits Listet alle Ihre geplanten Audits auf. **Syntax** ``` aws iot list-scheduled-audits \ [--next-token ] \ [--max-results ] \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "nextToken": "string", "maxResults": "integer" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | nextToken | Zeichenfolge | Das Token für den nächsten Ergebnissatz. | | maxResults | Ganzzahl range- max:250 min:1 | Die maximale Anzahl der Ergebnisse, die auf einmal zurückgegeben werden sollen. Der Standardwert ist 25. | Output ``` { "scheduledAudits": [ { "scheduledAuditName": "string", "scheduledAuditArn": "string", "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string" } ], "nextToken": "string" } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | scheduledAudits | auflisten member: ScheduledAuditMetadata java class: java.util.List | Die Liste der geplanten Audits. | | scheduledAuditName | Zeichenfolge length- max:128 min:1 pattern: [a-zA-Z0-9\$1-]\$1 | Der Name des geplanten Audits. | | scheduledAuditArn | Zeichenfolge | Der ARN des geplanten Audits. | | frequency | Zeichenfolge | Wie oft der geplante Audit stattfindet. enum: DAILY \$1 WEEKLY \$1 BIWEEKLY \$1 MONTHLY | | dayOfMonth | Zeichenfolge pattern: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | Der Tag des Monats, an dem der geplante Audit ausgeführt wird (wenn der Wert für `frequency` MONTHLY lautet). Wenn die Tage 29-31 angegeben werden und der Monat nicht so viele Tage hat, erfolgt der Audit am Tag LAST des Monats. | | dayOfWeek | Zeichenfolge | Der Tag der Woche, an dem der geplante Audit ausgeführt wird (wenn der Wert für `frequency` WEEKLY oder BIWEEKLY lautet). enum: SUN \$1 MON \$1 TUE \$1 WED \$1 THU \$1 FRI \$1 SAT | | nextToken | Zeichenfolge | Ein Token, mit dem der nächste Ergebnissatzes abgerufen werden kann, bzw. `null`, wenn keine weiteren Ergebnisse vorliegen. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ### DescribeScheduledAudit Ruft Informationen zu einem geplanten Audit ab. **Syntax** ``` aws iot describe-scheduled-audit \ --scheduled-audit-name \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "scheduledAuditName": "string" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | scheduledAuditName | Zeichenfolge length- max:128 min:1 pattern: [a-zA-Z0-9\$1-]\$1 | Der Name des geplanten Audits, dessen Daten Sie abrufen möchten. | Output ``` { "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string", "targetCheckNames": [ "string" ], "scheduledAuditName": "string", "scheduledAuditArn": "string" } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | frequency | Zeichenfolge | Wie oft der geplante Audit stattfindet. Entweder DAILY, WEEKLY, BIWEEKLY oder MONTHLY. Der tatsächliche Startzeitpunkt der einzelnen Prüfungen wird vom System bestimmt. enum: DAILY \$1 WEEKLY \$1 BIWEEKLY \$1 MONTHLY | | dayOfMonth | Zeichenfolge pattern: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | Das Tag des Monats, an dem der geplante Audit stattfindet. Kann 1 bis 31 oder LAST sein. Wenn die Tage 29-31 angegeben werden und der Monat nicht so viele Tage hat, erfolgt der Audit am Tag LAST des Monats. | | dayOfWeek | Zeichenfolge | Das Tag der Woche, an dem der geplante Audit stattfindet. Entweder SUN, MON, TUE, WED, THU, FRI oder SAT. enum: SUN \$1 MON \$1 TUE \$1 WED \$1 THU \$1 FRI \$1 SAT | | targetCheckNames | auflisten member: AuditCheckName | Gibt an, welche Prüfungen während des geplanten Audits ausgeführt werden. Die Prüfungen müssen für Ihr Konto aktiviert sein. (Verwenden Sie `DescribeAccountAuditConfiguration`, um die Liste aller Prüfungen, einschließlich aller aktivierten, anzuzeigen, oder `UpdateAccountAuditConfiguration`, um auszuwählen, welche Prüfungen aktiviert sind.) | | scheduledAuditName | Zeichenfolge length- max:128 min:1 pattern: [a-zA-Z0-9\$1-]\$1 | Der Name des geplanten Audits. | | scheduledAuditArn | Zeichenfolge | Der ARN des geplanten Audits. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ResourceNotFoundException` Die angegebene Ressource ist nicht vorhanden. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ### UpdateScheduledAudit Aktualisiert einen geplanten Audit, einschließlich welche Prüfungen durchgeführt werden und wie oft der Audit stattfindet. **Syntax** ``` aws iot update-scheduled-audit \ [--frequency ] \ [--day-of-month ] \ [--day-of-week ] \ [--target-check-names ] \ --scheduled-audit-name \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string", "targetCheckNames": [ "string" ], "scheduledAuditName": "string" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | frequency | Zeichenfolge | Wie oft der geplante Audit stattfindet. Kann entweder DAILY, WEEKLY, BIWEEKLY oder MONTHLY sein. Der tatsächliche Startzeitpunkt der einzelnen Prüfungen wird vom System bestimmt. enum: DAILY \$1 WEEKLY \$1 BIWEEKLY \$1 MONTHLY | | dayOfMonth | Zeichenfolge pattern: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | Das Tag des Monats, an dem der geplante Audit stattfindet. Kann 1 bis 31 oder LAST sein. Dieses Feld ist erforderlich, wenn der Parameter `frequency` auf MONTHLY eingestellt ist. Wenn die Tage 29-31 angegeben werden und der Monat nicht so viele Tage hat, erfolgt der Audit am Tag LAST des Monats. | | dayOfWeek | Zeichenfolge | Das Tag der Woche, an dem der geplante Audit stattfindet. Kann entweder SUN, MON, TUE, WED, THU, FRI oder SAT sein. Dieses Feld ist erforderlich, wenn der Parameter `frequency` auf WEEKLY oder BIWEEKLY eingestellt ist. enum: SUN \$1 MON \$1 TUE \$1 WED \$1 THU \$1 FRI \$1 SAT | | targetCheckNames | auflisten member: AuditCheckName | Gibt an, welche Prüfungen während des geplanten Audits ausgeführt werden. Die Prüfungen müssen für Ihr Konto aktiviert sein. (Verwenden Sie `DescribeAccountAuditConfiguration`, um die Liste aller Prüfungen, einschließlich aller aktivierten, anzuzeigen, oder `UpdateAccountAuditConfiguration`, um auszuwählen, welche Prüfungen aktiviert sind.) | | scheduledAuditName | Zeichenfolge length- max:128 min:1 pattern: [a-zA-Z0-9\$1-]\$1 | Der Name des geplanten Audits. (Maximal 128 Zeichen) | Output ``` { "scheduledAuditArn": "string" } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | scheduledAuditArn | Zeichenfolge | Der ARN des geplanten Audits. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ResourceNotFoundException` Die angegebene Ressource ist nicht vorhanden. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ### DeleteScheduledAudit Löscht ein geplantes Audit. **Syntax** ``` aws iot delete-scheduled-audit \ --scheduled-audit-name \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "scheduledAuditName": "string" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | scheduledAuditName | Zeichenfolge length- max:128 min:1 pattern: [a-zA-Z0-9\$1-]\$1 | Der Name des geplanten Audits, das Sie löschen möchten. | Output Keine **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ResourceNotFoundException` Die angegebene Ressource ist nicht vorhanden. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ## Ausführen einer On-Demand-Prüfung Geben Sie mit `StartOnDemandAuditTask` die Prüfungen an, die Sie ausführen möchten, und starten Sie einen sofort ausgeführten Audit. ### StartOnDemandAuditTask Startet einen On-Demand-Device Defender-Audit. **Syntax** ``` aws iot start-on-demand-audit-task \ --target-check-names \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "targetCheckNames": [ "string" ] } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | targetCheckNames | auflisten member: AuditCheckName | Gibt an, welche Prüfungen während des Audits ausgeführt werden. Die Prüfungen, die Sie angeben, müssen für Ihr Konto aktiviert sein. Andernfalls tritt eine Ausnahme auf. Verwenden Sie `DescribeAccountAuditConfiguration`, um die Liste aller Prüfungen, einschließlich aller aktivierten, anzuzeigen, oder `UpdateAccountAuditConfiguration`, um auszuwählen, welche Prüfungen aktiviert sind. | Output ``` { "taskId": "string" } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | taskId | Zeichenfolge length- max:40 min:1 pattern: [a-zA-Z0-9-]\$1 | Die ID des On-Demand-Audits, den Sie gestartet haben. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. `LimitExceededException` Ein Grenzwert wurde überschritten. ## Verwalten von Prüfungs-Instances Mit `DescribeAuditTask` können Sie Informationen zu einer bestimmten Audit-Instance anzufordern. Wenn der Audit bereits ausgeführt wurde, umfassen die Ergebnisse, welche Prüfungen fehlgeschlagen sind und welche bestanden wurden und welche Prüfungen das System nicht durchführen konnte. Wenn der Audit noch nicht beendet wurde, zeigen die Ergebnisse auf, welche Prüfungen derzeit noch durchgeführt werden. Mit `ListAuditTasks` können Sie die Prüfungen finden, die ausgeführt während eines angegebenen Zeitintervalls ausgeführt wurden. Mit `CancelAuditTask` können Sie die derzeit laufende Prüfung unterbrechen. ### DescribeAuditTask Ruft Informationen zu einer Device Defender-Prüfung ab. **Syntax** ``` aws iot describe-audit-task \ --task-id \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "taskId": "string" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | taskId | Zeichenfolge length- max:40 min:1 pattern: [a-zA-Z0-9-]\$1 | Die ID des Audits, dessen Daten Sie abrufen möchten. | Output ``` { "taskStatus": "string", "taskType": "string", "taskStartTime": "timestamp", "taskStatistics": { "totalChecks": "integer", "inProgressChecks": "integer", "waitingForDataCollectionChecks": "integer", "compliantChecks": "integer", "nonCompliantChecks": "integer", "failedChecks": "integer", "canceledChecks": "integer" }, "scheduledAuditName": "string", "auditDetails": { "string": { "checkRunStatus": "string", "checkCompliant": "boolean", "totalResourcesCount": "long", "nonCompliantResourcesCount": "long", "errorCode": "string", "message": "string" } } } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | taskStatus | Zeichenfolge | Der Status der Prüfung: entweder IN\$1PROGRESS, COMPLETED, FAILED oder CANCELED. enum: IN\$1PROGRESS \$1 COMPLETED \$1 FAILED \$1 CANCELED | | taskType | Zeichenfolge | Der Typ von Audit: ON\$1DEMAND\$1AUDIT\$1TASK oder SCHEDULED\$1AUDIT\$1TASK. enum: ON\$1DEMAND\$1AUDIT\$1TASK \$1 SCHEDULED\$1AUDIT\$1TASK | | taskStartTime | Zeitstempel | Der Zeitpunkt, zu dem das Audit begann. | | taskStatistics | TaskStatistics | Statistische Informationen zum Audit. | | totalChecks | Ganzzahl | Die Anzahl der Prüfungen in diesem Audit. | | inProgressChecks | Ganzzahl | Die Anzahl der laufenden Prüfungen. | | waitingForDataCollectionChecks | Ganzzahl | Die Anzahl der Prüfungen mit anstehender Datensammlung. | | compliantChecks | Ganzzahl | Die Anzahl der Prüfungen, mit denen konforme Ressourcen gefunden wurden. | | nonCompliantChecks | Ganzzahl | Die Anzahl der Prüfungen, mit denen nicht-konforme Ressourcen gefunden wurden. | | failedChecks | Ganzzahl | Die Anzahl der Prüfungen. | | canceledChecks | Ganzzahl | Die Anzahl der Prüfungen, die nicht ausgeführt werden, da der Audit abgebrochen wurde. | | scheduledAuditName | Zeichenfolge length- max:128 min:1 pattern: [a-zA-Z0-9\$1-]\$1 | Der Name des geplanten Audits (nur bei geplanten Audits). | | auditDetails | map | Detaillierte Informationen zu den einzelnen Prüfungen, die während dieses Audits durchgeführt werden. | | checkRunStatus | Zeichenfolge | Der Erledigungsstatus dieser Prüfung; entweder IN\$1PROGRESS, WAITING\$1FOR\$1DATA\$1COLLECTION, CANCELED, COMPLETED\$1COMPLIANT, COMPLETED\$1NON\$1COMPLIANT oder FAILED. enum: IN\$1PROGRESS \$1 WAITING\$1FOR\$1DATA\$1COLLECTION \$1 CANCELED \$1 COMPLETED\$1COMPLIANT \$1 COMPLETED\$1NON\$1COMPLIANT \$1 FAILED | | checkCompliant | boolesch | "True", wenn die Überprüfung abgeschlossen wurde und alle konformen Ressourcen gefunden hat. | | totalResourcesCount | long | Die Anzahl der Ressourcen, für die die Prüfung ausgeführt wurde. | | nonCompliantResourcesCount | long | Die Anzahl der Ressourcen, die von der Prüfungen als nicht-konforme Ressourcen befunden wurden. | | errorCode | Zeichenfolge | Der Code eines jeden Fehlers, der beim Durchführen dieser Prüfung während dieses Audits aufgetreten ist. Entweder INSUFFICIENT\$1PERMISSIONS oder AUDIT\$1CHECK\$1DISABLED. | | Nachricht | Zeichenfolge length- max:2048 | Die Nachricht, die zu den Fehlern gehört, die beim Durchführen dieser Prüfung während dieses Audits aufgetreten sind. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ResourceNotFoundException` Die angegebene Ressource ist nicht vorhanden. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ### ListAuditTasks Listet die Device Defender-Audits auf, die während eines bestimmten Zeitraums durchgeführt wurden. **Syntax** ``` aws iot list-audit-tasks \ --start-time \ --end-time \ [--task-type ] \ [--task-status ] \ [--next-token ] \ [--max-results ] \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "startTime": "timestamp", "endTime": "timestamp", "taskType": "string", "taskStatus": "string", "nextToken": "string", "maxResults": "integer" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | startTime | Zeitstempel | Der Beginn des Zeitraums. Audit-Daten werden für einen begrenzten Zeitraum (180 Tage) aufbewahrt. Wenn die angeforderte Startzeit vor dem Aufbewahrungszeitraum liegt, führt dies zu einer `InvalidRequestException`. | | endTime | Zeitstempel | Das Ende des Zeitraums. | | taskType | Zeichenfolge | Ein Filter, um die Auswertungsergebnisse auf die angegebene Art von Audit: entweder ON\$1DEMAND\$1AUDIT\$1TASK oder SCHEDULED\$1\$1AUDIT\$1TASK. enum: ON\$1DEMAND\$1AUDIT\$1TASK \$1 SCHEDULED\$1AUDIT\$1TASK | | taskStatus | Zeichenfolge | Ein Filter, um die Ausgabe auf Audits mit dem angegebenen Erledigungsstatus einzuschränken: entweder IN\$1PROGRESS, COMPLETED, FAILED oder CANCELED. enum: IN\$1PROGRESS \$1 COMPLETED \$1 FAILED \$1 CANCELED | | nextToken | Zeichenfolge | Das Token für den nächsten Ergebnissatz. | | maxResults | Ganzzahl range- max:250 min:1 | Die maximale Anzahl der Ergebnisse, die auf einmal zurückgegeben werden sollen. Der Standardwert ist 25. | Output ``` { "tasks": [ { "taskId": "string", "taskStatus": "string", "taskType": "string" } ], "nextToken": "string" } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | Aufgaben | auflisten member: AuditTaskMetadata java class: java.util.List | Die Audits, die während des angegebenen Zeitraums durchgeführt wurden. | | taskId | Zeichenfolge length- max:40 min:1 pattern: [a-zA-Z0-9-]\$1 | Die ID dieses Audits. | | taskStatus | Zeichenfolge | Der Status dieser Audits: entweder IN\$1PROGRESS, COMPLETED, FAILED oder CANCELED. enum: IN\$1PROGRESS \$1 COMPLETED \$1 FAILED \$1 CANCELED | | taskType | Zeichenfolge | Der Typ dieses Audits: entweder ON\$1DEMAND\$1AUDIT\$1TASK oder SCHEDULED\$1AUDIT\$1TASK. enum: ON\$1DEMAND\$1AUDIT\$1TASK \$1 SCHEDULED\$1AUDIT\$1TASK | | nextToken | Zeichenfolge | Ein Token, mit dem der nächste Ergebnissatzes abgerufen werden kann, bzw. `null`, wenn keine weiteren Ergebnisse vorliegen. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ### CancelAuditTask Bricht einen Audit ab, der gerade ausgeführt wird. Es kann sich um einen planmäßigen oder um einen On-Demand-Audit handeln. Wenn der Audit nicht ausgeführt wird, tritt eine `InvalidRequestException` auf. **Syntax** ``` aws iot cancel-audit-task \ --task-id \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "taskId": "string" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | taskId | Zeichenfolge length- max:40 min:1 pattern: [a-zA-Z0-9-]\$1 | Die ID des Audits, das Sie abbrechen möchten. Sie können nur einen Audit mit dem Status IN\$1PROGRESS abbrechen. | Output Keine **Fehler** `ResourceNotFoundException` Die angegebene Ressource ist nicht vorhanden. `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten. ## Prüfen der Prüfungsergebnisse Mit `ListAuditFindings` können Sie die Ergebnisse eines Audits anzeigen. Sie können die Ergebnisse nach der Art von Prüfung, einer bestimmten Ressource oder dem Zeitpunkt des Audits filtern. Sie können diese Informationen verwenden, um für gefundene Probleme Abhilfe zu schaffen. Sie können Abhilfemaßnahmen definieren und sie auf die Ergebnisse Ihrer Prüfung anwenden. Weitere Informationen finden Sie unter [Abschwächungsaktionen](dd-mitigation-actions.md). ### ListAuditFindings Listet die Ergebnisse eines Device Defender-Audits oder der während eines bestimmten Zeitraums durchgeführten Audits. (Die Ergebnisse 180 Tage lang aufbewahrt.) **Syntax** ``` aws iot list-audit-findings \ [--task-id ] \ [--check-name ] \ [--resource-identifier ] \ [--max-results ] \ [--next-token ] \ [--start-time ] \ [--end-time ] \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`-Format ``` { "taskId": "string", "checkName": "string", "resourceIdentifier": { "deviceCertificateId": "string", "caCertificateId": "string", "cognitoIdentityPoolId": "string", "clientId": "string", "policyVersionIdentifier": { "policyName": "string", "policyVersionId": "string" }, "roleAliasArn": "string", "account": "string" }, "maxResults": "integer", "nextToken": "string", "startTime": "timestamp", "endTime": "timestamp" } ``` **`cli-input-json`-Felder** | Name | Typ | Beschreibung | | --- | --- | --- | | taskId | Zeichenfolge length- max:40 min:1 pattern: [a-zA-Z0-9-]\$1 | Ein Filter zum Einschränken der Ergebnisse auf das Audit mit der angegebenen ID. Sie müssen entweder die taskId oder den Wert für startTime und endTime angeben, aber nicht beides. | | checkName | Zeichenfolge | Ein Filter zum Einschränken der Ergebnisse auf eine bestimmte Audit-Prüfung. | | resourceIdentifier | ResourceIdentifier | Informationen zur Identifizierung der nicht konformen Ressource. | | deviceCertificateId | Zeichenfolge length- max:64 min:64 pattern: (0x)?[a-fA-F0-9]\$1 | Die ID des Zertifikats, das der Ressource angehängt ist. | | caCertificateId | Zeichenfolge length- max:64 min:64 pattern: (0x)?[a-fA-F0-9]\$1 | Die ID des CA-Zertifikats, mit dem das Zertifikat autorisiert wird. | | cognitoIdentityPoolId | Zeichenfolge | Die ID des Amazon Cognito-Identitäten-Pools. | | clientId | Zeichenfolge | Die Client-ID. | | policyVersionIdentifier | PolicyVersionIdentifier | Die Version der Richtlinie, die der Ressource zugeordnet ist. | | policyName | Zeichenfolge length- max:128 min:1 pattern: [w\$1=,.@-]\$1 | Der Name der -Richtlinie. | | policyVersionId | Zeichenfolge pattern: [0-9]\$1 | Die ID der Richtlinienversion, die der Ressource zugeordnet ist. | | roleAliasArn | Zeichenfolge | Der ARN des Rollenalias, der Aktionen mit zu weitreichenden Berechtigungen hat. length- max:2048 min:1 | | Konto | Zeichenfolge length- max:12 min:12 pattern: [0-9]\$1 | Das Konto, dem die Ressource zugeordnet ist. | | maxResults | Ganzzahl range- max:250 min:1 | Die maximale Anzahl der Ergebnisse, die auf einmal zurückgegeben werden sollen. Der Standardwert ist 25. | | nextToken | Zeichenfolge | Das Token für den nächsten Ergebnissatz. | | startTime | Zeitstempel | Ein Filter, mit dem die Ergebnisse auf jene einzuschränken, die nach dem angegebenen Zeitpunkt gefunden wurden. Sie müssen entweder die den Wert für startTime und endTime oder die taskID angeben, aber nicht beides. | | endTime | Zeitstempel | Ein Filter, mit dem die Ergebnisse auf diejenigen eingeschränkt werden, die vor dem angegebenen Zeitpunkt gefunden wurden. Sie müssen entweder die den Wert für startTime und endTime oder die taskID angeben, aber nicht beides. | Output ``` { "findings": [ { "taskId": "string", "checkName": "string", "taskStartTime": "timestamp", "findingTime": "timestamp", "severity": "string", "nonCompliantResource": { "resourceType": "string", "resourceIdentifier": { "deviceCertificateId": "string", "caCertificateId": "string", "cognitoIdentityPoolId": "string", "clientId": "string", "policyVersionIdentifier": { "policyName": "string", "policyVersionId": "string" }, "account": "string" }, "additionalInfo": { "string": "string" } }, "relatedResources": [ { "resourceType": "string", "resourceIdentifier": { "deviceCertificateId": "string", "caCertificateId": "string", "cognitoIdentityPoolId": "string", "clientId": "string", "iamRoleArn": "string", "policyVersionIdentifier": { "policyName": "string", "policyVersionId": "string" }, "account": "string" }, "roleAliasArn": "string", "additionalInfo": { "string": "string" } } ], "reasonForNonCompliance": "string", "reasonForNonComplianceCode": "string" } ], "nextToken": "string" } ``` **CLI-Ausgabefelder** | Name | Typ | Beschreibung | | --- | --- | --- | | findings | auflisten member: AuditFinding | Die Ergebnisse des Audits. | | taskId | Zeichenfolge length- max:40 min:1 pattern: [a-zA-Z0-9-]\$1 | Die ID des Audits, der dieses Ergebnis generiert hat. | | checkName | Zeichenfolge | Die Audit-Prüfung, die dieses Ergebnis generiert hat. | | taskStartTime | Zeitstempel | Der Zeitpunkt, zu dem das Audit begann. | | findingTime | Zeitstempel | Die Uhrzeit, zu der das Ergebnis entdeckt wurde. | | severity | Zeichenfolge | Der Schweregrad des Ergebnisses. enum: CRITICAL \$1 HIGH \$1 MEDIUM \$1 LOW | | nonCompliantResource | NonCompliantResource | Die Ressource, die als nicht mit der Auditprüfung konform befunden wurde. | | RessourcenTyp | Zeichenfolge | Der Typ der nichtkonformen Ressource. enum: DEVICE\$1CERTIFICATE \$1 CA\$1CERTIFICATE \$1 IOT\$1POLICY \$1 COGNITO\$1IDENTITY\$1POOL \$1 CLIENT\$1ID \$1 ACCOUNT\$1SETTINGS | | resourceIdentifier | ResourceIdentifier | Informationen zur Identifizierung der nicht konformen Ressource. | | deviceCertificateId | Zeichenfolge length- max:64 min:64 pattern: (0x)?[a-fA-F0-9]\$1 | Die ID des Zertifikats, das der Ressource angehängt ist. | | caCertificateId | Zeichenfolge length- max:64 min:64 pattern: (0x)?[a-fA-F0-9]\$1 | Die ID des CA-Zertifikats, mit dem das Zertifikat autorisiert wird. | | cognitoIdentityPoolId | Zeichenfolge | Die ID des Amazon Cognito-Identitäten-Pools. | | clientId | Zeichenfolge | Die Client-ID. | | policyVersionIdentifier | PolicyVersionIdentifier | Die Version der Richtlinie, die der Ressource zugeordnet ist. | | policyName | Zeichenfolge length- max:128 min:1 pattern: [w\$1=,.@-]\$1 | Der Name der -Richtlinie. | | policyVersionId | Zeichenfolge pattern: [0-9]\$1 | Die ID der Richtlinienversion, die der Ressource zugeordnet ist. | | Konto | Zeichenfolge length- max:12 min:12 pattern: [0-9]\$1 | Das Konto, dem die Ressource zugeordnet ist. | | additionalInfo | map | Weitere Informationen über die nicht konforme Ressource. | | relatedResources | auflisten member: RelatedResource | Die Liste zugehöriger Ressourcen. | | RessourcenTyp | Zeichenfolge | Der Typ der Ressource. enum: DEVICE\$1CERTIFICATE \$1 CA\$1CERTIFICATE \$1 IOT\$1POLICY \$1 COGNITO\$1IDENTITY\$1POOL \$1 CLIENT\$1ID \$1 ACCOUNT\$1SETTINGS | | resourceIdentifier | ResourceIdentifier | Informationen zum Identifizieren der Ressource. | | deviceCertificateId | Zeichenfolge length- max:64 min:64 pattern: (0x)?[a-fA-F0-9]\$1 | Die ID des Zertifikats, das der Ressource angehängt ist. | | caCertificateId | Zeichenfolge length- max:64 min:64 pattern: (0x)?[a-fA-F0-9]\$1 | Die ID des CA-Zertifikats, mit dem das Zertifikat autorisiert wird. | | cognitoIdentityPoolId | Zeichenfolge | Die ID des Amazon Cognito-Identitäten-Pools. | | clientId | Zeichenfolge | Die Client-ID. | | policyVersionIdentifier | PolicyVersionIdentifier | Die Version der Richtlinie, die der Ressource zugeordnet ist. | | iamRoleArn | Zeichenfolge Länge max. 2048, min. 20 | Der ARN der IAM-Rolle, die Aktionen mit zu weitreichenden Berechtigungen hat. | | policyName | Zeichenfolge length- max:128 min:1 pattern: [w\$1=,.@-]\$1 | Der Name der -Richtlinie. | | policyVersionId | Zeichenfolge pattern: [0-9]\$1 | Die ID der Richtlinienversion, die der Ressource zugeordnet ist. | | roleAliasArn | Zeichenfolge length- max:2048 min:1 | Der ARN des Rollenalias, der Aktionen mit zu weitreichenden Berechtigungen hat. | | Konto | Zeichenfolge length- max:12 min:12 pattern: [0-9]\$1 | Das Konto, dem die Ressource zugeordnet ist. | | additionalInfo | map | Weitere Informationen über die Ressource. | | reasonForNonCompliance | Zeichenfolge | Der Grund, weshalb die Ressource nicht konform war. | | reasonForNonComplianceCode | Zeichenfolge | Ein Code, womit der Grund angegeben wird, weshalb die Ressource nicht konform war. | | nextToken | Zeichenfolge | Ein Token, mit dem der nächste Ergebnissatzes abgerufen werden kann, bzw. `null`, wenn keine weiteren Ergebnisse vorliegen. | **Fehler** `InvalidRequestException` Der Inhalt der Anforderung war ungültig. `ThrottlingException` Die Rate überschreitet den Grenzwert. `InternalFailureException` Ein unerwarteter Fehler ist aufgetreten.