Tätigen Sie einen Anruf bei API Gateway - AWS Step Functions

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.

Tätigen Sie einen Anruf bei API Gateway

Dieses Beispielprojekt veranschaulicht, wie Sie Step Functions verwenden, um API Gateway aufzurufen, und prüft, ob der Aufruf erfolgreich war. Dieses Beispielprojekt erstellt Folgendes:

  • Eine Amazon API Gateway REST-API, die vom Statuscomputer aufgerufen wird.

  • ZugehörigeAWS Identity and Access Management(IAM) -Rollen.

Weitere Informationen zu -Serviceintegrationen für API Gateway Gateway-und Step Functions Functions-Dienstoptionen finden Sie im

Erstellen des Zustandsautomaten und Bereitstellen von Ressourcen

  1. Öffnen SieStep Functions -Konsoleund wähleErstellen eines Zustandsautomatenaus.

  2. Klicken Sie aufFühren Sie ein Beispielprojekt ausKlicken Sie auf und danach aufTätigen Sie einen Anruf bei API Gatewayaus.

    Der Code und der Visual Workflow des Zustandsautomaten werden angezeigt.

    
            Schulungsmodell-Workflow.
  3. Wählen Sie Next (Weiter) aus.

    Die Seite Deploy resources (Ressourcen bereitstellen) wird angezeigt und listet die Ressourcen auf, die erstellt werden. Die Ressourcen für dieses Beispielprojekt:

    • Ein -Zustandsautomat

    • Ein Aufruf der API Gateway Gateway-REST-API

    • Zugehörige IAM-Rollen

  4. Wählen Sie Deploy Resources (Ressourcen bereitstellen) aus.

    Anmerkung

    Es kann bis zu 10 Minuten dauern, bis diese Ressourcen und dazugehörende IAM-Berechtigungen erstellt werden. Wenn die Seite Deploy resources (Ressourcen bereitstellen) anzeigt wird, können Sie den Link Stack ID (Stack-ID) öffnen, um zu sehen, welche Ressourcen bereitgestellt werden.

Starten einer neuen Ausführung

  1. Öffnen SieStep Functions -Konsoleaus.

  2. Auf derZustandsautomatenWählen Sie die SeiteApiGatewayWorkflowStateMaschineZustandsautomat, der vom Beispielprojekt erstellt wurde, und wählen Sie dannStarten Sie die Ausführungaus.

  3. Geben Sie auf der Seite New execution (Neue Ausführung) einen Namen für die Ausführung (optional) ein und wählen Sie Start Execution (Ausführung starten).

  4. (Optional) Um Ihre Ausführung zu identifizieren, können Sie imNameaus. Standardmäßig generiert Step Functions automatisch einen eindeutigen Ausführungsnamen.

    Anmerkung

    Mit Step Functions können Sie Statuscomputer-, Ausführungs- und Aktivitätsnamen erstellen, die Nicht-ASCII-Zeichen enthalten. Diese Nicht-ASCII-Namen funktionieren nicht mit AmazonCloudWatchaus. Um sicherzustellen, dass Sie nachverfolgen könnenCloudWatchMetriken, wählen Sie einen Namen, der nur ASCII-Zeichen verwendet.

  5. (Optional) Wechseln Sie auf den Step Functions zum neu erstellten ZustandsautomatenDashboardKlicken Sie auf und danach aufNeue Ausführungaus.

  6. Wenn eine Ausführung abgeschlossen ist, können Sie Zustände imVisueller WorkflowUnd stöbern Sie imEingabeundAusgabeunterSchritt-Detailsaus.

Code des Zustandsautomaten aus diesem Beispiel

Der Zustandsautomat in diesem Beispielprojekt lässt sich in API Gateway integrieren, indem die API Gateway Gateway-REST-API aufgerufen und alle erforderlichen Parameter übergeben werden.

Durchsuchen Sie diesen Beispielzustandsautomaten, um zu sehen, wie Step Functions mit API Gateway Gateway-Interagieren.

Weitere Informationen darüber, wie AWS Step Functions andere AWS-Services steuern kann, finden Sie unter Verwenden von AWS Step Functions mit sonstigen Services.

{ "Comment": "Calling APIGW REST Endpoint", "StartAt": "Add Pet to Store", "States": { "Add Pet to Store": { "Type": "Task", "Resource": "arn:aws:states:::apigateway:invoke", "Parameters": { "ApiEndpoint": "<POST_PETS_API_ENDPOINT>", "Method": "POST", "Stage": "default", "Path": "pets", "RequestBody.$": "$.NewPet", "AuthType": "IAM_ROLE" }, "ResultSelector": { "ResponseBody.$": "$.ResponseBody" }, "Next": "Pet was Added Successfully?" }, "Pet was Added Successfully?": { "Type": "Choice", "Choices": [ { "Variable": "$.ResponseBody.errors", "IsPresent": true, "Next": "Failure" } ], "Default": "Retrieve Pet Store Data" }, "Failure": { "Type": "Fail" }, "Retrieve Pet Store Data": { "Type": "Task", "Resource": "arn:aws:states:::apigateway:invoke", "Parameters": { "ApiEndpoint": "<GET_PETS_API_ENDPOINT>", "Method": "GET", "Stage": "default", "Path": "pets", "AuthType": "IAM_ROLE" }, "ResultSelector": { "Pets.$": "$.ResponseBody" }, "ResultPath": "$.ExistingPets", "End": true } } }

Weitere Informationen zum Konfigurieren von IAM bei Verwendung von Step Functions mit anderenAWSDienstleistungen, sieheIAM-Richtlinien für integrierte Diensteaus.

IAM-Beispiel

Dieses BeispielAWS Identity and Access Management(IAM) -Beispielprojekt erstellt wurden, enthalten die geringstmöglichen Privilegien, die für die Ausführung des Zustandsautomaten und der verwandten Ressourcen erforderlich sind. Wir empfehlen, nur die erforderlichen Berechtigungen in Ihre IAM-Richtlinien aufzunehmen.

{ "Version": "2012-10-17", "Statement": [ { "Action": [ "execute-api:Invoke" ], "Resource": [ "arn:aws:execute-api:us-west-1:111122223333:c8hqe4kdg5/default/GET/pets", "arn:aws:execute-api:us-west-1:111122223333:c8hqe4kdg5/default/POST/pets" ], "Effect": "Allow" } ] }

Weitere Informationen zum Konfigurieren von IAM bei Verwendung von Step Functions mit anderenAWSDienstleistungen, sieheIAM-Richtlinien für integrierte Diensteaus.