Serialized Form

Package com.amazonaws.services.sqs.model

Class com.amazonaws.services.sqs.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

label

String label

The unique identification of the permission you're setting (e.g., AliceSendMessage). Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

aWSAccountIds

List<E> aWSAccountIds

The AWS account number of the principal who will be given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.

actions

List<E> actions

The action the client wants to allow for the specified principal. The following are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility | GetQueueAttributes | GetQueueUrl . For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for the ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

Class com.amazonaws.services.sqs.model.BatchEntryIdsNotDistinctException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.BatchRequestTooLongException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.BatchResultErrorEntry extends Object implements Serializable

Serialized Fields

id

String id

The id of an entry in a batch request.

senderFault

Boolean senderFault

Whether the error happened due to the sender's fault.

code

String code

An error code representing why the action failed on this entry.

message

String message

A message explaining why the action failed on this entry.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

entries

List<E> entries

A list of receipt handles of the messages for which the visibility timeout must be changed.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchRequestEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

receiptHandle

String receiptHandle

A receipt handle.

visibilityTimeout

Integer visibilityTimeout

The new value (in seconds) for the message's visibility timeout.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResult extends Object implements Serializable

Serialized Fields

successful

List<E> successful

A list of ChangeMessageVisibilityBatchResultEntry items.

failed

List<E> failed

A list of BatchResultErrorEntry items.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityBatchResultEntry extends Object implements Serializable

Serialized Fields

id

String id

Represents a message whose visibility timeout has been changed successfully.

Class com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

receiptHandle

String receiptHandle

The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.

visibilityTimeout

Integer visibilityTimeout

The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.

Class com.amazonaws.services.sqs.model.CreateQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueName

String queueName

The name of the new queue. The following limits apply to this name:

• A queue name can have up to 80 characters.

• The following are accepted: alphanumeric chatacters, hyphens ( -), and underscores (_).

• A FIFO queue name must end with the .fifo suffix.

Queue names are case-sensitive.

attributes

Map<K,V> attributes

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

• DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).

• MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

• MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days).

• Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

• ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0.

• RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

  The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.

• VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Designates a queue as FIFO. You can provide this attribute only during queue creation; you can't change it for an existing queue. When you set this attribute, you must provide a MessageGroupId explicitly.

  For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Enables content-based deduplication. 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.

    • 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.

  • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

  • 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.

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.

Class com.amazonaws.services.sqs.model.CreateQueueResult extends Object implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL for the created Amazon SQS queue.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

entries

List<E> entries

A list of receipt handles for the messages to be deleted.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchRequestEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for this particular receipt handle. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

receiptHandle

String receiptHandle

A receipt handle.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchResult extends Object implements Serializable

Serialized Fields

successful

List<E> successful

A list of DeleteMessageBatchResultEntry items.

failed

List<E> failed

A list of BatchResultErrorEntry items.

Class com.amazonaws.services.sqs.model.DeleteMessageBatchResultEntry extends Object implements Serializable

Serialized Fields

id

String id

Represents a successfully deleted message.

Class com.amazonaws.services.sqs.model.DeleteMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

receiptHandle

String receiptHandle

The receipt handle associated with the message to delete.

Class com.amazonaws.services.sqs.model.DeleteQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.EmptyBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.GetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

attributeNames

List<E> attributeNames

A list of attributes for which to retrieve information.

Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

The following attributes are supported:

• All - Returns all values.

• ApproximateNumberOfMessages - Returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

• ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and are not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

• CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

• DelaySeconds - Returns the default delay on the queue in seconds.

• LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

• MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

• MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

• Policy - Returns the policy of the queue.

• QueueArn - Returns the Amazon resource name (ARN) of the queue.

• ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which ReceiveMessage call will wait for a message to arrive.

• RedrivePolicy - Returns the parameters for dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

• VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

Class com.amazonaws.services.sqs.model.GetQueueAttributesResult extends Object implements Serializable

Serialized Fields

attributes

Map<K,V> attributes

A map of attributes to the respective values.

Class com.amazonaws.services.sqs.model.GetQueueUrlRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueName

String queueName

The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.

Queue names are case-sensitive.

queueOwnerAWSAccountId

String queueOwnerAWSAccountId

The AWS account ID of the account that created the queue.

Class com.amazonaws.services.sqs.model.GetQueueUrlResult extends Object implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL for the queue.

Class com.amazonaws.services.sqs.model.InvalidAttributeNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.InvalidBatchEntryIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.InvalidIdFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.InvalidMessageContentsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The queue URL of a dead letter queue.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.ListDeadLetterSourceQueuesResult extends Object implements Serializable

Serialized Fields

queueUrls

List<E> queueUrls

A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue.

Class com.amazonaws.services.sqs.model.ListQueuesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueNamePrefix

String queueNamePrefix

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue names are case-sensitive.

Class com.amazonaws.services.sqs.model.ListQueuesResult extends Object implements Serializable

Serialized Fields

queueUrls

List<E> queueUrls

A list of queue URLs, up to 1000 entries.

Class com.amazonaws.services.sqs.model.Message extends Object implements Serializable

Serialized Fields

messageId

String messageId

A unique identifier for the message. Message IDs are considered unique across all AWS accounts for an extended period of time.

receiptHandle

String 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.

mD5OfBody

String mD5OfBody

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

body

String body

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

attributes

Map<K,V> attributes

SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.

mD5OfMessageAttributes

String mD5OfMessageAttributes

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

messageAttributes

Map<K,V> messageAttributes

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

Class com.amazonaws.services.sqs.model.MessageAttributeValue extends Object implements Serializable

Serialized Fields

stringValue

String stringValue

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

binaryValue

ByteBuffer binaryValue

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

stringListValues

List<E> stringListValues

Not implemented. Reserved for future use.

binaryListValues

List<E> binaryListValues

Not implemented. Reserved for future use.

dataType

String 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 Message Attribute Data Types in the Amazon SQS Developer Guide.

Class com.amazonaws.services.sqs.model.MessageNotInflightException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.OverLimitException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.PurgeQueueInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.PurgeQueueRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The queue URL of the queue to delete the messages from when using the PurgeQueue API.

Queue URLs are case-sensitive.

Class com.amazonaws.services.sqs.model.QueueDeletedRecentlyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.QueueDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.QueueNameExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.ReceiveMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

attributeNames

List<E> attributeNames

A list of attributes that need to be returned along with each message. These attributes include:

• All - Returns all values.

• ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).

• ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.

• SenderId

  • For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.

  • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

• SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).

• MessageDeduplicationId - Returns the value provided by the sender that calls the SendMessage action.

• MessageGroupId - Returns the value provided by the sender that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

• SequenceNumber - Returns the value provided by Amazon SQS.

Any other valid special request parameters (such as the following) that are specified are ignored:

• ApproximateNumberOfMessages

• ApproximateNumberOfMessagesDelayed

• ApproximateNumberOfMessagesNotVisible

• CreatedTimestamp

• ContentBasedDeduplication

• DelaySeconds

• LastModifiedTimestamp

• MaximumMessageSize

• MessageRetentionPeriod

• Policy

• QueueArn,

• ReceiveMessageWaitTimeSeconds

• RedrivePolicy

• FifoQueue

• VisibilityTimeout

messageAttributeNames

List<E> messageAttributeNames

The name of the message attribute, where N is the index. The message attribute name can contain the following characters: A-Z, a-z, 0-9, underscore (_), hyphen (-), and period (.). The name must not start or end with a period, and it should not have successive periods. The name is case sensitive and must be unique among all attribute names for the message. The name can be up to 256 characters long. The name can't start with "AWS." or "Amazon." (or any variations in casing), because these prefixes are reserved for use by Amazon Web Services.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying "All" or ".*" in your request. You can also use "bar.*" to return all message attributes starting with the "bar" prefix.

maxNumberOfMessages

Integer maxNumberOfMessages

The maximum number of messages to return. Amazon SQS never returns more messages than this value but might return fewer. Values can be from 1 to 10. Default is 1.

All of the messages are not necessarily returned.

visibilityTimeout

Integer visibilityTimeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

waitTimeSeconds

Integer waitTimeSeconds

The duration (in seconds) for which the call will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.

receiveRequestAttemptId

String receiveRequestAttemptId

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

• You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

• When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

• If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

• You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

• During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

  If a caller of the ReceiveMessage action is still processing messages when the visibility timeout expires and messages become visible, another worker reading from the same queue can receive the same messages and therefore process duplicates. Also, if a reader whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

  To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

• While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.

• If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries will work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue will remain in a strict order.

The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation ( !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.

Class com.amazonaws.services.sqs.model.ReceiveMessageResult extends Object implements Serializable

Serialized Fields

messages

List<E> messages

A list of messages.

Class com.amazonaws.services.sqs.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

label

String label

The identification of the permission to remove. This is the label added with the AddPermission action.

Class com.amazonaws.services.sqs.model.SendMessageBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

entries

List<E> entries

A list of SendMessageBatchRequestEntry items.

Class com.amazonaws.services.sqs.model.SendMessageBatchRequestEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for the message in this batch. This is used to communicate the result. Note that the Ids of a batch request need to be unique within the request.

messageBody

String messageBody

Body of the message.

delaySeconds

Integer delaySeconds

The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

messageAttributes

Map<K,V> messageAttributes

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

messageDeduplicationId

String 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.

  • 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.

• You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

• 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.

The MessageDeduplicationId is available to the recipient 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.

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 Simple Queue Service Developer Guide.

messageGroupId

String 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 readers 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 are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

Class com.amazonaws.services.sqs.model.SendMessageBatchResult extends Object implements Serializable

Serialized Fields

successful

List<E> successful

A list of SendMessageBatchResultEntry items.

failed

List<E> failed

A list of BatchResultErrorEntry items with the error detail about each message that could not be enqueued.

Class com.amazonaws.services.sqs.model.SendMessageBatchResultEntry extends Object implements Serializable

Serialized Fields

id

String id

An identifier for the message in this batch.

messageId

String messageId

An identifier for the message.

mD5OfMessageBody

String mD5OfMessageBody

An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

mD5OfMessageAttributes

String mD5OfMessageAttributes

An MD5 digest of the non-URL-encoded message attribute string. This can be used to verify that Amazon SQS received the message batch correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

sequenceNumber

String sequenceNumber

This element applies only to FIFO (first-in-first-out) queues.

A 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.

Class com.amazonaws.services.sqs.model.SendMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

messageBody

String messageBody

The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding note.

delaySeconds

Integer delaySeconds

The number of seconds (0 to 900 - 15 minutes) to delay a specific message. Messages with a positive DelaySeconds value become available for processing after the delay time is finished. If you don't specify a value, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

messageAttributes

Map<K,V> messageAttributes

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

messageDeduplicationId

String messageDeduplicationId

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. 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.

  • 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.

• You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

• 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.

The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgdment is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

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 Simple Queue Service Developer Guide.

messageGroupId

String 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 readers 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 are alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

Class com.amazonaws.services.sqs.model.SendMessageResult extends Object implements Serializable

Serialized Fields

mD5OfMessageBody

String mD5OfMessageBody

An MD5 digest of the non-URL-encoded message body string. This can be used to verify that Amazon SQS received the message correctly. Amazon SQS first URL decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

mD5OfMessageAttributes

String mD5OfMessageAttributes

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

messageId

String messageId

An element containing the message ID of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

sequenceNumber

String sequenceNumber

This element applies only to FIFO (first-in-first-out) queues.

A large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

Class com.amazonaws.services.sqs.model.SetQueueAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue to take action on.

Queue URLs are case-sensitive.

attributes

Map<K,V> attributes

A map of attributes to set.

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

• DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).

• MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

• MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. An integer representing seconds, from 60 (1 minute) to 120,9600 (14 days). The default is 345,600 (4 days).

• Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

• ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action will wait for a message to arrive. An integer from 0 to 20 (seconds). The default is 0.

• RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

  The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.

• VisibilityTimeout - The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attribute applies only to FIFO (first-in-first-out) queues:

• ContentBasedDeduplication - Enables content-based deduplication. 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.

    • 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.

  • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

  • 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.

Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages, ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.

Class com.amazonaws.services.sqs.model.TooManyEntriesInBatchRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.sqs.model.UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L