View a markdown version of this page

Entdecken Sie Muster der Serviceintegration in Step Functions - 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.

Entdecken Sie Muster der Serviceintegration in Step Functions

Für Serviceintegrationen können Sie verschiedene Integrationsmuster angeben, um zu steuern, wie Ihre Zustandsmaschine mit der integrierten interagiert AWS Dienste:

Jedes dieser Serviceintegrationsmuster wird dadurch gesteuert, wie Sie im "Resource"-Feld Ihrer Aufgabendefinition eine URI erstellen.

Ein ASL-Ressourcenwert in Step Functions ist ein eindeutiger Name (URI), der folgenden Anforderungen entspricht ARN-Format, identifiziert aber in der Regel keinen tatsächlichen Ressource in deinem Konto. Das Präfix“arn:aws:states:"richtet einen Namespace ein, den Step Functions für Integrationen verwendet. Der ::: Ein Teil des Werts steht für leer region und account-id Felder, die unnötig sind, da beide aus der Region und dem Konto abgeleitet werden, in denen der Workflow ausgeführt wird.

Ältere Integrationen zu AWS Lambda sind die einzige Ausnahme, bei der der Resource-Wert eine tatsächliche Lambda-Funktionsressource angibt. In der Step Functions-Konsole werden diese veralteten Ressourcen angezeigt, aber Sie können solche Ressourcen in der aktuellen grafischen Benutzeroberfläche nicht erstellen oder bearbeiten, es sei denn, Sie möchten den ASL-Code direkt bearbeiten.

Unterstützung von Integrationsmustern

Standard-Workflows und Express-Workflows unterstützen dasselbe Integrationen aber nicht dasselbe Integrationsmuster.

  • Standard-Arbeitsabläufe Unterstützung Antwort anfordern Integrationen. Unterstützung bestimmter Dienste Einen Job ausführen (.sync), oder Warte auf den Rückruf (.waitForTaskToken) , und in einigen Fällen beides. Einzelheiten finden Sie in der folgenden Tabelle mit optimierten Integrationen.

  • Express-Workflows nur Unterstützung Antwort anfordern Integrationen.

Informationen zur Entscheidung zwischen den beiden Typen finden Sie unter Workflowtyp in Step Functions auswählen.

AWS SDK-Integrationen in Step Functions

Integrierter Service Request Response (Antwort anfordern) Einen Job ausführen - .sync Warte auf Rückruf - .warteForTaskToken
Über zweihundert Dienste Standard und Express Wird nicht unterstützt Standard

Optimierte Integrationen in Step Functions

Integrierter Service Request Response (Antwort anfordern) Einen Job ausführen - .sync Warte auf Rückruf - .warteForTaskToken
Amazon API Gateway Standard und Express Wird nicht unterstützt Standard
Amazon Athena Standard und Express Standard Wird nicht unterstützt
AWS Batch Standard und Express Standard Wird nicht unterstützt
Amazon Bedrock Standard und Express Standard Standard
Amazon Bedrock AgentCore Standard und Express Wird nicht unterstützt Wird nicht unterstützt
AWS CodeBuild Standard und Express Standard Wird nicht unterstützt
Amazon DynamoDB Standard und Express Wird nicht unterstützt Wird nicht unterstützt
Amazon ECS/Fargate Standard und Express Standard Standard
Amazon EKS Standard und Express Standard Standard
Amazon EMR Standard und Express Standard Wird nicht unterstützt
Amazon EMR on EKS Standard und Express Standard Wird nicht unterstützt
Amazon EMR Serverless Standard und Express Standard Wird nicht unterstützt
Amazon EventBridge Standard und Express Wird nicht unterstützt Standard
AWS Glue Standard und Express Standard Wird nicht unterstützt
AWS Glue DataBrew Standard und Express Standard Wird nicht unterstützt
AWS Lambda Standard und Express Wird nicht unterstützt Standard
AWS Elemental MediaConvert Standard und Express Standard Wird nicht unterstützt
Amazon SageMaker AI Standard und Express Standard Wird nicht unterstützt
Amazon SNS Standard und Express Wird nicht unterstützt Standard
Amazon SQS Standard und Express Wird nicht unterstützt Standard
AWS Step Functions Standard und Express Standard Standard

Request Response (Antwort anfordern)

Wenn Sie einen Dienst angeben in der "Resource" Zeichenfolge Ihres Aufgabenstatus und Sie nur geben Sie die Ressource an, Step Functions wartet auf eine HTTP-Antwort und geht dann zum nächsten Status über. Step Functions wartet nicht darauf, dass ein Job abgeschlossen ist.

Das folgende Beispiel zeigt, wie Sie ein Amazon SNS-Thema veröffentlichen können.

"Send message to SNS": { "Type":"Task", "Resource":"arn:aws:states:::sns:publish", "Parameters": { "TopicArn":"arn:aws:sns:region:123456789012:myTopic", "Message":"Hello from Step Functions!" }, "Next":"NEXT_STATE" }

Dieses Beispiel bezieht sich auf Veröffentlichen API von Amazon SNS. Der Workflow fährt nach dem Aufruf der Publish-API mit dem nächsten Zustand fort.

Tipp

Informationen zur Bereitstellung eines Beispielworkflows, der das Request Response Service-Integrationsmuster verwendet, finden Sie unter Integrieren Sie einen Dienst im Tutorial „Erste Schritte“ in diesem Handbuch oder im Modul „Antwort anfordern“ in Das AWS Step Functions Werkstatt.

Timeouts für Request Response-Aufgaben

TimeoutSeconds (oder TimeoutSecondsPath (in JSONPath) legt die maximale Zeit fest a Task state kann ausgeführt werden. Step Functions setzt dieses Limit selbst durch. Es wird nicht an den API-Aufruf weitergegeben, den die Aufgabe durchführt. Wenn die Aufgabe nicht innerhalb dieser Zeit abgeschlossen wird, schlägt sie mit einem Fehler fehl States.Timeout Fehler.

Wenn Sie keinen Timeout festlegen, wendet Step Functions einen Standard-Timeout an, sodass eine Request Response-Aufgabe nicht unbegrenzt wartet. Wenn Sie Folgendes einstellen TimeoutSeconds, Step Functions verwendet Ihren Wert anstelle des Standardwerts.

Step Functions begrenzt auch, wie lange darauf gewartet wird, dass der Dienst auf den API-Aufruf reagiert. TimeoutSeconds ändert dieses Limit nicht. Wenn Sie einen größeren Wert festlegen, hat der API-Aufruf nicht mehr Zeit, als das Limit zulässt.

Ausführen einer Aufgabe (.sync)

Für integrierte Dienste wie AWS Batch und Amazon ECS können Step Functions warten, bis eine Anfrage abgeschlossen ist, bevor sie zum nächsten Status übergehen. Um Step Functions warten zu lassen, geben Sie Folgendes an "Resource" Feld in Ihrer Aufgabenstatusdefinition mit .sync Suffix, das nach dem Ressourcen-URI angehängt wird.

Zum Beispiel beim Senden einer AWS Batch Job, benutze den "Resource" Feld in der Zustandsmaschinen-Definition, wie in diesem Beispiel gezeigt.

"Manage Batch task": { "Type": "Task", "Resource": "arn:aws:states:::batch:submitJob.sync", "Parameters": { "JobDefinition": "arn:aws:batch:us-east-2:123456789012:job-definition/testJobDefinition", "JobName": "testJob", "JobQueue": "arn:aws:batch:us-east-2:123456789012:job-queue/testQueue" }, "Next": "NEXT_STATE" }

Mit dem .sync Ein Teil, der an die Ressource Amazon Resource Name (ARN) angehängt wird, bedeutet, dass Step Functions auf den Abschluss des Jobs wartet. Nach dem Aufrufen von AWS Batch submitJob wird der Workflow unterbrochen. Wenn der Job abgeschlossen ist, geht Step Functions in den nächsten Status über. Weitere Informationen finden Sie in der AWS Batch Beispielprojekt: Verwalten Sie einen Batch-Job mit AWS Batch und Amazon SNS.

Wenn eine Aufgabe dies verwendet (.sync) Das Service-Integrationsmuster wird abgebrochen und Step Functions kann die Aufgabe nicht abbrechen. Möglicherweise fallen für Sie zusätzliche Kosten für den integrierten Dienst an. Eine Aufgabe kann abgebrochen werden, wenn:

  • Die Ausführung der Zustandsmaschine wird gestoppt.

  • Ein anderer Zweig eines Parallelzustands schlägt fehl und es liegt ein Fehler vor, der nicht erkannt wurde.

  • Eine Iteration eines Map-Status schlägt fehl, da ein Fehler nicht erkannt wurde.

Step Functions versucht nach besten Kräften, die Aufgabe abzubrechen. Zum Beispiel, wenn ein Step Functions states:startExecution.sync Eine Aufgabe wird abgebrochen, sie ruft die Step Functions auf StopExecution API-Aktion. Es ist jedoch möglich, dass Step Functions die Aufgabe nicht abbrechen kann. Zu den Gründen hierfür gehören unter anderem:

  • Ihrer IAM-Ausführungsrolle fehlt die Berechtigung, den entsprechenden API-Aufruf durchzuführen.

  • Ein vorübergehender Serviceausfall ist aufgetreten.

Wenn Sie das verwenden .sync Nach dem Muster der Serviceintegration verwendet Step Functions eine Abfrage, bei der Ihr zugewiesenes Kontingent und Ereignisse aufgebraucht werden, um den Status eines Jobs zu überwachen. Für .sync Aufrufe innerhalb desselben Kontos verwendet Step Functions EventBridge Ereignisse und Abfragen der APIs, die Sie in der Task Bundesstaat. Für kontoübergreifend .sync Aufrufe, Step Functions verwendet nur Polling. Zum Beispiel für states:StartExecution.sync, Step Functions führt Abfragen auf dem durch DescribeExecution API und verwendet Ihr zugewiesenes Kontingent.

Tipp

Informationen zur Bereitstellung eines Beispiel-Workflows, der das .sync-Integrationsmuster verwendet, finden Sie unter Einen Job ausführen (.sync) in Das AWS Step Functions Werkstatt.

Für eine Liste der integrierten Services, die das Warten auf den Abschluss eines Auftrags unterstützen (.sync) vgl. Integration von Diensten mit Step Functions. .

Anmerkung

Serviceintegrationen, die das verwenden .sync oder .waitForTaskToken Muster erfordern zusätzliche IAM-Berechtigungen. Weitere Informationen finden Sie unter So generiert Step Functions IAM-Richtlinien für integrierte Dienste.

In einigen Fällen möchten Sie möglicherweise, dass Step Functions Ihren Arbeitsablauf fortsetzt, bevor der Job vollständig abgeschlossen ist. Sie können dies auf die gleiche Weise erreichen wie bei der Verwendung von Warten Sie auf einen Rückruf mit dem Task-Token Muster der Dienstintegration. Übergeben Sie dazu ein Aufgabentoken an Ihren Job und geben Sie es dann mit einem SendTaskSuccess oder SendTaskFailure API-Aufruf. Step Functions verwendet die Daten, die Sie in diesem Aufruf angeben, um die Aufgabe abzuschließen, die Überwachung des Jobs zu beenden und den Workflow fortzusetzen.

Warten Sie auf einen Rückruf mit dem Task-Token

Callback-Aufgaben bieten eine Möglichkeit, einen Workflow anhalten, bis ein Aufgabentoken zurückgegeben wird. Eine Aufgabe auf eine menschliche Genehmigung warten, mit einer Drittpartei integriert werden oder ältere Systeme aufrufen müssen. Bei Aufgaben wie diesen können Sie Step Functions so lange unterbrechen, bis die Workflow-Ausführung das Servicekontingent von einem Jahr erreicht hat (siehe Kontingente im Zusammenhang mit staatlicher Drosselung) und warten Sie, bis ein externer Prozess oder Workflow abgeschlossen ist. In diesen Situationen ermöglicht Step Functions die Übergabe eines Aufgabentoken an die AWS SDK-Serviceintegrationen und auch einige optimierte Dienstintegrationen. Die Aufgabe wird angehalten, bis sie dieses Aufgabentoken mit einem SendTaskSuccess- oder SendTaskFailure- Aufruf zurückerhält.

Wenn ein Task Status, der das Callback-Task-Token verwendet, eine Zeitüberschreitung, wird ein neues zufälliges Token generiert. Sie können auf die Task-Token von der Kontext-Objekt.

Zu verwenden .waitForTaskToken mit einem AWS SDK-Integration, die von Ihnen verwendete API muss über ein Parameterfeld verfügen, in dem das Task-Token platziert werden kann.

Anmerkung

Sie müssen Aufgabentoken von Prinzipalen innerhalb derselben übergeben AWS Konto. Die Tokens funktionieren nicht, wenn du sie von Schulleitern in einem anderen Land sendest AWS Konto.

Tipp

Informationen zum Bereitstellen eines Beispiel-Workflows, der ein Integrationsmuster für Callback-Aufgabentoken verwendet, finden Sie unter Rückruf mit Task-Token in Das AWS Step Functions Werkstatt.

Eine Liste der integrierten Services, die das Warten auf ein Aufgabentoken unterstützen (.waitForTaskToken) finden Sie unter Integration von Diensten mit Step Functions.

Aufgabentoken-Beispiel

In diesem Beispiel muss ein Step Functions-Workflow in einen externen Microservice integriert werden, um im Rahmen eines Genehmigungsworkflows eine Bonitätsprüfung durchzuführen. Step Functions veröffentlicht eine Amazon SQS-Nachricht, die ein Task-Token als Teil der Nachricht enthält. Ein externes System ist in Amazon SQS integriert und zieht die Nachricht aus der Warteschlange. Wenn das abgeschlossen ist, werden das Ergebnis und das ursprüngliche Task-Token zurückgegeben. Step Functions setzt dann seinen Arbeitsablauf fort.

SQS-Aufgabe, die auf die Rückgabe eines Aufgabentokens wartet

Der "Resource" Das Feld der Aufgabendefinition, das auf Amazon SQS verweist, umfasst .waitForTaskToken an das Ende angehängt.

"Send message to SQS": { "Type": "Task", "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken", "Parameters": { "QueueUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/myQueue", "MessageBody": { "Message": "Hello from Step Functions!", "TaskToken.$": "$$.Task.Token" } }, "Next": "NEXT_STATE" }

Dadurch wird Step Functions angewiesen, eine Pause einzulegen und auf das Task-Token zu warten. Wenn Sie eine Ressource mit .waitForTaskToken, abgeben, können Sie im "Parameters"-Feld Ihrer Zustandsdefinition mit einer speziellen Pfadbezeichnung ($$.Task.Token) auf das Aufgabentoken zugreifen. Das Initiale $$. gibt an, dass der Pfad auf den zugreift Kontext-Objekt, und ruft das Task-Token für die aktuelle Aufgabe in einer laufenden Ausführung ab.

Wenn der Vorgang abgeschlossen ist, ruft der externe Service SendTaskSuccess oder SendTaskFailure mit taskToken auf. Erst danach wird der Workflow mit dem nächsten Zustand fortgesetzt.

Anmerkung

Wie zu vermeiden ist, dass unbegrenzt lange gewartet wird, wenn ein Prozess das Aufgabentoken nicht zusammen mit SendTaskSuccess oder SendTaskFailure sendet, finden Sie unter Konfigurieren einer Heartbeat-Zeitüberschreitung für eine wartende Aufgabe.

Ruft ein Token aus dem Context-Objekt ab

Das Context-Objekt ist ein internes JSON-Objekt, das Informationen über Ihre Ausführung enthält. Wie die Zustandsausgabe ist es über einen Pfad aus dem Feld "Parameters" während einer Ausführung zugänglich. Wenn aus einer Aufgabendefinition darauf zugegriffen wird, enthält es Informationen über die spezifische Ausführung, einschließlich des Aufgabentokens.

{ "Execution": { "Id": "arn:aws:states:region:account-id:execution:stateMachineName:executionName", "Input": { "key": "value" }, "Name": "executionName", "RoleArn": "arn:aws:iam::account-id:role...", "StartTime": "2019-03-26T20:14:13.192Z" }, "State": { "EnteredTime": "2019-03-26T20:14:13.192Z", "Name": "Test", "RetryCount": 3 }, "StateMachine": { "Id": "arn:aws:states:region:account-id:stateMachine:stateMachineName", "Name": "name" }, "Task": { "Token": "h7XRiCdLtd/83p1E0dMccoxlzFhglsdkzpK9mBVKZsp7d9yrT1W" } }

Sie können auf das Aufgabentoken mit einem speziellen Pfad innerhalb des "Parameters"-Felds Ihrer Aufgabendefinition zugreifen. Um auf die Eingabe oder das Context-Objekt zuzugreifen, geben Sie zunächst an, dass der Parameter ein Pfad sein soll, indem Sie einen .$ an den Parameternamen. Im Folgenden werden Knoten sowohl aus dem Eingabe- als auch aus dem Context-Objekt in einem angegeben "Parameters" Spezifikation.

"Parameters": { "Input.$": "$", "TaskToken.$": "$$.Task.Token" },

In beiden Fällen anhängen .$ weist Step Functions an den Parameternamen an, einen Pfad zu erwarten. Im ersten Fall ist "$" ein Pfad, der die gesamte Eingabe enthält. Im zweiten Fall $$. gibt an, dass der Pfad auf das Context-Objekt zugreift, und $$.Task.Token setzt den Parameter auf den Wert des Task-Tokens im Context-Objekt einer laufenden Ausführung.

Im Amazon SQS-Beispiel .waitForTaskToken in der "Resource" Feld weist Step Functions an, auf die Rückgabe des Task-Token zu warten. Das "TaskToken.$": "$$.Task.Token" Der Parameter übergibt dieses Token als Teil der Amazon SQS-Nachricht.

"Send message to SQS": { "Type": "Task", "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken", "Parameters": { "QueueUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/myQueue", "MessageBody": { "Message": "Hello from Step Functions!", "TaskToken.$": "$$.Task.Token" } }, "Next": "NEXT_STATE" }

Weitere Informationen zum Context-Objekt finden Sie unter Zugreifen auf Ausführungsdaten aus dem Context-Objekt in Step Functions in der Eingabe und Ausgabe verarbeiten Abschnitt in diesem Handbuch.

Konfigurieren einer Heartbeat-Zeitüberschreitung für eine wartende Aufgabe

Eine Aufgabe, die auf einen Aufgabentoken wartet, wartet, bis die Ausführung das einjährige Servicekontingent erreicht (siehe Kontingente im Zusammenhang mit staatlicher Drosselung). Um zu verhindern, dass Ausführungen hängen bleiben, können Sie eine Heartbeat-Zeitüberschreitung in Ihrer Zustandsautomatendefinition konfigurieren. Verwenden Sie das HeartbeatSeconds-Feld, um das Timeout-Intervall anzugeben.

{ "StartAt": "Push to SQS", "States": { "Push to SQS": { "Type": "Task", "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken", "HeartbeatSeconds": 600, "Parameters": { "MessageBody": { "myTaskToken.$": "$$.Task.Token" }, "QueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/push-based-queue" }, "ResultPath": "$.SQS", "End": true } } }

In dieser State-Machine-Definition sendet eine Aufgabe eine Nachricht an Amazon SQS und wartet darauf, dass ein externer Prozess mit dem bereitgestellten Task-Token zurückruft. Das "HeartbeatSeconds": 600-Feld legt das Intervall der Heartbeat-Zeitüberschreitung Intervall auf 10 Minuten fest. Die Aufgabe wartet auf die Rückgabe des Aufgabentokens mit einer der folgenden API-Aktionen:

Wenn die wartende Aufgabe innerhalb dieser 10 Minuten kein gültiges Aufgabentoken erhält, schlägt die Aufgabe mit dem Fehlernamen States.Timeout fehl.

Weitere Informationen finden Sie im Beispielprojekt Erstellen Sie ein Beispiel für ein Callback-Muster mit Amazon SQS, Amazon SNS und Lambda für eine Callback-Aufgabe.