Commandes d'audit

Gestion des paramètres d'audit

Utilisez UpdateAccountAuditConfiguration pour configurer les paramètres d'audit de votre compte.. Cette commande vous permet d'activer les contrôles que vous souhaitez disponibles pour les audits, de configurer les notifications facultatives et de configurer les autorisations.

Vérifiez ces paramètres avec DescribeAccountAuditConfiguration.

Utilisez DeleteAccountAuditConfiguration pour supprimer vos paramètres d'audit. Rétablit toutes les valeurs par défaut et désactive efficacement les audits, car tous les contrôles sont désactivés par défaut.

UpdateAccountAuditConfiguration

Configure ou reconfigure les paramètres d'audit Device Defender pour ce compte. Les paramètres incluent le mode d'envoi des notifications d'audit et les contrôles activés ou désactivés.

Résumé

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]

Format de cli-input-json

{
  "roleArn": "string",
  "auditNotificationTargetConfigurations": {
    "string": {
      "targetArn": "string",
      "roleArn": "string",
      "enabled": "boolean"
    }
  },
  "auditCheckConfigurations": {
    "string": {
      "enabled": "boolean"
    }
  }
}

Champs cli-input-json
Nom	Type	Description
roleArn	chaîne longueur - max. : 2048. Min. : 20	L'ARN du rôle qui accorde à AWS IoT l'autorisation d'accéder aux informations de vos appareils, stratégies, certificats et autres éléments lors d'un audit.
auditNotificationTargetConfigurations	map	Informations sur les cibles auxquelles les notifications d'audit sont envoyées.
targetArn	chaîne	L'ARN de la cible (rubrique SNS) à laquelle des notifications d'audit sont envoyées.
roleArn	chaîne longueur - max. : 2048. Min. : 20	L'ARN du rôle qui accorde l'autorisation d'envoyer des notifications à la cible.
enabled	boolean	La valeur est true si les notifications vers la cible sont activées.
auditCheckConfigurations	map	Spécifie les vérifications d'audit activées et désactivées pour ce compte. Utilisez DescribeAccountAuditConfiguration pour afficher la liste de tous les contrôles, y compris ceux qui sont actuellement activés. Certaines collectes de données peuvent démarrer immédiatement lorsque certains contrôles sont activés. Si un contrôle est désactivé, toutes les données collectées jusqu'à présent en relation avec lui sont supprimées. Vous ne pouvez pas désactiver un contrôle s'il est utilisé par un audit planifié. Vous devez d'abord supprimer le contrôle de l'audit planifié ou supprimer l'audit planifié lui-même. Dans le premier appel à UpdateAccountAuditConfiguration, ce paramètre est obligatoire et doit spécifier au moins un contrôle activé.
enabled	boolean	La valeur est true si cette vérification d'audit est activée pour ce compte.

Sortie

Aucun

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

DescribeAccountAuditConfiguration

Récupère les informations sur les paramètres d'audit Device Defender pour ce compte. Les paramètres incluent le mode d'envoi des notifications d'audit et les contrôles activés ou désactivés.

Résumé

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

Format de cli-input-json

{
}

Sortie

{
  "roleArn": "string",
  "auditNotificationTargetConfigurations": {
    "string": {
      "targetArn": "string",
      "roleArn": "string",
      "enabled": "boolean"
    }
  },
  "auditCheckConfigurations": {
    "string": {
      "enabled": "boolean"
    }
  }
}

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
roleArn	chaîne longueur - max. : 2048. Min. : 20	L'ARN du rôle qui accorde à AWS IoT l'autorisation d'accéder aux informations de vos appareils, stratégies, certificats et autres éléments lors d'un audit. Lors du premier appel à UpdateAccountAuditConfiguration, ce paramètre est requis.
auditNotificationTargetConfigurations	map	Des informations sur les cibles auxquelles les notifications d'audit sont envoyées pour ce compte.
targetArn	chaîne	L'ARN de la cible (rubrique SNS) à laquelle des notifications d'audit sont envoyées.
roleArn	chaîne longueur - max. : 2048. Min. : 20	L'ARN du rôle qui accorde l'autorisation d'envoyer des notifications à la cible.
enabled	boolean	La valeur est true si les notifications vers la cible sont activées.
auditCheckConfigurations	map	Les contrôles d'audit activés et désactivés pour ce compte.
enabled	boolean	La valeur est true si cette vérification d'audit est activée pour ce compte.

Erreurs

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

DeleteAccountAuditConfiguration

Restaure les paramètres par défaut des audits Device Defender pour ce compte. Toutes les données de configuration saisies sont supprimées et tous les contrôles d'audit sont réinitialisés pour être désactivés.

Résumé

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

Format de cli-input-json

{
  "deleteScheduledAudits": "boolean"
}

Champs cli-input-json
Nom	Type	Description
deleteScheduledAudits	boolean	Si la valeur est true, tous les audits planifiés sont supprimés.

Sortie

Aucun

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ResourceNotFoundException

La ressource spécifiée n'existe pas.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

Audits planifiés

Utilisez CreateScheduledAudit pour créer un ou plusieurs audits planifiés. Cette commande vous permet de spécifier les contrôles que vous souhaitez exécuter lors d'un audit, ainsi que la fréquence à laquelle ces audits doivent être exécutés.

Assurez le suivi de vos audits planifiés avec ListScheduledAudits et DescribeScheduledAudit.

Modifiez un audit planifié existant avec UpdateScheduledAudit ou supprimez-le avec DeleteScheduledAudit.

CreateScheduledAudit

Crée un audit planifié exécuté à un intervalle de temps spécifié.

Résumé

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]

Format de cli-input-json

{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "tags": [
    {
      "Key": "string",
      "Value": "string"
    }
  ],
  "scheduledAuditName": "string"
}

Champs cli-input-json
Nom	Type	Description
frequency	chaîne	À quelle fréquence se déroule l'audit planifiée. Peut être « DAILY », « WEEKLY », « BIWEEKLY » ou « MONTHLY ». L'heure de début réelle de chaque audit est déterminée par le système. enum: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	chaîne modèle : ^([1-9]|[12][0-9]|3[01])$|^LAST$	Le jour du mois auquel l'audit planifié se déroule. Peut être « 1 » à « 31 » ou « LAST ». Ce champ est obligatoire uniquement si le paramètre frequency est défini sur « MONTHLY ». Si les jours « 29 » à « 31 » sont spécifiés et que le mois ne compte pas autant de jours, l'audit se déroule le « LAST » (dernier) jour du mois.
dayOfWeek	chaîne	Le jour de la semaine pendant lequel l'audit planifié se déroule. Peut être « SUN », « MON », « TUE », « WED », « THU », « FRI » ou « SAT ». Ce champ est obligatoire si le paramètre frequency est défini sur « WEEKLY » ou « BIWEEKLY ». enum: SUN | MON | TUE | WED | THU | FRI | SAT
targetCheckNames	liste membre : AuditCheckName	Quels contrôles sont effectués pendant l'audit planifié. Les contrôles doivent être activés sur votre compte. (Utilisez DescribeAccountAuditConfiguration pour afficher la liste de tous les contrôles, y compris ceux activés, ou UpdateAccountAuditConfiguration pour sélectionner les contrôles activés.)
balises	liste membre : Tag classe Java : java.util.List	Métadonnées qui peuvent être utilisées pour gérer l'audit planifié.
Clé	chaîne	Clé de la balise.
Valeur	chaîne	Valeur de la balise.
scheduledAuditName	chaîne longueur - max. : 128. Min. : 1 modèle : [a-zA-Z0-9_-]+	Le nom que vous souhaitez donner à l'audit planifié. (128 caractères maximum)

Sortie

{
  "scheduledAuditArn": "string"
}

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
scheduledAuditArn	chaîne	L'ARN de l'audit planifié.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

LimitExceededException

Une limite a été dépassée.

ListScheduledAudits

Répertorie tous vos audits planifiés.

Résumé

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

Format de cli-input-json

{
  "nextToken": "string",
  "maxResults": "integer"
}

Champs cli-input-json
Nom	Type	Description
nextToken	chaîne	Jeton de l'ensemble de résultats suivant.
maxResults	entier plage - max. : 250 min. : 1	Nombre maximal de résultats à renvoyer simultanément. La valeur par défaut est 25.

Sortie

{
  "scheduledAudits": [
    {
      "scheduledAuditName": "string",
      "scheduledAuditArn": "string",
      "frequency": "string",
      "dayOfMonth": "string",
      "dayOfWeek": "string"
    }
  ],
  "nextToken": "string"
}

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
scheduledAudits	liste membre : ScheduledAuditMetadata classe Java : java.util.List	Liste des audits planifiés.
scheduledAuditName	chaîne longueur - max. : 128. Min. : 1 modèle : [a-zA-Z0-9_-]+	Le nom de l'audit planifié.
scheduledAuditArn	chaîne	L'ARN de l'audit planifié.
frequency	chaîne	À quelle fréquence se déroule l'audit planifiée. enum: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	chaîne modèle : ^([1-9]|[12][0-9]|3[01])$|^LAST$	Jour du mois où l'audit planifié est exécuté (si l'élément frequency est « MONTHLY »). Si les jours « 29 » à « 31 » sont spécifiés et que le mois ne compte pas autant de jours, l'audit se déroule le « LAST » (dernier) jour du mois.
dayOfWeek	chaîne	Jour de la semaine où l'audit planifié est exécuté (si frequency est « WEEKLY » OU « BIWEEKLY »). enum: SUN | MON | TUE | WED | THU | FRI | SAT
nextToken	chaîne	Jeton qui peut être utilisé pour obtenir l'ensemble de résultats suivant, ou null s'il n'y a pas d'autres résultats.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

DescribeScheduledAudit

Obtient des informations sur un audit planifié.

Résumé

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

Format de cli-input-json

{
  "scheduledAuditName": "string"
}

Champs cli-input-json
Nom	Type	Description
scheduledAuditName	chaîne longueur - max. : 128. Min. : 1 modèle : [a-zA-Z0-9_-]+	Le nom de l'audit planifié dont vous souhaitez obtenir les informations.

Sortie

{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "scheduledAuditName": "string",
  "scheduledAuditArn": "string"
}

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
frequency	chaîne	À quelle fréquence se déroule l'audit planifiée. « DAILY », « WEEKLY », « BIWEEKLY » ou « MONTHLY ». L'heure de début réelle de chaque audit est déterminée par le système. enum: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	chaîne modèle : ^([1-9]|[12][0-9]|3[01])$|^LAST$	Le jour du mois auquel l'audit planifié se déroule. Peut être « 1 » à « 31 » ou « LAST ». Si les jours « 29 » à « 31 » sont spécifiés et que le mois ne compte pas autant de jours, l'audit se déroule le « LAST » (dernier) jour du mois.
dayOfWeek	chaîne	Le jour de la semaine pendant lequel l'audit planifié se déroule. « SUN », « MON », « TUE », « WED », « THU », « FRI » ou « SAT ». enum: SUN | MON | TUE | WED | THU | FRI | SAT
targetCheckNames	liste membre : AuditCheckName	Quels contrôles sont effectués pendant l'audit planifié. Les contrôles doivent être activés sur votre compte. (Utilisez DescribeAccountAuditConfiguration pour afficher la liste de tous les contrôles, y compris ceux activés, ou UpdateAccountAuditConfiguration pour sélectionner les contrôles activés.)
scheduledAuditName	chaîne longueur - max. : 128. Min. : 1 modèle : [a-zA-Z0-9_-]+	Le nom de l'audit planifié.
scheduledAuditArn	chaîne	L'ARN de l'audit planifié.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ResourceNotFoundException

La ressource spécifiée n'existe pas.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

UpdateScheduledAudit

Met à jour un audit régulier, y compris les contrôles exécutés et la fréquence à laquelle l'audit a lieu.

Résumé

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]

Format de cli-input-json

{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "scheduledAuditName": "string"
}

Champs cli-input-json
Nom	Type	Description
frequency	chaîne	À quelle fréquence se déroule l'audit planifiée. Peut être « DAILY », « WEEKLY », « BIWEEKLY » ou « MONTHLY ». L'heure de début réelle de chaque audit est déterminée par le système. enum: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	chaîne modèle : ^([1-9]|[12][0-9]|3[01])$|^LAST$	Le jour du mois auquel l'audit planifié se déroule. Peut être « 1 » à « 31 » ou « LAST ». Ce champ est obligatoire uniquement si le paramètre frequency est défini sur « MONTHLY ». Si les jours « 29 » à « 31 » sont spécifiés et que le mois ne compte pas autant de jours, l'audit se déroule le « LAST » (dernier) jour du mois.
dayOfWeek	chaîne	Le jour de la semaine pendant lequel l'audit planifié se déroule. Peut être « SUN », « MON », « TUE », « WED », « THU », « FRI » ou « SAT ». Ce champ est obligatoire si le paramètre frequency est défini sur « WEEKLY » ou « BIWEEKLY ». enum: SUN | MON | TUE | WED | THU | FRI | SAT
targetCheckNames	liste membre : AuditCheckName	Quels contrôles sont effectués pendant l'audit planifié. Les contrôles doivent être activés sur votre compte. (Utilisez DescribeAccountAuditConfiguration pour afficher la liste de tous les contrôles, y compris ceux activés, ou UpdateAccountAuditConfiguration pour sélectionner les contrôles activés.)
scheduledAuditName	chaîne longueur - max. : 128. Min. : 1 modèle : [a-zA-Z0-9_-]+	Le nom de l'audit planifié. (128 caractères maximum)

Sortie

{
  "scheduledAuditArn": "string"
}

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
scheduledAuditArn	chaîne	L'ARN de l'audit planifié.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ResourceNotFoundException

La ressource spécifiée n'existe pas.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

DeleteScheduledAudit

Supprime un audit planifié.

Résumé

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

Format de cli-input-json

{
  "scheduledAuditName": "string"
}

Champs cli-input-json
Nom	Type	Description
scheduledAuditName	chaîne longueur - max. : 128. Min. : 1 modèle : [a-zA-Z0-9_-]+	Le nom de l'audit planifié que vous souhaitez supprimer.

Sortie

Aucun

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ResourceNotFoundException

La ressource spécifiée n'existe pas.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

Exécution d’un audit à la demande

Utilisez StartOnDemandAuditTask pour spécifier les contrôles que vous souhaitez exécuter et démarrer une exécution d'audit immédiatement.

StartOnDemandAuditTask

Démarre un audit Device Defender à la demande.

Résumé

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

Format de cli-input-json

{
  "targetCheckNames": [
    "string"
  ]
}

Champs cli-input-json
Nom	Type	Description
targetCheckNames	liste membre : AuditCheckName	Quels contrôles sont effectués pendant l'audit. Les contrôles que vous spécifiez doivent être activés pour votre compte ou une exception se produit. Utilisez DescribeAccountAuditConfiguration pour afficher la liste de tous les contrôles, y compris ceux activés, ou UpdateAccountAuditConfiguration pour sélectionner les contrôles activés.

Sortie

{
  "taskId": "string"
}

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
taskId	chaîne longueur - max. : 40. Min. : 1 modèle : [a-zA-Z0-9-]+	ID de l'audit à la demande que vous avez démarré.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

LimitExceededException

Une limite a été dépassée.

Gérez les instances d'audit

Utilisez DescribeAuditTask pour obtenir des informations sur une instance d'audit spécifique. Si la fonction est déjà exécutée, les résultats incluent les contrôles en échec ou réussis, ceux n'ayant pas pu être achevés par le système et, si l'audit est toujours en cours, ceux sur lesquels ce dernier travaille toujours.

Utilisez ListAuditTasks pour trouver les audits exécutés lors d'un intervalle de temps spécifié.

Utilisez CancelAuditTask pour arrêter un audit en cours.

DescribeAuditTask

Obtient des informations sur un audit Device Defender.

Résumé

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

Format de cli-input-json

{
  "taskId": "string"
}

Champs cli-input-json
Nom	Type	Description
taskId	chaîne longueur - max. : 40. Min. : 1 modèle : [a-zA-Z0-9-]+	L'ID de l'audit dont vous souhaitez obtenir les informations.

Sortie

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

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
taskStatus	chaîne	Le statut de l'audit : « IN_PROGRESS », « COMPLETED », « FAILED » ou « CANCELED ». enum: IN_PROGRESS | COMPLETED | FAILED | CANCELED
taskType	chaîne	Le type d'audit : « ON_DEMAND_AUDIT_TASK » ou « SCHEDULED_AUDIT_TASK ». enum: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK
taskStartTime	timestamp	L'heure de début de l'audit.
taskStatistics	TaskStatistics	Les statistiques de l'audit.
totalChecks	entier	Le nombre de contrôles dans cet audit.
inProgressChecks	entier	Le nombre de contrôles en cours.
waitingForDataCollectionChecks	entier	Le nombre de contrôles en attente de collecte des données.
compliantChecks	entier	Le nombre de contrôles conformes aux ressources.
nonCompliantChecks	entier	Le nombre de contrôles non conformes aux ressources.
failedChecks	entier	Le nombre de contrôles.
canceledChecks	entier	Le nombre de contrôles non exécutés à cause de l'annulation de l'audit.
scheduledAuditName	chaîne longueur - max. : 128. Min. : 1 modèle : [a-zA-Z0-9_-]+	Le nom de l'audit planifié (uniquement si ce dernier était planifié).
auditDetails	map	Les informations détaillées sur chaque contrôle effectué au cours de cet audit.
checkRunStatus	chaîne	Le statut de finalisation de ce contrôle : « IN_PROGRESS », « WAITING_FOR_DATA_COLLECTION », « CANCELED », « COMPLETED_COMPLIANT », « COMPLETED_NON_COMPLIANT » ou « FAILED ». enum: IN_PROGRESS | WAITING_FOR_DATA_COLLECTION | CANCELED | COMPLETED_COMPLIANT | COMPLETED_NON_COMPLIANT | FAILED
checkCompliant	boolean	La valeur est true si le contrôle est terminé et a trouvé toutes les ressources conformes.
totalResourcesCount	long	Le nombre de ressources sur lesquelles le contrôle a été effectué.
nonCompliantResourcesCount	long	Le nombre de ressources non conformes trouvées par le contrôle.
errorCode	chaîne	Le code des erreurs rencontrées lors de l'exécution de ce contrôle pendant l'audit. « INSUFFICIENT_PERMISSIONS » ou « AUDIT_CHECK_DISABLED ».
message	chaîne longueur - max. : 2048	Le message associé aux erreurs rencontrées lors de l'exécution de ce contrôle pendant l'audit.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ResourceNotFoundException

La ressource spécifiée n'existe pas.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

ListAuditTasks

Répertorie les audits Device Defender qui ont été exécutés au cours d'une période donnée.

Résumé

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]

Format de cli-input-json

{
  "startTime": "timestamp",
  "endTime": "timestamp",
  "taskType": "string",
  "taskStatus": "string",
  "nextToken": "string",
  "maxResults": "integer"
}

Champs cli-input-json
Nom	Type	Description
startTime	timestamp	Début de la période. Les informations d'audit sont conservées pendant une durée limitée (180 jours). Une demande d'heure de début antérieure à ce qui est conservé génère une exception InvalidRequestException.
endTime	timestamp	Fin de la période.
taskType	chaîne	Filtre pour limiter la sortie du type d'audit spécifié : peut être « ON_DEMAND_AUDIT_TASK » ou « SCHEDULED__AUDIT_TASK ». enum: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK
taskStatus	chaîne	Filtre pour limiter la sortie des audits spécifiée avec le statut d'achèvement : « IN_PROGRESS », « COMPLETED », « FAILED » ou « CANCELED ». enum: IN_PROGRESS | COMPLETED | FAILED | CANCELED
nextToken	chaîne	Jeton de l'ensemble de résultats suivant.
maxResults	entier plage - max. : 250 min. : 1	Nombre maximal de résultats à renvoyer simultanément. La valeur par défaut est 25.

Sortie

{
  "tasks": [
    {
      "taskId": "string",
      "taskStatus": "string",
      "taskType": "string"
    }
  ],
  "nextToken": "string"
}

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
tasks	liste membre : AuditTaskMetadata classe Java : java.util.List	Audits exécutés au cours de la période spécifiée.
taskId	chaîne longueur - max. : 40. Min. : 1 modèle : [a-zA-Z0-9-]+	ID de cet audit.
taskStatus	chaîne	Statut de l'audit : « IN_PROGRESS », « COMPLETED », « FAILED » ou « CANCELED ». enum: IN_PROGRESS | COMPLETED | FAILED | CANCELED
taskType	chaîne	Type de l'audit : « ON_DEMAND_AUDIT_TASK » ou « SCHEDULED_AUDIT_TASK ». enum: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK
nextToken	chaîne	Jeton qui peut être utilisé pour obtenir l'ensemble de résultats suivant, ou null, s'il n'y a pas de résultats supplémentaires.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

CancelAuditTask

Annule un audit en cours. L'audit peut être planifié ou à la demande. Si le contrôle n'est pas en cours, une exception InvalidRequestException.

Résumé

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

Format de cli-input-json

{
  "taskId": "string"
}

Champs cli-input-json
Nom	Type	Description
taskId	chaîne longueur - max. : 40. Min. : 1 modèle : [a-zA-Z0-9-]+	L'ID de l'audit que vous souhaitez annuler. Vous pouvez uniquement annuler un audit « IN_PROGRESS ».

Sortie

Aucun

Erreurs

ResourceNotFoundException

La ressource spécifiée n'existe pas.

InvalidRequestException

Le contenu de la demande n'était pas valide.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.

Vérifiez les résultats de l'audit

Utilisez ListAuditFindings pour consulter les résultats d'un audit. Vous pouvez filtrer les résultats par contrôle, ressource spécifique ou heure d'audit. Vous pouvez utiliser ces informations pour atténuer les problèmes détectés.

Vous pouvez définir des mesures d'atténuation et les appliquer aux résultats de votre audit. Pour en savoir plus, consultez Actions d'atténuation.

ListAuditFindings

Répertorie les conclusions (résultats) d'un audit Device Defender ou des audits effectués pendant une période déterminée. (Les conclusions sont conservées pendant 180 jours.)

Résumé

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]

Format de cli-input-json

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

Champs cli-input-json
Nom	Type	Description
taskId	chaîne longueur - max. : 40. Min. : 1 modèle : [a-zA-Z0-9-]+	Filtre pour limiter les résultats à l'audit avec l'ID spécifié. Vous devez spécifier le taskId ou les startTime et endTime, mais pas les deux.
checkName	chaîne	Filtre pour limiter les conclusions au contrôle d'audit spécifié.
resourceIdentifier	ResourceIdentifier	Informations qui identifient les ressources non conformes.
deviceCertificateId	chaîne longueur - max. : 64. Min. : 64 modèle : (0x)?[a-fA-F0-9]+	ID du certificat attaché à la ressource.
caCertificateId	chaîne longueur - max. : 64. Min. : 64 modèle : (0x)?[a-fA-F0-9]+	ID du certificat CA utilisé pour autoriser le certificat.
cognitoIdentityPoolId	chaîne	ID du groupe d'identités Amazon Cognito.
clientId	chaîne	ID client.
policyVersionIdentifier	PolicyVersionIdentifier	Version de la stratégie associée à la ressource.
policyName	chaîne longueur - max. : 128. Min. : 1 modèle : [w+=,.@-]+	Nom de la politique .
policyVersionId	chaîne modèle : [0-9]+	ID de la version de la stratégie associée à la ressource.
roleAliasArn	chaîne	ARN de l'alias de rôle ayant des actions trop permissives. longueur - max. : 2 048. Min. : 1
compte	chaîne longueur - max. : 12. Min. : 12 modèle : [0-9]+	Compte auquel la ressource est associée.
maxResults	entier plage - max. : 250 min. : 1	Nombre maximal de résultats à renvoyer simultanément. La valeur par défaut est 25.
nextToken	chaîne	Jeton de l'ensemble de résultats suivant.
startTime	timestamp	Filtre pour limiter les résultats à ceux obtenus après l'heure spécifiée. Vous devez spécifier le taskId ou les startTime et endTime, mais pas les deux.
endTime	timestamp	Filtre pour limiter les résultats à ceux obtenus avant l'heure spécifiée. Vous devez spécifier le taskId ou les startTime et endTime, mais pas les deux.

Sortie

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

Champs de sortie de l'interface de ligne de commande
Nom	Type	Description
findings	liste membre : AuditFinding	Conclusions (résultats) de l'audit.
taskId	chaîne longueur - max. : 40. Min. : 1 modèle : [a-zA-Z0-9-]+	ID de l'audit qui a généré ce résultat.
checkName	chaîne	Contrôle d'audit qui a généré le résultat.
taskStartTime	timestamp	L'heure de début de l'audit.
findingTime	timestamp	Heure à laquelle le résultat (finding) a été découvert.
severity	chaîne	Gravité du résultat (finding). enum : CRITICAL | HIGH | MEDIUM | LOW
nonCompliantResource	NonCompliantResource	Ressource qui a été détectée comme non conforme avec le contrôle d'audit.
resourceType	chaîne	Type de la ressource non conforme. enum: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS
resourceIdentifier	ResourceIdentifier	Informations qui identifient les ressources non conformes.
deviceCertificateId	chaîne longueur - max. : 64. Min. : 64 modèle : (0x)?[a-fA-F0-9]+	ID du certificat attaché à la ressource.
caCertificateId	chaîne longueur - max. : 64. Min. : 64 modèle : (0x)?[a-fA-F0-9]+	ID du certificat CA utilisé pour autoriser le certificat.
cognitoIdentityPoolId	chaîne	ID du groupe d'identités Amazon Cognito.
clientId	chaîne	ID client.
policyVersionIdentifier	PolicyVersionIdentifier	Version de la stratégie associée à la ressource.
policyName	chaîne longueur - max. : 128. Min. : 1 modèle : [w+=,.@-]+	Nom de la politique .
policyVersionId	chaîne modèle : [0-9]+	ID de la version de la stratégie associée à la ressource.
compte	chaîne longueur - max. : 12. Min. : 12 modèle : [0-9]+	Compte auquel la ressource est associée.
additionalInfo	map	Autres informations relatives à la ressource non conforme.
relatedResources	liste membre : RelatedResource	Liste des ressources associées.
resourceType	chaîne	Type de ressource. enum: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS
resourceIdentifier	ResourceIdentifier	Informations qui identifient la ressource.
deviceCertificateId	chaîne longueur - max. : 64. Min. : 64 modèle : (0x)?[a-fA-F0-9]+	ID du certificat attaché à la ressource.
caCertificateId	chaîne longueur - max. : 64. Min. : 64 modèle : (0x)?[a-fA-F0-9]+	ID du certificat CA utilisé pour autoriser le certificat.
cognitoIdentityPoolId	chaîne	ID du groupe d'identités Amazon Cognito.
clientId	chaîne	ID client.
policyVersionIdentifier	PolicyVersionIdentifier	Version de la stratégie associée à la ressource.
iamRoleArn	chaîne longueur - max. : 2048. Min. : 20	ARN du rôle IAM ayant des actions trop permissives.
policyName	chaîne longueur - max. : 128. Min. : 1 modèle : [w+=,.@-]+	Nom de la politique .
policyVersionId	chaîne modèle : [0-9]+	ID de la version de la stratégie associée à la ressource.
roleAliasArn	chaîne longueur - max. : 2 048. Min. : 1	ARN de l'alias de rôle ayant des actions trop permissives.
compte	chaîne longueur - max. : 12. Min. : 12 modèle : [0-9]+	Compte auquel la ressource est associée.
additionalInfo	map	Autres informations relatives à la ressource.
reasonForNonCompliance	chaîne	Raison pour laquelle la ressource était non conforme.
reasonForNonComplianceCode	chaîne	Code qui indique la raison pour laquelle la ressource était non conforme.
nextToken	chaîne	Jeton qui peut être utilisé pour obtenir l'ensemble de résultats suivant, ou null, s'il n'y a pas de résultats supplémentaires.

Erreurs

InvalidRequestException

Le contenu de la demande n'était pas valide.

ThrottlingException

Le tarif dépasse la limite.

InternalFailureException

Une erreur inattendue est survenue.