Administrar la configuración de auditorías Programación de auditorías Ejecutar una auditoría bajo demanda Administrar instancias de auditoría Comprobar resultados de auditoría

Comandos de auditoría

Administrar la configuración de auditorías

Utilice UpdateAccountAuditConfiguration para configurar los ajustes de auditoría de su cuenta Este comando le permite habilitar las comprobaciones que desea que estén disponibles para las auditorías, configurar notificaciones opcionales y configurar permisos.

Compruebe esta configuración con DescribeAccountAuditConfiguration.

Utilice DeleteAccountAuditConfiguration para eliminar la configuración de auditoría. Esto restaura todos los valores predeterminados y desactiva de manera efectiva las auditorías, ya que todas las comprobaciones están deshabilitadas de manera predeterminada.

UpdateAccountAuditConfiguration

Configura o vuelve a configurar los ajustes de auditoría de Device Defender para esta cuenta. La configuración incluye cómo se envían las notificaciones de auditoría y qué comprobaciones de auditoría se habilitan o deshabilitan.

Sinopsis


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]

Formato cli-input-json


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

Campos `cli-input-json`
Nombre	Tipo	Descripción
roleArn	cadena Longitud máx.: 2048; mín.: 20	El ARN del rol que concede permiso a AWS IoT para obtener acceso a la información sobre sus dispositivos, políticas, certificados y otros elementos al realizar una auditoría.
auditNotificationTargetConfigurations	map	Información sobre los destinos a los que se envían las notificaciones de auditoría.
targetArn	cadena	El ARN del destino (tema SNS) al que se envían las notificaciones de auditoría.
roleArn	cadena Longitud máx.: 2048; mín.: 20	El ARN del rol que concede permiso para enviar notificaciones al destino.
enabled	boolean	True si se habilitan las notificaciones al destino.
auditCheckConfigurations	map	Especifica las comporbaciones de auditoría habilitadas y deshabilitadas para esta cuenta. Utilice `DescribeAccountAuditConfiguration` para ver la lista de todas las comprobaciones, incluidas las habilitadas actualmente. Parte de la recopilación de datos puede comenzar inmediatamente cuando se habilitan determinadas comprobaciones. Cuando se deshabilita una comprobación, se borran todos los datos recopilados hasta el momento relacionados con la comprobación. No puede deshabilitar una comprobación si se utiliza en una auditoría programada. Primero debe eliminar la comprobación de la auditoría programada o eliminar la propia auditoría programada. En la primera llamada a `UpdateAccountAuditConfiguration` se necesita este parámetro y debe especificar al menos una comprobación habilitada.
enabled	boolean	True si está habilitada la comprobación de auditoría para esta cuenta.

Salida

Ninguna

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

DescribeAccountAuditConfiguration

Obtiene información sobre la configuración de auditoría de Device Defender para esta cuenta. La configuración incluye cómo se envían las notificaciones de auditoría y qué comprobaciones de auditoría se habilitan o deshabilitan.

Sinopsis


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

Formato cli-input-json

{
}

Salida


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

Campos de salida de la CLI
Nombre	Tipo	Descripción
roleArn	cadena Longitud máx.: 2048; mín.: 20	El ARN del rol que concede permiso a AWS IoT para obtener acceso a la información sobre sus dispositivos, políticas, certificados y otros elementos al realizar una auditoría. En la primera llamada a `UpdateAccountAuditConfiguration`, se necesita este parámetro.
auditNotificationTargetConfigurations	map	Información sobre los destinos a los que se envían las notificaciones de auditoría para esta cuenta.
targetArn	cadena	El ARN del destino (tema SNS) al que se envían las notificaciones de auditoría.
roleArn	cadena Longitud máx.: 2048; mín.: 20	El ARN del rol que concede permiso para enviar notificaciones al destino.
enabled	boolean	True si se habilitan las notificaciones al destino.
auditCheckConfigurations	map	Las verificaciones de auditoría habilitadas y deshabilitadas para esta cuenta.
enabled	boolean	True si está habilitada la comprobación de auditoría para esta cuenta.

Errores

ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

DeleteAccountAuditConfiguration

Restaura la configuración predeterminada para las auditorías de Device Defender para esta cuenta. Se eliminarán todos los datos de configuración que haya introducido y todas las comprobaciones de auditoría se restablecerán como deshabilitadas.

Sinopsis


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

Formato cli-input-json


{
  "deleteScheduledAudits": "boolean"
}

Campos `cli-input-json`
Nombre	Tipo	Descripción
deleteScheduledAudits	boolean	Si es true, se eliminan todas las auditorías programadas.

Salida

Ninguna

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ResourceNotFoundException: El recurso especificado no existe.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

Programación de auditorías

Utilice CreateScheduledAudit para crear una o varias auditorías programadas. Este comando permite especificar las comprobaciones que desea realizar durante una auditoría y con qué frecuencia deben ejecutarse.

Mantenga un registro de sus auditorías programadas con ListScheduledAudits y DescribeScheduledAudit.

Cambie una auditoría programada existente con UpdateScheduledAudit o elimínela con DeleteScheduledAudit.

CreateScheduledAudit

Crea una auditoría programada que se ejecuta en un intervalo de tiempo especificado.

Sinopsis


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]

Formato cli-input-json


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

Campos `cli-input-json`
Nombre	Tipo	Descripción
frequency	cadena	Frecuencia con la que se lleva a cabo la auditoría. Puede ser DAILY, WEEKLY, BIWEEKLY o MONTHLY. El sistema determina la hora de inicio real de cada auditoría. enum: DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY
dayOfMonth	cadena patrón: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$	El día del mes en que tiene lugar la auditoría programada. Puede ser de 1 a 31 o LAST. Este campo es obligatorio si el parámetro `frequency` se establece en MONTHLY. Si se especifican los días 29-31 y el mes no tiene tantos días, la auditoría se realizará el último (LAST) día del mes.
dayOfWeek	cadena	El día de la semana en que tiene lugar la auditoría programada. Puede ser SUN, MON, TUE,WED, THU, FRI o SAT. Este campo es obligatorio si el parámetro `frequency` se establece en WEEKLY o BIWEEKLY. enum: SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT
targetCheckNames	list miembro: AuditCheckName	Controles que se realizan durante la auditoría programada. Las comprobaciones deben activarse para su cuenta. (Utilice `DescribeAccountAuditConfiguration` para ver la lista de todas las comprobaciones, incluidas las habilitadas o `UpdateAccountAuditConfiguration` para seleccionar las comprobaciones habilitadas).
etiquetas	list member: Tag Clase de Java: java.util.List	Los metadatos que se pueden utilizar para administrar la auditoría programada.
Clave	cadena	La clave de la etiqueta.
Valor	cadena	El valor de la etiqueta.
scheduledAuditName	cadena Longitud máx.: 128; mín.: 1 Patrón: [a-zA-Z0-9_-]+	El nombre que desea asignar a la auditoría programada. (Máximo de 128 caracteres)

Salida


{
  "scheduledAuditArn": "string"
}

Campos de salida de la CLI
Nombre	Tipo	Descripción
scheduledAuditArn	cadena	El ARN de la auditoría programada.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.
LimitExceededException: Se ha superado un límite.

ListScheduledAudits

Muestra una lista de las auditorías programadas.

Sinopsis


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

Formato cli-input-json


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

Campos `cli-input-json`
nextToken	cadena	El token del conjunto siguiente de resultados.
maxResults	integer Rango máx.: 250; mín.: 1	El número máximo de resultados que devolver a la vez. El valor predeterminado es 25.

Campos cli-input-json

Nombre

Tipo

Descripción

nextToken

cadena

El token del conjunto siguiente de resultados.

maxResults

integer

Rango máx.: 250; mín.: 1

El número máximo de resultados que devolver a la vez. El valor predeterminado es 25.

Salida


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

Campos de salida de la CLI
Nombre	Tipo	Descripción
scheduledAudits	list miembro: ScheduledAuditMetadata Clase de Java: java.util.List	La lista de auditorías programadas.
scheduledAuditName	cadena Longitud máx.: 128; mín.: 1 Patrón: [a-zA-Z0-9_-]+	El nombre de la auditoría programada.
scheduledAuditArn	cadena	El ARN de la auditoría programada.
frequency	cadena	Frecuencia con la que se lleva a cabo la auditoría. enum: DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY
dayOfMonth	cadena patrón: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$	El día del mes en que se ejecuta la auditoría programada (si `frequency` es MONTHLY). Si se especifican los días 29-31 y el mes no tiene tantos días, la auditoría se realizará el último (LAST) día del mes.
dayOfWeek	cadena	El día de la semana en que se ejecuta la auditoría programada (si `frequency` es WEEKLY o BIWEEKLY). enum: SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT
nextToken	cadena	Un token que se puede utilizar para recuperar el siguiente conjunto de resultados o `null` si no hay resultados adicionales.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

DescribeScheduledAudit

Obtiene información acerca de una auditoría programada.

Sinopsis


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

Formato cli-input-json


{
  "scheduledAuditName": "string"
}

Campos `cli-input-json`
scheduledAuditName	cadena Longitud máx.: 128; mín.: 1 Patrón: [a-zA-Z0-9_-]+	El nombre de la auditoría programada cuya información desea obtener.

Campos cli-input-json

Nombre

Tipo

Descripción

scheduledAuditName

cadena

Longitud máx.: 128; mín.: 1

Patrón: [a-zA-Z0-9_-]+

El nombre de la auditoría programada cuya información desea obtener.

Salida


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

Campos de salida de la CLI
Nombre	Tipo	Descripción
frequency	cadena	Frecuencia con la que se lleva a cabo la auditoría. Uno entre DAILY, WEEKLY, BIWEEKLY o MONTHLY. El sistema determina la hora de inicio real de cada auditoría. enum: DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY
dayOfMonth	cadena patrón: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$	El día del mes en que tiene lugar la auditoría programada. Puede ser de 1 a 31 o LAST. Si se especifican los días 29-31 y el mes no tiene tantos días, la auditoría se realizará el último (LAST) día del mes.
dayOfWeek	cadena	El día de la semana en que tiene lugar la auditoría programada. Uno entre SUN, MON, TUE, WED, THU, FRI o SAT. enum: SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT
targetCheckNames	list miembro: AuditCheckName	Controles que se realizan durante la auditoría programada. Las comprobaciones deben activarse para su cuenta. (Utilice `DescribeAccountAuditConfiguration` para ver la lista de todas las comprobaciones, incluidas las habilitadas o `UpdateAccountAuditConfiguration` para seleccionar las comprobaciones habilitadas).
scheduledAuditName	cadena Longitud máx.: 128; mín.: 1 Patrón: [a-zA-Z0-9_-]+	El nombre de la auditoría programada.
scheduledAuditArn	cadena	El ARN de la auditoría programada.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ResourceNotFoundException: El recurso especificado no existe.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

UpdateScheduledAudit

Actualiza una auditoría programada, que incluye las comprobaciones que se realizan y con qué frecuencia se lleva a cabo la auditoría.

Sinopsis


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]

Formato cli-input-json


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

Campos `cli-input-json`
Nombre	Tipo	Descripción
frequency	cadena	Frecuencia con la que se lleva a cabo la auditoría. Puede ser DAILY, WEEKLY, BIWEEKLY o MONTHLY. El sistema determina la hora de inicio real de cada auditoría. enum: DAILY \| WEEKLY \| BIWEEKLY \| MONTHLY
dayOfMonth	cadena patrón: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$	El día del mes en que tiene lugar la auditoría programada. Puede ser de 1 a 31 o LAST. Este campo es obligatorio si el parámetro `frequency` se establece en MONTHLY. Si se especifican los días 29-31 y el mes no tiene tantos días, la auditoría se realizará el último (LAST) día del mes.
dayOfWeek	cadena	El día de la semana en que tiene lugar la auditoría programada. Puede ser SUN, MON, TUE,WED, THU, FRI o SAT. Este campo es obligatorio si el parámetro `frequency` se establece en WEEKLY o BIWEEKLY. enum: SUN \| MON \| TUE \| WED \| THU \| FRI \| SAT
targetCheckNames	list miembro: AuditCheckName	Controles que se realizan durante la auditoría programada. Las comprobaciones deben activarse para su cuenta. (Utilice `DescribeAccountAuditConfiguration` para ver la lista de todas las comprobaciones, incluidas las habilitadas o `UpdateAccountAuditConfiguration` para seleccionar las comprobaciones habilitadas).
scheduledAuditName	cadena Longitud máx.: 128; mín.: 1 Patrón: [a-zA-Z0-9_-]+	El nombre de la auditoría programada. (Máximo de 128 caracteres)

Salida


{
  "scheduledAuditArn": "string"
}

Campos de salida de la CLI
Nombre	Tipo	Descripción
scheduledAuditArn	cadena	El ARN de la auditoría programada.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ResourceNotFoundException: El recurso especificado no existe.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

DeleteScheduledAudit

Elimina una auditoría programada.

Sinopsis


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

Formato cli-input-json


{
  "scheduledAuditName": "string"
}

Campos `cli-input-json`
scheduledAuditName	cadena Longitud máx.: 128; mín.: 1 Patrón: [a-zA-Z0-9_-]+	El nombre de la auditoría programada que desea borrar.

Campos cli-input-json

Nombre

Tipo

Descripción

scheduledAuditName

cadena

Longitud máx.: 128; mín.: 1

Patrón: [a-zA-Z0-9_-]+

El nombre de la auditoría programada que desea borrar.

Salida

Ninguna

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ResourceNotFoundException: El recurso especificado no existe.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

Ejecutar una auditoría bajo demanda

Utilice StartOnDemandAuditTask para especificar las comprobaciones que desea realizar y comenzar una auditoría de inmediato.

StartOnDemandAuditTask

Comienza una auditoría de Device Defender bajo demanda.

Sinopsis


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

Formato cli-input-json


{
  "targetCheckNames": [
    "string"
  ]
}

Campos `cli-input-json`
targetCheckNames	list miembro: AuditCheckName	Controles que se realizan durante la auditoría. Las comprobaciones que especifique deben estar habilitadas para su cuenta o se producirá una excepción. Utilice `DescribeAccountAuditConfiguration` para ver la lista de todas las comprobaciones, incluidas las habilitadas o `UpdateAccountAuditConfiguration` para seleccionar las comprobaciones habilitadas.

Campos cli-input-json

Nombre

Tipo

Descripción

targetCheckNames

list

miembro: AuditCheckName

Controles que se realizan durante la auditoría. Las comprobaciones que especifique deben estar habilitadas para su cuenta o se producirá una excepción. Utilice DescribeAccountAuditConfiguration para ver la lista de todas las comprobaciones, incluidas las habilitadas o UpdateAccountAuditConfiguration para seleccionar las comprobaciones habilitadas.

Salida


{
  "taskId": "string"
}

Campos de salida de la CLI
taskId	cadena Longitud máx.: 40; mín.: 1 Patrón: [a-zA-Z0-9-]+	El ID de la auditoría bajo demanda que comenzó.

Campos de salida de la CLI

Nombre

Tipo

Descripción

taskId

cadena

Longitud máx.: 40; mín.: 1

Patrón: [a-zA-Z0-9-]+

El ID de la auditoría bajo demanda que comenzó.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.
LimitExceededException: Se ha superado un límite.

Administrar instancias de auditoría

Utilice DescribeAuditTask para obtener información sobre una instancia de auditoría específica. Si ya se ha ejecutado, los resultados incluyen las comprobaciones fallidas y las correctas, aquellas que el sistema no ha podido completar y, si la auditoría aún está en curso, aquellas en las que todavía está trabajando.

Utilice ListAuditTasks para buscar las auditorías que se ejecutaron durante un intervalo de tiempo específico.

Utilice CancelAuditTask para parar una auditoría en curso.

DescribeAuditTask

Obtiene información acerca de una auditoría de Device Defender.

Sinopsis


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

Formato cli-input-json


{
  "taskId": "string"
}

Campos `cli-input-json`
taskId	cadena Longitud máx.: 40; mín.: 1 Patrón: [a-zA-Z0-9-]+	El ID de la auditoría cuya información desea obtener.

Campos cli-input-json

Nombre

Tipo

Descripción

taskId

cadena

Longitud máx.: 40; mín.: 1

Patrón: [a-zA-Z0-9-]+

El ID de la auditoría cuya información desea obtener.

Salida


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

Campos de salida de la CLI
Nombre	Tipo	Descripción
taskStatus	cadena	El estado de la auditoría: uno entre IN_PROGRESS, COMPLETED, FAILED o CANCELED. enum: IN_PROGRESS \| COMPLETED \| FAILED \| CANCELED
taskType	cadena	El tipo de auditoría: ON_DEMAND_AUDIT_TASK r SCHEDULED_AUDIT_TASK. enum: ON_DEMAND_AUDIT_TASK \| SCHEDULED_AUDIT_TASK
taskStartTime	Marca de tiempo	La hora a la que se inició la auditoría.
taskStatistics	TaskStatistics	Información estadística sobre la auditoría.
totalChecks	integer	El número de comprobaciones de esta auditoría.
inProgressChecks	integer	El número de comprobaciones en curso.
waitingForDataCollectionChecks	integer	El número de comprobaciones en espera de recopilación de datos.
compliantChecks	integer	El número de comprobaciones que encontraron recursos conformes.
nonCompliantChecks	integer	El número de comprobaciones que encontraron recursos no conformes.
failedChecks	integer	El número de comprobaciones.
canceledChecks	integer	El número de comprobaciones no ejecutadas debido a la cancelación de la auditoría.
scheduledAuditName	cadena Longitud máx.: 128; mín.: 1 Patrón: [a-zA-Z0-9_-]+	El nombre de la auditoría programada (solo si la auditoría era una auditoría programada).
auditDetails	map	Información detallada sobre cada comprobación realizada durante esta auditoría.
checkRunStatus	cadena	El estado de finalización de esta comprobación, una entre IN_PROGRESS, WAITING_FOR_DATA_COLLECTION, CANCELED, COMPLETED_COMPLIANT, COMPLETED_NON_COMPLIANT o FAILED. enum: IN_PROGRESS \| WAITING_FOR_DATA_COLLECTION \| CANCELED \| COMPLETED_COMPLIANT \| COMPLETED_NON_COMPLIANT \| FAILED
checkCompliant	boolean	True si se ha completado la comprobación y se ha detectado que todos los recursos son conformes.
totalResourcesCount	long	El número de recursos en los que se ha realizado la comprobación.
nonCompliantResourcesCount	long	El número de recursos que la comprobación ha encontrado que no son conformes.
errorCode	cadena	El código de cualquier error encontrado al realizar esta comprobación durante esta auditoría. Uno entre INSUFFICIENT_PERMISSIONS o AUDIT_CHECK_DISABLED.
message	cadena Longitud máx.: 2048	El mensaje asociado con cualquier error encontrado al realizar esta comprobación durante esta auditoría.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ResourceNotFoundException: El recurso especificado no existe.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

ListAuditTasks

Muestra una lista de las auditorías de Device Defender que se han realizado durante un periodo de tiempo determinado.

Sinopsis


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]

Formato cli-input-json


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

Campos `cli-input-json`
Nombre	Tipo	Descripción
startTime	Marca de tiempo	El comienzo del periodo de tiempo. La información de auditoría se conserva durante un tiempo limitado (180 días). Si se solicita una hora de inicio anterior al tiempo de retención, se produce la excepción `InvalidRequestException`.
endTime	Marca de tiempo	El final del periodo de tiempo.
taskType	cadena	Un filtro para limitar el resultado al tipo de auditoría especificado: puede ser uno entre ON_DEMAND_AUDIT_TASK o SCHEDULED__AUDIT_TASK. enum: ON_DEMAND_AUDIT_TASK \| SCHEDULED_AUDIT_TASK
taskStatus	cadena	Un filtro para limitar el resultado a las auditorías con el estado de finalización especificado: puede ser uno entre IN_PROGRESS, COMPLETED, FAILED o CANCELED. enum: IN_PROGRESS \| COMPLETED \| FAILED \| CANCELED
nextToken	cadena	El token del conjunto siguiente de resultados.
maxResults	integer Rango máx.: 250; mín.: 1	El número máximo de resultados que devolver a la vez. El valor predeterminado es 25.

Salida


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

Campos de salida de la CLI
Nombre	Tipo	Descripción
tareas	list miembro: AuditTaskMetadata Clase de Java: java.util.List	Las auditorías que se realizaron durante el periodo de tiempo especificado.
taskId	cadena Longitud máx.: 40; mín.: 1 Patrón: [a-zA-Z0-9-]+	El ID de esta auditoría.
taskStatus	cadena	El estado de esta auditoría: uno entre IN_PROGRESS, COMPLETED, FAILED o CANCELED. enum: IN_PROGRESS \| COMPLETED \| FAILED \| CANCELED
taskType	cadena	El tipo de esta auditoría: uno entre ON_DEMAND_AUDIT_TASK o SCHEDULED_AUDIT_TASK. enum: ON_DEMAND_AUDIT_TASK \| SCHEDULED_AUDIT_TASK
nextToken	cadena	Un token que se puede utilizar para recuperar el siguiente conjunto de resultados o `null` si no hay resultados adicionales.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

CancelAuditTask

Cancela una auditoría que está en curso. La auditoría puede ser programada o bajo demanda. Si la auditoría no está en curso, se produce la excepción InvalidRequestException.

Sinopsis


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

Formato cli-input-json


{
  "taskId": "string"
}

Campos `cli-input-json`
taskId	cadena Longitud máx.: 40; mín.: 1 Patrón: [a-zA-Z0-9-]+	ID de la auditoría que desea cancelar. Solo puede cancelar una auditoría que esté IN_PROGRESS.

Campos cli-input-json

Nombre

Tipo

Descripción

taskId

cadena

Longitud máx.: 40; mín.: 1

Patrón: [a-zA-Z0-9-]+

ID de la auditoría que desea cancelar. Solo puede cancelar una auditoría que esté IN_PROGRESS.

Salida

Ninguna

Errores

ResourceNotFoundException: El recurso especificado no existe.
InvalidRequestException: El contenido de la solicitud no es válido.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

Comprobar resultados de auditoría

Utilice ListAuditFindings para ver los resultados de una auditoría. Puede filtrar los resultados por el tipo de comporbación, por recurso específico o por la hora de la auditoría. Puede utilizar esta información para mitigar cualquier problema que se encuentre.

Puede definir acciones de mitigación y aplicarlas a los resultados de su auditoría. Para obtener más información, consulte Acciones de mitigación.

ListAuditFindings

Muestra una lista de los resultados (resultados) de una auditoría de Device Defender o de las auditorías realizadas durante un periodo de tiempo especificado. (Los resultados se conservan durante 180 días).

Sinopsis


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]

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

Campos `cli-input-json`
Nombre	Tipo	Descripción
taskId	cadena Longitud máx.: 40; mín.: 1 Patrón: [a-zA-Z0-9-]+	Un filtro para limitar los resultados a la auditoría que tiene el ID especificado. Debe especificar taskId o startTime y endTime, pero no ambos.
checkName	cadena	Un filtro para limitar los resultados a los resultados de la verificación de auditoría especificada.
resourceIdentifier	ResourceIdentifier	La información que identifica el recurso no conforme.
deviceCertificateId	cadena Longitud máx.: 64; mín.: 64 Patrón: (0x)?[a-fA-F0-9]+	El ID del certificado asociado al recurso.
caCertificateId	cadena Longitud máx.: 64; mín.: 64 Patrón: (0x)?[a-fA-F0-9]+	El ID del certificado de entidad de certificación utilizado para autorizar el certificado.
cognitoIdentityPoolId	cadena	El ID del grupo de identidades de Amazon Cognito.
clientId	cadena	El ID de cliente.
policyVersionIdentifier	PolicyVersionIdentifier	La versión de la política asociada a este recurso.
policyName	cadena Longitud máx.: 128; mín.: 1 patrón: [w+=,.@-]+	El nombre de la política de .
policyVersionId	cadena Patrón: [0-9]+	El ID de la versión de la política asociada a este recurso.
roleAliasArn	cadena	El ARN del alias de rol que tiene acciones excesivamente permisivas. Longitud: máx.: 2048; mín.: 1
cuenta	cadena Longitud máx.: 12; mín.: 12 Patrón: [0-9]+	La cuenta a la que está asociado el recurso.
maxResults	integer Rango máx.: 250; mín.: 1	El número máximo de resultados que devolver a la vez. El valor predeterminado es 25.
nextToken	cadena	El token del conjunto siguiente de resultados.
startTime	Marca de tiempo	Un filtro para limitar los resultados a los encontrados después de la hora especificada. Debe especificar startTime y endTime o taskId, pero no ambos.
endTime	Marca de tiempo	Un filtro para limitar los resultados a los encontrados antes de la hora especificada. Debe especificar startTime y endTime o taskId, pero no ambos.

Salida


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

Campos de salida de la CLI
Nombre	Tipo	Descripción
findings	list miembro: AuditFinding	Los resultados (resultados) de la auditoría.
taskId	cadena Longitud máx.: 40; mín.: 1 Patrón: [a-zA-Z0-9-]+	El ID de la auditoría que generó este resultado (resultado).
checkName	cadena	La comprobación de auditoría que generó este resultado.
taskStartTime	Marca de tiempo	La hora a la que se inició la auditoría.
findingTime	Marca de tiempo	La hora a la que se descubrió el resultado (resultado).
severity	cadena	La gravedad del resultado (resultado). enum: CRÍTICA \| ALTA \| MEDIA \| BAJA
nonCompliantResource	NonCompliantResource	El recurso que se ha comprobado que no cumple los requisitos de una comprobación de auditoría.
resourceType	cadena	El tipo del recurso no conforme. enum: DEVICE_CERTIFICATE \| CA_CERTIFICATE \| IOT_POLICY \| COGNITO_IDENTITY_POOL \| CLIENT_ID \| ACCOUNT_SETTINGS
resourceIdentifier	ResourceIdentifier	La información que identifica el recurso no conforme.
deviceCertificateId	cadena Longitud máx.: 64; mín.: 64 Patrón: (0x)?[a-fA-F0-9]+	El ID del certificado asociado al recurso.
caCertificateId	cadena Longitud máx.: 64; mín.: 64 Patrón: (0x)?[a-fA-F0-9]+	El ID del certificado de entidad de certificación utilizado para autorizar el certificado.
cognitoIdentityPoolId	cadena	El ID del grupo de identidades de Amazon Cognito.
clientId	cadena	El ID de cliente.
policyVersionIdentifier	PolicyVersionIdentifier	La versión de la política asociada a este recurso.
policyName	cadena Longitud máx.: 128; mín.: 1 patrón: [w+=,.@-]+	El nombre de la política de .
policyVersionId	cadena Patrón: [0-9]+	El ID de la versión de la política asociada a este recurso.
cuenta	cadena Longitud máx.: 12; mín.: 12 Patrón: [0-9]+	La cuenta a la que está asociado el recurso.
additionalInfo	map	Otra información sobre el recurso no conforme.
relatedResources	list miembro: RelatedResource	La lista de recursos relacionados.
resourceType	cadena	El tipo de recurso. enum: DEVICE_CERTIFICATE \| CA_CERTIFICATE \| IOT_POLICY \| COGNITO_IDENTITY_POOL \| CLIENT_ID \| ACCOUNT_SETTINGS
resourceIdentifier	ResourceIdentifier	Información que identifica el recurso.
deviceCertificateId	cadena Longitud máx.: 64; mín.: 64 Patrón: (0x)?[a-fA-F0-9]+	El ID del certificado asociado al recurso.
caCertificateId	cadena Longitud máx.: 64; mín.: 64 Patrón: (0x)?[a-fA-F0-9]+	El ID del certificado de entidad de certificación utilizado para autorizar el certificado.
cognitoIdentityPoolId	cadena	El ID del grupo de identidades de Amazon Cognito.
clientId	cadena	El ID de cliente.
policyVersionIdentifier	PolicyVersionIdentifier	La versión de la política asociada a este recurso.
iamRoleArn	cadena Longitud máx.: 2048; mín.: 20	El ARN del rol de IAM que tiene acciones excesivamente permisivas.
policyName	cadena Longitud máx.: 128; mín.: 1 patrón: [w+=,.@-]+	El nombre de la política de .
policyVersionId	cadena Patrón: [0-9]+	El ID de la versión de la política asociada a este recurso.
roleAliasArn	cadena Longitud: máx.: 2048; mín.: 1	El ARN del alias de rol que tiene acciones excesivamente permisivas.
cuenta	cadena Longitud máx.: 12; mín.: 12 Patrón: [0-9]+	La cuenta a la que está asociado el recurso.
additionalInfo	map	Otra información sobre el recurso.
reasonForNonCompliance	cadena	El motivo por el que el recurso no era conforme.
reasonForNonComplianceCode	cadena	Un código que indica el motivo por el cual el recurso no era conforme.
nextToken	cadena	Un token que se puede utilizar para recuperar el siguiente conjunto de resultados o `null` si no hay resultados adicionales.

Errores

InvalidRequestException: El contenido de la solicitud no es válido.
ThrottlingException: El índice supera el límite.
InternalFailureException: Se ha producido un error inesperado.

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Registro desactivado

Supresiones de resultados de auditoría