在 Step Functions 中探索服务集成模式

AWS Step Functions 直接与 Amazon 各州语言的服务集成。您可以使用三种服务集成模式来控制这些 AWS 服务：

调用服务，让 Step Functions 在收到HTTP响应后立即进入下一个状态。
调用服务，并让 Step Functions 等待作业完成。
使用任务令牌调用服务并让 Step Functions 等待，直到该令牌与有效负载一起返回。

这些服务集成模式中的每一种都由您在任务定义"Resource"字段URI中创建的方式来控制。

调用集成服务的方式

请求响应
运行作业 (.sync)
等待具有任务令牌的回调

有关为集成服务配置 AWS Identity and Access Management (IAM) 的信息，请参见Step Functions 如何为集成服务生成IAM策略。

请求响应

当您在任务状态"Resource"字符串中指定服务并且仅提供资源时，Step Functions 将等待HTTP响应，然后进入下一个状态。Step Functions 不会等待作业完成。

以下示例显示了如何发布 Amazon SNS 主题。


"Send message to SNS":{
            "Type":"Task",
            "Resource":"arn:aws:states:::sns:publish",
            "Parameters":{
            "TopicArn":"arn:aws:sns:us-east-1:123456789012:myTopic",
            "Message":"Hello from Step Functions!"
            },
            "Next":"NEXT_STATE"
            }

此示例引用了 Amazon API 的发布SNS。调用后，工作流程将进入下一个状态。Publish API

提示

要将使用请求响应服务集成模式的示例工作流部署到您的工作流程 AWS 账户，请参阅模块 2- AWS Step Functions 研讨会的请求响应。

运行作业 (.sync)

对于诸如 AWS Batch 和亚马逊之类的集成服务ECS，Step Functions 可以等待请求完成后再进入下一个状态。要让 Step Functions 等待，请在任务状态定义中指定在资源后面附加后.sync缀的"Resource"字段。URI

例如，提交 AWS Batch 作业时，使用状态机定义中的"Resource"字段，如本示例所示。


"Manage Batch task": {
            "Type": "Task",
            "Resource": "arn:aws:states:::batch:submitJob.sync",
            "Parameters": {
            "JobDefinition": "arn:aws:batch:us-east-2:123456789012:job-definition/testJobDefinition",
            "JobName": "testJob",
            "JobQueue": "arn:aws:batch:us-east-2:123456789012:job-queue/testQueue"
            },
            "Next": "NEXT_STATE"
            }

将该.sync部分附加到资源 Amazon 资源名称 (ARN) 中意味着 Step Functions 会等待任务完成。在调用 AWS Batch submitJob 后，工作流会暂停。作业完成后，Step Functions 将进入下一状态。欲了解更多信息，请参阅 AWS Batch 示例项目：使用AWS Batch和管理批处理作业 Amazon SNS。

如果使用此 (.sync) 服务集成模式的任务中止，并且 Step Functions 无法取消该任务，则集成服务可能会向您收取额外费用。在以下情况下，任务可能被中止：

状态机执行被停止。
并行状态的另一个分支因未捕获的错误而失败。
Map 状态的一次迭代失败并出现未捕获的错误。

Step Functions 将尽力尝试取消任务。例如，如果 Step Functions states:startExecution.sync 任务中止，它将调用 Step Functions StopExecution API 操作。但是，Step Functions 可能无法取消该任务。原因包括但不限于：

您的IAM执行角色无权进行相应API调用。
发生临时服务中断。

当您使用 .sync 服务集成模式时，Step Functions 会使用轮询来监控任务的状态，并且会消耗分配的配额和事件。对于同一账户内的.sync调用，Step Functions 使用 EventBridge 事件并轮询您在状态中Task指定的事件。APIs对于跨账户的 .sync 调用，Step Functions 仅使用轮询。例如，对于states:StartExecution.sync，Step Functions 对执行轮询DescribeExecutionAPI并使用您分配的配额。

提示

要将使用 Run a Job (.sync) 服务集成模式的示例工作流部署到您的 AWS 账户，请参阅研讨会的模块 3-运行作业 (.sync)。 AWS Step Functions

要查看等待作业完成的集成服务支持的列表 (.sync)，请参阅 Step Functions 的优化集成。

注意

使用.sync或.waitForTaskToken模式的服务集成需要额外的IAM权限。有关更多信息，请参阅 Step Functions 如何为集成服务生成IAM策略。

在某些情况下，您可能希望 Step Functions 在任务完全完成之前继续工作流。实现的方法与等待具有任务令牌的回调服务集成模式相同。为此，请将任务令牌传递给您的作业，然后使用SendTaskSuccess或SendTaskFailureAPI调用将其返回。Step Functions 会使用您在该调用中提供的数据来完成任务、停止监控作业并继续工作流。

等待具有任务令牌的回调

回调任务提供了一种暂停工作流程，直到返回任务令牌的方法。任务可能需要等待人员批准、与第三方集成或调用旧式系统。对于此类任务，您可以暂停 Step Functions，直到工作流执行达到一年的服务限额（参阅与状态限制相关的配额），然后等待外部流程或工作流完成。对于这些情况，Step Functions 允许您将任务令牌传递给 AWS SDK服务集成以及某些优化的服务集成。任务将会暂停，直到它通过 SendTaskSuccess 或 SendTaskFailure 调用接收到该任务令牌。

如果使用回调任务令牌的 Task 状态超时，则会生成一个新的随机令牌。您可以从上下文对象访问任务令牌。

注意

任务令牌必须包含至少 1 个字符，并且不能超过 1024 个字符。

要.waitForTaskToken与 AWS SDK集成一起使用，API您使用的必须具有用于放置任务令牌的参数字段。

注意

您必须从同一 AWS 账户中的委托人那里传递任务代币。如果您使用其他 AWS 账户的委托人发送代币，则代币将无法使用。

提示

要将使用回调任务令牌服务集成模式的示例工作流程部署到您 AWS 账户，请参阅模块 4-使用 AWS Step Functions 研讨会的任务令牌等待回调。

要查看支持等待任务令牌的集成服务的列表 (.waitForTaskToken)，请参阅 Step Functions 的优化集成。

任务令牌示例

在此示例中，Step Functions 工作流需要与外部微服务集成，才能在批准工作流中执行信用检查。Step Functions 发布了一SQS条亚马逊消息，其中包含任务令牌作为消息的一部分。外部系统与 Amazon 集成SQS，并从队列中提取消息。完成后，它将返回结果和原始任务令牌。然后 Step Functions 继续其工作流。

引用 Amazon 的任务定义"Resource"字段SQS包含.waitForTaskToken在末尾。


"Send message to SQS": {
                "Type": "Task",
                "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken",
                "Parameters": {
                "QueueUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/myQueue",
                "MessageBody": {
                "Message": "Hello from Step Functions!",
                "TaskToken.$": "$$.Task.Token"
                }
                },
                "Next": "NEXT_STATE"
                }

这会指示 Step Functions 暂停并等待任务令牌。使用 .waitForTaskToken 指定资源时，可以使用特殊路径名称 ($$.Task.Token) 在状态定义的 "Parameters" 字段中访问任务令牌。初始 $$. 指定访问上下文对象的路径，并在正在运行的执行中获取当前任务的任务令牌。

完成后，外部服务会调用 SendTaskSuccess 或 SendTaskFailure，其中包含 taskToken。只有这样，工作流程才会继续进入下一个状态。

注意

要避免在流程无法与 SendTaskSuccess 或 SendTaskFailure 一起发送任务令牌时无限期地等待，请参阅为等待任务配置检测信号超时。

从上下文对象获取令牌

上下文对象是一个内部JSON对象，其中包含有关您的执行的信息。与状态输入一样，可以在执行期间使用来自 "Parameters" 字段的路径访问它。从任务定义中访问时，它包含有关特定执行的信息（包括任务令牌）。


{
                "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"
                }
                }

您可以使用任务定义的 "Parameters" 字段内的特殊路径来访问任务令牌。要访问输入或上下文对象，首先通过将 .$ 附加到参数名称来指定参数将是路径。以下内容指定 "Parameters" 规范中输入和上下文对象的节点。


"Parameters": {
                "Input.$": "$",
                "TaskToken.$": "$$.Task.Token"
                },

在这两种情况下，将 .$ 添加到参数名称会告知 Step Functions 期望一个路径。在第一种情况下，"$" 是一个路径，其中包含整个输入。在第二种情况下，$$. 指定路径将访问上下文对象，$$.Task.Token 将参数设置为正在运行的执行的上下文对象中的任务令牌的值。

在亚马逊的SQS示例.waitForTaskToken中，该"Resource"字段告诉 Step Functions 等待任务令牌返回。"TaskToken.$": "$$.Task.Token"参数将该令牌作为 Amazon SQS 消息的一部分传递。


"Send message to SQS": {
                "Type": "Task",
                "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken",
                "Parameters": {
                "QueueUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/myQueue",
                "MessageBody": {
                "Message": "Hello from Step Functions!",
                "TaskToken.$": "$$.Task.Token"
                }
                },
                "Next": "NEXT_STATE"
                }

有关上下文对象的更多信息，请参阅本指南中处理输入和输出部分中的 Context 对象。

为等待任务配置检测信号超时

等待任务令牌的任务将等到执行达到一年服务配额（请参阅与状态限制相关的配额）。要避免执行卡顿，您可以在状态机定义中配置检测信号超时间隔。使用 HeartbeatSeconds 字段指定超时间隔。


{
                "StartAt": "Push to SQS",
                "States": {
                "Push to SQS": {
                "Type": "Task",
                "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken",
                "HeartbeatSeconds": 600,
                "Parameters": {
                "MessageBody": { "myTaskToken.$": "$$.Task.Token" },
                "QueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/push-based-queue"
                },
                "ResultPath": "$.SQS",
                "End": true
                }
                }
                }

在此状态机定义中，任务将消息推送到 Amazon，SQS并等待外部进程使用提供的任务令牌进行回调。"HeartbeatSeconds": 600 字段将检测信号超时间隔为 10 分钟。任务将等待任务令牌通过以下API操作之一返回：

如果等待任务在该 10 分钟内未收到有效的任务令牌，则任务失败并显示 States.Timeout 错误名称。

有关更多信息，请参阅回调任务示例项目：使用亚马逊SQS、亚马逊SNS和 Lambda 创建回调模式示例。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

与其他服务集成

AWS SDK集成