기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
참고
이제 우리는 주로 APPSYNC_JS 런타임과 해당 문서를 지원합니다. 여기에서 APPSYNC_JS 런타임과 해당 안내서를 사용해 보세요.
$util 변수에는 데이터 작업에 도움이 되는 일반 유틸리티 메서드가 포함되어 있습니다. 달리 지정하지 않는 한, 모든 유틸리티는 UTF-8 문자 집합을 사용합니다.
JSON 구문 분석 유틸리티
-
$util.parseJson(String) : Object -
‘문자열화된’ JSON을 가져와서 결과의 객체 표현을 반환합니다.
-
$util.toJson(Object) : String -
객체를 받아 해당 객체의 ‘문자열화된’ JSON 표현을 반환합니다.
인코딩 유틸리티
-
$util.urlEncode(String) : String -
입력 문자열을
application/x-www-form-urlencoded인코딩 문자열로 반환합니다. -
$util.urlDecode(String) : String -
application/x-www-form-urlencoded인코딩 문자열을 인코딩되지 않은 형식으로 다시 디코딩합니다. -
$util.base64Encode( byte[] ) : String -
입력을 base64 인코딩 문자열로 인코딩합니다.
-
$util.base64Decode(String) : byte[] -
데이터를 base64 인코딩 문자열에서 디코딩합니다.
ID 생성 유틸리티
-
$util.autoId() : String -
임의로 생성된 128비트 UUID를 반환합니다.
$util.autoUlid() : String-
무작위로 생성된 128비트 ULID(Universally Unique Lexicographically Sortable Identifier)를 반환합니다.
$util.autoKsuid() : String-
길이가 27인 문자열로 인코딩된 무작위로 생성된 128비트 KSUID(K-Sortable Unique Identifier) base62를 반환합니다.
오류 유틸리티
-
$util.error(String) -
사용자 지정 오류를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 사용하여 요청 또는 호출 결과와 관련된 오류를 감지할 수 있습니다.
-
$util.error(String, String) -
사용자 지정 오류를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 사용하여 요청 또는 호출 결과와 관련된 오류를 감지할 수 있습니다.
errorType도 지정할 수 있습니다. -
$util.error(String, String, Object) -
사용자 지정 오류를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 사용하여 요청 또는 호출 결과와 관련된 오류를 감지할 수 있습니다.
errorType및data필드를 지정할 수도 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다.참고
참고:
data는 쿼리 선택 세트를 기반으로 필터링됩니다. -
$util.error(String, String, Object, Object) -
사용자 지정 오류를 발생시킵니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType,data및errorInfo필드를 지정할 수 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다.참고
참고:
data는 쿼리 선택 세트를 기반으로 필터링됩니다. GraphQL 응답에서errorInfo값은error내 해당errors블록에 추가됩니다.errorInfo는 쿼리 선택 세트를 기반으로 필터링되지 않습니다. -
$util.appendError(String) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다.
$util.error(String)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. -
$util.appendError(String, String) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType을 지정할 수 있습니다.$util.error(String, String)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. -
$util.appendError(String, String, Object) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType과data필드를 지정할 수 있습니다.$util.error(String, String, Object)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다.참고
참고:
data는 쿼리 선택 세트를 기반으로 필터링됩니다. -
$util.appendError(String, String, Object, Object) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType,data및errorInfo필드를 지정할 수 있습니다.$util.error(String, String, Object, Object)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다.참고
참고:
data는 쿼리 선택 세트를 기반으로 필터링됩니다. GraphQL 응답에서errorInfo값은error내 해당errors블록에 추가됩니다.errorInfo는 쿼리 선택 세트를 기반으로 필터링되지 않습니다.
조건 검증 유틸리티
-
$util.validate(Boolean, String) : void -
조건이 false이면 지정된 메시지와 함께 CustomTemplateException이 발생합니다.
-
$util.validate(Boolean, String, String) : void -
조건이 false이면 지정된 메시지 및 오류 유형과 함께 CustomTemplateException이 발생합니다.
-
$util.validate(Boolean, String, String, Object) : void -
조건이 false이면 지정된 메시지 및 오류 유형 그리고 응답에서 반환할 데이터와 함께 CustomTemplateException이 발생합니다.
Null 동작 유틸리티
-
$util.isNull(Object) : Boolean -
제공되는 객체가 null이면 true를 반환합니다.
-
$util.isNullOrEmpty(String) : Boolean -
제공되는 데이터가 null이거나 빈 문자열이면 true를 반환합니다. 그렇지 않을 경우 false를 반환합니다.
-
$util.isNullOrBlank(String) : Boolean -
제공되는 데이터가 null이거나 빈 문자열이면 true를 반환합니다. 그렇지 않을 경우 false를 반환합니다.
-
$util.defaultIfNull(Object, Object) : Object -
첫 번째 객체가 null이 아니면 첫 번째 객체를 반환합니다. 그렇지 않은 경우 두 번째 객체를 ‘기본 객체’로 반환합니다.
-
$util.defaultIfNullOrEmpty(String, String) : String -
첫 번째 문자열이 null이 아니거나 비어 있지 않으면 첫 번째 문자열을 반환합니다. 그렇지 않은 경우 두 번째 문자열을 ‘기본 문자열’로 반환합니다.
-
$util.defaultIfNullOrBlank(String, String) : String -
첫 번째 문자열이 null이 아니거나 공백이 아니면 첫 번째 문자열을 반환합니다. 그렇지 않은 경우 두 번째 문자열을 ‘기본 문자열’로 반환합니다.
패턴 매칭 유틸리티
-
$util.typeOf(Object) : String -
객체 유형을 설명하는 문자열을 반환합니다. 지원되는 유형 식별은 ‘Null’, ‘숫자’, ‘문자열’, ‘맵’, ‘목록’, ‘부울’입니다. 유형을 식별할 수 없는 경우 반환 유형은 ‘객체’입니다.
-
$util.matches(String, String) : Boolean -
첫 번째 인수의 지정된 패턴이 두 번째 인수에서 제공되는 데이터와 일치하는 경우 true를 반환합니다. 패턴은
$util.matches("a*b", "aaaaab")등과 같은 정규식이어야 합니다. 이 기능은 Pattern을 기반으로 하며, 여기서 자세한 설명을 참조할 수 있습니다. -
$util.authType() : String -
요청에 사용되는 다중 인증 유형을 설명하는 문자열을 반환하고 'IAM 권한 부여', '사용자 풀 권한 부여', 'Open ID Connect 권한 부여' 또는 'API 키 인증'을 반환합니다.
객체 검증 유틸리티
-
$util.isString(Object) : Boolean -
객체가 문자열인 경우 true를 반환합니다.
-
$util.isNumber(Object) : Boolean -
객체가 숫자인 경우 true를 반환합니다.
-
$util.isBoolean(Object) : Boolean -
객체가 부울인 경우 true를 반환합니다.
-
$util.isList(Object) : Boolean -
객체가 목록인 경우 true를 반환합니다.
-
$util.isMap(Object) : Boolean -
객체가 맵인 경우 true를 반환합니다.
CloudWatch 로깅 유틸리티
$util.log.info(Object) : Void-
API에서 로그 수준
ALL,INFO또는 로 요청 수준 및 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림DEBUG에 로깅합니다. $util.log.info(String, Object...) : Void-
API에서 로그 수준
ALL로 요청 수준 및 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 기록합니다. 이 유틸리티는 첫 번째 입력 형식 문자열에서 '{}'로 표시된 모든 변수를 제공된 객체의 문자열 표현으로 순서대로 바꿉니다. $util.log.debug(Object) : Void-
로그 수준
ALL또는 API에서 요청 수준 및 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림DEBUG에 로깅합니다. $util.log.debug(String, Object...) : Void-
API에서 로그 수준
DEBUG또는 로그 수준ALL로 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 기록합니다. 이 유틸리티는 첫 번째 입력 형식 문자열에서 '{}'로 표시된 모든 변수를 제공된 객체의 문자열 표현으로 순서대로 바꿉니다. $util.log.error(Object) : Void-
API에서 모든 로그 수준(
ALL,INFODEBUG, 등)으로 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 로깅합니다. $util.log.error(String, Object...) : Void-
API에서 로그 수준
ERROR또는 로그 수준ALL로 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 기록합니다. 이 유틸리티는 첫 번째 입력 형식 문자열에서 '{}'로 표시된 모든 변수를 제공된 객체의 문자열 표현으로 순서대로 바꿉니다.
반환 값 동작 유틸리티
$util.qr()및$util.quiet()-
반환된 값을 제한하면서 VTL 문을 실행합니다. 이는 맵에 항목 추가와 같이 임시 자리 표시자를 사용하지 않고 메서드를 실행하고자 하는 경우 유용합니다. 예시:
#set ($myMap = {}) #set($discard = $myMap.put("id", "first value"))Becomes:
#set ($myMap = {}) $util.qr($myMap.put("id", "first value"))-
$util.escapeJavaScript(String) : String -
입력 문자열을 JavaScript 의 이스케이프된 문자열로 반환합니다.
-
$util.urlEncode(String) : String -
입력 문자열을
application/x-www-form-urlencoded인코딩 문자열로 반환합니다. -
$util.urlDecode(String) : String -
application/x-www-form-urlencoded인코딩 문자열을 인코딩되지 않은 형식으로 다시 디코딩합니다. -
$util.base64Encode( byte[] ) : String -
입력을 base64 인코딩 문자열로 인코딩합니다.
-
$util.base64Decode(String) : byte[] -
데이터를 base64 인코딩 문자열에서 디코딩합니다.
-
$util.parseJson(String) : Object -
‘문자열화된’ JSON을 가져와서 결과의 객체 표현을 반환합니다.
-
$util.toJson(Object) : String -
객체를 받아 해당 객체의 ‘문자열화된’ JSON 표현을 반환합니다.
-
$util.autoId() : String -
임의로 생성된 128비트 UUID를 반환합니다.
$util.autoUlid() : String-
무작위로 생성된 128비트 ULID(Universally Unique Lexicographically Sortable Identifier)를 반환합니다.
$util.autoKsuid() : String-
길이가 27인 문자열로 인코딩된 무작위로 생성된 128비트 KSUID(K-Sortable Unique Identifier) base62를 반환합니다.
-
$util.unauthorized() -
해석 중인 필드에 대해
Unauthorized를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 이를 사용하여 호출자가 필드를 확인하도록 허용할지 여부를 결정합니다. -
$util.error(String) -
사용자 지정 오류를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 사용하여 요청 또는 호출 결과와 관련된 오류를 감지할 수 있습니다.
-
$util.error(String, String) -
사용자 지정 오류를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 사용하여 요청 또는 호출 결과와 관련된 오류를 감지할 수 있습니다.
errorType도 지정할 수 있습니다. -
$util.error(String, String, Object) -
사용자 지정 오류를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 사용하여 요청 또는 호출 결과와 관련된 오류를 감지할 수 있습니다.
errorType및data필드를 지정할 수도 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다. 참고:data는 쿼리 선택 세트를 기반으로 필터링됩니다. -
$util.error(String, String, Object, Object) -
사용자 지정 오류를 발생시킵니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType,data및errorInfo필드를 지정할 수 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다. 참고:data는 쿼리 선택 세트를 기반으로 필터링됩니다. GraphQL 응답에서errorInfo값은error내 해당errors블록에 추가됩니다. 참고:errorInfo는 쿼리 선택 세트를 기반으로 필터링되지 않습니다. -
$util.appendError(String) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다.
$util.error(String)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. -
$util.appendError(String, String) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType을 지정할 수 있습니다.$util.error(String, String)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. -
$util.appendError(String, String, Object) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType과data필드를 지정할 수 있습니다.$util.error(String, String, Object)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다. 참고:data는 쿼리 선택 세트를 기반으로 필터링됩니다. -
$util.appendError(String, String, Object, Object) -
사용자 지정 오류를 추가합니다. 이 필드는 요청 또는 응답 매핑 템플릿에서 템플릿이 요청 또는 호출 결과와 관련된 오류를 감지하는 경우 사용할 수 있습니다. 또한
errorType,data및errorInfo필드를 지정할 수 있습니다.$util.error(String, String, Object, Object)와 달리 템플릿 평가가 중단되지 않기 때문에 데이터를 호출자에게 반환할 수 있습니다. GraphQL 응답에서data값은error내 해당errors블록에 추가됩니다. 참고:data는 쿼리 선택 세트를 기반으로 필터링됩니다. GraphQL 응답에서errorInfo값은error내 해당errors블록에 추가됩니다. 참고:errorInfo는 쿼리 선택 세트를 기반으로 필터링되지 않습니다. -
$util.validate(Boolean, String) : void -
조건이 false이면 지정된 메시지와 함께 CustomTemplateException이 발생합니다.
-
$util.validate(Boolean, String, String) : void -
조건이 false이면 지정된 메시지 및 오류 유형과 함께 CustomTemplateException이 발생합니다.
-
$util.validate(Boolean, String, String, Object) : void -
조건이 false이면 지정된 메시지 및 오류 유형 그리고 응답에서 반환할 데이터와 함께 CustomTemplateException이 발생합니다.
-
$util.isNull(Object) : Boolean -
제공되는 객체가 null이면 true를 반환합니다.
-
$util.isNullOrEmpty(String) : Boolean -
제공되는 데이터가 null이거나 빈 문자열이면 true를 반환합니다. 그렇지 않을 경우 false를 반환합니다.
-
$util.isNullOrBlank(String) : Boolean -
제공되는 데이터가 null이거나 빈 문자열이면 true를 반환합니다. 그렇지 않을 경우 false를 반환합니다.
-
$util.defaultIfNull(Object, Object) : Object -
첫 번째 객체가 null이 아니면 첫 번째 객체를 반환합니다. 그렇지 않은 경우 두 번째 객체를 ‘기본 객체’로 반환합니다.
-
$util.defaultIfNullOrEmpty(String, String) : String -
첫 번째 문자열이 null이 아니거나 비어 있지 않으면 첫 번째 문자열을 반환합니다. 그렇지 않은 경우 두 번째 문자열을 ‘기본 문자열’로 반환합니다.
-
$util.defaultIfNullOrBlank(String, String) : String -
첫 번째 문자열이 null이 아니거나 공백이 아니면 첫 번째 문자열을 반환합니다. 그렇지 않은 경우 두 번째 문자열을 ‘기본 문자열’로 반환합니다.
-
$util.isString(Object) : Boolean -
객체가 문자열인 경우 true를 반환합니다.
-
$util.isNumber(Object) : Boolean -
객체가 숫자인 경우 true를 반환합니다.
-
$util.isBoolean(Object) : Boolean -
객체가 부울인 경우 true를 반환합니다.
-
$util.isList(Object) : Boolean -
객체가 목록인 경우 true를 반환합니다.
-
$util.isMap(Object) : Boolean -
객체가 맵인 경우 true를 반환합니다.
-
$util.typeOf(Object) : String -
객체 유형을 설명하는 문자열을 반환합니다. 지원되는 유형 식별은 ‘Null’, ‘숫자’, ‘문자열’, ‘맵’, ‘목록’, ‘부울’입니다. 유형을 식별할 수 없는 경우 반환 유형은 ‘객체’입니다.
-
$util.matches(String, String) : Boolean -
첫 번째 인수의 지정된 패턴이 두 번째 인수에서 제공되는 데이터와 일치하는 경우 true를 반환합니다. 패턴은
$util.matches("a*b", "aaaaab")등과 같은 정규식이어야 합니다. 이 기능은 Pattern을 기반으로 하며, 여기서 자세한 설명을 참조할 수 있습니다. -
$util.authType() : String -
요청에 사용되는 다중 인증 유형을 설명하는 문자열을 반환하고 'IAM 권한 부여', '사용자 풀 권한 부여', 'Open ID Connect 권한 부여' 또는 'API 키 인증'을 반환합니다.
$util.log.info(Object) : Void-
API에서 로그 수준
ALL로 요청 수준 및 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 기록합니다. $util.log.info(String, Object...) : Void-
API에서 로그 수준
ALL로 요청 수준 및 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 기록합니다. 이 유틸리티는 첫 번째 입력 형식 문자열에서 '{}'로 표시된 모든 변수를 제공된 객체의 문자열 표현으로 순서대로 바꿉니다. $util.log.error(Object) : Void-
API에서 로그 수준
ERROR또는 로그 수준ALL로 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 기록합니다. $util.log.error(String, Object...) : Void-
API에서 로그 수준
ERROR또는 로그 수준ALL로 필드 수준 CloudWatch 로깅이 활성화된 경우 제공된 객체의 문자열 표현을 요청된 로그 스트림에 기록합니다. 이 유틸리티는 첫 번째 입력 형식 문자열에서 '{}'로 표시된 모든 변수를 제공된 객체의 문자열 표현으로 순서대로 바꿉니다.
-
-
$util.escapeJavaScript(String) : String -
입력 문자열을 JavaScript 의 이스케이프된 문자열로 반환합니다.
해석기 권한 부여
-
$util.unauthorized() -
해석 중인 필드에 대해
Unauthorized를 발생시킵니다. 요청 또는 응답 매핑 템플릿에서 이를 사용하여 호출자가 필드를 확인하도록 허용할지 여부를 결정합니다.
