Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SQS.Types.Message

Description

Synopsis

data Message = Message' {
- messageAttributes :: Maybe (HashMap Text MessageAttributeValue)
- mD5OfBody :: Maybe Text
- body :: Maybe Text
- attributes :: Maybe (HashMap MessageAttribute Text)
- receiptHandle :: Maybe Text
- messageId :: Maybe Text
- mD5OfMessageAttributes :: Maybe Text
}
newMessage :: Message
message_messageAttributes :: Lens' Message (Maybe (HashMap Text MessageAttributeValue))
message_mD5OfBody :: Lens' Message (Maybe Text)
message_body :: Lens' Message (Maybe Text)
message_attributes :: Lens' Message (Maybe (HashMap MessageAttribute Text))
message_receiptHandle :: Lens' Message (Maybe Text)
message_messageId :: Lens' Message (Maybe Text)
message_mD5OfMessageAttributes :: Lens' Message (Maybe Text)

Documentation

data Message Source #

An Amazon SQS message.

See: newMessage smart constructor.

Constructors

Message'

Fields

messageAttributes :: Maybe (HashMap Text 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.
mD5OfBody :: Maybe Text
An MD5 digest of the non-URL-encoded message body string.
body :: Maybe Text
The message's contents (not URL-encoded).
attributes :: Maybe (HashMap MessageAttribute Text)
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.
receiptHandle :: Maybe Text
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.
messageId :: Maybe Text
A unique identifier for the message. A MessageIdis considered unique across all accounts for an extended period of time.
mD5OfMessageAttributes :: Maybe Text
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.

Instances

Instances details

Eq Message Source #
Instance details Defined in Amazonka.SQS.Types.Message Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Read Message Source #
Instance details Defined in Amazonka.SQS.Types.Message Methods readsPrec :: Int -> ReadS Message # readList :: ReadS [Message] # readPrec :: ReadPrec Message # readListPrec :: ReadPrec [Message] #
Show Message Source #
Instance details Defined in Amazonka.SQS.Types.Message Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Generic Message Source #
Instance details Defined in Amazonka.SQS.Types.Message Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
NFData Message Source #
Instance details Defined in Amazonka.SQS.Types.Message Methods rnf :: Message -> () #
Hashable Message Source #
Instance details Defined in Amazonka.SQS.Types.Message Methods hashWithSalt :: Int -> Message -> Int # hash :: Message -> Int #
FromXML Message Source #
Instance details Defined in Amazonka.SQS.Types.Message Methods parseXML :: [Node] -> Either String Message #
type Rep Message Source #
Instance details Defined in Amazonka.SQS.Types.Message type Rep Message = D1 ('MetaData "Message" "Amazonka.SQS.Types.Message" "libZSservicesZSamazonka-sqsZSamazonka-sqs" 'False) (C1 ('MetaCons "Message'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MessageAttributeValue))) :: (S1 ('MetaSel ('Just "mD5OfBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap MessageAttribute Text))) :: S1 ('MetaSel ('Just "receiptHandle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mD5OfMessageAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newMessage :: Message Source #

Create a value of Message with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:messageAttributes:Message', message_messageAttributes - Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.

$sel:mD5OfBody:Message', message_mD5OfBody - An MD5 digest of the non-URL-encoded message body string.

$sel:body:Message', message_body - The message's contents (not URL-encoded).

$sel:attributes:Message', message_attributes - 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.

$sel:receiptHandle:Message', message_receiptHandle - 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.

$sel:messageId:Message', message_messageId - A unique identifier for the message. A MessageIdis considered unique across all accounts for an extended period of time.

$sel:mD5OfMessageAttributes:Message', message_mD5OfMessageAttributes - 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.

message_messageAttributes :: Lens' Message (Maybe (HashMap Text MessageAttributeValue)) Source #

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

message_mD5OfBody :: Lens' Message (Maybe Text) Source #

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

message_body :: Lens' Message (Maybe Text) Source #

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

message_attributes :: Lens' Message (Maybe (HashMap MessageAttribute Text)) Source #

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.

message_receiptHandle :: Lens' Message (Maybe Text) Source #

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.

message_messageId :: Lens' Message (Maybe Text) Source #

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

message_mD5OfMessageAttributes :: Lens' Message (Maybe Text) Source #

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.