翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
API Gateway 経由で同期 Express ワークフローを呼び出す
このサンプルプロジェクトでは、Amazon API Gateway を使用して同期 Express ワークフローを呼び出し、従業員データベースを管理する方法を示します。
このプロジェクトでは、Step Functions はAPIゲートウェイエンドポイントを使用して Step Functions 同期 Express ワークフローを開始します。次に、DynamoDB を使用して、従業員データベース内の従業員を検索、追加、および削除します。
Step Functions の同期 Express ワークフローの詳細については、Step Functions での同期および非同期 Express ワークフロー を参照してください。
注記
このサンプルプロジェクトでは、料金が発生する場合があります。
新規 AWS ユーザーは、無料利用枠を利用できます。この枠では、サービスを利用しても一定のレベル以下であれば無料です。 AWS コストと無料利用枠の詳細については、「Step Functions の料金
ステップ 1: ステートマシンを作成してリソースをプロビジョニングする
-
Step Functions コンソール
を開き、[ステートマシンの作成] を選択します。 -
検索ボックスに
Invoke Synchronous Express Workflows through API Gateway
と入力し、返された検索結果から [API Gateway を介して同期高速ワークフローを呼び出す] を選択します。 -
[次へ] を選択して続行します。
-
Step Functions は、選択したサンプルプロジェクト AWS サービス で使用される を一覧表示します。サンプルプロジェクトのワークフローグラフも表示されます。このプロジェクトを にデプロイ AWS アカウント するか、独自のプロジェクトを構築するための出発点として使用します。進める方法に応じて、[デモの実行] または [その上に構築する] を選択します。
このサンプルプロジェクトは、以下のリソースをデプロイします。
-
ステートマシンによって呼び出Amazon API GatewayHTTPSAPIされる 。
-
Amazon DynamoDB テーブル。
-
3 つの AWS Step Functions ステートマシン。
-
関連する AWS Identity and Access Management (IAM) ロール。
以下のイメージは、[API Gateway を介して同期高速ワークフローを呼び出す] サンプルプロジェクトのワークフローグラフを示しています。
-
-
[テンプレートの使用] を選択して選択を続行します。
-
次のいずれかを行います。
-
Build on it を選択した場合、Step Functions はワークフロープロトタイプを作成しますが、ワークフロー定義にリソースをデプロイしないため、ワークフロープロトタイプの構築を継続できます。
Workflow Studio の ではデザインモード、ワークフロープロトタイプに状態を追加できます。または、 に切り替えコードモードて、統合されたコードエディタを使用して、Step Functions コンソールからステートマシンの Amazon ステートメント言語 (ASL) 定義を編集することもできます。
重要
ワークフロー を実行する前に、サンプルプロジェクトで使用されるリソースのプレースホルダー Amazon リソースネーム (ARN) を更新する必要がある場合があります。 ワークフローを実行
-
デモの実行 を選択した場合、Step Functions は、 AWS CloudFormation テンプレートを使用してそのテンプレート内の AWS リソースを にデプロイする読み取り専用プロジェクトを作成します AWS アカウント。コードモード を選択すると、ステートマシンの定義を表示できます。
デプロイと実行を選択してプロジェクトをデプロイし、リソースを作成します。
デプロイには、リソースとIAMアクセス許可が作成されるまでに最大 10 分かかる場合があることに注意してください。リソースのデプロイ中に、 AWS CloudFormation スタック ID リンクを開いて、プロビジョニングされているリソースを確認できます。
すべてのリソースが作成されると、コンソールのステートマシンページにプロジェクトが表示されます。
重要
CloudFormation テンプレートで使用されるサービスごとに、標準料金が適用される場合があります。
-
ステップ 2: ステートマシンを実行する
-
[ステートマシン] ページで、サンプルプロジェクトを選択します。
-
サンプルプロジェクトページで、[実行を開始] を選択します。
-
[実行を開始] ダイアログボックスで、以下の操作を行います。
-
(オプション) 実行を識別するには、名前を指定するか、デフォルトで生成された実行名 を使用します。
注記
Step Functions は、 ASCII以外の文字を含むステートマシン、実行、アクティビティ、およびラベルの名前を受け入れます。文字ASCII以外の名前は Amazon では機能しないため CloudWatch、 ASCII でメトリクスを追跡できるように、文字のみを使用することをお勧めします CloudWatch。
-
(オプション) 入力ボックスに、ワークフローを実行するための入力値を JSON 形式で入力します。
[デモの実行] を選択した場合、実行入力を入力する必要はありません。
注記
デプロイしたデモプロジェクトに事前入力された実行入力データが含まれている場合は、その入力を使用してステートマシンを実行します。
-
[実行のスタート] を選択します。
-
Step Functions コンソールから実行 ID のタイトルが付いたページが表示されます。このページは、[実行の詳細] ページと呼ばれます。このページでは、実行の進行中または完了後に実行結果を確認できます。
実行結果を確認するには、[グラフビュー] で個々の状態を選択し、ステップの詳細 ペインの個々のタブを選択すると、入力、出力、定義などの各状態の詳細がそれぞれ表示されます。[実行の詳細] ページに表示できる実行情報の詳細については、「[実行の詳細] ページ - インターフェイスの概要」を参照してください。
-
ステートマシンのコード例
このサンプルプロジェクトのステートマシンは、APIGateway を使用して同期 Express ワークフローを呼び出し、APIGateway および DynamoDB と統合します。このワークフローは、DynamoDB を使用して従業員データベースを更新または読み取ります。
このステートマシンの例を参照して、Step Functions が DynamoDB から読み取りを行い、従業員情報を取得する方法を確認してください。
API Gateway を使用して Step Functions を呼び出す方法の詳細については、以下を参照してください。
ゲートウェイデベロッパーガイドの「プライベートゲートウェイを呼び出す方法」。 API
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"
}
}
}
他の AWS のサービスで Step Functions を使用するIAMときに を設定する方法については、「」を参照してください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"
]
}
]
}
他の AWS のサービスで Step Functions を使用するIAMときに を設定する方法については、「」を参照してくださいStep Functions が統合サービスのIAMポリシーを生成する方法。