The Amazon Simple Queue Service API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• BatchResultErrorEntry (p. 69)
• ChangeMessageVisibilityBatchRequestEntry (p. 70)
• ChangeMessageVisibilityBatchResultEntry (p. 71)
• DeleteMessageBatchRequestEntry (p. 72)
• DeleteMessageBatchResultEntry (p. 73)
• Message (p. 74)
• MessageAttributeValue (p. 76)
• MessageSystemAttributeValue (p. 78)
• SendMessageBatchRequestEntry (p. 80)
• SendMessageBatchResultEntry (p. 83)
BatchResultErrorEntry
BatchResultErrorEntry
Gives a detailed description of the result of an action on each entry in the request.
Contents
Code
An error code representing why the action failed on this entry.
Type: String Required: Yes Id
The Id of an entry in a batch request.
Type: String Required: Yes Message
A message explaining why the action failed on this entry.
Type: String Required: No SenderFault
Specifies whether the error happened due to the caller of the batch API action.
Type: Boolean Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ChangeMessageVisibilityBatchRequestEntry
ChangeMessageVisibilityBatchRequestEntry
Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch (p. 9).
Important
All of the following list parameters must be prefixed with
ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
Contents
Id
An identifier for this particular receipt handle used to communicate the result.
NoteThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted:
alphanumeric characters, hyphens(-), and underscores (_).
Type: String Required: Yes ReceiptHandle
A receipt handle.
Type: String Required: Yes VisibilityTimeout
The new value (in seconds) for the message's visibility timeout.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ChangeMessageVisibilityBatchResultEntry
ChangeMessageVisibilityBatchResultEntry
Encloses the Id of an entry in ChangeMessageVisibilityBatch (p. 9).
Contents
Id
Represents a message whose visibility timeout has been changed successfully.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DeleteMessageBatchRequestEntry
DeleteMessageBatchRequestEntry
Encloses a receipt handle and an identifier for it.
Contents
Id
An identifier for this particular receipt handle. This is used to communicate the result.
NoteThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted:
alphanumeric characters, hyphens(-), and underscores (_).
Type: String Required: Yes ReceiptHandle
A receipt handle.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DeleteMessageBatchResultEntry
DeleteMessageBatchResultEntry
Encloses the Id of an entry in DeleteMessageBatch (p. 20).
Contents
Id
Represents a successfully deleted message.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Message
Message
An Amazon SQS message.
Contents
Attribute , Attribute.N.Name (key) , Attribute.N.Value (value)
A map of the attributes requested in ReceiveMessage (p. 41) 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.
Type: String to string map
Valid Keys: SenderId | SentTimestamp | ApproximateReceiveCount |
ApproximateFirstReceiveTimestamp | SequenceNumber | MessageDeduplicationId | MessageGroupId | AWSTraceHeader
Required: No Body
The message's contents (not URL-encoded).
Type: String Required: No MD5OfBody
An MD5 digest of the non-URL-encoded message body string.
Type: String Required: No
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.
Type: String Required: No
MessageAttribute , MessageAttribute.N.Name (key) , MessageAttribute.N.Value (value)
Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
See Also
Type: String to MessageAttributeValue (p. 76) object map Required: No
MessageId
A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
Type: String Required: No 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.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MessageAttributeValue
MessageAttributeValue
The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage (p. 49).
Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
Contents
BinaryListValue.N
Not implemented. Reserved for future use.
Type: Array of Base64-encoded binary data objects Required: No
BinaryValue
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Type: Base64-encoded binary data object Required: No
DataType
Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
Type: String Required: Yes StringListValue.N
Not implemented. Reserved for future use.
Type: Array of strings Required: No
StringValue
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
See Also
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
MessageSystemAttributeValue
MessageSystemAttributeValue
The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage (p. 49).
Name, type, value and the message body must not be empty or null.
Contents
BinaryListValue.N
Not implemented. Reserved for future use.
Type: Array of Base64-encoded binary data objects Required: No
BinaryValue
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
Type: Base64-encoded binary data object Required: No
DataType
Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
Type: String Required: Yes StringListValue.N
Not implemented. Reserved for future use.
Type: Array of strings Required: No
StringValue
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
See Also
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SendMessageBatchRequestEntry
SendMessageBatchRequestEntry
Contains the details of a single Amazon SQS message along with an Id.
Contents
DelaySeconds
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900.
Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.
NoteWhen you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Type: Integer Required: No Id
An identifier for a message in this batch used to communicate the result.
NoteThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted:
alphanumeric characters, hyphens(-), and underscores (_).
Type: String Required: Yes
MessageAttribute , MessageAttribute.N.Name (key) , MessageAttribute.N.Value (value)
Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS message attributes in the Amazon SQS Developer Guide.
Type: String to MessageAttributeValue (p. 76) object map Required: No
MessageBody
The body of the message.
Type: String Required: Yes MessageDeduplicationId
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 MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
• Every message must have a unique MessageDeduplicationId,
• You may provide a MessageDeduplicationId explicitly.
Contents
• If you aren't able to provide a MessageDeduplicationId and you enable
ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
• If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
• If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
• When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
• If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
NoteThe MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?
@[\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer Guide.
Type: String Required: No MessageGroupId
This parameter applies only to FIFO (first-in-first-out) queues.
The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.
• You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
• ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer Guide.
Important
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
See Also
Type: String Required: No
MessageSystemAttribute , MessageSystemAttribute.N.Name (key) , MessageSystemAttribute.N.Value (value)
The message system attribute to send Each message system attribute consists of a Name, Type, and Value.
Important
• Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted AWS X-Ray trace header string.
• The size of a message system attribute doesn't count towards the total size of a message.
Type: String to MessageSystemAttributeValue (p. 78) object map Valid Keys: AWSTraceHeader
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SendMessageBatchResultEntry
SendMessageBatchResultEntry
Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch (p. 54).
Contents
Id
An identifier for the message in this batch.
Type: String Required: Yes
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.
Type: String Required: No MD5OfMessageBody
An MD5 digest of the non-URL-encoded message body 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.
Type: String Required: Yes
MD5OfMessageSystemAttributes
An MD5 digest of the non-URL-encoded message system 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.
Type: String Required: No MessageId
An identifier for the message.
Type: String Required: Yes SequenceNumber
This parameter applies only to FIFO (first-in-first-out) queues.
The large, non-consecutive number that Amazon SQS assigns to each message.
The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.
Type: String
See Also
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3