Add documentation about GetQueueUrl and DSN format in SQS transport

jderusse · jderusse · commit 447065dc4fe6 · 2020-11-04T10:03:11.000+01:00
diff --git a/messenger.rst b/messenger.rst
@@ -1300,7 +1300,7 @@ Amazon SQS
 
 .. versionadded:: 5.1
 
-    The Amazon SQS transport as introduced in Symfony 5.1.
+    The Amazon SQS transport has been introduced in Symfony 5.1.
 
 The Amazon SQS transport is perfect for application hosted on AWS. Install it by
 running:
@@ -1314,14 +1314,25 @@ The SQS transport DSN may looks like this:
 .. code-block:: env
 
     # .env
-    MESSENGER_TRANSPORT_DSN=sqs://AKIAIOSFODNN7EXAMPLE:j17M97ffSVoKI0briFoo9a@sqs.eu-west-3.amazonaws.com/messages
+    MESSENGER_TRANSPORT_DSN=https://AKIAIOSFODNN7EXAMPLE:j17M97ffSVoKI0briFoo9a@sqs.eu-west-3.amazonaws.com/123456789012/messages
     MESSENGER_TRANSPORT_DSN=sqs://localhost:9494/messages?sslmode=disable
 
 .. note::
 
     The transport will automatically create queues that are needed. This
     can be disabled setting the ``auto_setup`` option to ``false``.
 
+.. tip::
+
+    Before sending or receiving a message, Symfony needs to convert the queue
+    name into an AWS queue URL by calling the ``GetQueueUrl`` API in AWS. This
+    extra API call can be avoided by providing a DSN which is the queue URL.
+
+.. versionadded:: 5.2
+
+    Providing a DSN equals to the queue URL to avoid call to ``GetQueueUrl``
+    has been introduced in Symfony 5.2.
+
 The transport has a number of options:
 
 ======================  ======================================  ===================================
