# Comandos de auditoria
<a name="AuditCommands"></a>

## Gerenciar configurações de auditoria
<a name="AuditCommandsManageSettings"></a>

Use `UpdateAccountAuditConfiguration` para definir as configurações de auditoria de sua conta. Esse comando permite habilitar as verificações que devem estar disponíveis para auditorias, configurar notificações opcionais e configurar permissões. 

Verifique essas configurações com `DescribeAccountAuditConfiguration`.

Use `DeleteAccountAuditConfiguration` para excluir suas configurações de auditoria. Isso restaura todos os valores padrão e desativa efetivamente as auditorias, pois todas as verificações estão desativadas por padrão.

### UpdateAccountAuditConfiguration
<a name="dd-api-iot-UpdateAccountAuditConfiguration"></a>

Configura ou reconfigura o as configurações de auditoria do Device Defender para essa conta. As configurações incluem como as notificações de auditoria são enviadas e quais verificações de auditoria estão ativadas ou desativadas.

 **Resumo**

```
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 de 

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


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| roleArn | string<br /> comprimento - máx.: 2048 mín.: 20 | O ARN da função que concede permissão à AWS IoT para acessar informações sobre os dispositivos, políticas, certificados e outros itens ao executar uma auditoria. | 
| auditNotificationTargetConfigurations | mapear | Informações sobre os destinos para os quais as notificações de auditoria são enviadas. | 
| targetArn | string | O ARN do destino (tópico do SNS) para o qual as notificações de auditoria são enviadas. | 
| roleArn | string<br /> comprimento - máx.: 2048 mín.: 20 | O ARN da função que concede permissão para enviar notificações ao destino. | 
| enabled | booleano | Verdadeiro se as notificações para o destino estão habilitadas. | 
| auditCheckConfigurations | mapear | Especifica quais verificações de auditoria são ativadas ou desativadas para essa conta. Use `DescribeAccountAuditConfiguration` para consultar a lista de todas as verificações, incluindo aquelas ativadas atualmente.<br />A coleta de alguns dados pode começar imediatamente quando determinadas verificações forem ativadas. Quando uma verificação for desativada, todos os dados coletados até o momento em relação à verificação são excluídos.<br />Não é possível desativar uma verificação se ela for usada por qualquer auditoria programada. Primeiro é necessário excluir a verificação da auditoria programada ou excluir a auditoria em si.<br />Na primeira chamada ao `UpdateAccountAuditConfiguration`, esse parâmetro é necessário e deve especificar pelo menos uma verificação ativada. | 
| enabled | booleano | Verdadeiro se essa verificação de auditoria está habilitada para essa conta. | 
| configuration | mapear | (Opcional) configurações personalizadas para verificações de auditoria específicas, como `CERT_AGE_THRESHOLD_IN_DAYS` e `CERT_EXPIRATION_THRESHOLD_IN_DAYS`, permitindo definir quando você quer receber um aviso sobre a idade do certificado e a expiração iminente. | 

Output

Nenhum

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

### DescribeAccountAuditConfiguration
<a name="dd-api-iot-DescribeAccountAuditConfiguration"></a>

Obtém informações sobre as configurações de auditoria do Device Defender para esta conta. As configurações incluem como as notificações de auditoria são enviadas e quais verificações de auditoria estão ativadas ou desativadas.

 **Resumo**

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

 `cli-input-json`Formato de 

```
{
}
```

Output

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


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| roleArn | string<br /> comprimento - máx.: 2048 mín.: 20 | O ARN da função que concede permissão à AWS IoT para acessar informações sobre os dispositivos, políticas, certificados e outros itens ao executar uma auditoria.<br />Na primeira chamada ao `UpdateAccountAuditConfiguration`, esse parâmetro é obrigatório. | 
| auditNotificationTargetConfigurations | mapear | Informações sobre os destinos para os quais as notificações são enviadas para essa conta. | 
| targetArn | string | O ARN do destino (tópico do SNS) para o qual as notificações de auditoria são enviadas. | 
| roleArn | string<br /> comprimento - máx.: 2048 mín.: 20 | O ARN da função que concede permissão para enviar notificações ao destino. | 
| enabled | booleano | Verdadeiro se as notificações para o destino estão habilitadas. | 
| auditCheckConfigurations | mapear | Quais verificações de auditoria são habilitadas ou desabilitadas para essa conta. | 
| enabled | booleano | Verdadeiro se essa verificação de auditoria está habilitada para essa conta. | 
| configuration | mapear | (Opcional) Permite configurar parâmetros específicos para certas verificações de auditoria, como o tempo de vida máximo de certificados ou o número de dias antes da expiração para o disparo de um alerta. | 

 **Erros**

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

### DeleteAccountAuditConfiguration
<a name="dd-api-iot-DeleteAccountAuditConfiguration"></a>

Restaura as configurações padrão para auditorias do Device Defender para essa conta. Qualquer dado de configuração inserido é excluído e todas as verificações de auditoria são desativadas. 

 **Resumo**

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

 `cli-input-json`Formato de 

```
{
  "deleteScheduledAudits": "boolean"
}
```


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| deleteScheduledAudits | booleano | Se verdadeiro, todas as auditorias programadas são excluídas. | 

Output

Nenhum

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ResourceNotFoundException`  
O recurso especificado não existe.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

## Programar auditorias
<a name="device-defender-AuditCommandsManageSchedules"></a>

Use `CreateScheduledAudit` para criar uma ou mais auditorias programadas. Este comando permite especificar as verificações que você deseja executar durante uma auditoria e a frequência com que essa auditoria deve ser executada. 

Acompanhe suas auditorias programadas com `ListScheduledAudits` e `DescribeScheduledAudit`. 

Altere uma auditoria programada existente com `UpdateScheduledAudit` ou a exclua com `DeleteScheduledAudit`. 

### CreateScheduledAudit
<a name="dd-api-iot-CreateScheduledAudit"></a>

Cria uma auditoria programada que é executada em um intervalo de tempo especificado.

 **Resumo**

```
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 de 

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


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| frequência | string | A frequência com que a auditoria programada ocorre. Pode ser DIÁRIO, SEMANAL, BISSEMANAL ou MENSAL. A hora de início real de cada auditoria é determinada pelo sistema.<br /> enum: DIÁRIO \| SEMANAL \| BISSEMANAL \| MENSAL. | 
| dayOfMonth | string<br /> padrão: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | O dia do mês em que a auditoria programada ocorre. Pode ser 1 a 31 ou LAST. Este campo é obrigatório se o parâmetro `frequency` for definido como MENSAL. Se os dias 29 a 31 forem especificados e o mês não tiver essa quantidade de dias, a auditoria ocorre no ÚLTIMO dia do mês. | 
| dayOfWeek | string | O dia da semana em que a auditoria programada ocorre. Pode ser DOM, SEG, TER, QUA, QUI, SEX ou SÁB. Este campo é obrigatório se o parâmetro `frequency` for definido como SEMANAL ou BISSEMANAL.<br /> enum: DOM \| SEG \| TER \| QUA \| QUI \| SEX \| SÁB. | 
| targetCheckNames | listar<br /> membro: AuditCheckName | Quais verificações são realizadas durante a auditoria programada. As verificações devem estar ativadas na sua conta. (Use `DescribeAccountAuditConfiguration` para consultar a lista de todas as verificações, incluindo as que estão ativadas ou `UpdateAccountAuditConfiguration` para selecionar quais verificações serão ativadas.) | 
| tags | listar<br /> membro: Tag<br /> classe java: java.util.List | Metadados que podem ser usados para gerenciar a auditoria programada. | 
| Chave | string | A chave da tag. | 
| Valor | string | O valor da tag. | 
| scheduledAuditName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [a-zA-Z0-9\_-]\+ | O nome que deseja dar à auditoria programada. (Máximo de 128 caracteres) | 

Output

```
{
  "scheduledAuditArn": "string"
}
```


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| scheduledAuditArn | string | O ARN da auditoria programada. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

`LimitExceededException`  
Um limite foi excedido.

### ListScheduledAudits
<a name="dd-api-iot-ListScheduledAudits"></a>

Lista todas as auditorias programadas.

 **Resumo**

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

 `cli-input-json`Formato de 

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


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| nextToken | string | O token para o próximo conjunto de resultados. | 
| maxResults | inteiro<br /> range- máx.: 250, mín.: 1 | O número máximo de resultados a serem retornados ao mesmo tempo. O padrão é 25. | 

Output

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


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| scheduledAudits | listar<br /> membro: ScheduledAuditMetadata<br /> classe java: java.util.List | A lista de auditorias programadas. | 
| scheduledAuditName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [a-zA-Z0-9\_-]\+ | O nome da auditoria programada. | 
| scheduledAuditArn | string | O ARN da auditoria programada. | 
| frequência | string | A frequência com que a auditoria programada ocorre.<br /> enum: DIÁRIO \| SEMANAL \| BISSEMANAL \| MENSAL. | 
| dayOfMonth | string<br /> padrão: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | O dia do mês em que a auditoria programada é executada (se `frequency` for MENSAL). Se os dias 29 a 31 forem especificados e o mês não tiver essa quantidade de dias, a auditoria ocorre no ÚLTIMO dia do mês. | 
| dayOfWeek | string | O dia da semana em que a auditoria programada é executada (se `frequency` for SEMANAL ou BISSEMANAL).<br /> enum: DOM \| SEG \| TER \| QUA \| QUI \| SEX \| SÁB. | 
| nextToken | string | Um token que pode ser usado para recuperar o próximo conjunto de resultados ou `null` se não houver mais resultados. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

### DescribeScheduledAudit
<a name="dd-api-iot-DescribeScheduledAudit"></a>

Obtém informações sobre uma auditoria programada.

 **Resumo**

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

 `cli-input-json`Formato de 

```
{
  "scheduledAuditName": "string"
}
```


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| scheduledAuditName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [a-zA-Z0-9\_-]\+ | O nome da auditoria programada da qual deseja obter informações. | 

Output

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


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| frequência | string | A frequência com que a auditoria programada ocorre. DIÁRIO, SEMANAL, BISSEMANAL ou MENSAL. A hora de início real de cada auditoria é determinada pelo sistema.<br /> enum: DIÁRIO \| SEMANAL \| BISSEMANAL \| MENSAL. | 
| dayOfMonth | string<br /> padrão: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | O dia do mês em que a auditoria programada ocorre. Pode ser 1 a 31 ou LAST. Se os dias 29 a 31 forem especificados e o mês não tiver essa quantidade de dias, a auditoria ocorre no ÚLTIMO dia do mês. | 
| dayOfWeek | string | O dia da semana em que a auditoria programada ocorre. DOM, SEG, TER, QUA, QUI, SEX ou SÁB.<br /> enum: DOM \| SEG \| TER \| QUA \| QUI \| SEX \| SÁB. | 
| targetCheckNames | listar<br /> membro: AuditCheckName | Quais verificações são realizadas durante a auditoria programada. As verificações devem estar ativadas na sua conta. (Use `DescribeAccountAuditConfiguration` para consultar a lista de todas as verificações, incluindo as que estão ativadas ou use `UpdateAccountAuditConfiguration` para selecionar quais verificações serão ativadas.) | 
| scheduledAuditName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [a-zA-Z0-9\_-]\+ | O nome da auditoria programada. | 
| scheduledAuditArn | string | O ARN da auditoria programada. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ResourceNotFoundException`  
O recurso especificado não existe.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

### UpdateScheduledAudit
<a name="dd-api-iot-UpdateScheduledAudit"></a>

Atualiza uma auditoria programada, incluindo quais verificações são realizadas e a frequência com que a auditoria ocorre.

 **Resumo**

```
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 de 

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


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| frequência | string | A frequência com que a auditoria programada ocorre. Pode ser DIÁRIO, SEMANAL, BISSEMANAL ou MENSAL. A hora de início real de cada auditoria é determinada pelo sistema.<br /> enum: DIÁRIO \| SEMANAL \| BISSEMANAL \| MENSAL. | 
| dayOfMonth | string<br /> padrão: ^([1-9]\|[12][0-9]\|3[01])$\|^LAST$ | O dia do mês em que a auditoria programada ocorre. Pode ser 1 a 31 ou LAST. Este campo é obrigatório se o parâmetro `frequency` for definido como MENSAL. Se os dias 29 a 31 forem especificados e o mês não tiver essa quantidade de dias, a auditoria ocorre no ÚLTIMO dia do mês. | 
| dayOfWeek | string | O dia da semana em que a auditoria programada ocorre. Pode ser DOM, SEG, TER, QUA, QUI, SEX ou SÁB. Este campo é obrigatório se o parâmetro `frequency` for definido como SEMANAL ou BISSEMANAL.<br /> enum: DOM \| SEG \| TER \| QUA \| QUI \| SEX \| SÁB. | 
| targetCheckNames | listar<br /> membro: AuditCheckName | Quais verificações são realizadas durante a auditoria programada. As verificações devem estar ativadas na sua conta. (Use `DescribeAccountAuditConfiguration` para consultar a lista de todas as verificações, incluindo as que estão ativadas ou use `UpdateAccountAuditConfiguration` para selecionar quais verificações serão ativadas.) | 
| scheduledAuditName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [a-zA-Z0-9\_-]\+ | O nome da auditoria programada. (Máximo de 128 caracteres) | 

Output

```
{
  "scheduledAuditArn": "string"
}
```


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| scheduledAuditArn | string | O ARN da auditoria programada. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ResourceNotFoundException`  
O recurso especificado não existe.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

### DeleteScheduledAudit
<a name="dd-api-iot-DeleteScheduledAudit"></a>

Exclui uma auditoria programada.

 **Resumo**

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

 `cli-input-json`Formato de 

```
{
  "scheduledAuditName": "string"
}
```


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| scheduledAuditName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [a-zA-Z0-9\_-]\+ | O nome da auditoria programada que deseja excluir. | 

Output

Nenhum

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ResourceNotFoundException`  
O recurso especificado não existe.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

## Executar uma auditoria sob demanda
<a name="device-defender-AuditCommandsOnDemand"></a>

Use `StartOnDemandAuditTask` para especificar as verificações que você deseja executar e iniciar uma auditoria com execução imediata.

### StartOnDemandAuditTask
<a name="dd-api-iot-StartOnDemandAuditTask"></a>

Iniciar uma auditoria do Device Defender sob demanda.

 **Resumo**

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

 `cli-input-json`Formato de 

```
{
  "targetCheckNames": [
    "string"
  ]
}
```


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| targetCheckNames | listar<br /> membro: AuditCheckName | Quais verificações são realizadas durante a auditoria. As verificações especificadas devem estar ativadas na sua conta ou ocorrerá uma exceção. Use `DescribeAccountAuditConfiguration` para consultar a lista de todas as verificações, incluindo as que estão ativadas ou `UpdateAccountAuditConfiguration` para selecionar quais verificações serão ativadas. | 

Output

```
{
  "taskId": "string"
}
```


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| taskId | string<br /> comprimento - máx.: 40 mín.: 1<br /> padrão: [a-zA-Z0-9-]\+ | O ID da auditoria sob demanda iniciada. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

`LimitExceededException`  
Um limite foi excedido.

## Gerenciar instâncias de auditoria
<a name="device-defender-AuditCommandsManageInstances"></a>

Use `DescribeAuditTask` para obter informações sobre uma instância de auditoria específica. Se ela já foi executada, os resultados incluem quais verificações falharam e quais foram aprovadas, aquelas que o sistema não foi capaz de concluir e, se a auditoria ainda estiver em andamento, aquelas em que ainda está trabalhando.

Use `ListAuditTasks` para encontrar as auditorias executadas durante um intervalo de tempo especificado.

Use `CancelAuditTask` para interromper uma auditoria em andamento.

### DescribeAuditTask
<a name="dd-api-iot-DescribeAuditTask"></a>

Obtém informações sobre uma auditoria do Device Defender.

 **Resumo**

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

 `cli-input-json`Formato de 

```
{
  "taskId": "string"
}
```


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| taskId | string<br /> comprimento - máx.: 40 mín.: 1<br /> padrão: [a-zA-Z0-9-]\+ | O ID da auditoria programada da qual deseja obter informações. | 

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


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| taskStatus | string | O status da auditoria: IN\_PROGRESS, COMPLETED, FAILED, ou CANCELED.<br /> enum: IN\_PROGRESS \| COMPLETED \| FAILED \| CANCELED | 
| Tipo de tarefa | string | O tipo de auditoria: ON\_DEMAND\_AUDIT\_TASK ou SCHEDULED\_AUDIT\_TASK.<br /> enum: ON\_DEMAND\_AUDIT\_TASK \| SCHEDULED\_AUDIT\_TASK | 
| taskStartTime | timestamp | A hora em que a auditoria foi iniciada. | 
| taskStatistics | TaskStatistics | Informações estatísticas sobre a auditoria. | 
| totalChecks | integer | O número de verificações nesta auditoria. | 
| inProgressChecks | integer | O número de verificações em andamento. | 
| waitingForDataCollectionChecks | integer | O número de verificações aguardando a coleta de dados. | 
| compliantChecks | integer | O número de verificações que encontraram recursos compatíveis. | 
| nonCompliantChecks | integer | O número de verificações que encontraram recursos incompatíveis. | 
| failedChecks | integer | O número de verificações.  | 
| canceledChecks | integer | O número de verificações que não foram executadas porque a auditoria foi cancelada. | 
| scheduledAuditName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [a-zA-Z0-9\_-]\+ | O nome da auditoria programada (somente se a auditoria for uma auditoria programada). | 
| auditDetails | mapear | Informações detalhadas sobre cada verificação realizada durante essa auditoria. | 
| checkRunStatus | string | O status de conclusão dessa verificação: IN\_PROGRESS, WAITING\_FOR\_DATA\_COLLECTION, CANCELED, COMPLETED\_COMPLIANT, COMPLETED\_NON\_COMPLIANT, ou FAILED.<br /> enum: IN\_PROGRESS \| WAITING\_FOR\_DATA\_COLLECTION \| CANCELED \| COMPLETED\_COMPLIANT \| COMPLETED\_NON\_COMPLIANT \| FAILED | 
| checkCompliant | booleano | Verdadeiro se a verificação foi concluída e encontrou todos os recursos compatíveis. | 
| totalResourcesCount | longo | O número de recursos nos quais a verificação foi realizada. | 
| nonCompliantResourcesCount | longo | O número de recursos que a verificação identificou como incompatíveis. | 
| errorCode | string | O código de qualquer erro encontrado ao executar essa verificação durante a auditoria. INSUFFICIENT\_PERMISSIONS ou AUDIT\_CHECK\_DISABLED. | 
| message | string<br /> comprimento - máx.: 2048 | A mensagem associada a qualquer erro encontrado ao executar essa verificação durante a auditoria. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ResourceNotFoundException`  
O recurso especificado não existe.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

### ListAuditTasks
<a name="dd-api-iot-ListAuditTasks"></a>

Lista as auditorias do Device Defender realizadas durante um determinado período.

 **Resumo**

```
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 de 

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


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| startTime | timestamp | O início do período. As informações de auditoria são mantidas durante um período limitado (180 dias). Solicitar uma hora de início anterior ao que está mantido resulta em um `InvalidRequestException`. | 
| endTime | timestamp | O término do período. | 
| Tipo de tarefa | string | Um filtro para limitar a saída para o tipo de auditoria especificado: pode ser ON\_DEMAND\_AUDIT\_TASK ou SCHEDULED\_\_AUDIT\_TASK.<br /> enum: ON\_DEMAND\_AUDIT\_TASK \| SCHEDULED\_AUDIT\_TASK | 
| taskStatus | string | Um filtro para limitar a saída para auditorias com o status de conclusão especificado: pode ser IN\_PROGRESS, COMPLETED, FAILED, ou CANCELED.<br /> enum: IN\_PROGRESS \| COMPLETED \| FAILED \| CANCELED | 
| nextToken | string | O token para o próximo conjunto de resultados. | 
| maxResults | inteiro<br /> range- máx.: 250, mín.: 1 | O número máximo de resultados a serem retornados ao mesmo tempo. O padrão é 25. | 

Output

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


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| tarefas | listar<br /> membro: AuditTaskMetadata<br /> classe java: java.util.List | As auditorias realizadas durante o período especificado. | 
| taskId | string<br /> comprimento - máx.: 40 mín.: 1<br /> padrão: [a-zA-Z0-9-]\+ | O ID dessa auditoria. | 
| taskStatus | string | O status dessa auditoria: IN\_PROGRESS, COMPLETED, FAILED, ou CANCELED.<br /> enum: IN\_PROGRESS \| COMPLETED \| FAILED \| CANCELED | 
| Tipo de tarefa | string | O tipo dessa auditoria: ON\_DEMAND\_AUDIT\_TASK ou SCHEDULED\_AUDIT\_TASK.<br /> enum: ON\_DEMAND\_AUDIT\_TASK \| SCHEDULED\_AUDIT\_TASK | 
| nextToken | string | Um token que pode ser usado para recuperar o próximo conjunto de resultados ou `null` se não houver resultados adicionais. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

### CancelAuditTask
<a name="dd-api-iot-CancelAuditTask"></a>

Cancela uma auditoria que está em andamento. A auditoria pode ser programada ou sob demanda. Se a auditoria não está em andamento, uma `InvalidRequestException` ocorre.

 **Resumo**

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

 `cli-input-json`Formato de 

```
{
  "taskId": "string"
}
```


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| taskId | string<br /> comprimento - máx.: 40 mín.: 1<br /> padrão: [a-zA-Z0-9-]\+ | O ID da auditoria que deseja cancelar. Só é possível cancelar uma auditoria que está IN\_PROGRESS. | 

Output

Nenhum

 **Erros**

`ResourceNotFoundException`  
O recurso especificado não existe.

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.

## Verificar os resultados da auditoria
<a name="device-defender-AuditCommandsFindings"></a>

Use `ListAuditFindings` para ver os resultados de uma auditoria. É possível filtrar os resultados pelo tipo de verificação, um recurso específico ou a data da auditoria. Você pode usar essas informações para reduzir os problemas que foram encontrados.

Você pode definir ações de mitigação e aplicá-las às descobertas de sua auditoria. Para obter mais informações, consulte [Ações de mitigação](dd-mitigation-actions.md).

### ListAuditFindings
<a name="dd-api-iot-ListAuditFindings"></a>

Lista as descobertas (resultados) de uma auditoria do Device Defender ou das auditorias realizadas durante um período especificado. (As descobertas são mantidas durante 180 dias.)

 **Resumo**

```
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 de 

```
{
  "taskId": "string",
  "checkName": "string",
  "resourceIdentifier": {
    "deviceCertificateId": "string",
    "caCertificateId": "string",
    "cognitoIdentityPoolId": "string",
    "clientId": "string",
    "policyVersionIdentifier": {
      "policyName": "string",
      "policyVersionId": "string"
    },
   
    "roleAliasArn": "string",
    "account": "string"
  },
  "maxResults": "integer",
  "nextToken": "string",
  "startTime": "timestamp",
  "endTime": "timestamp"
}
```


**`cli-input-json`Campos**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| taskId | string<br /> comprimento - máx.: 40 mín.: 1<br /> padrão: [a-zA-Z0-9-]\+ | Um filtro para limitar os resultados para a auditoria com o ID especificado. É necessário especificar o taskId, ou startTime e endTime, mas não ambos. | 
| checkName | string | Um filtro para limitar os resultados para as descobertas da verificação de auditoria especificada. | 
| resourceIdentifier | ResourceIdentifier | As informações que identificam o recurso incompatível. | 
| deviceCertificateId | string<br /> comprimento - máx.: 64 mín.: 64<br /> padrão: (0x)?[a-fA-F0-9]\+ | O ID do certificado anexado ao recurso. | 
| caCertificateId | string<br /> comprimento - máx.: 64 mín.: 64<br /> padrão: (0x)?[a-fA-F0-9]\+ | O ID do certificado CA usado para autorizar o certificado. | 
| cognitoIdentityPoolId | string | O ID do grupo de identidades do Amazon Cognito. | 
| clientId | string | O ID do cliente. | 
| policyVersionIdentifier | PolicyVersionIdentifier | A versão da política associada ao recurso. | 
| policyName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [w\+=,.@-]\+ | O nome da política. | 
| policyVersionId | string<br /> padrão: [0-9]\+ | O ID da versão da política associada ao recurso. | 
| roleAliasArn | string | O ARN do alias de função que tem ações excessivamente permissivas.<br /> comprimento - máx.: 2048 mín.: 1 | 
| conta | string<br /> comprimento - máx.: 12 mín.: 12<br /> padrão: [0-9]\+ | A conta com a qual o recurso está associado. | 
| maxResults | inteiro<br /> range- máx.: 250, mín.: 1 | O número máximo de resultados a serem retornados ao mesmo tempo. O padrão é 25. | 
| nextToken | string | O token para o próximo conjunto de resultados. | 
| startTime | timestamp | Um filtro para limitar os resultados para aqueles encontrados após o tempo especificado. É necessário especificar startTime e endTime, ou o taskId, mas não ambos. | 
| endTime | timestamp | Um filtro para limitar os resultados para aqueles encontrados antes do tempo especificado. É necessário especificar startTime e endTime, ou o taskId, mas não ambos. | 

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


**Campos de saída da CLI**  

|  Nome |  Tipo |  Descrição | 
| --- | --- | --- | 
| descobertas | listar<br /> membro: AuditFinding | As descobertas (resultados) da auditoria. | 
| taskId | string<br /> comprimento - máx.: 40 mín.: 1<br /> padrão: [a-zA-Z0-9-]\+ | O ID da auditoria que gerou esse resultado (descoberta). | 
| checkName | string | A verificação de auditoria que gerou esse resultado. | 
| taskStartTime | timestamp | A hora em que a auditoria foi iniciada. | 
| findingTime | timestamp | A hora em que o resultado (descoberta) foi encontrado. | 
| severidade | string | A severidade do resultado (descoberta).<br /> enum: CRITICAL \| HIGH \| MEDIUM \| LOW | 
| nonCompliantResource | NonCompliantResource | O recurso identificado como incompatível com a verificação de auditoria. | 
| resourceType | string | O tipo do recurso incompatível.<br /> enum: DEVICE\_CERTIFICATE \| CA\_CERTIFICATE \| IOT\_POLICY \| COGNITO\_IDENTITY\_POOL \| CLIENT\_ID \| ACCOUNT\_SETTINGS | 
| resourceIdentifier | ResourceIdentifier | As informações que identificam o recurso incompatível. | 
| deviceCertificateId | string<br /> comprimento - máx.: 64 mín.: 64<br /> padrão: (0x)?[a-fA-F0-9]\+ | O ID do certificado anexado ao recurso. | 
| caCertificateId | string<br /> comprimento - máx.: 64 mín.: 64<br /> padrão: (0x)?[a-fA-F0-9]\+ | O ID do certificado CA usado para autorizar o certificado. | 
| cognitoIdentityPoolId | string | O ID do grupo de identidades do Amazon Cognito. | 
| clientId | string | O ID do cliente. | 
| policyVersionIdentifier | PolicyVersionIdentifier | A versão da política associada ao recurso. | 
| policyName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [w\+=,.@-]\+ | O nome da política. | 
| policyVersionId | string<br /> padrão: [0-9]\+ | O ID da versão da política associada ao recurso. | 
| conta | string<br /> comprimento - máx.: 12 mín.: 12<br /> padrão: [0-9]\+ | A conta com a qual o recurso está associado. | 
| additionalInfo | mapear | Outras informações sobre o recurso incompatível. | 
| relatedResources | listar<br /> membro: RelatedResource | A lista de recursos relacionados. | 
| resourceType | string | O tipo de recurso.<br /> enum: DEVICE\_CERTIFICATE \| CA\_CERTIFICATE \| IOT\_POLICY \| COGNITO\_IDENTITY\_POOL \| CLIENT\_ID \| ACCOUNT\_SETTINGS | 
| resourceIdentifier | ResourceIdentifier | As informações que identificam o recurso. | 
| deviceCertificateId | string<br /> comprimento - máx.: 64 mín.: 64<br /> padrão: (0x)?[a-fA-F0-9]\+ | O ID do certificado anexado ao recurso. | 
| caCertificateId | string<br /> comprimento - máx.: 64 mín.: 64<br /> padrão: (0x)?[a-fA-F0-9]\+ | O ID do certificado CA usado para autorizar o certificado. | 
| cognitoIdentityPoolId | string | O ID do grupo de identidades do Amazon Cognito. | 
| clientId | string | O ID do cliente. | 
| policyVersionIdentifier | PolicyVersionIdentifier | A versão da política associada ao recurso. | 
| iamRoleArn | string<br /> comprimento - máx.: 2048 mín.: 20 | O ARN do perfil do IAM que tem ações excessivamente permissivas. | 
| policyName | string<br /> comprimento - máx.: 128 mín.: 1<br /> padrão: [w\+=,.@-]\+ | O nome da política. | 
| policyVersionId | string<br /> padrão: [0-9]\+ | O ID da versão da política associada ao recurso. | 
| roleAliasArn | string<br /> length- max:2048 min:1 | O ARN do alias de função que tem ações excessivamente permissivas. | 
| conta | string<br /> comprimento - máx.: 12 mín.: 12<br /> padrão: [0-9]\+ | A conta com a qual o recurso está associado. | 
| additionalInfo | mapear | Outras informações sobre o recurso. | 
| reasonForNonCompliance | string | O motivo pelo qual o recurso era incompatível. | 
| reasonForNonComplianceCode | string | Um código que indica o motivo pelo qual o recurso era incompatível. | 
| nextToken | string | Um token que pode ser usado para recuperar o próximo conjunto de resultados ou `null` se não houver resultados adicionais. | 

 **Erros**

`InvalidRequestException`  
O conteúdo da solicitação era inválido.

`ThrottlingException`  
A taxa excede o limite.

`InternalFailureException`  
Ocorreu um erro inesperado.