本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
Task
Task
状态 ("Type": "Task"
) 代表状态机执行的一个工作单元。任务通过以下方式来执行工作:使用活动或 Amazon Lambda 函数、与其他受支持的 Amazon Web Services集成,或通过调用 Stripe 等第三方 API。
Amazon States Language 通过将状态类型设置为 Task
并且向任务提供活动、Lambda 函数或第三方 API 端点的 Amazon 资源名称 (ARN) 来呈现任务。以下 Task 状态定义调用名为
的 Lambda 函数。HelloFunction
"Lambda Invoke": {
"Type": "Task",
"Resource": "arn:aws:states:::lambda:invoke",
"Parameters": {
"Payload.$": "$",
"FunctionName": "arn:aws:lambda:us-east-2
:123456789012
:function:HelloFunction
:$LATEST"
},
"End": true
}
任务类型
Step Functions 支持以下任务类型,您可以在 Task 状态定义中指定这些类型:
您可以通过在 Task 状态定义的 Resource
字段中提供其 ARN 来指定任务类型。以下示例显示了 Resource
字段的语法。除调用第三方 API 的任务类型外,所有任务类型均使用以下语法。有关 HTTP 任务语法的信息,请参阅调用第三方 API。
在 Task 状态定义中,用特定于 Amazon 资源的信息替换以下语法中的斜体文本。
arn:partition
:service
:region
:account
:task_type
:name
下面的列表解释了此语法中的各个组件:
-
partition
是要使用的 Amazon Step Functions 分区,最常用的是aws
。 -
service
表示用于执行任务的 Amazon Web Service,可以是以下值之一: -
region
是创建 Step Functions 活动或状态机类型、Lambda 函数或任何其他 Amazon 资源的 Amazon 区域代码。 -
account
是您定义资源时使用的 Amazon Web Services 账户 ID。 -
task_type
是要运行的任务的类型。它可能为下列值之一:-
activity
– 一个活动。 -
function
– 一个 Lambda 函数。 -
– 支持的连接服务的名称(请参阅 Step Functions 的优化集成)。servicename
-
-
name
是已注册的资源名称(活动名称、Lambda 函数名称或服务 API 操作)。
注意
Step Functions 不支持跨分区或区域引用 ARN。例如,aws-cn
无法调用 aws
分区中的任务,反之亦然。
以下各部分提供有关每种类型的更多详细信息。
活动
活动表示由您实现和托管的、用于执行某个特定任务的工作线程 (进程或线程)。它们只受标准工作流支持,而不受快速工作流支持。
活动 Resource
ARN 使用下面的语法。
arn:partition
:states:region
:account
:activity:name
注意
在第一次使用活动之前,必须先使用 Step Functions 创建活动(使用 CreateActivity、API 操作或 Step Functions 控制台
有关创建活动和实现工作线程的更多信息,请参阅活动。
Lambda 函数
Lambda 任务使用 Amazon Lambda 执行函数。要指定 Lambda 函数,请在 Resource
字段中使用 Lambda 函数的 ARN。
根据您用于指定 Lambda 函数的集成类型(优化集成或 Amazon 软件开发工具包集成),Lambda 函数 Resource
字段的语法会有所不同。
以下 Resource
字段语法是 Lambda 函数的优化集成的示例。
"arn:aws:states:::lambda:invoke"
以下 Resource
字段语法 Lambda 函数的 Amazon 软件开发工具包的示例。
"arn:aws:states:::aws-sdk:lambda:invoke"
以下 Task
状态定义显示了名为
的 Lambda 函数的优化集成的示例。HelloWorld
"LambdaState": {
"Type": "Task",
"Resource": "arn:aws:states:::lambda:invoke",
"OutputPath": "$.Payload",
"Parameters": {
"Payload.$": "$",
"FunctionName": "arn:aws:lambda:us-east-1:function:HelloWorld:$LATEST
"
},
"Next": "NextState"
}
在 Resource
字段中指定的 Lambda 函数完成后,其输出将会发送到在 Next
字段中标识的状态(“NextState”)。
支持的 Amazon Web Service
当您引用连接的资源时,Step Functions 直接调用受支持服务的 API 操作。在 Resource
字段中指定服务和操作。
所连接服务 Resource
ARN 使用下面的语法。
arn:partition
:states:region
:account
:servicename
:APIname
注意
要创建与所连接资源的同步连接,请将 .sync
追加到 ARN 中的 APIname
条目。有关更多信息,请参阅使用其他服务。
例如:
{
"StartAt": "BATCH_JOB",
"States": {
"BATCH_JOB": {
"Type": "Task",
"Resource": "arn:aws:states:::batch:submitJob.sync",
"Parameters": {
"JobDefinition": "preprocessing",
"JobName": "PreprocessingBatchJob",
"JobQueue": "SecondaryQueue",
"Parameters.$": "$.batchjob.parameters",
"RetryStrategy": {
"attempts": 5
}
},
"End": true
}
}
}
Task 状态字段
除了常见状态字段之外,Task
状态还具有以下字段。
-
Resource
(必填) -
一个 URI,尤其是唯一标识要执行的特定任务的 ARN。
-
Parameters
(可选) -
用于将信息传递给所连接资源的 API 操作。参数可以混合使用静态 JSON 和 JsonPath
。有关更多信息,请参阅将参数传递给服务 API。 Credentials
(可选)-
指定状态机的执行角色在调用指定
Resource
前必须承担的目标角色。或者,您也可以指定 JSONPath 值或内置函数,在运行时根据执行输入解析为 IAM 角色 ARN。如果指定 JSONPath 值,则必须在其前缀加上$.
表示法。有关在
Task
状态内使用此字段的示例,请参阅 。有关使用此字段从状态机访问跨账户 Amazon 资源的示例,请参阅教程:访问跨账户资源 Amazon。注意
使用 Lambda 函数的和支持的 Amazon服务支持此字段。
-
ResultPath
(可选) -
指定(输入中)用于放置
Resource
中所指定任务的执行结果的位置。接下来,输入将按照OutputPath
字段(如果存在)指定的内容进行筛选,然后再用作状态输出。有关更多信息,请参阅输入和输出处理。 -
ResultSelector
(可选) -
传递键值对集合,其中,值为静态值或从结果中选择的值。有关更多信息,请参阅ResultSelector。
-
Retry
(可选) -
一个称为重试器的对象的数组,定义在状态遇到运行时错误时的重试策略。有关更多信息,请参阅使用 Retry 和使用 Catch 的状态机示例。
-
Catch
(可选) -
一个称为捕获器的对象数组,用于定义回退状态。如果状态遇到运行时错误并且其重试策略已耗尽或者未定义,则执行该状态。有关更多信息,请参阅回退状态。
-
TimeoutSeconds
(可选) -
指定活动或任务在因 States.Timeout 错误而超时并失败之前可以运行的最长时间。超时值必须是非零的正整数。默认值为
99999999
。超时计数从任务启动后开始,例如,从
ActivityStarted
或LambdaFunctionStarted
事件记录到执行事件历史记录时开始。对于活动,当GetActivityTask
收到令牌并且ActivityStarted
记录在执行事件历史记录中时开始计数。Step Functions 会在指定的
TimeoutSeconds
时长内等待任务或活动工作线程的成功或失败响应。如果任务或活动工作线程未能在这段时间内做出响应,Step Functions 会将工作流执行标记为失败。 -
TimeoutSecondsPath
(可选) -
如果要使用参考路径从状态输入中动态提供超时值,请使用
TimeoutSecondsPath
。解析后,参考路径必须选择值为正整数的字段。注意
一个
Task
状态不能同时包含TimeoutSeconds
和TimeoutSecondsPath
。 -
HeartbeatSeconds
(可选) -
确定活动工作线程在任务执行期间发送的检测信号的频率。检测信号表示任务仍在运行,需要更多时间才能完成。检测信号可防止活动或任务在
TimeoutSeconds
持续时间内超时。HeartbeatSeconds
必须是小于TimeoutSeconds
字段值的正非零整数值。默认值为99999999
。如果任务检测信号之间的时间超过了指定秒数,则 Task 状态将失败,并返回 States.Timeout 错误。对于活动,当
GetActivityTask
收到令牌并且ActivityStarted
记录在执行事件历史记录中时开始计数。 -
HeartbeatSecondsPath
(可选) -
如果要使用参考路径从状态输入中动态提供检测信号值,请使用
HeartbeatSecondsPath
。解析后,参考路径必须选择值为正整数的字段。注意
一个
Task
状态不能同时包含HeartbeatSeconds
和HeartbeatSecondsPath
。
Task
状态必须将 End
字段设置为 true
(如果状态结束执行),或者必须在 Next
字段中提供一个状态(该状态将在 Task
状态完成时运行)。
Task 状态定义示例
以下示例说明如何根据要求指定 Task 状态定义。
Task 状态超时和检测信号间隔
为长时间运行的活动设置超时值和检测信号间隔是一个好的做法。这可以通过指定超时和检测信号值或通过动态设置来完成。
静态超时和检测信号通知示例
当 HelloWorld
完成后,将运行下一个状态(此处名为 NextState
)。
如果此任务在 300 秒内未能完成,或者未在 60 秒的间隔内发送检测信号通知,则任务会被标记为 failed
。
"ActivityState": {
"Type": "Task",
"Resource": "arn:aws:states:us-east-1:123456789012:activity:HelloWorld",
"TimeoutSeconds": 300,
"HeartbeatSeconds": 60,
"Next": "NextState"
}
动态任务超时和检测信号通知示例
在此示例中,当 Amazon Glue 作业完成时,下一个状态将运行。
如果此任务未能在 Amazon Glue 作业动态设置的时间间隔内完成,则该任务将被标记为 failed
。
"GlueJobTask": {
"Type": "Task",
"Resource": "arn:aws:states:::glue:startJobRun.sync",
"Parameters": {
"JobName": "myGlueJob"
},
"TimeoutSecondsPath": "$.params.maxTime",
"Next": "NextState"
}