Create apigateway-sqs-receiveMessages.json

Author: marakere

APIGateway-SQS-ReceiveMessages/apigateway-sqs-receiveMessages.json

@@ -0,0 +1,89 @@
+{
+    "title": "APIGateway-SQS-ReceiveMessages",
+    "description": "Create a REST API Gateway to receive Messages from SQS queue.",
+    "language": "Python",
+    "level": "200",
+    "framework": "SAM",
+    "introBox": {
+        "headline": "How it works",
+        "text": [
+            "This serverless pattern creates an Amazon API Gateway REST API endpoint that directly integrates with Amazon Simple Queue Service (SQS) to read messages from a queue.",
+            "Users can simply call the GET method of the invoke URL to interact with the SQS queue. The invoke URL supports query string parameters such as MaxNumberOfMessages, VisibilityTimeout, and AttributeName to customize the output.",
+            "This pattern is particularly useful for frontend applications that need to interact with SQS via HTTPS protocol to read messages from the queue. It eliminates the need for AWS SDK integration, as requests to SQS can be made through simple HTTP calls.When implementing this pattern, please consider the AWS API Gateway and AWS SQS quotas to ensure compliance with the service limits."
+        ]
+    },
+    "gitHub": {
+        "template": {
+            "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/APIGateway-SQS-ReceiveMessages",
+            "templateURL": "serverless-patterns/APIGateway-SQS-ReceiveMessages",
+            "projectFolder": "APIGateway-SQS-ReceiveMessages",
+            "templateFile": "template.yaml"
+        }
+    },
+    "resources": {
+        "bullets": [
+            {
+                "text": "Working on integration of AWS Services with API Gateway",
+                "link": "https://repost.aws/knowledge-center/api-gateway-proxy-integrate-service"
+            },
+            {
+                "text": "API Gateway Documentation",
+                "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html"
+            },
+            {
+                "text": "AWS SQS Documentation",
+                "link": "https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html"
+            },
+            {
+                "text": "AWS API Gateway Quotas",
+                "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html"
+            },
+            {
+                "text": "AWS SQS Quotas",
+                "link": "https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html"
+            }
+        ]
+    },
+    "deploy": {
+        "text": [
+            "sam deploy"
+        ]
+    },
+    "testing": {
+        "text": [
+            "See the GitHub repo for detailed testing instructions."
+        ]
+    },
+    "cleanup": {
+        "text": [
+            "Delete the stack: <code>sam delete</code>"
+        ]
+    },
+    "authors": [
+        {
+            "name": "Yogesh Nain",
+            "image": "link-to-your-photo.jpg",
+            "bio": "Yogesh is Cloud Support Engineer and SME of Lambda, API Gateway at Amazon Web Services.",
+            "linkedin": "yogesh-nain-a54133170"
+        }
+    ],
+    "patternArch": {
+        "icon1": {
+            "x": 20,
+            "y": 50,
+            "service": "apigw",
+            "label": "API Gateway REST API"
+        },
+        "icon2": {
+            "x": 80,
+            "y": 50,
+            "service": "sqs",
+            "label": "Amazon SQS"
+        },
+        "line1": {
+            "from": "icon1",
+            "to": "icon2",
+            "label": ""
+        }
+    }
+}