通过API网关调用同步快速工作流程 - AWS Step Functions
第 1 步：创建状态机第 2 步：运行状态机示例状态机代码IAM示例

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

通过API网关调用同步快速工作流程

此示例项目演示如何通过 Amazon API Gateway 调用同步快速工作流程来管理员工数据库。

在这个项目中，Step Functions 使用API网关端点启动 Step Functions 同步快速工作流程。然后，它们使用 DynamoDB 在员工数据库中搜索、添加和删除员工。

有关 Step Functions 同步快速工作流程的更多信息，请参阅Step Functions 中的同步和异步快速工作流程。

注意

此示例项目可能会产生费用。

对于新品 AWS 用户，可免费使用套餐。在此套餐中，低于某种使用水平的服务是免费的。有关 AWS 费用和免费套餐，请参阅 Step Functions 定价。

第 1 步：创建状态机

  1. 打开 Step Functions 控制台，然后选择创建状态机。

  2. 在搜索框Invoke Synchronous Express Workflows through API Gateway中键入，然后选择通过以下方式调用同步 Express 工作流程 API Gateway来自返回的搜索结果。

  3. 选择下一步以继续。

  4. 选择 “运行演示” 以创建只读和 ready-to-deploy 工作流程，或者选择 “在其上构建” 以创建可编辑的状态机定义，您可以在此基础上构建并稍后部署。

    该示例项目部署了以下资源：

    • 网络 ACL 和安全组都允许 (因此可到达您的实例) 的发起 ping 的 Amazon API Gateway HTTPSAPI这是由状态机调用的。

    • 网络 ACL 和安全组都允许 (因此可到达您的实例) 的发起 ping 的 Amazon DynamoDB 桌子。

    • 三 AWS Step Functions 状态机。

    • 相关 AWS Identity and Access Management (IAM) 角色。

    下图显示了通过 “调用同步 Express 工作流程” 的工作流程图 API Gateway示例项目：

    通过调用同步 Express 工作流的工作流程图 API Gateway示例项目。

  5. 选择使用模板继续进行选择。

后续步骤取决于您之前的选择：

  1. 运行演示 — 您可以先查看状态机，然后再使用部署的资源创建只读项目 AWS CloudFormation 给你的 AWS 账户.

    您可以查看状态机定义，准备就绪后，选择部署并运行以部署项目并创建资源。

    部署最多可能需要 10 分钟才能创建资源和权限。您可以使用堆栈 ID 链接来监控进度 AWS CloudFormation.

    部署完成后，您应该会在控制台中看到您的新状态机。

  2. 在此基础上再接再厉 — 您可以查看和编辑工作流程定义。在尝试运行自定义工作流程之前，您可能需要为示例项目中的占位符设置值。

注意

部署到您的账户的服务可能会收取标准费用。

第 2 步：运行状态机

  1. 在状态机页面上，选择您的示例项目。

  2. 在示例项目页面上，选择启动执行。

  3. 在启动执行对话框中，执行以下操作：

    1. （可选）输入自定义执行名称以覆盖生成的默认执行名称。

      非ASCII姓名和日志

      Step Functions 接受状态机、执行、活动和包含非ASCII字符的标签的名称。由于此类字符不适用于亚马逊 CloudWatch，因此我们建议您仅使用ASCII字符，以便您可以跟踪中的指标 CloudWatch。

    2. （可选）在输入框中，将输入值输入为JSON。如果您正在运行演示，则可以跳过此步骤。

    3. 选择启动执行。

    Step Functions 控制台将引导您进入执行详情页面，您可以在图表视图中选择状态以浏览步骤详细信息窗格中的相关信息。

示例状态机代码

此示例项目中的状态机使用API网关调用 “同步 Express 工作流”，然后API使用 DynamoDB 更新员工数据库或从员工数据库读取数据，从而与 Gateway 和 DynamoDB 集成。

浏览此示例状态机，了解 Step Functions 如何从 DynamoDB 读取数据，检索员工信息。

要了解有关如何使用 API Gateway 调用 Step Functions 的更多信息，请参阅以下内容。

有关如何做的更多信息 AWS Step Functions 可以控制其他 AWS 服务，请参阅将服务与 Step Functions 集成。

{
  "Comment": "This state machine returns an employee entry from DynamoDB",
  "StartAt": "Read From DynamoDB",
  "States": {
    "Read From DynamoDB": {
      "Type": "Task",
      "Resource": "arn:aws:states:::dynamodb:getItem",
      "Parameters": {
        "TableName": "StepFunctionsSample-SynchronousExpressWorkflowAKIAIOSFODNN7EXAMPLE-DynamoDBTable-ANPAJ2UCCR6DPCEXAMPLE",
        "Key": {
          "EmployeeId": {"S.$": "$.employee"}
        }
      },
      "Retry": [
        {
          "ErrorEquals": [
            "DynamoDB.AmazonDynamoDBException"
          ],
          "IntervalSeconds": 3,
          "MaxAttempts": 2,
          "BackoffRate": 1.5
        }
      ],
      "Next": "Is Get Successful"
    },
    "Is Get Successful": {
      "Type": "Choice",
      "Choices": [
        {
          "Variable": "$.Item",
          "IsPresent": true,
          "Next": "Succeed Execution"
        }
      ],
      "Default": "Fail Execution"
    },
    "Succeed Execution": {
      "Type": "Pass",
      "Parameters" : {
        "employee.$": "$.Item.EmployeeId.S",
        "jobTitle.$": "$.Item.JobTitle.S"
      },
      "End": true
    },
    "Fail Execution": {
      "Type": "Fail",
      "Error": "EmployeeDoesNotExist"
    }
  }
}

有关在将 Step Functions 与其他功能一起使用IAM时如何进行配置的信息 AWS 服务，请参阅Step Functions 如何为集成服务生成IAM策略。

IAM示例

这些例子 AWS Identity and Access Management (IAM) 示例项目生成的策略包括执行状态机和相关资源所需的最低权限。我们建议您在IAM策略中仅包含必要的权限。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogDelivery",
                "logs:GetLogDelivery",
                "logs:UpdateLogDelivery",
                "logs:DeleteLogDelivery",
                "logs:ListLogDeliveries",
                "logs:PutResourcePolicy",
                "logs:DescribeResourcePolicies",
                "logs:DescribeLogGroups"
            ],
            "Resource": "*"
        }
    ]
}
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "dynamodb:GetItem",
                "dynamodb:PutItem",
                "dynamodb:UpdateItem",
                "dynamodb:DeleteItem"
            ],
            "Resource": [
                "arn:aws:dynamodb:us-east-1:111122223333:table/Write"
            ]
        }
    ]
}

有关在将 Step Functions 与其他功能一起使用IAM时如何进行配置的信息 AWS 服务，请参阅Step Functions 如何为集成服务生成IAM策略。