Comandi di auditing - AWS IoT Device Defender

Comandi di auditing

Gestione delle impostazioni di auditing

Utilizzare UpdateAccountAuditConfiguration per configurare le impostazioni di audit per l'account. Questo comando permette di abilitare i controlli che desideri siano disponibili per gli audit, configurare le notifiche opzionali e configurare le autorizzazioni.

Controlla queste impostazioni con DescribeAccountAuditConfiguration.

Usa DeleteAccountAuditConfiguration per eliminare le impostazioni di auditing. In questo modo, vengono ripristinati tutti i valori predefiniti e vengono disabilitati in modo efficace tutti gli audit in quanto tutti i controlli sono disabilitati per impostazione predefinita.

UpdateAccountAuditConfiguration

Configura o riconfigura le impostazioni di auditing di Device Defender per l'account. Le impostazioni includono la modalità di invio delle notifiche degli audit e i controlli di auditing abilitati o disabilitati.

Riepilogo

aws iot update-account-audit-configuration \ [--role-arn <value>] \ [--audit-notification-target-configurations <value>] \ [--audit-check-configurations <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "roleArn": "string", "auditNotificationTargetConfigurations": { "string": { "targetArn": "string", "roleArn": "string", "enabled": "boolean" } }, "auditCheckConfigurations": { "string": { "enabled": "boolean" } } }
Campi cli-input-json

Nome

Type

Descrizione

roleArn

string

Lunghezza max: 2048, min.: 20

L’ARN del ruolo che concede a AWS IoT l'autorizzazione per accedere alle informazioni su dispositivi, policy, certificati e altri elementi necessari per eseguire un audit.

auditNotificationTargetConfigurations

map

Informazioni sui target a cui vengono inviate le notifiche di auditing.

targetArn

string

ARN del target (argomento SNS) a cui vengono inviate le notifiche di auditing.

roleArn

string

Lunghezza max: 2048, min.: 20

ARN del ruolo che concede l'autorizzazione per l'invio delle notifiche al target.

enabled

booleano

True se le notifiche per il target sono abilitate.

auditCheckConfigurations

map

Specifica i controlli di auditing abilitati e disabilitati per l'account. Usa DescribeAccountAuditConfiguration per visualizzare l'elenco di tutti i controlli, inclusi quelli attualmente abilitati.

Alcune raccolte di dati potrebbero iniziare subito quando alcuni controlli sono abilitati. Quando un controllo viene disabilitato, i dati raccolti fino a quel momento in relazione al controllo vengono eliminati.

Non è possibile disabilitare un controllo se viene usato da un audit pianificato. È prima necessario eliminare il controllo dall'audit pianificato oppure eliminare l'audit pianificato stesso.

Nella prima chiamata a UpdateAccountAuditConfiguration questo parametro è obbligatorio e deve specificare almeno un controllo abilitato.

enabled

booleano

True se il controllo di auditing è abilitato per l'account.

Output

Nessuno

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

DescribeAccountAuditConfiguration

Ottiene informazioni sulle impostazioni di Device Defender Audit per l'account. Le impostazioni includono la modalità di invio delle notifiche degli audit e i controlli di auditing abilitati o disabilitati.

Riepilogo

aws iot describe-account-audit-configuration \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ }

Output

{ "roleArn": "string", "auditNotificationTargetConfigurations": { "string": { "targetArn": "string", "roleArn": "string", "enabled": "boolean" } }, "auditCheckConfigurations": { "string": { "enabled": "boolean" } } }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

roleArn

string

Lunghezza max: 2048, min.: 20

L’ARN del ruolo che concede a AWS IoT l'autorizzazione per accedere alle informazioni su dispositivi, policy, certificati e altri elementi necessari per eseguire un audit.

Nella prima chiamata a UpdateAccountAuditConfiguration questo parametro è obbligatorio.

auditNotificationTargetConfigurations

map

Informazioni sui target a cui vengono inviate le notifiche di auditing per l'account.

targetArn

string

ARN del target (argomento SNS) a cui vengono inviate le notifiche di auditing.

roleArn

string

Lunghezza max: 2048, min.: 20

ARN del ruolo che concede l'autorizzazione per l'invio delle notifiche al target.

enabled

booleano

True se le notifiche per il target sono abilitate.

auditCheckConfigurations

map

Specifica i controlli di auditing abilitati e disabilitati per l'account.

enabled

booleano

True se il controllo di auditing è abilitato per l'account.

Errori

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

DeleteAccountAuditConfiguration

Ripristina le impostazioni predefinite per gli audit di Device Defender per l'account. I dati di configurazione immessi vengono eliminati e tutti i controlli di audit vengono reimpostati come disabilitati.

Riepilogo

aws iot delete-account-audit-configuration \ [--delete-scheduled-audits | --no-delete-scheduled-audits] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "deleteScheduledAudits": "boolean" }
Campi cli-input-json

Nome

Type

Descrizione

deleteScheduledAudits

booleano

Se true, tutti gli audit pianificati vengono eliminati.

Output

Nessuno

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ResourceNotFoundException

La risorsa specificata non esiste.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

Pianificazione di audit

Crea uno o più audit pianificati usando CreateScheduledAudit. Questo comando ti permette di specificare i controlli da eseguire durante un audit e la frequenza di esecuzione dell'audit.

Tieni traccia degli audit pianificati con ListScheduledAudits e DescribeScheduledAudit.

Cambia un audit pianificato esistente con UpdateScheduledAudit o eliminalo con DeleteScheduledAudit.

CreateScheduledAudit

Crea un audit pianificato che viene eseguito con un intervallo di tempo specificato.

Riepilogo

aws iot create-scheduled-audit \ --frequency <value> \ [--day-of-month <value>] \ [--day-of-week <value>] \ --target-check-names <value> \ [--tags <value>] \ --scheduled-audit-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string", "targetCheckNames": [ "string" ], "tags": [ { "Key": "string", "Value": "string" } ], "scheduledAuditName": "string" }
Campi cli-input-json

Nome

Type

Descrizione

frequenza

string

Frequenza di esecuzione dell'audit. I valori possibili sono "DAILY", "WEEKLY", "BIWEEKLY" o "MONTHLY". L'ora di inizio effettiva di ogni audit è determinata dal sistema.

enumerazione: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

string

modello: ^([1-9]|[12][0-9]|3[01])$|^LAST$

Giorno del mese in cui viene eseguito l'audit pianificato. Il valore può essere compreso tra "1" e "31" oppure può essere "LAST". Questo campo è obbligatorio se il parametro frequency è impostato su "MONTHLY". Se vengono specificati i giorni 29-31 e il mese non ha tali giorni, l'audit viene eseguito l'ultimo ("LAST") giorno del mese.

dayOfWeek

string

Giorno della settimana in cui viene eseguito l'audit pianificato. I valori possibili sono "SUN", "MON", "TUE", "WED", "THU", "FRI" o "SAT". Questo campo è obbligatorio se il parametro frequency è impostato su "WEEKLY" o "BIWEEKLY".

enumerazione: SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

elenco

membro: AuditCheckName

Controlli eseguiti durante l'audit pianificato. I controlli devono essere abilitati per l'account. Usa DescribeAccountAuditConfiguration per visualizzare l'elenco di tutti i controlli, inclusi quelli abilitati, o UpdateAccountAuditConfiguration per selezionare i controlli abilitati.

tags

elenco

member: Tag

Classe Java: java.util.List

Metadati utilizzabili per la gestione dell'audit pianificato.

Chiave

string

La chiave del tag.

Valore

string

Il valore del tag.

scheduledAuditName

string

Lunghezza max: 128, min.: 1

Modello: [a–z A–Z 0–9 _-]+

Nome da assegnare all'audit pianificato. (numero massimo pari a 128 caratteri)

Output

{ "scheduledAuditArn": "string" }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

scheduledAuditArn

string

ARN dell'audit pianificato.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

LimitExceededException

È stato superato un limite.

ListScheduledAudits

Elenca tutti gli audit pianificati.

Riepilogo

aws iot list-scheduled-audits \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "nextToken": "string", "maxResults": "integer" }
Campi cli-input-json

Nome

Type

Descrizione

nextToken

string

Token per il set di risultati successivo.

maxResults

integer

Intervallo – Max: 250, min.: 1

Numero massimo di risultati da restituire per volta. Il valore predefinito è 25.

Output

{ "scheduledAudits": [ { "scheduledAuditName": "string", "scheduledAuditArn": "string", "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string" } ], "nextToken": "string" }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

scheduledAudits

elenco

membro: ScheduledAuditMetadata

Classe Java: java.util.List

Elenco di audit pianificati.

scheduledAuditName

string

Lunghezza max: 128, min.: 1

Modello: [a–z A–Z 0–9 _-]+

Nome dell'audit pianificato.

scheduledAuditArn

string

ARN dell'audit pianificato.

frequenza

string

Frequenza di esecuzione dell'audit.

enumerazione: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

string

modello: ^([1-9]|[12][0-9]|3[01])$|^LAST$

Giorno del mese in cui viene eseguito l'audit pianificato (se frequency è "MONTHLY"). Se vengono specificati i giorni 29-31 e il mese non ha tali giorni, l'audit viene eseguito l'ultimo ("LAST") giorno del mese.

dayOfWeek

string

Giorno della settimana in cui viene eseguito l'audit pianificato (se frequency è "WEEKLY" o "BIWEEKLY").

enumerazione: SUN | MON | TUE | WED | THU | FRI | SAT

nextToken

string

Token che è possibile usare per recuperare il set di risultati successivo oppure null se non ci sono altri risultati.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

DescribeScheduledAudit

Ottiene le informazioni su un audit pianificato.

Riepilogo

aws iot describe-scheduled-audit \ --scheduled-audit-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "scheduledAuditName": "string" }
Campi cli-input-json

Nome

Type

Descrizione

scheduledAuditName

string

Lunghezza max: 128, min.: 1

Modello: [a–z A–Z 0–9 _-]+

Nome dell'audit pianificato di cui ottenere le informazioni.

Output

{ "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string", "targetCheckNames": [ "string" ], "scheduledAuditName": "string", "scheduledAuditArn": "string" }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

frequenza

string

Frequenza di esecuzione dell'audit. Un valore tra "DAILY", "WEEKLY", "BIWEEKLY" o "MONTHLY". L'ora di inizio effettiva di ogni audit è determinata dal sistema.

enumerazione: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

string

modello: ^([1-9]|[12][0-9]|3[01])$|^LAST$

Giorno del mese in cui viene eseguito l'audit pianificato. Il valore può essere compreso tra "1" e "31" oppure può essere "LAST". Se vengono specificati i giorni 29-31 e il mese non ha tali giorni, l'audit viene eseguito l'ultimo ("LAST") giorno del mese.

dayOfWeek

string

Giorno della settimana in cui viene eseguito l'audit pianificato. Un valore tra "SUN", "MON", "TUE", "WED", "THU", "FRI" o "SAT".

enumerazione: SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

elenco

membro: AuditCheckName

Controlli eseguiti durante l'audit pianificato. I controlli devono essere abilitati per l'account. (Usa DescribeAccountAuditConfiguration per visualizzare l'elenco di tutti i controlli, inclusi quelli abilitati o UpdateAccountAuditConfiguration per selezionare i controlli abilitati).

scheduledAuditName

string

Lunghezza max: 128, min.: 1

Modello: [a–z A–Z 0–9 _-]+

Nome dell'audit pianificato.

scheduledAuditArn

string

ARN dell'audit pianificato.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ResourceNotFoundException

La risorsa specificata non esiste.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

UpdateScheduledAudit

Aggiorna un audit pianificato, inclusi i controlli eseguiti e la frequenza di esecuzione dell'audit.

Riepilogo

aws iot update-scheduled-audit \ [--frequency <value>] \ [--day-of-month <value>] \ [--day-of-week <value>] \ [--target-check-names <value>] \ --scheduled-audit-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string", "targetCheckNames": [ "string" ], "scheduledAuditName": "string" }
Campi cli-input-json

Nome

Type

Descrizione

frequenza

string

Frequenza di esecuzione dell'audit. I valori possibili sono "DAILY", "WEEKLY", "BIWEEKLY" o "MONTHLY". L'ora di inizio effettiva di ogni audit è determinata dal sistema.

enumerazione: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

string

modello: ^([1-9]|[12][0-9]|3[01])$|^LAST$

Giorno del mese in cui viene eseguito l'audit pianificato. Il valore può essere compreso tra "1" e "31" oppure può essere "LAST". Questo campo è obbligatorio se il parametro frequency è impostato su "MONTHLY". Se vengono specificati i giorni 29-31 e il mese non ha tali giorni, l'audit viene eseguito l'ultimo ("LAST") giorno del mese.

dayOfWeek

string

Giorno della settimana in cui viene eseguito l'audit pianificato. I valori possibili sono "SUN", "MON", "TUE", "WED", "THU", "FRI" o "SAT". Questo campo è obbligatorio se il parametro frequency è impostato su "WEEKLY" o "BIWEEKLY".

enumerazione: SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

elenco

membro: AuditCheckName

Controlli eseguiti durante l'audit pianificato. I controlli devono essere abilitati per l'account. (Usa DescribeAccountAuditConfiguration per visualizzare l'elenco di tutti i controlli, inclusi quelli abilitati o UpdateAccountAuditConfiguration per selezionare i controlli abilitati).

scheduledAuditName

string

Lunghezza max: 128, min.: 1

Modello: [a–z A–Z 0–9 _-]+

Nome dell'audit pianificato. (numero massimo pari a 128 caratteri)

Output

{ "scheduledAuditArn": "string" }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

scheduledAuditArn

string

ARN dell'audit pianificato.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ResourceNotFoundException

La risorsa specificata non esiste.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

DeleteScheduledAudit

Elimina un audit pianificato.

Riepilogo

aws iot delete-scheduled-audit \ --scheduled-audit-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "scheduledAuditName": "string" }
Campi cli-input-json

Nome

Type

Descrizione

scheduledAuditName

string

Lunghezza max: 128, min.: 1

Modello: [a–z A–Z 0–9 _-]+

Nome dell'audit pianificato da eliminare.

Output

Nessuno

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ResourceNotFoundException

La risorsa specificata non esiste.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

Esecuzione di un audit on demand

Usare StartOnDemandAuditTask per specificare i controlli da eseguire e avviare un audit immediatamente.

StartOnDemandAuditTask

Avvia un audit di Device Defender on demand.

Riepilogo

aws iot start-on-demand-audit-task \ --target-check-names <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "targetCheckNames": [ "string" ] }
Campi cli-input-json

Nome

Type

Descrizione

targetCheckNames

elenco

membro: AuditCheckName

Controlli eseguiti durante l'audit. I controlli specificati devono essere abilitati per l'account, altrimenti si verifica un'eccezione. Usa DescribeAccountAuditConfiguration per visualizzare l'elenco di tutti i controlli, inclusi quelli abilitati o UpdateAccountAuditConfiguration per selezionare i controlli abilitati.

Output

{ "taskId": "string" }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

taskId

string

Lunghezza max: 40, min.: 1

Modello: [a–z A–Z 0–9 -]+

ID dell'audit on demand avviato.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

LimitExceededException

È stato superato un limite.

Gestione di istanze di audit

Usa DescribeAuditTask per ottenere informazioni su un'istanza di audit specifica. Se l'esecuzione è già avvenuta, i risultati includono i controlli con esito negativo e quelli con esito positivo, quelli che il sistema non è stato in grado di completare e, se l'audit è ancora in corso, quelli ancora in fase di elaborazione.

Usa ListAuditTasks per trovare gli audit eseguiti durante un intervallo di tempo specifico.

Usa CancelAuditTask per arrestare un audit in corso.

DescribeAuditTask

Ottiene le informazioni su un audit di Device Defender.

Riepilogo

aws iot describe-audit-task \ --task-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "taskId": "string" }
Campi cli-input-json

Nome

Type

Descrizione

taskId

string

Lunghezza max: 40, min.: 1

Modello: [a–z A–Z 0–9 -]+

ID dell'audit di cui ottenere le informazioni.

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" } } }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

taskStatus

string

Stato dell'audit: un valore tra "IN_PROGRESS", "COMPLETED", "FAILED" o "CANCELED".

enumerazione: IN_PROGRESS | COMPLETED | FAILED | CANCELED

taskType

string

Tipo di audit: "ON_DEMAND_AUDIT_TASK" o "SCHEDULED_AUDIT_TASK".

enumerazione: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

taskStartTime

timestamp

Ora di inizio dell'audit.

taskStatistics

TaskStatistics

Informazioni statistiche sull'audit.

totalChecks

integer

Numero di controlli nell'audit.

inProgressChecks

integer

Numero di controlli in corso.

waitingForDataCollectionChecks

integer

Numero di controlli in attesa della raccolta dei dati.

compliantChecks

integer

Numero di controlli che hanno trovato risorse conformi.

nonCompliantChecks

integer

Numero di controlli che hanno trovato risorse non conformi.

failedChecks

integer

Numero di controlli.

canceledChecks

integer

Numero di controlli non eseguiti perché l'audit è stato annullato.

scheduledAuditName

string

Lunghezza max: 128, min.: 1

Modello: [a–z A–Z 0–9 _-]+

Nome dell'audit pianificato (solo se l'audit è di tipo pianificato).

auditDetails

map

Informazioni dettagliate su ogni controllo eseguito durante l'audit.

checkRunStatus

string

Stato di completamento del controllo. Un valore tra "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT" o "FAILED".

enumerazione: IN_PROGRESS | WAITING_FOR_DATA_COLLECTION | CANCELED | COMPLETED_COMPLIANT | COMPLETED_NON_COMPLIANT | FAILED

checkCompliant

booleano

True se il controllo è stato completato e ha trovato tutte le risorse conformi.

totalResourcesCount

Long

Numero di risorse su cui è stato eseguito il controllo.

nonCompliantResourcesCount

Long

Numero di risorse che dal controllo sono risultate non conformi.

errorCode

string

Codice degli errori rilevati durante l'esecuzione del controllo nel corso dell'audit. Un valore tra "INSUFFICIENT_PERMISSIONS" o "AUDIT_CHECK_DISABLED".

message

string

Lunghezza max: 2048

Messaggio associato agli errori rilevati durante l'esecuzione del controllo nel corso dell'audit.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ResourceNotFoundException

La risorsa specificata non esiste.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

ListAuditTasks

Elenca gli audit di Device Defender eseguiti durante un determinato periodo di tempo.

Riepilogo

aws iot list-audit-tasks \ --start-time <value> \ --end-time <value> \ [--task-type <value>] \ [--task-status <value>] \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "startTime": "timestamp", "endTime": "timestamp", "taskType": "string", "taskStatus": "string", "nextToken": "string", "maxResults": "integer" }
Campi cli-input-json

Nome

Type

Descrizione

startTime

timestamp

Inizio del periodo di tempo. Le informazioni sull'audit vengono conservate per un periodo di tempo limitato (180 giorni). Richiesta di un orario di inizio precedente a ciò che viene conservato comporta un InvalidRequestException.

endTime

timestamp

Fine del periodo di tempo.

taskType

string

Filtro che limita l'output al tipo di audit specificato: può essere un valore tra "ON_DEMAND_AUDIT_TASK" o "SCHEDULED__AUDIT_TASK".

enumerazione: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

taskStatus

string

Filtro che limita l'output agli audit con lo stato di completamento specificato: può essere un valore tra "IN_PROGRESS", "COMPLETED", "FAILED" o "CANCELED".

enumerazione: IN_PROGRESS | COMPLETED | FAILED | CANCELED

nextToken

string

Token per il set di risultati successivo.

maxResults

integer

Intervallo – Max: 250, min.: 1

Numero massimo di risultati da restituire per volta. Il valore predefinito è 25.

Output

{ "tasks": [ { "taskId": "string", "taskStatus": "string", "taskType": "string" } ], "nextToken": "string" }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

attività

elenco

membro: AuditTaskMetadata

Classe Java: java.util.List

Audit eseguiti durante il periodo di tempo specificato.

taskId

string

Lunghezza max: 40, min.: 1

Modello: [a–z A–Z 0–9 -]+

ID dell'audit.

taskStatus

string

Stato dell'audit: un valore tra "IN_PROGRESS", "COMPLETED", "FAILED" o "CANCELED".

enumerazione: IN_PROGRESS | COMPLETED | FAILED | CANCELED

taskType

string

Tipo di audit: un valore tra "ON_DEMAND_AUDIT_TASK" o "SCHEDULED_AUDIT_TASK".

enumerazione: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

nextToken

string

Token che è possibile usare per recuperare il set di risultati successivo oppure null se non ci sono risultati aggiuntivi.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

CancelAuditTask

Annulla un audit in corso. L'audit può essere pianificato o on demand. Se l'audit non è in corso, si verifica InvalidRequestException.

Riepilogo

aws iot cancel-audit-task \ --task-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "taskId": "string" }
Campi cli-input-json

Nome

Type

Descrizione

taskId

string

Lunghezza max: 40, min.: 1

Modello: [a–z A–Z 0–9 -]+

ID dell'audit da annullare. È possibile annullare solo un audit con stato "IN_PROGRESS".

Output

Nessuno

Errori

ResourceNotFoundException

La risorsa specificata non esiste.

InvalidRequestException

I contenuti della richiesta non sono validi.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.

Controllo dei risultati dell'audit

Usa ListAuditFindings per visualizzare i risultati di un audit. Puoi filtrare i risultati in base al tipo di controllo, a una risorsa specifica o a quando è stato eseguito l'audit. È possibile utilizzare queste informazioni per mitigare gli eventuali problemi rilevati.

È possibile definire operazioni di mitigazione e applicarle ai risultati dell'audit. Per ulteriori informazioni, consultare Operazioni di mitigazione.

ListAuditFindings

Elenca i risultati di un audit di Device Defender o degli audit eseguiti durante un periodo di tempo specificato. I risultati vengono conservati per 180 giorni.

Riepilogo

aws iot list-audit-findings \ [--task-id <value>] \ [--check-name <value>] \ [--resource-identifier <value>] \ [--max-results <value>] \ [--next-token <value>] \ [--start-time <value>] \ [--end-time <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json formato

{ "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" }
Campi cli-input-json

Nome

Type

Descrizione

taskId

string

Lunghezza max: 40, min.: 1

Modello: [a–z A–Z 0–9 -]+

Filtro che limita i risultati all'audit con l'ID specificato. Devi specificare il valore di taskId oppure di startTime ed endTime, ma non entrambi.

checkName

string

Filtro che limita i risultati al controllo di auditing specificato.

resourceIdentifier

ResourceIdentifier

Informazioni che identificano le risorse non conformi.

deviceCertificateId

string

Lunghezza max: 64, min.: 64

Modello: (0x)?[a–f A–F 0–9]+

ID del certificato collegato alla risorsa.

caCertificateId

string

Lunghezza max: 64, min.: 64

Modello: (0x)?[a–f A–F 0–9]+

ID del certificato CA usato per autorizzare il certificato.

cognitoIdentityPoolId

string

ID del pool di identità Amazon Cognito.

clientId

string

ID client.

policyVersionIdentifier

PolicyVersionIdentifier

Versione della policy associata alla risorsa.

policyName

string

Lunghezza max: 128, min.: 1

modello: [w+=,.@-]+

Il nome della policy .

policyVersionId

string

Modello: [0–9]+

ID della versione della policy associata alla risorsa.

roleAliasArn

string

L'ARN dell'alias ruolo con azioni eccessivamente permissive.

Lunghezza max: 2048, min.: 1

account

string

Lunghezza max: 12, min.: 12

Modello: [0–9]+

Account a cui è associata la risorsa.

maxResults

integer

Intervallo – Max: 250, min.: 1

Numero massimo di risultati da restituire per volta. Il valore predefinito è 25.

nextToken

string

Token per il set di risultati successivo.

startTime

timestamp

Filtro che limita i risultati a quelli trovati dopo l'ora specificata. Devi specificare il valore di startTime ed endTime oppure di taskId, ma non entrambi.

endTime

timestamp

Filtro che limita i risultati a quelli trovati prima dell'ora specificata. Devi specificare il valore di startTime ed endTime oppure di taskId, ma non entrambi.

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" }
Campi di output dell'interfaccia a riga di comando

Nome

Type

Descrizione

risultati

elenco

membro: AuditFinding

Risultati dell'audit.

taskId

string

Lunghezza max: 40, min.: 1

Modello: [a–z A–Z 0–9 -]+

ID dell'audit che ha generato il risultato (ricerca)

checkName

string

Controllo di auditing che ha generato il risultato.

taskStartTime

timestamp

Ora di inizio dell'audit.

findingTime

timestamp

Ora in cui è stato trovato il risultato.

severity

string

Gravità del risultato.

enumerazione: CRITICAL | HIGH | MEDIUM | LOW

nonCompliantResource

NonCompliantResource

Risorsa risultata non conforme dal controllo di auditing.

resourceType

string

Tipo della risorsa non conforme.

enumerazione: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS

resourceIdentifier

ResourceIdentifier

Informazioni che identificano le risorse non conformi.

deviceCertificateId

string

Lunghezza max: 64, min.: 64

Modello: (0x)?[a–f A–F 0–9]+

ID del certificato collegato alla risorsa.

caCertificateId

string

Lunghezza max: 64, min.: 64

Modello: (0x)?[a–f A–F 0–9]+

ID del certificato CA usato per autorizzare il certificato.

cognitoIdentityPoolId

string

ID del pool di identità Amazon Cognito.

clientId

string

ID client.

policyVersionIdentifier

PolicyVersionIdentifier

Versione della policy associata alla risorsa.

policyName

string

Lunghezza max: 128, min.: 1

modello: [w+=,.@-]+

Il nome della policy .

policyVersionId

string

Modello: [0–9]+

ID della versione della policy associata alla risorsa.

account

string

Lunghezza max: 12, min.: 12

Modello: [0–9]+

Account a cui è associata la risorsa.

additionalInfo

map

Altre informazioni sulla risorsa non conforme.

relatedResources

elenco

membro: RelatedResource

Elenco delle risorse correlate.

resourceType

string

Il tipo di risorsa.

enumerazione: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS

resourceIdentifier

ResourceIdentifier

Informazioni che identificano la risorsa.

deviceCertificateId

string

Lunghezza max: 64, min.: 64

Modello: (0x)?[a–f A–F 0–9]+

ID del certificato collegato alla risorsa.

caCertificateId

string

Lunghezza max: 64, min.: 64

Modello: (0x)?[a–f A–F 0–9]+

ID del certificato CA usato per autorizzare il certificato.

cognitoIdentityPoolId

string

ID del pool di identità Amazon Cognito.

clientId

string

ID client.

policyVersionIdentifier

PolicyVersionIdentifier

Versione della policy associata alla risorsa.

iamRoleArn

string

Lunghezza max: 2048, min.: 20

L'ARN del ruolo IAM che ha azioni eccessivamente permissive.

policyName

string

Lunghezza max: 128, min.: 1

modello: [w+=,.@-]+

Il nome della policy .

policyVersionId

string

Modello: [0–9]+

ID della versione della policy associata alla risorsa.

roleAliasArn

string

Lunghezza max: 2048, min.: 1

L'ARN dell'alias ruolo con azioni eccessivamente permissive.

account

string

Lunghezza max: 12, min.: 12

Modello: [0–9]+

Account a cui è associata la risorsa.

additionalInfo

map

Altre informazioni sulla risorsa.

reasonForNonCompliance

string

Motivo per cui la risorsa è risultata non conforme.

reasonForNonComplianceCode

string

Codice che indica il motivo per cui la risorsa è risultata non conforme.

nextToken

string

Token che è possibile usare per recuperare il set di risultati successivo oppure null se non ci sono risultati aggiuntivi.

Errori

InvalidRequestException

I contenuti della richiesta non sono validi.

ThrottlingException

La velocità supera il limite.

InternalFailureException

Si è verificato un errore imprevisto.