AWS IoT exemplos usando AWS CLI

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

O accept-certificate-transfer exemplo a seguir aceita um certificado de dispositivo transferido de outra AWS conta. 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.

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

O add-thing-to-billing-group exemplo a seguir adiciona a coisa chamada MyLightBulb ao grupo de cobrança chamadoGroupOne.

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

Este comando não produz saída.

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

O add-thing-to-billing-group exemplo a seguir adiciona uma coisa com um especificado ARN a um grupo de cobrança com o especificadoARN. Especificar um ARN é útil se você trabalha com várias AWS regiões ou contas. Isso pode ajudar a garantir que você esteja adicionando à 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 para desenvolvedores de AWS IoT.

Para adicionar algo a um grupo

O add-thing-to-thing-group exemplo a seguir adiciona a coisa especificada ao grupo de coisas 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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Associar um grupo de coisas a um trabalho contínuo

O associate-targets-with-job exemplo a seguir associa o grupo de coisas 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

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

O attach-policy exemplo a seguir anexa a política especificada a um grupo de coisas identificado por itsARN.

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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Exemplo 2: Para anexar uma política a um certificado

O attach-policy exemplo a seguir anexa a política UpdateDeviceCertPolicy ao principal especificado 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 para desenvolvedores de AWS IoT.

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

O attach-security-profile exemplo a seguir associa o perfil de segurança do AWS IoT Device Defender Testprofile nomeado a todos os dispositivos não registrados us-west-2 na região para essa conta. 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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para anexar um certificado à sua coisa

O attach-thing-principal exemplo a seguir anexa um certificado à MyTemperatureSensor coisa. O certificado é identificado por umARN. Você pode encontrar o ARN para um certificado no console de 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.

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

O cancel-audit-mitigations-action-task exemplo a seguir cancela a aplicação de ações de mitigação para a tarefa especificada. Você não pode cancelar tarefas que já 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 de AWS IoT.

Para cancelar uma tarefa de auditoria

O cancel-audit-task exemplo a seguir cancela uma tarefa de auditoria com o ID de tarefa especificado. Você não pode 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 de AWS IoT.

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

O cancel-certificate-transfer exemplo a seguir cancela a transferência da transferência de certificado especificada. O certificado é identificado por uma ID de certificado. Você pode encontrar a ID de um certificado no console de 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.

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

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

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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para cancelar um trabalho

O cancel-job exemplo 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para limpar o autorizador padrão

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

aws iot clear-default-authorizer

Este comando não produz saída.

Para obter mais informações, consulte ClearDefaultAuthorizera Referência de AWS IoT. API

Para confirmar o destino de uma regra de tópico

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

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 Confirmando o destino de uma regra de tópico no Guia do desenvolvedor de AWS IoT.

Para criar uma supressão da descoberta de auditoria

O create-audit-suppression exemplo a seguir cria uma supressão de constatação 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 Auditoria encontrando supressões no Guia de desenvolvedores de AWS IoT.

Para criar um autorizador personalizado

O create-authorizer exemplo a seguir cria um autorizador personalizado que usa a função 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 CreateAuthorizera Referência de AWS IoT. API

Para criar um grupo de cobrança

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

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 para desenvolvedores de AWS IoT.

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

O create-certificate-from-csr exemplo a seguir cria um certificado de dispositivo a partir de umCSR. Você pode usar o openssl comando para criar umCSR.

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 CreateCertificateFromCSRa Referência de AWS IoT. API

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

O create-custom-metric exemplo 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 criar uma dimensão

O seguinte create-dimension cria uma dimensão com um único filtro de tópico chamadoTopicFilterForAuthMessages.

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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para criar uma configuração de domínio

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

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 de AWS IoT.

Para criar um grupo dinâmico de coisas

O create-dynamic-thing-group exemplo a seguir cria um grupo dinâmico de coisas que contém qualquer coisa com um atributo de temperatura maior que 60 graus. Você deve habilitar a indexação da frota de AWS IoT antes de poder usar grupos dinâmicos de coisas.

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 Dynamic Thing Groups no Guia de desenvolvedores de AWS IoT.

Exemplo 1: Para criar um trabalho

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

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: Para criar um trabalho contínuo

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

aws iot create-job --job-id “example-job-04" --targets “arn:aws:iot:us-west- 2:123456789012: -job.json --description “exemplo de trabalho contínuo” --target-selection thinggroup/DeadBulbs" --document file://example 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para criar um RSA key pair e emitir um certificado X.509

O seguinte create-keys-and-certificate cria um par de chaves de 2048 bits e emite um certificado X.509 usando a RSA chave pública emitida. Como essa é a única vez que a 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 certificado de dispositivo de IoT no Guia do desenvolvedor de AWS IoT.AWS

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

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

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 de AWS IoT.

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

O create-ota-update exemplo a seguir cria uma AWS IoT OTAUpdate em um grupo-alvo de coisas ou grupos. Isso faz parte de uma RTOS over-the-air atualização gratuita da Amazon que possibilita a implantação de novas imagens de firmware em um único dispositivo ou 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 C reateOTAUpdate na Referência de AWS IoT. API

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

O create-policy-version exemplo 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 de AWS IoT no Guia para desenvolvedores de AWS IoT.

Para criar uma política de AWS IoT

O create-policy exemplo a seguir cria uma política AWS de IoT chamada. TemperatureSensorPolicy O policy.json arquivo contém declarações que permitem ações de políticas de 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 de AWS IoT no Guia para desenvolvedores de AWS IoT.

Para criar uma declaração de aprovisionamento

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

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 para desenvolvedores do AWS IoT Core.

Para criar uma versão do modelo de aprovisionamento

O exemplo a seguir cria uma versão para o modelo de aprovisionamento especificado. O corpo da nova versão é fornecido no arquivotemplate.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 IoT Core AWS .

Para criar um modelo de aprovisionamento

O create-provisioning-template exemplo 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 IoT Core AWS .

Para criar um alias de função

O create-role-alias exemplo a seguir cria um alias de função chamado LightBulbRole para a função especificada.

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 CreateRoleAliasa Referência de AWS IoT. API

Para criar uma auditoria agendada

O create-scheduled-audit exemplo 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 expirando.

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 de AWS IoT.

Para criar um perfil de segurança

O create-security-profile exemplo 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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para criar um stream para entregar um ou mais arquivos grandes em partes acima MQTT

O create-stream exemplo a seguir cria um fluxo para entregar um ou mais arquivos grandes em partes. MQTT Um stream transporta bytes de dados em partes ou blocos empacotados como MQTT mensagens de uma fonte 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 CreateStreama Referência de AWS IoT. API

Exemplo 1: Para criar um grupo de coisas

O create-thing-group exemplo a seguir cria um grupo de coisas 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: Para criar um grupo de coisas que faça parte de um grupo principal

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

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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Para definir um tipo de coisa

O create-thing-type exemplo a seguir define um tipo de coisa 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 coisas no Guia AWS para desenvolvedores de IoT.

Exemplo 1: Para criar um registro de coisa no registro

O create-thing exemplo a seguir cria uma entrada para um dispositivo no registro de coisas da 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: Para definir uma coisa associada a um tipo de coisa

O create-thing exemplo a seguir cria uma coisa que tem o tipo de coisa especificado e seus atributos.

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 coisas com o registro e os tipos de coisas no Guia AWS para desenvolvedores de IoT.

Para criar um destino de regra de tópico

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

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 Criação de um destino de regra de tópico no Guia do desenvolvedor de AWS IoT.

Para criar uma regra que envie um SNS alerta da Amazon

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

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

O exemplo exige que o JSON código a seguir seja salvo em um arquivo chamadoplant-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 Criação de uma regra de AWS IoT no Guia para desenvolvedores de AWS IoT.

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

O delete-account-audit-configuration exemplo 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 de AWS IoT.

Para excluir uma supressão de descoberta de auditoria

O delete-audit-suppression exemplo a seguir exclui uma supressão de constatação 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 Auditoria encontrando supressões no Guia de desenvolvedores de AWS IoT.

Para excluir um autorizador personalizado

O delete-authorizer exemplo a seguir exclui o autorizador chamado. CustomAuthorizer Um autorizador personalizado deve estar no INACTIVE estado antes que você possa excluí-lo.

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

Este comando não produz saída.

Para obter mais informações, consulte o DeleteAuthorizerGuia do desenvolvedor de AWS IoT.

Para excluir um grupo de cobrança

O delete-billing-group exemplo a seguir exclui o grupo de cobrança especificado. Você pode excluir um grupo de cobrança mesmo que ele contenha uma ou mais coisas.

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 para desenvolvedores de AWS IoT.

Para excluir um certificado CA

O delete-ca-certificate exemplo 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 D eleteCACertificate na Referência de AWS IoT. API

Para excluir um certificado de dispositivo

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

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

Este comando não produz saída.

Para obter mais informações, consulte DeleteCertificatea Referência de AWS IoT. API

Para excluir uma métrica personalizada

O delete-custom-metric exemplo 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 excluir uma dimensão

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

aws iot delete-dimension \
    --name TopicFilterForAuthMessages

Este comando não produz saída.

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

Para excluir uma configuração de domínio

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

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 de AWS IoT.

Para excluir um grupo dinâmico de coisas

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

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

Este comando não produz saída.

Para obter mais informações, consulte Dynamic Thing Groups no Guia de desenvolvedores de AWS IoT.

Para excluir uma execução de trabalho

O delete-job-execution exemplo 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para excluir um trabalho

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

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

Este comando não produz saída.

Para obter mais informações, consulte Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

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

O delete-mitigation-action exemplo 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 de AWS IoT.

Para excluir uma OTA atualização

O delete-ota-update exemplo a seguir exclui a OTA atualização 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 D eleteOTAUpdate na Referência de AWS IoT. API

Para excluir uma versão da política

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

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 de AWS IoT no Guia do desenvolvedor de AWS IoT.

Como excluir uma política

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

aws iot delete-policy --policy-name UpdateDeviceCertPolicy

Este comando não produz saída.

Para obter mais informações, consulte Políticas de AWS IoT no Guia para desenvolvedores de AWS IoT.

Para excluir uma versão do modelo de aprovisionamento

O delete-provisioning-template-version exemplo a seguir exclui a versão 2 do modelo de aprovisionamento 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 IoT Core AWS .

Para excluir um modelo de aprovisionamento

O delete-provisioning-template exemplo a seguir exclui o modelo de aprovisionamento 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 IoT Core AWS .

Para excluir seu código de registro

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

aws iot delete-registration-code

Este comando não produz saída.

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

Para excluir um alias de AWS função de IoT

O delete-role-alias exemplo a seguir exclui um alias de função de 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 Autorização de chamadas diretas para AWS serviços no Guia do desenvolvedor de AWS IoT.

Para excluir uma auditoria agendada

O delete-scheduled-audit exemplo 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 de AWS IoT.

Para excluir um perfil de segurança

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

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

Este comando não produz saída.

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

Para excluir um stream

O delete-stream exemplo 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 DeleteStreama Referência de AWS IoT. API

Para excluir um grupo de coisas

O delete-thing-group exemplo a seguir exclui o grupo de coisas especificado. Você não pode excluir um grupo de coisas se ele contiver grupos de coisas secundárias.

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

Este comando não produz saída.

Para obter mais informações, consulte Thing Groups no Guia AWS para desenvolvedores de IoT.

Exemplo 1: Para excluir um tipo de coisa

O delete-thing-type exemplo 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 coisas no Guia AWS para desenvolvedores de IoT.

Para exibir informações detalhadas sobre uma coisa

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

era 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 excluir um destino de regra de tópico

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

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 Excluindo um destino de regra de tópico no Guia do desenvolvedor de AWS IoT.

Para excluir uma regra

O delete-topic-rule exemplo 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 Excluindo uma regra no Guia para desenvolvedores de AWS IoT.

Para excluir o nível de registro de um grupo de coisas

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

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

Este comando não produz saída.

Exemplo 1: Para descontinuar um tipo de coisa

O deprecate-thing-type exemplo a seguir desaprova um tipo de coisa para que os usuários não possam associar nenhuma coisa nova a ela.

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

Este comando não produz saída.

Exemplo 2: Para reverter a depreciação de um tipo de coisa

O deprecate-thing-type exemplo a seguir reverte a suspensão de uso de um tipo de item, o que possibilita que os usuários associem coisas novas a ele novamente.

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 coisas no Guia AWS para desenvolvedores de IoT.

Para visualizar as configurações de auditoria atuais

O describe-account-audit-configuration exemplo a seguir lista as configurações atuais da sua configuração de auditoria AWS do 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 de AWS IoT.

Para listar detalhes de uma descoberta de auditoria

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

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 auditoria (comandos de auditoria) no Guia do desenvolvedor de AWS IoT.

Para mostrar os detalhes de uma tarefa de ações de mitigação de auditoria

O describe-audit-mitigation-actions-task exemplo a seguir mostra os detalhes da tarefa especificada, na qual o ResetPolicyVersionAction foi aplicado a uma descoberta. Os resultados incluem quando a tarefa começou e terminou, quantas descobertas foram direcionadas (e o 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 de AWS IoT.

Para obter detalhes sobre a supressão de uma descoberta de auditoria

O describe-audit-suppression exemplo 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 Auditoria encontrando supressões no Guia de desenvolvedores de AWS IoT.

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

O describe-audit-task exemplo 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 de AWS IoT.

Para obter informações sobre um autorizador personalizado

O describe-authorizer exemplo a seguir exibe 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 DescribeAuthorizera Referência de AWS IoT. API

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

O describe-billing-group exemplo a seguir obtém informações para 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 para desenvolvedores de AWS IoT.

Para obter detalhes sobre um certificado CA

O describe-ca-certificate exemplo 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 D escribeCACertificate na Referência de AWS IoT. API

Para obter informações sobre um certificado

O describe-certificate exemplo 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 DescribeCertificatea Referência de AWS IoT. API

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

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

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.

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

O describe-default-authorizer exemplo a seguir exibe 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 DescribeDefaultAuthorizera Referência de AWS IoT. API

Para obter informações sobre uma dimensão

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

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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para descrever uma configuração de domínio

O describe-domain-configuration exemplo a seguir exibe 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 de AWS IoT.

Exemplo 1: Para obter seu AWS endpoint atual

O describe-endpoint exemplo a seguir recupera o AWS endpoint padrão 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 o DescribeEndpointGuia do desenvolvedor de AWS IoT.

Exemplo 2: Para obter seu ATS endpoint

O describe-endpoint exemplo a seguir recupera o endpoint 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 Certificados X.509 e IoT AWS no Guia do desenvolvedor de AWS IoT.

Para mostrar quais tipos de eventos são publicados

O describe-event-configurations exemplo a seguir lista a configuração que controla quais eventos são gerados quando algo é 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 eventos no Guia do desenvolvedor de AWS IoT.

Para recuperar o status atual do índice da coisa

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

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 Managing Thing Indexing no Guia do desenvolvedor de AWS IoT.

Para obter detalhes de execução de um trabalho em um dispositivo

O describe-job-execution exemplo a seguir obtém detalhes de execução para o 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para obter o status detalhado de um trabalho

O describe-job exemplo 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para ver os detalhes de uma ação de mitigação definida

O describe-mitigation-action exemplo a seguir exibe 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 de AWS IoT.

Para descrever uma versão do modelo de aprovisionamento

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

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 Como provisionar dispositivos que não têm certificados de dispositivo usando o provisionamento de frota no Guia de desenvolvedores do IoT Core AWS .

Para descrever um modelo de provisionamento

O describe-provisioning-template exemplo 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 Como provisionar dispositivos que não têm certificados de dispositivo usando o provisionamento de frota no Guia de desenvolvedores do IoT Core AWS .

Para obter informações sobre um alias de função de AWS IoT

O describe-role-alias exemplo a seguir exibe detalhes do alias de função 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 DescribeRoleAliasa Referência de AWS IoT. API

Para obter informações sobre uma auditoria agendada

O describe-scheduled-audit exemplo a seguir obtém informações detalhadas sobre uma auditoria agendada AWS IOT do Device Defender chamadaAWSIoTDeviceDefenderDailyAudit.

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 de AWS IoT.

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

O describe-security-profile exemplo 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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para obter informações sobre um stream

O describe-stream exemplo a seguir exibe os detalhes sobre o 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 DescribeStreama Referência de AWS IoT. API

Para obter informações sobre um grupo de coisas

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

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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Para obter informações sobre um tipo de coisa

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

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 coisas no Guia AWS para desenvolvedores de IoT.

Para exibir informações detalhadas sobre uma coisa

O describe-thing exemplo a seguir exibe informações sobre uma coisa (dispositivo) definida no registro de AWS IoT da sua AWS conta.

como descrever a coisa --nome da coisa” 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.

Exemplo 1: Para separar uma política de AWS IoT de um grupo de coisas

O detach-policy exemplo a seguir separa a política especificada de um grupo de coisas e, por extensão, de todas as coisas desse grupo e de qualquer um dos grupos secundários do grupo.

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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Exemplo 2: Para separar uma política de AWS IoT de um certificado de dispositivo

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

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 desassociar um perfil de segurança de um alvo

O detach-security-profile exemplo a seguir remove a associação entre o Testprofile nome do perfil de segurança do AWS IoT Device Defender e o alvo de todas as coisas registradas.

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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para separar um certificado/diretor de uma coisa

O detach-thing-principal exemplo a seguir remove um certificado que representa um principal da coisa especificada.

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.

Para desativar uma regra de tópico

O disable-topic-rule exemplo a seguir desativa 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 Visualizando suas regras no Guia do desenvolvedor de AWS IoT.

Para habilitar uma regra de tópico

O enable-topic-rule exemplo 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 Visualizando suas regras no Guia do desenvolvedor de AWS IoT.

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

O get-behavior-model-training-summaries exemplo a seguir lista o status de treinamento do 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 (Detectar comandos) no Guia do desenvolvedor de AWS IoT.

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

Você pode usar o script de configuração a seguir para criar 10 itens representando 10 sensores de temperatura. Cada coisa nova 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 get-cardinality exemplo 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 Consultando dados agregados< https://docs.aws.amazon.com/iot/ latest/developerguide/index -aggregate.html> no Guia do desenvolvedor de IoT.AWS

Para listar as políticas que afetam algo

O get-effective-policies exemplo a seguir lista as políticas que afetam a coisa especificada, incluindo políticas anexadas a qualquer grupo ao qual ela 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 Obtenha políticas eficazes para uma coisa no Guia para desenvolvedores de AWS IoT.

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

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

aws iot get-indexing-configuration

Saída:

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

Para obter mais informações, consulte Managing Thing Indexing no Guia de desenvolvedores de AWS IoT.

Para recuperar o documento para um trabalho

O get-job-document exemplo 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para obter as opções de registro

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

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 de AWS IoT.

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

O get-ota-update exemplo a seguir exibe detalhes sobre a OTA atualização 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 G etOTAUpdate na Referência de AWS IoT. API

Para agrupar os valores agregados que correspondem à consulta em agrupamentos de percentis

Você pode usar o script de configuração a seguir para criar 10 itens representando 10 sensores de temperatura. Cada coisa nova 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 get-percentiles exemplo 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 do campo agregado que ocorre em aproximadamente 10% 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 Consultando dados agregados no Guia do desenvolvedor de AWS IoT.

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

O get-policy-version exemplo 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 de AWS IoT no Guia para desenvolvedores de AWS IoT.

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

O get-policy exemplo a seguir recupera 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 de AWS IoT no Guia para desenvolvedores de AWS IoT.

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

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

aws iot get-registration-code

Saída:

{
    "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c"
}

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

Para pesquisar dados agregados no índice do dispositivo

O get-statistics exemplo a seguir retorna o número de itens que têm uma propriedade chamada connectivity.connected set to false (ou seja, o número de dispositivos 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 Como obter estatísticas sobre sua frota de dispositivos no Guia do desenvolvedor de AWS IoT.

Para obter um destino de regra de tópico

O get-topic-rule-destination exemplo a seguir obtém informações sobre o destino de uma 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 Como trabalhar com destinos de regras de tópicos no Guia do desenvolvedor de AWS IoT.

Para obter informações sobre uma regra

O get-topic-rule exemplo a seguir obtém 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 suas regras no Guia AWS para desenvolvedores de IoT.

Para listar as opções de registro atuais

O get-v2-logging-options exemplo a seguir lista as opções de registro atuais para 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 de AWS IoT.

Para listar as violações ativas

O list-active-violations exemplo 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
        }
    ]
}

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

O list-attached-policies exemplo 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 Thing Groups no Guia AWS para desenvolvedores de IoT.

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

O list-attached-policies exemplo a seguir lista as políticas de AWS IoT anexadas ao certificado do dispositivo. O certificado é identificado por seuARN.

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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Exemplo 1: Para listar todas as descobertas de uma auditoria

O list-audit-findings exemplo 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: Para listar as descobertas de um tipo de verificação de auditoria

O list-audit-findings exemplo a seguir mostra os resultados das auditorias do AWS IoT Device Defender realizadas entre 5 de junho de 2019 e 19 de junho de 2019, nas quais os dispositivos estão compartilhando um certificado de dispositivo. Ao especificar um nome de verificação, você deve 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 de AWS IoT.

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 IoT Device AWS Defender. O list-audit-mitigation-actions-executions exemplo a seguir lista os detalhes da tarefa de ação de mitigação com a descoberta especificada taskId e especificada.

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 de AWS IoT.

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

O list-audit-mitigation-actions-tasks exemplo 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 de AWS IoT.

Para listar todas as supressões de descobertas de auditoria

O list-audit-suppressions exemplo a seguir lista todas as supressões ativas 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 Auditoria encontrando supressões no Guia de desenvolvedores de AWS IoT.

Para listar todas as descobertas de uma auditoria

O list-audit-tasks exemplo 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 de AWS IoT.

Para listar seu autorizador personalizado

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

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 ListAuthorizersa Referência de AWS IoT. API

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

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

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 para desenvolvedores de AWS IoT.

Para listar os certificados CA registrados em sua AWS conta

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

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 Use seu próprio certificado no Guia do desenvolvedor de AWS IoT.

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

O list-certificates-by-ca exemplo a seguir lista todos os certificados de dispositivo em sua AWS conta 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 de AWS IoT. API

Exemplo 1: Para listar os certificados registrados em sua AWS conta

O list-certificates exemplo a seguir lista todos os certificados registrados em sua conta. Se você tiver mais do que o limite de paginação padrão de 25, poderá usar o valor de nextMarker resposta 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 listar suas métricas personalizadas

O list-custom-metrics exemplo 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 listar as dimensões da sua AWS conta

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

aws iot list-dimensions

Saída:

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

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

Para listar as configurações de domínio

O list-domain-configurations exemplo a seguir lista as configurações de domínio em sua AWS conta 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 de AWS IoT.

Para listar os índices de pesquisa configurados

O list-indices exemplo a seguir lista todos os índices de pesquisa configurados em sua AWS conta. Se você não ativou a indexação de coisas, talvez não tenha nenhum índice.

aws iot list-indices

Saída:

{
    "indexNames": [
        "AWS_Things"
    ]
}

Para obter mais informações, consulte Managing Thing Indexing no Guia do desenvolvedor de AWS IoT.

Para listar os trabalhos em sua AWS conta

O list-job-executions-for-job exemplo a seguir lista todas as execuções de um trabalho em sua AWS conta, especificado pelojobId.

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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para listar os trabalhos que foram executados para uma coisa

O list-job-executions-for-thing exemplo a seguir lista todos os trabalhos que foram executados para a coisa chamadaMyRaspberryPi.

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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

Para listar os trabalhos em sua AWS conta

O list-jobs exemplo a seguir lista todos os trabalhos em sua AWS conta, 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

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

O list-mitigation-actions exemplo a seguir lista todas as ações de mitigação definidas para sua AWS conta e região. Para cada ação, o nome e ARN 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 de AWS IoT.

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

O list-mitigations-actions exemplo a seguir lista todas as ações de mitigação definidas para sua AWS conta e região. Para cada ação, o nome e ARN 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 de AWS IoT.

Para listar OTA as atualizações da conta

O list-ota-updates exemplo a seguir lista as OTA atualizações 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 L istOTAUpdates na Referência de AWS IoT. API

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

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

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 ListOutgoingCertificatesa Referência de AWS IoT. API

Para listar as políticas definidas em sua AWS conta

O list-policies exemplo a seguir lista todas as políticas definidas em sua AWS conta.

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 de AWS IoT no Guia para desenvolvedores de AWS IoT.

Exemplo 1: Para ver todas as versões de uma política

O list-policy-versions exemplo 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 de AWS IoT no Guia para desenvolvedores de AWS IoT.

Para listar as coisas anexadas a um diretor

O list-principal-things exemplo a seguir lista as coisas anexadas ao principal especificado por umARN.

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 ListPrincipalThingsa Referência de AWS IoT. API

Para listar as versões do modelo de aprovisionamento

O list-provisioning-template-versions exemplo a seguir lista as versões disponíveis do modelo de aprovisionamento 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 IoT Core AWS .

Para listar modelos de provisionamento

O list-provisioning-templates exemplo a seguir lista todos os modelos de provisionamento em sua AWS conta.

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 IoT Core AWS .

Para listar os aliases da função de AWS IoT em sua conta AWS

O list-role-aliases exemplo a seguir lista os aliases da função de AWS IoT em sua conta. AWS

aws iot list-role-aliases

Saída:

{
    "roleAliases": [
        "ResidentAlias",
        "ElectricianAlias"
    ]
}

Para obter mais informações, consulte ListRoleAliasesa Referência de AWS IoT. API

Para listar as auditorias agendadas para sua conta AWS

O list-scheduled-audits exemplo a seguir lista todas as auditorias agendadas para sua AWS conta.

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 de AWS IoT.

Para listar os perfis de segurança anexados a um alvo

O list-security-profiles-for-target exemplo 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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para listar os perfis de segurança da sua AWS conta

O list-security-profiles exemplo a seguir lista todos os perfis de segurança do AWS IoT Device Defender definidos na AWS sua conta.

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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para listar os streams na conta

O list-streams exemplo a seguir lista todos os streams em sua AWS conta.

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 ListStreamsa Referência de AWS IoT. API

Para exibir as tags e seus valores associados a um recurso

O list-tags-for-resource exemplo a seguir exibe as tags e os valores associados ao grupo de coisasLightBulbs.

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 Como marcar seus recursos de AWS IoT no Guia do desenvolvedor de AWS IoT.

Para listar os principais associados a uma política de AWS IoT

O list-targets-for-policy exemplo 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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Para listar os alvos aos quais um perfil de segurança é aplicado

O list-targets-for-security-profile exemplo a seguir lista os alvos aos quais o PossibleIssue nome do perfil de segurança AWS IoT Device Defender é 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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para listar os grupos aos quais uma coisa pertence

O list-thing-groups-for-thing exemplo a seguir lista os grupos aos quais a coisa especificada 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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Para listar os grupos de coisas definidos em sua AWS conta

O describe-thing-group exemplo a seguir lista todos os grupos de itens definidos em sua AWS conta.

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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Para listar os princípios associados a uma coisa

O list-thing-principals exemplo a seguir lista os principais (certificados X.509, IAM usuários, grupos, funções, identidades do Amazon Cognito ou identidades federadas) associados à coisa especificada.

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 ListThingPrincipalsa Referência de AWS IoT. API

Para listar os tipos de coisas definidos

O list-thing-types exemplo a seguir exibe uma lista dos tipos de itens definidos em sua AWS conta.

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 coisas no Guia AWS para desenvolvedores de IoT.

Para listar os itens em um grupo de cobrança

O list-things-in-billing-group exemplo a seguir lista os itens que estão 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 para desenvolvedores de AWS IoT.

Para listar as coisas que pertencem a um grupo

O list-things-in-thing-group exemplo a seguir lista as coisas que pertencem ao grupo de coisas especificado.

aws iot list-things-in-thing-group \
    --thing-group-name LightBulbs

Saída:

{
    "things": [
        "MyLightBulb"
    ]
}

Para obter mais informações, consulte Thing Groups no Guia AWS para desenvolvedores de IoT.

Exemplo 1: como listar todas os itens do registro

O list-things exemplo a seguir lista as coisas (dispositivos) definidas no registro de AWS IoT da sua AWS conta.

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 listar seus destinos de regras de tópicos

O list-topic-rule-destinations exemplo a seguir lista todos os destinos de regras de tópico que você definiu na AWS região 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 Como trabalhar com destinos de regras de tópicos no Guia do desenvolvedor de AWS IoT.

Para listar suas regras

O list-topic-rules exemplo a seguir lista todas as regras que você definiu.

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 suas regras no Guia AWS para desenvolvedores de IoT.

Para listar os níveis de registro

O list-v2-logging-levels exemplo a seguir lista os níveis de registro configurados. Se os níveis de registro não foram definidos, um NotConfiguredException ocorre quando você executa esse comando.

aws iot list-v2-logging-levels

Saída:

{
    "logTargetConfigurations": [
        {
            "logTarget": {
                "targetType": "DEFAULT"
            },
            "logLevel": "ERROR"
        }
    ]
}

Para listar as violações do perfil de segurança durante um período

O list-violation-events exemplo 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 AWS atual AWS e da região.

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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para registrar um certificado de autoridade de certificação (CA)

O register-ca-certificate exemplo a seguir registra um certificado CA. O comando fornece o certificado CA e um certificado de verificação de chave que prova que você possui a 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 R egisterCACertificate na Referência de AWS IoT. API

Para registrar um certificado de dispositivo autoassinado

O register-certificate exemplo a seguir registra o certificado do deviceCert.pem dispositivo assinado pelo certificado rootCA.pem CA. 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 que você passa 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 RegisterCertificatea Referência de AWS IoT. API

Para registrar uma coisa

O register-thing exemplo a seguir registra uma coisa 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 para desenvolvedores do AWS IoT Core.

Para rejeitar uma transferência de certificado

O reject-certificate-transfer exemplo a seguir rejeita a transferência do certificado do dispositivo especificado de outra AWS conta.

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.

Para remover algo de um grupo de cobrança

O remove-thing-from-billing-group exemplo a seguir remove o item especificado 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 para desenvolvedores de AWS IoT.

Para remover uma coisa de um grupo de coisas

O remove-thing-from-thing-group exemplo a seguir remove a coisa especificada de um grupo de coisas.

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 Thing Groups < https://docs.aws.amazon.com/iot/ latest/developerguide/thing -groups.html > no Guia do desenvolvedor de AWS IoT.

Para atualizar a definição de regra de um tópico

O replace-topic-rule exemplo a seguir atualiza a regra especificada para enviar um SNS alerta 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 Criação de uma regra de AWS IoT no Guia do desenvolvedor de AWS IoT.

Para consultar o índice da coisa

O search-index exemplo a seguir consulta o AWS_Things índice em busca de itens que têm um tipo deLightBulb.

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 Managing Thing Indexing no Guia do desenvolvedor de AWS IoT.

Para definir um autorizador padrão

O set-default-authorizer exemplo a seguir define o autorizador personalizado nomeado 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 CreateDefaultAuthorizera Referência de AWS IoT. API

Para definir a versão padrão de uma política

O set-default-policy-version exemplo a seguir define a versão padrão 2 para a política chamadaUpdateDeviceCertPolicy.

aws iot set-default-policy-version \
    --policy-name UpdateDeviceCertPolicy \
    --policy-version-id 2

Este comando não produz saída.

Para definir o nível de registro para um grupo de coisas

O set-v2-logging-level exemplo a seguir define o nível de registro para registrar avisos para o grupo de coisas 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 definir as opções de registro

O set-v2-logging-options exemplo a seguir define o nível de verbosidade de registro padrão como ERROR e especifica o a ARN ser usado para 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.

Aplicar uma ação de mitigação às conclusões de uma auditoria

O start-audit-mitigation-actions-task exemplo a seguir aplica a ResetPolicyVersionAction ação (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 de AWS IoT.

Para iniciar uma auditoria imediatamente

O start-on-demand-audit-task exemplo a seguir inicia uma auditoria AWS do 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 de AWS IoT.

Para especificar uma tag, chave e valor para um recurso

O tag-resource exemplo a seguir aplica a tag com uma chave Assembly e o valor Fact1NW ao grupo de coisasLightBulbs.

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 Como marcar seus recursos de AWS IoT no Guia do desenvolvedor de AWS IoT.

Para testar suas políticas AWS de IoT

O test-authorization exemplo a seguir testa as políticas de AWS IoT associadas ao principal especificado.

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 TestAuthorizationa Referência de AWS IoT. API

Para testar seu autorizador personalizado

O test-invoke-authorizer exemplo 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 TestInvokeAuthorizera Referência de AWS IoT. API

Para transferir um certificado de dispositivo para uma AWS conta diferente

O transfer-certificate exemplo a seguir transfere um certificado de dispositivo para outra AWS conta. O certificado e a AWS conta 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 remover uma chave de tag de um recurso

O untag-resource exemplo a seguir remove a tag MyTag e seu valor do grupo de coisasLightBulbs.

command

Este comando não produz saída.

Para obter mais informações, consulte Como marcar seus recursos de AWS IoT no Guia do desenvolvedor de AWS IoT.

Exemplo 1: Para ativar as SNS notificações da Amazon para notificações de auditoria

O update-account-audit-configuration exemplo a seguir habilita SNS as notificações da Amazon para notificações de auditoria do AWS IoT Device Defender, especificando um alvo e a função usada para gravar nesse alvo.

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: Para habilitar uma verificação de auditoria

O update-account-audit-configuration exemplo a seguir ativa a verificação AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK de auditoria do AWS IoT Device Defender chamada. Você não pode desativar uma verificação de auditoria se ela fizer parte de targetCheckNames uma ou mais auditorias agendadas para a AWS conta.

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 de AWS IoT.

Para atualizar a supressão de uma descoberta de auditoria

O update-audit-suppression exemplo a seguir atualiza a data de expiração da supressão da constatação de auditoria para 2020-09-21.

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 Auditoria encontrando supressões no Guia de desenvolvedores de AWS IoT.

Para atualizar um autorizador personalizado

O update-authorizer exemplo a seguir é o estado CustomAuthorizer2 de doisINACTIVE.

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 UpdateAuthorizera Referência de AWS IoT. API

Para atualizar as informações sobre um grupo de cobrança

O update-billing-group exemplo 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 para desenvolvedores de AWS IoT.

Para atualizar um certificado de autoridade de certificação (CA)

O update-ca-certificate exemplo a seguir define o certificado CA especificado como ACTIVE status.

aws iot update-ca-certificate \
    --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 \
    --new-status ACTIVE

Este comando não produz saída.

Para obter mais informações, consulte U pdateCACertificate na Referência de AWS IoT. API

Para atualizar um certificado de dispositivo

O update-certificate exemplo a seguir define o certificado do dispositivo especificado como INACTIVE status.

aws iot update-certificate \
    --certificate-id d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be \
    --new-status INACTIVE

Este comando não produz saída.

Para obter mais informações, consulte UpdateCertificatea Referência de AWS IoT. API

Para atualizar uma métrica personalizada

O update-custom-metric exemplo a seguir atualiza uma métrica personalizada para ter uma novadisplay-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 atualizar uma dimensão

O update-dimension exemplo 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 atualizar uma configuração de domínio

O update-domain-configuration exemplo a seguir desativa 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 de AWS IoT.

Para atualizar um grupo dinâmico de coisas

O update-dynamic-thing-group exemplo a seguir atualiza o grupo dinâmico de coisas 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 Dynamic Thing Groups no Guia de desenvolvedores de AWS IoT.

Para mostrar quais tipos de eventos são publicados

O update-event-configurations exemplo 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 eventos no Guia do desenvolvedor de AWS IoT.

Para habilitar a indexação de coisas

O update-indexing-configuration exemplo a seguir permite que a indexação de coisas ofereça suporte à pesquisa de dados de registro, dados de sombra e status de conectividade de AWS coisas usando o índice _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 Managing Thing Indexing no Guia de desenvolvedores de AWS IoT.

Para obter o status detalhado de um trabalho

O update-job exemplo 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 Criação e gerenciamento de trabalhos (CLI) no Guia do desenvolvedor de AWS IoT.

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

O update-mitigation-action exemplo a seguir atualiza a ação de mitigação especificada chamadaAddThingsToQuarantineGroupAction, altera o nome do grupo de coisas e define overrideDynamicGroups como. false Você pode verificar suas alterações usando o describe-mitigation-action comando.

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 de AWS IoT.

Para atualizar um modelo de aprovisionamento

O update-provisioning-template exemplo a seguir modifica a descrição e a função 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 IoT Core AWS .

Para atualizar um alias de função

O update-role-alias exemplo a seguir atualiza o alias da LightBulbRole função.

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 UpdateRoleAliasa Referência de AWS IoT. API

Para atualizar uma definição de auditoria agendada

O update-scheduled-audit exemplo a seguir altera os nomes das verificações de destino para uma auditoria agendada AWS do 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 de AWS IoT.

Para alterar um perfil de segurança

O update-security-profile exemplo a seguir atualiza a descrição e os comportamentos de um perfil de segurança AWS do 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 Detectar comandos no Guia do desenvolvedor de AWS IoT.

Para atualizar um stream

O update-stream exemplo a seguir atualiza um stream existente. A versão do stream é 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 UpdateStreama Referência de AWS IoT. API

Para atualizar a definição de um grupo de coisas

O update-thing-group exemplo a seguir atualiza a definição do grupo de coisas 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 Thing Groups no Guia AWS para desenvolvedores de IoT.

Para mudar os grupos aos quais uma coisa pertence

O update-thing-groups-for-thing exemplo a seguir remove a coisa nomeada MyLightBulb do grupo nomeado DeadBulbs e a adiciona ao grupo nomeado ao replaceableItems 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 Thing Groups no Guia do desenvolvedor de AWS IoT.

Para associar uma coisa a um tipo de coisa

O update-thing exemplo a seguir associa uma coisa no registro de AWS IoT a um tipo de coisa. Ao fazer a associação, você fornece valores para os atributos definidos pelo tipo de coisa.