AWS IoT ejemplos que utilizan AWS CLI

Para aceptar un certificado de dispositivo transferido desde una AWS cuenta diferente

El siguiente accept-certificate-transfer ejemplo acepta un certificado de dispositivo transferido desde otra AWS cuenta. El certificado se identifica por su ID.

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

Este comando no produce ninguna salida.

Para obtener más información, consulte Transferir un certificado a otra cuenta en la Guía para desarrolladores de AWS IoT Core.

Ejemplo 1: Para añadir algo por su nombre a un grupo de facturación

En el siguiente add-thing-to-billing-group ejemplo, se agrega el elemento denominado MyLightBulb al grupo de facturación denominadoGroupOne.

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

Este comando no genera ninguna salida.

Ejemplo 2: Para añadir una cosa ARN a un grupo de facturación

En el siguiente add-thing-to-billing-group ejemplo, se agrega un elemento con un valor especificado ARN a un grupo de facturación con el valor especificadoARN. Especificar un ARN es útil si trabaja con varias AWS regiones o cuentas. Te ayudará a asegurarte de que estás añadiendo la región y la cuenta correctas.

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 no genera ninguna salida.

Para obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para añadir algo a un grupo

En el siguiente add-thing-to-thing-group ejemplo, se agrega el elemento especificado al grupo de elementos especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Para asociar un grupo de cosas a una tarea continua

El siguiente associate-targets-with-job ejemplo asocia el grupo de cosas especificado al trabajo continuo especificado.

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

Salida:

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

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para adjuntar una política a un grupo de cosas

En el siguiente attach-policy ejemplo, se adjunta la política especificada a un grupo de cosas identificado por suARN.

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

Este comando no produce ninguna salida.

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Ejemplo 2: Para adjuntar una política a un certificado

En el siguiente attach-policy ejemplo, se adjunta la política UpdateDeviceCertPolicy al principal especificado en un certificado.

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

Este comando no produce ninguna salida.

Para obtener más información, consulte Adjuntar una política de AWS IoT a un certificado de dispositivo en la Guía para desarrolladores de AWS IoT.

Para asociar un perfil de seguridad a todos los dispositivos no registrados

El siguiente attach-security-profile ejemplo asocia el perfil de seguridad de AWS IoT Device Defender nombrado Testprofile con todos los dispositivos no registrados de la us-west-2 región de esta AWS cuenta.

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 no genera ninguna salida.

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para adjuntar un certificado a tu cosa

En el siguiente attach-thing-principal ejemplo, se adjunta un certificado a la MyTemperatureSensor cosa. El certificado se identifica mediante unARN. Puede encontrar el certificado ARN para obtener un certificado en la consola de AWS IoT.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Administración de objetos con el registro en la Guía para desarrolladores de AWS IoT.

Para cancelar una tarea de auditoría (acciones de mitigación)

El siguiente cancel-audit-mitigations-action-task ejemplo cancela la aplicación de las acciones de mitigación para la tarea especificada. No puede cancelar las tareas que ya se han completado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte CancelAuditMitigationActionsTask (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para cancelar una tarea de auditoría

El siguiente cancel-audit-task ejemplo cancela una tarea de auditoría con el identificador de tarea especificado. No puede cancelar una tarea que esté completa.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para cancelar la transferencia de un certificado a otra AWS cuenta

El siguiente cancel-certificate-transfer ejemplo cancela la transferencia de la transferencia de certificado especificada. El certificado se identifica mediante un identificador de certificado. Puedes encontrar el ID de un certificado en la consola de AWS IoT.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Transferir un certificado a otra cuenta en la Guía para desarrolladores de AWS IoT Core.

Para cancelar la ejecución de un trabajo en un dispositivo

El siguiente cancel-job-execution ejemplo cancela la ejecución del trabajo especificado en un dispositivo. Si el trabajo no está en ese QUEUED estado, debe añadir el --force parámetro.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para cancelar un trabajo

El siguiente cancel-job ejemplo cancela el trabajo especificado.

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

Salida:

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

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para borrar el autorizador predeterminado

El siguiente clear-default-authorizer ejemplo borra el autorizador personalizado predeterminado configurado actualmente. Tras ejecutar este comando, no hay ningún autorizador predeterminado. Al utilizar un autorizador personalizado, debe especificarlo por su nombre en los encabezados de las HTTP solicitudes.

aws iot clear-default-authorizer

Este comando no genera ninguna salida.

Para obtener más información, consulte ClearDefaultAuthorizerla APIReferencia de AWS IoT.

Para confirmar el destino de una regla temática

El siguiente confirm-topic-rule-destination ejemplo confirma el destino de una regla temática con un token de confirmación recibido en un HTTP punto final.

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 no genera ninguna salida.

Para obtener más información, consulte Confirmación del destino de una regla temática en la Guía para desarrolladores de AWS IoT.

Para crear una supresión de los resultados de una auditoría

En el siguiente create-audit-suppression ejemplo, se suprime un hallazgo de auditoría para una política denominada virtualMachinePolicy «» que se ha marcado por ser demasiado permisiva.

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 no genera ninguna salida.

Para obtener más información, consulte las supresiones de detección de auditorías en la Guía para desarrolladores de AWS IoT.

Para crear un autorizador personalizado

En el siguiente create-authorizer ejemplo, se crea un autorizador personalizado que utiliza la función Lambda especificada como parte de un servicio de autenticación 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-----"

Salida:

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

Para obtener más información, consulte CreateAuthorizerla APIReferencia de AWS IoT.

Para crear un grupo de facturación

En el siguiente create-billing-group ejemplo, se crea un grupo de facturación sencillo denominadoGroupOne.

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

Salida:

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

Para obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para crear un certificado de dispositivo a partir de una solicitud de firma de certificado (CSR)

En el siguiente create-certificate-from-csr ejemplo, se crea un certificado de dispositivo a partir de unCSR. Puede usar el openssl comando para crear unCSR.

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

Salida:

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

Para obtener más información, consulte CreateCertificateFromCSRla APIReferencia de AWS IoT.

Para crear una métrica personalizada publicada por sus dispositivos en Device Defender

En el siguiente create-custom-metric ejemplo, se crea una métrica personalizada que mide el porcentaje de batería.

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"

Salida:

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

Para obtener más información, consulte Métricas personalizadas en la Guía para desarrolladores de AWS IoT Core.

Para crear una dimensión

A continuación, se create-dimension crea una dimensión con un único filtro de tema denominadoTopicFilterForAuthMessages.

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

Salida:

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

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para crear una configuración de dominio

El siguiente create-domain-configuration ejemplo crea una configuración AWS de dominio administrado con un tipo de servicio deDATA.

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

Salida:

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

Para obtener más información, consulte Terminales configurables en la Guía para desarrolladores de AWS IoT.

Para crear un grupo de cosas dinámico

El siguiente create-dynamic-thing-group ejemplo crea un grupo de cosas dinámico que contiene cualquier cosa con un atributo de temperatura superior a 60 grados. Debe habilitar la indexación de flotas de AWS IoT antes de poder usar grupos de cosas dinámicos.

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

Salida:

{
    "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 obtener más información, consulte Grupos de cosas dinámicos en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para crear un trabajo

El siguiente create-job ejemplo crea un trabajo de AWS IoT sencillo que envía un JSON documento al 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

Salida:

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

Ejemplo 2: Para crear un trabajo continuo

El siguiente create-job ejemplo crea un trabajo que continúa ejecutándose después de que las cosas especificadas como objetivos hayan completado el trabajo. En este ejemplo, el objetivo es un grupo de cosas, por lo que cuando se añaden nuevos dispositivos al grupo, el trabajo continuo se ejecuta en esas cosas nuevas.

aws iot create-job --job-id «example-job-04" --targets «arn:aws:iot:us-west- 2:123456789012: -job.json --description «ejemplo de trabajo continuo» --target-selection thinggroup/DeadBulbs" --document file://example CONTINUOUS

Salida:

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

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para crear un RSA key pair y emitir un certificado X.509

A continuación, se create-keys-and-certificate crea un par de RSA claves de 2048 bits y se emite un certificado X.509 con la clave pública emitida. Como esta es la única vez que el AWS IoT proporciona la clave privada para este certificado, asegúrese de guardarla en un lugar 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"

Salida:

{
    "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 obtener más información, consulte Crear y registrar un certificado de dispositivo de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para crear una acción de mitigación

El siguiente create-mitigation-action ejemplo define una acción de mitigación denominada AddThingsToQuarantineGroup1Action que, cuando se aplica, mueve las cosas al grupo de cosas denominadoQuarantineGroup1. Esta acción anula los grupos de cosas dinámicos.

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

Contenidos de params.json:

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

Salida:

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

Para obtener más información, consulte CreateMitigationAction (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para crear una OTA actualización para usarla con Amazon Free RTOS

El siguiente create-ota-update ejemplo crea una AWS IoT OTAUpdate en un grupo de cosas o grupos objetivo. Esto forma parte de una RTOS over-the-air actualización gratuita de Amazon que te permite implementar nuevas imágenes de firmware en un solo dispositivo o en un grupo de dispositivos.

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

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

Salida:

{
     "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 obtener más información, consulte C reateOTAUpdate en la APIReferencia de AWS IoT.

Para actualizar una política con una nueva versión

En el siguiente create-policy-version ejemplo, se actualiza la definición de una política y se crea una nueva versión de la política. Este ejemplo también convierte a la nueva versión en la predeterminada.

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

Contenidos de policy.json:

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

Salida:

{
    "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 obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para crear una política de AWS IoT

El siguiente create-policy ejemplo crea una política de AWS IoT denominada TemperatureSensorPolicy. El policy.json archivo contiene declaraciones que permiten acciones políticas de AWS IoT.

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

Contenidos 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"
            ]
        }
    ]
}

Salida:

{
    "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 obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para crear una notificación de aprovisionamiento

En el siguiente create-provisioning-claim ejemplo, se crea una notificación de aprovisionamiento a partir de una plantilla de aprovisionamiento.

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

Salida:

{
    "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 obtener más información, consulte Aprovisionamiento por usuario de confianza en la Guía para desarrolladores de AWS IoT Core.

Para crear una versión de plantilla de aprovisionamiento

En el siguiente ejemplo, se crea una versión para la plantilla de aprovisionamiento especificada. El cuerpo de la nueva versión se incluye en el archivotemplate.json.

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

Contenidos 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"]}
        }
    }
}

Salida:

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

Para obtener más información, consulte AWS IoT Secure Tunneling en la Guía para desarrolladores de AWS IoT Core.

Para crear una plantilla de aprovisionamiento

En el siguiente create-provisioning-template ejemplo, se crea una plantilla de aprovisionamiento tal como se define en el archivo. 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

Contenidos 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"]}
        }
    }
}

Salida:

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

Para obtener más información, consulte AWS IoT Secure Tunneling en la Guía para desarrolladores de AWS IoT Core.

Para crear un alias de rol

En el siguiente create-role-alias ejemplo, se crea un alias de rol llamado LightBulbRole para el rol especificado.

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

Salida:

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

Para obtener más información, consulte CreateRoleAliasla APIReferencia de AWS IoT.

Para crear una auditoría programada

En el siguiente create-scheduled-audit ejemplo, se crea una auditoría programada que se ejecuta semanalmente, los miércoles, para comprobar si los certificados de CA o los certificados de los dispositivos van a caducar.

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

Salida:

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

Para obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para crear un perfil de seguridad

El siguiente create-security-profile ejemplo crea un perfil de seguridad que comprueba si el ancho de banda móvil supera un umbral o si se producen más de 10 errores de autorización en un 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}}]"

Salida:

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

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para crear una transmisión para entregar uno o más archivos grandes en partes MQTT

En el siguiente create-stream ejemplo, se crea una secuencia para entregar uno o más archivos grandes por partes. MQTT Una transmisión transporta bytes de datos en fragmentos o bloques empaquetados como MQTT mensajes desde una fuente como S3. Puede tener uno o más archivos asociados con un flujo.

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

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

Salida:

{
     "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 obtener más información, consulte CreateStreamla APIReferencia de AWS IoT.

Ejemplo 1: Para crear un grupo de cosas

En el siguiente create-thing-group ejemplo, se crea un grupo de cosas denominado LightBulbs con una descripción y dos atributos.

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

Salida:

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

Ejemplo 2: Para crear un grupo de cosas que forme parte de un grupo principal

A continuación se create-thing-group crea un grupo de cosas denominado HalogenBulbs que tiene un nombre de grupo de cosas principalLightBulbs.

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

Salida:

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

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Para definir un tipo de cosa

En el siguiente create-thing-type ejemplo, se define un tipo de cosa y los atributos asociados.

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

Salida:

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

Para obtener más información, consulte Tipos de cosas en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para crear un registro de cosas en el registro

El siguiente create-thing ejemplo crea una entrada para un dispositivo en el registro de cosas de AWS IoT.

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

Salida:

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

Ejemplo 2: Para definir una cosa que está asociada a un tipo de cosa

En el siguiente create-thing ejemplo, se crea una cosa que tenga el tipo de cosa especificado y sus atributos.

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

Salida:

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

Para obtener más información, consulte Cómo administrar cosas con el registro y los tipos de cosas en la Guía para desarrolladores de AWS IoT.

Para crear un tema, regla, destino

En el siguiente create-topic-rule-destination ejemplo, se crea un destino de regla temática para un HTTP punto final.

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

Salida:

{
    "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 obtener más información, consulte Crear un destino de regla temática en la Guía para desarrolladores de AWS IoT.

Para crear una regla que envíe una SNS alerta de Amazon

En el siguiente create-topic-rule ejemplo, se crea una regla que envía un SNS mensaje de Amazon cuando las lecturas del nivel de humedad del suelo, tal y como se encuentran en la sombra de un dispositivo, son bajas.

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

El ejemplo requiere que se guarde el siguiente JSON código en un archivo llamadoplant-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 no genera ninguna salida.

Para obtener más información, consulte Creación de una regla de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para deshabilitar todas las comprobaciones de auditoría de tu AWS cuenta

El siguiente delete-account-audit-configuration ejemplo restaura la configuración predeterminada de AWS IoT Device Defender para esta cuenta, deshabilita todas las comprobaciones de auditoría y borra los datos de configuración. También elimina cualquier auditoría programada para esta cuenta. Utilice este comando con precaución.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para eliminar una supresión de un hallazgo de auditoría

El siguiente delete-audit-suppression ejemplo elimina la supresión de un hallazgo de auditoría para DEVICE _ _ CERTIFICATE EXPIRING _CHECK.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte las supresiones de detección de auditorías en la Guía para desarrolladores de AWS IoT.

Para eliminar un autorizador personalizado

En el siguiente delete-authorizer ejemplo, se elimina el autorizador denominado. CustomAuthorizer Un autorizador personalizado debe estar en ese INACTIVE estado para poder eliminarlo.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteAuthorizerla Guía para desarrolladores de AWS IoT.

Para eliminar un grupo de facturación

En el siguiente delete-billing-group ejemplo, se elimina el grupo de facturación especificado. Puede eliminar un grupo de facturación incluso si contiene uno o más elementos.

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

Este comando no produce ninguna salida.

Para obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para eliminar un certificado de CA

En el siguiente delete-ca-certificate ejemplo, se elimina el certificado de CA con el identificador de certificado especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte D eleteCACertificate en la APIReferencia de AWS IoT.

Para eliminar un certificado de dispositivo

En el siguiente delete-certificate ejemplo, se elimina el certificado del dispositivo con el ID especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteCertificatela APIReferencia de AWS IoT.

Para eliminar una métrica personalizada

En el siguiente delete-custom-metric ejemplo, se elimina una métrica personalizada.

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

Salida:

HTTP 200

Para obtener más información, consulte Métricas personalizadas en la Guía para desarrolladores de AWS IoT Core.

Para eliminar una dimensión

En el delete-dimension ejemplo siguiente se elimina una dimensión llamadaTopicFilterForAuthMessages.

aws iot delete-dimension \
    --name TopicFilterForAuthMessages

Este comando no genera ninguna salida.

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para eliminar una configuración de dominio

En el siguiente delete-domain-configuration ejemplo, se elimina una configuración de dominio denominada additionalDataDomain de su AWS cuenta.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Terminales configurables en la Guía para desarrolladores de AWS IoT.

Para eliminar un grupo de cosas dinámico

En el siguiente delete-dynamic-thing-group ejemplo, se elimina el grupo de cosas dinámico especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Grupos de cosas dinámicos en la Guía para desarrolladores de AWS IoT.

Para eliminar la ejecución de un trabajo

En el siguiente delete-job-execution ejemplo, se elimina la ejecución del trabajo especificado en un dispositivo. Se utiliza describe-job-execution para obtener el número de ejecución.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Eliminación de un trabajo

En el siguiente delete-job ejemplo, se elimina el trabajo especificado. Al especificar la --force opción, el trabajo se elimina incluso si el estado esIN_PROGRESS.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para eliminar una acción de mitigación

En el siguiente delete-mitigation-action ejemplo, se elimina la acción de mitigación especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteMitigationAction (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para eliminar una OTA actualización

En el siguiente delete-ota-update ejemplo, se elimina la OTA actualización especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte D eleteOTAUpdate en la APIReferencia de AWS IoT.

Para eliminar una versión de la política

En el siguiente delete-policy-version ejemplo, se elimina la versión 2 de la política especificada de su AWS cuenta.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Eliminación de una política

En el siguiente delete-policy ejemplo, se elimina la política especificada de tu AWS cuenta.

aws iot delete-policy --policy-name UpdateDeviceCertPolicy

Este comando no genera ninguna salida.

Para obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para eliminar una versión de plantilla de aprovisionamiento

En el siguiente delete-provisioning-template-version ejemplo, se elimina la versión 2 de la plantilla de aprovisionamiento especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte AWS IoT Secure Tunneling en la Guía para desarrolladores de AWS IoT Core.

Para eliminar una plantilla de aprovisionamiento

En el siguiente delete-provisioning-template ejemplo, se elimina la plantilla de aprovisionamiento especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte AWS IoT Secure Tunneling en la Guía para desarrolladores de AWS IoT Core.

Para eliminar el código de registro

El siguiente delete-registration-code ejemplo elimina el código de registro específico de una cuenta de AWS IoT.

aws iot delete-registration-code

Este comando no genera ninguna salida.

Para obtener más información, consulte Use su propio certificado en la Guía para desarrolladores de AWS IoT.

Para eliminar un alias de rol de AWS IoT

El siguiente delete-role-alias ejemplo elimina un alias de rol de AWS IoT denominadoLightBulbRole.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Autorización de llamadas directas a AWS los servicios en la Guía para desarrolladores de AWS IoT.

Para eliminar una auditoría programada

El siguiente delete-scheduled-audit ejemplo elimina la auditoría programada de AWS IoT Device Defender denominadaAWSIoTDeviceDefenderDailyAudit.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para eliminar un perfil de seguridad

En el siguiente delete-security-profile ejemplo, se elimina un perfil de seguridad denominadoPossibleIssue.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para eliminar una transmisión

En el siguiente delete-stream ejemplo, se elimina la transmisión especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteStreamla APIReferencia de AWS IoT.

Para eliminar un grupo de cosas

En el siguiente delete-thing-group ejemplo, se elimina el grupo de cosas especificado. No se puede eliminar un grupo de cosas si contiene grupos de cosas secundarios.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para eliminar un tipo de cosa

En el siguiente delete-thing-type ejemplo, se elimina un tipo de cosa obsoleto.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Tipos de cosas en la Guía para desarrolladores de AWS IoT.

Para mostrar información detallada sobre una cosa

En el siguiente delete-thing ejemplo, se elimina un elemento del registro de AWS IoT de tu AWS cuenta.

¿Fue para borrar algo --thing-name» FourthBulb

Este comando no genera ninguna salida.

Para obtener más información, consulte Administración de objetos con el registro en la Guía para desarrolladores de AWS IoT.

Para eliminar el destino de una regla de tema

En el siguiente delete-topic-rule-destination ejemplo, se elimina el destino de la regla temática especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar el destino de una regla temática en la Guía para desarrolladores de AWS IoT.

Para eliminar una regla

En el siguiente delete-topic-rule ejemplo, se elimina la regla especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Eliminar una regla en la Guía para desarrolladores de AWS IoT.

Para eliminar el nivel de registro de un grupo de cosas

En el siguiente delete-v2-logging-level ejemplo, se elimina el nivel de registro del grupo de cosas especificado.

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

Este comando no genera ninguna salida.

Ejemplo 1: Para desaprobar un tipo de cosa

En el siguiente deprecate-thing-type ejemplo, se desaprueba un tipo de cosa para que los usuarios no puedan asociarle ningún elemento nuevo.

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

Este comando no genera ninguna salida.

Ejemplo 2: Para revertir la obsolescencia de un tipo de cosa

El siguiente deprecate-thing-type ejemplo anula la obsolescencia de un tipo de cosa, lo que permite a los usuarios volver a asociarle cosas nuevas.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Tipos de cosas en la Guía para desarrolladores de AWS IoT.

Para ver los ajustes de configuración de auditoría actuales

En el siguiente describe-account-audit-configuration ejemplo, se enumeran los ajustes actuales de la configuración de auditoría de AWS IoT Device Defender.

aws iot describe-account-audit-configuration

Salida:

{
    "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 obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para enumerar los detalles de una conclusión de auditoría

En el siguiente describe-audit-finding ejemplo, se enumeran los detalles del hallazgo de auditoría de AWS IoT Device Defender especificado. Una auditoría puede producir varios resultados. Utilice el list-audit-findings comando para obtener una lista de los resultados de una auditoría y obtener lafindingId.

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

Salida:

{
    "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 obtener más información, consulte Comprobar los resultados de la auditoría (comandos de auditoría) en la Guía para desarrolladores de AWS IoT.

Para mostrar los detalles de una tarea de auditoría (acciones de mitigación)

El siguiente describe-audit-mitigation-actions-task ejemplo muestra los detalles de la tarea especificada, en la ResetPolicyVersionAction que se aplicó a un hallazgo. Los resultados incluyen cuándo comenzó y finalizó la tarea, cuántos hallazgos se buscaron (y cuál fue el resultado) y la definición de la acción que se aplicó como parte de esta tarea.

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

Salida:

{
    "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 obtener más información, consulte DescribeAuditMitigationActionsTask (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para obtener detalles sobre la supresión de un hallazgo de auditoría

En el siguiente describe-audit-suppression ejemplo se enumeran los detalles sobre la supresión de un hallazgo de auditoría.

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

Salida:

{
    "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 obtener más información, consulte las supresiones de detección de auditorías en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre una instancia de auditoría

El siguiente describe-audit-task ejemplo obtiene información sobre una instancia de una auditoría de AWS IoT Device Defender. Si la auditoría se ha completado, las estadísticas resumidas de la ejecución se incluyen en los resultados.

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

Salida:

 {
    "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 obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre un autorizador personalizado

En el siguiente describe-authorizer ejemplo, se muestran los detalles del autorizador personalizado especificado.

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

Salida:

{
    "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 obtener más información, consulte DescribeAuthorizerla APIReferencia de AWS IoT.

Para obtener información sobre un grupo de facturación

En el siguiente describe-billing-group ejemplo, se obtiene información del grupo de facturación especificado.

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

Salida:

{
    "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 obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para obtener detalles sobre un certificado de CA

En el siguiente describe-ca-certificate ejemplo, se muestran los detalles del certificado de CA especificado.

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

Salida:

{
    "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 obtener más información, consulte D escribeCACertificate en la APIReferencia de AWS IoT.

Para obtener información sobre un certificado

En el siguiente describe-certificate ejemplo, se muestran los detalles del certificado especificado.

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

Salida:

{
    "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 obtener más información, consulte DescribeCertificatela APIReferencia de AWS IoT.

Para obtener información sobre una métrica personalizada de Device Defender

En el describe-custom-metric ejemplo siguiente se obtiene información sobre una métrica personalizada denominadamyCustomMetric.

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

Salida:

{
    "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 obtener más información, consulte Métricas personalizadas en la Guía para desarrolladores de AWS IoT Core.

Para obtener información sobre el autorizador personalizado predeterminado

En el siguiente describe-default-authorizer ejemplo, se muestran los detalles del autorizador personalizado predeterminado.

aws iot describe-default-authorizer

Salida:

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

Para obtener más información, consulte DescribeDefaultAuthorizerla APIReferencia de AWS IoT.

Para obtener información sobre una dimensión

En el describe-dimension ejemplo siguiente se obtiene información sobre una dimensión denominadaTopicFilterForAuthMessages.

aws iot describe-dimension \
    --name TopicFilterForAuthMessages

Salida:

{
    "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 obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para describir una configuración de dominio

En el siguiente describe-domain-configuration ejemplo, se muestran detalles sobre la configuración de dominio especificada.

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

Salida:

{
    "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 obtener más información, consulte Terminales configurables en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para obtener su AWS punto final actual

El siguiente describe-endpoint ejemplo recupera el AWS punto final predeterminado al que se aplican todos los comandos.

aws iot describe-endpoint

Salida:

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

Para obtener más información, consulte DescribeEndpointla Guía para desarrolladores de AWS IoT.

Ejemplo 2: Para obtener su ATS terminal

En el siguiente describe-endpoint ejemplo, se recupera el punto final de Amazon Trust Services (ATS).

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

Salida:

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

Para obtener más información, consulte Certificados X.509 e AWS IoT en la Guía para desarrolladores de AWS IoT.

Para mostrar qué tipos de eventos se publican

El siguiente describe-event-configurations ejemplo muestra la configuración que controla qué eventos se generan cuando se agrega, actualiza o elimina algo.

aws iot describe-event-configurations

Salida:

{
    "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 obtener más información, consulte Mensajes de eventos en la Guía para desarrolladores de AWS IoT.

Para recuperar el estado actual del índice de cosas

En el siguiente describe-index ejemplo, se recupera el estado actual del índice de cosas.

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

Salida:

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

Para obtener más información, consulte Gestión de la indexación de cosas en la Guía para desarrolladores de AWS IoT.

Para obtener los detalles de ejecución de un trabajo en un dispositivo

En el siguiente describe-job-execution ejemplo, se obtienen los detalles de ejecución del trabajo especificado.

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

Salida:

{
    "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 obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para obtener el estado detallado de un trabajo

En el siguiente describe-job ejemplo se obtiene el estado detallado del trabajo cuyo identificador esexample-job-01.

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

Salida:

{
    "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 obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para ver los detalles de una acción de mitigación definida

En el siguiente describe-mitigation-action ejemplo, se muestran los detalles de la acción de mitigación especificada.

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

Salida:

{
    "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 obtener más información, consulte DescribeMitigationAction (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para describir una versión de plantilla de aprovisionamiento

En el siguiente describe-provisioning-template-version ejemplo, se describe una versión de plantilla de aprovisionamiento.

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

Salida:

{
    "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 obtener más información, consulte Aprovisionamiento de dispositivos que no tienen certificados de dispositivo mediante el aprovisionamiento de flotas en la Guía básica para desarrolladores de AWS IoT.

Para describir una plantilla de aprovisionamiento

En el siguiente describe-provisioning-template ejemplo, se describe una plantilla de aprovisionamiento.

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

Salida:

{
    "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 obtener más información, consulte Aprovisionamiento de dispositivos que no tienen certificados de dispositivo mediante el aprovisionamiento de flotas en la Guía básica para desarrolladores de AWS IoT.

Para obtener información sobre un alias de rol de AWS IoT

En el siguiente describe-role-alias ejemplo, se muestran los detalles del alias de rol especificado.

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

Salida:

{
    "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 obtener más información, consulte DescribeRoleAliasla APIReferencia de AWS IoT.

Para obtener información sobre una auditoría programada

En el siguiente describe-scheduled-audit ejemplo se obtiene información detallada sobre una auditoría programada de AWS IOT Device Defender denominadaAWSIoTDeviceDefenderDailyAudit.

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

Salida:

{
    "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 obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre un perfil de seguridad

El siguiente describe-security-profile ejemplo obtiene información sobre el perfil de seguridad de AWS IoT Device Defender denominado PossibleIssue.

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

Salida:

{
    "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 obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre una transmisión

En el siguiente describe-stream ejemplo, se muestran los detalles de la transmisión especificada.

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

Salida:

{
    "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 obtener más información, consulte DescribeStreamla APIReferencia de AWS IoT.

Para obtener información sobre un grupo de cosas

En el describe-thing-group ejemplo siguiente se obtiene información sobre el grupo de cosas denominadoHalogenBulbs.

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

Salida:

{
    "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 obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre un tipo de cosa

En el siguiente describe-thing-type ejemplo, se muestra información sobre el tipo de cosa especificado definido en su AWS cuenta.

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

Salida:

{
    "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 obtener más información, consulte Tipos de cosas en la Guía para desarrolladores de AWS IoT.

Para mostrar información detallada sobre una cosa

El siguiente describe-thing ejemplo muestra información sobre una cosa (dispositivo) que está definida en el registro de AWS IoT de su AWS cuenta.

¿Cómo describir-thing --thing-name» MyLightBulb

Salida:

{
    "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 obtener más información, consulte Administración de objetos con el registro en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para separar una política de AWS IoT de un grupo de cosas

El siguiente detach-policy ejemplo separa la política especificada de un grupo de cosas y, por extensión, de todas las cosas de ese grupo y de cualquiera de los grupos secundarios del grupo.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Ejemplo 2: Para separar una política de AWS IoT del certificado de un dispositivo

El siguiente detach-policy ejemplo separa la TemperatureSensorPolicy política de un certificado de dispositivo identificado por. ARN

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

Este comando no genera ninguna salida.

Para desasociar un perfil de seguridad de un objetivo

El siguiente detach-security-profile ejemplo elimina la asociación entre el perfil de seguridad de AWS IoT Device Defender denominado Testprofile y el objetivo all registered things.

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 no genera ninguna salida.

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para separar un certificado/principal de una cosa

En el siguiente detach-thing-principal ejemplo, se elimina un certificado que representa un principal del elemento especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Administración de objetos con el registro en la Guía para desarrolladores de AWS IoT.

Para deshabilitar una regla temática

En el siguiente disable-topic-rule ejemplo, se deshabilita la regla de tema especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo ver sus reglas en la Guía para desarrolladores de AWS IoT.

Para habilitar una regla temática

El siguiente enable-topic-rule ejemplo habilita (o vuelve a habilitar) la regla temática especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo ver sus reglas en la Guía para desarrolladores de AWS IoT.

Para ver el estado del modelo de formación ML Detect Security Profile de Device Defender

En el siguiente get-behavior-model-training-summaries ejemplo, se muestra el estado de entrenamiento del modelo para los comportamientos configurados en el perfil de seguridad elegido. Para cada comportamiento, se muestran el nombre, el estado del modelo y el porcentaje de puntos de datos recopilados.

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

Salida:

{
    "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 obtener más información, consulte GetBehaviorModelTrainingSummaries (Detectar comandos) en la Guía para desarrolladores de AWS IoT.

Para devolver el recuento aproximado de valores únicos que coinciden con la consulta

Puede utilizar el siguiente script de configuración para crear 10 elementos que representen 10 sensores de temperatura. Cada elemento nuevo tiene 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

Ejemplo de salida del script de configuración:

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

El siguiente get-cardinality ejemplo consulta los 10 sensores creados por el script de configuración y devuelve el número de racks que tienen sensores de temperatura que indican valores de temperatura anormales. Si el valor de temperatura es inferior a 60 o superior a 80, el sensor de temperatura se encuentra en un estado anormal.

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

Salida:

{
    "cardinality": 2
}

Para obtener más información, consulte Consulta de datos agregados< https://docs.aws.amazon.com/iot/ latest/developerguide/index -aggregate.html> en la Guía para desarrolladores de IoT.AWS

Para enumerar las políticas que afectan a una cosa

En el siguiente get-effective-policies ejemplo, se enumeran las políticas que afectan al elemento especificado, incluidas las políticas asociadas a cualquier grupo al que pertenezca.

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

Salida:

{
    "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 obtener más información, consulte Get Effective Policies for a Thing en la Guía para desarrolladores de AWS IoT.

Para obtener la configuración de indexación de la cosa

El siguiente get-indexing-configuration ejemplo obtiene los datos de configuración actuales para la indexación de flotas de AWS IoT.

aws iot get-indexing-configuration

Salida:

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

Para obtener más información, consulte Gestión de la indexación de cosas en la Guía para desarrolladores de AWS IoT.

Para recuperar el documento para un trabajo

En el siguiente get-job-document ejemplo, se muestran detalles sobre el documento del trabajo cuyo identificador esexample-job-01.

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

Salida:

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

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para obtener las opciones de registro

En el siguiente get-logging-options ejemplo, se obtienen las opciones de registro actuales de su AWS cuenta.

aws iot get-logging-options

Salida:

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

Para obtener más información, consulte el título en la Guía para desarrolladores de AWS IoT.

Para recuperar información sobre una OTA actualización

En el siguiente get-ota-update ejemplo, se muestran detalles sobre la OTA actualización especificada.

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

Salida:

{
    "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 obtener más información, consulte G etOTAUpdate en la APIReferencia de AWS IoT.

Para agrupar los valores agregados que coinciden con la consulta en grupos de percentiles

Puede usar el siguiente script de configuración para crear 10 elementos que representen 10 sensores de temperatura. Cada elemento nuevo tiene un 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

Ejemplo de salida del script de configuración:

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

El siguiente get-percentiles ejemplo consulta los 10 sensores creados por el script de configuración y devuelve un valor para cada grupo de percentiles especificado. El grupo de percentiles «10" contiene el valor del campo agregado que aparece en aproximadamente el 10 por ciento de los valores que coinciden con la consulta. En el siguiente resultado, {"porcentaje»: 10,0, «valor»: 67,7} significa que aproximadamente el 10,0% de los valores de temperatura están por debajo del 67,7.

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

Salida:

{
    "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 obtener más información, consulte Consulta de datos agregados en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre una versión específica de una política

En el siguiente get-policy-version ejemplo, se obtiene información sobre la primera versión de la política especificada.

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

Salida:

{
    "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 obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre la versión predeterminada de una política

En el siguiente get-policy ejemplo, se recupera información sobre la versión predeterminada de la política especificada.

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

Salida:

{
    "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 obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para obtener el código de registro AWS específico de tu cuenta

En el siguiente get-registration-code ejemplo, se recupera el código de registro específico de tu AWS cuenta.

aws iot get-registration-code

Salida:

{
    "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c"
}

Para obtener más información, consulte Use su propio certificado en la Guía para desarrolladores de AWS IoT.

Para buscar datos agregados en el índice de dispositivos

En el siguiente get-statistics ejemplo, se devuelve el número de elementos que tienen una propiedad denominada connectivity.connected establecida en false (es decir, el número de dispositivos que no están conectados) en su sombra de dispositivos.

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

Salida:

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

Para obtener más información, consulte Obtener estadísticas sobre su flota de dispositivos en la Guía para desarrolladores de AWS IoT.

Para obtener el destino de una regla temática

En el siguiente get-topic-rule-destination ejemplo, se obtiene información sobre el destino de una regla temática.

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

Salida:

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

Para obtener más información, consulte Trabajar con destinos de reglas temáticas en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre una regla

En el siguiente get-topic-rule ejemplo, se obtiene información sobre la regla especificada.

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

Salida:

{
    "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 obtener más información, consulte Cómo ver sus reglas en la Guía para desarrolladores de AWS IoT.

Para enumerar las opciones de registro actuales

El siguiente get-v2-logging-options ejemplo muestra las opciones de registro actuales para AWS IoT.

aws iot get-v2-logging-options

Salida:

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

Para obtener más información, consulte el título en la Guía para desarrolladores de AWS IoT.

Para enumerar las infracciones activas

En el siguiente list-active-violations ejemplo, se enumeran todas las infracciones del perfil de seguridad especificado.

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

Salida:

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

Ejemplo 1: Para enumerar las políticas asociadas a un grupo

En el siguiente list-attached-policies ejemplo, se enumeran las políticas asociadas al grupo especificado.

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

Salida:

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

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Ejemplo 2: Para enumerar las políticas adjuntas a un certificado de dispositivo

En el siguiente list-attached-policies ejemplo, se enumeran las políticas de AWS IoT adjuntas al certificado del dispositivo. El certificado se identifica por suARN.

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

Salida:

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

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para enumerar todos los resultados de una auditoría

En el siguiente list-audit-findings ejemplo, se enumeran todos los resultados de una auditoría de AWS IoT Device Defender con un identificador de tarea específico.

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

Salida:

{
    "findings": []
}

Ejemplo 2: Para enumerar los resultados de un tipo de comprobación de auditoría

El siguiente list-audit-findings ejemplo muestra los resultados de las auditorías de AWS IoT Device Defender realizadas entre el 5 y el 19 de junio de 2019, en las que los dispositivos comparten un certificado de dispositivo. Al especificar un nombre de verificación, debe proporcionar una hora de inicio y finalización.

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

Salida:

{
    "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 obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para enumerar los detalles de la ejecución de una acción de mitigación de auditoría

Una tarea de acción de mitigación de auditoría aplica una acción de mitigación a uno o más hallazgos de una auditoría de AWS IoT Device Defender. En el siguiente list-audit-mitigation-actions-executions ejemplo, se enumeran los detalles de la tarea de acción de mitigación con el resultado especificado taskId y el especificado.

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

Salida:

{
    "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 obtener más información, consulte ListAuditMitigationActionsExecutions (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para enumerar las tareas de auditoría y acciones de mitigación

En el siguiente list-audit-mitigation-actions-tasks ejemplo, se enumeran las acciones de mitigación que se aplicaron a los hallazgos dentro del período de tiempo especificado.

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

Salida:

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

Para obtener más información, consulte ListAuditMitigationActionsTasks (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para enumerar todas las omisiones de los resultados de auditoría

En el siguiente list-audit-suppressions ejemplo, se enumeran todas las supresiones de las comprobaciones de auditoría activas.

aws iot list-audit-suppressions

Salida:

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

Para obtener más información, consulte las supresiones de detección de auditorías en la Guía para desarrolladores de AWS IoT.

Para enumerar todos los resultados de una auditoría

En el siguiente list-audit-tasks ejemplo, se enumeran las tareas de auditoría que se ejecutaron entre el 5 de junio de 2019 y el 12 de junio de 2019.

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

Salida:

{
    "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 obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para incluir tu autorizador personalizado

En el siguiente list-authorizers ejemplo, se muestran los autorizadores personalizados de tu AWS cuenta.

aws iot list-authorizers

Salida:

{
    "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 obtener más información, consulte ListAuthorizersla APIReferencia de AWS IoT.

Para enumerar los grupos de facturación de tu AWS cuenta y región

En el siguiente list-billing-groups ejemplo, se enumeran todos los grupos de facturación que están definidos para su AWS cuenta y AWS región.

aws iot list-billing-groups

Salida:

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

Para obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para ver una lista de los certificados de CA registrados en su AWS cuenta

El siguiente list-ca-certificates ejemplo muestra los certificados de CA registrados en su AWS cuenta.

aws iot list-ca-certificates

Salida:

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

Para obtener más información, consulte Use su propio certificado en la Guía para desarrolladores de AWS IoT.

Para enumerar todos los certificados de dispositivos firmados con un certificado de CA

En el siguiente list-certificates-by-ca ejemplo, se enumeran todos los certificados de dispositivo de su AWS cuenta que están firmados con el certificado de CA especificado.

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

Salida:

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

Para obtener más información, consulte ListCertificatesByCA in the AWS IoT API Reference.

Ejemplo 1: Para enumerar los certificados registrados en su AWS cuenta

En el siguiente list-certificates ejemplo, se enumeran todos los certificados registrados en su cuenta. Si supera el límite de paginación predeterminado, que es 25, puede utilizar el valor de nextMarker respuesta de este comando e introducirlo en el siguiente comando para obtener el siguiente lote de resultados. Repita el procedimiento hasta que se nextMarker devuelva sin ningún valor.

aws iot list-certificates

Salida:

{
    "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 enumerar tus métricas personalizadas

En el siguiente list-custom-metrics ejemplo, se muestran todas las métricas personalizadas.

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

Salida:

{
    "metricNames": [
        "batteryPercentage"
    ]
}

Para obtener más información, consulte Métricas personalizadas en la Guía para desarrolladores de AWS IoT Core.

Para enumerar las dimensiones de tu AWS cuenta

En el siguiente list-dimensions ejemplo, se enumeran todas las dimensiones de AWS IoT Device Defender definidas en su AWS cuenta.

aws iot list-dimensions

Salida:

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

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para enumerar las configuraciones de dominio

En el siguiente list-domain-configurations ejemplo, se enumeran las configuraciones de dominio de su AWS cuenta que tienen el tipo de servicio especificado.

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

Salida:

{
    "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 obtener más información, consulte Terminales configurables en la Guía para desarrolladores de AWS IoT.

Para enumerar los índices de búsqueda configurados

En el siguiente list-indices ejemplo, se enumeran todos los índices de búsqueda configurados en su AWS cuenta. Si no has activado la indexación de cosas, es posible que no tengas ningún índice.

aws iot list-indices

Salida:

{
    "indexNames": [
        "AWS_Things"
    ]
}

Para obtener más información, consulte Gestión de la indexación de cosas en la Guía para desarrolladores de AWS IoT.

Para enumerar los trabajos de su AWS cuenta

En el siguiente list-job-executions-for-job ejemplo se enumeran todas las ejecuciones de tareas de una tarea de su AWS cuenta, especificadas enjobId.

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

Salida:

{
     "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 obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para enumerar los trabajos que se ejecutaron para una cosa

En el list-job-executions-for-thing ejemplo siguiente se enumeran todos los trabajos que se ejecutaron para la cosa denominadaMyRaspberryPi.

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

Salida:

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

Para obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para enumerar los trabajos de su AWS cuenta

En el siguiente list-jobs ejemplo, se muestran todos los trabajos de su AWS cuenta, ordenados por su estado.

aws iot list-jobs

Salida:

{
    "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 obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para enumerar todas las acciones de mitigación definidas

En el siguiente list-mitigation-actions ejemplo, se enumeran todas las acciones de mitigación definidas para su AWS cuenta y región. Para cada acción, se muestran el nombre y la fecha de creación. ARN

aws iot list-mitigation-actions

Salida:

{
    "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 obtener más información, consulte ListMitigationActions (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para enumerar todas las acciones de mitigación definidas

En el siguiente list-mitigations-actions ejemplo, se enumeran todas las acciones de mitigación definidas para su AWS cuenta y región. Para cada acción, se muestran el nombre y la fecha de creación. ARN

aws iot list-mitigation-actions

Salida:

{
    "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 obtener más información, consulte ListMitigationActions (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para enumerar OTA las actualizaciones de la cuenta

En el siguiente list-ota-updates ejemplo, se enumeran las OTA actualizaciones disponibles.

aws iot list-ota-updates

Salida:

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

Para obtener más información, consulte L istOTAUpdates en la APIReferencia de AWS IoT.

Para enumerar los certificados que se están transfiriendo a una AWS cuenta diferente

En el siguiente list-outgoing-certificates ejemplo, se enumeran todos los certificados de dispositivo que están en proceso de transferirse a una AWS cuenta diferente mediante el transfer-certificate comando.

aws iot list-outgoing-certificates

Salida:

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

Para obtener más información, consulte ListOutgoingCertificatesla APIReferencia de AWS IoT.

Para enumerar las políticas definidas en su AWS cuenta

En el siguiente list-policies ejemplo, se enumeran todas las políticas definidas en su AWS cuenta.

aws iot list-policies

Salida:

{
    "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 obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para ver todas las versiones de una política

El siguiente list-policy-versions ejemplo muestra todas las versiones de la política especificada y sus fechas de creación.

aws iot list-policy-versions \
    --policy-name LightBulbPolicy

Salida:

{
    "policyVersions": [
        {
            "versionId": "2",
            "isDefaultVersion": true,
            "createDate": 1559925941.924
        },
        {
            "versionId": "1",
            "isDefaultVersion": false,
            "createDate": 1559925941.924
        }
    ]
}

Para obtener más información, consulte Políticas de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para enumerar las cosas adjuntas a un principio

En el siguiente list-principal-things ejemplo se enumeran los elementos adjuntos al principal especificado por unARN.

aws iot list-principal-things \
    --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8

Salida:

{
    "things": [
        "DeskLamp",
        "TableLamp"
    ]
}

Para obtener más información, consulte ListPrincipalThingsla APIReferencia de AWS IoT.

Para enumerar las versiones de las plantillas de aprovisionamiento

En el siguiente list-provisioning-template-versions ejemplo, se enumeran las versiones disponibles de la plantilla de aprovisionamiento especificada.

aws iot list-provisioning-template-versions \
    --template-name "widget-template"

Salida:

{
    "versions": [
        {
            "versionId": 1,
            "creationDate": 1574800471.339,
            "isDefaultVersion": true
        },
        {
            "versionId": 2,
            "creationDate": 1574801192.317,
            "isDefaultVersion": false
        }
    ]
}

Para obtener más información, consulte AWS IoT Secure Tunneling en la Guía para desarrolladores de AWS IoT Core.

Para enumerar las plantillas de aprovisionamiento

En el siguiente list-provisioning-templates ejemplo, se enumeran todas las plantillas de aprovisionamiento de su AWS cuenta.

aws iot list-provisioning-templates

Salida:

{
    "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 obtener más información, consulte AWS IoT Secure Tunneling en la Guía para desarrolladores de AWS IoT Core.

Para enumerar los alias de los roles de AWS IoT en tu cuenta AWS

En el siguiente list-role-aliases ejemplo, se enumeran los alias de rol de AWS IoT de su AWS cuenta.

aws iot list-role-aliases

Salida:

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

Para obtener más información, consulte ListRoleAliasesla APIReferencia de AWS IoT.

Para enumerar las auditorías programadas para su AWS cuenta

En el siguiente list-scheduled-audits ejemplo, se enumeran todas las auditorías programadas para su AWS cuenta.

aws iot list-scheduled-audits

Salida:

{
    "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 obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para enumerar los perfiles de seguridad adjuntos a un objetivo

En el siguiente list-security-profiles-for-target ejemplo, se enumeran los perfiles de seguridad de AWS IoT Device Defender que están conectados a dispositivos no registrados.

aws iot list-security-profiles-for-target  \
    --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things"

Salida:

{
    "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 obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para enumerar los perfiles de seguridad de su AWS cuenta

En el siguiente list-security-profiles ejemplo, se enumeran todos los perfiles de seguridad de AWS IoT Device Defender que están definidos en su AWS cuenta.

aws iot list-security-profiles

Salida:

{
    "securityProfileIdentifiers": [
        {
            "name": "Testprofile",
            "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile"
        }
    ]
}

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para enumerar las transmisiones de la cuenta

En el siguiente list-streams ejemplo, se enumeran todas las transmisiones de tu AWS cuenta.

aws iot list-streams

Salida:

{
    "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 obtener más información, consulte ListStreamsla APIReferencia de AWS IoT.

Para mostrar las etiquetas y sus valores asociados a un recurso

En el siguiente list-tags-for-resource ejemplo, se muestran las etiquetas y los valores asociados al grupo de cosasLightBulbs.

aws iot list-tags-for-resource \
    --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs"

Salida:

{
    "tags": [
        {
            "Key": "Assembly",
            "Value": "Fact1NW"
        },
        {
            "Key": "MyTag",
            "Value": "777"
        }
    ]
}

Para obtener más información, consulte Cómo etiquetar sus recursos de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para enumerar los principios asociados a una política de AWS IoT

En el siguiente list-targets-for-policy ejemplo, se enumeran los certificados de dispositivo a los que se adjunta la política especificada.

aws iot list-targets-for-policy \
    --policy-name UpdateDeviceCertPolicy

Salida:

{
    "targets": [
        "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
        "arn:aws:iot:us-west-2:123456789012:cert/d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be"
    ]
}

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Para enumerar los objetivos a los que se aplica un perfil de seguridad

En el siguiente list-targets-for-security-profile ejemplo, se enumeran los objetivos a los que se aplica el perfil de seguridad de AWS IoT Device Defender denominadoPossibleIssue.

aws iot list-targets-for-security-profile \
    --security-profile-name Testprofile

Salida:

{
    "securityProfileTargets": [
        {
            "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things"
        },
        {
            "arn": "arn:aws:iot:us-west-2:123456789012:all/registered-things"
        }
    ]
}

Para obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para enumerar los grupos a los que pertenece una cosa

En el siguiente list-thing-groups-for-thing ejemplo, se enumeran los grupos a los que pertenece la cosa especificada.

aws iot list-thing-groups-for-thing \
    --thing-name MyLightBulb

Salida:

{
    "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 obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Para enumerar los grupos de cosas definidos en su AWS cuenta

En el siguiente describe-thing-group ejemplo, se enumeran todos los grupos de cosas definidos en su AWS cuenta.

aws iot list-thing-groups

Salida:

{
    "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 obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Para enumerar los principios asociados a una cosa

En el siguiente list-thing-principals ejemplo, se enumeran los principales (certificados X.509, IAM usuarios, grupos, funciones, identidades de Amazon Cognito o identidades federadas) asociados al elemento especificado.

aws iot list-thing-principals \
    --thing-name MyRaspberryPi

Salida:

{
    "principals": [
        "arn:aws:iot:us-west-2:123456789012:cert/33475ac865079a5ffd5ecd44240640349293facc760642d7d8d5dbb6b4c86893"
    ]
}

Para obtener más información, consulte ListThingPrincipalsla APIReferencia de AWS IoT.

Para enumerar los tipos de cosas definidos

En el siguiente list-thing-types ejemplo, se muestra una lista de los tipos de cosas definidos en su AWS cuenta.

aws iot list-thing-types

Salida:

{
    "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 obtener más información, consulte Tipos de cosas en la Guía para desarrolladores de AWS IoT.

Para enumerar los elementos de un grupo de facturación

En el siguiente list-things-in-billing-group ejemplo, se enumeran los elementos que se encuentran en el grupo de facturación especificado.

aws iot list-things-in-billing-group \
    --billing-group-name GroupOne

Salida:

{
    "things": [
        "MyOtherLightBulb",
        "MyLightBulb"
    ]
}

Para obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para enumerar las cosas que pertenecen a un grupo

En el siguiente list-things-in-thing-group ejemplo, se enumeran las cosas que pertenecen al grupo de cosas especificado.

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

Salida:

{
    "things": [
        "MyLightBulb"
    ]
}

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Creación de una lista de todos los objetos del registro

En el siguiente list-things ejemplo, se enumeran las cosas (dispositivos) que están definidas en el registro de AWS IoT de su AWS cuenta.

aws iot list-things

Salida:

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

Ejemplo 2: Creación de una lista de los objetos definidos que tienen un atributo específico

En el siguiente ejemplo de list-things se muestra una lista de objetos que tienen un atributo denominado wattage.

aws iot list-things \
    --attribute-name wattage

Salida:

{
    "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 obtener más información, consulte Administración de objetos con el registro en la Guía para desarrolladores de AWS IoT.

Para enumerar los destinos de las reglas temáticas

En el siguiente list-topic-rule-destinations ejemplo, se enumeran todos los destinos de las reglas temáticas que ha definido en la AWS región actual.

aws iot list-topic-rule-destinations

Salida:

{
    "destinationSummaries": [
        {
            "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "status": "ENABLED",
            "httpUrlSummary": {
                "confirmationUrl": "https://example.com"
            }
        }
    ]
}

Para obtener más información, consulte Trabajar con destinos de reglas temáticas en la Guía para desarrolladores de AWS IoT.

Para enumerar tus reglas

En el list-topic-rules ejemplo siguiente se enumeran todas las reglas que ha definido.

aws iot list-topic-rules

Salida:

{
    "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 obtener más información, consulte Cómo ver sus reglas en la Guía para desarrolladores de AWS IoT.

Para enumerar los niveles de registro

El siguiente list-v2-logging-levels ejemplo muestra los niveles de registro configurados. Si no se han establecido los niveles de registro, NotConfiguredException se produce una al ejecutar este comando.

aws iot list-v2-logging-levels

Salida:

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

Para enumerar las infracciones del perfil de seguridad durante un período

En el siguiente list-violation-events ejemplo, se enumeran las infracciones que se produjeron entre el 5 y el 12 de junio de 2019 en todos los perfiles de seguridad de AWS IoT Device Defender de la AWS cuenta corriente y la AWS región.

aws iot list-violation-events \
    --start-time 1559747125 \
    --end-time 1560351925

Salida:

{
    "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 obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para registrar un certificado de una entidad emisora de certificados (CA)

En el siguiente register-ca-certificate ejemplo, se registra un certificado de CA. El comando proporciona el certificado de CA y un certificado de verificación de clave que demuestra que usted es el propietario de la clave privada asociada al certificado de CA.

aws iot register-ca-certificate \
    --ca-certificate file://rootCA.pem \
    --verification-cert file://verificationCert.pem

Salida:

{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467",
    "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467"
 }

Para obtener más información, consulte R egisterCACertificate en la APIReferencia de AWS IoT.

Para registrar un certificado de dispositivo autofirmado

En el siguiente register-certificate ejemplo, se registra el certificado de deviceCert.pem dispositivo firmado por el certificado de rootCA.pem CA. El certificado de CA debe registrarse antes de usarlo para registrar un certificado de dispositivo autofirmado. El certificado autofirmado debe estar firmado por el mismo certificado de CA que se pasa a este comando.

aws iot register-certificate \
    --certificate-pem file://deviceCert.pem \
    --ca-certificate-pem file://rootCA.pem

Salida:

{
    "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142",
    "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142"
 }

Para obtener más información, consulte RegisterCertificatela APIReferencia de AWS IoT.

Para registrar una cosa

En el siguiente register-thing ejemplo, se registra una cosa mediante una plantilla de aprovisionamiento.

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

Salida:

{
    "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 obtener más información, consulte Aprovisionamiento por usuario de confianza en la Guía para desarrolladores de AWS IoT Core.

Para rechazar la transferencia de un certificado

El siguiente reject-certificate-transfer ejemplo rechaza la transferencia del certificado del dispositivo especificado desde otra AWS cuenta.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Transferir un certificado a otra cuenta en la Guía para desarrolladores de AWS IoT Core.

Para eliminar un elemento de un grupo de facturación

En el siguiente remove-thing-from-billing-group ejemplo, se elimina el elemento especificado de un grupo de facturación.

aws iot remove-thing-from-billing-group \
    --billing-group-name GroupOne \
    --thing-name MyOtherLightBulb

Este comando no genera ninguna salida.

Para obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para eliminar una cosa de un grupo de cosas

En el siguiente remove-thing-from-thing-group ejemplo, se elimina el elemento especificado de un grupo de cosas.

aws iot remove-thing-from-thing-group \
    --thing-name bulb7 \
    --thing-group-name DeadBulbs

Este comando no genera ninguna salida.

Para obtener más información, consulte Thing Groups < https://docs.aws.amazon.com/iot/ latest/developerguide/thing -groups.html > en la Guía para desarrolladores de AWS IoT.

Para actualizar la definición de reglas de un tema

El siguiente replace-topic-rule ejemplo actualiza la regla especificada para enviar una SNS alerta cuando las lecturas del nivel de humedad del suelo sean demasiado bajas.

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 no genera ninguna salida.

Para obtener más información, consulte Creación de una regla de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para consultar el índice de cosas

En el siguiente search-index ejemplo, se AWS_Things consultan en el índice los elementos que tienen un tipo deLightBulb.

aws iot search-index \
    --index-name "AWS_Things" \
    --query-string "thingTypeName:LightBulb"

Salida:

{
    "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 obtener más información, consulte Gestión de la indexación de cosas en la Guía para desarrolladores de AWS IoT.

Para configurar un autorizador predeterminado

En el siguiente set-default-authorizer ejemplo, se establece el autorizador personalizado CustomAuthorizer denominado autorizador predeterminado.

aws iot set-default-authorizer \
    --authorizer-name CustomAuthorizer

Salida:

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

Para obtener más información, consulte CreateDefaultAuthorizerla APIReferencia de AWS IoT.

Para establecer la versión predeterminada de una política

En el siguiente set-default-policy-version ejemplo, se establece la versión predeterminada en la política denominadaUpdateDeviceCertPolicy. 2

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

Este comando no genera ninguna salida.

Para establecer el nivel de registro de un grupo de cosas

En el siguiente set-v2-logging-level ejemplo, se establece el nivel de registro para registrar las advertencias del grupo de cosas especificado.

aws iot set-v2-logging-level \
    --log-target "{\"targetType\":\"THING_GROUP\",\"targetName\":\"LightBulbs\"}" \
    --log-level WARN

Este comando no genera ninguna salida.

Para configurar las opciones de registro

En el siguiente set-v2-logging-options ejemplo, se establece el nivel de detalle de registro predeterminado ERROR y se especifica el que se debe utilizar ARN para el registro.

aws iot set-v2-logging-options \
    --default-log-level ERROR \
    --role-arn "arn:aws:iam::094249569039:role/service-role/iotLoggingRole"

Este comando no genera ninguna salida.

Para aplicar una acción de mitigación a los resultados de una auditoría

El siguiente start-audit-mitigation-actions-task ejemplo aplica la ResetPolicyVersionAction acción (que borra la política) a la conclusión ú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"

Salida:

{
    "taskId": "myActionsTaskId"
}

Para obtener más información, consulte StartAuditMitigationActionsTask (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para iniciar una auditoría de inmediato

El siguiente start-on-demand-audit-task ejemplo inicia una auditoría de AWS IoT Device Defender y realiza tres comprobaciones de certificados.

aws iot start-on-demand-audit-task \
    --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK

Salida:

{
    "taskId": "a3aea009955e501a31b764abe1bebd3d"
}

Para obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para especificar una etiqueta, una clave y un valor para un recurso

En el siguiente tag-resource ejemplo, se aplica la etiqueta con una clave Assembly y el valor Fact1NW al grupo de cosasLightBulbs.

aws iot tag-resource \
    --tags Key=Assembly,Value="Fact1NW" \
    --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs"

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo etiquetar sus recursos de AWS IoT en la Guía para desarrolladores de AWS IoT.

Para probar sus políticas AWS de IoT

El siguiente test-authorization ejemplo prueba las políticas de AWS IoT asociadas al 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

Salida:

{
    "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 obtener más información, consulte TestAuthorizationla APIReferencia de AWS IoT.

Para probar su autorizador personalizado

El siguiente test-invoke-authorizer ejemplo prueba su autorizador personalizado.

aws iot test-invoke-authorizer \
    --authorizer-name IoTAuthorizer \
    --token allow \
    --token-signature "mE0GvaHqy9nER/FdgtJX5lXYEJ3b3vE7t1gEszc0TKGgLKWXTnPkb2AbKnOAZ8lGyoN5dVtWDWVmr25m7++zjbYIMk2TBvyGXhOmvKFBPkdgyA43KL6SiZy0cTqlPMcQDsP7VX2rXr7CTowCxSNKphGXdQe0/I5dQ+JO6KUaHwCmupt0/MejKtaNwiia064j6wprOAUwG5S1IYFuRd0X+wfo8pb0DubAIX1Ua705kuhRUcTx4SxUShEYKmN4IDEvLB6FsIr0B2wvB7y4iPmcajxzGl02ExvyCUNctCV9dYlRRGJj0nsGzBIXOI4sGytPfqlA7obdgmN22pkDzYvwjQ=="

Salida:

{
    "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 obtener más información, consulte TestInvokeAuthorizerla APIReferencia de AWS IoT.

Para transferir un certificado de dispositivo a una AWS cuenta diferente

En el siguiente transfer-certificate ejemplo, se transfiere un certificado de dispositivo a otra AWS cuenta. El certificado y la AWS cuenta se identifican mediante un identificador.

aws iot transfer-certificate \
    --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 \
    --target-aws-account 030714055129

Salida:

{
    "transferredCertificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142"
}

Para obtener más información, consulte Transferir un certificado a otra cuenta en la Guía para desarrolladores de AWS IoT Core.

Para eliminar una clave de etiqueta de un recurso

En el siguiente untag-resource ejemplo, se elimina la etiqueta MyTag y su valor del grupo de cosasLightBulbs.

command

Este comando no genera ninguna salida.

Para obtener más información, consulte Cómo etiquetar sus recursos de AWS IoT en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Para habilitar las notificaciones de Amazon para SNS las notificaciones de auditoría

El siguiente update-account-audit-configuration ejemplo habilita SNS las notificaciones de Amazon para las notificaciones de auditoría de AWS IoT Device Defender, especificando un destino y la función utilizada para escribir en ese objetivo.

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 no genera ninguna salida.

Ejemplo 2: Para habilitar una comprobación de auditoría

El siguiente update-account-audit-configuration ejemplo habilita la comprobación de auditoría de AWS IoT Device Defender denominadaAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK. No puede deshabilitar una comprobación de auditoría si forma parte de targetCheckNames una o más auditorías programadas para la AWS cuenta.

aws iot update-account-audit-configuration \
    --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}"

Este comando no genera ninguna salida.

Para obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para actualizar la supresión de un hallazgo de auditoría

En el siguiente update-audit-suppression ejemplo, se actualiza la fecha de caducidad de la supresión de un hallazgo de auditoría al 21 de septiembre de 2020.

aws iot update-audit-suppression \
    --check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \
    --resource-identifier deviceCertificateId=c7691e<shortened> \
    --no-suppress-indefinitely \
    --expiration-date 2020-09-21

Este comando no genera ninguna salida.

Para obtener más información, consulte las supresiones de detección de auditorías en la Guía para desarrolladores de AWS IoT.

Para actualizar un autorizador personalizado

En el siguiente update-authorizer ejemplo, el estado de dosCustomAuthorizer2. INACTIVE

aws iot update-authorizer \
    --authorizer-name CustomAuthorizer2 \
    --status INACTIVE

Salida:

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

Para obtener más información, consulte UpdateAuthorizerla APIReferencia de AWS IoT.

Para actualizar la información sobre un grupo de facturación

En el siguiente update-billing-group ejemplo, se actualiza la descripción del grupo de facturación especificado.

aws iot update-billing-group \
    --billing-group-name GroupOne \
    --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\""

Salida:

{
    "version": 2
}

Para obtener más información, consulte Grupos de facturación en la Guía para desarrolladores de AWS IoT.

Para actualizar un certificado de una entidad emisora de certificados (CA)

En el siguiente update-ca-certificate ejemplo, se establece el ACTIVE estado del certificado de CA especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte U pdateCACertificate en la APIReferencia de AWS IoT.

Para actualizar un certificado de dispositivo

En el siguiente update-certificate ejemplo, se establece el INACTIVE estado del certificado del dispositivo especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte UpdateCertificatela APIReferencia de AWS IoT.

Para actualizar una métrica personalizada

En el siguiente update-custom-metric ejemplo, se actualiza una métrica personalizada para que tenga una nuevadisplay-name.

aws iot update-custom-metric \
    --metric-name batteryPercentage \
    --display-name 'remaining battery percentage on device' \
    --region us-east-1

Salida:

{
    "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 obtener más información, consulte Métricas personalizadas en la Guía para desarrolladores de AWS IoT Core.

Para actualizar una dimensión

El siguiente update-dimension ejemplo actualiza una dimensión.

aws iot update-dimension \
    --name TopicFilterForAuthMessages \
    --string-values device/${iot:ClientId}/auth

Salida:

{
    "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 obtener más información, consulte Definir el alcance de las métricas en los perfiles de seguridad mediante dimensiones en la Guía para desarrolladores de AWS IoT Core.

Para actualizar la configuración de un dominio

El siguiente update-domain-configuration ejemplo deshabilita la configuración de dominio especificada.

aws iot update-domain-configuration \
    --domain-configuration-name "additionalDataDomain" \
    --domain-configuration-status "DISABLED"

Salida:

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

Para obtener más información, consulte Terminales configurables en la Guía para desarrolladores de AWS IoT.

Para actualizar un grupo de cosas dinámico

En el siguiente update-dynamic-thing-group ejemplo, se actualiza el grupo de cosas dinámico especificado. Proporciona una descripción y actualiza la cadena de consulta para cambiar los criterios de pertenencia al 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"

Salida:

{
    "version": 2
}

Para obtener más información, consulte Grupos de cosas dinámicos en la Guía para desarrolladores de AWS IoT.

Para mostrar qué tipos de eventos se publican

El siguiente update-event-configurations ejemplo actualiza la configuración para habilitar los mensajes cuando se agrega, actualiza o elimina el certificado de CA.

aws iot update-event-configurations \
    --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}"

Este comando no genera ninguna salida.

Para obtener más información, consulte Mensajes de eventos en la Guía para desarrolladores de AWS IoT.

Para habilitar la indexación de cosas

El siguiente update-indexing-configuration ejemplo permite que la indexación de cosas permita buscar datos de registro, datos ocultos y estado de conectividad de cosas mediante el índice AWS_Things.

aws iot update-indexing-configuration
    --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS

Este comando no genera ninguna salida.

Para obtener más información, consulte Gestión de la indexación de cosas en la Guía para desarrolladores de AWS IoT.

Para obtener el estado detallado de un trabajo

En el siguiente update-job ejemplo se obtiene el estado detallado del trabajo cuyo identificador esexample-job-01.

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

Salida:

{
    "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 obtener más información, consulte Creación y administración de trabajos (CLI) en la Guía para desarrolladores de AWS IoT.

Para actualizar una acción de mitigación

En el siguiente update-mitigation-action ejemplo, se actualiza el nombre de la acción de mitigación especificadaAddThingsToQuarantineGroupAction, se cambia el nombre del grupo de cosas y se establece overrideDynamicGroups enfalse. Puede comprobar los cambios mediante el describe-mitigation-action comando.

aws iot update-mitigation-action \
    --cli-input-json "{ \"actionName\": \"AddThingsToQuarantineGroupAction\", \"actionParams\": { \"addThingsToThingGroupParams\": {\"thingGroupNames\":[\"QuarantineGroup2\"],\"overrideDynamicGroups\": false}}}"

Salida:

{
    "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
    "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa"
}

Para obtener más información, consulte UpdateMitigationAction (Comandos de acción de mitigación) en la Guía para desarrolladores de AWS IoT.

Para actualizar una plantilla de aprovisionamiento

En el siguiente update-provisioning-template ejemplo, se modifican la descripción y la función arn de la plantilla de aprovisionamiento especificada y se habilita la plantilla.

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 no genera ninguna salida.

Para obtener más información, consulte AWS IoT Secure Tunneling en la Guía para desarrolladores de AWS IoT Core.

Para actualizar un alias de rol

En el siguiente update-role-alias ejemplo, se actualiza el alias del LightBulbRole rol.

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

Salida:

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

Para obtener más información, consulte UpdateRoleAliasla APIReferencia de AWS IoT.

Para actualizar una definición de auditoría programada

El siguiente update-scheduled-audit ejemplo cambia los nombres de las comprobaciones de destino para una auditoría programada de AWS IoT Device Defender.

aws iot update-scheduled-audit \
    --scheduled-audit-name WednesdayCertCheck \
    --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK

Salida:

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

Para obtener más información, consulte Audit Commands en la Guía para desarrolladores de AWS IoT.

Para cambiar un perfil de seguridad

El siguiente update-security-profile ejemplo actualiza la descripción y los comportamientos de un perfil de seguridad de AWS IoT Device Defender.

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

Salida:

{
    "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 obtener más información, consulte Detectar comandos en la Guía para desarrolladores de AWS IoT.

Para actualizar una transmisión

En el siguiente update-stream ejemplo, se actualiza una transmisión existente. La versión de transmisión se incrementa en uno.

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

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

Salida:

{
    "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 obtener más información, consulte UpdateStreamla APIReferencia de AWS IoT.

Para actualizar la definición de un grupo de cosas

En el siguiente update-thing-group ejemplo, se actualiza la definición del grupo de cosas especificado y se cambian la descripción y dos atributos.

aws iot update-thing-group \
    --thing-group-name HalogenBulbs \
    --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"

Salida:

{
    "version": 2
}

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.

Para cambiar los grupos a los que pertenece una cosa

En el siguiente update-thing-groups-for-thing ejemplo, se MyLightBulb quita la cosa nombrada del grupo nombrado DeadBulbs y se agrega al grupo nombrado replaceableItems al mismo tiempo.

aws iot update-thing-groups-for-thing \
    --thing-name MyLightBulb \
    --thing-groups-to-add "replaceableItems" \
    --thing-groups-to-remove "DeadBulbs"

Este comando no genera ninguna salida.

Para obtener más información, consulte Thing Groups en la Guía para desarrolladores de AWS IoT.