diff --git a/stepfunctions-sns-apigw-human-review/README.md b/stepfunctions-sns-apigw-human-review/README.md index 9860edd4e..24b9b942a 100644 --- a/stepfunctions-sns-apigw-human-review/README.md +++ b/stepfunctions-sns-apigw-human-review/README.md @@ -1,6 +1,6 @@ # Filter and Transform Amazon SQS messages with Amazon EventBridge Pipes -The application will create a State Machine, an SNS topic, and an API Gateway REST API. This pattern allows you to integrate a human review or approval process into your workflows. The State Machine task sends a message to an SNS topic which sends a notification to a human reviewer by email. The workflow then waits until the approver completes their review. When the reviewer makes a selection, it will trigger an API that sends the SendTaskSuccess API call with the chosen result. +The application will create a Amazon Step Functions State Machine, an Amazon SNS topic, and an Amazon API Gateway REST API. This pattern allows you to integrate a human review or approval process into your workflows. The State Machine task sends a message to an SNS topic which sends a notification to a human reviewer by email. The workflow then waits until the approver completes their review. When the reviewer makes a selection, it will trigger an API that sends the `SendTaskSuccess` [API](https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskSuccess.html) or or `SendTaskFailure` [API](https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskFailure.html) call with the chosen result. This pattern is implemented with AWS Serverless Application Model (AWS SAM). Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/stepfunctions-sns-apigw-human-review @@ -38,7 +38,7 @@ Once you have run `sam deploy --guided` mode once and saved arguments to a confi ## How it works -![image](./resources/statemachine.png) +![image](./Resources/statemachine.png) 1. During the workflow execution, a message is sent to an [Amazon Simple Notification Service (SNS)](https://aws.amazon.com/sns/) topic which sends out a notification via Email. The notification contains links to `Approve` or `Reject` the request. The link contains an API Gateway endpoint with [task token](https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token), which is automatically generated by AWS Step Functions. 2. After approving or denying, the reviewer calls the `SendTaskSuccess` API and passes the task token as well as the review result.