翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Step Functions RESTAPIsでAPIゲートウェイを作成する

Amazon API Gateway を使用して、Step Functions HTTPRESTAPIsで および を作成、公開、保守、モニタリングする方法について説明します。Gateway と統合するにはAPI、コードを記述したり、他のインフラストラクチャに依存したりすることなく、APIゲートウェイHTTPまたはAPIゲートウェイRESTエンドポイントを直接呼び出す Step Functions でTask状態を定義します。Task 状態定義には、API呼び出しに必要なすべての情報が含まれます。別の認可方法を選択することもできます。

との統合について学ぶには AWS Step Functions の サービスについては、 サービスとの統合「」および「」を参照してくださいStep Functions APIのサービスへのパラメータの受け渡し。

API ゲートウェイ機能のサポート

Step Functions API Gateway 統合は、一部のゲートウェイ機能をサポートしていますが、すべてのAPIゲートウェイ機能をサポートしているわけではありません。サポートされている特徴の詳細なリストについては、以下を参照してください。

API Gateway とその HTTPおよび REST の詳細についてはAPIs、以下を参照してください。

リクエストの形式

Task 状態定義を作成すると、Step Functions はパラメータを検証し、呼び出しを実行するURLために必要な を構築して、 を呼び出しますAPI。レスポンスには、HTTPステータスコード、ヘッダー、レスポンス本文が含まれます。リクエスト形式には、必須およびオプションのパラメータがあります。

必須リクエストパラメータ

オプションのリクエストパラメータ

次のコード例は、Step Functions を使用して API Gateway を呼び出す方法を示しています。

{
    "Type": "Task", 
    "Resource":"arn:aws:states:::apigateway:invoke", 
    "Parameters": {
        "ApiEndpoint": "example.execute-api.us-east-1.amazonaws.com",
        "Method": "GET", 
        "Headers": { 
            "key": ["value1", "value2"] 
        },
        "Stage": "prod",
        "Path": "bills",
        "QueryParameters": {
            "billId": ["123456"]
        },
        "RequestBody": {},
        "AuthType": "NO_AUTH"
    } 
}
    

認証と認可

次の認証方法を使用できます。

サービス統合パターン

API Gateway 統合は、次の 2 つのサービス統合パターンをサポートします。

出力形式

次の出力パラメータが提供されます。

レスポンスの例:

{
    "ResponseBody": {
        "myBills": []
    },
    "Headers": { 
        "key": ["value1", "value2"]
    }, 
    "StatusCode": 200,
    "StatusText": "OK" 
}

エラー処理

エラーが発生した場合、error そして cause は次のように返されます。

いずれの場合も、cause は文字列として返されます。

以下は、エラーが発生したレスポンスの例です。

{
    "error": "ApiGateway.403", 
    "cause": "{\"message\":\"Missing Authentication Token\"}"
}

IAM Amazon API Gateway への呼び出しの ポリシー

次のサンプルテンプレートは、 AWS Step Functions は、ステートマシン定義のリソースに基づいてIAMポリシーを生成します。詳細については、「Step Functions が統合サービスのIAMポリシーを生成する方法」および「Step Functions でサービス統合パターンを検出する」を参照してください。

リソース:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "execute-api:Invoke"
            ],
            "Resource": [
                "arn:[[region]]:[[accountId]]:*"
            ]
        }
    ]
}

次のコード例は、APIGateway を呼び出すためのリソースポリシーを示しています。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service": "states.amazonaws.com"
            },
            "Action": "execute-api:Invoke",
            "Resource": "arn:aws:execute-api:<region>:<account-id>:<api-id>/<stage-name>/<HTTP-VERB>/<resource-path-specifier>",
            "Condition": {
                "StringEquals": {
                    "aws:SourceArn": [
                        "<SourceStateMachineArn>"
                    ]
                }
            }
        }
    ]
}