Exemples d’utilisation de l’AWS CLI avec AWS IoT

Pour accepter un certificat d’appareil transféré depuis un autre compte AWS

L’exemple accept-certificate-transfer suivant accepte un certificat d’appareil transféré depuis un autre compte AWS. Le certificat est identifié par son ID.

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

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Transférer un certificat vers un autre compte dans le Manuel du développeur AWS IoT Core.

Exemple 1 : pour ajouter un objet par son nom à un groupe de facturation

L’exemple add-thing-to-billing-group suivant ajoute l’objet nommé MyLightBulb au groupe de facturation nommé GroupOne.

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

Cette commande ne produit aucune sortie.

Exemple 2 : pour ajouter un objet par son ARN à un groupe de facturation

L’exemple add-thing-to-billing-group suivant ajoute un objet avec un ARN spécifié à un groupe de facturation avec l’ARN spécifié. La spécification d’un ARN est utile si vous utilisez plusieurs régions ou comptes AWS. Cela vous permet de veiller à effectuer un ajout à la bonne région et au bon compte.

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"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour ajouter un objet à un groupe

L’exemple add-thing-to-thing-group suivant ajoute l’objet spécifié au groupe d’objets spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour associer un groupe d’objets à une tâche continue

L’exemple associate-targets-with-job suivant associe le groupe d’objets spécifié à la tâche continue spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Exemple 1 : pour attacher une stratégie à un groupe d’objets

L’exemple attach-policy suivant attache la stratégie spécifiée à un groupe d’objets identifié par son ARN.

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

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Exemple 2 : pour attacher une stratégie à un certificat

L’exemple attach-policy suivant attache la stratégie UpdateDeviceCertPolicy au principal spécifié par un certificat.

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

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Attacher une stratégie AWS IoT à un certificat d’appareil dans le Manuel du développeur AWS IoT.

Pour associer un profil de sécurité à tous les appareils non enregistrés

L’exemple attach-security-profile suivant associe le profil de sécurité AWS IoT Device Defender nommé Testprofile à tous les appareils non enregistrés de la région us-west-2 pour ce compte AWS.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour attacher un certificat à votre objet

L’exemple attach-thing-principal suivant attache un certificat à l’objet MyTemperatureSensor. Le certificat est identifié par un ARN. Vous trouverez l’ARN d’un certificat dans la console AWS IoT.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Comment gérer des objets avec le registre dans le Manuel du développeur AWS IoT.

Pour annuler une tâche d’actions d’atténuation d’audit

L’exemple cancel-audit-mitigations-action-task suivant annule l’application d’actions d’atténuation pour la tâche spécifiée. Vous ne pouvez pas annuler des tâches déjà terminées.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez CancelAuditMitigationActionsTask (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour annuler une tâche d’audit

L’exemple cancel-audit-task suivant annule une tâche d’audit avec l’ID de tâche spécifié. Vous ne pouvez pas annuler une tâche terminée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour annuler le transfert d’un certificat vers un autre compte AWS

L’exemple cancel-certificate-transfer suivant annule le transfert du certificat spécifié. Le certificat est identifié par un ID de certificat. Vous trouverez l’ID d’un certificat dans la console AWS IoT.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Transférer un certificat vers un autre compte dans le Manuel du développeur AWS IoT Core.

Pour annuler une exécution de tâche sur un appareil

L’exemple cancel-job-execution suivant annule l’exécution de la tâche spécifiée sur un appareil. Si la tâche n’est pas à l’état QUEUED, vous devez ajouter le paramètre --force.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour annuler une tâche

L’exemple cancel-job suivant annule la tâche spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour effacer le mécanisme d’autorisation par défaut

L’exemple clear-default-authorizer suivant efface le mécanisme d’autorisation personnalisé par défaut actuellement configuré. Une fois que vous avez exécuté cette commande, il n’existe aucun mécanisme d’autorisation par défaut. Lorsque vous utilisez un mécanisme d’autorisation personnalisé, vous devez le spécifier par son nom dans les en-têtes de requête HTTP.

aws iot clear-default-authorizer

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez ClearDefaultAuthorizer dans la Référence des API d’AWS IoT.

Pour confirmer une destination de règle de rubrique

L’exemple confirm-topic-rule-destination suivant confirme une destination de règle de rubrique à l’aide d’un jeton de confirmation reçu à un point de terminaison 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"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Confirmation d’une destination de règle de rubrique dans le Manuel du développeur AWS IoT.

Pour créer une suppression de résultat d’audit

L’exemple create-audit-suppression suivant crée une suppression de résultat d’audit pour une stratégie nommée « virtualMachinePolicy » signalée comme étant trop permissive.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppressions de résultat d’audit dans le Manuel du développeur AWS IoT.

Pour créer un mécanisme d’autorisation personnalisé

L’exemple create-authorizer suivant crée un mécanisme d’autorisation personnalisé qui utilise la fonction Lambda spécifiée dans le cadre d’un service d’authentification personnalisé.

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

Sortie :

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

Pour plus d’informations, consultez CreateAuthorizer dans la Référence des API d’AWS IoT.

Pour créer un groupe de facturation

L’exemple create-billing-group suivant crée un groupe de facturation simple nommé GroupOne.

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

Sortie :

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

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour créer un certificat d’appareil à partir d’une demande de signature de certificat (CSR)

L’exemple create-certificate-from-csr suivant crée un certificat d’appareil à partir d’une demande CSR. Vous pouvez créer une demande CSR à l’aide de la commande openssl.

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

Sortie :

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

Pour plus d’informations, consultez CreateCertificateFromCSR dans la Référence des API d’AWS IoT.

Pour créer une métrique personnalisée publiée par vos appareils sur Device Defender

L’exemple create-custom-metric suivant crée une métrique personnalisée qui mesure le pourcentage de batterie.

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"

Sortie :

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

Pour plus d’informations, consultez Métriques personnalisées dans le Manuel du développeur AWS IoT Core.

Pour créer une dimension

L’exemple create-dimension suivant crée une dimension avec un filtre de rubrique unique nommé TopicFilterForAuthMessages.

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

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour créer une configuration de domaine

L’exemple create-domain-configuration suivant crée une configuration de domaine géré par AWS avec le type de service DATA.

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

Sortie :

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

Pour plus d’informations, consultez Points de terminaison configurables dans le Manuel du développeur AWS IoT.

Pour créer un groupe d’objets dynamique

L’exemple create-dynamic-thing-group suivant crée un groupe d’objets dynamique qui comporte tout objet dont l’attribut de température est supérieur à 60 degrés. Vous devez activer l’indexation des flottes AWS IoT avant de pouvoir utiliser des groupes d’objets dynamiques.

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

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dynamiques dans le Manuel du développeur AWS IoT.

Exemple 1 : pour créer une tâche

L’exemple create-job suivant crée une tâche AWS IoT simple qui envoie un document JSON à l’appareil 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

Sortie :

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

Exemple 2 : pour créer une tâche continue

L’exemple create-job suivant crée une tâche qui continue de s’exécuter une fois que les objets spécifiés comme cibles ont terminé la tâche. Dans cet exemple, la cible est un groupe d’objets. Ainsi, lorsque de nouveaux appareils sont ajoutés au groupe, la tâche continue s’exécute sur ces nouveaux objets.

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 "exemple de tâche continue" --target-selection CONTINUOUS

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour créer une paire de clés RSA et émettre un certificat X.509

L’exemple create-keys-and-certificate suivant crée une paire de clés RSA 2 048 bits et émet un certificat X.509 à l’aide de la clé publique émise. Comme il s’agit de la seule fois où AWS IoT fournit la clé privée pour ce certificat, veillez à la conserver dans un endroit sécurisé.

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

Sortie :

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

Pour plus d’informations, consultez Créer et enregistrer un certificat d’appareil AWS IoT dans le Manuel du développeur AWS IoT.

Pour créer une action d’atténuation

L’exemple create-mitigation-action suivant définit une action d’atténuation nommée AddThingsToQuarantineGroup1Action qui, lorsqu’elle est appliquée, déplace des objets vers le groupe d’objets nomméQuarantineGroup1. Cette action remplace les groupes d’objets dynamiques.

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

Contenu de params.json :

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

Sortie :

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

Pour plus d’informations, consultez CreateMitigationAction (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour créer une mise à jour OTA à utiliser avec Amazon FreeRTOS

L’exemple create-ota-update suivant crée une mise à jour OTA AWS IoT sur un ou plusieurs groupes d’objets cibles. Cela fait partie d’une mise à jour OTA d’Amazon FreeRTOS qui vous permet de déployer les nouvelles images du micrologiciel sur un appareil ou un groupe d’appareils.

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

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

Sortie :

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

Pour plus d’informations, consultez CreateOTAUpdate dans la Référence des API d’AWS IoT.

Pour mettre à jour une stratégie avec une nouvelle version

L’exemple create-policy-version suivant met à jour une définition de stratégie en créant une version de stratégie. Cet exemple fait également de la nouvelle version la version par défaut.

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

Contenu de policy.json :

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

Sortie :

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

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Pour créer une stratégie AWS IoT

L’exemple create-policy suivant crée une stratégie AWS IoT nommée TemperatureSensorPolicy. Le fichier policy.json comporte des instructions qui autorisent les actions de stratégie AWS IoT.

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

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

Sortie :

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

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Pour créer une demande de mise en service

L’exemple create-provisioning-claim suivant crée une demande de mise en service à partir d’un modèle de mise en service.

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

Sortie :

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

Pour plus d’informations, consultez Allocation par utilisateur approuvé dans le Manuel du développeur AWS IoT Core.

Pour créer une version de modèle de mise en service

L’exemple suivant crée une version du modèle de mise en service spécifié. Le corps de la nouvelle version est fourni dans le fichier template.json.

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

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

Sortie :

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

Pour plus d’informations, consultez AWS IoT Secure Tunneling dans le Manuel du développeur AWS IoT Core.

Pour créer un modèle de mise en service

L’exemple create-provisioning-template suivant crée un modèle de mise en service tel que défini par le fichier 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

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

Sortie :

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

Pour plus d’informations, consultez AWS IoT Secure Tunneling dans le Manuel du développeur AWS IoT Core.

Pour créer un alias de rôle

L’exemple create-role-alias suivant crée un alias de rôle nommé LightBulbRole pour le rôle spécifié.

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

Sortie :

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

Pour plus d’informations, consultez CreateRoleAlias dans la Référence des API d’AWS IoT.

Pour créer un audit planifié

L’exemple create-scheduled-audit suivant crée un audit planifié qui s’exécute chaque semaine, le mercredi, pour vérifier si les certificats CA ou les certificats d’appareil expirent.

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

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour créer un profil de sécurité

L’exemple create-security-profile suivant crée un profil de sécurité qui vérifie si la bande passante cellulaire dépasse un seuil ou si plus de 10 échecs d’autorisation se produisent sur une période de 5 minutes.

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

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour créer un flux pour diffuser un ou plusieurs fichiers volumineux sous forme de fragments via MQTT

L’exemple create-stream suivant crée un flux pour diffuser un ou plusieurs fichiers volumineux sous forme de fragments via MQTT. Un flux transfère des octets de données dans des fragments ou blocs packagés sous forme de messages MQTT à partir d’une source telle que S3. Un ou plusieurs fichiers peuvent être associés à un flux.

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

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

Sortie :

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

Pour plus d’informations, consultez CreateStream dans la Référence des API d’AWS IoT.

Exemple 1 : pour créer un groupe d’objets

L’exemple create-thing-group suivant crée un groupe d’objets nommé LightBulbs avec une description et deux attributs.

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

Sortie :

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

Exemple 2 : pour créer un groupe d’objets faisant partie d’un groupe parent

L’exemple create-thing-group suivant crée un groupe d’objets nommé HalogenBulbs dont le groupe d’objets parent est nommé LightBulbs.

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

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour définir un type d’objet

L’exemple create-thing-type suivant définit un type d’objet et les attributs associés.

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

Sortie :

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

Pour plus d’informations, consultez Types d’objets dans le Manuel du développeur AWS IoT.

Exemple 1 : pour créer un enregistrement d’objet dans le registre

L’exemple create-thing suivant crée une entrée pour un appareil dans le registre des objets AWS IoT.

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

Sortie :

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

Exemple 2 : pour définir un objet associé à un type d’objet

L’exemple create-thing suivant crée un objet doté du type d’objet spécifié et de ses attributs.

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

Sortie :

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

Pour plus d’informations, consultez Comment gérer des objets avec le registre et Types d’objets dans le Manuel du développeur AWS IoT.

Pour créer une destination de règle de rubrique

L’exemple create-topic-rule-destination suivant crée une destination de règle de rubrique pour un point de terminaison HTTP.

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

Sortie :

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

Pour plus d’informations, consultez Création d’une destination de règle de rubrique dans le Manuel du développeur AWS IoT.

Pour créer une règle qui envoie une alerte Amazon SNS

L’exemple create-topic-rule suivant crée une règle qui envoie un message Amazon SNS lorsque les relevés du niveau d’humidité du sol, tels qu’ils apparaissent dans un cliché instantané d’appareil, sont faibles.

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

Cet exemple nécessite que le code JSON suivant soit enregistré dans un fichier nommé plant-rule.json :

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création d’une règle AWS IoT dans le Manuel du développeur AWS IoT.

Pour désactiver toutes les vérifications d’audit de votre compte AWS

L’exemple delete-account-audit-configuration suivant restaure les paramètres par défaut d’AWS IoT Device Defender pour ce compte, en désactivant toutes les vérifications d’audit et en effaçant les données de configuration. Il supprime également tous les audits planifiés pour ce compte. Utilisez cette commande avec prudence.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour supprimer une suppression de résultat d’audit

L’exemple delete-audit-suppression suivant supprime une suppression de résultat d’audit pour DEVICE_CERTIFICATE_EXPIRING_CHECK.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppressions de résultat d’audit dans le Manuel du développeur AWS IoT.

Pour supprimer un mécanisme d’autorisation personnalisé

L’exemple delete-authorizer suivant supprime le mécanisme d’autorisation nommé CustomAuthorizer. Un mécanisme d’autorisation personnalisé doit être à l’état INACTIVE avant que vous puissiez le supprimer.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteAuthorizer dans le Manuel du développeur AWS IoT.

Pour supprimer un groupe de facturation

L’exemple delete-billing-group suivant supprime le groupe de facturation spécifié. Vous pouvez supprimer un groupe de facturation même s’il comporte un ou plusieurs objets.

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

Cette commande ne génère pas de sortie.

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour supprimer un certificat CA

L’exemple delete-ca-certificate suivant supprime le certificat CA dont l’ID est spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteCACertificate dans la Référence des API d’AWS IoT.

Pour supprimer un certificat d’appareil

L’exemple delete-certificate suivant supprime le certificat d’appareil avec l’ID spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteCertificate dans la Référence des API d’AWS IoT.

Pour supprimer une métrique personnalisée

L’exemple delete-custom-metric suivant supprime une métrique personnalisée.

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

Sortie :

HTTP 200

Pour plus d’informations, consultez Métriques personnalisées dans le Manuel du développeur AWS IoT Core.

Pour supprimer une dimension

L’exemple delete-dimension suivant supprime une dimension nommée TopicFilterForAuthMessages.

aws iot delete-dimension \
    --name TopicFilterForAuthMessages

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour supprimer une configuration de domaine

L’exemple delete-domain-configuration suivant supprime une configuration de domaine nommée additionalDataDomain de votre compte AWS.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Points de terminaison configurables dans le Manuel du développeur AWS IoT.

Pour supprimer un groupe d’objets dynamique

L’exemple delete-dynamic-thing-group suivant supprime le groupe d’objets dynamique spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes d’objets dynamiques dans le Manuel du développeur AWS IoT.

Pour supprimer une exécution de tâche

L’exemple delete-job-execution suivant supprime l’exécution de la tâche spécifiée sur un appareil. Utilisez describe-job-execution pour obtenir le numéro d’exécution.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour supprimer une tâche

L’exemple delete-job suivant supprime la tâche spécifiée. En spécifiant l’option --force, la tâche est supprimée même si son statut est IN_PROGRESS.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour supprimer une action d’atténuation

L’exemple delete-mitigation-action suivant supprime l’action d’atténuation spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteMitigationAction (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour supprimer une mise à jour OTA

L’exemple delete-ota-update suivant supprime la mise à jour OTA spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteOTAUpdate dans la Référence des API d’AWS IoT.

Pour supprimer une version d’une politique

L’exemple delete-policy-version suivant supprime la version 2 de la stratégie spécifiée de votre compte AWS.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Pour supprimer une politique

L’exemple delete-policy suivant supprime la stratégie spécifiée de votre compte AWS.

aws iot delete-policy --policy-name UpdateDeviceCertPolicy

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Pour supprimer une version de modèle de mise en service

L’exemple delete-provisioning-template-version suivant supprime la version 2 du modèle de mise en service spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez AWS IoT Secure Tunneling dans le Manuel du développeur AWS IoT Core.

Pour supprimer un modèle de mise en service

L’exemple delete-provisioning-template suivant supprime le modèle de mise en service spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez AWS IoT Secure Tunneling dans le Manuel du développeur AWS IoT Core.

Pour supprimer votre code d’enregistrement

L’exemple delete-registration-code suivant supprime un code d’enregistrement spécifique à un compte AWS IoT.

aws iot delete-registration-code

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utiliser votre propre certificat dans le Manuel du développeur AWS IoT.

Pour supprimer un alias de rôle AWS IoT

L’exemple delete-role-alias suivant supprime un alias de rôle AWS IoT nommé LightBulbRole.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Autorisation des appels directs vers les services AWS dans le Manuel du développeur AWS IoT.

Pour supprimer un audit planifié

L’exemple delete-scheduled-audit suivant supprime l’audit planifié AWS IoT Device Defender nommé AWSIoTDeviceDefenderDailyAudit.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour supprimer un profil de sécurité

L’exemple delete-security-profile suivant supprime un profil de sécurité nommé PossibleIssue.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour supprimer un flux

L’exemple delete-stream suivant supprime le flux spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteStream dans la Référence des API d’AWS IoT.

Pour supprimer un groupe d’objets

L’exemple delete-thing-group suivant supprime le groupe d’objets spécifié. Vous ne pouvez pas supprimer un groupe d’objets s’il comporte des groupes d’objets enfants.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Exemple 1 : pour supprimer un type d’objet

L’exemple delete-thing-type suivant supprime un type d’objet obsolète.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Types d’objets dans le Manuel du développeur AWS IoT.

Pour afficher des informations détaillées sur un objet

L’exemple delete-thing suivant supprime un objet du registre AWS IoT de votre compte AWS.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Comment gérer des objets avec le registre dans le Manuel du développeur AWS IoT.

Pour supprimer une destination de règle de rubrique

L’exemple delete-topic-rule-destination suivant supprime la destination de règle de rubrique spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression d’une destination de règle de rubrique dans le Manuel du développeur AWS IoT.

Pour supprimer une règle

L’exemple delete-topic-rule suivant supprime la règle spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression d’une règle dans le Manuel du développeur AWS IoT.

Pour supprimer le niveau de journalisation d’un groupe d’objets

L’exemple delete-v2-logging-level suivant supprime le niveau de journalisation du groupe d’objets spécifié.

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

Cette commande ne produit aucune sortie.

Exemple 1 : pour rendre obsolète un type d’objet

L’exemple deprecate-thing-type suivant rend obsolète un type d’objet afin que les utilisateurs ne puissent pas y associer de nouveaux objets.

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

Cette commande ne produit aucune sortie.

Exemple 2 : pour annuler l’obsolescence d’un type d’objet

L’exemple deprecate-thing-type suivant annule l’obsolescence d’un type d’objet, ce qui permet aux utilisateurs d’y associer à nouveau de nouveaux objets.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Types d’objets dans le Manuel du développeur AWS IoT.

Pour consulter les paramètres de configuration d’audit actuels

L’exemple describe-account-audit-configuration suivant répertorie les paramètres actuels de votre configuration d’audit AWS IoT Device Defender.

aws iot describe-account-audit-configuration

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour répertorier les détails d’un résultat d’audit

L’exemple describe-audit-finding suivant répertorie les détails du résultat d’audit AWS IoT Device Defender spécifié. Un audit peut donner lieu à plusieurs résultats. Obtenez la liste des résultats d’un audit à l’aide de la commande list-audit-findings pour obtenir le findingId.

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

Sortie :

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

Pour plus d’informations, consultez Vérifier les résultats d’audit (commandes d’audit) dans le Manuel du développeur AWS IoT.

Pour afficher les détails d’une tâche d’actions d’atténuation d’audit

L’exemple describe-audit-mitigation-actions-task suivant affiche les détails de la tâche spécifiée, lors de laquelle l’action ResetPolicyVersionAction a été appliquée à un résultat. Les résultats incluent les dates de début et de fin de la tâche, le nombre de résultats ciblés (et l’issue) et la définition de l’action appliquée dans le cadre de cette tâche.

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

Sortie :

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

Pour plus d’informations, consultez DescribeAuditMitigationActionsTask (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour obtenir les détails sur une suppression de résultat d’audit

L’exemple describe-audit-suppression suivant répertorie les détails sur une suppression de résultat d’audit.

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

Sortie :

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

Pour plus d’informations, consultez Suppressions de résultat d’audit dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur une instance d’audit

L’exemple describe-audit-task suivant obtient les informations sur une instance d’un audit AWS IoT Device Defender. Si l’audit est terminé, les statistiques récapitulatives de l’exécution sont incluses dans les résultats.

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

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur un mécanisme d’autorisation personnalisé

L’exemple describe-authorizer suivant affiche les détails du mécanisme d’autorisation personnalisé spécifié.

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

Sortie :

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

Pour plus d’informations, consultez DescribeAuthorizer dans la Référence des API d’AWS IoT.

Pour obtenir les informations sur un groupe de facturation

L’exemple describe-billing-group suivant obtient les informations sur le groupe de facturation spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour obtenir les détails d’un certificat CA

L’exemple describe-ca-certificate suivant affiche les détails du certificat CA spécifié.

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

Sortie :

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

Pour plus d’informations, consultez DescribeCACertificate dans la Référence des API d’AWS IoT.

Pour obtenir les informations sur un certificat

L’exemple describe-certificate suivant affiche les détails du certificat spécifié.

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

Sortie :

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

Pour plus d’informations, consultez DescribeCertificate dans la Référence des API d’AWS IoT.

Pour obtenir les informations sur une métrique personnalisée Device Defender

L’exemple describe-custom-metric suivant obtient les informations sur une métrique personnalisée nommée myCustomMetric.

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

Sortie :

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

Pour plus d’informations, consultez Métriques personnalisées dans le Manuel du développeur AWS IoT Core.

Pour obtenir les informations sur le mécanisme d’autorisation personnalisé par défaut

L’exemple describe-default-authorizer suivant affiche les détails du mécanisme d’autorisation personnalisé par défaut.

aws iot describe-default-authorizer

Sortie :

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

Pour plus d’informations, consultez DescribeDefaultAuthorizer dans la Référence des API d’AWS IoT.

Pour obtenir les informations sur une dimension

L’exemple describe-dimension suivant obtient les informations sur une dimension nommée TopicFilterForAuthMessages.

aws iot describe-dimension \
    --name TopicFilterForAuthMessages

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour décrire une configuration de domaine

L’exemple describe-domain-configuration suivant affiche les détails de la configuration de domaine spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Points de terminaison configurables dans le Manuel du développeur AWS IoT.

Exemple 1 : pour obtenir votre point de terminaison AWS actuel

L’exemple describe-endpoint suivant récupère le point de terminaison AWS par défaut auquel toutes les commandes sont appliquées.

aws iot describe-endpoint

Sortie :

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

Pour plus d’informations, consultez DescribeEndpoint dans le Manuel du développeur AWS IoT.

Exemple 2 : pour obtenir votre point de terminaison ATS

L’exemple describe-endpoint suivant récupère le point de terminaison Amazon Trust Services (ATS).

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

Sortie :

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

Pour plus d’informations, consultez Certificats X.509 et AWS IoT dans le Manuel du développeur AWS IoT.

Pour afficher les types d’événements publiés

L’exemple describe-event-configurations suivant répertorie la configuration qui contrôle les événements générés lors de l’ajout, de la mise à jour ou de la suppression d’un élément.

aws iot describe-event-configurations

Sortie :

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

Pour plus d’informations, consultez Messages d’événements dans le Manuel du développeur AWS IoT.

Pour récupérer le statut actuel de l’index des objets

L’exemple describe-index suivant récupère le statut actuel de l’index des objets.

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

Sortie :

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

Pour plus d’informations, consultez Gestion de l’indexation d’objet dans le Manuel du développeur AWS IoT.

Pour obtenir les détails d’exécution d’une tâche sur un appareil

L’exemple describe-job-execution suivant obtient les détails d’exécution de la tâche spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour obtenir le statut détaillé d’une tâche

L’exemple describe-job suivant obtient le statut détaillé de la tâche dont l’identifiant correspond à example-job-01.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour afficher les détails d’une action d’atténuation définie

L’exemple describe-mitigation-action suivant affiche les détails de l’action d’atténuation spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez DescribeMitigationAction (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour décrire une version de modèle de mise en service

L’exemple describe-provisioning-template-version suivant décrit une version de modèle de mise en service.

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

Sortie :

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

Pour plus d’informations, consultez Mise en service d’appareils qui ne disposent pas de certificats d’appareils à l’aide de la mise en service de flotte dans le Manuel du développeur AWS IoT Core.

Pour décrire un modèle de mise en service

L’exemple describe-provisioning-template suivant décrit un modèle de mise en service.

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

Sortie :

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

Pour plus d’informations, consultez Mise en service d’appareils qui ne disposent pas de certificats d’appareils à l’aide de la mise en service de flotte dans le Manuel du développeur AWS IoT Core.

Pour obtenir les informations sur un alias de rôle AWS IoT

L’exemple describe-role-alias suivant affiche les détails de l’alias de rôle spécifié.

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

Sortie :

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

Pour plus d’informations, consultez DescribeRoleAlias dans la Référence des API d’AWS IoT.

Pour obtenir les informations sur un audit planifié

L’exemple describe-scheduled-audit suivant obtient les informations détaillées sur un audit planifié AWS IOT Device Defender nommé AWSIoTDeviceDefenderDailyAudit.

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

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur un profil de sécurité

L’exemple describe-security-profile suivant obtient les informations sur le profil de sécurité AWS IoT Device Defender nommé PossibleIssue.

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

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur un flux

L’exemple describe-stream suivant affiche les détails du flux spécifié.

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

Sortie :

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

Pour plus d’informations, consultez DescribeStream dans la Référence des API d’AWS IoT.

Pour obtenir les informations sur un groupe d’objets

L’exemple describe-thing-group suivant obtient les informations sur le groupe d’objets nommé HalogenBulbs.

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

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur un type d’objet

L’exemple describe-thing-type suivant affiche les informations sur le type d’objet spécifié défini dans votre compte AWS.

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

Sortie :

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

Pour plus d’informations, consultez Types d’objets dans le Manuel du développeur AWS IoT.

Pour afficher des informations détaillées sur un objet

L’exemple describe-thing suivant affiche les informations sur un objet (appareil) défini dans le registre AWS IoT de votre compte AWS.

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

Sortie :

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

Pour plus d’informations, consultez Comment gérer des objets avec le registre dans le Manuel du développeur AWS IoT.

Exemple 1 : pour détacher une stratégie AWS IoT d’un groupe d’objets

L’exemple detach-policy suivant détache la stratégie spécifiée d’un groupe d’objets et, par extension, de tous les objets de ce groupe et de tous les groupes enfants du groupe.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Exemple 2 : pour détacher une stratégie AWS IoT d’un certificat d’appareil

L’exemple detach-policy suivant détache la stratégie TemperatureSensorPolicy d’un certificat d’appareil identifié par son ARN.

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

Cette commande ne produit aucune sortie.

Pour dissocier un profil de sécurité d’une cible

L’exemple detach-security-profile suivant supprime l’association entre le profil de sécurité AWS IoT Device Defender nommé Testprofile et la cible de tous les objets enregistrés.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour détacher un certificat/principal d’un objet

L’exemple detach-thing-principal suivant supprime un certificat qui représente un principal de l’objet spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Comment gérer des objets avec le registre dans le Manuel du développeur AWS IoT.

Pour désactiver une règle de rubrique

L’exemple disable-topic-rule suivant désactive la règle de rubrique spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Affichage des règles dans le Manuel du développeur AWS IoT.

Pour activer une règle de rubrique

L’exemple enable-topic-rule suivant active (ou réactive) la règle de rubrique spécifiée.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Affichage des règles dans le Manuel du développeur AWS IoT.

Pour répertorier le statut du modèle d’entraînement d’un profil de sécurité ML Detect de Device Defender

L’exemple get-behavior-model-training-summaries suivant répertorie le statut d’entraînement des modèles pour les comportements configurés dans le profil de sécurité choisi. Pour chaque comportement, le nom, le statut du modèle et le pourcentage de points de données recueillis sont répertoriés.

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

Sortie :

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

Pour plus d’informations, consultez GetBehaviorModelTrainingSummaries (commandes Detect) dans le Manuel du développeur AWS IoT.

Pour renvoyer le nombre approximatif de valeurs uniques qui correspondent à la requête

Vous pouvez utiliser le script de configuration suivant pour créer 10 objets représentant 10 capteurs de température. Chaque nouvel objet possède trois attributs.

# 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

Exemple de sortie du script de configuration :

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

L’exemple get-cardinality suivant interroge les 10 capteurs créés par le script de configuration et renvoie le nombre de racks équipés de capteurs de température signalant des valeurs de température anormales. Si la valeur de température est inférieure à 60 ou supérieure à 80, le capteur de température est à l’état anormal.

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

Sortie :

{
    "cardinality": 2
}

Pour plus d’informations, consultez Interrogation de données agrégées<https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html> dans le Manuel du développeur AWS IoT.

Pour répertorier les stratégies qui affectent un objet

L’exemple get-effective-policies suivant répertorie les stratégies qui affectent l’objet spécifié, y compris les stratégies associées aux groupes auxquels il appartient.

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

Sortie :

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

Pour plus d’informations, consultez Obtention de stratégies efficaces pour un objet dans le Manuel du développeur AWS IoT.

Pour obtenir la configuration de l’indexation des objets

L’exemple get-indexing-configuration suivant obtient les données de configuration actuelles pour l’indexation des flottes AWS IoT.

aws iot get-indexing-configuration

Sortie :

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

Pour plus d’informations, consultez Gestion de l’indexation d’objet dans le Manuel du développeur AWS IoT.

Pour récupérer le document correspondant à une tâche

L’exemple get-job-document suivant affiche les détails du document correspondant à la tâche dont l’identifiant est example-job-01.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour obtenir les options de journalisation

L’exemple get-logging-options suivant obtient les options de journalisation actuelles de votre compte AWS.

aws iot get-logging-options

Sortie :

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

Pour plus d’informations, consultez le titre dans le Manuel du développeur AWS IoT.

Pour récupérer les informations sur une mise à jour OTA

L’exemple get-ota-update suivant affiche les détails de la mise à jour OTA spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez GetOTAUpdate dans la Référence des API d’AWS IoT.

Pour regrouper les valeurs agrégées qui correspondent à la requête en groupes de centiles

Vous pouvez utiliser le script de configuration suivant pour créer 10 objets représentant 10 capteurs de température. Chaque nouvel objet possède un attribut.

# 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

Exemple de sortie du script de configuration :

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

L’exemple get-percentiles suivant interroge les 10 capteurs créés par le script de configuration et renvoie une valeur pour chaque groupe de centiles spécifié. Le groupe de centiles « 10 » comporte la valeur de champ agrégée qui se produit dans environ 10 % des valeurs qui correspondent à la requête. Dans la sortie suivante, {"percent": 10.0, "value": 67.7} signifie qu’environ 10 % des valeurs de température sont inférieures à 67,7.

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

Sortie :

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

Pour plus d’informations, consultez Interrogation de données agrégées dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur une version spécifique d’une stratégie

L’exemple get-policy-version suivant obtient les informations sur la première version de la stratégie spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur la version par défaut d’une stratégie

L’exemple get-policy suivant récupère les informations sur la version par défaut de la stratégie spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Pour obtenir le code d’enregistrement spécifique à votre compte AWS

L’exemple get-registration-code suivant récupère le code d’enregistrement spécifique à votre compte AWS.

aws iot get-registration-code

Sortie :

{
    "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c"
}

Pour plus d’informations, consultez Utiliser votre propre certificat dans le Manuel du développeur AWS IoT.

Pour rechercher des données agrégées dans l’index des appareils

L’exemple get-statistics suivant renvoie le nombre d’objets dotés d’une propriété nommée connectivity.connected définie sur false (à savoir le nombre d’appareils non connectés) dans leur cliché instantané d’appareil.

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

Sortie :

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

Pour plus d’informations, consultez Obtention des statistiques sur votre flotte d’appareils dans le Manuel du développeur AWS IoT.

Pour obtenir une destination de règle de rubrique

L’exemple get-topic-rule-destination suivant obtient les informations sur une destination de règle de rubrique.

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

Sortie :

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

Pour plus d’informations, consultez Utilisation des destinations des règles de rubrique dans le Manuel du développeur AWS IoT.

Pour obtenir les informations sur une règle

L’exemple get-topic-rule suivant affiche les informations sur la règle spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Affichage des règles dans le Manuel du développeur AWS IoT.

Pour répertorier les options de journalisation actuelles

L’exemple get-v2-logging-options suivant répertorie les options de journalisation actuelles pour AWS IoT.

aws iot get-v2-logging-options

Sortie :

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

Pour plus d’informations, consultez le titre dans le Manuel du développeur AWS IoT.

Pour répertorier les violations actives

L’exemple list-active-violations suivant répertorie toutes les violations pour le profil de sécurité spécifié.

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

Sortie :

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

Exemple 1 : pour répertorier les stratégies attachées à un groupe

L’exemple list-attached-policies suivant répertorie les stratégies attachées au groupe spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Exemple 2 : pour répertorier les stratégies attachées à un certificat d’appareil

L’exemple list-attached-policies suivant répertorie les stratégies AWS IoT attachées au certificat d’appareil. Le certificat est identifié par son ARN.

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

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Exemple 1 : pour répertorier tous les résultats d’un audit

L’exemple list-audit-findings suivant répertorie tous les résultats d’un audit AWS IoT Device Defender avec un identifiant de tâche spécifié.

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

Sortie :

{
    "findings": []
}

Exemple 2 : pour répertorier les résultats d’un type de vérification d’audit

L’exemple list-audit-findings suivant illustre les résultats des audits AWS IoT Device Defender réalisés entre le 5 et le 19 juin 2019 dans lesquels des appareils partagent un certificat d’appareil. Lorsque vous spécifiez le nom d’une vérification, vous devez indiquer une heure de début et une heure de fin.

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

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour répertorier les détails de l’exécution d’une action d’atténuation d’audit

Une tâche d’action d’atténuation d’audit applique une action d’atténuation à un ou plusieurs résultats d’un audit AWS IoT Device Defender. L’exemple list-audit-mitigation-actions-executions suivant répertorie les détails de la tâche d’action d’atténuation avec l’objet taskId spécifié et pour le résultat spécifié.

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

Sortie :

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

Pour plus d’informations, consultez ListAuditMitigationActionsExecutions (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour répertorier les tâches d’action d’atténuation d’audit

L’exemple list-audit-mitigation-actions-tasks suivant répertorie les actions d’atténuation appliquées aux résultats au cours de la période spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez ListAuditMitigationActionsTasks (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour répertorier toutes les suppressions de résultats d’audit

L’exemple list-audit-suppressions suivant répertorie toutes les suppressions de résultats d’audit actives.

aws iot list-audit-suppressions

Sortie :

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

Pour plus d’informations, consultez Suppressions de résultat d’audit dans le Manuel du développeur AWS IoT.

Pour répertorier tous les résultats d’un audit

L’exemple list-audit-tasks suivant répertorie les tâches d’audit exécutées entre le 5 et le 12 juin 2019.

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

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour répertorier votre mécanisme d’autorisation personnalisé

L’exemple list-authorizers suivant répertorie les mécanismes d’autorisation personnalisés de votre compte AWS.

aws iot list-authorizers

Sortie :

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

Pour plus d’informations, consultez ListAuthorizers dans la Référence des API d’AWS IoT.

Pour répertorier les groupes de facturation pour vos compte et région AWS

L’exemple list-billing-groups suivant répertorie tous les groupes de facturation définis pour votre compte AWS et votre région AWS.

aws iot list-billing-groups

Sortie :

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

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour répertorier les certificats CA enregistrés dans votre compte AWS

L’exemple list-ca-certificates suivant répertorie les certificats CA enregistrés dans votre compte AWS.

aws iot list-ca-certificates

Sortie :

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

Pour plus d’informations, consultez Utiliser votre propre certificat dans le Manuel du développeur AWS IoT.

Pour répertorier tous les certificats d’appareil signés avec un certificat CA

L’exemple list-certificates-by-ca suivant répertorie tous les certificats d’appareil de votre compte AWS signés avec le certificat CA spécifié.

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

Sortie :

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

Pour plus d’informations, consultez ListCertificatesByCA dans la Référence des API d’AWS IoT.

Exemple 1 : pour répertorier les certificats enregistrés dans votre compte AWS

L’exemple list-certificates suivant répertorie tous les certificats enregistrés dans votre compte. Si vous avez dépassé la limite de pagination par défaut de 25, vous pouvez utiliser la valeur de réponse nextMarker de cette commande et la fournir à la commande suivante pour obtenir le prochain lot de résultats. Répétez l’opération jusqu’à ce que nextMarker ne renvoie aucune valeur.

aws iot list-certificates

Sortie :

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

Pour répertorier vos métriques personnalisées

L’exemple list-custom-metrics suivant répertorie toutes vos métriques personnalisées.

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

Sortie :

{
    "metricNames": [
        "batteryPercentage"
    ]
}

Pour plus d’informations, consultez Métriques personnalisées dans le Manuel du développeur AWS IoT Core.

Pour répertorier les dimensions de votre compte AWS

L’exemple list-dimensions suivant répertorie toutes les dimensions AWS IoT Device Defender définies dans votre compte AWS.

aws iot list-dimensions

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour répertorier les configurations de domaine

L’exemple list-domain-configurations suivant répertorie les configurations de domaine de votre compte AWS qui ont le type de service spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Points de terminaison configurables dans le Manuel du développeur AWS IoT.

Pour répertorier les index de recherche configurés

L’exemple list-indices suivant répertorie tous les index de recherche configurés dans votre compte AWS. Si vous n’avez pas activé l’indexation des objets, il se peut que vous n’ayez aucun index.

aws iot list-indices

Sortie :

{
    "indexNames": [
        "AWS_Things"
    ]
}

Pour plus d’informations, consultez Gestion de l’indexation d’objet dans le Manuel du développeur AWS IoT.

Pour répertorier les tâches de votre compte AWS

L’exemple list-job-executions-for-job suivant répertorie toutes les exécutions d’une tâche de votre compte AWS, spécifiée par son ID de tâche.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour répertorier les tâches exécutées pour un objet

L’exemple list-job-executions-for-thing suivant répertorie toutes les tâches exécutées pour l’objet nommé MyRaspberryPi.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour répertorier les tâches de votre compte AWS

L’exemple list-jobs suivant répertorie toutes les tâches de votre compte AWS, triées selon leur statut.

aws iot list-jobs

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour répertorier toutes les actions d’atténuation définies

L’exemple list-mitigation-actions suivant répertorie toutes les actions d’atténuation définies pour votre compte et votre région AWS. Pour chaque action, le nom, l’ARN et la date de création sont répertoriés.

aws iot list-mitigation-actions

Sortie :

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

Pour plus d’informations, consultez ListMitigationActions (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour répertorier toutes les actions d’atténuation définies

L’exemple list-mitigations-actions suivant répertorie toutes les actions d’atténuation définies pour votre compte et votre région AWS. Pour chaque action, le nom, l’ARN et la date de création sont répertoriés.

aws iot list-mitigation-actions

Sortie :

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

Pour plus d’informations, consultez ListMitigationActions (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour répertorier les mises à jour OTA pour le compte

L’exemple list-ota-updates suivant répertorie les mises à jour OTA disponibles.

aws iot list-ota-updates

Sortie :

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

Pour plus d’informations, consultez ListOTAUpdates dans la Référence des API d’AWS IoT.

Pour répertorier les certificats transférés vers un autre compte AWS

L’exemple list-outgoing-certificates suivant répertorie tous les certificats d’appareil en cours de transfert vers un autre compte AWS à l’aide de la commande transfer-certificate.

aws iot list-outgoing-certificates

Sortie :

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

Pour plus d’informations, consultez ListOutgoingCertificates dans la Référence des API d’AWS IoT.

Pour répertorier les stratégies définies dans votre compte AWS

L’exemple list-policies suivant répertorie toutes les stratégies définies dans votre compte AWS.

aws iot list-policies

Sortie :

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

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Exemple 1 : pour afficher toutes les versions d’une stratégie

L’exemple list-policy-versions suivant répertorie toutes les versions de la stratégie spécifiée et leur date de création.

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

Sortie :

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

Pour plus d’informations, consultez Stratégies AWS IoT dans le Manuel du développeur AWS IoT.

Pour répertorier les objets attachés à un principal

L’exemple list-principal-things suivant répertorie les objets attachés au principal spécifié par un ARN.

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

Sortie :

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

Pour plus d’informations, consultez ListPrincipalThings dans la Référence des API d’AWS IoT.

Pour répertorier les versions du modèle de mise en service

L’exemple list-provisioning-template-versions suivant répertorie les versions disponibles du modèle de mise en service spécifié.

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

Sortie :

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

Pour plus d’informations, consultez AWS IoT Secure Tunneling dans le Manuel du développeur AWS IoT Core.

Pour répertorier les modèles de mise en service

L’exemple list-provisioning-templates suivant répertorie tous les modèles de mise en service de votre compte AWS.

aws iot list-provisioning-templates

Sortie :

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

Pour plus d’informations, consultez AWS IoT Secure Tunneling dans le Manuel du développeur AWS IoT Core.

Pour répertorier les alias de rôle AWS IoT de votre compte AWS

L’exemple list-role-aliases suivant répertorie les alias de rôle AWS IoT de votre compte AWS.

aws iot list-role-aliases

Sortie :

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

Pour plus d’informations, consultez ListRoleAliases dans la Référence des API d’AWS IoT.

Pour répertorier les audits planifiés pour votre compte AWS

L’exemple list-scheduled-audits suivant répertorie tous les audits planifiés pour votre compte AWS.

aws iot list-scheduled-audits

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour répertorier les profils de sécurité attachés à une cible

L’exemple list-security-profiles-for-target suivant répertorie les profils de sécurité AWS IoT Device Defender attachés à des appareils non enregistrés.

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

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour répertorier les profils de sécurité de votre compte AWS

L’exemple list-security-profiles suivant répertorie tous les profils de sécurité AWS IoT Device Defender définis dans votre compte AWS.

aws iot list-security-profiles

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour répertorier les flux du compte

L’exemple list-streams suivant répertorie tous les flux de votre compte AWS.

aws iot list-streams

Sortie :

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

Pour plus d’informations, consultez ListStreams dans la Référence des API d’AWS IoT.

Pour afficher les balises et leurs valeurs associées à une ressource

L’exemple list-tags-for-resource suivant affiche les balises et les valeurs associées au groupe d’objets LightBulbs.

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

Sortie :

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

Pour plus d’informations, consultez Balisage de vos ressources AWS IoT dans le Manuel du développeur AWS IoT.

Pour répertorier les principaux associés à une stratégie AWS IoT

L’exemple list-targets-for-policy suivant répertorie les certificats d’appareil auxquels la stratégie spécifiée est attachée.

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

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour répertorier les cibles auxquelles un profil de sécurité est appliqué

L’exemple list-targets-for-security-profile suivant répertorie les cibles auxquelles le profil de sécurité AWS IoT Device Defender nommé PossibleIssue est appliqué.

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

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour répertorier les groupes auxquels un objet appartient

L’exemple list-thing-groups-for-thing suivant répertorie les groupes auxquels l’objet spécifié appartient.

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

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour répertorier les groupes d’objets définis dans votre compte AWS

L’exemple describe-thing-group suivant répertorie tous les groupes d’objets définis dans votre compte AWS.

aws iot list-thing-groups

Sortie :

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

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour répertorier les principaux associés à un objet

L’exemple list-thing-principals suivant répertorie les principaux (certificats X.509, utilisateurs IAM, groupes, rôles, identités Amazon Cognito ou identités fédérées) associés à l’objet spécifié.

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

Sortie :

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

Pour plus d’informations, consultez ListThingPrincipals dans la Référence des API d’AWS IoT.

Pour répertorier les types d’objets définis

L’exemple list-thing-types suivant affiche une liste des types d’objets définis dans votre compte AWS.

aws iot list-thing-types

Sortie :

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

Pour plus d’informations, consultez Types d’objets dans le Manuel du développeur AWS IoT.

Pour répertorier les objets d’un groupe de facturation

L’exemple list-things-in-billing-group suivant répertorie les objets figurant dans le groupe de facturation spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour répertorier les objets appartenant à un groupe

L’exemple list-things-in-thing-group suivant répertorie les objets qui appartiennent au groupe d’objets spécifié.

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

Sortie :

{
    "things": [
        "MyLightBulb"
    ]
}

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Exemple 1 : pour répertorier tous les objets du registre

L’exemple list-things suivant répertorie les objets (appareils) définis dans le registre AWS IoT de votre compte AWS.

aws iot list-things

Sortie :

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

Exemple 2 : pour répertorier les objets définis dotés d’un attribut spécifique

L’exemple list-things suivant affiche une liste d’objets dotés d’un attribut nommé wattage.

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

Sortie :

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

Pour plus d’informations, consultez Comment gérer des objets avec le registre dans le Manuel du développeur AWS IoT.

Pour répertorier vos destinations de règle de rubrique

L’exemple list-topic-rule-destinations suivant répertorie toutes les destinations de règle de rubrique que vous avez définies dans la région AWS actuelle.

aws iot list-topic-rule-destinations

Sortie :

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

Pour plus d’informations, consultez Utilisation des destinations des règles de rubrique dans le Manuel du développeur AWS IoT.

Pour répertorier vos règles

L’exemple list-topic-rules suivant répertorie toutes les règles que vous avez définies.

aws iot list-topic-rules

Sortie :

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

Pour plus d’informations, consultez Affichage des règles dans le Manuel du développeur AWS IoT.

Pour répertorier les niveaux de journalisation

L’exemple list-v2-logging-levels suivant répertorie les niveaux de journalisation configurés. Si aucun niveau de journalisation n’a été défini, une exception NotConfiguredException se produit lorsque vous exécutez cette commande.

aws iot list-v2-logging-levels

Sortie :

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

Pour répertorier les violations de profil de sécurité au cours d’une période donnée

L’exemple list-violation-events suivant répertorie les violations survenues entre le 5 et le 12 juin 2019 pour tous les profils de sécurité AWS IoT Device Defender du compte AWS et de la région AWS actuels.

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

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour enregistrer un certificat d’autorité de certification (CA)

L’exemple register-ca-certificate suivant enregistre un certificat CA. La commande fournit le certificat CA et un certificat de vérification de clé qui prouve que vous possédez la clé privée associée au certificat CA.

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

Sortie :

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

Pour plus d’informations, consultez RegisterCACertificate dans la Référence des API d’AWS IoT.

Pour enregistrer un certificat d’appareil autosigné

L’exemple register-certificate suivant enregistre le certificat d’appareil deviceCert.pem signé par le certificat CA rootCA.pem. Le certificat CA doit être enregistré afin de vous permettre d’enregistrer un certificat d’appareil autosigné. Le certificat autosigné doit être signé par le même certificat CA que celui que vous avez transmis à cette commande.

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

Sortie :

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

Pour plus d’informations, consultez RegisterCertificate dans la Référence des API d’AWS IoT.

Pour enregistrer un objet

L’exemple register-thing suivant enregistre un objet à l’aide d’un modèle de mise en service.

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

Sortie :

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

Pour plus d’informations, consultez Allocation par utilisateur approuvé dans le Manuel du développeur AWS IoT Core.

Pour refuser un transfert de certificat

L’exemple reject-certificate-transfer suivant refuse le transfert du certificat d’appareil spécifié depuis un autre compte AWS.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Transférer un certificat vers un autre compte dans le Manuel du développeur AWS IoT Core.

Pour supprimer un objet d’un groupe de facturation

L’exemple remove-thing-from-billing-group suivant supprime l’objet spécifié d’un groupe de facturation.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour supprimer un objet d’un groupe d’objets

L’exemple remove-thing-from-thing-group suivant supprime l’objet spécifié d’un groupe d’objets.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes d’objets <https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html > dans le Manuel du développeur AWS IoT.

Pour mettre à jour la définition d’une règle de rubrique

L’exemple replace-topic-rule suivant met à jour la règle spécifiée pour envoyer une alerte SNS lorsque les relevés du niveau d’humidité du sol sont trop faibles.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création d’une règle AWS IoT dans le Manuel du développeur AWS IoT.

Pour interroger l’index des objets

L’exemple search-index suivant interroge l’index AWS_Things pour les objets de type LightBulb.

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

Sortie :

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

Pour plus d’informations, consultez Gestion de l’indexation d’objet dans le Manuel du développeur AWS IoT.

Pour définir un mécanisme d’autorisation par défaut

L’exemple set-default-authorizer suivant définit le mécanisme d’autorisation personnalisé nommé CustomAuthorizer comme étant le mécanisme d’autorisation par défaut.

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

Sortie :

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

Pour plus d’informations, consultez CreateDefaultAuthorizer dans la Référence des API d’AWS IoT.

Pour définir la version par défaut d’une stratégie

L’exemple set-default-policy-version suivant définit la version par défaut sur 2 pour la stratégie nommée UpdateDeviceCertPolicy.

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

Cette commande ne produit aucune sortie.

Pour définir le niveau de journalisation d’un groupe d’objets

L’exemple set-v2-logging-level suivant définit le niveau de journalisation pour consigner les avertissements concernant le groupe d’objets spécifié.

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

Cette commande ne produit aucune sortie.

Pour définir les options de journalisation

L’exemple set-v2-logging-options suivant définit le niveau de détail de la journalisation par défaut sur ERROR et indique l’ARN à utiliser pour la journalisation.

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

Cette commande ne produit aucune sortie.

Pour appliquer une action d’atténuation aux résultats d’un audit

L’exemple start-audit-mitigation-actions-task suivant applique l’action ResetPolicyVersionAction (qui efface la stratégie) au résultat unique spécifié.

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"

Sortie :

{
    "taskId": "myActionsTaskId"
}

Pour plus d’informations, consultez StartAuditMitigationActionsTask (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour lancer un audit immédiatement

L’exemple start-on-demand-audit-task suivant lance un audit AWS IoT Device Defender et effectue trois vérifications de certificat.

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

Sortie :

{
    "taskId": "a3aea009955e501a31b764abe1bebd3d"
}

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour spécifier une clé de balise et une valeur pour une ressource

L’exemple tag-resource suivant applique la balise avec une clé Assembly et la valeur Fact1NW au groupe d’objets LightBulbs.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage de vos ressources AWS IoT dans le Manuel du développeur AWS IoT.

Pour tester vos stratégies AWS IoT

L’exemple test-authorization suivant teste les stratégies AWS IoT associées au principal spécifié.

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

Sortie :

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

Pour plus d’informations, consultez TestAuthorization dans la Référence des API d’AWS IoT.

Pour tester votre mécanisme d’autorisation personnalisé

L’exemple test-invoke-authorizer suivant teste votre mécanisme d’autorisation personnalisé.

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

Sortie :

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

Pour plus d’informations, consultez TestInvokeAuthorizer dans la Référence des API d’AWS IoT.

Pour transférer un certificat d’appareil vers un autre compte AWS

L’exemple transfer-certificate suivant transfère un certificat d’appareil vers un autre compte AWS. Le certificat et le compte AWS sont identifiés par un identifiant.

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

Sortie :

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

Pour plus d’informations, consultez Transférer un certificat vers un autre compte dans le Manuel du développeur AWS IoT Core.

Pour supprimer une clé de balise d’une ressource

L’exemple untag-resource suivant supprime la balise MyTag et sa valeur du groupe d’objets LightBulbs.

command

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage de vos ressources AWS IoT dans le Manuel du développeur AWS IoT.

Exemple 1 : pour activer les notifications Amazon SNS pour les notifications d’audit

L’exemple update-account-audit-configuration suivant active les notifications Amazon SNS pour les notifications d’audit AWS IoT Device Defender, en spécifiant une cible et le rôle permettant d’écrire sur cette cible.

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

Cette commande ne produit aucune sortie.

Exemple 2 : pour activer une vérification d’audit

L’exemple update-account-audit-configuration suivant active la vérification d’audit AWS IoT Device Defender nommée AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK. Vous ne pouvez pas désactiver une vérification d’audit si elle fait partie des targetCheckNames d’un ou de plusieurs audits planifiés pour le compte AWS.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour mettre à jour la suppression d’un résultat d’audit

L’exemple update-audit-suppression suivant redéfinit la date d’expiration de la suppression d’un résultat d’audit sur le 21/09/2020.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppressions de résultat d’audit dans le Manuel du développeur AWS IoT.

Pour mettre à jour un mécanisme d’autorisation personnalisé

L’exemple update-authorizer suivant redéfinit l’état de CustomAuthorizer2 sur INACTIVE.

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

Sortie :

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

Pour plus d’informations, consultez UpdateAuthorizer dans la Référence des API d’AWS IoT.

Pour mettre à jour les informations sur un groupe de facturation

L’exemple update-billing-group suivant met à jour la description du groupe de facturation spécifié.

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

Sortie :

{
    "version": 2
}

Pour plus d’informations, consultez Groupes de facturation dans le Manuel du développeur AWS IoT.

Pour mettre à jour un certificat d’autorité de certification (CA)

L’exemple update-ca-certificate suivant définit le certificat CA spécifié sur le statut ACTIF.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez UpdateCACertificate dans la Référence des API d’AWS IoT.

Pour mettre à jour un certificat d’appareil

L’exemple update-certificate suivant définit le certificat d’appareil spécifié sur le statut INACTIF.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez UpdateCertificate dans la Référence des API d’AWS IoT.

Pour mettre à jour une métrique personnalisée

L’exemple update-custom-metric suivant met à jour une métrique personnalisée afin de la doter d’un nouveau display-name.

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

Sortie :

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

Pour plus d’informations, consultez Métriques personnalisées dans le Manuel du développeur AWS IoT Core.

Pour mettre à jour une dimension

L’exemple update-dimension suivant met à jour une dimension.

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

Sortie :

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

Pour plus d’informations, consultez Définition de la portée des métriques dans les profils de sécurité à l’aide de dimensions dans le Manuel du développeur AWS IoT Core.

Pour mettre à jour une configuration de domaine

L’exemple update-domain-configuration suivant désactive la configuration de domaine spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Points de terminaison configurables dans le Manuel du développeur AWS IoT.

Pour mettre à jour un groupe d’objets dynamique

L’exemple update-dynamic-thing-group suivant met à jour le groupe d’objets dynamique spécifié. Il fournit une description et met à jour la chaîne de requête pour modifier les critères d’appartenance au groupe.

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"

Sortie :

{
    "version": 2
}

Pour plus d’informations, consultez Groupes d’objets dynamiques dans le Manuel du développeur AWS IoT.

Pour afficher les types d’événements publiés

L’exemple update-event-configurations suivant met à jour la configuration pour activer les messages lorsque le certificat CA est ajouté, mis à jour ou supprimé.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Messages d’événements dans le Manuel du développeur AWS IoT.

Pour activer l’indexation des objets

L’exemple update-indexing-configuration suivant permet à l’indexation des objets d’effectuer la recherche de données de registre, de données de cliché instantané et du statut de connectivité des objets à l’aide de l’index AWS_Things.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Gestion de l’indexation d’objet dans le Manuel du développeur AWS IoT.

Pour obtenir le statut détaillé d’une tâche

L’exemple update-job suivant obtient le statut détaillé de la tâche dont l’identifiant correspond à example-job-01.

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

Sortie :

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

Pour plus d’informations, consultez Création et gestion de tâches (interface de ligne de commande) dans le Manuel du développeur AWS IoT.

Pour mettre à jour une action d’atténuation

L’exemple update-mitigation-action suivant met à jour l’action d’atténuation spécifiée nommée AddThingsToQuarantineGroupAction, modifie le nom du groupe d’objets et définit overrideDynamicGroups sur false. Vous pouvez vérifier vos modifications à l’aide de la commande describe-mitigation-action.

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

Sortie :

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

Pour plus d’informations, consultez UpdateMitigationAction (commandes d’action d’atténuation) dans le Manuel du développeur AWS IoT.

Pour mettre à jour un modèle de mise en service

L’exemple update-provisioning-template suivant modifie la description et l’ARN de rôle du modèle de mise en service spécifié et active le modèle.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez AWS IoT Secure Tunneling dans le Manuel du développeur AWS IoT Core.

Pour mettre à jour un alias de rôle

L’exemple update-role-alias suivant met à jour l’alias de rôle LightBulbRole.

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

Sortie :

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

Pour plus d’informations, consultez UpdateRoleAlias dans la Référence des API d’AWS IoT.

Pour mettre à jour une définition d’audit planifié

L’exemple update-scheduled-audit suivant modifie les noms des vérifications cibles pour un audit planifié 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

Sortie :

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

Pour plus d’informations, consultez Commandes d’audit dans le Manuel du développeur AWS IoT.

Pour modifier un profil de sécurité

L’exemple update-security-profile suivant met à jour à la fois la description et les comportements d’un profil de sécurité 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}}]"

Sortie :

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

Pour plus d’informations, consultez Commandes Detect dans le Manuel du développeur AWS IoT.

Pour mettre à jour un flux

L’exemple update-stream suivant met à jour un flux existant. La version du flux est incrémentée de 1.

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

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

Sortie :

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

Pour plus d’informations, consultez UpdateStream dans la Référence des API d’AWS IoT.

Pour mettre à jour la définition d’un groupe d’objets

L’exemple update-thing-group suivant met à jour la définition du groupe d’objets spécifié, en modifiant la description et deux attributs.

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

Sortie :

{
    "version": 2
}

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour modifier les groupes auxquels un objet appartient

L’exemple update-thing-groups-for-thing suivant supprime l’objet nommé MyLightBulb du groupe nommé DeadBulbs et l’ajoute simultanément au groupe nommé replaceableItems.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Groupes d’objets dans le Manuel du développeur AWS IoT.

Pour associer un objet à un type d’objet

L’exemple update-thing suivant associe un objet du registre AWS IoT à un type d’objet. Lorsque vous établissez l’association, vous fournissez des valeurs pour les attributs définis par le type d’objet.