# Comandos de auditoria ## Gerenciar configurações de auditoria 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 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 ] \ [--audit-notification-target-configurations ] \ [--audit-check-configurations ] \ [--cli-input-json ] \ [--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 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 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. 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. 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. 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 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 ] \ [--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 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. 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 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 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 ] \ [--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 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 Cria uma auditoria programada que é executada em um intervalo de tempo especificado. **Resumo** ``` aws iot create-scheduled-audit \ --frequency \ [--day-of-month ] \ [--day-of-week ] \ --target-check-names \ [--tags ] \ --scheduled-audit-name \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`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. enum: DIÁRIO \$1 SEMANAL \$1 BISSEMANAL \$1 MENSAL. | | dayOfMonth | string padrão: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | 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. enum: DOM \$1 SEG \$1 TER \$1 QUA \$1 QUI \$1 SEX \$1 SÁB. | | targetCheckNames | listar 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 membro: Tag 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 comprimento - máx.: 128 mín.: 1 padrão: [a-zA-Z0-9\$1-]\$1 | 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 Lista todas as auditorias programadas. **Resumo** ``` aws iot list-scheduled-audits \ [--next-token ] \ [--max-results ] \ [--cli-input-json ] \ [--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 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 membro: ScheduledAuditMetadata classe java: java.util.List | A lista de auditorias programadas. | | scheduledAuditName | string comprimento - máx.: 128 mín.: 1 padrão: [a-zA-Z0-9\$1-]\$1 | O nome da auditoria programada. | | scheduledAuditArn | string | O ARN da auditoria programada. | | frequência | string | A frequência com que a auditoria programada ocorre. enum: DIÁRIO \$1 SEMANAL \$1 BISSEMANAL \$1 MENSAL. | | dayOfMonth | string padrão: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | 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). enum: DOM \$1 SEG \$1 TER \$1 QUA \$1 QUI \$1 SEX \$1 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 Obtém informações sobre uma auditoria programada. **Resumo** ``` aws iot describe-scheduled-audit \ --scheduled-audit-name \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`Formato de ``` { "scheduledAuditName": "string" } ``` **`cli-input-json`Campos** | Nome | Tipo | Descrição | | --- | --- | --- | | scheduledAuditName | string comprimento - máx.: 128 mín.: 1 padrão: [a-zA-Z0-9\$1-]\$1 | 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. enum: DIÁRIO \$1 SEMANAL \$1 BISSEMANAL \$1 MENSAL. | | dayOfMonth | string padrão: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | 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. enum: DOM \$1 SEG \$1 TER \$1 QUA \$1 QUI \$1 SEX \$1 SÁB. | | targetCheckNames | listar 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 comprimento - máx.: 128 mín.: 1 padrão: [a-zA-Z0-9\$1-]\$1 | 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 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 ] \ [--day-of-month ] \ [--day-of-week ] \ [--target-check-names ] \ --scheduled-audit-name \ [--cli-input-json ] \ [--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. enum: DIÁRIO \$1 SEMANAL \$1 BISSEMANAL \$1 MENSAL. | | dayOfMonth | string padrão: ^([1-9]\$1[12][0-9]\$13[01])\$1\$1^LAST\$1 | 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. enum: DOM \$1 SEG \$1 TER \$1 QUA \$1 QUI \$1 SEX \$1 SÁB. | | targetCheckNames | listar 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 comprimento - máx.: 128 mín.: 1 padrão: [a-zA-Z0-9\$1-]\$1 | 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 Exclui uma auditoria programada. **Resumo** ``` aws iot delete-scheduled-audit \ --scheduled-audit-name \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`Formato de ``` { "scheduledAuditName": "string" } ``` **`cli-input-json`Campos** | Nome | Tipo | Descrição | | --- | --- | --- | | scheduledAuditName | string comprimento - máx.: 128 mín.: 1 padrão: [a-zA-Z0-9\$1-]\$1 | 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 Use `StartOnDemandAuditTask` para especificar as verificações que você deseja executar e iniciar uma auditoria com execução imediata. ### StartOnDemandAuditTask Iniciar uma auditoria do Device Defender sob demanda. **Resumo** ``` aws iot start-on-demand-audit-task \ --target-check-names \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`Formato de ``` { "targetCheckNames": [ "string" ] } ``` **`cli-input-json`Campos** | Nome | Tipo | Descrição | | --- | --- | --- | | targetCheckNames | listar 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 comprimento - máx.: 40 mín.: 1 padrão: [a-zA-Z0-9-]\$1 | 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 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 Obtém informações sobre uma auditoria do Device Defender. **Resumo** ``` aws iot describe-audit-task \ --task-id \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`Formato de ``` { "taskId": "string" } ``` **`cli-input-json`Campos** | Nome | Tipo | Descrição | | --- | --- | --- | | taskId | string comprimento - máx.: 40 mín.: 1 padrão: [a-zA-Z0-9-]\$1 | 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\$1PROGRESS, COMPLETED, FAILED, ou CANCELED. enum: IN\$1PROGRESS \$1 COMPLETED \$1 FAILED \$1 CANCELED | | Tipo de tarefa | string | O tipo de auditoria: ON\$1DEMAND\$1AUDIT\$1TASK ou SCHEDULED\$1AUDIT\$1TASK. enum: ON\$1DEMAND\$1AUDIT\$1TASK \$1 SCHEDULED\$1AUDIT\$1TASK | | 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 comprimento - máx.: 128 mín.: 1 padrão: [a-zA-Z0-9\$1-]\$1 | 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\$1PROGRESS, WAITING\$1FOR\$1DATA\$1COLLECTION, CANCELED, COMPLETED\$1COMPLIANT, COMPLETED\$1NON\$1COMPLIANT, ou FAILED. enum: IN\$1PROGRESS \$1 WAITING\$1FOR\$1DATA\$1COLLECTION \$1 CANCELED \$1 COMPLETED\$1COMPLIANT \$1 COMPLETED\$1NON\$1COMPLIANT \$1 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\$1PERMISSIONS ou AUDIT\$1CHECK\$1DISABLED. | | message | string 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 Lista as auditorias do Device Defender realizadas durante um determinado período. **Resumo** ``` aws iot list-audit-tasks \ --start-time \ --end-time \ [--task-type ] \ [--task-status ] \ [--next-token ] \ [--max-results ] \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`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\$1DEMAND\$1AUDIT\$1TASK ou SCHEDULED\$1\$1AUDIT\$1TASK. enum: ON\$1DEMAND\$1AUDIT\$1TASK \$1 SCHEDULED\$1AUDIT\$1TASK | | taskStatus | string | Um filtro para limitar a saída para auditorias com o status de conclusão especificado: pode ser IN\$1PROGRESS, COMPLETED, FAILED, ou CANCELED. enum: IN\$1PROGRESS \$1 COMPLETED \$1 FAILED \$1 CANCELED | | nextToken | string | O token para o próximo conjunto de resultados. | | maxResults | inteiro 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 membro: AuditTaskMetadata classe java: java.util.List | As auditorias realizadas durante o período especificado. | | taskId | string comprimento - máx.: 40 mín.: 1 padrão: [a-zA-Z0-9-]\$1 | O ID dessa auditoria. | | taskStatus | string | O status dessa auditoria: IN\$1PROGRESS, COMPLETED, FAILED, ou CANCELED. enum: IN\$1PROGRESS \$1 COMPLETED \$1 FAILED \$1 CANCELED | | Tipo de tarefa | string | O tipo dessa auditoria: ON\$1DEMAND\$1AUDIT\$1TASK ou SCHEDULED\$1AUDIT\$1TASK. enum: ON\$1DEMAND\$1AUDIT\$1TASK \$1 SCHEDULED\$1AUDIT\$1TASK | | 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 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 \ [--cli-input-json ] \ [--generate-cli-skeleton] ``` `cli-input-json`Formato de ``` { "taskId": "string" } ``` **`cli-input-json`Campos** | Nome | Tipo | Descrição | | --- | --- | --- | | taskId | string comprimento - máx.: 40 mín.: 1 padrão: [a-zA-Z0-9-]\$1 | O ID da auditoria que deseja cancelar. Só é possível cancelar uma auditoria que está IN\$1PROGRESS. | 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 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 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 ] \ [--check-name ] \ [--resource-identifier ] \ [--max-results ] \ [--next-token ] \ [--start-time ] \ [--end-time ] \ [--cli-input-json ] \ [--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 comprimento - máx.: 40 mín.: 1 padrão: [a-zA-Z0-9-]\$1 | 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 comprimento - máx.: 64 mín.: 64 padrão: (0x)?[a-fA-F0-9]\$1 | O ID do certificado anexado ao recurso. | | caCertificateId | string comprimento - máx.: 64 mín.: 64 padrão: (0x)?[a-fA-F0-9]\$1 | 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 comprimento - máx.: 128 mín.: 1 padrão: [w\$1=,.@-]\$1 | O nome da política. | | policyVersionId | string padrão: [0-9]\$1 | 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. comprimento - máx.: 2048 mín.: 1 | | conta | string comprimento - máx.: 12 mín.: 12 padrão: [0-9]\$1 | A conta com a qual o recurso está associado. | | maxResults | inteiro 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 membro: AuditFinding | As descobertas (resultados) da auditoria. | | taskId | string comprimento - máx.: 40 mín.: 1 padrão: [a-zA-Z0-9-]\$1 | 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). enum: CRITICAL \$1 HIGH \$1 MEDIUM \$1 LOW | | nonCompliantResource | NonCompliantResource | O recurso identificado como incompatível com a verificação de auditoria. | | resourceType | string | O tipo do recurso incompatível. enum: DEVICE\$1CERTIFICATE \$1 CA\$1CERTIFICATE \$1 IOT\$1POLICY \$1 COGNITO\$1IDENTITY\$1POOL \$1 CLIENT\$1ID \$1 ACCOUNT\$1SETTINGS | | resourceIdentifier | ResourceIdentifier | As informações que identificam o recurso incompatível. | | deviceCertificateId | string comprimento - máx.: 64 mín.: 64 padrão: (0x)?[a-fA-F0-9]\$1 | O ID do certificado anexado ao recurso. | | caCertificateId | string comprimento - máx.: 64 mín.: 64 padrão: (0x)?[a-fA-F0-9]\$1 | 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 comprimento - máx.: 128 mín.: 1 padrão: [w\$1=,.@-]\$1 | O nome da política. | | policyVersionId | string padrão: [0-9]\$1 | O ID da versão da política associada ao recurso. | | conta | string comprimento - máx.: 12 mín.: 12 padrão: [0-9]\$1 | A conta com a qual o recurso está associado. | | additionalInfo | mapear | Outras informações sobre o recurso incompatível. | | relatedResources | listar membro: RelatedResource | A lista de recursos relacionados. | | resourceType | string | O tipo de recurso. enum: DEVICE\$1CERTIFICATE \$1 CA\$1CERTIFICATE \$1 IOT\$1POLICY \$1 COGNITO\$1IDENTITY\$1POOL \$1 CLIENT\$1ID \$1 ACCOUNT\$1SETTINGS | | resourceIdentifier | ResourceIdentifier | As informações que identificam o recurso. | | deviceCertificateId | string comprimento - máx.: 64 mín.: 64 padrão: (0x)?[a-fA-F0-9]\$1 | O ID do certificado anexado ao recurso. | | caCertificateId | string comprimento - máx.: 64 mín.: 64 padrão: (0x)?[a-fA-F0-9]\$1 | 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 comprimento - máx.: 2048 mín.: 20 | O ARN do perfil do IAM que tem ações excessivamente permissivas. | | policyName | string comprimento - máx.: 128 mín.: 1 padrão: [w\$1=,.@-]\$1 | O nome da política. | | policyVersionId | string padrão: [0-9]\$1 | O ID da versão da política associada ao recurso. | | roleAliasArn | string length- max:2048 min:1 | O ARN do alias de função que tem ações excessivamente permissivas. | | conta | string comprimento - máx.: 12 mín.: 12 padrão: [0-9]\$1 | 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.