Amazon SQS UDRs (4.3)
- Jenni Wallin
SqsCollectorCycleUDR
The SQS Collection Agent produces UDRs of type SqsCollectorCycleUDR.
Field | Description |
|---|---|
msgAttribute | The user-defined message attributes (if any) of the message. A read-only field of type |
msgBody | The contents of the message. A read-only field of type |
receiptHandle | The receipt handle - the unique id for the consumer - of the message. A read-only field of type |
standardAttributes | The standard attributes of the message. You have to select All Standard Attributes in the configuration of the agent if you want to retrieve this data, see Amazon SQS Forwarding Agent Configuration (4.3) A read-only field of type |
visibility | The visibility timeout of the message. This value shows how long the message remains “invisible” to other consumers of the queue. The visibility parameter in the queue for a particular collected message can be reset by the collection agent. This is done by changing the field value of the collected UDR in APL, and then routing the UDR back to the collection agent. The visibility parameter will not be set for the queue in general, only for the particular message. Routing back a UDR with its original contents to the collector will result in the message being deleted from the queue immediately without waiting for the timeout set in the visibility parameter. A field of type |
SqsForwarderCycleUDR
The SQS Forwarder Agent consumes UDRs of type SqsForwarderUDR. This is also the type used in the reply from the agent.
All fields of the SqsForwarderUDR are optional except one, the queueName.
Field | Description |
|---|---|
deduplicationId | the unique id to avoid duplicates of the message. If left empty, the SQS service will assign the id. An optional field of type |
error | If the message cannot be inserted in the queue, the error message from the SQS service is written to the error field. For successfully inserted messages, the error field is null. A read-only field of type |
msgAttribute | User-defined attributes of the message. An optional field of type |
msgBody | The contents of the message. An optional field of type |
msgGroupId | The Group Id that the message belongs to. An optional field of type |
queueName | The name of the queue that the message will be sent to. A mandatory field of type |
SqsMessageAttributeUDR
The SqsMessageAttributeUDR defines custom attributes in the SqsCollectorCycleUDR and the SqsForwarderUDR.
Field | Description |
|---|---|
DataType | Amazon SQS supports the following logical data types: |
value (any) | The value of the corresponding DataType |