Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
nota
Ahora admitimos de forma básica el tiempo de ejecución APPSYNC_JS y su documentación. Considere la opción de utilizar el tiempo de ejecución APPSYNC_JS y sus guías aquí.
La variable $util contiene métodos de utilidad generales que ayudan a trabajar con los datos. A menos que se especifique lo contrario, todas las utilidades usan el juego de caracteres UTF-8.
Utilidades de análisis de JSON
-
$util.parseJson(String) : Object -
Toma un elemento JSON en forma de cadena y devuelve una representación del resultado en forma de objeto.
-
$util.toJson(Object) : String -
Toma un objeto y devuelve una representación JSON en forma de cadena de dicho objeto.
Utilidades de codificación
-
$util.urlEncode(String) : String -
Devuelve la cadena de entrada como una cadena
application/x-www-form-urlencodedcodificada. -
$util.urlDecode(String) : String -
Descodifica una cadena
application/x-www-form-urlencodedcodificada y la devuelve a su forma no codificada. -
$util.base64Encode( byte[] ) : String -
Codifica la entrada en una cadena codificada en base64.
-
$util.base64Decode(String) : byte[] -
Descodifica los datos de una cadena codificada en base64.
Utilidades de generación de ID
-
$util.autoId() : String -
Devuelve un UUID de 128 bits generado de forma aleatoria.
$util.autoUlid() : String-
Devuelve un ULID (identificador ordenable lexicográficamente único y universal) de 128 bits generado de forma aleatoria.
$util.autoKsuid() : String-
Devuelve un KSUID (identificador único ordenable por K) de 128 bits generado de forma aleatoria codificado en base62 como una cadena con una longitud de 27.
Utilidades de error
-
$util.error(String) -
Genera un error personalizado. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para detectar un error en la solicitud o en el resultado de la invocación.
-
$util.error(String, String) -
Genera un error personalizado. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para detectar un error en la solicitud o en el resultado de la invocación. También puede especificar un
errorType. -
$util.error(String, String, Object) -
Genera un error personalizado. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para detectar un error en la solicitud o en el resultado de la invocación. También puede especificar un campo
errorTypeydata. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL.nota
datase filtrará en función de la selección de consulta establecida. -
$util.error(String, String, Object, Object) -
Genera un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se pueden especificar los campos
errorType,datayerrorInfo. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL.nota
datase filtrará en función de la selección de consulta establecida. El valor deerrorInfose añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL.errorInfoNO se filtrará en función de la selección de consulta establecida. -
$util.appendError(String) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. A diferencia de
$util.error(String), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. -
$util.appendError(String, String) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se puede especificar un valor
errorType. A diferencia de$util.error(String, String), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. -
$util.appendError(String, String, Object) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se puede especificar un valor
errorTypey un campodata. A diferencia de$util.error(String, String, Object), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL.nota
datase filtrará en función de la selección de consulta establecida. -
$util.appendError(String, String, Object, Object) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se pueden especificar los campos
errorType,datayerrorInfo. A diferencia de$util.error(String, String, Object, Object), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL.nota
datase filtrará en función de la selección de consulta establecida. El valor deerrorInfose añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL.errorInfoNO se filtrará en función de la selección de consulta establecida.
Utilidades de validación condicional
-
$util.validate(Boolean, String) : void -
Si la condición es falsa, lanza una CustomTemplateException con el mensaje especificado.
-
$util.validate(Boolean, String, String) : void -
Si la condición es falsa, lanza un CustomTemplateException con el mensaje y el tipo de error especificados.
-
$util.validate(Boolean, String, String, Object) : void -
Si la condición es falsa, arroja a CustomTemplateException con el mensaje y el tipo de error especificados, así como los datos que desee devolver en la respuesta.
Utilidades de comportamiento nulo
-
$util.isNull(Object) : Boolean -
Devuelve el valor true si el objeto suministrado es nulo.
-
$util.isNullOrEmpty(String) : Boolean -
Devuelve el valor true si los datos proporcionados son nulos o una cadena vacía. De lo contrario, devuelve el valor false.
-
$util.isNullOrBlank(String) : Boolean -
Devuelve el valor true si los datos proporcionados son nulos o una cadena en blanco. De lo contrario, devuelve el valor false.
-
$util.defaultIfNull(Object, Object) : Object -
Devuelve el primer objeto si no es nulo. De lo contrario devuelve el segundo objeto como "objeto predeterminado".
-
$util.defaultIfNullOrEmpty(String, String) : String -
Devuelve la primera cadena si no es nula ni está vacía. De lo contrario devuelve la segunda cadena como "cadena predeterminada".
-
$util.defaultIfNullOrBlank(String, String) : String -
Devuelve la primera cadena si no es nula ni está en blanco. De lo contrario devuelve la segunda cadena como "cadena predeterminada".
Utilidades de coincidencia de patrones
-
$util.typeOf(Object) : String -
Devuelve una cadena que describe el tipo de objeto. Las identificaciones de tipos admitidas son: "Null", "Number", "String", "Map", "List" y "Boolean". Si no puede identificarse un tipo, el tipo devuelto es "Object".
-
$util.matches(String, String) : Boolean -
Devuelve un valor true si el patrón especificado en el primer argumento coincide con los datos proporcionados en el segundo argumento. El patrón tiene que ser una expresión regular, por ejemplo
$util.matches("a*b", "aaaaab"). La funcionalidad se basa en Pattern, que puede consultar para obtener más información. -
$util.authType() : String -
Devuelve una cadena que describe el tipo de autenticación múltiple que utiliza una solicitud y devuelve "Autorización de IAM", "Autorización del grupo de usuarios", "Autorización de Open ID Connect" o "Autorización de la clave de API".
Utilidades de validación de objetos
-
$util.isString(Object) : Boolean -
Devuelve el valor true si el objeto es una cadena.
-
$util.isNumber(Object) : Boolean -
Devuelve el valor true si el objeto es un número.
-
$util.isBoolean(Object) : Boolean -
Devuelve el valor true si el objeto es un valor booleano.
-
$util.isList(Object) : Boolean -
Devuelve el valor true si el objeto es una lista.
-
$util.isMap(Object) : Boolean -
Devuelve el valor true si el objeto es un mapa.
CloudWatch utilidades de registro
$util.log.info(Object) : Void-
Registra la representación en cadena del objeto proporcionado en el flujo de registro solicitado cuando el registro a nivel de solicitud y de campo está habilitado a nivel CloudWatch de registro o en una
ALLAPIINFO.DEBUG $util.log.info(String, Object...) : Void-
Registra la representación en cadena de los objetos proporcionados en el flujo de registro solicitado cuando el registro a nivel de solicitud y de campo está habilitado con el nivel de CloudWatch registro en una API.
ALLEsta utilidad reemplazará todas las variables indicadas con "{}" en la primera cadena de formato de entrada por la representación de cadena de los objetos proporcionados en orden. $util.log.debug(Object) : Void-
Registra la representación en cadena del objeto proporcionado en el flujo de registro solicitado cuando el registro a nivel de solicitud y de campo está habilitado a nivel de CloudWatch registro o en una API.
ALLDEBUG $util.log.debug(String, Object...) : Void-
Registra la representación en cadena de los objetos proporcionados en el flujo de registro solicitado cuando el registro a nivel de campo está habilitado con el nivel de CloudWatch registro
DEBUGo el nivel de registro en una API.ALLEsta utilidad reemplazará todas las variables indicadas con "{}" en la primera cadena de formato de entrada por la representación de cadena de los objetos proporcionados en orden. $util.log.error(Object) : Void-
Registra la representación en cadena del objeto proporcionado en el flujo de registro solicitado cuando el CloudWatch registro a nivel de campo está habilitado con cualquier nivel de registro (
ALL,,INFODEBUG, etc.) de una API. $util.log.error(String, Object...) : Void-
Registra la representación en cadena de los objetos proporcionados en el flujo de registro solicitado cuando el registro a nivel de campo está habilitado con el nivel de CloudWatch registro
ERRORo el nivel de registro en una API.ALLEsta utilidad reemplazará todas las variables indicadas con "{}" en la primera cadena de formato de entrada por la representación de cadena de los objetos proporcionados en orden.
Utilidades de comportamiento del valor devuelto
$util.qr()y$util.quiet()-
Ejecuta una instrucción VTL y suprime el valor devuelto. Esto resulta útil para ejecutar métodos sin utilizar marcadores de posición temporales, por ejemplo para añadir elementos a un mapa. Por ejemplo:
#set ($myMap = {}) #set($discard = $myMap.put("id", "first value"))se convierte en:
#set ($myMap = {}) $util.qr($myMap.put("id", "first value"))-
$util.escapeJavaScript(String) : String -
Devuelve la cadena de entrada como cadena de JavaScript escape.
-
$util.urlEncode(String) : String -
Devuelve la cadena de entrada como una cadena
application/x-www-form-urlencodedcodificada. -
$util.urlDecode(String) : String -
Descodifica una cadena
application/x-www-form-urlencodedcodificada y la devuelve a su forma no codificada. -
$util.base64Encode( byte[] ) : String -
Codifica la entrada en una cadena codificada en base64.
-
$util.base64Decode(String) : byte[] -
Descodifica los datos de una cadena codificada en base64.
-
$util.parseJson(String) : Object -
Toma un elemento JSON en forma de cadena y devuelve una representación del resultado en forma de objeto.
-
$util.toJson(Object) : String -
Toma un objeto y devuelve una representación JSON en forma de cadena de dicho objeto.
-
$util.autoId() : String -
Devuelve un UUID de 128 bits generado de forma aleatoria.
$util.autoUlid() : String-
Devuelve un ULID (identificador ordenable lexicográficamente único y universal) de 128 bits generado de forma aleatoria.
$util.autoKsuid() : String-
Devuelve un KSUID (identificador único ordenable por K) de 128 bits generado de forma aleatoria codificado en base62 como una cadena con una longitud de 27.
-
$util.unauthorized() -
Genera el código
Unauthorizedpara el campo que se está resolviendo. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para determinar si se debe permitir al intermediario que resuelva el campo. -
$util.error(String) -
Genera un error personalizado. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para detectar un error en la solicitud o en el resultado de la invocación.
-
$util.error(String, String) -
Genera un error personalizado. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para detectar un error en la solicitud o en el resultado de la invocación. También puede especificar un
errorType. -
$util.error(String, String, Object) -
Genera un error personalizado. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para detectar un error en la solicitud o en el resultado de la invocación. También puede especificar un campo
errorTypeydata. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL. Nota:datase filtrará en función de la selección de consulta establecida. -
$util.error(String, String, Object, Object) -
Genera un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se puede especificar un campo
errorType, un campodatay un campoerrorInfo. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL. Nota:datase filtrará en función de la selección de consulta establecida. El valor deerrorInfose añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL. Nota:errorInfoNO se filtrará en función de la selección de consulta establecida. -
$util.appendError(String) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. A diferencia de
$util.error(String), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. -
$util.appendError(String, String) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se puede especificar un valor
errorType. A diferencia de$util.error(String, String), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. -
$util.appendError(String, String, Object) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se puede especificar un valor
errorTypey un campodata. A diferencia de$util.error(String, String, Object), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL. Nota:datase filtrará en función de la selección de consulta establecida. -
$util.appendError(String, String, Object, Object) -
Adjunta un error personalizado. Se puede utilizar en las plantillas de mapeo de solicitud o de respuesta si la plantilla detecta un error en la solicitud o en el resultado de la invocación. También se puede especificar un campo
errorType, un campodatay un campoerrorInfo. A diferencia de$util.error(String, String, Object, Object), la evaluación de la plantilla no se interrumpirá, de modo podrán devolverse datos al intermediario. El valor dedatase añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL. Nota:datase filtrará en función de la selección de consulta establecida. El valor deerrorInfose añadirá al bloqueerrorcorrespondiente dentro deerrorsen la respuesta de GraphQL. Nota:errorInfoNO se filtrará en función de la selección de consulta establecida. -
$util.validate(Boolean, String) : void -
Si la condición es falsa, lanza a CustomTemplateException con el mensaje especificado.
-
$util.validate(Boolean, String, String) : void -
Si la condición es falsa, lanza un CustomTemplateException con el mensaje y el tipo de error especificados.
-
$util.validate(Boolean, String, String, Object) : void -
Si la condición es falsa, arroja a CustomTemplateException con el mensaje y el tipo de error especificados, así como los datos que desee devolver en la respuesta.
-
$util.isNull(Object) : Boolean -
Devuelve el valor true si el objeto suministrado es nulo.
-
$util.isNullOrEmpty(String) : Boolean -
Devuelve el valor true si los datos proporcionados son nulos o una cadena vacía. De lo contrario, devuelve el valor false.
-
$util.isNullOrBlank(String) : Boolean -
Devuelve el valor true si los datos proporcionados son nulos o una cadena en blanco. De lo contrario, devuelve el valor false.
-
$util.defaultIfNull(Object, Object) : Object -
Devuelve el primer objeto si no es nulo. De lo contrario devuelve el segundo objeto como "objeto predeterminado".
-
$util.defaultIfNullOrEmpty(String, String) : String -
Devuelve la primera cadena si no es nula ni está vacía. De lo contrario devuelve la segunda cadena como "cadena predeterminada".
-
$util.defaultIfNullOrBlank(String, String) : String -
Devuelve la primera cadena si no es nula ni está en blanco. De lo contrario devuelve la segunda cadena como "cadena predeterminada".
-
$util.isString(Object) : Boolean -
Devuelve el valor true si el objeto es una cadena.
-
$util.isNumber(Object) : Boolean -
Devuelve el valor true si el objeto es un número.
-
$util.isBoolean(Object) : Boolean -
Devuelve el valor true si el objeto es un valor booleano.
-
$util.isList(Object) : Boolean -
Devuelve el valor true si el objeto es una lista.
-
$util.isMap(Object) : Boolean -
Devuelve el valor true si el objeto es un mapa.
-
$util.typeOf(Object) : String -
Devuelve una cadena que describe el tipo de objeto. Las identificaciones de tipos admitidas son: "Null", "Number", "String", "Map", "List" y "Boolean". Si no puede identificarse un tipo, el tipo devuelto es "Object".
-
$util.matches(String, String) : Boolean -
Devuelve un valor true si el patrón especificado en el primer argumento coincide con los datos proporcionados en el segundo argumento. El patrón tiene que ser una expresión regular, por ejemplo
$util.matches("a*b", "aaaaab"). La funcionalidad se basa en Pattern, que puede consultar para obtener más información. -
$util.authType() : String -
Devuelve una cadena que describe el tipo de autenticación múltiple que utiliza una solicitud y devuelve "Autorización de IAM", "Autorización del grupo de usuarios", "Autorización de Open ID Connect" o "Autorización de la clave de API".
$util.log.info(Object) : Void-
Registra la representación en cadena del objeto proporcionado en el flujo de registro solicitado cuando el registro a nivel de solicitud y de campo está habilitado con el nivel de CloudWatch registro en una API.
ALL $util.log.info(String, Object...) : Void-
Registra la representación en cadena de los objetos proporcionados en el flujo de registro solicitado cuando el registro a nivel de solicitud y de campo está habilitado con el nivel de CloudWatch registro en una API.
ALLEsta utilidad reemplazará todas las variables indicadas con "{}" en la primera cadena de formato de entrada por la representación de cadena de los objetos proporcionados en orden. $util.log.error(Object) : Void-
Registra la representación en cadena del objeto proporcionado en el flujo de registro solicitado cuando el registro a nivel de campo está habilitado con el nivel de CloudWatch registro
ERRORo el nivel de registro en una API.ALL $util.log.error(String, Object...) : Void-
Registra la representación en cadena de los objetos proporcionados en el flujo de registro solicitado cuando el registro a nivel de campo está habilitado con el nivel de CloudWatch registro
ERRORo el nivel de registro en una API.ALLEsta utilidad reemplazará todas las variables indicadas con "{}" en la primera cadena de formato de entrada por la representación de cadena de los objetos proporcionados en orden.
-
-
$util.escapeJavaScript(String) : String -
Devuelve la cadena de entrada como cadena de JavaScript escape.
Autorización del solucionador
-
$util.unauthorized() -
Genera el código
Unauthorizedpara el campo que se está resolviendo. Utilícela en las plantillas de mapeo de solicitudes o de respuestas para determinar si se debe permitir al intermediario que resuelva el campo.
