使用 AWS Step Functions - AWS Toolkit for VS Code
查看 Step Functions 状态机创建 Step Functions 状态机使用模板创建 Step Functions 状态机下载 Step Functions 状态机将更改保存到 Step Functions 状态机运行 Step Functions 状态机使用代码段代码验证

使用 AWS Step Functions

以下各部分介绍了如何在 AWS Toolkit 中使用包含状态机定义的 AWS Step Functions Amazon State Language (ASL) 文件。有关 AWS Step Functions 状态机的详细信息，请参阅《AWS Step Functions 开发人员指南》中的了解 Step Functions 中的状态机主题。

查看 Step Functions 状态机

要在 AWS Toolkit 各区服务浏览器中查看包含状态机定义的现有 ASL 文件，请完成以下步骤。

  1. 在 AWS Toolkit 各区服务浏览器中，展开包含要查看的 ASL 文件的区域。

  2. 展开 Step Function s 标题。

  3. 您的 ASL 文件将显示在 AWS 各区服务浏览器中。

创建 Step Functions 状态机

在 AWS Toolkit 中，您可以使用文件创建新的 Step Functions 状态机，也可以使用模板进行创建。以下步骤介绍了如何使用文件创建 Step Functions 状态机。有关使用模板创建 SFN 状态机的详细信息，请参阅本用户指南主题中下方的状态机模板部分。

注意

要在 VS Code 中使用 Step Functions，包含状态机定义的 Amazon State Language（ASL）文件的扩展名必须以 asl.json、asl.yml 或 .asl.yaml 结尾。

默认情况下，相关的 Step Functions 文件会在 Workflow Studio 中打开。有关通过 AWS Toolkit 使用 Workflow Studio 的详细信息，请参阅本用户指南中的使用 Workflow Studio 主题。

  1. 在 VS Code 的工作区中，创建新文件。

  2. 为文件命名并将文件扩展名指定为 asl.json、asl.yml 或 .asl.yaml。

  3. 创建新文件后，AWS Toolkit 会在 AWS Step Functions Workflow Studio 中打开该文件。

  4. 在 Workflow Studio 的实用工具菜单中，选择保存按钮，保存您的新 ASL 文件。

使用模板创建 Step Functions 状态机

在 AWS Toolkit 中，您可以使用模板创建 Step Functions 状态机。模板过程会创建一个包含状态机定义的 ASL 文件，从而为您的项目提供一个起点。以下步骤介绍了如何在 AWS Toolkit 中使用模板创建 Step Functions 状态机。

  1. 在 AWS Toolkit 各区服务浏览器中，展开要在其中创建 Step Functions 状态机的区域。

  2. 打开（右键单击）Step Functions 的上下文菜单，然后选择创建新的 Step Functions 状态机以在 VS Code 中打开选择初学者模板（1/2）向导。

  3. 从选择初学者模板（1/2）向导中，选择 Step Functions 状态机的模板类型以继续。

  4. 在选择模板格式（2/2）屏幕中，为您的模板格式选择 YAML 或 JSON。

  5. 系统将在 VS Code 编辑器中打开一个包含状态机定义的新 ASL 文件。

下载 Step Functions 状态机

要将远程存储的 Step Functions 状态机下载到本地的 VS Code 实例，请完成以下步骤。

  1. 在 AWS Toolkit 各区服务浏览器中，展开包含要下载的 Step Functions 状态机的区域。

  2. 展开 Step Functions，然后右键单击要下载的 Step Functions 状态机并选择下载定义...。

  3. 指定存储 Step Functions 状态机的本地位置以继续。

  4. 步骤完成后，Step Functions 状态机将在 Workflow Studio 中打开。

将更改保存到 Step Functions 状态机

以下步骤介绍了如何保存对 Step Functions 状态机的更改。

注意

在 Workflow Studio 中进行的编辑会同步到您的本地文件，但工作保存到 VS Code 编辑器或 Workflow Studio 中之前，编辑内容将保持未保存状态。如果在打开 Workflow Studio 时修改并保存了本地文件，并且在 ASL 文件中未检测到任何错误，则保存完成后，您将在 Workflow Studio 中收到成功通知。但是，如果您的本地文件包含无效 JSON 或 YAML 并且您尝试了保存，则您的本地文件将无法同步，并且您会在 Workflow Studio 中收到警告通知。

  1. 从 Workflow Studio 中打开的包含状态机定义 ASL 的文件，导航到实用工具按钮。

  2. 选择保存按钮。

  3. 文件保存后，VS Code 会通知您。

运行 Step Functions 状态机

以下步骤介绍了如何在 AWS Toolkit 中运行 Step Functions 状态机。

  1. 在 AWS Toolkit 各区服务浏览器中，展开包含要运行的 Step Functions 状态机的区域。

  2. 展开 Step Functions，然后右键单击要运行的 Step Functions 状态机。

  3. 从上下文菜单中，选择启动执行以启动该启动流程。

  4. 启动状态显示在 VS Code 的 AWS Toolkit 输出窗口中。

使用代码段

代码段是根据您正在处理的代码生成的自动建议。要在 Toolkit 中将代码段与 Step Functions 结合使用，请完成以下步骤。

注意

要在 VS Code 中使用 Step Functions 代码段，包含状态机定义的 ASL 文件的扩展名必须以 .asl.json、.asl.yml 或 .asl.yaml 结尾。

默认情况下，您的相关 Step Functions 文件会在 Workflow Studio 中打开。

  1. 在 VS Code 中，打开包含要修改的状态机定义的 ASL 文件或创建一个新 ASL 文件。

  2. 在 Workflow Studio 中，如果您处于设计模式，请切换为代码模式。

  3. 在 Workflow Studio 代码编辑器中，将光标放在 "States" 属性中。

  4. 按下 control + space，打开代码段菜单，按下 control + space 即可访问其他属性，这些属性基于 "State" "Type"。

  5. 从列表中选择所需的代码段。

代码验证

当您在 Workflow Studio 中处理 Step Functions 时，代码验证会主动识别错误并针对以下错误提出建议：

  • 缺少属性

  • 值不正确

  • 无最终状态

  • 指向不存在的状态