Getting Started

AmazonSQS native integration

Target Version: NServiceBus 7.x

This document describes how to consume messages from non-NServiceBus endpoints via Amazon SQS in integration scenarios.

Accessing the native Amazon SQS message

It is sometimes useful to access the native Amazon SQS message from behaviors and handlers. When a message is received, the transport adds the native message, an instance of Amazon.SQS.Model.Message, to the message processing context. For example, the native message may be accessed from a pipeline behavior:

class AccessToAmazonSqsNativeMessage : Behavior<IIncomingContext>
    public override Task Invoke(IIncomingContext context, Func<Task> next)
        // get the native Amazon SQS message
        var message = context.Extensions.Get<Message>();

        //do something useful

        return next();

Message type detection

NServiceBus requires the message type to be available as part of the message metadata to process a message successfully

During message processing, the SQS transport inspects the native message attributes for an attribute with the name NServiceBus.AmazonSQS.Headers. This attribute's value should be a serialized Dictionary<string, string>. If the attribute is present, the message is treated as a native message, and the body is deserialized into the target type inferred from the payload.

The native message body is loaded from the configured S3 bucket when the NServiceBus.AmazonSQS.Headers attribute contains an entry with the key S3BodyKey and the value representing an S3 object key, including the necessary prefix as configured by the receiving endpoint.

Whenever the native message needs to be copied for moving messages to the error queue, auditing or delayed retries purposes, the native message is converted into the transport's internal structure. The collection from NServiceBus.AmazonSQS.Headers is moved from the native message attribute into the headers collection. All other available message attributes from the original native message are copied over into the newly formed native message.

Retrying failed messages

Native messages that failed processing can be retried using ServicePulse and ServiceControl but the native message attributes that might have been present in the original message are lost when the message is retried.