AWS IoT 1-Click Gerätebeispiele mit AWS CLI - AWS Command Line Interface
Aktionen

Diese Dokumentation bezieht sich AWS CLI nur auf Version 1 von. Dokumentation zu Version 2 von finden Sie im Benutzerhandbuch für Version 2. AWS CLI

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

AWS IoT 1-Click Gerätebeispiele mit AWS CLI

In den folgenden Codebeispielen wird gezeigt, wie Sie mithilfe von AWS Command Line Interface With AWS IoT 1-Click Devices Aktionen ausführen und allgemeine Szenarien implementieren.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Aktionen zeigen Ihnen zwar, wie Sie einzelne Servicefunktionen aufrufen, aber Sie können Aktionen im Kontext der zugehörigen Szenarien sehen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungclaim-devices-by-claim-code.

AWS CLI

Um ein oder mehrere AWS IoT 1-Click 1-Click-Geräte mit einem Einlösungscode zu beanspruchen

Im folgenden claim-devices-by-claim-code Beispiel wird das angegebene AWS IoT 1-Click 1-Click-Gerät mithilfe eines Einlösungscodes (anstelle einer Geräte-ID) beansprucht.

aws iot1click-devices claim-devices-by-claim-code \
    --claim-code C-123EXAMPLE

Ausgabe:

{
   "Total": 9
   "ClaimCode": "C-123EXAMPLE"
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-device.

AWS CLI

Um ein Gerät zu beschreiben

Das folgende describe-device Beispiel beschreibt das angegebene Gerät.

aws iot1click-devices describe-device \
    --device-id G030PM0123456789

Ausgabe:

{
    "DeviceDescription": {
        "Arn": "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789",
        "Attributes": {
            "projectRegion": "us-west-2",
            "projectName": "AnytownDumpsters",
            "placementName": "customer217",
            "deviceTemplateName": "empty-dumpster-request"
        },
        "DeviceId": "G030PM0123456789",
        "Enabled": false,
        "RemainingLife": 99.9,
        "Type": "button",
        "Tags": {}
    }
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

  • APIEinzelheiten finden Sie DescribeDevicein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungfinalize-device-claim.

AWS CLI

So schließen Sie eine Reklamationsanfrage für ein AWS IoT 1-Click 1-Click-Gerät mithilfe einer Geräte-ID ab

Im folgenden finalize-device-claim Beispiel wird eine Anspruchsanforderung für das angegebene AWS IoT 1-Click 1-Click-Gerät mithilfe einer Geräte-ID (anstelle eines Einlösungscodes) abgeschlossen.

aws iot1click-devices finalize-device-claim \
    --device-id G030PM0123456789

Ausgabe:

{
    "State": "CLAIMED"
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungget-device-methods.

AWS CLI

Um die verfügbaren Methoden für ein Gerät aufzulisten

Das folgende get-device-methods Beispiel listet die verfügbaren Methoden für ein Gerät auf.

aws iot1click-devices get-device-methods \
    --device-id G030PM0123456789

Ausgabe:

{
    "DeviceMethods": [
        {
            "MethodName": "getDeviceHealthParameters"
        },
        {
            "MethodName": "setDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "getDeviceHealthMonitorCallback"
        },
        {
            "MethodName": "setOnClickCallback"
        },
        {
            "MethodName": "getOnClickCallback"
        }
    ]
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

Das folgende Codebeispiel zeigt die Verwendunginitiate-device-claim.

AWS CLI

Um mithilfe einer Geräte-ID einen Anspruch für ein AWS IoT 1-Click-Gerät geltend zu machen

Im folgenden initiate-device-claim Beispiel wird mithilfe einer Geräte-ID (anstelle eines Einlösungscodes) eine Anspruchsanforderung für das angegebene AWS IoT 1-Click-Gerät initiiert.

aws iot1click-devices initiate-device-claim \
    --device-id G030PM0123456789

Ausgabe:

{
    "State": "CLAIM_INITIATED"
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

Das folgende Codebeispiel zeigt die Verwendunginvoke-device-method.

AWS CLI

Um eine Gerätemethode auf einem Gerät aufzurufen

Im folgenden invoke-device-method Beispiel wird die angegebene Methode auf einem Gerät aufgerufen.

aws iot1click-devices invoke-device-method \
    --cli-input-json file://invoke-device-method.json

Inhalt von invoke-device-method.json:

{
    "DeviceId": "G030PM0123456789",
    "DeviceMethod": {
        "DeviceType": "device",
        "MethodName": "getDeviceHealthParameters"
    }
}

Ausgabe:

{
    "DeviceMethodResponse": "{\"remainingLife\": 99.8}"
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

Das folgende Codebeispiel zeigt die Verwendunglist-device-events.

AWS CLI

Um die Ereignisse eines Geräts für einen bestimmten Zeitraum aufzulisten

Das folgende list-device-events Beispiel listet die Ereignisse des angegebenen Geräts für den angegebenen Zeitraum auf.

aws iot1click-devices list-device-events \
    --device-id G030PM0123456789 \
    --from-time-stamp 2019-07-17T15:45:12.880Z --to-time-stamp 2019-07-19T15:45:12.880Z

Ausgabe:

{
    "Events": [
        {
            "Device": {
                "Attributes": {},
                "DeviceId": "G030PM0123456789",
                "Type": "button"
            },
            "StdEvent": "{\"clickType\": \"SINGLE\", \"reportedTime\": \"2019-07-18T23:47:55.015Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.85000000000001, \"testMode\": false}"
        },
        {
            "Device": {
                "Attributes": {},
                "DeviceId": "G030PM0123456789",
                "Type": "button"
            },
            "StdEvent": "{\"clickType\": \"DOUBLE\", \"reportedTime\": \"2019-07-19T00:14:41.353Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.8, \"testMode\": false}"
        }
    ]
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

Das folgende Codebeispiel zeigt die Verwendunglist-devices.

AWS CLI

Um die Geräte eines bestimmten Typs aufzulisten

Das folgende list-devices Beispiel listet die Geräte eines bestimmten Typs auf.

aws iot1click-devices list-devices \
    --device-type button

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Ausgabe:

{
    "Devices": [
        {
            "remainingLife": 99.9,
            "attributes": {
                "arn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
                "type": "button",
                "deviceId": "G030PM0123456789",
                "enabled": false
            }
        }
    ]
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

  • APIEinzelheiten finden Sie ListDevicesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-tags-for-resource.

AWS CLI

Um die Tags für ein Gerät aufzulisten

Im folgenden list-tags-for-resource Beispiel werden die Tags für das angegebene Gerät aufgelistet.

aws iot1click-devices list-tags-for-resource \
    --resource-arn "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789"

Ausgabe:

{
    "Tags": {
        "Driver Phone": "123-555-0199",
        "Driver": "Jorge Souza"
    }
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungtag-resource.

AWS CLI

Um einer AWS Geräteressource Tags hinzuzufügen

Im folgenden tag-resource Beispiel werden der angegebenen Ressource zwei Tags hinzugefügt.

aws iot1click-devices tag-resource \
    --cli-input-json file://devices-tag-resource.json

Inhalt von devices-tag-resource.json:

{
    "ResourceArn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789",
    "Tags": {
        "Driver": "Jorge Souza",
        "Driver Phone": "123-555-0199"
    }
}

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

  • APIEinzelheiten finden Sie TagResourcein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungunclaim-device.

AWS CLI

Um die Inanspruchnahme (Abmeldung) eines Geräts von Ihrem Konto aufzuheben AWS

Im folgenden unclaim-device Beispiel wird das angegebene Gerät von Ihrem Konto zurückgenommen (deregistriert). AWS 

aws iot1click-devices unclaim-device \
    --device-id G030PM0123456789

Ausgabe:

{
    "State": "UNCLAIMED"
}

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

  • APIEinzelheiten finden Sie UnclaimDevicein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunguntag-resource.

AWS CLI

Um Tags aus einer AWS Geräteressource zu entfernen

Im folgenden untag-resource Beispiel werden die Tags mit den Namen Driver Phone und Driver aus der angegebenen Geräteressource entfernt.

aws iot1click-devices untag-resource \
    --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \
    --tag-keys "Driver Phone" "Driver"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.

  • APIEinzelheiten finden Sie UntagResourcein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-device-state.

AWS CLI

Um den Status ``aktiviert`` für ein Gerät zu aktualisieren

Im Folgenden wird der Status des update-device-state angegebenen Geräts auf gesetzt. enabled

aws iot1click-devices update-device-state \
    --device-id G030PM0123456789 \
    --enabled

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Using AWS IoT 1-Click with the AWS CLI im AWS IoT 1-Click Developer Guide.