AWS IoT
Entwicklerhandbuch

Syntax des Schattendokuments

Der Device Shadow-Service verwendet bei den Vorgängen UPDATE, GET und DELETE mithilfe der RESTful-API oder MQTT-Nachrichten f. Veröffentl./Abos die folgenden Dokumente. Weitere Informationen finden Sie unter Dokumente des Device Shadow-Service.

Anfrage-Statusdokumente

Anfrage-Statusdokumente besitzen das folgende Format:

{ "state": { "desired": { "attribute1": integer2, "attribute2": "string2", ... "attributeN": boolean2 }, "reported": { "attribute1": integer1, "attribute2": "string1", ... "attributeN": boolean1 } }, "clientToken": "token", "version": version }
  • state — Aktualisierungen betreffen lediglich die angegebenen Felder.

  • clientToken — Bei Verwendung können Sie überprüfen, ob Anfrage und Antwort denselben Client-Token enthalten.

  • version — Bei Verwendung verarbeitet der Device Shadow-Service nur dann die Aktualisierung, wenn die angegebene Version mit seiner neuesten Version übereinstimmt.

Antwort-Statusdokumente

Antwort-Statusdokumente besitzen das folgende Format:

{ "state": { "desired": { "attribute1": integer2, "attribute2": "string2", ... "attributeN": boolean2 }, "reported": { "attribute1": integer1, "attribute2": "string1", ... "attributeN": boolean1 }, "delta": { "attribute3": integerX, "attribute5": "stringY" } }, "metadata": { "desired": { "attribute1": { "timestamp": timestamp }, "attribute2": { "timestamp": timestamp }, ... "attributeN": { "timestamp": timestamp } }, "reported": { "attribute1": { "timestamp": timestamp }, "attribute2": { "timestamp": timestamp }, ... "attributeN": { "timestamp": timestamp } } }, "timestamp": timestamp, "clientToken": "token", "version": version }
  • state

    • reported — Liegt nur dann vor, wenn ein Gerät Daten im Abschnitt reported (gemeldet) meldete und enthält nur Felder, die im Anfrage-Statusdokument enthalten waren.

    • desired — Liegt nur dann vor, wenn ein Gerät Daten im Abschnitt desired (gemeldet) meldete und enthält nur Felder, die im Anfrage-Statusdokument enthalten waren.

  • metadata — Enthält für jedes Attribut in den Abschnitten desired (Soll) und reported (gemeldet) die Zeitstempel, sodass Sie feststellen können, wann der Status aktualisiert wurde.

  • timestamp — Das Epoche-Datum und die Epoche-Uhrzeit, zu der die Antwort mittels AWS IoT erzeugt wurde.

  • clientToken — Liegt nur dann vor, wenn bei der Veröffentlichung einer gültigen JSON im Thema /update (/Aktualisierung) ein Client-Token verwendet wurde.

  • version — Die aktuelle Versionsnummer des Dokuments für den Geräteschatten, der in AWS IoT freigegeben wird. Sie erhöht sich zur vorherigen Versionsnummer des Dokuments um die Zahl eins.

Dokumente über Fehlermeldungen

Dokumente über Fehlermeldungen besitzen das folgende Format:

{ "code": error-code, "message": "error-message", "timestamp": timestamp, "clientToken": "token" }
  • code — Einen HTTP-Antwortcode, der auf die Art des Fehlers hinweist.

  • message — Eine Textnachricht mit zusätzlichen Informationen.

  • timestamp — Das Datum und Uhrzeit, zu der die Antwort mittels AWS IoT erzeugt wurde.

  • clientToken — Liegt nur dann vor, wenn bei der Veröffentlichung einer gültigen JSON im Thema /update (/Aktualisierung) ein Client-Token verwendet wurde.

Weitere Informationen finden Sie unter Schatten-Fehlermeldungen.