Step Function调用API Gateway时，如何从输入路径构建查询参数？

问题描述 #

我在构建调用API Gateway代理的Step Function时，无法将输入值传递到查询参数中。尝试使用"$.zzId"作为查询参数值，但它没有被替换为输入的实际值。直接在Parameters里添加"zzId" : "$.zzId"能正确解析值，但因为这个属性不属于APIGateway调用的合法参数，导致Step Function执行失败，不过这能确认路径表达式本身是正确的。

错误代码示例 #

"Branches": [
  {
    "StartAt": "Get Content",
    "States": {
      "Get Content": {
        "Type": "Task",
        "Resource": "arn:aws:states:::apigateway:invoke",
        "Parameters": {
          "ApiEndpoint": "zcxzscaw.execute-api.us-east-1.amazonaws.com",
          "Method": "GET",
          "Headers": {},
          "Path": "/bmx/content",
          "zzId" : "$.zzId" // 此写法能解析值，但属性无效导致执行失败
          "QueryParameters": {
            "zzId": [
              "$.zzId" // 此写法未生效
            ]
          },
          "RequestBody": {},
          "AuthType": "NO_AUTH"
        },
        "TimeoutSeconds": 3,
        "End": true
      }
    }
  }
]

解决方案 #

1. 先修正JSON语法错误
   代码中"zzId" : "$.zzId"这一行末尾缺少逗号，导致JSON格式无效，会直接引发Step Function定义错误，先补充逗号：

   "zzId" : "$.zzId", // 补充逗号
   

2. 查询参数的正确写法
   在APIGateway调用任务的QueryParameters中，每个参数对应一个字符串数组，要传递动态输入值，直接在数组中使用路径引用即可，Step Functions会自动解析这个路径并替换为输入值。同时要确保输入数据中确实存在zzId字段。

   修正后的完整参数配置：

   "Parameters": {
     "ApiEndpoint": "zcxzscaw.execute-api.us-east-1.amazonaws.com",
     "Method": "GET",
     "Headers": {},
     "Path": "/bmx/content",
     "QueryParameters": {
       "zzId": [
         "$.zzId"
       ]
     },
     "RequestBody": {},
     "AuthType": "NO_AUTH"
   }
   

   如果上述写法仍不生效，可以使用States.Format函数显式解析值，确保动态引用被正确处理：

   "QueryParameters": {
     "zzId": [
       {
         "States.Format": "{}",
         "Parameters": {
           "input.$": "$.zzId"
         }
       }
     ]
   }
   

关键说明 #

• 路径引用$.zzId指向Step Function输入的根节点下的zzId字段，如果你的输入结构不同，需要调整路径（比如输入是{"data": {"zzId": "123"}}，则路径应为"$.data.zzId"）。
• 不要在Parameters中添加zzId这类非法属性，APIGateway调用任务只接受官方定义的参数字段（如ApiEndpoint、Method、QueryParameters等）。

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