Werkzeuge zum Analysieren von JSON Werkzeuge zum Kodieren Tools zur ID-Generierung Fehler utils Werkzeuge zur Zustandsvalidierung Werkzeuge für das Verhalten Null Dienstprogramme für den Musterabgleich Tools zur Objektvalidierung CloudWatch Tools zur Protokollierung Gibt den Wert zurück, Verhalten, utils Autorisierung des Resolvers

Hilfsprogramme in $util

Anmerkung

Wir unterstützen jetzt hauptsächlich die APPSYNC_JS-Laufzeit und ihre Dokumentation. Bitte erwägen Sie, die APPSYNC_JS-Laufzeit und ihre Anleitungen hier zu verwenden.

Die $util Variable enthält allgemeine Hilfsmethoden, die Ihnen bei der Arbeit mit Daten helfen. Sofern nicht anders angegeben, verwenden alle Dienstprogramme den UTF-8-Zeichensatz.

Werkzeuge zum Analysieren von JSON

$util.parseJson(String) : Object: Erhält das "stringify"-JSON-Objekt und gibt eine Objektdarstellung des Ergebnisses zurück.
$util.toJson(Object) : String: Nimmt ein Objekt und gibt eine "stringify"-JSON-Darstellung dieses Objekts zurück.

Werkzeuge zum Kodieren

$util.urlEncode(String) : String: Gibt die Eingabezeichenfolge als eine application/x-www-form-urlencoded-kodierte Zeichenfolge zurück.
$util.urlDecode(String) : String: Dekodiert eine application/x-www-form-urlencoded-kodierte Zeichenfolge zurück in ihre nicht kodierte Form.
$util.base64Encode( byte[] ) : String: Verschlüsselt die Eingabe in eine base64-kodierte Zeichenfolge.
$util.base64Decode(String) : byte[]: Decodiert die Daten einer base64-verschlüsselten Zeichenfolge.

Tools zur ID-Generierung

$util.autoId() : String: Gibt eine zufällig generierte 128-Bit-UUID zurück.
$util.autoUlid() : String: Gibt eine zufällig generierte 128-Bit-ULID (Universally Unique Lexicographically Sortable Identifier) zurück.
$util.autoKsuid() : String: Gibt eine zufällig generierte 128-Bit-KSUID (K-Sortable Unique Identifier) Base62 zurück, die als Zeichenfolge mit einer Länge von 27 codiert ist.

Fehler utils

$util.error(String): Gibt einen benutzerdefinierte Fehler aus. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um einen Fehler in der Anfrage oder im Aufrufergebnis zu erkennen.
$util.error(String, String): Gibt einen benutzerdefinierte Fehler aus. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um einen Fehler in der Anfrage oder im Aufrufergebnis zu erkennen. Sie können auch eine errorType angeben.
$util.error(String, String, Object): Gibt einen benutzerdefinierte Fehler aus. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um einen Fehler in der Anfrage oder im Aufrufergebnis zu erkennen. Sie können auch ein Feld errorType und ein data Feld angeben. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt.

Anmerkung
datawird auf der Grundlage des Abfrageauswahlsatzes gefiltert.
$util.error(String, String, Object, Object): Gibt einen benutzerdefinierte Fehler aus. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Zusätzlich können ein errorType Feld, ein data Feld und ein errorInfo Feld angegeben werden. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt.

Anmerkung
datawird auf der Grundlage des Abfrageauswahlsatzes gefiltert. Der errorInfo-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt.
errorInfowird NICHT auf der Grundlage des Abfrageauswahlsatzes gefiltert.
$util.appendError(String): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Im Gegensatz zu $util.error(String) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können.
$util.appendError(String, String): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Zudem kann ein errorType angegeben werden. Im Gegensatz zu $util.error(String, String) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können.
$util.appendError(String, String, Object): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Zudem können die Felder errorType und data angegeben werden. Im Gegensatz zu $util.error(String, String, Object) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt.

Anmerkung
datawird auf der Grundlage des Abfrageauswahlsatzes gefiltert.
$util.appendError(String, String, Object, Object): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Zusätzlich können ein errorType Feld, ein data Feld und ein errorInfo Feld angegeben werden. Im Gegensatz zu $util.error(String, String, Object, Object) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt.

Anmerkung
datawird auf der Grundlage des Abfrageauswahlsatzes gefiltert. Der errorInfo-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt.
errorInfowird NICHT auf der Grundlage des Abfrageauswahlsatzes gefiltert.

Werkzeuge zur Zustandsvalidierung

$util.validate(Boolean, String) : void: Wenn die Bedingung falsch ist, wird eine CustomTemplateException mit der angegebenen Nachricht ausgelöst.
$util.validate(Boolean, String, String) : void: Wenn die Bedingung falsch ist, wird a CustomTemplateException mit der angegebenen Nachricht und dem angegebenen Fehlertyp ausgelöst.
$util.validate(Boolean, String, String, Object) : void: Wenn die Bedingung falsch ist, wird eine CustomTemplateException mit der angegebenen Meldung und dem angegebenen Fehlertyp sowie den Daten ausgelöst, die in der Antwort zurückgegeben werden sollen.

Werkzeuge für das Verhalten Null

$util.isNull(Object) : Boolean: Gibt "true" zurück, wenn das bereitgestellte Objekt null ist.
$util.isNullOrEmpty(String) : Boolean: Gibt "true" zurück, wenn die bereitgestellten Daten null oder eine leere Zeichenfolge sind. Ansonsten wird "false" zurückgegeben.
$util.isNullOrBlank(String) : Boolean: Gibt "true" zurück, wenn die bereitgestellten Daten null oder eine leere Zeichenfolge sind. Ansonsten wird "false" zurückgegeben.
$util.defaultIfNull(Object, Object) : Object: Gibt das erste Objekt zurück, wenn es nicht null ist. Ansonsten wird das zweite Objekt als ein "Standardobjekt" zurückgegeben.
$util.defaultIfNullOrEmpty(String, String) : String: Gibt die erste Zeichenfolge zurück, wenn sie nicht null oder leer ist. Ansonsten wird die zweite Zeichenfolge als eine "Standardzeichenfolge" zurückgegeben.
$util.defaultIfNullOrBlank(String, String) : String: Gibt die erste Zeichenfolge zurück, wenn sie nicht null oder leer ist. Ansonsten wird die zweite Zeichenfolge als eine "Standardzeichenfolge" zurückgegeben.

Dienstprogramme für den Musterabgleich

$util.typeOf(Object) : String: Gibt eine Zeichenfolge zurück, die den Typ des Objekts beschreibt. Unterstützte Typenidentifikationen sind "null", "Zahl", "Zeichenfolge", "Zuweisung", "Liste", "boolescher Wert". Wenn ein Typ nicht identifiziert werden kann, lautet der Rückgabetyp "Objekt".
$util.matches(String, String) : Boolean: Gibt "true" zurück, wenn das angegebene Muster im ersten Argument den bereitgestellten Daten im zweiten Argument entspricht. Das Muster muss ein regulärer Ausdruck sein, wie z. B. $util.matches("a*b", "aaaaab"). Die Funktionalität basiert auf Pattern, worauf Sie zur weiteren Dokumentation verweisen können.
$util.authType() : String: Gibt eine Zeichenfolge zurück, die den Multi-Auth-Typ beschreibt, der von einer Anfrage verwendet wird, und gibt entweder „IAM-Autorisierung“, „Benutzerpool-Autorisierung“, „Open ID Connect-Autorisierung“ oder „API-Schlüsselautorisierung“ zurück.

Tools zur Objektvalidierung

$util.isString(Object) : Boolean: Gibt true zurück, wenn das Objekt ein String ist.
$util.isNumber(Object) : Boolean: Gibt true zurück, wenn das Objekt eine Zahl ist.
$util.isBoolean(Object) : Boolean: Gibt true zurück, wenn das Objekt ein boolescher Wert ist.
$util.isList(Object) : Boolean: Gibt true zurück, wenn es sich bei dem Objekt um eine Liste handelt.
$util.isMap(Object) : Boolean: Gibt true zurück, wenn es sich bei dem Objekt um eine Map handelt.

CloudWatch Tools zur Protokollierung

$util.log.info(Object) : Void: Protokolliert die String-Darstellung des bereitgestellten Objekts im angeforderten Log-Stream, wenn die Protokollierung auf Anfrage- und Feldebene mit CloudWatch Protokollebene auf einer API aktiviert ist. ALL
$util.log.info(String, Object...) : Void: Protokolliert die String-Repräsentation der bereitgestellten Objekte im angeforderten Log-Stream, wenn die Protokollierung auf Anfrage- und Feldebene mit CloudWatch Protokollebene auf einer API aktiviert ist. ALL Dieses Hilfsprogramm ersetzt alle Variablen, die im ersten Eingabeformat String mit „{}“ gekennzeichnet sind, der Reihe nach durch die String-Darstellung der bereitgestellten Objekte.
$util.log.error(Object) : Void: Protokolliert die String-Repräsentation des bereitgestellten Objekts im angeforderten Log-Stream, wenn die CloudWatch Protokollierung auf Feldebene mit Log Level ERROR oder Log Level ALL auf einer API aktiviert ist.
$util.log.error(String, Object...) : Void: Protokolliert die Zeichenkettendarstellung der bereitgestellten Objekte im angeforderten Logstream, wenn die Protokollierung auf Feldebene mit CloudWatch Protokollebene ERROR oder Protokollebene auf einer API aktiviert ist. ALL Dieses Hilfsprogramm ersetzt alle Variablen, die im ersten Eingabeformat String mit „{}“ gekennzeichnet sind, der Reihe nach durch die String-Darstellung der bereitgestellten Objekte.

Gibt den Wert zurück, Verhalten, utils

$util.qr() und $util.quiet()

Führt eine VTL-Anweisung aus und unterdrückt dabei den zurückgegebenen Wert. Dies ist nützlich, um Methoden auszuführen, ohne temporäre Platzhalter zu verwenden, z. B. um Elemente zu einer Map hinzuzufügen. Beispiel:


#set ($myMap = {})
#set($discard = $myMap.put("id", "first value"))

Wird zu:


#set ($myMap = {})
$util.qr($myMap.put("id", "first value"))

$util.escapeJavaScript(String) : String: Gibt die Eingabezeichenfolge als JavaScript Escape-Zeichenfolge zurück.
$util.urlEncode(String) : String: Gibt die Eingabezeichenfolge als eine application/x-www-form-urlencoded-kodierte Zeichenfolge zurück.
$util.urlDecode(String) : String: Dekodiert eine application/x-www-form-urlencoded-kodierte Zeichenfolge zurück in ihre nicht kodierte Form.
$util.base64Encode( byte[] ) : String: Verschlüsselt die Eingabe in eine base64-kodierte Zeichenfolge.
$util.base64Decode(String) : byte[]: Decodiert die Daten einer base64-verschlüsselten Zeichenfolge.
$util.parseJson(String) : Object: Erhält das "stringify"-JSON-Objekt und gibt eine Objektdarstellung des Ergebnisses zurück.
$util.toJson(Object) : String: Nimmt ein Objekt und gibt eine "stringify"-JSON-Darstellung dieses Objekts zurück.
$util.autoId() : String: Gibt eine zufällig generierte 128-Bit-UUID zurück.
$util.autoUlid() : String: Gibt eine zufällig generierte 128-Bit-ULID (Universally Unique Lexicographically Sortable Identifier) zurück.
$util.autoKsuid() : String: Gibt eine zufällig generierte 128-Bit-KSUID (K-Sortable Unique Identifier) Base62 zurück, die als Zeichenfolge mit einer Länge von 27 codiert ist.
$util.unauthorized(): Gibt Unauthorized für das Feld aus, das aufgelöst wird. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um zu bestimmen, ob der Anrufer das Feld auflösen kann.
$util.error(String): Gibt einen benutzerdefinierte Fehler aus. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um einen Fehler in der Anfrage oder im Aufrufergebnis zu erkennen.
$util.error(String, String): Gibt einen benutzerdefinierte Fehler aus. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um einen Fehler in der Anfrage oder im Aufrufergebnis zu erkennen. Sie können auch eine errorType angeben.
$util.error(String, String, Object): Gibt einen benutzerdefinierte Fehler aus. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um einen Fehler in der Anfrage oder im Aufrufergebnis zu erkennen. Sie können auch ein Feld errorType und ein data Feld angeben. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt. Hinweis: data wird basierend auf dem Abfragenauswahlsatz gefiltert.
$util.error(String, String, Object, Object): Gibt einen benutzerdefinierte Fehler aus. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Außerdem können die Felder errorType, data und errorInfo angegeben werden. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt. Hinweis: data wird basierend auf dem Abfragenauswahlsatz gefiltert. Der errorInfo-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt. Hinweis: errorInfo wird NICHT basierend auf dem Abfragenauswahlsatz gefiltert.
$util.appendError(String): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Im Gegensatz zu $util.error(String) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können.
$util.appendError(String, String): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Zudem kann ein errorType angegeben werden. Im Gegensatz zu $util.error(String, String) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können.
$util.appendError(String, String, Object): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Zudem können die Felder errorType und data angegeben werden. Im Gegensatz zu $util.error(String, String, Object) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt. Hinweis: data wird basierend auf dem Abfragenauswahlsatz gefiltert.
$util.appendError(String, String, Object, Object): Fügt einen benutzerdefinierten Fehler an. Dies kann in Anforderungs- oder Antwortzuweisungsvorlagen verwendet werden, wenn die Vorlage einen Fehler bei der Anforderung oder beim Aufrufergebnis erkennt. Außerdem können die Felder errorType, data und errorInfo angegeben werden. Im Gegensatz zu $util.error(String, String, Object, Object) wird die Vorlagenbewertung nicht unterbrochen, sodass die Daten an den Aufrufer zurückgegeben werden können. Der data-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt. Hinweis: data wird basierend auf dem Abfragenauswahlsatz gefiltert. Der errorInfo-Wert wird zum entsprechenden error-Block in errors in der GraphQL-Antwort hinzugefügt. Hinweis: errorInfo wird NICHT basierend auf dem Abfragenauswahlsatz gefiltert.
$util.validate(Boolean, String) : void: Wenn die Bedingung falsch ist, wird a CustomTemplateException mit der angegebenen Nachricht ausgelöst.
$util.validate(Boolean, String, String) : void: Wenn die Bedingung falsch ist, wird a CustomTemplateException mit der angegebenen Nachricht und dem angegebenen Fehlertyp ausgelöst.
$util.validate(Boolean, String, String, Object) : void: Wenn die Bedingung falsch ist, wird eine CustomTemplateException mit der angegebenen Meldung und dem angegebenen Fehlertyp sowie den Daten ausgelöst, die in der Antwort zurückgegeben werden sollen.
$util.isNull(Object) : Boolean: Gibt "true" zurück, wenn das bereitgestellte Objekt null ist.
$util.isNullOrEmpty(String) : Boolean: Gibt "true" zurück, wenn die bereitgestellten Daten null oder eine leere Zeichenfolge sind. Ansonsten wird "false" zurückgegeben.
$util.isNullOrBlank(String) : Boolean: Gibt "true" zurück, wenn die bereitgestellten Daten null oder eine leere Zeichenfolge sind. Ansonsten wird "false" zurückgegeben.
$util.defaultIfNull(Object, Object) : Object: Gibt das erste Objekt zurück, wenn es nicht null ist. Ansonsten wird das zweite Objekt als ein "Standardobjekt" zurückgegeben.
$util.defaultIfNullOrEmpty(String, String) : String: Gibt die erste Zeichenfolge zurück, wenn sie nicht null oder leer ist. Ansonsten wird die zweite Zeichenfolge als eine "Standardzeichenfolge" zurückgegeben.
$util.defaultIfNullOrBlank(String, String) : String: Gibt die erste Zeichenfolge zurück, wenn sie nicht null oder leer ist. Ansonsten wird die zweite Zeichenfolge als eine "Standardzeichenfolge" zurückgegeben.
$util.isString(Object) : Boolean: Gibt "true" zurück, wenn das Objekt eine Zeichenfolge ist.
$util.isNumber(Object) : Boolean: Gibt "true" zurück, wenn das Objekt eine Zahl ist.
$util.isBoolean(Object) : Boolean: Gibt "true" zurück, wenn das Objekt ein boolescher Wert ist.
$util.isList(Object) : Boolean: Gibt "true" zurück, wenn das Objekt eine Liste ist.
$util.isMap(Object) : Boolean: Gibt "true" zurück, wenn das Objekt eine Zuweisung ist.
$util.typeOf(Object) : String: Gibt eine Zeichenfolge zurück, die den Typ des Objekts beschreibt. Unterstützte Typenidentifikationen sind "null", "Zahl", "Zeichenfolge", "Zuweisung", "Liste", "boolescher Wert". Wenn ein Typ nicht identifiziert werden kann, lautet der Rückgabetyp "Objekt".
$util.matches(String, String) : Boolean: Gibt "true" zurück, wenn das angegebene Muster im ersten Argument den bereitgestellten Daten im zweiten Argument entspricht. Das Muster muss ein regulärer Ausdruck sein, wie z. B. $util.matches("a*b", "aaaaab"). Die Funktionalität basiert auf Pattern, worauf Sie zur weiteren Dokumentation verweisen können.
$util.authType() : String: Gibt eine Zeichenfolge zurück, die den Multi-Auth-Typ beschreibt, der von einer Anfrage verwendet wird, und gibt entweder „IAM-Autorisierung“, „Benutzerpool-Autorisierung“, „Open ID Connect-Autorisierung“ oder „API-Schlüsselautorisierung“ zurück.
$util.log.info(Object) : Void: Protokolliert die String-Darstellung des bereitgestellten Objekts im angeforderten Log-Stream, wenn die Protokollierung auf Anfrage- und Feldebene auf CloudWatch Protokollebene in einer API aktiviert ist. ALL
$util.log.info(String, Object...) : Void: Protokolliert die String-Repräsentation der bereitgestellten Objekte im angeforderten Log-Stream, wenn die Protokollierung auf Anfrage- und Feldebene mit CloudWatch Protokollebene auf einer API aktiviert ist. ALL Dieses Hilfsprogramm ersetzt alle Variablen, die im ersten Eingabeformat String mit „{}“ gekennzeichnet sind, der Reihe nach durch die String-Darstellung der bereitgestellten Objekte.
$util.log.error(Object) : Void: Protokolliert die String-Repräsentation des bereitgestellten Objekts im angeforderten Log-Stream, wenn die CloudWatch Protokollierung auf Feldebene mit Log Level ERROR oder Log Level ALL auf einer API aktiviert ist.
$util.log.error(String, Object...) : Void: Protokolliert die Zeichenkettendarstellung der bereitgestellten Objekte im angeforderten Logstream, wenn die Protokollierung auf Feldebene mit CloudWatch Protokollebene ERROR oder Protokollebene auf einer API aktiviert ist. ALL Dieses Hilfsprogramm ersetzt alle Variablen, die im ersten Eingabeformat String mit „{}“ gekennzeichnet sind, der Reihe nach durch die String-Darstellung der bereitgestellten Objekte.

$util.escapeJavaScript(String) : String: Gibt die Eingabezeichenfolge als JavaScript maskierte Zeichenfolge zurück.

Autorisierung des Resolvers

$util.unauthorized(): Gibt Unauthorized für das Feld aus, das aufgelöst wird. Verwenden Sie dies in Vorlagen für die Zuordnung von Anfragen oder Antworten, um zu bestimmen, ob der Anrufer das Feld auflösen kann.

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

Referenz zum Hilfsprogramm für Resolver-Mapping-Vorlagen

AWS AppSync Direktiven