Ejemplos de AWS IoT que utilizan la AWS CLI

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

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

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

Este comando no produce ninguna salida.

Para obtener más información, consulte Transfer a certificate to another account en la Guía para desarrolladores de AWS IoT Core.

Ejemplo 1: adición de un objeto por nombre a un grupo de facturación

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

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

Este comando no genera ninguna salida.

Ejemplo 2: adición de un objeto por ARN a un grupo de facturación

En el siguiente ejemplo de add-thing-to-billing-group, se agrega un objeto con un ARN especificado a un grupo de facturación con el ARN especificado. Especificar un ARN es útil si trabaja con varias regiones o cuentas de AWS. Puede ayudar a asegurarse de que está 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 Billing Groups en la Guía para desarrolladores de AWS IoT.

Para agregar un objeto a un grupo

En el siguiente ejemplo de add-thing-to-thing-group, se agrega el objeto especificado a un grupo de objetos 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 objetos a un trabajo continuo

En el siguiente ejemplo de associate-targets-with-job, se asocia el grupo de objetos 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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: asociación de una política a un grupo de objetos

En el siguiente ejemplo de attach-policy, se asocia la política especificada a un grupo de objetos identificado por su ARN.

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: asociación de una política a un certificado

En el siguiente ejemplo de attach-policy, se asocia la política UpdateDeviceCertPolicy a la entidad principal especificada por 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 Attach an AWS IoT Policy to a Device Certificate en la Guía para desarrolladores de AWS IoT.

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

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

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

Este comando no genera ninguna salida.

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

Para asociar un certificado a un objeto

En el siguiente ejemplo de attach-thing-principal se asocia un certificado al objeto MyTemperatureSensor. El certificado se identifica con un ARN. Encontrará el ARN de 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 acciones de mitigación de auditoría

El siguiente ejemplo de cancel-audit-mitigations-action-task, se cancela la aplicación de las acciones de mitigación para la tarea especificada. No se pueden cancelar tareas que 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 las acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para cancelar una tarea de auditoría

En el siguiente ejemplo de cancel-audit-task, se cancela una tarea de auditoría con el ID de tarea especificado. No se puede cancelar una tarea que se ha completado.

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

Este comando no genera ninguna salida.

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

Para cancelar la transferencia de un certificado a otra cuenta de AWS

En el siguiente ejemplo de cancel-certificate-transfer, se cancela la transferencia de certificado especificada. El certificado se identifica con un ID de certificado. 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 Transfer a certificate to another account en la Guía para desarrolladores de AWS IoT Core.

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

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

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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para cancelar un trabajo

En el siguiente ejemplo de cancel-job, se 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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para borrar el autorizador predeterminado

En el siguiente ejemplo de clear-default-authorizer, se borra el autorizador personalizado predeterminado configurado actualmente. Después de ejecutar este comando, no existe ningún autorizador predeterminado. Al utilizar un autorizador personalizado, debe especificarlo con su nombre en los encabezados de las solicitudes HTTP.

aws iot clear-default-authorizer

Este comando no genera ninguna salida.

Para obtener más información, consulte ClearDefaultAuthorizer en la Referencia de la API de AWS IoT.

Para confirmar un destino de regla de tema

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

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Confirming a topic rule destination en la Guía para desarrolladores de AWS IoT.

Para crear una supresión de resultado de auditoría

En el siguiente ejemplo de create-audit-suppression, se crea una eliminación de un resultado de auditoría de una política denominada virtualMachinePolicy que se ha marcado como 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 Supresiones de resultados de auditoría en la Guía para desarrolladores de AWS IoT.

Para crear un autorizador personalizado

En el siguiente ejemplo de create-authorizer, se crea un autorizador personalizado que utiliza la función de 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 CreateAuthorizer en la Referencia de la API de AWS IoT.

Para crear un grupo de facturación

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

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 Billing Groups 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 ejemplo de create-certificate-from-csr, se crea un certificado de dispositivo a partir de una CSR. Para crear una CSR, utilice el comando openssl.

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 CreateCertificateFromCSR en la Referencia de la API de AWS IoT.

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

En el siguiente ejemplo de create-custom-metric, 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

create-dimension crea una dimensión con un único filtro de tema denominado TopicFilterForAuthMessages.

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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para crear una configuración de dominio

En el siguiente ejemplo de create-domain-configuration, se crea una configuración de dominio administrado por AWS con un tipo de servicio DATA.

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 Configurable Endpoints en la Guía para desarrolladores de AWS IoT.

Para crear un grupo de objetos dinámico

En el siguiente ejemplo de create-dynamic-thing-group, se crea un grupo de objetos dinámico que contiene cualquier objeto con un atributo de temperatura superior a 60 grados. Debe habilitar la indexación de flotas de AWS IoT para poder usar grupos de objetos 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 Dynamic Thing Groups en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: creación de un trabajo

En el siguiente ejemplo de create-job, se crea un trabajo de AWS IoT sencillo que envía un documento JSON al dispositivo MyRaspberryPi.

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

Salida:

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

Ejemplo 2: creación de un trabajo continuo

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

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

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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Creación de un par de claves RSA y emisión de un certificado X.509

El siguiente create-keys-and-certificate crea un par de claves RSA de 2048 bits y emite un certificado X.509 mediante la clave pública emitida. Como esta es la única vez que 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 Create and Register an AWS IoT Device Certificate en la Guía para desarrolladores de AWS IoT.

Para crear acciones de mitigación

En el siguiente ejemplo de create-mitigation-action, se define una acción de mitigación denominada AddThingsToQuarantineGroup1Action que, cuando se aplica, mueve los objetos al grupo de objetos denominado QuarantineGroup1. Esta acción anula los grupos de objetos dinámicos.

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

Contenido 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 las acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para crear una actualización de OTA para usarla con Amazon FreeRTOS

En el siguiente ejemplo de create-ota-update, se Crea un OTAUpdate de AWS IoT en un grupo de destino de objetos o grupos. Esto forma parte de una actualización inalámbrica de Amazon FreeRTOS que 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

Contenido 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 CreateOTAUpdate en la Referencia de la API de AWS IoT.

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

En el siguiente ejemplo de create-policy-version, se actualiza una definición de política que 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

Contenido 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 AWS IoT Policies en la Guía para desarrolladores de AWS IoT.

Para crear una política de AWS IoT

En el siguiente ejemplo de create-policy, se crea una política de AWS IoT denominada TemperatureSensorPolicy. El archivo policy.json contiene instrucciones que permiten acciones de política de AWS IoT.

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

Contenido 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 AWS IoT Policies en la Guía para desarrolladores de AWS IoT.

Para crear una reclamación de aprovisionamiento

En el siguiente ejemplo de create-provisioning-claim, se crea una reclamació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 Provisioning by trusted user 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 de la plantilla de aprovisionamiento especificada. El cuerpo de la nueva versión se incluye en el archivo template.json.

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

Contenido 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 ejemplo de create-provisioning-template, 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

Contenido 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 ejemplo de create-role-alias, se crea un alias de rol denominado 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 CreateRoleAlias en la Referencia de la API de AWS IoT.

Para crear una auditoría programada

En el siguiente ejemplo de create-scheduled-audit, 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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para crear un perfil de seguridad

En el siguiente ejemplo de create-security-profile, se 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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para crear un flujo para la entrega de uno o más archivos grandes en fragmentos a través de MQTT

En el siguiente ejemplo de create-stream, se crea un flujo para entregar uno o varios archivos grandes en fragmentos a través de MQTT. Un flujo trasporta bytes de datos en fragmentos o bloques empaquetados como mensajes MQTT desde un origen como S3. Puede tener uno o más archivos asociados con un flujo.

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

Contenido 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 CreateStream en la Referencia de la API de AWS IoT.

Ejemplo 1: creación de un grupo de objetos

En el siguiente ejemplo de create-thing-group, se crea un grupo de objetos 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: creación de un grupo de objetos que forme parte de un grupo principal

create-thing-group crea un grupo de objetos denominado HalogenBulbs que tiene un grupo de objetos principal denominado LightBulbs.

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 objeto

En el siguiente ejemplo de create-thing-type, se define un tipo de objeto 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 Thing Types en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: creación de un registro de objetos en el registro

En el siguiente ejemplo de create-thing se crea una entrada para un dispositivo en el registro de objetos 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: definición de un objeto que está asociado a un tipo de objeto

En el siguiente ejemplo de create-thing se crea un objeto que tiene el tipo de objeto 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 How to Manage Things with the Registry y Thing Types en la Guía para desarrolladores de AWS IoT.

Para crear un destino de regla de tema

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

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 Creating a topic rule destination en la Guía para desarrolladores de AWS IoT.

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

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

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

El ejemplo requiere que se guarde el siguiente código JSON en un archivo denominadoplant-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 Creating an AWS IoT Rule en la Guía para desarrolladores de AWS IoT.

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

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

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

Este comando no genera ninguna salida.

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

Para eliminar la supresión de un resultado de auditoría

En el siguiente ejemplo de delete-audit-suppression, se elimina una supresión de resultado de auditoría de 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 Supresiones de resultados de auditoría en la Guía para desarrolladores de AWS IoT.

Para eliminar un autorizador personalizado

En el siguiente ejemplo de delete-authorizer, se elimina el autorizador denominado CustomAuthorizer. Un autorizador personalizado debe tener el estado INACTIVE para que se pueda eliminar.

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

Este comando no genera ninguna salida.

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

Para eliminar un grupo de facturación

En el siguiente ejemplo de delete-billing-group, se elimina el grupo de facturación especificado. Puede eliminar un grupo de facturación aunque contenga uno o varios objetos.

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

Este comando no produce ninguna salida.

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

Para eliminar un certificado de CA

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

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteCACertificate en la Referencia de la API de AWS IoT.

Para eliminar un certificado de dispositivo

En el siguiente ejemplo de delete-certificate se elimina el certificado de 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 DeleteCertificate en la Referencia de la API de AWS IoT.

Para eliminar una métrica personalizada

En el siguiente ejemplo de delete-custom-metric, 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 siguiente ejemplo de delete-dimension, se elimina una dimensión denominada TopicFilterForAuthMessages.

aws iot delete-dimension \
    --name TopicFilterForAuthMessages

Este comando no genera ninguna salida.

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

Para eliminar una configuración de dominio

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

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 Configurable Endpoints en la Guía para desarrolladores de AWS IoT.

Para eliminar un grupo de objetos dinámico

En el siguiente ejemplo de delete-dynamic-thing-group, se elimina el grupo de objetos 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 Dynamic Thing Groups en la Guía para desarrolladores de AWS IoT.

Para eliminar una ejecución de trabajo

En el siguiente ejemplo de delete-job-execution, se elimina la ejecución del trabajo especificado en un dispositivo. Utilice 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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Eliminación de un trabajo

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

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para eliminar una acción de mitigación

En el siguiente ejemplo de delete-mitigation-action, 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 las acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para eliminar una actualización OTA

En el siguiente ejemplo de delete-ota-update, se elimina la actualización de OTA 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 DeleteOTAUpdate en la Referencia de la API de AWS IoT.

Para eliminar una versión de una política

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

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 AWS IoT Policies en la Guía para desarrolladores de AWS IoT.

Eliminación de una política

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

aws iot delete-policy --policy-name UpdateDeviceCertPolicy

Este comando no genera ninguna salida.

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

Para eliminar una versión de plantilla de aprovisionamiento

En el siguiente ejemplo de delete-provisioning-template-version, 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 ejemplo de delete-provisioning-template, 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

En el siguiente ejemplo de delete-registration-code, se elimina un 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 Your Own Certificate en la Guía para desarrolladores de AWS IoT.

Para eliminar un alias de rol de AWS IoT

En el siguiente ejemplo de delete-role-alias, se elimina un alias de rol de AWS IoT denominado LightBulbRole.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Authorizing Direct Calls to AWS Services en la Guía para desarrolladores de AWS IoT.

Para eliminar una auditoría programada

En el siguiente ejemplo de delete-scheduled-audit, se elimina la auditoría programada de AWS IoT Device Defender denominada AWSIoTDeviceDefenderDailyAudit.

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

Este comando no genera ninguna salida.

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

Para eliminar un perfil de seguridad

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

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

Este comando no genera ninguna salida.

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

Para eliminar un flujo

En el siguiente ejemplo de delete-stream, se elimina el flujo especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteStream en la Referencia de la API de AWS IoT.

Para eliminar un grupo de objetos

En el siguiente ejemplo de delete-thing-group, se elimina el grupo de objetos especificado. No se puede eliminar un grupo de objetos si contiene grupos de objetos 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: eliminación de un tipo de objeto

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

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

Este comando no genera ninguna salida.

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

Para visualizar información detallada acerca de un objeto

En el siguiente ejemplo de delete-thing se elimina un objeto del registro de AWS IoT de su cuenta de AWS.

aws iot delete-thing --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 un destino de regla de tema

En el siguiente ejemplo de delete-topic-rule-destination, se elimina el destino de la regla del tema especificado.

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 Deleting a topic rule destination en la Guía para desarrolladores de AWS IoT.

Para eliminar una regla

En el siguiente ejemplo de delete-topic-rule, 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 Deleting a Rule en la Guía para desarrolladores de AWS IoT.

Para eliminar el nivel de registro de un grupo de objetos

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

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

Este comando no genera ninguna salida.

Ejemplo 1: obsolescencia de un tipo de objeto

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

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

Este comando no genera ninguna salida.

Ejemplo 2: reversión de la obsolescencia de un tipo de objeto

En el siguiente ejemplo de deprecate-thing-type, se anula la obsolescencia de un tipo de objeto, lo que permite a los usuarios volver a asociarle objetos nuevos.

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

Este comando no genera ninguna salida.

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

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

En el siguiente ejemplo de describe-account-audit-configuration, se enumera 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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para enumerar los detalles de un resultado de auditoría

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

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 resultados de auditoría (Comandos de auditoría) en la Guía para desarrolladores de AWS IoT.

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

En el siguiente ejemplo de describe-audit-mitigation-actions-task, se muestran los detalles de la tarea especificada en la que se ha aplicado ResetPolicyVersionAction a un resultado. Los resultados incluyen cuándo comenzó y finalizó la tarea, cuántos resultados 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 las acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre la supresión de un resultado de auditoría

En el siguiente ejemplo de describe-audit-suppression, se enumeran los detalles sobre la supresión de un resultado 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 Supresiones de resultados de auditoría en la Guía para desarrolladores de AWS IoT.

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

En el siguiente ejemplo de describe-audit-task, se 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 de resumen 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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre un autorizador personalizado

En el siguiente ejemplo de describe-authorizer, 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 DescribeAuthorizer en la Referencia de la API de AWS IoT.

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

En el siguiente ejemplo de describe-billing-group, 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 Billing Groups en la Guía para desarrolladores de AWS IoT.

Para obtener detalles sobre un certificado de CA

En el siguiente ejemplo de describe-ca-certificate, 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 DescribeCACertificate en la Referencia de la API de AWS IoT.

Para obtener información sobre un certificado

En el siguiente ejemplo de describe-certificate, 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 DescribeCertificate en la Referencia de la API de AWS IoT.

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

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

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 un autorizador personalizado predeterminado

En el siguiente ejemplo de describe-default-authorizer, 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 DescribeDefaultAuthorizer en la Referencia de la API de AWS IoT.

Para obtener información sobre una dimensión

En el siguiente ejemplo de describe-dimension, se obtiene información sobre una dimensión denominada TopicFilterForAuthMessages.

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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para describir una configuración de dominio

En el siguiente ejemplo de describe-domain-configuration, se muestran los detalles de la configuración de dominios 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 Configurable Endpoints en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: Obtención de su punto de conexión de AWS actual

En el siguiente ejemplo de describe-endpoint se recupera el punto de conexión predeterminado de AWS 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 DescribeEndpoint en la Guía para desarrolladores de AWS IoT.

Ejemplo 2: Obtención del punto de conexión ATS

En el siguiente ejemplo de describe-endpoint se recupera el punto de conexión 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 y AWS IoT en la Guía para desarrolladores de AWS IoT.

Para mostrar qué tipos de eventos se publican

En el siguiente ejemplo de describe-event-configurations, se enumera la configuración que controla los eventos que 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 Event Messages en la Guía para desarrolladores de AWS IoT.

Para recuperar el estado actual del índice de objetos

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

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 Managing Thing Indexing, 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 ejemplo de describe-job-execution, se obtienen los detalles de la 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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para obtener el estado detallado de un trabajo

En el siguiente ejemplo de describe-job, se obtiene el estado detallado del trabajo cuyo ID es example-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 Creating and Managing Jobs (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 ejemplo de describe-mitigation-action, 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 las acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para describir una versión de plantilla de aprovisionamiento

En el siguiente ejemplo de describe-provisioning-template-version, 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 Provisioning devices that don't have device certificates using fleet provisioning en la Guía para desarrolladores de AWS IoT Core.

Para describir una plantilla de aprovisionamiento

En el siguiente ejemplo de describe-provisioning-template, 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 Provisioning devices that don't have device certificates using fleet provisioning en la Guía para desarrolladores de AWS IoT Core.

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

En el siguiente ejemplo de describe-role-alias, se muestran los detalles del alias del 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 DescribeRoleAlias en la Referencia de la API de AWS IoT.

Para obtener información acerca de una auditoría programada

En el siguiente ejemplo de describe-scheduled-audit, se obtiene información detallada sobre una auditoría de AWS IoT Device Defender denominada AWSIoTDeviceDefenderDailyAudit.

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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre un perfil de seguridad

En el siguiente ejemplo de describe-security-profile, se 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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para obtener información acerca de un flujo

En el siguiente ejemplo de describe-stream, se muestran los detalles del flujo especificado.

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 DescribeStream en la Referencia de la API de AWS IoT.

Para obtener información acerca de un grupo de objetos

En el siguiente ejemplo de describe-thing-group, se obtiene información sobre el grupo de objetos denominado HalogenBulbs.

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 acerca de un tipo de objeto

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

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 Thing Types en la Guía para desarrolladores de AWS IoT.

Para visualizar información detallada acerca de un objeto

En el siguiente ejemplo de describe-thing se muestra información sobre un objeto (dispositivo) que está definido en el registro de AWS IoT de su cuenta de AWS.

aws iot describe-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: desasociación de una política de AWS IoT de un grupo de objetos

En el siguiente ejemplo de detach-policy, se desvincula la política especificada de un grupo de objetos y, por extensión, de todos los objetos 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: desasociación de una política de AWS IoT de un certificado de dispositivo

En el siguiente ejemplo de detach-policy, se desvincula la política TemperatureSensorPolicy de un certificado de dispositivo identificado por el 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 destino

En el siguiente ejemplo de detach-security-profile, se elimina la asociación entre el perfil de seguridad de AWS IoT Device Defender denominado Testprofile y el objetivo de todos los objetos registrados.

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

Este comando no genera ninguna salida.

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

Para desasociar un certificado o entidad principal de un objeto

En el siguiente ejemplo de detach-thing-principal se elimina un certificado que representa una entidad principal del objeto 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 de tema

En el siguiente ejemplo de disable-topic-rule, 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 Viewing Your Rules en la Guía para desarrolladores de AWS IoT.

Para habilitar una regla de tema

En el siguiente ejemplo de enable-topic-rule, se habilita (o se vuelve a habilitar) la regla del tema especificada.

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

Este comando no genera ninguna salida.

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

Para enumerar el estado del modelo de entrenamiento del perfil de seguridad para la detección de ML de Device Defender

En el siguiente ejemplo de get-behavior-model-training-summaries, se enumera el estado de entrenamiento del modelo de 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 (Comandos de detección) en la Guía para desarrolladores de AWS IoT.

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

Puede usar el siguiente script de configuración para crear diez elementos que representen diez sensores de temperatura. Cada objeto nuevo tiene tres 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"
}

En el siguiente ejemplo de get-cardinality, se consultan los diez sensores creados por el script de configuración y se devuelve el número de racks con sensores de temperatura que indican valores de temperatura anormales. Si el valor de temperatura es inferior a 60 o superior a 80, el estado del sensor de temperatura es 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 Querying for Aggregate Data<https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html> en la Guía para desarrolladores de AWS IoT.

Para enumerar las políticas que afectan a un objeto

En el siguiente ejemplo de get-effective-policies, se enumeran las políticas que afectan al objeto 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 objetos

En el siguiente ejemplo de get-indexing-configuration, se obtienen 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 Managing Thing Indexing en la Guía para desarrolladores de AWS IoT.

Para recuperar el documento para un trabajo

En el siguiente ejemplo de get-job-document, se muestran los detalles del documento para el trabajo con el ID example-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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para obtener las opciones de registro

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

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 actualización OTA

En el siguiente ejemplo de get-ota-update, se muestran los detalles de las actualizaciones OTA especificadas.

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 GetOTAUpdate en la Referencia de la API de AWS IoT.

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

Puede usar el siguiente script de configuración para crear diez elementos que representen diez sensores de temperatura. Cada objeto 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"
}

En el siguiente ejemplo de get-percentiles, se consultan los diez sensores creados por el script de configuración y se devuelve un valor para cada grupo de percentiles especificado. El grupo de percentiles 10 contiene el valor agregado del campo que se obtiene aproximadamente en el diez por ciento de los valores que coinciden con la consulta. En el siguiente resultado, {"percent": 10.0, "value": 67.7} significa que aproximadamente el 10 % de los valores de temperatura están por debajo de 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 Querying for Aggregate Data 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 ejemplo de get-policy-version, 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 AWS IoT Policies en la Guía para desarrolladores de AWS IoT.

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

En el siguiente ejemplo de get-policy, se obtiene 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 AWS IoT Policies en la Guía para desarrolladores de AWS IoT.

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

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

aws iot get-registration-code

Salida:

{
    "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c"
}

Para obtener más información, consulte Use Your Own Certificate en la Guía para desarrolladores de AWS IoT.

Para buscar datos agregados en el índice de dispositivos

En el siguiente ejemplo de get-statistics, se devuelve el número de objetos que tiene 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 Getting Statistics About Your Device Fleet en la Guía para desarrolladores de AWS IoT.

Para obtener un destino de regla de tema

En el siguiente ejemplo de get-topic-rule-destination, se obtiene información sobre un destino de regla de tema.

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 Working with topic rule destinations en la Guía para desarrolladores de AWS IoT.

Para obtener información sobre una regla

En el siguiente ejemplo de get-topic-rule, 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 Viewing Your Rules en la Guía para desarrolladores de AWS IoT.

Para enumerar las opciones de registro actuales

En el siguiente ejemplo de get-v2-logging-options, se enumeran las opciones de registro de AWS IoT actuales.

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 ejemplo de list-active-violations, 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: lista de las políticas asociadas a un grupo

En el siguiente ejemplo de list-attached-policies, se enumeran las políticas que se asocian 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: lista de las políticas asociadas a un certificado de dispositivo

En el siguiente ejemplo de list-attached-policies, se enumeran las políticas de AWS IoT asociadas al certificado del dispositivo. El certificado se identifica con su ARN.

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: lista de todos los resultados de una auditoría

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

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

Salida:

{
    "findings": []
}

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

En el siguiente ejemplo de list-audit-findings, se muestran 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 Comandos de auditoría 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 resultados de una auditoría de AWS IoT Device Defender. En el siguiente ejemplo de list-audit-mitigation-actions-executions, se enumeran los detalles de la tarea de acción de mitigación con el taskId y el resultado especificados.

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 acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

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

En el siguiente ejemplo de list-audit-mitigation-actions-tasks, se enumeran las acciones de mitigación que se han aplicado a los resultados 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 acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para enumerar las supresiones de resultados de auditoría

En el siguiente ejemplo de list-audit-suppressions, se enumeran todas las supresiones de resultados 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 Supresiones de resultados de auditoría en la Guía para desarrolladores de AWS IoT.

Para enumerar todos los resultados de una auditoría

En el siguiente ejemplo de list-audit-tasks, se enumeran las tareas de auditoría que se han realizado entre el 5 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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para enumerar su autorizador personalizado

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

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 ListAuthorizers en la Referencia de la API de AWS IoT.

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

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

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 Billing Groups en la Guía para desarrolladores de AWS IoT.

Para enumerar los certificados de CA registrados en la cuenta de AWS

En el siguiente ejemplo de list-ca-certificates, se enumeran los certificados de CA registrados en su cuenta de AWS.

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 Your Own Certificate en la Guía para desarrolladores de AWS IoT.

Para ver una lista de todos los certificados de dispositivos firmados con un certificado de CA

En el siguiente ejemplo de list-certificates-by-ca, se enumeran todos los certificados de dispositivo de su cuenta de AWS 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 en la Referencia de la API de AWS IoT.

Ejemplo 1: enumeración de los certificados registrados en la cuenta de AWS

En el siguiente ejemplo de list-certificates se muestra una lista de todos los certificados registrados en la cuenta. Si supera el límite de paginación predeterminado de 25, puede utilizar el valor de respuesta nextMarker de este comando e introducirlo en el siguiente comando para obtener el siguiente lote de resultados. Repita el procedimiento hasta que nextMarker no devuelva 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 sus métricas personalizadas

En el siguiente ejemplo de list-custom-metrics, se enumeran 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 su cuenta de AWS

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

aws iot list-dimensions

Salida:

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

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

Para enumerar las configuraciones de dominio

En el siguiente ejemplo de list-domain-configurations, se enumeran las configuraciones de dominio de su cuenta de AWS 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 Configurable Endpoints en la Guía para desarrolladores de AWS IoT.

Para enumerar los índices de búsqueda configurados

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

aws iot list-indices

Salida:

{
    "indexNames": [
        "AWS_Things"
    ]
}

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

Para enumerar los trabajos de su cuenta de AWS

En el siguiente ejemplo de list-job-executions-for-job, se enumeran todas las ejecuciones de trabajos de un trabajo de su cuenta de AWS, especificadas por el jobId.

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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para enumerar los trabajos que se han ejecutado para un objeto

En el siguiente ejemplo de list-job-executions-for-thing, se enumeran todos los trabajos que se han ejecutado para el objeto denominado MyRaspberryPi.

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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para enumerar los trabajos de su cuenta de AWS

En el siguiente ejemplo de list-jobs, se enumeran todos los trabajos de la cuenta de AWS ordenados por estado del trabajo.

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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para enumerar todas las acciones de mitigación definidas

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

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 acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para enumerar todas las acciones de mitigación definidas

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

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 acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para ver una lista de las actualizaciones de OTA de la cuenta

En el siguiente ejemplo de list-ota-updates, se enumeran las actualizaciones OTA 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 ListOTAUpdates en la Referencia de la API de AWS IoT.

Para ver una lista de los certificados que se están transfiriendo a una cuenta de AWS diferente

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

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 ListOutgoingCertificates en la Referencia de la API de AWS IoT.

Para ver una lista de las políticas definidas en su cuenta de AWS

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

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 AWS IoT Policies en la Guía para desarrolladores de AWS IoT.

Ejemplo 1: visualización de todas las versiones de una política

En el siguiente ejemplo de list-policy-versions, se enumeran 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 AWS IoT Policies en la Guía para desarrolladores de AWS IoT.

Para enumerar los objetos asociados a una entidad principal

En el siguiente ejemplo de list-principal-things, se enumeran los objetos asociados a la entidad principal especificada por un ARN.

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 ListPrincipalThings en la Referencia de la API de AWS IoT.

Para enumerar las versiones de plantillas de aprovisionamiento

En el siguiente ejemplo de list-provisioning-template-versions, se enumeran las versiones 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 ejemplo de list-provisioning-templates, se enumeran todas las plantillas de aprovisionamiento de la cuenta de AWS.

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 su cuenta de AWS

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

aws iot list-role-aliases

Salida:

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

Para obtener más información, consulte ListRoleAliases en la Referencia de la API de AWS IoT.

Para enumerar las auditorías programadas para su cuenta AWS

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

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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para enumerar los perfiles de seguridad asociados a un destino

En el siguiente ejemplo de list-security-profiles-for-target, se enumeran los perfiles de seguridad de AWS IoT Device Defender 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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para enumerar los perfiles de seguridad de su cuenta de AWS

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

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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para enumerar los flujos de la cuenta

En el siguiente ejemplo de list-streams, se enumeran todos los flujos de la cuenta de AWS.

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 ListStreams en la Referencia de la API de AWS IoT.

Para mostrar las etiquetas y sus valores asociados a un recurso

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

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 Tagging Your AWS Resources en la Guía para desarrolladores de AWS IoT.

Para enumerar las entidades principales asociadas a una política de AWS IoT

En el siguiente ejemplo de list-targets-for-policy, se enumeran los certificados de dispositivo que tienen asociada 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 destinos a los que se aplica un perfil de seguridad

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

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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para enumerar los grupos a los que pertenece un objeto

En el siguiente ejemplo de list-thing-groups-for-thing, se enumeran los grupos a los que pertenece el objeto especificado.

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 objetos en su cuenta de AWS

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

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 las entidades principales asociadas con el objeto

En el siguiente ejemplo de list-thing-principals, se enumeran las entidades principales (certificados X.509, usuarios de IAM, roles, identidades de Amazon Cognito o identidades federadas) asociadas al objeto 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 ListThingPrincipals en la Referencia de la API de AWS IoT.

Para enumerar los tipos de objetos definidos

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

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 Thing Types en la Guía para desarrolladores de AWS IoT.

Para enumerar los objetos de un grupo de facturación

En el siguiente ejemplo de list-things-in-billing-group, se enumeran los objetos 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 Billing Groups en la Guía para desarrolladores de AWS IoT.

Para enumerar los objetos que pertenecen a un grupo

En el siguiente ejemplo de list-things-in-thing-group, se enumeran los objetos a los que pertenece el grupo de objetos 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 ejemplo de list-things se enumeran los objetos (dispositivos) que están definidos en el registro de AWS IoT de su cuenta de AWS.

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 sus reglas de tema

En el siguiente ejemplo de list-topic-rule-destinations, se enumeran todos los destinos de las reglas de tema que ha definido en la región de AWS 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 Working with topic rule destinations en la Guía para desarrolladores de AWS IoT.

Para enumerar las reglas

En el siguiente ejemplo de list-topic-rules, 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 Viewing Your Rules en la Guía para desarrolladores de AWS IoT.

Para enumerar los niveles de registro

En el siguiente ejemplo de list-v2-logging-levels, se enumeran los niveles de registro configurados. Si no se han establecido niveles de registro, se produce una NotConfiguredException 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 de tiempo

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

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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para recuperar el certificado de una entidad de certificación (CA)

En el siguiente ejemplo de register-ca-certificate, 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 RegisterCACertificate en la Referencia de la API de AWS IoT.

Para registrar un certificado de dispositivo autofirmado

En el siguiente ejemplo de register-certificate, se registra el certificado de dispositivo deviceCert.pem firmado por el certificado de CA rootCA.pem. 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 RegisterCertificate en la Referencia de la API de AWS IoT.

Para registrar un objeto

En el siguiente ejemplo de register-thing, se registra un objeto 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 Provisioning by trusted user en la Guía para desarrolladores de AWS IoT Core.

Para rechazar una transferencia de certificado

En el siguiente ejemplo de reject-certificate-transfer, se rechaza la transferencia del certificado de dispositivo especificado desde otra cuenta de AWS.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Transfer a certificate to another account en la Guía para desarrolladores de AWS IoT Core.

Para quitar un objeto de un grupo de facturación

En el siguiente ejemplo de remove-thing-from-billing-group, se elimina el objeto 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 Billing Groups en la Guía para desarrolladores de AWS IoT.

Para quitar un objeto de un grupo de objetos

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

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 una definición de reglas de un tema

En el siguiente ejemplo de replace-topic-rule, se actualiza la regla especificada para enviar una alerta de SNS cuando los valores de las lecturas del nivel de humedad del suelo son 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 Creating an AWS IoT Rule en la Guía para desarrolladores de AWS IoT.

Para consultar el índice de objetos

En el siguiente ejemplo de search-index se consulta en el índice de AWS_Things los objetos que son del tipo LightBulb.

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 Managing Thing Indexing, en la Guía para desarrolladores de AWS IoT.

Para definir el autorizador predeterminado

En el siguiente ejemplo de set-default-authorizer, se establece el autorizador personalizado denominado CustomAuthorizer como el 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 CreateDefaultAuthorizer en la Referencia de la API de AWS IoT.

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

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

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

Este comando no genera ninguna salida.

Para definir el nivel de registro de un grupo de objetos

En el siguiente ejemplo de set-v2-logging-level, se define el nivel de registro para registrar avisos para el grupo de objetos especificado.

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

Este comando no genera ninguna salida.

Para definir las opciones de registro

En el siguiente ejemplo de set-v2-logging-options, se establece el nivel de verbosidad de registro predeterminado en ERROR y se especifica el ARN que se utilizará 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

En el siguiente ejemplo de start-audit-mitigation-actions-task, se aplica la acción ResetPolicyVersionAction (que borra la política) al único resultado especificado.

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 acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para iniciar una auditoría de inmediato

En el siguiente ejemplo de start-on-demand-audit-task, se inicia una auditoría de AWS IoT Device Defender y se realizan 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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para especificar una clave y valor de etiqueta para un recurso

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

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 Tagging Your AWS Resources en la Guía para desarrolladores de AWS IoT.

Para probar sus políticas de AWS IoT

En el siguiente ejemplo de test-authorization, se prueban las políticas de AWS IoT asociadas a la entidad principal especificada.

aws iot test-authorization \
    --auth-infos actionType=CONNECT,resources=arn:aws:iot:us-east-1:123456789012:client/client1 \
    --principal arn:aws:iot:us-west-2:123456789012:cert/aab1068f7f43ac3e3cae4b3a8aa3f308d2a750e6350507962e32c1eb465d9775

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 TestAuthorization en la Referencia de la API de AWS IoT.

Para probar el autorizador personalizado

En el siguiente ejemplo de test-invoke-authorizer, se prueba el 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 TestInvokeAuthorizer en la Referencia de la API de AWS IoT.

Para transferir un certificado de dispositivo a otra cuenta de AWS

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

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 Transfer a certificate to another account en la Guía para desarrolladores de AWS IoT Core.

Para eliminar una clave de etiqueta de un recurso

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

command

Este comando no genera ninguna salida.

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

Ejemplo 1: activación de las notificaciones de Amazon SNS para las notificaciones de auditoría

En el siguiente ejemplo de update-account-audit-configuration, se habilitan las notificaciones de Amazon SNS para las notificaciones de auditoría de AWS IoT Device Defender, especificando un destino y el rol utilizado para escribir en ese destino.

aws iot update-account-audit-configuration \
    --audit-notification-target-configurations "SNS={targetArn=\"arn:aws:sns:us-west-2:123456789012:ddaudits\",roleArn=\"arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit\",enabled=true}"

Este comando no genera ninguna salida.

Ejemplo 2: activación de una comprobación de auditoría

En el siguiente ejemplo de update-account-audit-configuration, se activa la comprobación de auditoría de AWS IoT Device Defender denominada AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK. No puede deshabilitar una comprobación de auditoría si forma parte de targetCheckNames para una o más auditorías programadas para la cuenta de AWS.

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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

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

En el siguiente ejemplo de update-audit-suppression, se actualiza la fecha de caducidad de la supresión de un resultado 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 Supresiones de resultados de auditoría en la Guía para desarrolladores de AWS IoT.

Para actualizar un autorizador personalizado

En el siguiente ejemplo de update-authorizer, el estado de CustomAuthorizer2 cambia a 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 UpdateAuthorizer en la Referencia de la API de AWS IoT.

Para actualizar información acerca de un grupo de facturación

En el siguiente ejemplo de update-billing-group, 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 Billing Groups en la Guía para desarrolladores de AWS IoT.

Para actualizar el certificado de una entidad de certificación (CA)

En el siguiente ejemplo de update-ca-certificate, se establece el estado ACTIVE para el 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 UpdateCACertificate en la Referencia de la API de AWS IoT.

Para actualizar el certificado de un dispositivo

En el siguiente ejemplo de update-certificate, se establece el estado INACTIVE para el certificado de 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 UpdateCertificate en la Referencia de la API de AWS IoT.

Para actualizar una métrica personalizada

En el siguiente ejemplo de update-custom-metric, se actualiza una métrica personalizada para que tenga un nuevo display-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

En el siguiente ejemplo de update-dimension, se 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 Scoping metrics in security profiles using dimensions en la Guía para desarrolladores de AWS IoT Core.

Para actualizar una configuración de dominio

En el siguiente ejemplo de update-domain-configuration, se desactiva la configuración de dominios 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 Configurable Endpoints en la Guía para desarrolladores de AWS IoT.

Para actualizar un grupo de objetos dinámico

En el siguiente ejemplo de update-dynamic-thing-group, se actualiza el grupo de objetos 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 Dynamic Thing Groups en la Guía para desarrolladores de AWS IoT.

Para mostrar qué tipos de eventos se publican

En el siguiente ejemplo de update-event-configurations, se 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 Event Messages en la Guía para desarrolladores de AWS IoT.

Para activar la indexación de objetos

En el siguiente ejemplo de update-indexing-configuration se permite que la indexación de objetos admita la búsqueda de datos de registro, datos de sombra y el estado de conectividad de los objetos 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 Managing Thing Indexing en la Guía para desarrolladores de AWS IoT.

Para obtener el estado detallado de un trabajo

En el siguiente ejemplo de update-job, se obtiene el estado detallado del trabajo cuyo ID es example-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 Creating and Managing Jobs (CLI) en la Guía para desarrolladores de AWS IoT.

Para actualizar una acción de mitigación

En el siguiente ejemplo de update-mitigation-action, se actualiza la acción de mitigación denominada AddThingsToQuarantineGroupAction especificada, se cambia el nombre del grupo de objetos y se establece overrideDynamicGroups en false. Para verificar los cambios, use el comando describe-mitigation-action.

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 acciones de mitigación) en la Guía para desarrolladores de AWS IoT.

Para actualizar una plantilla de aprovisionamiento

En el siguiente ejemplo de update-provisioning-template, se modifica el ARN de la descripción y el rol 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 ejemplo de update-role-alias, se actualiza el alias de rol de LightBulbRole.

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 UpdateRoleAlias en la Referencia de la API de AWS IoT.

Para actualizar una definición de auditoría programada

En el siguiente ejemplo de update-scheduled-audit, se cambian 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 Comandos de auditoría en la Guía para desarrolladores de AWS IoT.

Para modificar un perfil de seguridad

En el siguiente ejemplo de update-security-profile, se 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 Comandos de detección en la Guía para desarrolladores de AWS IoT.

Para actualizar un flujo

En el siguiente ejemplo de update-stream, se actualiza un flujo existente. La versión del flujo aumentará en uno.

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

Contenido 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 UpdateStream en la Referencia de la API de AWS IoT.

Para actualizar la definición de un grupo de objetos

En el siguiente ejemplo de update-thing-group, se actualiza la definición del grupo de objetos 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 modificar los grupos a los que pertenece un objeto

En el siguiente ejemplo de update-thing-groups-for-thing, se elimina el objeto denominado MyLightBulb del grupo denominado DeadBulbs y, al mismo tiempo, se añade al grupo denominado replaceableItems.

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.

Para asociar un objeto con un tipo de objeto

En el siguiente ejemplo de update-thing se asocia un objeto del registro de AWS IoT con un tipo de objeto. Al realizar la asociación, se proporcionan valores para los atributos definidos por el tipo de objeto.

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