utilitas penguraian JSON Pengkodean utilitas Utilitas pembuatan ID Kesalahan utils Utils validasi kondisi Utils perilaku nol Utils pencocokan pola Utils validasi objek CloudWatch utilitas logging Kembalikan utilitas perilaku nilai Otorisasi penyelesai

Pembantu utilitas di $ util

catatan

Kami sekarang terutama mendukung runtime APPSYNC_JS dan dokumentasinya. Harap pertimbangkan untuk menggunakan runtime APPSYNC_JS dan panduannya di sini.

$utilVariabel berisi metode utilitas umum untuk membantu Anda bekerja dengan data. Kecuali ditentukan lain, semua utilitas menggunakan set karakter UTF-8.

utilitas penguraian JSON

$util.parseJson(String) : Object: Mengambil “stringified” JSON dan mengembalikan representasi objek dari hasilnya.
$util.toJson(Object) : String: Mengambil objek dan mengembalikan representasi JSON “stringified” dari objek itu.

Pengkodean utilitas

$util.urlEncode(String) : String: Mengembalikan string masukan sebagai string application/x-www-form-urlencoded dikodekan.
$util.urlDecode(String) : String: Mendekode string yang application/x-www-form-urlencoded dikodekan kembali ke bentuk yang tidak dikodekan.
$util.base64Encode( byte[] ) : String: Mengkodekan input ke dalam string yang dikodekan base64.
$util.base64Decode(String) : byte[]: Mendekode data dari string yang dikodekan base64.

Utilitas pembuatan ID

$util.autoId() : String: Mengembalikan UUID 128-bit yang dihasilkan secara acak.
$util.autoUlid() : String: Mengembalikan ULID 128-bit yang dihasilkan secara acak (Universalally Unique Lexicographically Sortable Identifier).
$util.autoKsuid() : String: Mengembalikan 128-bit yang dihasilkan secara acak KSUID (K-Sortable Unique Identifier) base62 dikodekan sebagai String dengan panjang 27.

Kesalahan utils

$util.error(String): Melempar kesalahan khusus. Gunakan ini dalam template pemetaan permintaan atau respons untuk mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan.
$util.error(String, String): Melempar kesalahan khusus. Gunakan ini dalam template pemetaan permintaan atau respons untuk mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Anda juga dapat menentukan fileerrorType.
$util.error(String, String, Object): Melempar kesalahan khusus. Gunakan ini dalam template pemetaan permintaan atau respons untuk mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Anda juga dapat menentukan errorType dan data bidang. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL.

catatan
dataakan disaring berdasarkan set pemilihan kueri.
$util.error(String, String, Object, Object): Melempar kesalahan khusus. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, errorType bidang, data bidang, dan errorInfo bidang dapat ditentukan. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL.

catatan
dataakan disaring berdasarkan set pemilihan kueri. errorInfoNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL.
errorInfoTIDAK akan disaring berdasarkan set pemilihan kueri.
$util.appendError(String): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Tidak seperti$util.error(String), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon.
$util.appendError(String, String): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, errorType dapat ditentukan. Tidak seperti$util.error(String, String), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon.
$util.appendError(String, String, Object): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, bidang errorType dan data bidang dapat ditentukan. Tidak seperti$util.error(String, String, Object), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL.

catatan
dataakan disaring berdasarkan set pemilihan kueri.
$util.appendError(String, String, Object, Object): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, errorType bidang, data bidang, dan errorInfo bidang dapat ditentukan. Tidak seperti$util.error(String, String, Object, Object), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL.

catatan
dataakan disaring berdasarkan set pemilihan kueri. errorInfoNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL.
errorInfoTIDAK akan disaring berdasarkan set pemilihan kueri.

Utils validasi kondisi

$util.validate(Boolean, String) : void: Jika kondisinya salah, lempar a CustomTemplateException dengan pesan yang ditentukan.
$util.validate(Boolean, String, String) : void: Jika kondisinya salah, lempar a CustomTemplateException dengan pesan dan jenis kesalahan yang ditentukan.
$util.validate(Boolean, String, String, Object) : void: Jika kondisinya salah, lempar a CustomTemplateException dengan pesan dan jenis kesalahan yang ditentukan, serta data untuk kembali dalam respons.

Utils perilaku nol

$util.isNull(Object) : Boolean: Mengembalikan nilai true jika objek yang disediakan adalah null.
$util.isNullOrEmpty(String) : Boolean: Mengembalikan nilai true jika data yang disediakan adalah null atau string kosong. Jika tidak, mengembalikan false.
$util.isNullOrBlank(String) : Boolean: Mengembalikan nilai true jika data yang disediakan adalah null atau string kosong. Jika tidak, mengembalikan false.
$util.defaultIfNull(Object, Object) : Object: Mengembalikan Object pertama jika tidak null. Jika tidak, mengembalikan objek kedua sebagai “Objek default”.
$util.defaultIfNullOrEmpty(String, String) : String: Mengembalikan String pertama jika tidak null atau kosong. Jika tidak, mengembalikan String kedua sebagai “String default”.
$util.defaultIfNullOrBlank(String, String) : String: Mengembalikan String pertama jika tidak null atau kosong. Jika tidak, mengembalikan String kedua sebagai “String default”.

Utils pencocokan pola

$util.typeOf(Object) : String: Mengembalikan String menggambarkan jenis Object. Identifikasi tipe yang didukung adalah: “Null”, “Number”, “String”, “Map”, “List”, “Boolean”. Jika suatu tipe tidak dapat diidentifikasi, tipe yang dikembalikan adalah “Objek”.
$util.matches(String, String) : Boolean: Mengembalikan nilai true jika pola tertentu dalam argumen pertama cocok dengan data yang disediakan dalam argumen kedua. Pola harus berupa ekspresi reguler seperti$util.matches("a*b", "aaaaab"). Fungsionalitas ini didasarkan pada Pola, yang dapat Anda referensikan untuk dokumentasi lebih lanjut.
$util.authType() : String: Mengembalikan String yang menjelaskan jenis multi-auth yang digunakan oleh permintaan, mengembalikan “IAM Authorization”, “User Pool Authorization”, “Open ID Connect Authorization”, atau “API Key Authorization”.

Utils validasi objek

$util.isString(Object) : Boolean: Mengembalikan nilai true jika Object adalah String.
$util.isNumber(Object) : Boolean: Mengembalikan nilai true jika Object adalah Number.
$util.isBoolean(Object) : Boolean: Mengembalikan nilai true jika Object adalah Boolean.
$util.isList(Object) : Boolean: Mengembalikan nilai true jika Object adalah List.
$util.isMap(Object) : Boolean: Mengembalikan nilai true jika Object adalah Peta.

CloudWatch utilitas logging

$util.log.info(Object) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat pencatatan tingkat permintaan dan tingkat bidang diaktifkan dengan level CloudWatch logALL,, INFO atau pada API. DEBUG
$util.log.info(String, Object...) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat pencatatan tingkat permintaan dan tingkat bidang diaktifkan dengan tingkat CloudWatch log pada API. ALL Utilitas ini akan menggantikan semua variabel yang ditunjukkan oleh “{}” dalam format input pertama String dengan representasi String dari Objek yang disediakan secara berurutan.
$util.log.debug(Object) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat pencatatan tingkat permintaan dan tingkat bidang diaktifkan dengan tingkat CloudWatch log atau pada API. ALL DEBUG
$util.log.debug(String, Object...) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat CloudWatch logging tingkat bidang diaktifkan dengan level log DEBUG atau level log ALL pada API. Utilitas ini akan menggantikan semua variabel yang ditunjukkan oleh “{}” dalam format input pertama String dengan representasi String dari Objek yang disediakan secara berurutan.
$util.log.error(Object) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat CloudWatch logging tingkat bidang diaktifkan dengan tingkat log apa pun (ALL,,, INFODEBUG, dll.) pada API.
$util.log.error(String, Object...) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat CloudWatch logging tingkat bidang diaktifkan dengan level log ERROR atau level log ALL pada API. Utilitas ini akan menggantikan semua variabel yang ditunjukkan oleh “{}” dalam format input pertama String dengan representasi String dari Objek yang disediakan secara berurutan.

Kembalikan utilitas perilaku nilai

$util.qr() dan $util.quiet()

Menjalankan pernyataan VTL sambil menekan nilai yang dikembalikan. Ini berguna untuk menjalankan metode tanpa menggunakan placeholder sementara, seperti menambahkan item ke peta. Misalnya:


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

Menjadi:


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

$util.escapeJavaScript(String) : String: Mengembalikan string masukan sebagai string JavaScript lolos.
$util.urlEncode(String) : String: Mengembalikan string masukan sebagai string application/x-www-form-urlencoded dikodekan.
$util.urlDecode(String) : String: Mendekode string yang application/x-www-form-urlencoded dikodekan kembali ke bentuk yang tidak dikodekan.
$util.base64Encode( byte[] ) : String: Mengkodekan input ke dalam string yang dikodekan base64.
$util.base64Decode(String) : byte[]: Mendekode data dari string yang dikodekan base64.
$util.parseJson(String) : Object: Mengambil “stringified” JSON dan mengembalikan representasi objek dari hasilnya.
$util.toJson(Object) : String: Mengambil objek dan mengembalikan representasi JSON “stringified” dari objek itu.
$util.autoId() : String: Mengembalikan UUID 128-bit yang dihasilkan secara acak.
$util.autoUlid() : String: Mengembalikan ULID 128-bit yang dihasilkan secara acak (Universalally Unique Lexicographically Sortable Identifier).
$util.autoKsuid() : String: Mengembalikan 128-bit yang dihasilkan secara acak KSUID (K-Sortable Unique Identifier) base62 dikodekan sebagai String dengan panjang 27.
$util.unauthorized(): Melempar Unauthorized untuk bidang yang sedang diselesaikan. Gunakan ini dalam templat pemetaan permintaan atau respons untuk menentukan apakah akan mengizinkan pemanggil menyelesaikan bidang.
$util.error(String): Melempar kesalahan khusus. Gunakan ini dalam template pemetaan permintaan atau respons untuk mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan.
$util.error(String, String): Melempar kesalahan khusus. Gunakan ini dalam template pemetaan permintaan atau respons untuk mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Anda juga dapat menentukan fileerrorType.
$util.error(String, String, Object): Melempar kesalahan khusus. Gunakan ini dalam template pemetaan permintaan atau respons untuk mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Anda juga dapat menentukan errorType dan data bidang. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL. Catatan: data akan difilter berdasarkan set pemilihan kueri.
$util.error(String, String, Object, Object): Melempar kesalahan khusus. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, errorType bidang, data bidang, dan errorInfo bidang dapat ditentukan. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL. Catatan: data akan difilter berdasarkan set pemilihan kueri. errorInfoNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL. Catatan: TIDAK errorInfo akan difilter berdasarkan set pemilihan kueri.
$util.appendError(String): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Tidak seperti$util.error(String), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon.
$util.appendError(String, String): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, errorType dapat ditentukan. Tidak seperti$util.error(String, String), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon.
$util.appendError(String, String, Object): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, bidang errorType dan data bidang dapat ditentukan. Tidak seperti$util.error(String, String, Object), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL. Catatan: data akan difilter berdasarkan set pemilihan kueri.
$util.appendError(String, String, Object, Object): Menambahkan kesalahan kustom. Ini dapat digunakan dalam template pemetaan permintaan atau respons jika template mendeteksi kesalahan dengan permintaan atau dengan hasil pemanggilan. Selain itu, errorType bidang, data bidang, dan errorInfo bidang dapat ditentukan. Tidak seperti$util.error(String, String, Object, Object), evaluasi template tidak akan terganggu, sehingga data dapat dikembalikan ke penelepon. dataNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL. Catatan: data akan difilter berdasarkan set pemilihan kueri. errorInfoNilai akan ditambahkan ke error blok yang sesuai di errors dalam respons GraphQL. Catatan: TIDAK errorInfo akan difilter berdasarkan set pemilihan kueri.
$util.validate(Boolean, String) : void: Jika kondisinya salah, lempar a CustomTemplateException dengan pesan yang ditentukan.
$util.validate(Boolean, String, String) : void: Jika kondisinya salah, lempar a CustomTemplateException dengan pesan dan jenis kesalahan yang ditentukan.
$util.validate(Boolean, String, String, Object) : void: Jika kondisinya salah, lempar a CustomTemplateException dengan pesan dan jenis kesalahan yang ditentukan, serta data untuk kembali dalam respons.
$util.isNull(Object) : Boolean: Mengembalikan nilai true jika objek yang disediakan adalah null.
$util.isNullOrEmpty(String) : Boolean: Mengembalikan nilai true jika data yang disediakan adalah null atau string kosong. Jika tidak, mengembalikan false.
$util.isNullOrBlank(String) : Boolean: Mengembalikan nilai true jika data yang disediakan adalah null atau string kosong. Jika tidak, mengembalikan false.
$util.defaultIfNull(Object, Object) : Object: Mengembalikan Object pertama jika tidak null. Jika tidak, mengembalikan objek kedua sebagai “Objek default”.
$util.defaultIfNullOrEmpty(String, String) : String: Mengembalikan String pertama jika tidak null atau kosong. Jika tidak, mengembalikan String kedua sebagai “String default”.
$util.defaultIfNullOrBlank(String, String) : String: Mengembalikan String pertama jika tidak null atau kosong. Jika tidak, mengembalikan String kedua sebagai “String default”.
$util.isString(Object) : Boolean: Mengembalikan nilai true jika Object adalah String.
$util.isNumber(Object) : Boolean: Mengembalikan nilai true jika Object adalah Number.
$util.isBoolean(Object) : Boolean: Mengembalikan nilai true jika Object adalah Boolean.
$util.isList(Object) : Boolean: Mengembalikan nilai true jika Object adalah Daftar.
$util.isMap(Object) : Boolean: Mengembalikan nilai true jika Object adalah Peta.
$util.typeOf(Object) : String: Mengembalikan String menggambarkan jenis Object. Identifikasi tipe yang didukung adalah: “Null”, “Number”, “String”, “Map”, “List”, “Boolean”. Jika suatu tipe tidak dapat diidentifikasi, tipe yang dikembalikan adalah “Objek”.
$util.matches(String, String) : Boolean: Mengembalikan nilai true jika pola tertentu dalam argumen pertama cocok dengan data yang disediakan dalam argumen kedua. Pola harus berupa ekspresi reguler seperti$util.matches("a*b", "aaaaab"). Fungsionalitas ini didasarkan pada Pola, yang dapat Anda referensikan untuk dokumentasi lebih lanjut.
$util.authType() : String: Mengembalikan String yang menjelaskan jenis multi-auth yang digunakan oleh permintaan, mengembalikan “IAM Authorization”, “User Pool Authorization”, “Open ID Connect Authorization”, atau “API Key Authorization”.
$util.log.info(Object) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat pencatatan tingkat permintaan dan tingkat bidang diaktifkan dengan tingkat CloudWatch log pada API. ALL
$util.log.info(String, Object...) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat pencatatan tingkat permintaan dan tingkat bidang diaktifkan dengan tingkat CloudWatch log pada API. ALL Utilitas ini akan menggantikan semua variabel yang ditunjukkan oleh “{}” dalam format input pertama String dengan representasi String dari Objek yang disediakan secara berurutan.
$util.log.error(Object) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat CloudWatch logging tingkat bidang diaktifkan dengan level log ERROR atau level log ALL pada API.
$util.log.error(String, Object...) : Void: Mencatat representasi String dari Objek yang disediakan ke aliran log yang diminta saat CloudWatch logging tingkat bidang diaktifkan dengan level log ERROR atau level log ALL pada API. Utilitas ini akan menggantikan semua variabel yang ditunjukkan oleh “{}” dalam format input pertama String dengan representasi String dari Objek yang disediakan secara berurutan.

$util.escapeJavaScript(String) : String: Mengembalikan string masukan sebagai string JavaScript lolos.

Otorisasi penyelesai

$util.unauthorized(): Melempar Unauthorized untuk bidang yang sedang diselesaikan. Gunakan ini dalam templat pemetaan permintaan atau respons untuk menentukan apakah akan mengizinkan pemanggil menyelesaikan bidang.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Referensi utilitas template pemetaan penyelesai

AWS AppSync arahan