如何在AWS AppSync的VTL中从DynamoDB列表移除元素？

你的VTL代码存在几个关键问题，导致无法正确移除DynamoDB列表中的指定元素，以下是具体问题和修正后的代码：

核心问题点 #

• 主键硬编码：原代码中pk和sk写死为固定值，无法根据传入的参数动态定位到目标用户条目。
• 工具函数参数错误：$util.list.copyAndRemoveAll的第一个参数需要传入实际的列表对象，而非属性名字符串"#user_incoming_friend_requests"。
• DynamoDB类型不匹配：工具函数返回的普通JSON列表未转换为DynamoDB要求的{"L": [...]}格式。
• JSON语法错误：expressionValues中:newList后缺少逗号，导致JSON解析失败。
• 版本递增方式不规范：使用ADD递增版本号虽可行，但SET version = version + :plusOne更符合常规用法。

修正后的VTL代码 #

{
    "version" : "2018-05-29",
    "operation" : "UpdateItem",
    "key" : {
        "pk" : { "S" : "${context.arguments.pk}" },
        "sk" : { "S" : "${context.arguments.sk}" }
    },
    "update": {
        "expression" : "SET #user_incoming_friend_requests = :newList, version = version + :plusOne",
        "expressionNames": {
            "#user_incoming_friend_requests" : "user_incoming_friend_requests"
        },
        "expressionValues" : {
          ":newList": $util.dynamodb.toList($util.list.copyAndRemoveAll($ctx.source.user_incoming_friend_requests, [$ctx.arguments.friend])),
          ":plusOne" : {"N": "1"}
        }
    }
}

关键说明 #

1. 动态主键：通过${context.arguments.pk}和${context.arguments.sk}获取传入的主键参数，确保操作目标用户正确。
2. 工具函数正确调用：
   • $ctx.source.user_incoming_friend_requests获取当前条目下的好友请求列表（需确保AppSync能访问到更新前的条目数据）。
   • $util.list.copyAndRemoveAll(原列表, [要移除的元素])生成移除指定元素后的新列表。
   • $util.dynamodb.toList()将普通列表转换为DynamoDB兼容的列表格式。
3. 语法与表达式修正：
   • 修复expressionValues中的逗号缺失问题。
   • 将版本递增改为SET表达式，逻辑更清晰。

注意事项 #

如果$ctx.source.user_incoming_friend_requests无法获取到当前列表（比如首次操作时列表不存在），可以添加空值判断：

:newList: $util.dynamodb.toList($util.list.copyAndRemoveAll($util.defaultIfNull($ctx.source.user_incoming_friend_requests, []), [$ctx.arguments.friend]))

这样即使原列表为空，也能正常生成新列表。

内容的提问来源于stack exchange，提问作者Alex Tsang