Exemplos do AWS IoT usando oAWS CLI - AWS Command Line Interface
Ações

Exemplos do AWS IoT usando oAWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS IoT.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar accept-certificate-transfer.

AWS CLI

Para aceitar um certificado de dispositivo transferido de uma conta da AWS diferente

O exemplo accept-certificate-transfer a seguir aceita um certificado de dispositivo transferido de outra conta da AWS. O certificado é identificado por seu ID.

aws iot accept-certificate-transfer \
    --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18bEXAMPLEe57b7272ba44c45e3448142

Esse comando não produz nenhuma saída.

Para obter mais informações, consulte Transferir um certificado para outra conta no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar add-thing-to-billing-group.

AWS CLI

Exemplo 1: adicionar um item a um grupo de cobrança pelo nome

O exemplo add-thing-to-billing-group a seguir adiciona o item chamado MyLightBulb ao grupo de cobrança chamado GroupOne.

aws iot add-thing-to-billing-group \
    --billing-group-name GroupOne \
    --thing-name MyLightBulb

Este comando não produz saída.

Exemplo 2: adicionar um item a um grupo de cobrança por ARN

O exemplo add-thing-to-billing-group a seguir adiciona um item com um ARN especificado a um grupo de cobrança com o ARN especificado. Especificar um ARN é útil ao trabalhar com várias regiões ou contas da AWS. Isso pode ajudar a garantir que o item seja adicionado à região e à conta corretas.

aws iot add-thing-to-thing-group \
    --billing-group-arn "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" \
    --thing-arn "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb"

Este comando não produz saída.

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar add-thing-to-thing-group.

AWS CLI

Para adicionar um item a um grupo

O exemplo add-thing-to-thing-group a seguir adiciona o item especificado a um grupo de itens especificado.

aws iot add-thing-to-thing-group \
    --thing-name MyLightBulb \
    --thing-group-name LightBulbs

Este comando não produz saída.

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar associate-targets-with-job.

AWS CLI

Para associar um grupo a um trabalho contínuo

O exemplo associate-targets-with-job a seguir associa o grupo de itens especificado ao trabalho contínuo especificado.

aws iot associate-targets-with-job \
    --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \
    --job-id "example-job-04"

Saída:

{
    "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04",
    "jobId": "example-job-04",
    "description": "example continuous job"
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar attach-policy.

AWS CLI

Exemplo 1: anexar uma política a um grupo de itens

O exemplo attach-policy a seguir anexa a política especificada a um grupo de itens identificado por seu ARN.

aws iot attach-policy \
    --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \
    --policy-name "UpdateDeviceCertPolicy"

Esse comando não produz nenhuma saída.

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

Exemplo 2: anexar uma política a um certificado

O exemplo attach-policy a seguir anexa a política UpdateDeviceCertPolicy à entidade principal especificada por um certificado.

aws iot attach-policy \
    --policy-name UpdateDeviceCertPolicy \
    --target "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e"

Esse comando não produz nenhuma saída.

Para obter mais informações, consulte Anexar uma política de AWS IoT a um certificado de dispositivo no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte AttachPolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar attach-security-profile.

AWS CLI

Para associar um perfil de segurança a todos os dispositivos não registrados

O exemplo attach-security-profile a seguir associa o perfil de segurança do AWS IoT Device Defender chamado Testprofile a todos os dispositivos não registrados na região us-west-2 para essa conta da AWS.

aws iot attach-security-profile \
    --security-profile-name Testprofile \
    --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things"

Este comando não produz saída.

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar attach-thing-principal.

AWS CLI

Para anexar um certificado a um item

O exemplo attach-thing-principal a seguir anexa um certificado ao item MyTemperatureSensor. O certificado é identificado por um ARN. É possível encontrar o ARN para um certificado no console do AWS IoT.

aws iot attach-thing-principal \
    --thing-name MyTemperatureSensor \
    --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8

Este comando não produz saída.

Para acessar mais informações, consulte Como gerenciar objetos com o registro no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar cancel-audit-mitigation-actions-task.

AWS CLI

Para cancelar uma tarefa de ações de mitigação de auditoria

O exemplo cancel-audit-mitigations-action-task a seguir cancela a aplicação de ações de mitigação para a tarefa especificada. Não é possível cancelar tarefas que foram concluídas.

aws iot cancel-audit-mitigation-actions-task
    --task-id "myActionsTaskId"

Este comando não produz saída.

Para obter mais informações, consulte CancelAuditMitigationActionsTask (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar cancel-audit-task.

AWS CLI

Para cancelar uma tarefa de auditoria

O exemplo cancel-audit-task a seguir cancela uma tarefa de auditoria com o ID de tarefa especificado. Não é possível cancelar uma tarefa que está concluída.

aws iot cancel-audit-task \
    --task-id a3aea009955e501a31b764abe1bebd3d

Este comando não produz saída.

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CancelAuditTask na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar cancel-certificate-transfer.

AWS CLI

Para cancelar a transferência de um certificado para uma conta da AWS diferente

O exemplo cancel-certificate-transfer a seguir cancela a transferência da transferência de certificado especificada. O certificado é identificado por uma ID de certificado. É possível encontrar o ID para um certificado no console do AWS IoT.

aws iot cancel-certificate-transfer \
    --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8

Este comando não produz saída.

Para obter mais informações, consulte Transferir um certificado para outra conta no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar cancel-job-execution.

AWS CLI

Para cancelar uma execução de trabalho em um dispositivo

O exemplo cancel-job-execution a seguir cancela a execução do trabalho especificado em um dispositivo. Se o trabalho não estiver no estado QUEUED, é necessário adicionar o parâmetro --force.

aws iot cancel-job-execution \
    --job-id "example-job-03" \
    --thing-name "MyRPi"

Este comando não produz saída.

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CancelJobExecution na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar cancel-job.

AWS CLI

Para cancelar um trabalho

O exemplo cancel-job a seguir cancela o trabalho especificado.

aws iot cancel-job \
    --job-job "example-job-03"

Saída:

{
    "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-03",
    "jobId": "example-job-03",
    "description": "example job test"
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CancelJob na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar clear-default-authorizer.

AWS CLI

Para limpar o autorizador padrão

O exemplo clear-default-authorizer a seguir limpa o autorizador personalizado padrão atualmente configurado. Depois de executar esse comando, não haverá um autorizador padrão. Ao usar um autorizador personalizado, é necessário especificá-lo pelo nome nos cabeçalhos da solicitação HTTP.

aws iot clear-default-authorizer

Este comando não produz saída.

Para obter mais informações, consulte ClearDefaultAuthorizer na Referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar confirm-topic-rule-destination.

AWS CLI

Para confirmar um destino de regra de tópico

O exemplo confirm-topic-rule-destination a seguir confirma o destino de uma regra de tópico com um token de confirmação recebido em um endpoint HTTP.

aws iot confirm-topic-rule-destination \
    --confirmation-token "AYADeIcmtq-ZkxfpiWIQqHWM5ucAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREFxY1E0UmlGeDg0V21BZWZ1VjZtZWFRVUJJUktUYXJaN09OZlJOczJhRENSZmZYL3JHZC9PR3NNcis5T3ZlSitnQT09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLWVhc3QtMTo5ODc5NTE4NTI0OTk6a2V5L2U4YmU3ODViLTU5NWMtNDcxYi1iOWJmLWQ2Y2I4ZjQxODlmNwC4AQIBAHhwz48UWTGWE1ua0P8U1hj27nsFzEaAdf6Hs2K_7wBheAF62zwMuk_A4dPiC6eyPGuMAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM9vtRMpf9D3CiZ8sMAgEQgDuFd0Txy-aywpPqg8YEsa1lD4B40aJ2s1wEHKMybiF1RoOZzYisI0IvslzQY5UmCkqq3tV-3f7-nKfosgIAAAAADAAAEAAAAAAAAAAAAAAAAAAi9RMgy-V19V9m6Iw2xfbw_____wAAAAEAAAAAAAAAAAAAAAEAAAB1hw4SokgUcxiJ3gTO6n50NLJVpzyQR1UmPIj5sShqXEQGcOsWmXzpYOOx_PWyPVNsIFHApyK7Cc3g4bW8VaLVwOLkC83g6YaZAh7dFEl2-iufgrzTePl8RZYOWr0O6Aj9DiVzJZx-1iD6Pu-G6PUw1kaO7Knzs2B4AD0qfrHUF4pYRTvyUgBnMGUCMQC8ZRmhKqntd_c6Kgrow3bMUDBvNqo2qZr8Z8Jm2rzgseROlAnLgFLGpGShr99oSZkCMEd1v62NBRKX9HQXnybyF3fkg__-PIetJ803Z4IlIlF8xXlcdPGP-PV1dOXFemyL8g"

Este comando não produz saída.

Para obter mais informações, consulte Confirmar um destino de regra de tópico no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-audit-suppression.

AWS CLI

Para criar uma supressão de descoberta de auditoria

O exemplo create-audit-suppression a seguir cria uma supressão de descoberta de auditoria para uma política chamada "virtualMachinePolicy" que foi sinalizada por ser excessivamente permissiva.

aws iot create-audit-suppression \
    --check-name IOT_POLICY_OVERLY_PERMISSIVE_CHECK \
    --resource-identifier policyVersionIdentifier={"policyName"="virtualMachinePolicy","policyVersionId"="1"} \
    --no-suppress-indefinitely \
    --expiration-date 2020-10-20

Este comando não produz saída.

Para obter mais informações, consulte Supressões de descoberta de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-authorizer.

AWS CLI

Para criar um autorizador personalizado

O exemplo create-authorizer a seguir cria um autorizador personalizado que usa a função do Lambda especificada como parte de um serviço de autenticação personalizado.

   aws iot create-authorizer \
       --authorizer-name "CustomAuthorizer" \
       --authorizer-function-arn "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction" \
       --token-key-name "MyAuthToken" \
       --status ACTIVE \
       --token-signing-public-keys FIRST_KEY="-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo
Z+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y
ZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p
zwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ
+GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx
50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1
lQIDAQAB
-----END PUBLIC KEY-----"

Saída:

{
    "authorizerName": "CustomAuthorizer",
    "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2"
}

Para obter mais informações, consulte CreateAuthorizer no Guia de referência da API do AWS IoT.

  • Para ver detalhes da API, consulte CreateAuthorizer na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-billing-group.

AWS CLI

Para criar um grupo de cobrança

O exemplo create-billing-group a seguir cria um grupo de cobrança simples chamado GroupOne.

aws iot create-billing-group \
    --billing-group-name GroupOne

Saída:

{
    "billingGroupName": "GroupOne",
    "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne",
    "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562"
}

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CreateBillingGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-certificate-from-csr.

AWS CLI

Para criar um certificado de dispositivo a partir de uma solicitação de assinatura de certificado (CSR)

O exemplo create-certificate-from-csr a seguir cria um certificado de dispositivo a partir de uma CSR. É possível usar o comando openssl para criar um CSR.

aws iot create-certificate-from-csr \
    --certificate-signing-request=file://certificate.csr

Saída:

{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9",
        "certificateId": "c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9",
        "certificatePem": "<certificate-text>"
}

Para obter mais informações, consulte CreateCertificateFromCSR no Guia de referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar create-custom-metric.

AWS CLI

Para criar uma métrica personalizada publicada por seus dispositivos no Device Defender

O exemplo create-custom-metric a seguir cria uma métrica personalizada que mede a porcentagem da bateria.

aws iot create-custom-metric \
    --metric-name "batteryPercentage" \
    --metric-type "number" \
    --display-name "Remaining battery percentage." \
    --region us-east-1 \
    --client-request-token "02ccb92b-33e8-4dfa-a0c1-35b181ed26b0"

Saída:

{
    "metricName": "batteryPercentage",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage"
}

Para obter mais informações, consulte Métricas personalizadas no Guia do desenvolvedor do AWS IoT Core.

  • Para ver detalhes da API, consulte CreateCustomMetric na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-dimension.

AWS CLI

Para criar uma dimensão

O create-dimension a seguir cria uma dimensão com um único filtro de tópico chamado TopicFilterForAuthMessages.

aws iot create-dimension \
    --name TopicFilterForAuthMessages \
    --type TOPIC_FILTER \
    --string-values device/+/auth

Saída:

{
    "name": "TopicFilterForAuthMessages",
    "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages"
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CreateDimension na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-domain-configuration.

AWS CLI

Para criar uma configuração de domínio

O exemplo create-domain-configuration a seguir cria uma configuração de domínio gerenciado pela AWS com um tipo de serviço de DATA.

aws iot create-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --service-type "DATA"

Saída:

{
    "domainConfigurationName": "additionalDataDomain",
    "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh"
}

Para obter mais informações, consulte Endpoints configuráveis no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-dynamic-thing-group.

AWS CLI

Para criar um grupo dinâmico de itens

O exemplo create-dynamic-thing-group a seguir cria um grupo dinâmico de itens que contém qualquer item com um atributo de temperatura maior que 60 graus. É necessário habilitar a indexação da frota do AWS IoT antes de poder usar grupos dinâmicos de itens.

aws iot create-dynamic-thing-group \
    --thing-group-name "RoomTooWarm" \
    --query-string "attributes.temperature>60"

Saída:

{
    "thingGroupName": "RoomTooWarm",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/RoomTooWarm",
    "thingGroupId": "9d52492a-fc87-43f4-b6e2-e571d2ffcad1",
    "indexName": "AWS_Things",
    "queryString": "attributes.temperature>60",
    "queryVersion": "2017-09-30"
}

Para obter mais informações, consulte Grupos dinâmicos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-job.

AWS CLI

Exemplo 1: criar um trabalho

O exemplo create-job a seguir cria um trabalho simples do AWS IoT que envia um documento JSON para o dispositivo MyRaspberryPi.

aws iot create-job \
    --job-id "example-job-01" \
    --targets "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" \
    --document file://example-job.json \
    --description "example job test" \
    --target-selection SNAPSHOT

Saída:

{
    "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01",
    "jobId": "example-job-01",
    "description": "example job test"
}

Exemplo 2: criar um trabalho contínuo

O exemplo create-job a seguir cria um trabalho que continua sendo executado depois que os itens especificados como destinos concluírem o trabalho. Neste exemplo, o destino é um grupo de itens, portanto, quando novos dispositivos são adicionados ao grupo, o trabalho contínuo é executado nesses itens novos.

aws iot create-job --job-id "example-job-04" --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" --document file://example-job.json --description "example continuous job" --target-selection CONTINUOUS

Saída:

{
    "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04",
    "jobId": "example-job-04",
    "description": "example continuous job"
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte CreateJob na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-keys-and-certificate.

AWS CLI

Para criar um par de chaves RSA e emitir um certificado X.509

O create-keys-and-certificate a seguir cria um par de chaves RSA de 2048 bits e emite um certificado X.509 usando a chave pública emitida. Como essa é a única vez que o AWS IoT fornece a chave privada para esse certificado, certifique-se de mantê-lo em um local seguro.

aws iot create-keys-and-certificate \
    --certificate-pem-outfile "myTest.cert.pem" \
    --public-key-outfile "myTest.public.key" \
    --private-key-outfile "myTest.private.key"

Saída:

{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2",
    "certificateId": "9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2",
    "certificatePem": "
-----BEGIN CERTIFICATE-----
MIICiTCCEXAMPLE6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBAgEXAMPLEAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSEXAMPLE2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYEXAMPLEb20wHhcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCEXAMPLEJBgNVBAgTAldBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDAEXAMPLEsTC0lBTSBDb25z
b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEXAMPLE25lQGFt
YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+aEXAMPLE
EXAMPLEfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZEXAMPLELG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE
Ibb3OhjZnzcvQAEXAMPLEWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4
nUhVVxYUntneD9+h8Mg9qEXAMPLEyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----\n",
    "keyPair": {
        "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkEXAMPLEQEFAAOCAQ8AMIIBCgKCAQEAEXAMPLE1nnyJwKSMHw4h\nMMEXAMPLEuuN/dMAS3fyce8DW/4+EXAMPLEyjmoF/YVF/gHr99VEEXAMPLE5VF13\n59VK7cEXAMPLE67GK+y+jikqXOgHh/xJTwo+sGpWEXAMPLEDz18xOd2ka4tCzuWEXAMPLEahJbYkCPUBSU8opVkR7qkEXAMPLE1DR6sx2HocliOOLtu6Fkw91swQWEXAMPLE\GB3ZPrNh0PzQYvjUStZeccyNCx2EXAMPLEvp9mQOUXP6plfgxwKRX2fEXAMPLEDa\nhJLXkX3rHU2xbxJSq7D+XEXAMPLEcw+LyFhI5mgFRl88eGdsAEXAMPLElnI9EesG\nFQIDAQAB\n-----END PUBLIC KEY-----\n",
        "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nkey omittted for security reasons\n-----END RSA PRIVATE KEY-----\n"
    }
}

Para obter mais informações, consulte Criar e registrar um AWS IoT Device Certificate no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-mitigation-action.

AWS CLI

Para criar ações de mitigação

O exemplo create-mitigation-action a seguir define uma ação de mitigação chamada AddThingsToQuarantineGroup1Action que, quando aplicada, move os itens para o grupo de itens chamado QuarantineGroup1. Essa ação substitui grupos dinâmicos de itens.

aws iot create-mitigation-action --cli-input-json file::params.json

Conteúdo de params.json:

{
    "actionName": "AddThingsToQuarantineGroup1Action",
    "actionParams": {
        "addThingsToThingGroupParams": {
            "thingGroupNames": [
                "QuarantineGroup1"
            ],
            "overrideDynamicGroups": true
        }
    },
    "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole"
}

Saída:

{
    "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroup1Action",
    "actionId": "992e9a63-a899-439a-aa50-4e20c52367e1"
}

Para obter mais informações, consulte CreateMitigationAction (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-ota-update.

AWS CLI

Para criar uma atualização OTA para uso com o Amazon FreeRTOS

O exemplo create-ota-update a seguir cria um OTAUpdate do AWS IoT em um grupo ou grupo de itens alvo. Isso faz parte de uma atualização over-the-air do Amazon FreeRTOS que possibilita a implantação de novas imagens de firmware em um único dispositivo ou em um grupo de dispositivos.

aws iot create-ota-update \
    --cli-input-json file://create-ota-update.json

Conteúdo de create-ota-update.json:

{
    "otaUpdateId": "ota12345",
    "description": "A critical update needed right away.",
    "targets": [
        "device1",
        "device2",
        "device3",
        "device4"
    ],
    "targetSelection": "SNAPSHOT",
    "awsJobExecutionsRolloutConfig": {
        "maximumPerMinute": 10
    },
    "files": [
        {
          "fileName": "firmware.bin",
          "fileLocation": {
            "stream": {
              "streamId": "004",
              "fileId":123
            }
          },
          "codeSigning": {
            "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6"
          }
        }
    ]
    "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role"
}

Saída:

{
     "otaUpdateId": "ota12345",
     "awsIotJobId": "job54321",
     "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate",
     "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/itsajob",
     "otaUpdateStatus": "CREATE_IN_PROGRESS"
}

Para obter mais informações, consulte CreateOTAUpdate no Guia de referência da API do AWS IoT.

  • Para ver detalhes da API, consulte CreateOtaUpdate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-policy-version.

AWS CLI

Para atualizar uma política com uma nova versão

O exemplo create-policy-version a seguir atualiza uma definição de política, criando uma nova versão da política. Esse exemplo também torna a nova versão padrão.

aws iot create-policy-version \
    --policy-name UpdateDeviceCertPolicy \
    --policy-document file://policy.json \
    --set-as-default

Conteúdo de policy.json:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action":  "iot:UpdateCertificate",
            "Resource": "*"
        }
    ]
}

Saída:

{
    "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy",
    "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\":  \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }",
    "policyVersionId": "2",
    "isDefaultVersion": true
}

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte CreatePolicyVersion na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-policy.

AWS CLI

Para criar uma política do AWS IoT

O exemplo create-policy a seguir cria uma política do AWS IoT chamada TemperatureSensorPolicy. O arquivo policy.json contém declarações que permitem ações da política do AWS IoT.

aws iot create-policy \
    --policy-name TemperatureSensorPolicy \
    --policy-document file://policy.json

Conteúdo de policy.json:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "iot:Publish",
                "iot:Receive"
            ],
            "Resource": [
                "arn:aws:iot:us-west-2:123456789012:topic/topic_1",
                "arn:aws:iot:us-west-2:123456789012:topic/topic_2"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "iot:Subscribe"
            ],
            "Resource": [
                "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1",
                "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "iot:Connect"
            ],
            "Resource": [
                "arn:aws:iot:us-west-2:123456789012:client/basicPubSub"
            ]
        }
    ]
}

Saída:

{
    "policyName": "TemperatureSensorPolicy",
    "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy",
    "policyDocument": "{
        \"Version\": \"2012-10-17\",
        \"Statement\": [
            {
                \"Effect\": \"Allow\",
                \"Action\": [
                    \"iot:Publish\",
                    \"iot:Receive\"
                ],
                \"Resource\": [
                    \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\",
                    \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\"
                ]
            },
            {
                \"Effect\": \"Allow\",
                \"Action\": [
                    \"iot:Subscribe\"
                ],
                \"Resource\": [
                    \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\",
                    \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\"
                ]
            },
            {
                \"Effect\": \"Allow\",
                \"Action\": [
                    \"iot:Connect\"
                ],
                \"Resource\": [
                    \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\"
                ]
            }
        ]
    }",
    "policyVersionId": "1"
}

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte CreatePolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-provisioning-claim.

AWS CLI

Para criar uma declaração de provisionamento

O exemplo create-provisioning-claim a seguir cria uma declaração de provisionamento a partir de um modelo de provisionamento.

aws iot create-provisioning-claim \
    --template-name MyTestProvisioningTemplate

Saída:

{
    "certificateId": "78de02184b2ce80cf8fb709bda59e62b19fb83513590483eb0434589476ab09f",
    "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDdzCCAl+gAwIBAgIUXSZhEBLztMLZ2fHG
14gV0NymYY0wDQYJKoZIhvcNAQEL\nBQAwfjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBg
VBAcM\nB1NlYXR0bGUxGDAWBgNVBAoMD0FtYXpvbi5jb20gSW5jLjEgMB4GA1UECwwXQW1h\nem9uIElvVCBQcm9
2aXNpb25pbmcxDDAKBgNVBAUTAzEuMDAeFw0yMDA3MjgxNjQ0\nMDZaFw0yMDA3MjgxNjUxMDZaMEsxSTBHBgNVB
AMMQDFhNDEyM2VkNmIxYjU3MzE3\nZTgzMTJmY2MzN2FiNTdhY2MzYTZkZGVjOGQ5OGY3NzUwMWRlMjc0YjhmYTQ
xN2Iw\nggEiMA0GCSqGSIb3EXAMPLEAA4IBDwAwggEKAoIBAQDBhKI94ktKLqTwnj+ayOq1\nTAJt/N6s6IJDZvl
rYjkC0E7wzaeY3TprWk03S29vUzVuEOXHXQXZbihgpg2m6fza\nkWm9/wpjzE9ny5+xkPGVH4Wnwz7yK5m8S0agL
T96cRBSWnWmonOWdY0GKVzni0CA\n+iyGudgrFKm7Eae/v18oXrf82KtOAGO4xG0KE2WKYHsT1fx3c9xZhlXP/eX
Lhv00\n+lGp0WVw9PbhKfrxliKJ5q6sL5nVUaUHq6hlQPYwsATeOvAp3u0ak5zgTyL0fg7Y\nPyKk6VYwLW62r+V
YBSForEMOAhkq3LsP/rjxpEKmi2W4lPVS6oFZRKcD+H1Kyil5\nAgMBAAGjIDAeMAwGA1UdEwEB/wQCMAAwDgYDV
R0PAQH/BAQDAgeAMA0GCSqGSIb3\nDQEBCwUAA4IBAQAGgix2k6nVqbZFKq97/fZBzLGS0dyz5rT/E41cDIRX+1j
EPW41\nw0D+2sXheCZLZZnSkvIiP74IToNeXDrjdcaodeGFVHIElRjhMIq+4ZebPbRLtidF\nRc2hfcTAlqq9Z6v
5Vk6BeM1tu0RqH1wPoVUccLPya8EjNCbnJZUmGdOfrN/Y9pho\n5ikV+HPeZhG/k6dhE2GsQJyKFVHL/uBgKSily
1bRyWU1r6qcpWBNBHjUoD7HgOwD\nnzMh4XRb2FQDsqFalkCSYmeL8IVC49sgPD9Otyp5uteGMTy62usAAUQdq/f
ZvrWg\nOkFpwMVnGKVKT7Kg0kKOLzKWOBB2Jm4/gmrJ\n-----END CERTIFICATE-----\n",
    "keyPair": {
        "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCg
KCAQEAwYSiPeJLSi6k8J4/msjq\ntUwCbfzerOiCQ2b5a2I5AtBO8M2nmN06a1pNN0tvb1M1bhDlx10F2W4oYKYN
pun8\n2pFpvf8KY8xPZ8ufsZDxlR+Fp8M+8iuZvEtGoC0/enEQUlp1pqJzlnWNBilc54tA\ngPoshrnYKxSpuxGn
v79fKF63/NirTgBjuMRtChNlimEXAMPLE3PcWYZVz/3ly4b9\nNPpRqdFlcPT24Sn68ZYiieaurC+Z1VGlB6uoZU
D2MLAE3jrwKd7tGpOc4E8i9H4O\n2D8ipOlWMC1utq/lWAUhaKxDDgIZKty7D/648aRCpotluJT1UuqBWUSnA/h9
Ssop\neQIDAQAB\n-----END PUBLIC KEY-----\n",
        "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwYSiPeJLSi6k8J4/
msjqtUwCbfzerOiCQ2b5a2I5AtBO8M2n\nmN06a1pNN0tvb1M1bhDlx10F2W4oYKYNpun82pFpvf8KY8xPZ8ufsZ
DxlR+Fp8M+\n8iuZvEtGoC0/enEQUlp1pqJzlnWNBilc54tAgPoshrnYKxSpuxGnv79fKF63/Nir\nTgBjuMRtCh
NlimB7E9X8d3PcWYZVz/3ly4b9NPpRqdFlcPT24Sn68ZYiieaurC+Z\n1VGlB6uoZUD2MLAE3jrwKd7tGpOc4E8i
9H4O2D8ipOlWMC1utq/lWAUhaKxDDgIZ\nKty7D/648aRCpotluJT1UuqBWUSnA/h9SsopeQIDAQABAoIBAEAybN
QUtx9T2/nK\ntZT2pA4iugecxI4dz+DmT0XVXs5VJmrx/nBSq6ejXExEpSIMO4RY7LE3ZdJcnd56\nF7tQkkY7yR
VzfxHeXFU1krOIPuxWebNOrRoPZr+1RSer+wv2aBC525+88pVuR6tM\nm3pgkrR2ycCj9FdOUoQxdjHBHaM5PDmJ
9aSxCKdg3nReepeGwsR2TQA+m2vVxWk7\nou0+91eTOP+/QfP7P8ZjOIkO2XivlRcVDyN/E4QXPKuIkM/8vS8VK+
E9pATQ0MtB\n2lw8R/YU5AJd6jlEXAMPLEGU2UzRzInNWiLtkPPPqgqXXhxOf+mxByjcMalVJk0L\nhOG2ROUCgY
EA+ROcHNHy/XbsP7FihOhEh+6Q2QxQ2ncBUPYbBazrR8Hn+7SCICQK\nVyYfd8Ajfq3e7RsKVL5SlMBp7Slidxak
bIn28fKfPn62DaemGCIoyDgLpF+eUxBx\ngzbCiBZga8brfurza43UZjKZLpg3hq721+FeAiXi1Nma4Yr9YWEHEN
8CgYEAxuWt\npzdWWmsiFzfsAw0sy9ySDA/xr5WRWzJyAqUsjsks6rxNzWebpufnYHcmtW7pLdqM\nkboHwN2pXa
kmZvrk2nKkEMq5brBYGDXuxDe+V369Bianx8aZFyIsckA7OwXW1w1h\ngRC5rQ4XOgp3+Jmw7eAO8LRYDjaN846+
QbtO2KcCgYAWS0UL51bijQR0ZwI0dz27\nFQVuCAYsp748aurcRTACCj8jbnK/QbqTNlxWsaH7ssBjZKo2D5sAqY
BRtASWODab\naHXsDhVm2Jye+ESLoHMaCLoyCkT3ll8yqXIcEDStMO7fO1Ryag164EiJvSIrMfny\nNL/fXVjCSH
/udCxdzPt+7QKBgQC+LAD7rxdr4J9538hTqpc4XK9vxRbrMXEH55XH\nHbMa2xONZXpmeTgEQBukyohCVceyRhK9
i0e6irZTjVXghOeoTpC8VXkzcnzouTiQ\neFQQSGfnp7Ioe6UIz23715pKduzSNkMSKrG924ktv7CyDBF1gBQI5g
aDoHnddJBJ\nPRTIZQKBgA8MASXtTxQntRwXXzR92U0vAighiuRkB/mx9jQpUcK1qiqHbkAMqgNF\nPFCBYIUbFT
iYKKKeJNbyJQvjfsJCkAnaFJ+RnTxk0Q6Wjm20peJ/ii4QiDdnigoE\nvdlc5cFQewWb4/zqAtPdinkPlN94ileI
79XQdc7RlJ0jpgTimL+V\n-----END RSA PRIVATE KEY-----\n"
    },
    "expiration": 1595955066.0
}

Para obter mais informações, consulte Provisionamento por usuário confiável no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar create-provisioning-template-version.

AWS CLI

Para criar uma versão de um modelo de provisionamento

O exemplo a seguir cria uma versão para o modelo de provisionamento especificado. O corpo da nova versão é fornecido no arquivo template.json.

aws iot create-provisioning-template-version \
    --template-name widget-template \
    --template-body file://template.json

Conteúdo de template.json:

{
    "Parameters" : {
        "DeviceLocation": {
            "Type": "String"
        }
    },
    "Mappings": {
        "LocationTable": {
            "Seattle": {
                "LocationUrl": "https://example.aws"
            }
        }
    },
    "Resources" : {
        "thing" : {
            "Type" : "AWS::IoT::Thing",
            "Properties" : {
                "AttributePayload" : {
                    "version" : "v1",
                    "serialNumber" : "serialNumber"
                },
                "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]},
                "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]},
                "ThingGroups" : ["widgets", "WA"],
                "BillingGroup": "BillingGroup"
            },
            "OverrideSettings" : {
                "AttributePayload" : "MERGE",
                "ThingTypeName" : "REPLACE",
                "ThingGroups" : "DO_NOTHING"
            }
        },
        "certificate" : {
            "Type" : "AWS::IoT::Certificate",
            "Properties" : {
                "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"},
                "Status" : "Active"
            }
        },
        "policy" : {
            "Type" : "AWS::IoT::Policy",
            "Properties" : {
                "PolicyDocument" : {
                    "Version": "2012-10-17",
                    "Statement": [{
                        "Effect": "Allow",
                        "Action":["iot:Publish"],
                        "Resource": ["arn:aws:iot:us-east-1:123456789012:topic/foo/bar"]
                    }]
                }
            }
        }
    },
    "DeviceConfiguration": {
        "FallbackUrl": "https://www.example.com/test-site",
        "LocationUrl": {
            "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]}
        }
    }
}

Saída:

{
    "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template",
    "templateName": "widget-template",
    "versionId": 2,
    "isDefaultVersion": false
}

Para obter mais informações, consulte AWS IoT Secure Tunneling no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar create-provisioning-template.

AWS CLI

Para criar um modelo de provisionamento

O exemplo create-provisioning-template a seguir cria um modelo de provisionamento conforme definido pelo arquivo template.json.

aws iot create-provisioning-template \
    --template-name widget-template \
    --description "A provisioning template for widgets" \
    --provisioning-role-arn arn:aws:iam::123456789012:role/Provision_role \
    --template-body file://template.json

Conteúdo de template.json:

{
    "Parameters" : {
        "DeviceLocation": {
            "Type": "String"
        }
    },
    "Mappings": {
        "LocationTable": {
            "Seattle": {
                "LocationUrl": "https://example.aws"
            }
        }
    },
    "Resources" : {
        "thing" : {
            "Type" : "AWS::IoT::Thing",
            "Properties" : {
                "AttributePayload" : {
                    "version" : "v1",
                    "serialNumber" : "serialNumber"
                },
                "ThingName" : {"Fn::Join":["",["ThingPrefix_",{"Ref":"SerialNumber"}]]},
                "ThingTypeName" : {"Fn::Join":["",["ThingTypePrefix_",{"Ref":"SerialNumber"}]]},
                "ThingGroups" : ["widgets", "WA"],
                "BillingGroup": "BillingGroup"
            },
            "OverrideSettings" : {
                "AttributePayload" : "MERGE",
                "ThingTypeName" : "REPLACE",
                "ThingGroups" : "DO_NOTHING"
            }
        },
        "certificate" : {
            "Type" : "AWS::IoT::Certificate",
            "Properties" : {
                "CertificateId": {"Ref": "AWS::IoT::Certificate::Id"},
                "Status" : "Active"
            }
        },
        "policy" : {
            "Type" : "AWS::IoT::Policy",
            "Properties" : {
                "PolicyDocument" : {
                    "Version": "2012-10-17",
                    "Statement": [{
                        "Effect": "Allow",
                        "Action":["iot:Publish"],
                        "Resource": ["arn:aws:iot:us-east-1:504350838278:topic/foo/bar"]
                    }]
                }
            }
        }
    },
    "DeviceConfiguration": {
        "FallbackUrl": "https://www.example.com/test-site",
        "LocationUrl": {
            "Fn::FindInMap": ["LocationTable",{"Ref": "DeviceLocation"}, "LocationUrl"]}
        }
    }
}

Saída:

{
    "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template",
    "templateName": "widget-template",
    "defaultVersionId": 1
}

Para obter mais informações, consulte AWS IoT Secure Tunneling no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar create-role-alias.

AWS CLI

Para criar um alias de perfil

O exemplo create-role-alias a seguir cria um alias de perfil chamado LightBulbRole para o perfil especificado.

aws iot create-role-alias \
    --role-alias LightBulbRole \
    --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001

Saída:

{
    "roleAlias": "LightBulbRole",
    "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole"
}

Para obter mais informações, consulte CreateRoleAlias no Guia de referência da API do AWS IoT.

  • Para ver detalhes da API, consulte CreateRoleAlias na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-scheduled-audit.

AWS CLI

Para criar uma auditoria agendada

O exemplo create-scheduled-audit a seguir cria uma auditoria agendada que é executada semanalmente, na quarta-feira, para verificar se os certificados da CA ou os certificados do dispositivo estão prestes a expirar.

aws iot create-scheduled-audit \
    --scheduled-audit-name WednesdayCertCheck \
    --frequency WEEKLY \
    --day-of-week WED \
    --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK

Saída:

{
    "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck"
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-security-profile.

AWS CLI

Para criar um perfil de segurança

O exemplo create-security-profile a seguir cria um perfil de segurança que verifica se a largura de banda celular excede um limite ou se mais de 10 falhas de autorização ocorrem em um período de cinco minutos.

aws iot create-security-profile \
    --security-profile-name PossibleIssue \
    --security-profile-description "Check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128"  \
    --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":10},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"

Saída:

{
    "securityProfileName": "PossibleIssue",
    "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue"
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-stream.

AWS CLI

Para criar um fluxo para fornecer um ou mais arquivos grandes em blocos por meio do MQTT

O exemplo create-stream a seguir cria um fluxo para fornecer um ou mais arquivos grandes em blocos por meio do MQTT. Um fluxo transporta bytes de dados em blocos ou blocos empacotados como mensagens MQTT de uma origem, como o S3. Você pode ter um ou mais arquivos associados a um fluxo.

aws iot create-stream \
    --cli-input-json file://create-stream.json

Conteúdo de create-stream.json:

{
    "streamId": "stream12345",
    "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
    "files": [
        {
            "fileId": 123,
            "s3Location": {
                "bucket":"codesign-ota-bucket",
                "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6"
            }
        }
    ],
    "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role"
}

Saída:

{
     "streamId": "stream12345",
     "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345",
     "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
     "streamVersion": "1"
}

Para obter mais informações, consulte CreateStream no Guia de referência da API do AWS IoT.

  • Para obter detalhes da API, consulte CreateStream na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-thing-group.

AWS CLI

Exemplo 1: criar um grupo de itens

O exemplo create-thing-group a seguir cria um grupo de itens chamado LightBulbs com uma descrição e dois atributos.

aws iot create-thing-group \
    --thing-group-name LightBulbs \
    --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"

Saída:

{
    "thingGroupName": "LightBulbs",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs",
    "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331"
}

Exemplo 2: criar um grupo de itens que faça parte de um grupo pai

O seguinte create-thing-group cria um grupo de itens chamado HalogenBulbs que tem um grupo de itens pai chamado LightBulbs.

aws iot create-thing-group \
    --thing-group-name HalogenBulbs \
    --parent-group-name LightBulbs

Saída:

{
    "thingGroupName": "HalogenBulbs",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs",
    "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e"
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CreateThingGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-thing-type.

AWS CLI

Como definir um tipo de item

O exemplo create-thing-type a seguir define um tipo de item os e atributos associados.

aws iot create-thing-type \
    --thing-type-name "LightBulb" \
    --thing-type-properties "thingTypeDescription=light bulb type, searchableAttributes=wattage,model"

Saída:

{
    "thingTypeName": "LightBulb",
    "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb",
    "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190"
}

Para obter mais informações, consulte Tipos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CreateThingType na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-thing.

AWS CLI

Exemplo 1: criar um registro de item no registro

O exemplo create-thing a seguir cria uma entrada para um dispositivo no registro de itens do AWS IoT.

aws iot create-thing \
    --thing-name SampleIoTThing

Saída:

{
    "thingName": "SampleIoTThing",
    "thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing",
    "thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE "
}

Exemplo 2: definir um item associado a um tipo de item

O exemplo create-thing a seguir cria um item com o tipo de item e seus atributos especificados.

aws iot create-thing \
    --thing-name "MyLightBulb" \
    --thing-type-name "LightBulb" \
    --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}"

Saída:

{
    "thingName": "MyLightBulb",
    "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
    "thingId": "40da2e73-c6af-406e-b415-15acae538797"
}

Para obter mais informações, consulte Como gerenciar itens com o registro e Tipos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CreateThing na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-topic-rule-destination.

AWS CLI

Para criar um destino da regra de tópico

O exemplo create-topic-rule-destination a seguir cria um destino de regra de tópico para um endpoint HTTP.

aws iot create-topic-rule-destination \
    --destination-configuration httpUrlConfiguration={confirmationUrl=https://example.com}

Saída:

{
    "topicRuleDestination": {
        "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "status": "IN_PROGRESS",
        "statusReason": "Awaiting confirmation. Confirmation message sent on 2020-07-09T22:47:54.154Z; no response received from the endpoint.",
        "httpUrlProperties": {
            "confirmationUrl": "https://example.com"
        }
    }
}

Para obter mais informações, consulte Criar um destino de regra de tópico no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar create-topic-rule.

AWS CLI

Para criar uma regra que envie um alerta do Amazon SNS

O exemplo create-topic-rule a seguir cria uma regra que envia uma mensagem do Amazon SNS quando as leituras do nível de umidade do solo, encontradas em uma sombra do dispositivo, estão baixas.

aws iot create-topic-rule \
    --rule-name "LowMoistureRule" \
    --topic-rule-payload file://plant-rule.json

O exemplo exige que o código JSON a seguir seja salvo em um arquivo chamado plant-rule.json:

{
    "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n",
    "description": "Sends an alert whenever soil moisture level readings are too low.",
    "ruleDisabled": false,
    "awsIotSqlVersion": "2016-03-23",
    "actions": [{
            "sns": {
                "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic",
                "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole",
                "messageFormat": "RAW"
            }
    }]
}

Este comando não produz saída.

Para obter mais informações, consulte Criar uma regra do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte CreateTopicRule na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-account-audit-configuration.

AWS CLI

Para desativar todas as verificações de auditoria da sua conta da AWS

O exemplo delete-account-audit-configuration a seguir restaura as configurações padrão do AWS IoT Device Defender para essa conta, desativando todas as verificações de auditoria e limpando os dados de configuração. Ele também exclui todas as auditorias agendadas para essa conta. Use esse comando com cuidado.

aws iot delete-account-audit-configuration \
    --delete-scheduled-audits

Este comando não produz saída.

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-audit-suppression.

AWS CLI

Para excluir uma supressão de descoberta de auditoria

O exemplo delete-audit-suppression a seguir exclui uma supressão de descoberta de auditoria para DEVICE_CERTIFICATE_EXPIRING_CHECK.

aws iot delete-audit-suppression \
    --check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \
    --resource-identifier deviceCertificateId="c7691e<shortened>"

Este comando não produz saída.

Para obter mais informações, consulte Supressões de descoberta de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-authorizer.

AWS CLI

Para excluir um autorizador personalizado

O delete-authorizer a seguir exclui o autorizador chamado CustomAuthorizer. É necessário que um autorizador personalizado esteja no estado INACTIVE antes que seja possível excluí-lo.

aws iot delete-authorizer \
    --authorizer-name CustomAuthorizer

Este comando não produz saída.

Para obter mais informações, consulte DeleteAuthorizer no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteAuthorizer na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-billing-group.

AWS CLI

Para excluir um grupo de cobrança

O exemplo delete-billing-group a seguir exclui o grupo de cobrança especificado. É possível excluir um grupo de cobrança mesmo que ele contenha um ou mais itens.

aws iot delete-billing-group \
    --billing-group-name BillingGroupTwo

Esse comando não produz nenhuma saída.

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteBillingGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-ca-certificate.

AWS CLI

Para excluir um certificado CA

O exemplo delete-ca-certificate a seguir exclui o certificado CA com o ID do certificado especificado.

aws iot delete-ca-certificate \
    --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467

Este comando não produz saída.

Para obter mais informações, consulte DeleteCACertificate na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte DeleteCaCertificate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-certificate.

AWS CLI

Para excluir um certificado de um dispositivo

O exemplo de delete-certificate a seguir exclui o certificado do dispositivo com o ID especificado.

aws iot delete-certificate \
    --certificate-id c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9

Este comando não produz saída.

Para obter mais informações, consulte DeleteCertificate na Referência da API do AWS IoT.

  • Para obter detalhes da API, consulte DeleteCertificate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-custom-metric.

AWS CLI

Para excluir uma métrica personalizada

O exemplo delete-custom-metric a seguir exclui uma métrica personalizada.

aws iot delete-custom-metric \
    --metric-name batteryPercentage \
    --region us-east-1

Saída:

HTTP 200

Para obter mais informações, consulte Métricas personalizadas no Guia do desenvolvedor do AWS IoT Core.

  • Para ver detalhes da API, consulte DeleteCustomMetric na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-dimension.

AWS CLI

Para excluir uma dimensão

O exemplo delete-dimension a seguir exclui uma dimensão chamada TopicFilterForAuthMessages.

aws iot delete-dimension \
    --name TopicFilterForAuthMessages

Este comando não produz saída.

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteDimension na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-domain-configuration.

AWS CLI

Para excluir uma configuração de domínio

O exemplo delete-domain-configuration a seguir exclui uma configuração de domínio chamada additionalDataDomain da sua conta da AWS.

aws iot delete-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --domain-configuration-status "OK"

Este comando não produz saída.

Para obter mais informações, consulte Endpoints configuráveis no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-dynamic-thing-group.

AWS CLI

Para excluir um grupo dinâmico de itens

O exemplo delete-dynamic-thing-group a seguir exclui o grupo dinâmico de itens especificado.

aws iot delete-dynamic-thing-group \
    --thing-group-name "RoomTooWarm"

Este comando não produz saída.

Para obter mais informações, consulte Grupos dinâmicos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-job-execution.

AWS CLI

Para excluir uma execução de trabalho

O exemplo delete-job-execution a seguir exclui a execução do trabalho especificado em um dispositivo. Use describe-job-execution para obter o número da execução.

aws iot delete-job-execution
    --job-id "example-job-02"
    --thing-name "MyRaspberryPi"
    --execution-number 1

Este comando não produz saída.

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteJobExecution na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-job.

AWS CLI

Para excluir um trabalho

O exemplo delete-job a seguir exclui o trabalho especificado. Ao especificar a opção --force, o trabalho é excluído mesmo que o status seja IN_PROGRESS.

aws iot delete-job \
    --job-id "example-job-04" \
    --force

Este comando não produz saída.

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte DeleteJob na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-mitigation-action.

AWS CLI

Para excluir uma ação de mitigação

O exemplo delete-mitigation-action a seguir exclui a ação de mitigação especificada.

aws iot delete-mitigation-action \
    --action-name AddThingsToQuarantineGroup1Action

Este comando não produz saída.

Para obter mais informações, consulte DeleteMitigationAction (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-ota-update.

AWS CLI

Para excluir uma atualização OTA

O exemplo delete-ota-update a seguir exclui a atualização OTA especificada.

aws iot delete-ota-update \
    --ota-update-id ota12345 \
    --delete-stream \
    --force-delete-aws-job

Este comando não produz saída.

Para obter mais informações, consulte DeleteOTAUpdate na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte DeleteOtaUpdate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-policy-version.

AWS CLI

Para excluir uma versão de uma política

O exemplo delete-policy-version a seguir exclui a versão 2 da política especificada da sua conta da AWS.

aws iot delete-policy-version \
    --policy-name UpdateDeviceCertPolicy \
    --policy-version-id 2

Este comando não produz saída.

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte DeletePolicyVersion na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-policy.

AWS CLI

Como excluir uma política

O exemplo delete-policy a seguir exclui a política especificada da sua conta da AWS.

aws iot delete-policy --policy-name UpdateDeviceCertPolicy

Este comando não produz saída.

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte DeletePolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-provisioning-template-version.

AWS CLI

Para excluir uma versão do modelo de provisionamento

O exemplo delete-provisioning-template-version a seguir excluir a versão 2 do modelo de provisionamento especificado.

aws iot delete-provisioning-template-version \
    --version-id 2 \
    --template-name "widget-template"

Este comando não produz saída.

Para obter mais informações, consulte AWS IoT Secure Tunneling no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar delete-provisioning-template.

AWS CLI

Para excluir um modelo de provisionamento

O exemplo delete-provisioning-template a seguir excluir o modelo de provisionamento especificado.

aws iot delete-provisioning-template \
    --template-name widget-template

Este comando não produz saída.

Para obter mais informações, consulte AWS IoT Secure Tunneling no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar delete-registration-code.

AWS CLI

Para excluir seu código de registro

O exemplo delete-registration-code a seguir exclui um código de registro específico para a conta do AWS IoT.

aws iot delete-registration-code

Este comando não produz saída.

Para obter mais informações, consulte Usar seu próprio certificado no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-role-alias.

AWS CLI

Para excluir um alias de perfil do AWS IoT

O exemplo delete-role-alias a seguir exclui um alias de perfil do AWS IoT chamado LightBulbRole.

aws iot delete-role-alias \
    --role-alias LightBulbRole

Este comando não produz saída.

Para obter mais informações, consulte Autorizar de chamadas diretas para serviços AWS no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteRoleAlias na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-scheduled-audit.

AWS CLI

Para excluir uma auditoria agendada

O exemplo delete-scheduled-audit a seguir exclui a auditoria agendada do AWS IoT Device Defender chamada AWSIoTDeviceDefenderDailyAudit.

aws iot delete-scheduled-audit \
    --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit

Este comando não produz saída.

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-security-profile.

AWS CLI

Para excluir um perfil de segurança

O exemplo delete-security-profile a seguir exclui um perfil de segurança chamado PossibleIssue.

aws iot delete-security-profile \
    --security-profile-name PossibleIssue

Este comando não produz saída.

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-stream.

AWS CLI

Para excluir um fluxo

O exemplo delete-stream a seguir exclui o fluxo especificado.

aws iot delete-stream \
    --stream-id stream12345

Este comando não produz saída.

Para obter mais informações, consulte DeleteStream na Referência da API do AWS IoT.

  • Para obter detalhes da API, consulte DeleteStream na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-thing-group.

AWS CLI

Para excluir um grupo de itens

O exemplo delete-thing-group a seguir exclui o grupo de itens especificado. Não é possível excluir um grupo de itens se ele contiver grupos-filho de itens.

aws iot delete-thing-group \
    --thing-group-name DefectiveBulbs

Este comando não produz saída.

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteThingGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-thing-type.

AWS CLI

Exemplo 1: excluir um tipo de item

O exemplo delete-thing-type a seguir exclui um tipo de item obsoleto.

aws iot delete-thing-type \
    --thing-type-name "obsoleteThingType"

Este comando não produz saída.

Para obter mais informações, consulte Tipos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteThingType na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-thing.

AWS CLI

Como exibir informações detalhadas sobre um item

O exemplo delete-thing a seguir exclui um item do registro do AWS IoT da sua conta da AWS.

aws iot delete-thing --thing-name "FourthBulb"

Este comando não produz saída.

Para acessar mais informações, consulte Como gerenciar objetos com o registro no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteThing na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-topic-rule-destination.

AWS CLI

Para excluir um destino de regra de tópico

O exemplo delete-topic-rule-destination a seguir exclui o destino de regra de tópico especificado.

aws iot delete-topic-rule-destination \
    --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"

Este comando não produz saída.

Para obter mais informações, consulte Excluir um destino de regra de tópico no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar delete-topic-rule.

AWS CLI

Para excluir uma regra

O exemplo de delete-topic-rule a seguir exclui a regra especificada.

aws iot delete-topic-rule \
    --rule-name "LowMoistureRule"

Este comando não produz saída.

Para obter mais informações, consulte Excluir uma regra no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeleteTopicRule na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-v2-logging-level.

AWS CLI

Para excluir o nível de log de um grupo de itens

O exemplo delete-v2-logging-level a seguir exclui o nível de log do grupo de itens especificado.

aws iot delete-v2-logging-level \
    --target-type THING_GROUP \
    --target-name LightBulbs

Este comando não produz saída.

O código de exemplo a seguir mostra como usar deprecate-thing-type.

AWS CLI

Exemplo 1: descontinuar um tipo de item

O exemplo deprecate-thing-type a seguir descontinua um tipo de item para que os usuários não possam associar novas itens a ele.

aws iot deprecate-thing-type \
    --thing-type-name "obsoleteThingType"

Este comando não produz saída.

Exemplo 2: reverter a descontinuação de um tipo de item

O exemplo deprecate-thing-type a seguir reverte a descontinuação de uso de um tipo de item, o que possibilita que os usuários voltem a associar novos itens a ele.

aws iot deprecate-thing-type \
    --thing-type-name "obsoleteThingType" \
    --undo-deprecate

Este comando não produz saída.

Para obter mais informações, consulte Tipos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DeprecateThingType na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-account-audit-configuration.

AWS CLI

Como visualizar as configurações de auditoria atuais

O exemplo describe-account-audit-configuration a seguir lista as configurações atuais da sua configuração de auditoria do AWS IoT Device Defender.

aws iot describe-account-audit-configuration

Saída:

{
    "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit_1551201085996",
    "auditNotificationTargetConfigurations": {
        "SNS": {
            "targetArn": "arn:aws:sns:us-west-2:123456789012:ddaudits",
            "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit",
            "enabled": true
        }
    },
    "auditCheckConfigurations": {
        "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": {
            "enabled": true
        },
        "CA_CERTIFICATE_EXPIRING_CHECK": {
            "enabled": true
        },
        "CONFLICTING_CLIENT_IDS_CHECK": {
            "enabled": true
        },
        "DEVICE_CERTIFICATE_EXPIRING_CHECK": {
            "enabled": true
        },
        "DEVICE_CERTIFICATE_SHARED_CHECK": {
            "enabled": true
        },
        "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": {
            "enabled": true
        },
        "LOGGING_DISABLED_CHECK": {
            "enabled": true
        },
        "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": {
            "enabled": true
        },
        "REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK": {
            "enabled": true
        },
        "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": {
            "enabled": true
        }
    }
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-audit-finding.

AWS CLI

Para listar detalhes de uma descoberta de auditoria

O exemplo describe-audit-finding a seguir lista os detalhes da descoberta de auditoria especificada do AWS IoT Device Defender. Uma auditoria pode produzir várias descobertas. Use o comando list-audit-findings para obter uma lista das descobertas de uma auditoria para obter o findingId.

aws iot describe-audit-finding \
    --finding-id "ef4826b8-e55a-44b9-b460-5c485355371b"

Saída:

{
    "finding": {
        "findingId": "ef4826b8-e55a-44b9-b460-5c485355371b",
        "taskId": "873ed69c74a9ec8fa9b8e88e9abc4661",
        "checkName": "IOT_POLICY_OVERLY_PERMISSIVE_CHECK",
        "taskStartTime": 1576012045.745,
        "findingTime": 1576012046.168,
        "severity": "CRITICAL",
        "nonCompliantResource": {
            "resourceType": "IOT_POLICY",
            "resourceIdentifier": {
                "policyVersionIdentifier": {
                    "policyName": "smp-ggrass-group_Core-policy",
                    "policyVersionId": "1"
                }
            }
         },
        "reasonForNonCompliance": "Policy allows broad access to IoT data plane actions: [iot:Subscribe, iot:Connect, iot:GetThingShadow, iot:DeleteThingShadow, iot:UpdateThingShadow, iot:Publish].",
        "reasonForNonComplianceCode": "ALLOWS_BROAD_ACCESS_TO_IOT_DATA_PLANE_ACTIONS"
    }
}

Para obter mais informações, consulte Verificar resultados de auditorias (Comandos de auditoria) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-audit-mitigation-actions-task.

AWS CLI

Como exibir os detalhes de uma tarefa de ações de mitigação de auditoria

O exemplo describe-audit-mitigation-actions-task a seguir exibe os detalhes da tarefa especificada, na qual a ResetPolicyVersionAction foi aplicada a uma descoberta. Os resultados incluem quando a tarefa começou e terminou, quantas descobertas foram direcionadas (e seu resultado) e a definição da ação que é aplicada como parte dessa tarefa.

aws iot describe-audit-mitigation-actions-task \
    --task-id ResetPolicyTask01

Saída:

{
    "taskStatus": "COMPLETED",
    "startTime": "2019-12-10T15:13:19.457000-08:00",
    "endTime": "2019-12-10T15:13:19.947000-08:00",
    "taskStatistics": {
        "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": {
            "totalFindingsCount": 1,
            "failedFindingsCount": 0,
            "succeededFindingsCount": 1,
            "skippedFindingsCount": 0,
            "canceledFindingsCount": 0
        }
    },
    "target": {
        "findingIds": [
            "ef4826b8-e55a-44b9-b460-5c485355371b"
        ]
    },
    "auditCheckToActionsMapping": {
        "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": [
            "ResetPolicyVersionAction"
        ]
    },
    "actionsDefinition": [
        {
            "name": "ResetPolicyVersionAction",
            "id": "1ea0b415-bef1-4a01-bd13-72fb63c59afb",
            "roleArn": "arn:aws:iam::123456789012:role/service-role/ReplacePolicyVersionRole",
            "actionParams": {
                "replaceDefaultPolicyVersionParams": {
                    "templateName": "BLANK_POLICY"
                }
            }
        }
    ]
}

Para obter mais informações, consulte DescribeAuditMitigationActionsTask (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-audit-suppression.

AWS CLI

Para excluir uma supressão de descoberta de auditoria

O exemplo describe-audit-suppression a seguir lista detalhes sobre a supressão de uma descoberta de auditoria.

aws iot describe-audit-task \
    --task-id "787ed873b69cb4d6cdbae6ddd06996c5"

Saída:

{
    "taskStatus": "COMPLETED",
    "taskType": "SCHEDULED_AUDIT_TASK",
    "taskStartTime": 1596168096.157,
    "taskStatistics": {
        "totalChecks": 1,
        "inProgressChecks": 0,
        "waitingForDataCollectionChecks": 0,
        "compliantChecks": 0,
        "nonCompliantChecks": 1,
        "failedChecks": 0,
        "canceledChecks": 0
    },
    "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit",
    "auditDetails": {
        "DEVICE_CERTIFICATE_EXPIRING_CHECK": {
            "checkRunStatus": "COMPLETED_NON_COMPLIANT",
            "checkCompliant": false,
            "totalResourcesCount": 195,
            "nonCompliantResourcesCount": 2
        }
    }
}

Para obter mais informações, consulte Supressões de descoberta de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-audit-task.

AWS CLI

Para obter informações sobre uma instância de auditoria

O exemplo describe-audit-task a seguir obtém informações sobre uma instância de uma auditoria do AWS IoT Device Defender. Se a auditoria for concluída, as estatísticas resumidas da execução serão incluídas nos resultados.

aws iot describe-audit-task \
    --task-id a3aea009955e501a31b764abe1bebd3d

Saída:

 {
    "taskStatus": "COMPLETED",
    "taskType": "ON_DEMAND_AUDIT_TASK",
    "taskStartTime": 1560356923.434,
    "taskStatistics": {
        "totalChecks": 3,
        "inProgressChecks": 0,
        "waitingForDataCollectionChecks": 0,
        "compliantChecks": 3,
        "nonCompliantChecks": 0,
        "failedChecks": 0,
        "canceledChecks": 0
    },
    "auditDetails": {
        "CA_CERTIFICATE_EXPIRING_CHECK": {
            "checkRunStatus": "COMPLETED_COMPLIANT",
            "checkCompliant": true,
            "totalResourcesCount": 0,
            "nonCompliantResourcesCount": 0
        },
        "DEVICE_CERTIFICATE_EXPIRING_CHECK": {
            "checkRunStatus": "COMPLETED_COMPLIANT",
            "checkCompliant": true,
            "totalResourcesCount": 6,
            "nonCompliantResourcesCount": 0
        },
        "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": {
            "checkRunStatus": "COMPLETED_COMPLIANT",
            "checkCompliant": true,
            "totalResourcesCount": 0,
            "nonCompliantResourcesCount": 0
        }
    }
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DescribeAuditTask na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-authorizer.

AWS CLI

Para obter informações sobre um autorizador personalizado

O exemplo describe-authorizer a seguir exibe os detalhes do autorizador personalizado especificado.

aws iot describe-authorizer \
    --authorizer-name CustomAuthorizer

Saída:

{
    "authorizerDescription": {
        "authorizerName": "CustomAuthorizer",
        "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer",
        "authorizerFunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction",
        "tokenKeyName": "MyAuthToken",
        "tokenSigningPublicKeys": {
            "FIRST_KEY": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo\nZ+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y\nZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p\nzwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ\n+GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx\n50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1\nlQIDAQAB\n-----END PUBLIC KEY-----"
        },
        "status": "ACTIVE",
        "creationDate": 1571245658.069,
        "lastModifiedDate": 1571245658.069
    }
}

Para obter mais informações, consulte DescribeAuthorizer na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte DescribeAuthorizer na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-billing-group.

AWS CLI

Para obter informações sobre um grupo de cobrança

O exemplo describe-billing-group a seguir obtém informações sobre o grupo de cobrança especificado.

aws iot describe-billing-group --billing-group-name GroupOne

Saída:

{
    "billingGroupName": "GroupOne",
    "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562",
    "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne",
    "version": 1,
    "billingGroupProperties": {},
    "billingGroupMetadata": {
        "creationDate": 1560199355.378
    }
}

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-ca-certificate.

AWS CLI

Para obter detalhes sobre um certificado CA

O exemplo describe-ca-certificate a seguir exibe os detalhes do certificado CA especificado.

aws iot describe-ca-certificate \
    --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467

Saída:

{
    "certificateDescription": {
        "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467",
        "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467",
        "status": "INACTIVE",
        "certificatePem": "-----BEGIN CERTIFICATE-----\nMIICzzCCAbegEXAMPLEJANVEPWXl8taPMA0GCSqGSIb3DQEBBQUAMB4xCzAJBgNV\nBAYTAlVTMQ8wDQYDVQQKDAZBbWF6b24wHhcNMTkwOTI0MjEzMTE1WhcNMjkwOTIx\nMjEzMTE1WjAeMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGQW1hem9uMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzd3R3ioalCS0MhFWfBrVGR036EK07UAf\nVdz9EXAMPLE1VczICbADnATK522kEIB51/18VzlFtAhQL5V5eybXKnB7QebNer5m\n4Yibx7shR5oqNzFsrXWxuugN5+w5gEfqNMawOjhF4LsculKG49yuqjcDU19/13ua\n3B2gxs1Pe7TiWWvUskzxnbO1F2WCshbEJvqY8fIWtGYCjTeJAgQ9hvZx/69XhKen\nwV9LJwOQxrsUS0Ty8IHwbB8fRy72VM3u7fJoaU+nO4jD5cqaoEPtzoeFUEXAMPLE\nyVAJpqHwgbYbcUfn7V+AB6yh1+0Fa1rEQGuZDPGyJslxwr5vh8nRewIDAQABoxAw\nDjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQA+3a5CV3IJgOnd0AgI\nBgVMtmYzTvqAngx26aG9/spvCjXckh2SBF+EcBlCFwH1yakwjJL1dR4yarnrfxgI\nEqP4AOYVimAVoQ5FBwnloHe16+3qtDiblU9DeXBUCtS55EcfrEXAMPLEYtXdqU5C\nU9ia4KAjV0dxW1+EFYMwX5eGeb0gDTNHBylV6B/fOSZiQAwDYp4x3B+gAP+a/bWB\nu1umOqtBdWe6L6/83L+JhaTByqV25iVJ4c/UZUnG8926wUlDM9zQvEXuEVvzZ7+m\n4PSNqst/nVOvnLpoG4e0WgcJgANuB33CSWtjWSuYsbhmqQRknGhREXAMPLEZT4fm\nfo0e\n-----END CERTIFICATE-----\n",
        "ownedBy": "123456789012",
        "creationDate": 1569365372.053,
        "autoRegistrationStatus": "DISABLE",
        "lastModifiedDate": 1569365372.053,
        "customerVersion": 1,
        "generationId": "c5c2eb95-140b-4f49-9393-6aaac85b2a90",
        "validity": {
            "notBefore": 1569360675.0,
            "notAfter": 1884720675.0
        }
    }
}

Para obter mais informações, consulte DescribeCACertificate na Referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar describe-certificate.

AWS CLI

Para obter informações sobre um certificado

O exemplo describe-certificate a seguir exibe os detalhes do certificado especificado.

aws iot describe-certificate \
    --certificate-id "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e"

Saída:

{
    "certificateDescription": {
        "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e",
        "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e",
        "status": "ACTIVE",
        "certificatePem": "-----BEGIN CERTIFICATE-----
MIICiTEXAMPLEQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC
VVMxCzAJBgNVBEXAMPLEMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6
b24xFDASBgNVBAsTC0lBTSBDEXAMPLElMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd
BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5EXAMPLEcNMTEwNDI1MjA0NTIxWhcN
MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNEXAMPLEdBMRAwDgYD
VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBEXAMPLEz
b2xEXAMPLEYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt
YXpvbi5jb20wgZ8EXAMPLEZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ
21uUSfwfEvySWtC2XADZ4nB+BLYEXAMPLEpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T
rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7EXAMPLEGBzZswY6786m86gpE
Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFEXAMPLEAtCu4
nUhVVxYUnEXAMPLE8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb
FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb
NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=
-----END CERTIFICATE-----",
        "ownedBy": "123456789012",
        "creationDate": 1541022751.983,
        "lastModifiedDate": 1541022751.983,
        "customerVersion": 1,
        "transferData": {},
        "generationId": "6974fbed-2e61-4114-bc5e-4204cc79b045",
        "validity": {
            "notBefore": 1541022631.0,
            "notAfter": 2524607999.0
        }
    }
}

Para obter mais informações, consulte DescribeCertificate na Referência da API do AWS IoT.

  • Para obter detalhes da API, consulte DescribeCertificate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-custom-metric.

AWS CLI

Para obter informações sobre uma métrica personalizada do Device Defender

O exemplo describe-custom-metric a seguir obtém informações sobre uma métrica personalizada chamada myCustomMetric.

aws iot describe-custom-metric \
    --metric-name myCustomMetric

Saída:

{
    "metricName": "myCustomMetric",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/myCustomMetric",
    "metricType": "number",
    "displayName": "My custom metric",
    "creationDate": 2020-11-17T23:02:12.879000-09:00,
    "lastModifiedDate": 2020-11-17T23:02:12.879000-09:00
}

Para obter mais informações, consulte Métricas personalizadas no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar describe-default-authorizer.

AWS CLI

Para obter informações sobre o autorizador personalizado padrão

O exemplo describe-default-authorizer a seguir exibe os detalhes do autorizador personalizado padrão.

aws iot describe-default-authorizer

Saída:

{
    "authorizerName": "CustomAuthorizer",
    "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer"
}

Para obter mais informações, consulte DescribeDefaultAuthorizer na Referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar describe-dimension.

AWS CLI

Para obter informações sobre uma dimensão

O exemplo describe-dimension a seguir obtém informações sobre uma dimensão chamada TopicFilterForAuthMessages.

aws iot describe-dimension \
    --name TopicFilterForAuthMessages

Saída:

{
    "name": "TopicFilterForAuthMessages",
    "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages",
    "type": "TOPIC_FILTER",
    "stringValues": [
        "device/+/auth"
    ],
    "creationDate": 1578620223.255,
    "lastModifiedDate": 1578620223.255
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DescribeDimension na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-domain-configuration.

AWS CLI

Para descrever uma configuração de domínio

O exemplo describe-domain-configuration a seguir descreve os detalhes sobre a configuração de domínio especificada.

aws iot describe-domain-configuration \
    --domain-configuration-name "additionalDataDomain"

Saída:

{
    "domainConfigurationName": "additionalDataDomain",
    "domainConfigurationArn": "arn:aws:iot:us-east-1:758EXAMPLE143:domainconfiguration/additionalDataDomain/norpw",
    "domainName": "d055exampleed74y71zfd-ats.beta.us-east-1.iot.amazonaws.com",
    "serverCertificates": [],
    "domainConfigurationStatus": "ENABLED",
    "serviceType": "DATA",
    "domainType": "AWS_MANAGED",
    "lastStatusChangeDate": 1601923783.774
}

Para obter mais informações, consulte Endpoints configuráveis no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-endpoint.

AWS CLI

Exemplo 1: como obter o endpoint atual da AWS

O exemplo de describe-endpoint a seguir recupera o endpoint padrão da AWS ao qual todos os comandos são aplicados.

aws iot describe-endpoint

Saída:

{
    "endpointAddress": "abc123defghijk.iot.us-west-2.amazonaws.com"
}

Para obter mais informações, consulte DescribeEndpoint no Guia do desenvolvedor do AWS IoT.

Exemplo 2: como obter o endpoint do ATS

O exemplo de describe-endpoint a seguir recupera o endpoint do Amazon Trust Services (ATS).

aws iot describe-endpoint \
    --endpoint-type iot:Data-ATS

Saída:

{
    "endpointAddress": "abc123defghijk-ats.iot.us-west-2.amazonaws.com"
}

Para obter mais informações, consulte X.509 Certificates and AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte DescribeEndpoint na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-event-configurations.

AWS CLI

Como mostrar quais tipos de eventos são publicados

O exemplo describe-event-configurations a seguir lista a configuração que controla quais eventos são gerados quando um item é adicionado, atualizado ou excluído.

aws iot describe-event-configurations

Saída:

{
    "eventConfigurations": {
        "CA_CERTIFICATE": {
            "Enabled": false
        },
        "CERTIFICATE": {
            "Enabled": false
        },
        "JOB": {
            "Enabled": false
        },
        "JOB_EXECUTION": {
            "Enabled": false
        },
        "POLICY": {
            "Enabled": false
        },
        "THING": {
            "Enabled": false
        },
        "THING_GROUP": {
            "Enabled": false
        },
        "THING_GROUP_HIERARCHY": {
            "Enabled": false
        },
        "THING_GROUP_MEMBERSHIP": {
            "Enabled": false
        },
        "THING_TYPE": {
            "Enabled": false
        },
        "THING_TYPE_ASSOCIATION": {
            "Enabled": false
        }
    }
}

Para obter mais informações, consulte Mensagens de evento no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-index.

AWS CLI

Para recuperar o status atual do índice do item

O exemplo describe-index a seguir recupera o status atual do índice do item.

aws iot describe-index \
    --index-name "AWS_Things"

Saída:

{
    "indexName": "AWS_Things",
    "indexStatus": "ACTIVE",
    "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS"
}

Para obter mais informações, consulte Gerenciar indexações de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DescribeIndex na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-job-execution.

AWS CLI

Para obter detalhes de um trabalho em um dispositivo

O exemplo describe-job-execution a seguir obtém os detalhes de execução do trabalho especificado.

aws iot describe-job-execution \
    --job-id "example-job-01" \
    --thing-name "MyRaspberryPi"

Saída:

{
    "execution": {
        "jobId": "example-job-01",
        "status": "QUEUED",
        "statusDetails": {},
        "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi",
        "queuedAt": 1560787023.636,
        "lastUpdatedAt": 1560787023.636,
        "executionNumber": 1,
        "versionNumber": 1
    }
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-job.

AWS CLI

Para obter o status de um trabalho

O exemplo describe-job a seguir obtém o status detalhado do trabalho cujo ID é example-job-01.

aws iot describe-job \
    --job-id "example-job-01"

Saída:

{
    "job": {
        "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01",
        "jobId": "example-job-01",
        "targetSelection": "SNAPSHOT",
        "status": "IN_PROGRESS",
        "targets": [
            "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi"
        ],
        "description": "example job test",
        "presignedUrlConfig": {},
        "jobExecutionsRolloutConfig": {},
        "createdAt": 1560787022.733,
        "lastUpdatedAt": 1560787026.294,
        "jobProcessDetails": {
            "numberOfCanceledThings": 0,
            "numberOfSucceededThings": 0,
            "numberOfFailedThings": 0,
            "numberOfRejectedThings": 0,
            "numberOfQueuedThings": 1,
            "numberOfInProgressThings": 0,
            "numberOfRemovedThings": 0,
            "numberOfTimedOutThings": 0
        },
        "timeoutConfig": {}
    }
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte DescribeJob na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-mitigation-action.

AWS CLI

Como visualizar os detalhes de uma ação de mitigação definida

O exemplo describe-mitigation-action a seguir exibe os detalhes da ação de mitigação especificada.

aws iot describe-mitigation-action \
    --action-name AddThingsToQuarantineGroupAction

Saída:

{
    "actionName": "AddThingsToQuarantineGroupAction",
    "actionType": "ADD_THINGS_TO_THING_GROUP",
    "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
    "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa",
    "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole",
    "actionParams": {
        "addThingsToThingGroupParams": {
            "thingGroupNames": [
                "QuarantineGroup1"
            ],
            "overrideDynamicGroups": true
        }
    },
    "creationDate": "2019-12-10T11:09:35.999000-08:00",
    "lastModifiedDate": "2019-12-10T11:09:35.999000-08:00"
}

Para obter mais informações, consulte DescribeMitigationAction (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-provisioning-template-version.

AWS CLI

Para descrever uma versão do modelo de provisionamento

O exemplo describe-provisioning-template-version a seguir descreve uma versão do modelo de provisionamento.

aws iot describe-provisioning-template-version \
    --template-name MyTestProvisioningTemplate \
    --version-id 1

Saída:

{
    "versionId": 1,
    "creationDate": 1589308310.574,
    "templateBody": "{
        \"Parameters\":{
            \"SerialNumber\":{
                \"Type\":\"String\"
            },
            \"AWS::IoT::Certificate::Id\":{
                \"Type\":\"String\"
            }
        },
        \"Resources\":{
            \"certificate\":{
                \"Properties\":{
                    \"CertificateId\":{
                        \"Ref\":\"AWS::IoT::Certificate::Id\"
                    },
                    \"Status\":\"Active\"
                },
                \"Type\":\"AWS::IoT::Certificate\"
            },
            \"policy\":{
                \"Properties\":{
                    \"PolicyName\":\"MyIotPolicy\"
                },
                \"Type\":\"AWS::IoT::Policy\"
            },
            \"thing\":{
                \"OverrideSettings\":{
                    \"AttributePayload\":\"MERGE\",
                    \"ThingGroups\":\"DO_NOTHING\",
                    \"ThingTypeName\":\"REPLACE\"
                },
                \"Properties\":{
                    \"AttributePayload\":{},
                    \"ThingGroups\":[],
                    \"ThingName\":{
                        \"Fn::Join\":[
                            \"\",
                            [
                                \"DemoGroup_\",
                                {\"Ref\":\"SerialNumber\"}
                            ]
                        ]
                    },
                    \"ThingTypeName\":\"VirtualThings\"
                },
                \"Type\":\"AWS::IoT::Thing\"
            }
        }
    }",
    "isDefaultVersion": true
}

Para obter mais informações, consulte Provisionar itens que não têm certificados de dispositivo usando o provisionamento de frota no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar describe-provisioning-template.

AWS CLI

Para descrever um modelo de provisionamento

O exemplo describe-provisioning-template a seguir descreve um modelo de provisionamento.

aws iot describe-provisioning-template \
    --template-name MyTestProvisioningTemplate

Saída:

{
    "templateArn": "arn:aws:iot:us-west-2:57EXAMPLE833:provisioningtemplate/MyTestProvisioningTemplate",
    "templateName": "MyTestProvisioningTemplate",
    "creationDate": 1589308310.574,
    "lastModifiedDate": 1589308345.539,
    "defaultVersionId": 1,
    "templateBody": "{
        \"Parameters\":{
            \"SerialNumber\":{
                \"Type\":\"String\"
            },
            \"AWS::IoT::Certificate::Id\":{
                \"Type\":\"String\"
            }
        },
        \"Resources\":{
            \"certificate\":{
                \"Properties\":{
                    \"CertificateId\":{
                        \"Ref\":\"AWS::IoT::Certificate::Id\"
                    },
                    \"Status\":\"Active\"
                },
                \"Type\":\"AWS::IoT::Certificate\"
            },
            \"policy\":{
                \"Properties\":{
                    \"PolicyName\":\"MyIotPolicy\"
                },
                \"Type\":\"AWS::IoT::Policy\"
            },
            \"thing\":{
                \"OverrideSettings\":{
                    \"AttributePayload\":\"MERGE\",
                    \"ThingGroups\":\"DO_NOTHING\",
                    \"ThingTypeName\":\"REPLACE\"
                },
                \"Properties\":{
                    \"AttributePayload\":{},
                    \"ThingGroups\":[],
                    \"ThingName\":{
                        \"Fn::Join\":[
                            \"\",
                            [
                                \"DemoGroup_\",
                                {\"Ref\":\"SerialNumber\"}
                            ]
                        ]
                    },
                    \"ThingTypeName\":\"VirtualThings\"
                },
                \"Type\":\"AWS::IoT::Thing\"
            }
        }
    }",
    "enabled": true,
    "provisioningRoleArn": "arn:aws:iam::571032923833:role/service-role/IoT_access"
}

Para obter mais informações, consulte Provisionar itens que não têm certificados de dispositivo usando o provisionamento de frota no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar describe-role-alias.

AWS CLI

Para obter informações sobre um alias de perfil do AWS IoT

O exemplo describe-role-alias a seguir exibe os detalhes do alias de perfil especificado.

aws iot describe-role-alias \
    --role-alias LightBulbRole

Saída:

{
    "roleAliasDescription": {
        "roleAlias": "LightBulbRole",
        "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole",
        "roleArn": "arn:aws:iam::123456789012:role/light_bulb_role_001",
        "owner": "123456789012",
        "credentialDurationSeconds": 3600,
        "creationDate": 1570558643.221,
        "lastModifiedDate": 1570558643.221
    }
}

Para obter mais informações, consulte DescribeRoleAlias na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte DescribeRoleAlias na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-scheduled-audit.

AWS CLI

Para obter informações sobre uma auditoria programada

O exemplo describe-scheduled-audit a seguir obtém informações detalhadas sobre uma instância auditoria programada do AWS IoT Device Defender AWSIoTDeviceDefenderDailyAudit.

aws iot describe-scheduled-audit \
    --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit

Saída:

{
    "frequency": "DAILY",
    "targetCheckNames": [
        "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK",
        "CONFLICTING_CLIENT_IDS_CHECK",
        "DEVICE_CERTIFICATE_SHARED_CHECK",
        "IOT_POLICY_OVERLY_PERMISSIVE_CHECK",
        "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK",
        "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK"
    ],
    "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit",
    "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit"
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-security-profile.

AWS CLI

Para obter informações sobre um perfil de segurança

O exemplo describe-security-profile a seguir obtém informações sobre o perfil de segurança do AWS IoT Device Defender chamado PossibleIssue.

aws iot describe-security-profile \
    --security-profile-name PossibleIssue

Saída:

{
    "securityProfileName": "PossibleIssue",
    "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue",
    "securityProfileDescription": "check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128",
    "behaviors": [
        {
            "name": "CellularBandwidth",
            "metric": "aws:message-byte-size",
            "criteria": {
                "comparisonOperator": "greater-than",
                "value": {
                    "count": 128
                },
                "consecutiveDatapointsToAlarm": 1,
                "consecutiveDatapointsToClear": 1
            }
        },
        {
            "name": "Authorization",
            "metric": "aws:num-authorization-failures",
            "criteria": {
                "comparisonOperator": "greater-than",
                "value": {
                    "count": 10
                },
                "durationSeconds": 300,
                "consecutiveDatapointsToAlarm": 1,
                "consecutiveDatapointsToClear": 1
            }
        }
    ],
    "version": 1,
    "creationDate": 1560278102.528,
    "lastModifiedDate": 1560278102.528
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar describe-stream.

AWS CLI

Para obter informações sobre um fluxo

O exemplo describe-stream a seguir exibe os detalhes do fluxo especificado.

aws iot describe-stream \
    --stream-id stream12345

Saída:

{
    "streamInfo": {
        "streamId": "stream12345",
        "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345",
        "streamVersion": 1,
        "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
        "files": [
            {
                "fileId": "123",
                "s3Location": {
                    "bucket":"codesign-ota-bucket",
                    "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6"
                }
            }
        ],
        "createdAt": 1557863215.995,
        "lastUpdatedAt": 1557863215.995,
        "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role"
    }
}

Para obter mais informações, consulte DescribeStream na Referência da API do AWS IoT.

  • Para obter detalhes da API, consulte DescribeStream na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-thing-group.

AWS CLI

Para obter informações sobre um grupo de itens

O exemplo describe-thing-group a seguir obtém informações sobre o grupo de itens chamado HalogenBulbs.

aws iot describe-thing-group \
    --thing-group-name HalogenBulbs

Saída:

{
    "thingGroupName": "HalogenBulbs",
    "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs",
    "version": 1,
    "thingGroupProperties": {},
    "thingGroupMetadata": {
        "parentGroupName": "LightBulbs",
        "rootToParentThingGroups": [
            {
                "groupName": "LightBulbs",
                "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
            }
        ],
        "creationDate": 1559927609.897
    }
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DescribeThingGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-thing-type.

AWS CLI

Para obter informações sobre um tipo de item

O exemplo describe-thing-type a seguir exibe informações sobre o tipo de item especificado definido em sua conta da AWS.

aws iot describe-thing-type \
    --thing-type-name "LightBulb"

Saída:

{
    "thingTypeName": "LightBulb",
    "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190",
    "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb",
    "thingTypeProperties": {
        "thingTypeDescription": "light bulb type",
        "searchableAttributes": [
            "model",
            "wattage"
        ]
    },
    "thingTypeMetadata": {
        "deprecated": false,
        "creationDate": 1559772562.498
    }
}

Para obter mais informações, consulte Tipos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DescribeThingType na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-thing.

AWS CLI

Como exibir informações detalhadas sobre um item

O exemplo describe-thing a seguir exibe informações sobre um item (dispositivo) definido no registro do AWS IoT da sua conta da AWS.

aws iot describe-thing --thing-name "MyLightBulb"

Saída:

{
    "defaultClientId": "MyLightBulb",
    "thingName": "MyLightBulb",
    "thingId": "40da2e73-c6af-406e-b415-15acae538797",
    "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
    "thingTypeName": "LightBulb",
    "attributes": {
        "model": "123",
        "wattage": "75"
    },
    "version": 1
}

Para acessar mais informações, consulte Como gerenciar objetos com o registro no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DescribeThing na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar detach-policy.

AWS CLI

Exemplo 1: remover uma política do AWS IoT de um grupo de itens

O exemplo detach-policy a seguir remove a política especificada de um grupo de itens e, por extensão, de todos os itens desse grupo e de qualquer um de seus grupos-filho.

aws iot detach-policy \
    --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \
    --policy-name "MyFirstGroup_Core-policy"

Este comando não produz saída.

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

Exemplo 2: remover uma política do AWS IoT de um certificado de dispositivo

O exemplo detach-policy a seguir separa a política TemperatureSensorPolicy de um certificado de dispositivo identificado pelo ARN.

aws iot detach-policy \
    --policy-name TemperatureSensorPolicy \
    --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142

Este comando não produz saída.

  • Para obter detalhes da API, consulte.DetachPolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar detach-security-profile.

AWS CLI

Como desassociar um perfil de segurança de um alvo

O exemplo detach-security-profile a seguir remove a associação entre o perfil de segurança do AWS IoT Device Defender chamado Testprofile e o alvo de todos os dispositivos registrados.

aws iot detach-security-profile \
    --security-profile-name Testprofile \
    --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/registered-things"

Este comando não produz saída.

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar detach-thing-principal.

AWS CLI

Para remover um certificado/entidade principal de um item

O exemplo detach-thing-principal a seguir remove um certificado que representa uma entidade principal do item especificado.

aws iot detach-thing-principal \
    --thing-name "MyLightBulb" \
    --principal "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36"

Este comando não produz saída.

Para acessar mais informações, consulte Como gerenciar objetos com o registro no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar disable-topic-rule.

AWS CLI

Para desativar uma regra de tópico

O exemplo disable-topic-rule a seguir desabilita a regra de tópico especificada.

aws iot disable-topic-rule \
    --rule-name "MyPlantPiMoistureAlertRule"

Este comando não produz saída.

Para obter mais informações, consulte Visualizar suas regras no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte DisableTopicRule na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar enable-topic-rule.

AWS CLI

Como ativar uma regra de tópico

O exemplo enable-topic-rule a seguir ativa (ou reativa) a regra de tópico especificada.

aws iot enable-topic-rule \
    --rule-name "MyPlantPiMoistureAlertRule"

Este comando não produz saída.

Para obter mais informações, consulte Visualizar suas regras no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte EnableTopicRule na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-behavior-model-training-summaries.

AWS CLI

Para listar o status do modelo de treinamento do Perfil de segurança do ML Detect do Device Defender

O exemplo get-behavior-model-training-summaries a seguir lista o status do treinamento de modelo para os comportamentos configurados no Perfil de Segurança escolhido. Para cada comportamento, o nome, o status do modelo e a porcentagem de pontos de dados coletados são listados.

aws iot get-behavior-model-training-summaries \
    --security-profile-name MySecuirtyProfileName

Saída:

{
    "summaries": [
        {
            "securityProfileName": "MySecuirtyProfileName",
            "behaviorName": "Messages_sent_ML_behavior",
            "modelStatus": "PENDING_BUILD",
            "datapointsCollectionPercentage": 0.0
        },
        {
            "securityProfileName": "MySecuirtyProfileName",
            "behaviorName": "Messages_received_ML_behavior",
            "modelStatus": "PENDING_BUILD",
            "datapointsCollectionPercentage": 0.0
        },
        {
            "securityProfileName": "MySecuirtyProfileName",
            "behaviorName": "Authorization_failures_ML_behavior",
            "modelStatus": "PENDING_BUILD",
            "datapointsCollectionPercentage": 0.0
        },
        {
            "securityProfileName": "MySecuirtyProfileName",
            "behaviorName": "Message_size_ML_behavior",
            "modelStatus": "PENDING_BUILD",
            "datapointsCollectionPercentage": 0.0
        },
        {
            "securityProfileName": "MySecuirtyProfileName",
            "behaviorName": "Connection_attempts_ML_behavior",
            "modelStatus": "PENDING_BUILD",
            "datapointsCollectionPercentage": 0.0
        },
        {
            "securityProfileName": "MySPNoALerts",
            "behaviorName": "Disconnects_ML_behavior",
            "modelStatus": "PENDING_BUILD",
            "datapointsCollectionPercentage": 0.0
        }
    ]
}

Para obter mais informações, consulte GetBehaviorModelTrainingSummaries (Comandos do Detect) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar get-cardinality.

AWS CLI

Como retornar a contagem aproximada de valores exclusivos que correspondem à consulta

É possível usar o script de configuração a seguir para criar 10 itens representando 10 sensores de temperatura. Cada item novo tem 3 atributos.

# Bash script. If in other shells, type `bash` before running
Temperatures=(70 71 72 73 74 75 47 97 98 99)
Racks=(Rack1 Rack1 Rack2 Rack2 Rack3 Rack4 Rack5 Rack6 Rack6 Rack6)
IsNormal=(true true true true true true false false false false)
for ((i=0; i<10 ; i++))
do
  thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]},rackId=${Racks[i]},stateNormal=${IsNormal[i]}}")
  aws iot describe-thing --thing-name "TempSensor$i"
done

Exemplo de saída do script de configuração:

{
    "version": 1,
    "thingName": "TempSensor0",
    "defaultClientId": "TempSensor0",
    "attributes": {
        "rackId": "Rack1",
        "stateNormal": "true",
        "temperature": "70"
    },
    "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0",
    "thingId": "example1-90ab-cdef-fedc-ba987example"
}

O exemplo get-cardinality a seguir consulta os 10 sensores criados pelo script de configuração e retorna o número de racks que têm sensores de temperatura relatando valores de temperatura anormais. Se o valor da temperatura estiver abaixo de 60 ou acima de 80, o sensor de temperatura está em um estado anormal.

aws iot get-cardinality \
    --aggregation-field "attributes.rackId" \
    --query-string "thingName:TempSensor* AND attributes.stateNormal:false"

Saída:

{
    "cardinality": 2
}

Para obter mais informações, consulte Consultar dados agregados<https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html> no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetCardinality na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-effective-policies.

AWS CLI

Para listar as políticas que afetam um item

O exemplo get-effective-policies a seguir lista as políticas que afetam o item especificado, incluindo políticas anexadas a qualquer grupo ao qual ele pertença.

aws iot get-effective-policies \
    --thing-name TemperatureSensor-001 \
    --principal arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142

Saída:

{
    "effectivePolicies": [
        {
            "policyName": "TemperatureSensorPolicy",
            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy",
            "policyDocument": "{
                \"Version\": \"2012-10-17\",
                \"Statement\": [
                    {
                        \"Effect\": \"Allow\",
                        \"Action\": [
                            \"iot:Publish\",
                            \"iot:Receive\"
                        ],
                        \"Resource\": [
                            \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\",
                            \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\"
                        ]
                    },
                    {
                        \"Effect\": \"Allow\",
                        \"Action\": [
                            \"iot:Subscribe\"
                        ],
                        \"Resource\": [
                            \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\",
                            \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\"
                        ]
                    },
                    {
                        \"Effect\": \"Allow\",
                        \"Action\": [
                            \"iot:Connect\"
                        ],
                        \"Resource\": [
                            \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\"
                        ]
                    }
                ]
            }"
        }
    ]
}

Para obter mais informações, consulte Obter políticas que afetam um item no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar get-indexing-configuration.

AWS CLI

Para obter a configuração da indexação de itens

O exemplo get-indexing-configuration a seguir obtém os dados de configuração atuais para indexação de frotas do AWS IoT.

aws iot get-indexing-configuration

Saída:

{
    "thingIndexingConfiguration": {
        "thingIndexingMode": "OFF",
        "thingConnectivityIndexingMode": "OFF"
    },
    "thingGroupIndexingConfiguration": {
        "thingGroupIndexingMode": "OFF"
    }
}

Para obter mais informações, consulte Gerenciar indexações de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar get-job-document.

AWS CLI

Para recuperar o documento para um trabalho

O exemplo get-job-document a seguir exibe detalhes sobre o documento do trabalho cujo ID é example-job-01.

aws iot get-job-document \
    --job-id "example-job-01"

Saída:

{
    "document": "\n{\n    \"operation\":\"customJob\",\n    \"otherInfo\":\"someValue\"\n}\n"
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetJobDocument na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-logging-options.

AWS CLI

Para obter as opções de log

O exemplo get-logging-options a seguir mostra as opções de log atuais da sua conta da AWS.

aws iot get-logging-options

Saída:

{
    "roleArn": "arn:aws:iam::123456789012:role/service-role/iotLoggingRole",
    "logLevel": "ERROR"
}

Para obter mais informações, consulte o título no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetLoggingOptions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-ota-update.

AWS CLI

Para recuperar informações sobre uma Atualização OTA

O exemplo get-ota-update a seguir exibe os detalhes da Atualização OTA especificada.

aws iot get-ota-update \
    --ota-update-id ota12345

Saída:

{
    "otaUpdateInfo": {
        "otaUpdateId": "ota12345",
        "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate",
        "creationDate": 1557863215.995,
        "lastModifiedDate": 1557863215.995,
        "description": "A critical update needed right away.",
        "targets": [
           "device1",
           "device2",
           "device3",
           "device4"
        ],
        "targetSelection": "SNAPSHOT",
        "protocols": ["HTTP"],
        "awsJobExecutionsRolloutConfig": {
           "maximumPerMinute": 10
        },
        "otaUpdateFiles": [
            {
                "fileName": "firmware.bin",
                "fileLocation": {
                    "stream": {
                        "streamId": "004",
                        "fileId":123
                    }
                },
                "codeSigning": {
                    "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6"
                }
            }
        ],
        "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role"
        "otaUpdateStatus": "CREATE_COMPLETE",
        "awsIotJobId": "job54321",
        "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/job54321",
        "errorInfo": {
        }
    }
}

Para obter mais informações, consulte GetOTAUpdate na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte GetOtaUpdate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-percentiles.

AWS CLI

Como agrupar os valores agregados que correspondem à consulta em agrupamentos de percentil

É possível usar o script de configuração a seguir para criar 10 itens representando 10 sensores de temperatura. Cada item novo tem 1 atributo.

# Bash script. If in other shells, type `bash` before running
Temperatures=(70 71 72 73 74 75 47 97 98 99)
for ((i=0; i<10 ; i++))
do
    thing=$(aws iot create-thing --thing-name "TempSensor$i" --attribute-payload attributes="{temperature=${Temperatures[i]}}")
    aws iot describe-thing --thing-name "TempSensor$i"
done

Exemplo de saída do script de configuração:

{
    "version": 1,
    "thingName": "TempSensor0",
    "defaultClientId": "TempSensor0",
    "attributes": {
        "temperature": "70"
    },
    "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/TempSensor0",
    "thingId": "example1-90ab-cdef-fedc-ba987example"
}

O exemplo get-percentiles a seguir consulta os 10 sensores criados pelo script de configuração e retorna um valor para cada grupo de percentis especificado. O grupo de percentis "10" contém o valor de campo agregado que ocorre em aproximadamente 10 por cento dos valores que correspondem à consulta. Na saída a seguir, {"percent": 10.0, "value": 67.7} significa que aproximadamente 10,0% dos valores de temperatura estão abaixo de 67,7.

aws iot get-percentiles \
    --aggregation-field "attributes.temperature" \
    --query-string "thingName:TempSensor*" \
    --percents 10 25 50 75 90

Saída:

{
    "percentiles": [
        {
            "percent": 10.0,
            "value": 67.7
        },
        {
            "percent": 25.0,
            "value": 71.25
        },
        {
            "percent": 50.0,
            "value": 73.5
        },
        {
            "percent": 75.0,
            "value": 91.5
        },
        {
            "percent": 90.0,
            "value": 98.1
        }
    ]
}

Para obter mais informações, consulte Consultar dados agregados no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetPercentiles na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-policy-version.

AWS CLI

Para obter informações sobre uma versão específica de uma política

O exemplo get-policy-version a seguir obtém informações sobre a primeira versão da política especificada.

aws iot get-policy \
    --policy-name UpdateDeviceCertPolicy
    --policy-version-id "1"

Saída:

{
    "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy",
    "policyName": "UpdateDeviceCertPolicy",
    "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\":  \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }",
    "policyVersionId": "1",
    "isDefaultVersion": false,
    "creationDate": 1559925941.924,
    "lastModifiedDate": 1559926175.458,
    "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042"
}

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte GetPolicyVersion na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-policy.

AWS CLI

Para obter informações sobre uma versão padrão de uma política

O exemplo get-policy a seguir obtém informações sobre a versão padrão da política especificada.

aws iot get-policy \
    --policy-name UpdateDeviceCertPolicy

Saída:

{
    "policyName": "UpdateDeviceCertPolicy",
    "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy",
    "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\":  \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }",
    "defaultVersionId": "2",
    "creationDate": 1559925941.924,
    "lastModifiedDate": 1559925941.924,
    "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042"
}

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte GetPolicy na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-registration-code.

AWS CLI

Para obter o código de registro específico da sua conta da AWS

O exemplo get-registration-code a seguir recupera o código de registro específico para sua conta da AWS.

aws iot get-registration-code

Saída:

{
    "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c"
}

Para obter mais informações, consulte Usar seu próprio certificado no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetRegistrationCode na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-statistics.

AWS CLI

Como pesquisar dados agregados no índice do dispositivo

O exemplo get-statistics a seguir retorna o número de dispositivos que têm uma propriedade chamada connectivity.connected definida como false (ou seja, o número de itens que não estão conectados) na sombra do dispositivo.

aws iot get-statistics \
    --index-name AWS_Things \
    --query-string "connectivity.connected:false"

Saída:

{
    "statistics": {
        "count": 6
    }
}

Para obter mais informações, consulte Obter estatísticas sobre sua frota de dispositivos no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetStatistics na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-topic-rule-destination.

AWS CLI

Para obter um destino da regra de tópico

O exemplo get-topic-rule-destination a seguir obtém informações sobre um destino de regra de tópico.

aws iot get-topic-rule-destination \
    --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"

Saída:

{
    "topicRuleDestination": {
        "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "status": "DISABLED",
        "httpUrlProperties": {
            "confirmationUrl": "https://example.com"
        }
    }
}

Para obter mais informações, consulte Trabalhar com destinos de tópicos no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar get-topic-rule.

AWS CLI

Para obter informações sobre uma regra

O exemplo get-topic-rule a seguir mostra as informações sobre a regra especificada.

aws iot get-topic-rule \
    --rule-name MyRPiLowMoistureAlertRule

Saída:

{
    "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule",
    "rule": {
        "ruleName": "MyRPiLowMoistureAlertRule",
        "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n                    ",
        "description": "Sends an alert whenever soil moisture level readings are too low.",
        "createdAt": 1558624363.0,
        "actions": [
            {
                "sns": {
                    "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic",
                    "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole",
                    "messageFormat": "RAW"
                }
            }
        ],
        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23"
    }
}

Para obter mais informações, consulte Visualizando as regras no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetTopicRule na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-v2-logging-options.

AWS CLI

Para listar as opções de log atuais

O exemplo get-v2-logging-options a seguir lista as opções atuais de log do AWS IoT.

aws iot get-v2-logging-options

Saída:

{
    "roleArn": "arn:aws:iam::094249569039:role/service-role/iotLoggingRole",
    "defaultLogLevel": "WARN",
    "disableAllLogs": false
}

Para obter mais informações, consulte o título no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte GetV2LoggingOptions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-active-violations.

AWS CLI

Para listar as violações ativas

O exemplo list-active-violations a seguir lista todas as violações do perfil de segurança especificado.

aws iot list-active-violations \
    --security-profile-name Testprofile

Saída:

{
    "activeViolations": [
        {
            "violationId": "174db59167fa474c80a652ad1583fd44",
            "thingName": "iotconsole-1560269126751-1",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "lastViolationValue": {
                "count": 0
            },
            "lastViolationTime": 1560293700.0,
            "violationStartTime": 1560279000.0
        },
        {
            "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab",
            "thingName": "TvnQoEoU",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "CellularBandwidth",
                "metric": "aws:message-byte-size",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 128
                    },
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "lastViolationValue": {
                "count": 110
            },
            "lastViolationTime": 1560369000.0,
            "violationStartTime": 1560276600.0
        },
        {
            "violationId": "74aa393adea02e6648f3ac362beed55e",
            "thingName": "iotconsole-1560269232412-2",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "lastViolationValue": {
                "count": 0
            },
            "lastViolationTime": 1560276600.0,
            "violationStartTime": 1560276600.0
        },
        {
            "violationId": "1e6ab5f7cf39a1466fcd154e1377e406",
            "thingName": "TvnQoEoU",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "lastViolationValue": {
                "count": 0
            },
            "lastViolationTime": 1560369000.0,
            "violationStartTime": 1560276600.0
        }
    ]
}

O código de exemplo a seguir mostra como usar list-attached-policies.

AWS CLI

Exemplo 1: listar as políticas anexadas a um grupo

O exemplo list-attached-policies a seguir lista as políticas anexadas ao grupo especificado.

aws iot list-attached-policies \
    --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"

Saída:

{
    "policies": [
        {
            "policyName": "UpdateDeviceCertPolicy",
            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy"
        }
    ]
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

Exemplo 2: listar as políticas anexadas a um certificado de dispositivo

O exemplo list-attached-policies a seguir lista as políticas do AWS IoT anexadas ao certificado do dispositivo. Cada certificado é identificado pelo seu ARN.

aws iot list-attached-policies \
    --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142

Saída:

{
    "policies": [
        {
            "policyName": "TemperatureSensorPolicy",
            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy"
        }
    ]
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-audit-findings.

AWS CLI

Exemplo 1: listar todas as descobertas de uma auditoria

O exemplo list-audit-findings a seguir lista todas as descobertas de uma auditoria do AWS IoT Device Defender com um ID de tarefa especificado.

aws iot list-audit-findings \
    --task-id a3aea009955e501a31b764abe1bebd3d

Saída:

{
    "findings": []
}

Exemplo 2: listar as descobertas de um tipo de verificação de auditoria

O exemplo list-audit-findings a seguir mostra as descobertas das auditorias do AWS IoT Device Defender realizadas entre 5 de junho de 2019 e 19 de junho de 2019, nas quais os itens compartilham um certificado de dispositivo. Ao especificar um nome de verificação, é necessário fornecer um horário de início e término.

aws iot list-audit-findings \
    --check-name DEVICE_CERTIFICATE_SHARED_CHECK \
    --start-time 1559747125 \
    --end-time 1560962028

Saída:

{
    "findings": [
        {
            "taskId": "eeef61068b0eb03c456d746c5a26ee04",
            "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK",
            "taskStartTime": 1560161017.172,
            "findingTime": 1560161017.592,
            "severity": "CRITICAL",
            "nonCompliantResource": {
                "resourceType": "DEVICE_CERTIFICATE",
                "resourceIdentifier": {
                    "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b"
                }
            },
            "relatedResources": [
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "ZipxgAIl"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1560086374068"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "ZipxgAIl"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1560081552187",
                        "DISCONNECTION_TIME": "1560086371552"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "ZipxgAIl"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559289863631",
                        "DISCONNECTION_TIME": "1560081532716"
                    }
                }
            ],
            "reasonForNonCompliance": "Certificate shared by one or more devices.",
            "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES"
        },
        {
            "taskId": "bade6b5efd2e1b1569822f6021b39cf5",
            "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK",
            "taskStartTime": 1559988217.27,
            "findingTime": 1559988217.655,
            "severity": "CRITICAL",
            "nonCompliantResource": {
                "resourceType": "DEVICE_CERTIFICATE",
                "resourceIdentifier": {
                    "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b"
                }
            },
            "relatedResources": [
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "xShGENLW"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559972350825"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "xShGENLW"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559255062002",
                        "DISCONNECTION_TIME": "1559972350616"
                    }
                }
            ],
            "reasonForNonCompliance": "Certificate shared by one or more devices.",
            "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES"
        },
        {
            "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6",
            "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK",
            "taskStartTime": 1559901817.31,
            "findingTime": 1559901817.767,
            "severity": "CRITICAL",
            "nonCompliantResource": {
                "resourceType": "DEVICE_CERTIFICATE",
                "resourceIdentifier": {
                    "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b"
                }
            },
            "relatedResources": [
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "TvnQoEoU"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559826729768"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "TvnQoEoU"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559345920964",
                        "DISCONNECTION_TIME": "1559826728402"
                    }
                }
            ],
            "reasonForNonCompliance": "Certificate shared by one or more devices.",
            "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES"
        }
    ]
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListAuditFindings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-audit-mitigation-actions-executions.

AWS CLI

Para listar os detalhes da execução de uma ação de mitigação de auditoria

Uma tarefa de ação de mitigação de auditoria aplica uma ação de mitigação a uma ou mais descobertas de uma auditoria do AWS IoT Device Defender. O exemplo list-audit-mitigation-actions-executions a seguir lista os detalhes da tarefa de ação de mitigação com a taskId e a descoberta especificadas.

aws iot list-audit-mitigation-actions-executions \
    --task-id myActionsTaskId \
    --finding-id 0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464

Saída:

{
    "actionsExecutions": [
        {
            "taskId": "myActionsTaskId",
            "findingId": "0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464",
            "actionName": "ResetPolicyVersionAction",
            "actionId": "1ea0b415-bef1-4a01-bd13-72fb63c59afb",
            "status": "COMPLETED",
            "startTime": "2019-12-10T15:19:13.279000-08:00",
            "endTime": "2019-12-10T15:19:13.337000-08:00"
        }
    ]
}

Para obter mais informações, consulte ListAuditMitigationActionsExecutions (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-audit-mitigation-actions-tasks.

AWS CLI

Para listar as tarefas de ação de mitigação de auditoria

O exemplo list-audit-mitigation-actions-tasks a seguir lista as ações de mitigação que foram aplicadas às descobertas dentro do período de tempo especificado.

aws iot list-audit-mitigation-actions-tasks \
    --start-time 1594157400 \
    --end-time 1594157430

Saída:

{
    "tasks": [
        {
                "taskId": "0062f2d6-3999-488f-88c7-bef005414103",
                "startTime": "2020-07-07T14:30:15.172000-07:00",
            "taskStatus": "COMPLETED"
        }
    ]
}

Para obter mais informações, consulte ListAuditMitigationActionsTasks (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-audit-suppressions.

AWS CLI

Para listar as supressões de descobertas de auditoria

O exemplo list-audit-suppressions a seguir lista todas as supressões de descobertas de auditoria.

aws iot list-audit-suppressions

Saída:

{
    "suppressions": [
        {
        "checkName": "DEVICE_CERTIFICATE_EXPIRING_CHECK",
            "resourceIdentifier": {
                "deviceCertificateId": "c7691e<shortened>"
            },
        "expirationDate": 1597881600.0,
        "suppressIndefinitely": false
        }
    ]
}

Para obter mais informações, consulte Supressões de descoberta de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-audit-tasks.

AWS CLI

Para listar todas as descobertas de uma auditoria

O exemplo list-audit-tasks a seguir lista as tarefas de auditoria executadas entre 5 de junho de 2019 e 12 de junho de 2019.

aws iot list-audit-tasks \
    --start-time 1559747125 \
    --end-time 1560357228

Saída:

{
    "tasks": [
        {
            "taskId": "a3aea009955e501a31b764abe1bebd3d",
            "taskStatus": "COMPLETED",
            "taskType": "ON_DEMAND_AUDIT_TASK"
        },
        {
            "taskId": "f76b4b5102b632cd9ae38a279c266da1",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        },
        {
            "taskId": "51d9967d9f9ff4d26529505f6d2c444a",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        },
        {
            "taskId": "eeef61068b0eb03c456d746c5a26ee04",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        },
        {
            "taskId": "041c49557b7c7b04c079a49514b55589",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        },
        {
            "taskId": "82c7f2afac1562d18a4560be73998acc",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        },
        {
            "taskId": "bade6b5efd2e1b1569822f6021b39cf5",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        },
        {
            "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        },
        {
            "taskId": "ac9086b7222a2f5e2e17bb6fd30b3aeb",
            "taskStatus": "COMPLETED",
            "taskType": "SCHEDULED_AUDIT_TASK"
        }
    ]
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListAuditTasks na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-authorizers.

AWS CLI

Para listar seu autorizador personalizado

O exemplo list-authorizers a seguir lista os autorizadores personalizados em sua conta da AWS.

aws iot list-authorizers

Saída:

{
    "authorizers": [
        {
            "authorizerName": "CustomAuthorizer",
            "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer"
        },
        {
            "authorizerName": "CustomAuthorizer2",
            "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2"
        },
        {
            "authorizerName": "CustomAuthorizer3",
            "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer3"
        }
    ]
}

Para obter mais informações, consulte ListAuthorizers na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte ListAuthorizers na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-billing-groups.

AWS CLI

Para listar os grupos de cobrança da sua conta da AWS e região

O exemplo list-billing-groups a seguir lista todos os grupos de cobrança definidos para sua conta da AWS e região da AWS.

aws iot list-billing-groups

Saída:

{
    "billingGroups": [
        {
            "groupName": "GroupOne",
            "groupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne"
        }
    ]
}

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListBillingGroups na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-ca-certificates.

AWS CLI

Para listar os certificados CA registrados em sua conta da AWS.

O exemplo list-ca-certificates a seguir lista os certificados CA registrados em sua conta da AWS.

aws iot list-ca-certificates

Saída:

{
    "certificates": [
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467",
            "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467",
            "status": "INACTIVE",
            "creationDate": 1569365372.053
        }
    ]
}

Para obter mais informações, consulte Usar seu próprio certificado no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListCaCertificates na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-certificates-by-ca.

AWS CLI

Para listar todos os certificados de dispositivo assinados com um certificado CA

O exemplo list-certificates-by-ca a seguir lista todos os certificados de dispositivo em sua conta da AWS que estão assinados com o certificado CA especificado.

aws iot list-certificates-by-ca \
    --ca-certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467

Saída:

{
    "certificates": [
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
            "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
            "status": "ACTIVE",
            "creationDate": 1569363250.557
        }
    ]
}

Para obter mais informações, consulte ListCertificatesByCA na Referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar list-certificates.

AWS CLI

Exemplo 1: listar os certificados registrados em sua conta da AWS.

O exemplo de list-certificates a seguir lista os certificados registrados em sua conta. Se o limite de paginação for maior do que o padrão de 25, é possível usar o valor de resposta nextMarker desse comando e fornecê-lo ao próximo comando para obter o próximo lote de resultados. Repita até nextMarker retornar sem um valor.

aws iot list-certificates

Saída:

{
    "certificates": [
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36",
            "certificateId": "604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36",
            "status": "ACTIVE",
            "creationDate": 1556810537.617
        },
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e",
            "certificateId": "262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e",
            "status": "ACTIVE",
            "creationDate": 1546447050.885
        },
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b",
            "certificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b",
            "status": "ACTIVE",
            "creationDate": 1546292258.322
        },
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42",
            "certificateId": "7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42",
            "status": "ACTIVE",
            "creationDate": 1541457693.453
        },
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3",
            "certificateId": "54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3",
            "status": "ACTIVE",
            "creationDate": 1541113568.611
        },
        {
            "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e",
            "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e",
            "status": "ACTIVE",
            "creationDate": 1541022751.983
        }
    ]
}

  • Para obter detalhes da API, consulte ListCertificates na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-custom-metrics.

AWS CLI

Para listar suas métricas personalizadas

O exemplo list-custom-metrics a seguir lista todas as suas métricas personalizadas.

aws iot list-custom-metrics \
    --region us-east-1

Saída:

{
    "metricNames": [
        "batteryPercentage"
    ]
}

Para obter mais informações, consulte Métricas personalizadas no Guia do desenvolvedor do AWS IoT Core.

  • Para ver detalhes da API, consulte ListCustomMetrics na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-dimensions.

AWS CLI

Para listar as dimensões da sua conta da AWS

O exemplo list-dimensions a seguir lista todas as dimensões do AWS IoT Device Defender definidas na sua conta da AWS.

aws iot list-dimensions

Saída:

{
    "dimensionNames": [
        "TopicFilterForAuthMessages",
        "TopicFilterForActivityMessages"
    ]
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListDimensions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-domain-configurations.

AWS CLI

Para listar as configurações de domínio

O exemplo list-domain-configurations a seguir lista as configurações de domínio em sua conta da AWS que têm o tipo de serviço especificado.

aws iot list-domain-configurations \
    --service-type "DATA"

Saída:

{
    "domainConfigurations":
    [
        {
            "domainConfigurationName": "additionalDataDomain",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh",
            "serviceType": "DATA"
        },

        {
            "domainConfigurationName": "iot:Jobs",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Jobs",
            "serviceType": "JOBS"
        },
        {
            "domainConfigurationName": "iot:Data-ATS",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Data-ATS",
            "serviceType": "DATA"
        },
        {
            "domainConfigurationName": "iot:CredentialProvider",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:CredentialProvider",
            "serviceType": "CREDENTIAL_PROVIDER"
        }
    ]
}

Para obter mais informações, consulte Endpoints configuráveis no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-indices.

AWS CLI

Para listar os índices de pesquisa configurados

O exemplo list-indices a seguir lista todos os índices de pesquisa configurados em sua conta da AWS. Se a indexação de itens não foi ativada, talvez não haja nenhum índice.

aws iot list-indices

Saída:

{
    "indexNames": [
        "AWS_Things"
    ]
}

Para obter mais informações, consulte Gerenciar indexações de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListIndices na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-job-executions-for-job.

AWS CLI

Para listar os trabalhos em sua conta da AWS

O exemplo list-job-executions-for-job a seguir lista todas as execuções de um trabalho em sua contaAWS, especificados pelo jobID.

aws iot list-job-executions-for-job \
    --job-id my-ota-job

Saída:

{
     "executionSummaries": [
         {
             "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/my_thing",
             "jobExecutionSummary": {
                 "status": "QUEUED",
                 "queuedAt": "2022-03-07T15:58:42.195000-08:00",
                 "lastUpdatedAt": "2022-03-07T15:58:42.195000-08:00",
                 "executionNumber": 1,
                 "retryAttempt": 0
             }
         }
     ]
 }

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-job-executions-for-thing.

AWS CLI

Para listar os trabalhos que executados para um item

O exemplo list-job-executions-for-thing a seguir lista todos os trabalhos que foram executados para o item chamadoMyRaspberryPi.

aws iot list-job-executions-for-thing \
    --thing-name "MyRaspberryPi"

Saída:

{
    "executionSummaries": [
        {
            "jobId": "example-job-01",
            "jobExecutionSummary": {
                "status": "QUEUED",
                "queuedAt": 1560787023.636,
                "lastUpdatedAt": 1560787023.636,
                "executionNumber": 1
            }
        }
    ]
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-jobs.

AWS CLI

Para listar os trabalhos em sua conta da AWS

O exemplo list-jobs a seguir lista todos os trabalhos em sua conta da AWS classificados pelo status do trabalho.

aws iot list-jobs

Saída:

{
    "jobs": [
        {
            "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01",
            "jobId": "example-job-01",
            "targetSelection": "SNAPSHOT",
            "status": "IN_PROGRESS",
            "createdAt": 1560787022.733,
            "lastUpdatedAt": 1560787026.294
        }
    ]
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte ListJobs na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-mitigation-actions.

AWS CLI

Para listar todas as ações de mitigação definidas

O exemplo list-mitigation-actions a seguir lista todas as ações de mitigação definidas para sua região e conta da AWS. Para cada ação, o nome, o ARN e a data de criação são listados.

aws iot list-mitigation-actions

Saída:

{
    "actionIdentifiers": [
        {
            "actionName": "DeactivateCACertAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/DeactivateCACertAction",
            "creationDate": "2019-12-10T11:12:47.574000-08:00"
        },
        {
            "actionName": "ResetPolicyVersionAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/ResetPolicyVersionAction",
            "creationDate": "2019-12-10T11:11:48.920000-08:00"
        },
        {
            "actionName": "PublishFindingToSNSAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/PublishFindingToSNSAction",
            "creationDate": "2019-12-10T11:10:49.546000-08:00"
        },
        {
            "actionName": "AddThingsToQuarantineGroupAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
            "creationDate": "2019-12-10T11:09:35.999000-08:00"
        },
        {
            "actionName": "UpdateDeviceCertAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/UpdateDeviceCertAction",
            "creationDate": "2019-12-10T11:08:44.263000-08:00"
        },
        {
            "actionName": "SampleMitigationAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/SampleMitigationAction",
            "creationDate": "2019-12-10T11:03:41.840000-08:00"
        }
    ]
}

Para obter mais informações, consulte ListMitigationActions (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-mitigations-actions.

AWS CLI

Para listar todas as ações de mitigação definidas

O exemplo list-mitigations-actions a seguir lista todas as ações de mitigação definidas para sua região e conta da AWS. Para cada ação, o nome, o ARN e a data de criação são listados.

aws iot list-mitigation-actions

Saída:

{
    "actionIdentifiers": [
        {
            "actionName": "DeactivateCACertAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/DeactivateCACertAction",
            "creationDate": "2019-12-10T11:12:47.574000-08:00"
        },
        {
            "actionName": "ResetPolicyVersionAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/ResetPolicyVersionAction",
            "creationDate": "2019-12-10T11:11:48.920000-08:00"
        },
        {
            "actionName": "PublishFindingToSNSAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/PublishFindingToSNSAction",
            "creationDate": "2019-12-10T11:10:49.546000-08:00"
        },
        {
            "actionName": "AddThingsToQuarantineGroupAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
            "creationDate": "2019-12-10T11:09:35.999000-08:00"
        },
        {
            "actionName": "UpdateDeviceCertAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/UpdateDeviceCertAction",
            "creationDate": "2019-12-10T11:08:44.263000-08:00"
        },
        {
            "actionName": "SampleMitigationAction",
            "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/SampleMitigationAction",
            "creationDate": "2019-12-10T11:03:41.840000-08:00"
        }
    ]
}

Para obter mais informações, consulte ListMitigationActions (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-ota-updates.

AWS CLI

Para listar atualizações OTA para a conta

O exemplo list-ota-updates a seguir lista as atualizações OTA disponíveis.

aws iot list-ota-updates

Saída:

{
    "otaUpdates": [
        {
            "otaUpdateId": "itsaupdate",
            "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate",
            "creationDate": 1557863215.995
        }
    ]
}

Para obter mais informações, consulte ListOTAUpdates na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte ListOtaUpdates na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-outgoing-certificates.

AWS CLI

Para listar os certificados que estão sendo transferidos para uma conta da AWS diferente

O exemplo list-outgoing-certificates a seguir lista todos os certificados de dispositivo que estão sendo transferidos para uma conta da AWS diferente usando o comando transfer-certificate.

aws iot list-outgoing-certificates

Saída:

{
    "outgoingCertificates": [
        {
            "certificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
            "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
            "transferredTo": "030714055129",
            "transferDate": 1569427780.441,
            "creationDate": 1569363250.557
        }
    ]
}

Para obter mais informações, consulte ListOutgoingCertificates na Referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar list-policies.

AWS CLI

Para listar as políticas definidas em sua conta da AWS

O exemplo list-policies a seguir lista todas as políticas definidas em sua conta da AWS.

aws iot list-policies

Saída:

{
    "policies": [
        {
            "policyName": "UpdateDeviceCertPolicy",
            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy"
        },
        {
            "policyName": "PlantIoTPolicy",
            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/PlantIoTPolicy"
        },
        {
            "policyName": "MyPiGroup_Core-policy",
            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/MyPiGroup_Core-policy"
        }
    ]
}

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte ListPolicies na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-policy-versions.

AWS CLI

Exemplo 1: ver todas as versões de uma política

O exemplo list-policy-versions a seguir lista todas as versões da política especificada e suas datas de criação.

aws iot list-policy-versions \
    --policy-name LightBulbPolicy

Saída:

{
    "policyVersions": [
        {
            "versionId": "2",
            "isDefaultVersion": true,
            "createDate": 1559925941.924
        },
        {
            "versionId": "1",
            "isDefaultVersion": false,
            "createDate": 1559925941.924
        }
    ]
}

Para obter mais informações, consulte Políticas do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte ListPolicyVersions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-principal-things.

AWS CLI

Para listar os itens anexados a uma entidade principal

O exemplo list-principal-things a seguir lista os itens anexados à entidade principal especificados por um ARN.

aws iot list-principal-things \
    --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8

Saída:

{
    "things": [
        "DeskLamp",
        "TableLamp"
    ]
}

Para obter mais informações, consulte ListPrincipalThings na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte ListPrincipalThings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-provisioning-template-versions.

AWS CLI

Para listar as versões do modelo de provisionamento

O exemplo list-provisioning-template-versions a seguir lista as versões disponíveis do modelo de provisionamento especificado.

aws iot list-provisioning-template-versions \
    --template-name "widget-template"

Saída:

{
    "versions": [
        {
            "versionId": 1,
            "creationDate": 1574800471.339,
            "isDefaultVersion": true
        },
        {
            "versionId": 2,
            "creationDate": 1574801192.317,
            "isDefaultVersion": false
        }
    ]
}

Para obter mais informações, consulte AWS IoT Secure Tunneling no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar list-provisioning-templates.

AWS CLI

Para listar modelos de provisionamento

O exemplo list-provisioning-templates a seguir lista todos os modelos de provisionamento em sua conta da AWS.

aws iot list-provisioning-templates

Saída:

{
    "templates": [
        {
            "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template",
            "templateName": "widget-template",
            "description": "A provisioning template for widgets",
            "creationDate": 1574800471.367,
            "lastModifiedDate": 1574801192.324,
            "enabled": false
        }
    ]
}

Para obter mais informações, consulte AWS IoT Secure Tunneling no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar list-role-aliases.

AWS CLI

Para listar os aliases da função do AWS IoT em sua conta da AWS

O exemplo list-role-aliases a seguir lista os aliases da função do AWS IoT em sua conta da AWS.

aws iot list-role-aliases

Saída:

{
    "roleAliases": [
        "ResidentAlias",
        "ElectricianAlias"
    ]
}

Para obter mais informações, consulte ListRoleAliases na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte ListRoleAliases na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-scheduled-audits.

AWS CLI

Para listar as auditorias programadas para sua conta da AWS

O exemplo list-scheduled-audits a seguir lista todas as auditorias programadas para sua conta da AWS.

aws iot list-scheduled-audits

Saída:

{
    "scheduledAudits": [
        {
            "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit",
            "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit",
            "frequency": "DAILY"
        },
        {
            "scheduledAuditName": "AWSDeviceDefenderWeeklyAudit",
            "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSDeviceDefenderWeeklyAudit",
            "frequency": "WEEKLY",
            "dayOfWeek": "SUN"
        }
    ]
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListScheduledAudits na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-security-profiles-for-target.

AWS CLI

Para listar os perfis de segurança anexados a um alvo

O exemplo list-security-profiles-for-target a seguir lista os perfis de segurança do AWS IoT Device Defender que estão conectados a dispositivos não registrados.

aws iot list-security-profiles-for-target  \
    --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things"

Saída:

{
    "securityProfileTargetMappings": [
        {
            "securityProfileIdentifier": {
                "name": "Testprofile",
                "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile"
            },
            "target": {
                "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things"
            }
        }
    ]
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-security-profiles.

AWS CLI

Para listar os perfis de segurança da sua conta da AWS

O exemplo list-security-profiles a seguir lista todos os perfis de segurança do AWS IoT Device Defender definidas na sua conta da AWS.

aws iot list-security-profiles

Saída:

{
    "securityProfileIdentifiers": [
        {
            "name": "Testprofile",
            "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile"
        }
    ]
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-streams.

AWS CLI

Para listar os fluxos na conta

O exemplo list-streams a seguir lista todos fluxos em sua conta da AWS.

aws iot list-streams

Saída:

{
    "streams": [
        {
            "streamId": "stream12345",
            "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345",
            "streamVersion": 1,
            "description": "This stream is used for Amazon FreeRTOS OTA Update 12345."
        },
        {
            "streamId": "stream54321",
            "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream54321",
            "streamVersion": 1,
            "description": "This stream is used for Amazon FreeRTOS OTA Update 54321."
        }
    ]
}

Para obter mais informações, consulte ListStreams na Referência da API do AWS IoT.

  • Para obter detalhes da API, consulte ListStreams na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Como exibir as tags e seus valores associados a um recurso

O exemplo list-tags-for-resource a seguir exibe as tags e os valores associados ao grupo de itens LightBulbs.

aws iot list-tags-for-resource \
    --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs"

Saída:

{
    "tags": [
        {
            "Key": "Assembly",
            "Value": "Fact1NW"
        },
        {
            "Key": "MyTag",
            "Value": "777"
        }
    ]
}

Para obter mais informações, consulte Adicionar tags aos recursos do AWS IoT, no Guia do Desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-targets-for-policy.

AWS CLI

Para listar as entidades principais associadas a uma política do AWS IoT

O exemplo list-targets-for-policy a seguir lista os certificados de dispositivo aos quais a política especificada está anexada.

aws iot list-targets-for-policy \
    --policy-name UpdateDeviceCertPolicy

Saída:

{
    "targets": [
        "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
        "arn:aws:iot:us-west-2:123456789012:cert/d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be"
    ]
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-targets-for-security-profile.

AWS CLI

Para listar os alvos aos quais um perfil de segurança é aplicado

O exemplo list-targets-for-security-profile a seguir lista os alvos aos quais o perfil de segurança do AWS IoT Device Defender chamado PossibleIssue é aplicado.

aws iot list-targets-for-security-profile \
    --security-profile-name Testprofile

Saída:

{
    "securityProfileTargets": [
        {
            "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things"
        },
        {
            "arn": "arn:aws:iot:us-west-2:123456789012:all/registered-things"
        }
    ]
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-thing-groups-for-thing.

AWS CLI

Para listar os grupos aos quais um item pertence

O exemplo list-thing-groups-for-thing a seguir lista os grupos aos quais o item especificado pertence.

aws iot list-thing-groups-for-thing \
    --thing-name MyLightBulb

Saída:

{
    "thingGroups": [
        {
            "groupName": "DeadBulbs",
            "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs"
        },
        {
            "groupName": "LightBulbs",
            "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
        }
    ]
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-thing-groups.

AWS CLI

Para listar os grupos de itens em sua conta da AWS

O exemplo describe-thing-group a seguir lista todos os grupos de itens definidos em sua conta da AWS.

aws iot list-thing-groups

Saída:

{
    "thingGroups": [
        {
            "groupName": "HalogenBulbs",
            "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs"
        },
        {
            "groupName": "LightBulbs",
            "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs"
        }
    ]
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListThingGroups na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-thing-principals.

AWS CLI

As entidades principais associadas ao item.

O exemplo list-thing-principals a seguir lista as entidades principais (certificados X.509, usuários do IAM, grupos, perfis, identidades do Amazon Cognito ou identidades federadas) associados ao item especificado.

aws iot list-thing-principals \
    --thing-name MyRaspberryPi

Saída:

{
    "principals": [
        "arn:aws:iot:us-west-2:123456789012:cert/33475ac865079a5ffd5ecd44240640349293facc760642d7d8d5dbb6b4c86893"
    ]
}

Para obter mais informações, consulte ListThingPrincipals na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte ListThingPrincipals na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-thing-types.

AWS CLI

Para listar os tipos de itens definidos

O exemplo list-thing-types a seguir lista todos os grupos de itens definidos em sua conta da AWS.

aws iot list-thing-types

Saída:

{
    "thingTypes": [
        {
            "thingTypeName": "LightBulb",
            "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb",
            "thingTypeProperties": {
                "thingTypeDescription": "light bulb type",
                "searchableAttributes": [
                    "model",
                    "wattage"
                ]
            },
            "thingTypeMetadata": {
            "deprecated": false,
            "creationDate": 1559772562.498
            }
        }
    ]
}

Para obter mais informações, consulte Tipos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListThingTypes na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-things-in-billing-group.

AWS CLI

Para listar os itens em um grupo de cobrança

O exemplo list-things-in-billing-group a seguir lista os itens que no grupo de cobrança especificado.

aws iot list-things-in-billing-group \
    --billing-group-name GroupOne

Saída:

{
    "things": [
        "MyOtherLightBulb",
        "MyLightBulb"
    ]
}

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-things-in-thing-group.

AWS CLI

Para listar os itens que pertencem a um grupo

O exemplo list-things-in-thing-group a seguir lista os itens que pertencem ao grupo de itens especificado.

aws iot list-things-in-thing-group \
    --thing-group-name LightBulbs

Saída:

{
    "things": [
        "MyLightBulb"
    ]
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-things.

AWS CLI

Exemplo 1: listar todas os itens do registro

O exemplo de list-things a seguir lista os itens (dispositivos) que estão definidos no registro do AWS IoT da conta da AWS.

aws iot list-things

Saída:

{
    "things": [
        {
            "thingName": "ThirdBulb",
            "thingTypeName": "LightBulb",
            "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/ThirdBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "version": 2
        },
        {
            "thingName": "MyOtherLightBulb",
            "thingTypeName": "LightBulb",
            "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "version": 3
        },
        {
            "thingName": "MyLightBulb",
            "thingTypeName": "LightBulb",
            "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "version": 1
        },
        {
        "thingName": "SampleIoTThing",
        "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/SampleIoTThing",
        "attributes": {},
        "version": 1
        }
    ]
}

Exemplo 2: como listar os itens definidos que possuem um atributo específico

O exemplo de list-things a seguir exibe uma lista dos itens que têm um atributo chamado wattage.

aws iot list-things \
    --attribute-name wattage

Saída:

{
    "things": [
        {
            "thingName": "MyLightBulb",
            "thingTypeName": "LightBulb",
            "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "version": 1
        },
        {
            "thingName": "MyOtherLightBulb",
            "thingTypeName": "LightBulb",
            "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "version": 3
        }
    ]
}

Para acessar mais informações, consulte Como gerenciar objetos com o registro no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte ListThings na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-topic-rule-destinations.

AWS CLI

Para listar seus destinos de regras de tópicos

O exemplo list-topic-rule-destinations a seguir lista todos os destinos de regras de tópicos definidas na região da AWS atual.

aws iot list-topic-rule-destinations

Saída:

{
    "destinationSummaries": [
        {
            "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "status": "ENABLED",
            "httpUrlSummary": {
                "confirmationUrl": "https://example.com"
            }
        }
    ]
}

Para obter mais informações, consulte Trabalhar com destinos de tópicos no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar list-topic-rules.

AWS CLI

Para listar suas regras

O exemplo list-topic-rules a seguir lista todas as regras definidas.

aws iot list-topic-rules

Saída:

{
    "rules": [
        {
            "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule",
            "ruleName": "MyRPiLowMoistureAlertRule",
            "topicPattern": "$aws/things/MyRPi/shadow/update/accepted",
            "createdAt": 1558624363.0,
            "ruleDisabled": false
        },
        {
            "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyPlantPiMoistureAlertRule",
            "ruleName": "MyPlantPiMoistureAlertRule",
            "topicPattern": "$aws/things/MyPlantPi/shadow/update/accepted",
            "createdAt": 1541458459.0,
            "ruleDisabled": false
        }
    ]
}

Para obter mais informações, consulte Visualizando as regras no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListTopicRules na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-v2-logging-levels.

AWS CLI

Para listar os níveis de log

O exemplo list-v2-logging-levels a seguir lista os níveis de log configurados. Se os níveis de log não foram definidos, um NotConfiguredException ocorre ao executar esse comando.

aws iot list-v2-logging-levels

Saída:

{
    "logTargetConfigurations": [
        {
            "logTarget": {
                "targetType": "DEFAULT"
            },
            "logLevel": "ERROR"
        }
    ]
}

  • Para ver detalhes da API, consulte ListV2LoggingLevels na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-violation-events.

AWS CLI

Para listar as violações do perfil de segurança durante um período

O exemplo list-violation-events a seguir lista as violações que ocorreram entre 5 de junho de 2019 e 12 de junho de 2019 para todos os perfis de segurança do AWS IoT Device Defender da conta da AWS atual e da região da AWS.

aws iot list-violation-events \
    --start-time 1559747125 \
    --end-time 1560351925

Saída:

{
    "violationEvents": [
        {
            "violationId": "174db59167fa474c80a652ad1583fd44",
            "thingName": "iotconsole-1560269126751-1",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 0
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560279000.0
        },
        {
            "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab",
            "thingName": "TvnQoEoU",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "CellularBandwidth",
                "metric": "aws:message-byte-size",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 128
                    },
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 110
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560276600.0
        },
        {
            "violationId": "74aa393adea02e6648f3ac362beed55e",
            "thingName": "iotconsole-1560269232412-2",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 0
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560276600.0
        },
        {
            "violationId": "1e6ab5f7cf39a1466fcd154e1377e406",
            "thingName": "TvnQoEoU",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 0
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560276600.0
        }
    ]
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ListViolationEvents na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar register-ca-certificate.

AWS CLI

Para registrar um certificado de autoridade de certificação (CA)

O exemplo register-ca-certificate a seguir registra um certificado CA. O comando fornece o certificado CA e um certificado de verificação de chave que prova a posse da chave privada associada ao certificado CA.

aws iot register-ca-certificate \
    --ca-certificate file://rootCA.pem \
    --verification-cert file://verificationCert.pem

Saída:

{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467",
    "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467"
 }

Para obter mais informações, consulte RegisterCACertificate na Referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar register-certificate.

AWS CLI

Para registrar um certificado de dispositivo autoassinado

O exemplo register-certificate a seguir registra o certificado do dispositivo deviceCert.pem assinado pelo certificado CA rootCA.pem. O certificado CA deve ser registrado antes de ser usado para registrar um certificado de dispositivo autoassinado. O certificado autoassinado deve ser assinado pelo mesmo certificado CA passado para esse comando.

aws iot register-certificate \
    --certificate-pem file://deviceCert.pem \
    --ca-certificate-pem file://rootCA.pem

Saída:

{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
    "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142"
 }

Para obter mais informações, consulte RegisterCertificate na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte RegisterCertificate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar register-thing.

AWS CLI

Para registrar um item

O exemplo register-thing a seguir registra um item usando um modelo de provisionamento.

aws iot register-thing \
    --template-body '{"Parameters":{"ThingName":{"Type":"String"},"AWS::IoT::Certificate::Id":{"Type":"String"}},"Resources": {"certificate":{"Properties":{"CertificateId":{"Ref":"AWS::IoT::Certificate::Id"},"Status":"Active"},"Type":"AWS::IoT::Certificate"},"policy":{"Properties":{"PolicyName":"MyIotPolicy"},"Type":"AWS::IoT::Policy"},"thing":{"OverrideSettings":{"AttributePayload":"MERGE","ThingGroups":"DO_NOTHING","ThingTypeName":"REPLACE"},"Properties":{"AttributePayload":{},"ThingGroups":[],"ThingName":{"Ref":"ThingName"},"ThingTypeName":"VirtualThings"},"Type":"AWS::IoT::Thing"}}}' \
    --parameters '{"ThingName":"Register-thing-trial-1","AWS::IoT::Certificate::Id":"799a9ea048a1e6aea42b55EXAMPLEf8697b4bafcd77a318a3068e30404b9233c"}'

Saída:

{
    "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCCAkGgAwIBAgIUYLk81I35cIppobpw
HiOJ2jNjboIwDQYJKoZIhvcNAQEL\nBQAwTTFLMEkGA1UECwxCQW1hem9uIFdlYiBTZXJ2aWNlcyBPPUFtYXpvbi
5jb20g\nSW5jLiBMPVNlYXR0bGUgU1Q9V2FzaGluZ3RvbiBDPVVTMB4XDTIwMDcyMzE2NDUw\nOVoXDTQ5MTIzMT
IzNTk1OVowHjEcMBoGA1UEAwwTQVdTIElvVCBDZXJ0aWZpY2F0\nZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC
AQoCggEBAO71uADhdBajqTmgrMV5\nmCFfBZQRMo1MdtVoZr2X+M4MzL+RARrtUzH9a2SMAckeX8KeblIOTKzORI
RDXnyE\n6lVOwjgAsd0ku22rFxex4eG2ikha7pYYkvuToqA7L3TxItRvfKrxRI4ZfJoFPip4\nKqiuBJVNOGKTcQ
Hd1RNOrddwwu6kFJLeKDmEXAMPLEdUF0N+qfR9yKnZQkm+g6Q2\nGXu7u0W3hn6nlRN8qVoka0uW12p53xM7oHVz
Gf+cxKBxlbOhGkp6yCfTSkUBm3Sp\n9zLw35kiHXVm4EVpwgNlnk6XcIGIkw8a/iy4pzmvuGAANY1/uU/zgCjymw
ZT5S30\nBV0CAwEAAaNgMF4wHwYDVR0jBBgwFoAUGx0tCcU3q2n1WXAuUCv6hugXjKswHQYD\nVR0OBBYEFOVtvZ
9Aj2RYFnkX7Iu01XTRUdxgMAwGA1UdEwEB/wQCMAAwDgYDVR0P\nAQH/BAQDAgeAMA0GCSqGSIb3DQEBCwUAA4IB
AQCXCQcpOtubS5ftOsDMTcpP/jNX\nDHyArxmjpSc2aCdmm7WX59lTKWyAdxGAvqaDVWqTo0oXI7tZ8w7aINlGi5
pXnifx\n3SBebMUoBbTktrC97yUaeL025mCFv8emDnTR/fE7PTsBKjW0g/rrfpwBxZLXDFwN\nnqkQjy3EDfifj2
6j0xYIqqWMPogyn4srOCKynS5wMJuQZlHQOnabVwnwK4Y0Mflp\np9+4susFUR9aT3BT1AcIwqSpzhlKhh4Iz7ND
kRn4amsUT210jg/zOO1Ow+BTHcVQ\nJly8XDu0CWSu04q6SnaBzHmlySIajxuRTP/AdfRouP1OXe+qlbPOBcvVvF
8o\n-----END CERTIFICATE-----\n",
    "resourceArns": {
        "certificate": "arn:aws:iot:us-west-2:571032923833:cert/799a9ea048a1e6aea42b55EXAMPLEf8697b4bafcd77a318a3068e30404b9233c",
        "thing": "arn:aws:iot:us-west-2:571032923833:thing/Register-thing-trial-1"
    }
}

Para obter mais informações, consulte Provisionamento por usuário confiável no Guia do desenvolvedor do AWS IoT Core.

  • Para ver detalhes da API, consulte RegisterThing na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar reject-certificate-transfer.

AWS CLI

Como aceitar ou rejeitar uma transferência de certificado

O exemplo reject-certificate-transfer a seguir rejeita a transferência do certificado do dispositivo especificado de outra conta da AWS.

aws iot reject-certificate-transfer \
    --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8

Este comando não produz saída.

Para obter mais informações, consulte Transferir um certificado para outra conta no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar remove-thing-from-billing-group.

AWS CLI

Para remover um item de um grupo de cobrança

O exemplo remove-thing-from-billing-group a seguir remove os itens especificados de um grupo de cobrança.

aws iot remove-thing-from-billing-group \
    --billing-group-name GroupOne \
    --thing-name MyOtherLightBulb

Este comando não produz saída.

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar remove-thing-from-thing-group.

AWS CLI

Para remover um item de um grupo de itens

O exemplo remove-thing-from-thing-group a seguir remove o item especificado de um grupo de itens.

aws iot remove-thing-from-thing-group \
    --thing-name bulb7 \
    --thing-group-name DeadBulbs

Este comando não produz saída.

Para obter mais informações, consulte Grupos de itens <https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html > no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar replace-topic-rule.

AWS CLI

Para atualizar a definição de regra de um tópico

O exemplo replace-topic-rule a seguir atualiza a regra especificada para enviar um alerta do SNS quando as leituras do nível de umidade do solo estiverem muito baixas.

aws iot replace-topic-rule \
    --rule-name MyRPiLowMoistureAlertRule \
    --topic-rule-payload "{\"sql\": \"SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\", \"description\": \"Sends an alert when soil moisture level readings are too low.\",\"actions\": [{\"sns\":{\"targetArn\":\"arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic\",\"roleArn\":\"arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole\",\"messageFormat\": \"RAW\"}}],\"ruleDisabled\": false,\"awsIotSqlVersion\":\"2016-03-23\"}"

Este comando não produz saída.

Para obter mais informações, consulte Criando uma regra do AWS IoT no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte ReplaceTopicRule na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar search-index.

AWS CLI

Como consultar o índice do item

O exemplo de search-index a seguir consulta o índice AWS_Things em busca de itens que tenham um tipo de LightBulb.

aws iot search-index \
    --index-name "AWS_Things" \
    --query-string "thingTypeName:LightBulb"

Saída:

{
    "things": [
        {
            "thingName": "MyLightBulb",
            "thingId": "40da2e73-c6af-406e-b415-15acae538797",
            "thingTypeName": "LightBulb",
            "thingGroupNames": [
                "LightBulbs",
                "DeadBulbs"
            ],
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "connectivity": {
                "connected": false
            }
        },
        {
            "thingName": "ThirdBulb",
            "thingId": "615c8455-33d5-40e8-95fd-3ee8b24490af",
            "thingTypeName": "LightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "connectivity": {
                "connected": false
            }
        },
        {
            "thingName": "MyOtherLightBulb",
            "thingId": "6dae0d3f-40c1-476a-80c4-1ed24ba6aa11",
            "thingTypeName": "LightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "connectivity": {
                "connected": false
            }
        }
    ]
}

Para obter mais informações, consulte Gerenciar indexações de itens no Guia do desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte SearchIndex na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar set-default-authorizer.

AWS CLI

Como definir o autorizador padrão

O exemplo set-default-authorizer a seguir define o autorizador personalizado chamado CustomAuthorizer como o autorizador padrão.

aws iot set-default-authorizer \
    --authorizer-name CustomAuthorizer

Saída:

{
    "authorizerName": "CustomAuthorizer",
    "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer"
}

Para obter mais informações, consulte CreateDefaultAuthorizer no Guia de referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar set-default-policy-version.

AWS CLI

Como definir a versão padrão de uma política

O exemplo set-default-policy-version a seguir define a versão padrão de 2 para a política chamada UpdateDeviceCertPolicy.

aws iot set-default-policy-version \
    --policy-name UpdateDeviceCertPolicy \
    --policy-version-id 2

Este comando não produz saída.

O código de exemplo a seguir mostra como usar set-v2-logging-level.

AWS CLI

Como definir o nível de log para um grupo de itens

O exemplo set-v2-logging-level a seguir define o nível de registro para registrar avisos para o grupo de itens especificado.

aws iot set-v2-logging-level \
    --log-target "{\"targetType\":\"THING_GROUP\",\"targetName\":\"LightBulbs\"}" \
    --log-level WARN

Este comando não produz saída.

  • Para ver detalhes da API, consulte SetV2LoggingLevel na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar set-v2-logging-options.

AWS CLI

Como definir as opções de log

O exemplo set-v2-logging-options a seguir define o nível de detalhamento do log padrão como ERROR e especifica o ARN a ser usado para o registro.

aws iot set-v2-logging-options \
    --default-log-level ERROR \
    --role-arn "arn:aws:iam::094249569039:role/service-role/iotLoggingRole"

Este comando não produz saída.

  • Para ver detalhes da API, consulte SetV2LoggingOptions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar start-audit-mitigation-actions-task.

AWS CLI

Como aplicar uma ação de mitigação às descobertas de uma auditoria

O exemplo start-audit-mitigation-actions-task a seguir aplica a ação ResetPolicyVersionAction (que limpa a política) à descoberta única especificada.

aws iot start-audit-mitigation-actions-task \
    --task-id "myActionsTaskId" \
    --target "findingIds=[\"0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464\"]" \
    --audit-check-to-actions-mapping "IOT_POLICY_OVERLY_PERMISSIVE_CHECK=[\"ResetPolicyVersionAction\"]" \
    --client-request-token "adhadhahda"

Saída:

{
    "taskId": "myActionsTaskId"
}

Para obter mais informações, consulte StartAuditMitigationActionsTask (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar start-on-demand-audit-task.

AWS CLI

Para iniciar uma auditoria imediatamente

O exemplo start-on-demand-audit-task a seguir inicia uma auditoria do AWS IoT Device Defender e executa três verificações de certificado.

aws iot start-on-demand-audit-task \
    --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK

Saída:

{
    "taskId": "a3aea009955e501a31b764abe1bebd3d"
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para especificar a chave e o valor de uma tag para um recurso

O exemplo tag-resource a seguir aplica a tag com uma chave Assembly e o valor Fact1NW ao grupo de itens LightBulbs.

aws iot tag-resource \
    --tags Key=Assembly,Value="Fact1NW" \
    --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs"

Este comando não produz saída.

Para obter mais informações, consulte Adicionar tags aos recursos do AWS IoT, no Guia do Desenvolvedor do AWS IoT.

  • Para obter detalhes da API, consulte TagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar test-authorization.

AWS CLI

Para testar suas políticas do AWS IoT

O exemplo test-authorization a seguir testa as políticas do AWS IoT associadas à entidade principal especificada.

aws iot test-authorization \
    --auth-infos actionType=CONNECT,resources=arn:aws:iot:us-east-1:123456789012:client/client1 \
    --principal arn:aws:iot:us-west-2:123456789012:cert/aab1068f7f43ac3e3cae4b3a8aa3f308d2a750e6350507962e32c1eb465d9775

Saída:

{
    "authResults": [
        {
            "authInfo": {
                "actionType": "CONNECT",
                "resources": [
                    "arn:aws:iot:us-east-1:123456789012:client/client1"
                ]
            },
            "allowed": {
                "policies": [
                    {
                        "policyName": "TestPolicyAllowed",
                        "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyAllowed"
                    }
                ]
            },
            "denied": {
                "implicitDeny": {
                    "policies": [
                        {
                            "policyName": "TestPolicyDenied",
                            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyDenied"
                        }
                    ]
                },
                "explicitDeny": {
                    "policies": [
                        {
                            "policyName": "TestPolicyExplicitDenied",
                            "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyExplicitDenied"
                        }
                    ]
                }
            },
            "authDecision": "IMPLICIT_DENY",
            "missingContextValues": []
        }
    ]
}

Para obter mais informações, consulte TestAuthorization na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte TestAuthorization na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar test-invoke-authorizer.

AWS CLI

Para testar um autorizador personalizado

O exemplo test-invoke-authorizer a seguir testa seu autorizador personalizado.

aws iot test-invoke-authorizer \
    --authorizer-name IoTAuthorizer \
    --token allow \
    --token-signature "mE0GvaHqy9nER/FdgtJX5lXYEJ3b3vE7t1gEszc0TKGgLKWXTnPkb2AbKnOAZ8lGyoN5dVtWDWVmr25m7++zjbYIMk2TBvyGXhOmvKFBPkdgyA43KL6SiZy0cTqlPMcQDsP7VX2rXr7CTowCxSNKphGXdQe0/I5dQ+JO6KUaHwCmupt0/MejKtaNwiia064j6wprOAUwG5S1IYFuRd0X+wfo8pb0DubAIX1Ua705kuhRUcTx4SxUShEYKmN4IDEvLB6FsIr0B2wvB7y4iPmcajxzGl02ExvyCUNctCV9dYlRRGJj0nsGzBIXOI4sGytPfqlA7obdgmN22pkDzYvwjQ=="

Saída:

{
    "isAuthenticated": true,
    "principalId": "principalId",
    "policyDocuments": [
        "{"Version":"2012-10-17","Statement":[{"Action":"iot:Publish","Effect":"Allow","Resource":"arn:aws:iot:us-west-2:123456789012:topic/customauthtesting"}]}"
    ],
    "refreshAfterInSeconds": 600,
    "disconnectAfterInSeconds": 3600
}

Para obter mais informações, consulte TestInvokeAuthorizer na Referência da API do AWS IoT.

O código de exemplo a seguir mostra como usar transfer-certificate.

AWS CLI

Como transferir um certificado para uma conta da AWS diferente

O exemplo transfer-certificate a seguir transfere um certificado de dispositivo a outra conta da AWS. O certificado e a conta da AWS são identificados por ID.

aws iot transfer-certificate \
    --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 \
    --target-aws-account 030714055129

Saída:

{
    "transferredCertificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142"
}

Para obter mais informações, consulte Transferir um certificado para outra conta no Guia do desenvolvedor do AWS IoT Core.

  • Para ver detalhes da API, consulte TransferCertificate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover uma tag de um recurso

O exemplo untag-resource a seguir remove a tag MyTag e seu valor do grupo de itens LightBulbs.

command

Este comando não produz saída.

Para obter mais informações, consulte Adicionar tags aos recursos do AWS IoT, no Guia do Desenvolvedor do AWS IoT.

  • Para obter detalhes sobre a API, consulte UntagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-account-audit-configuration.

AWS CLI

Exemplo 1: habilitar as notificações do Amazon SNS para notificações de auditoria

O exemplo update-account-audit-configuration a seguir habilita notificações do Amazon SNS para notificações de auditoria do AWS IoT Device Defender, especificando um alvo e a função usada para gravar nesse destino.

aws iot update-account-audit-configuration \
    --audit-notification-target-configurations "SNS={targetArn=\"arn:aws:sns:us-west-2:123456789012:ddaudits\",roleArn=\"arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit\",enabled=true}"

Este comando não produz saída.

Exemplo 2: habilitar uma verificação de auditoria

O exemplo update-account-audit-configuration a seguir habilita a auditoria do AWS IoT Device Defender chamada AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK. Não é possível desativar uma verificação de auditoria se ela fizer parte de targetCheckNames em uma ou mais auditorias programadas para a conta da AWS.

aws iot update-account-audit-configuration \
    --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}"

Este comando não produz saída.

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-audit-suppression.

AWS CLI

Para atualizar uma supressão de descoberta de auditoria

O exemplo update-audit-suppression a seguir atualiza a data de expiração de uma supressão da descoberta de auditoria para 21-09-2020.

aws iot update-audit-suppression \
    --check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \
    --resource-identifier deviceCertificateId=c7691e<shortened> \
    --no-suppress-indefinitely \
    --expiration-date 2020-09-21

Este comando não produz saída.

Para obter mais informações, consulte Supressões de descoberta de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-authorizer.

AWS CLI

Para atualizar um autorizador personalizado

O exemplo update-authorizer a seguir atualiza o estado de CustomAuthorizer2 para INACTIVE.

aws iot update-authorizer \
    --authorizer-name CustomAuthorizer2 \
    --status INACTIVE

Saída:

{
    "authorizerName": "CustomAuthorizer2",
    "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2"
}

Para obter mais informações, consulte UpdateAuthorizer na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte UpdateAuthorizer na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-billing-group.

AWS CLI

Para atualizar informações sobre um grupo de cobrança

O exemplo update-billing-group a seguir atualiza a descrição do grupo de cobrança especificado.

aws iot update-billing-group \
    --billing-group-name GroupOne \
    --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\""

Saída:

{
    "version": 2
}

Para obter mais informações, consulte Grupos de cobrança no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte UpdateBillingGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-ca-certificate.

AWS CLI

Para atualizar um certificado de autoridade de certificação (CA)

O exemplo update-ca-certificate a seguir define o status do certificado CA especificado para ATIVO.

aws iot update-ca-certificate \
    --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 \
    --new-status ACTIVE

Este comando não produz saída.

Para obter mais informações, consulte UpdateCACertificate na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte UpdateCaCertificate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-certificate.

AWS CLI

Para atualizar um certificado de dispositivo

O exemplo update-certificate a seguir define o status do certificado do dispositivo especificado para INATIVO.

aws iot update-certificate \
    --certificate-id d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be \
    --new-status INACTIVE

Este comando não produz saída.

Para obter mais informações, consulte UpdateCertificate na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte UpdateCertificate na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-custom-metric.

AWS CLI

Para atualizar uma métrica personalizada

O exemplo update-custom-metric a seguir atualiza uma métrica personalizada para ter uma nova display-name.

aws iot update-custom-metric \
    --metric-name batteryPercentage \
    --display-name 'remaining battery percentage on device' \
    --region us-east-1

Saída:

{
    "metricName": "batteryPercentage",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage",
    "metricType": "number",
    "displayName": "remaining battery percentage on device",
    "creationDate": "2020-11-17T23:01:35.110000-08:00",
    "lastModifiedDate": "2020-11-17T23:02:12.879000-08:00"
}

Para obter mais informações, consulte Métricas personalizadas no Guia do desenvolvedor do AWS IoT Core.

  • Para ver detalhes da API, consulte UpdateCustomMetric na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-dimension.

AWS CLI

Para atualizar uma dimensão

O exemplo update-dimension a seguir atualiza uma dimensão.

aws iot update-dimension \
    --name TopicFilterForAuthMessages \
    --string-values device/${iot:ClientId}/auth

Saída:

{
    "name": "TopicFilterForAuthMessages",
    "lastModifiedDate": 1585866222.317,
    "stringValues": [
        "device/${iot:ClientId}/auth"
    ],
    "creationDate": 1585854500.474,
    "type": "TOPIC_FILTER",
    "arn": "arn:aws:iot:us-west-2:1234564789012:dimension/TopicFilterForAuthMessages"
}

Para obter mais informações, consulte Métricas de escopo em perfis de segurança usando dimensões no Guia do desenvolvedor do AWS IoT Core.

  • Para ver detalhes da API, consulte UpdateDimension na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-domain-configuration.

AWS CLI

Para atualizar uma configuração de domínio

O exemplo update-domain-configuration a seguir desabilita a configuração de domínio especificada.

aws iot update-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --domain-configuration-status "DISABLED"

Saída:

{
    "domainConfigurationName": "additionalDataDomain",
    "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh"
}

Para obter mais informações, consulte Endpoints configuráveis no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-dynamic-thing-group.

AWS CLI

Para atualizar um grupo dinâmico de itens

O exemplo update-dynamic-thing-group a seguir atualiza o grupo dinâmico de itens especificado. Ele fornece uma descrição e atualiza a string de consulta para alterar os critérios de associação ao grupo.

aws iot update-dynamic-thing-group \
    --thing-group-name "RoomTooWarm"
    --thing-group-properties "thingGroupDescription=\"This thing group contains rooms warmer than 65F.\"" \
    --query-string "attributes.temperature>65"

Saída:

{
    "version": 2
}

Para obter mais informações, consulte Grupos dinâmicos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-event-configurations.

AWS CLI

Como mostrar quais tipos de eventos são publicados

O exemplo update-event-configurations a seguir atualiza a configuração para habilitar mensagens quando o certificado CA é adicionado, atualizado ou excluído.

aws iot update-event-configurations \
    --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}"

Este comando não produz saída.

Para obter mais informações, consulte Mensagens de evento no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-indexing-configuration.

AWS CLI

Para habilitar a indexação de itens

O exemplo de update-indexing-configuration a seguir permite que a indexação de itens ofereça suporte à pesquisa de dados de registro, dados de sombra e status de conectividade de itens usando o índice AWS_Things.

aws iot update-indexing-configuration
    --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar indexações de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-job.

AWS CLI

Para obter o status de um trabalho

O exemplo update-job a seguir obtém o status detalhado do trabalho cujo ID é example-job-01.

aws iot describe-job \
    --job-id "example-job-01"

Saída:

{
    "job": {
        "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01",
        "jobId": "example-job-01",
        "targetSelection": "SNAPSHOT",
        "status": "IN_PROGRESS",
        "targets": [
            "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi"
        ],
        "description": "example job test",
        "presignedUrlConfig": {},
        "jobExecutionsRolloutConfig": {},
        "createdAt": 1560787022.733,
        "lastUpdatedAt": 1560787026.294,
        "jobProcessDetails": {
            "numberOfCanceledThings": 0,
            "numberOfSucceededThings": 0,
            "numberOfFailedThings": 0,
            "numberOfRejectedThings": 0,
            "numberOfQueuedThings": 1,
            "numberOfInProgressThings": 0,
            "numberOfRemovedThings": 0,
            "numberOfTimedOutThings": 0
        },
        "timeoutConfig": {}
    }
}

Para obter mais informações, consulte Criar e gerenciar trabalhos (CLI) no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte UpdateJob na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-mitigation-action.

AWS CLI

Para atualizar uma ação de mitigação

O exemplo update-mitigation-action a seguir atualiza a ação de mitigação especificada chamada AddThingsToQuarantineGroupAction, altera o nome do grupo de itens e define overrideDynamicGroups como false. Para verificar as alterações, use o comando describe-mitigation-action.

aws iot update-mitigation-action \
    --cli-input-json "{ \"actionName\": \"AddThingsToQuarantineGroupAction\", \"actionParams\": { \"addThingsToThingGroupParams\": {\"thingGroupNames\":[\"QuarantineGroup2\"],\"overrideDynamicGroups\": false}}}"

Saída:

{
    "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
    "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa"
}

Para obter mais informações, consulte UpdateMitigationAction (Comandos de ação de mitigação) no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-provisioning-template.

AWS CLI

Para atualizar um modelo de provisionamento

O exemplo update-provisioning-template a seguir modifica a descrição e o perfil ARN do modelo de provisionamento especificado e ativa o modelo.

aws iot update-provisioning-template \
    --template-name widget-template \
    --enabled \
    --description "An updated provisioning template for widgets" \
    --provisioning-role-arn arn:aws:iam::504350838278:role/Provision_role

Este comando não produz saída.

Para obter mais informações, consulte AWS IoT Secure Tunneling no Guia do desenvolvedor do AWS IoT Core.

O código de exemplo a seguir mostra como usar update-role-alias.

AWS CLI

Para atualizar um alias de perfil

O exemplo update-role-alias a seguir atualiza o alias do perfil LightBulbRole.

aws iot update-role-alias \
    --role-alias LightBulbRole \
    --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001

Saída:

{
    "roleAlias": "LightBulbRole",
    "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole"
}

Para obter mais informações, consulte UpdateRoleAlias na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte UpdateRoleAlias na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-scheduled-audit.

AWS CLI

Para atualizar uma definição de auditoria programada

O exemplo update-scheduled-audit a seguir altera os nomes das verificações de alvo para uma auditoria agendada do AWS IoT Device Defender.

aws iot update-scheduled-audit \
    --scheduled-audit-name WednesdayCertCheck \
    --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK

Saída:

{
    "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck"
}

Para obter mais informações, consulte Comandos de auditoria no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-security-profile.

AWS CLI

Para alterar um perfil de segurança

O exemplo update-security-profile a seguir atualiza a descrição e os comportamentos de um perfil de segurança do AWS IoT Device Defender.

aws iot update-security-profile \
    --security-profile-name PossibleIssue \
    --security-profile-description "Check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128"  \
    --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"

Saída:

{
    "securityProfileName": "PossibleIssue",
    "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue",
    "securityProfileDescription": "check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128",
    "behaviors": [
        {
            "name": "CellularBandwidth",
            "metric": "aws:message-byte-size",
            "criteria": {
                "comparisonOperator": "greater-than",
                "value": {
                    "count": 128
                },
                "consecutiveDatapointsToAlarm": 1,
                "consecutiveDatapointsToClear": 1
            }
        },
        {
            "name": "Authorization",
            "metric": "aws:num-authorization-failures",
            "criteria": {
                "comparisonOperator": "less-than",
                "value": {
                    "count": 12
                },
                "durationSeconds": 300,
                "consecutiveDatapointsToAlarm": 1,
                "consecutiveDatapointsToClear": 1
            }
        }
    ],
    "version": 2,
    "creationDate": 1560278102.528,
    "lastModifiedDate": 1560352711.207
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-stream.

AWS CLI

Para atualizar um fluxo

O exemplo update-stream a seguir atualiza um fluxo existente. A versão do fluxo será incrementada em um.

aws iot update-stream \
    --cli-input-json file://update-stream.json

Conteúdo de update-stream.json:

{
    "streamId": "stream12345",
    "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
    "files": [
        {
            "fileId": 123,
            "s3Location": {
                "bucket":"codesign-ota-bucket",
                "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6"
            }
        }
    ]
    "roleArn": "arn:aws:iam:us-west-2:123456789012:role/service-role/my_ota_stream_role"
}

Saída:

{
    "streamId": "stream12345",
    "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345",
    "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
    "streamVersion": 2
}

Para obter mais informações, consulte UpdateStream na Referência da API do AWS IoT.

  • Para ver detalhes da API, consulte UpdateStream na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-thing-group.

AWS CLI

Para atualizar a definição de um grupo de itens

O exemplo update-thing-group a seguir atualiza a definição do grupo de itens especificado, alterando a descrição e dois atributos.

aws iot update-thing-group \
    --thing-group-name HalogenBulbs \
    --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"

Saída:

{
    "version": 2
}

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte UpdateThingGroup na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-thing-groups-for-thing.

AWS CLI

Para alterar uma lista de grupos aos quais o item pertence

O exemplo update-thing-groups-for-thing a seguir remove o item chamado MyLightBulb do grupo chamado DeadBulbs e a adiciona ao grupo nomeado replaceableItems ao mesmo tempo.

aws iot update-thing-groups-for-thing \
    --thing-name MyLightBulb \
    --thing-groups-to-add "replaceableItems" \
    --thing-groups-to-remove "DeadBulbs"

Este comando não produz saída.

Para obter mais informações, consulte Grupos de itens no Guia do desenvolvedor do AWS IoT.

O código de exemplo a seguir mostra como usar update-thing.

AWS CLI

Como associar um item a um tipo de item

O exemplo update-thing a seguir associa um item no registro do AWS IoT a um tipo de item. Ao fazer a associação, devem ser fornecidos valores para os atributos definidos pelo tipo de item.

aws iot update-thing \
    --thing-name "MyOtherLightBulb" \
    --thing-type-name "LightBulb" \
    --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}"

Esse comando não produz nenhuma saída. É possível usar o comando describe-thing para exibir o resultado.

Para obter mais informações, consulte Tipos de itens no Guia do desenvolvedor do AWS IoT.

  • Para ver detalhes da API, consulte UpdateThing na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-topic-rule-destination.

AWS CLI

Exemplo 1: habilitar um destino de regra de tópico

O exemplo update-topic-rule-destination a seguir ativa o tráfego para um destino de regra de tópico.

aws iot update-topic-rule-destination \
    --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \
    --status ENABLED

Este comando não produz saída.

Para obter mais informações, consulte Habilitar um destino de regra de tópico no Guia do desenvolvedor do AWS IoT.

Exemplo 2: desativar um destino de regra de tópico

O exemplo update-topic-rule-destination a seguir desativa o tráfego para um destino de regra de tópico.

aws iot update-topic-rule-destination \
    --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \
    --status DISABLED

Este comando não produz saída.

Para obter mais informações, consulte Desativar um destino de regra de tópico no Guia do desenvolvedor do AWS IoT.

Exemplo 3: enviar uma nova mensagem de confirmação

O exemplo update-topic-rule-destination a seguir envia uma nova mensagem de confirmação para um destino de regra de tópico.

aws iot update-topic-rule-destination \
    --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \
    --status IN_PROGRESS

Este comando não produz saída.

Para obter mais informações, consulte Enviar uma nova mensagem de confirmação no Guia do desenvolvedor de AWS IoT.

O código de exemplo a seguir mostra como usar validate-security-profile-behaviors.

AWS CLI

Exemplo 1: validar os parâmetros de comportamento de um perfil de segurança

O exemplo validate-security-profile-behaviors a seguir valida um conjunto bem formado e correto de comportamentos para um perfil de segurança do AWS IoT Device Defender.

aws iot validate-security-profile-behaviors \
    --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"

Saída:

{
    "valid": true,
    "validationErrors": []
}

Exemplo 2: validar os parâmetros de comportamento incorretos de um perfil de segurança

O exemplo validate-security-profile-behaviors a seguir valida um conjunto de comportamentos que contém um erro para um perfil de segurança do AWS IoT Device Defender.

aws iot validate-security-profile-behaviors \
    --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":100000,\"consecutiveDatapointsToClear\":1}}]"

Saída:

{
    "valid": false,
    "validationErrors": [
        {
            "errorMessage": "Behavior Authorization is malformed. consecutiveDatapointsToAlarm 100000 should be in range[1,10]"
        }
    ]
}

Para obter mais informações, consulte Comandos do Detect no Guia do desenvolvedor do AWS IoT.