Skip to content

Commit 44bb92d

Browse files
Improve documentation
1 parent b976618 commit 44bb92d

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

samples/aws/sqs-native-integration/sample.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: AmazonSQS transport native integration sample
3-
reviewed: 2025-05-04
3+
reviewed: 2025-07-25
44
component: Sqs
55
related:
66
- transports/sqs
@@ -10,6 +10,32 @@ redirects:
1010

1111
This sample demonstrates how to enable an NServiceBus endpoint to receive messages sent by a native (i.e. non-NServiceBus-based) implementation.
1212

13+
downloadbutton
14+
15+
## AWS setup
16+
17+
### Security and access configuration
18+
19+
Add the [AWS Access Key ID and AWS Secret Access Key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) to the following environment variables:
20+
21+
* Access Key ID in `AWS_ACCESS_KEY_ID`
22+
* Secret Access Key in `AWS_SECRET_ACCESS_KEY`
23+
* Default Region in `AWS_REGION`
24+
25+
See also [AWS Account Identifiers](https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html), [Managing Access Keys for an AWS Account](https://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html), and [IAM Security Credentials](https://console.aws.amazon.com/iam/home#/security_credential).
26+
27+
See also [AWS Regions](https://docs.aws.amazon.com/general/latest/gr/rande.html) for a list of available regions.
28+
29+
### SQS
30+
31+
Several [Amazon SQS](https://aws.amazon.com/sqs/) queues are required to run this sample. These will be created at start-up via the [installer mechanism](/nservicebus/operations/installers.md) of NServiceBus. The queues can be seen in the [SQS management UI](https://console.aws.amazon.com/sqs/home).
32+
33+
* `Samples-Sqs-SimpleReceiver`: The main message processing queue.
34+
* `Samples-Sqs-SimpleReceiver-delay.fifo`: Queue used for [delayed retries](/nservicebus/recoverability/#delayed-retries).
35+
* `error`: Queue used for [error handling](/nservicebus/recoverability/configure-error-handling.md).
36+
37+
### Code walk-through
38+
1339
In this sample, an external system sends a message to an SQS queue using the Amazon SQS .NET SDK.
1440

1541
snippet: NativeMessage

0 commit comments

Comments
 (0)