Interface Message

interface Message {
    body: string;
    id: string;
    deduplicationId?: string;
    delaySeconds?: number;
    groupId?: string;
    messageAttributes?: {
        [key: string]: MessageAttributeValue;
    };
}

Properties

body id deduplicationId? delaySeconds? groupId? messageAttributes?

Properties

body

body: string

The messages contents.

id

id: string

An identifier for the message. This must be unique within the batch of messages.

Optional deduplicationId

deduplicationId?: string

This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular id is sent successfully, subsequent messages with the same id are accepted successfully but aren't delivered.

Optional delaySeconds

delaySeconds?: number

The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes.

Optional groupId

groupId?: string

This parameter applies only to FIFO (first-in-first-out) queues. When set messages that belong to the same message group are processed in a FIFO manner

Optional messageAttributes

messageAttributes?: {
    [key: string]: MessageAttributeValue;
}

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

Type declaration

  • [key: string]: MessageAttributeValue

Settings

Member Visibility

Theme

On This Page

bodyiddeduplicationIddelaySecondsgroupIdmessageAttributes