Built-in Functions

Actions have functions that are provided from the start. This is called a built-in function. Built-in functions correspond to methods of the object $fn and can be called in the form $fn.XXX.

Note

Some built-in functions are asynchronous functions. When calling an asynchronous function, it is necessary to use an await expression to wait until the result is returned. When an error occurs, the catch clause receives the error object returned by the Amazon SDK.

Types of Built-in Functions

Some built-in functions are available in UI Scripts, while others are available in Actions. The following table shows the supported combinations.

Built-in Function	UI Script	Action
$fn.addUsers(param)	-	○
$fn.callAction()	○	○
$fn.callGenerativeAI(param)	-	○
$fn.changePassword(param)	-	○
$fn.closeDialog()	○	○
$fn.copyFile(src, dest)	-	○
$fn.createFolder(path)	-	○
$fn.createGroup(param)	-	○
$fn.createUser(param)	-	○
$fn.csvToObject(csv)	-	○
$fn.deleteFile(path)	-	○
$fn.deleteFolder(path)	-	○
$fn.deleteUser(email)	-	○
$fn.download(file, filename)	-	○
$fn.getCookieContent()	-	○
$fn.getCurrentPosition()	-	○
$fn.getCurrentUser()	-	○
$fn.getFile(path)	-	○
$fn.getFileNames(path)	-	○
$fn.getGroups(option)	-	○
$fn.getLanguage()	-	○
$fn.getPresignedUrl(path,options)	-	○
$fn.getUploadFiles()	-	○
$fn.getUsers(groupName?,option)	-	○
$fn.link(url)	-	○
$fn.listUsersByEmail(email,option)	-	○
$fn.listUsersByName(name,option)	-	○
$fn.message(parameters)	○	○
$fn.moveFile(src, dest)	-	○
$fn.nextUI(uiCode)	-	○
$fn.openDialog(UiCode)	○	○
$fn.putFile(path, parameters)	-	○
$fn.removeUsers(param)	-	○
$fn.resetPassword(param)	-	○
$fn.sendMail(param)	-	○
$fn.setCookieContent()	-	○
$fn.setFocus(param)	-	○
$fn.setLanguage(language)	-	○
$fn.signOut()	-	○
$fn.updateUser(param)	-	○