Skip to content

API reference / @node-ts/bus-sqs / SqsMessage

Interface: SqsMessage ​

Defined in: node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1487

An Amazon SQS message.

Properties ​

PropertyModifierTypeDescriptionDefined in
Attributes?publicPartial<Record<MessageSystemAttributeName, string>>

A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

  • ApproximateReceiveCount

  • ApproximateFirstReceiveTimestamp

  • MessageDeduplicationId

  • MessageGroupId

  • SenderId

  • SentTimestamp

  • SequenceNumber

ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1559
Body?publicstring

The message's contents (not URL-encoded).

node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1510
MD5OfBody?publicstring

An MD5 digest of the non-URL-encoded message body string.

node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1505
MD5OfMessageAttributes?publicstring

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1564
MessageAttributes?publicRecord<string, MessageAttributeValue>

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1572
MessageId?publicstring

A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.

node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1493
ReceiptHandle?publicstring

An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

node_modules/.pnpm/@aws-sdk+client-sqs@3.1142.0/node_modules/@aws-sdk/client-sqs/dist-types/models/models_0.d.ts:1500

Released under the MIT License.