AWS Step Functions
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

上下文对象

上下文对象是在执行期间可用的内部 JSON 结构。它包括有关您可以在状态定义的 "Parameters" 字段中访问的状态机和执行的信息。这允许您的工作流程访问有关其特定执行的信息。

上下文对象格式

上下文对象包括有关状态机、状态、执行和任务的信息。此 JSON 对象包括每种类型数据的节点,并采用以下格式。

{ "Execution": { "Id": "String", "Input": {}, "StartTime": "Format: ISO 8601" }, "State": { "EnteredTime": "Format: ISO 8601", "Name": "String", "RetryCount": Number }, "StateMachine": { "Id": "String" }, "Task": { "Token": "String" } }

在执行期间,上下文对象将以访问它的 "Parameters" 字段的相关数据填充。如果 "Parameters" 字段超出任务状态,则 "Task" 字段的值为空。

来自正在运行的执行的内容包括以下格式的具体信息。

{ "Execution": { "Id": "arn:aws:states:us-east-1:123456789012:execution:stateMachineName:executionName", "Input": { "key": "value" }, "Name": "executionName", "RoleArn": "arn:aws:iam::123456789012:role...", "StartTime": "2019-03-26T20:14:13.192Z" }, "State": { "EnteredTime": "2019-03-26T20:14:13.192Z", "Name": "Test", "RetryCount": 3 }, "StateMachine": { "Id": "arn:aws:states:us-east-1:123456789012:stateMachine:stateMachineName", "Name": "name" }, "Task": { "Token": "h7XRiCdLtd/83p1E0dMccoxlzFhglsdkzpK9mBVKZsp7d9yrT1W" } }

注意

有关与 Map 状态相关的上下文对象数据,请参阅映射状态的上下文对象数据

访问上下文对象

要访问上下文对象,首先通过将 .$ 附加到末尾来指定参数名称,就像选择带路径的状态输入时一样。然后,要访问上下文对象数据(而不是输入),请在路径前加上 $$.。这会告诉 Step Functions 使用路径选择上下文对象中的节点。

此示例任务状态使用路径进行检索并将执行 ARN 传递给 Amazon SQS 消息。

{ "Order Flight Ticket Queue": { "Type": "Task", "Resource": "arn:aws:states:::sqs:sendMessage", "Parameters": { "QueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/flight-purchase", "MessageBody": { "From": "YVR", "To": "SEA", "Execution.$": "$$.Execution.Id" } }, "Next": "NEXT_STATE" } }

注意

有关在调用集成服务时使用任务令牌的更多信息,请参阅 等待具有任务令牌的回调

映射状态的上下文对象数据

处理 Map 状态时,上下文对象中还有两个附加项:IndexValueIndex 包含当前迭代中正在处理的数组项的索引号。在 Map 状态内,上下文对象包括以下内容。

"Map": { "Item": { "Index": "Number", "Value": "String" } }

这些仅在 Map 状态下可用,并且可以在 "Iterator" 部分之前的 "Parameters" 字段中指定。

注意

您必须在主要 Map 状态的 "Parameters" 块中的上下文对象中定义参数,而不是在 "Iterator" 部分中包含的状态中定义参数。

给定具有简单 Map 状态的状态机,我们可以按如下方式从上下文对象中注入信息。

{ "StartAt": "ExampleMapState", "States": { "ExampleMapState": { "Type": "Map", "Parameters": { "ContextIndex.$": "$$.Map.Item.Index", "ContextValue.$": "$$.Map.Item.Value" }, "Iterator": { "StartAt": "TestPass", "States": { "TestPass": { "Type": "Pass", "End": true } } }, "End": true } } }

如果使用以下输入执行前一状态机,则将 IndexValue 插入到输出中。

[ { "who": "bob" }, { "who": "meg" }, { "who": "joe" } ]

执行的输出如下所示。

[ { "ContextValue": { "who": "bob" }, "ContextIndex": 0 }, { "ContextValue": { "who": "meg" }, "ContextIndex": 1 }, { "ContextValue": { "who": "joe" }, "ContextIndex": 2 } ]