組み込みユーティリティ - AWS AppSync

組み込みユーティリティ

util 変数には、データの操作を容易にする一般的なユーティリティメソッドが含まれています。特に指定されていない限り、すべてのユーティリティでは UTF-8 文字セットが使用されます。

エンコーディング utils

util.urlEncode(String)

入力文字列を application/x-www-form-urlencoded でエンコードされた文字列として返します。

util.urlDecode(String)

application/x-www-form-urlencoded でエンコードされた文字列をデコードして、エンコードされていない形式に戻します。

util.base64Encode(string) : string

入力を base64 でエンコードされた文字列にエンコードします。

util.base64Decode(string) : string

base64 エンコードされた文字列からデータをデコードします。

ID 生成 utils

util.autoId()

ランダムに生成された 128 ビットの UUID を返します。

util.autoUlid()

ランダムに生成された 128 ビットの ULID (辞書的にソート可能なユニバーサルユニーク識別子) を返します。

util.autoKsuid()

長さ 27 の文字列としてエンコードされた、ランダムに生成された 128 ビットの KSUID (K ソート可能な固有識別子) base62 を返します。

エラー utils

util.error(String, String?, Object?, Object?)

カスタムエラーをスローします。これは、テンプレートがリクエストまたは呼び出し結果でエラーを検出した場合に、リクエストまたはレスポンスのマッピングテンプレートで使用できます。また、errorType フィールド、data フィールド、および errorInfo フィールドを指定できます。data の値は、GraphQL レスポンスの errors 内の該当する error ブロックに追加されます。

注記

data はクエリ選択セットに基づいてフィルタリングされます。errorInfo の値は、GraphQL レスポンスの errors 内の該当する error ブロックに追加されます。

errorInfo はクエリ選択セットに基づいてフィルタリングされません

util.appendError(String, String?, Object?, Object?)

カスタムエラーを追加します。これは、テンプレートがリクエストまたは呼び出し結果でエラーを検出した場合に、リクエストまたはレスポンスのマッピングテンプレートで使用できます。また、errorType フィールド、data フィールド、および errorInfo フィールドを指定できます。util.error(String, String?, Object?, Object?) とは異なり、テンプレートの評価は中断されないため、データを呼び出し元に返すことができます。data の値は、GraphQL レスポンスの errors 内の該当する error ブロックに追加されます。

注記

data はクエリ選択セットに基づいてフィルタリングされます。errorInfo の値は、GraphQL レスポンスの errors 内の該当する error ブロックに追加されます。

errorInfo はクエリ選択セットに基づいてフィルタリングされません

タイプとパターンマッチングの utils

util.matches(String, String) : Boolean

最初の引数で指定されたパターンが、2 番目の引数で指定されたデータと一致する場合は true を返します。パターンは正規表現である必要があります (例: util.matches("a*b", "aaaaab"))。この機能は Java の Pattern に基づいています。詳細については、Pattern を参照してください。

util.authType()

リクエストで使用されているマルチ認可タイプを表す文字列型 (String) の値を返します。「IAM 認可」、「ユーザープールの認可」、「オープン ID Connect 認可」、または「API キー認可」のいずれかを返します。

戻り値動作 utils

util.escapeJavaScript(String)

入力文字列を JavasScript のエスケープした文字列として返します。

リゾルバー認可 utils

util.unauthorized()

解決されるフィールドに対して Unauthorized をスローします。リクエストまたはレスポンスのマッピングテンプレートでこれを使用し、呼び出し元にそのフィールドの解決が許可されるかどうかを判別します。