Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

APIGateway REST APIs mit Step-Funktionen erstellen

Erfahren Sie, wie Sie Amazon API Gateway zum Erstellen, Veröffentlichen, Verwalten HTTP und Überwachen sowie REST APIs mit Step Functions verwenden. Für die Integration mit API Gateway definieren Sie in Step Functions einen Task Status, der direkt einen API API Gateway HTTP - oder REST Gateway-Endpunkt aufruft, ohne Code zu schreiben oder sich auf eine andere Infrastruktur zu verlassen. Eine Task Statusdefinition umfasst alle für den API Anruf erforderlichen Informationen. Sie können auch verschiedene Autorisierungsmethoden auswählen.

Um mehr über die Integration mit zu erfahren AWS Dienste in Step Functions, siehe Integrieren von -Services undÜbergeben von Parametern an einen Dienst API in Step Functions.

APIUnterstützung von Gateway-Funktionen

Die Step Functions API Gateway-Integration unterstützt einige, aber nicht alle API Gateway-Funktionen. Eine detailliertere Liste der unterstützten Funktionen finden Sie im Folgenden.

Weitere Informationen zu API Gateway und seinen HTTP und REST APIs finden Sie im Folgenden.

Anforderungsformat

Wenn Sie Ihre Task Statusdefinition erstellen, validiert Step Functions die Parameter, erstellt die für den Aufruf erforderlichen URL Daten und ruft dann den aufAPI. Die Antwort umfasst den HTTP Statuscode, die Header und den Antworttext. Das Anforderungsformat hat sowohl erforderliche als auch optionale Parameter.

Erforderliche Anforderungsparameter

Optionale Anforderungsparameter

Das folgende Codebeispiel zeigt, wie API Gateway mithilfe von Step Functions aufgerufen wird.

{
    "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"
    } 
}
    

Authentifizierung und Autorisierung

Sie können die folgenden Authentifizierungsmethoden verwenden:

Muster der Serviceintegration

Die API Gateway-Integration unterstützt zwei Serviceintegrationsmuster:

Ausgabeformat

Die folgenden Ausgabeparameter sind verfügbar:

Ein Beispiel für eine Antwort:

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

Fehlerbehandlung

Wenn ein Fehler auftritt, cause wird ein error und wie folgt zurückgegeben:

In beiden Fällen cause wird das als Zeichenfolge zurückgegeben.

Das folgende Beispiel zeigt eine Antwort, bei der ein Fehler aufgetreten ist:

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

IAMRichtlinien für Anrufe an Amazon API Gateway

Die folgenden Beispielvorlagen zeigen, wie AWS Step Functions generiert IAM Richtlinien auf der Grundlage der Ressourcen in Ihrer State-Machine-Definition. Weitere Informationen erhalten Sie unter So generiert Step Functions IAM Richtlinien für integrierte Dienste und Entdecken Sie Serviceintegrationsmuster in Step Functions.

Ressourcen:

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

Das folgende Codebeispiel zeigt eine Ressourcenrichtlinie für den Aufruf von API Gateway.

{
    "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>"
                    ]
                }
            }
        }
    ]
}