String queueUrl
The URL of the Amazon SQS queue to which permissions are added.
Queue URLs are case-sensitive.
String label
The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum
80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (
_).
SdkInternalList<T> aWSAccountIds
The AWS account number of the principal who is 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 Simple Queue Service Developer Guide.
SdkInternalList<T> actions
The action the client wants to allow for the specified principal. The following values are valid:
*
ChangeMessageVisibility
DeleteMessage
GetQueueAttributes
GetQueueUrl
ReceiveMessage
SendMessage
For more information about these actions, see Understanding Permissions in the Amazon Simple Queue Service Developer Guide.
Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for
ActionName.n also grants permissions for the corresponding batch versions of those actions:
SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
String id
The Id of an entry in a batch request.
Boolean senderFault
Specifies whether the error happened due to the sender's fault.
String code
An error code representing why the action failed on this entry.
String message
A message explaining why the action failed on this entry.
String queueUrl
The URL of the Amazon SQS queue whose messages' visibility is changed.
Queue URLs are case-sensitive.
SdkInternalList<T> entries
A list of receipt handles of the messages for which the visibility timeout must be changed.
String id
An identifier for this particular receipt handle used to communicate the result.
The Ids of a batch request need to be unique within a request
String receiptHandle
A receipt handle.
Integer visibilityTimeout
The new value (in seconds) for the message's visibility timeout.
SdkInternalList<T> successful
A list of ChangeMessageVisibilityBatchResultEntry items.
SdkInternalList<T> failed
A list of BatchResultErrorEntry items.
String id
Represents a message whose visibility timeout has been changed successfully.
String queueUrl
The URL of the Amazon SQS queue whose message's visibility is changed.
Queue URLs are case-sensitive.
String receiptHandle
The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by
the ReceiveMessage action.
Integer visibilityTimeout
The new value for the message's visibility timeout (in seconds). Values values: 0 to
43200. Maximum: 12 hours.
String queueName
The name of the new queue. The following limits apply to this name:
A queue name can have up to 80 characters.
Valid values: alphanumeric characters, hyphens (-), and underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue names are case-sensitive.
SdkInternalMap<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 length of time, in seconds, for which the delivery of all messages in the queue
is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). The default is 0 (zero).
MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it.
Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).
MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message.
Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (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 length of time, in seconds, for which a
ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20
(seconds). The default is 0 (zero).
RedrivePolicy - The string that includes 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 Simple Queue Service Developer Guide.
deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount - The number of times a message is delivered to the source queue before being moved
to the dead-letter queue.
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. Valid values: An integer from 0 to 43,200
(12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and
86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but
results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue - Designates a queue as FIFO. Valid values: true, false. 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 also provide the MessageGroupId for your messages explicitly.
For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
ContentBasedDeduplication - Enables content-based deduplication. Valid values: true,
false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service 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.
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 (such as the following) are ignored:
ApproximateNumberOfMessages
ApproximateNumberOfMessagesDelayed
ApproximateNumberOfMessagesNotVisible
CreatedTimestamp
LastModifiedTimestamp
QueueArn
String queueUrl
The URL of the created Amazon SQS queue.
String queueUrl
The URL of the Amazon SQS queue from which messages are deleted.
Queue URLs are case-sensitive.
SdkInternalList<T> entries
A list of receipt handles for the messages to be deleted.
SdkInternalList<T> successful
A list of DeleteMessageBatchResultEntry items.
SdkInternalList<T> failed
A list of BatchResultErrorEntry items.
String id
Represents a successfully deleted message.
String queueUrl
The URL of the Amazon SQS queue to delete.
Queue URLs are case-sensitive.
String queueUrl
The URL of the Amazon SQS queue whose attribute information is retrieved.
Queue URLs are case-sensitive.
SdkInternalList<T> attributeNames
A list of attributes for which to retrieve information.
In the future, new attributes might be added. If you write 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 Simple Queue Service 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 aren't deleted. For more information, see Resources Required to Process Messages in the Amazon Simple Queue Service 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 length of time, in 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 length of time, in seconds, for which the
ReceiveMessage action waits for a message to arrive.
RedrivePolicy - Returns the string that includes 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 Simple Queue Service Developer Guide.
deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount - The number of times a message is delivered to the source queue before being moved
to the dead-letter queue.
VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the
visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a
custom CMK. For more information, see Key Terms.
KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can
reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.
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 Simple Queue Service Developer Guide.
To determine whether a queue is FIFO, you
can check whether QueueName ends with the .fifo suffix.
ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue.
For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
SdkInternalMap<K,V> attributes
A map of attributes to their respective values.
String queueName
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters,
hyphens (-), and underscores (_).
Queue names are case-sensitive.
String queueOwnerAWSAccountId
The AWS account ID of the account that created the queue.
String queueUrl
The URL of the queue.
String queueUrl
The URL of a dead-letter queue.
Queue URLs are case-sensitive.
SdkInternalList<T> queueUrls
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a
dead-letter queue.
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.
SdkInternalList<T> queueUrls
A list of queue URLs, up to 1,000 entries.
String queueUrl
The URL of the queue.
SdkInternalMap<K,V> tags
The list of all tags added to the specified queue.
String messageId
A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an
extended period of time.
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.
String mD5OfBody
An MD5 digest of the non-URL-encoded message body string.
String body
The message's contents (not URL-encoded).
SdkInternalMap<K,V> attributes
SenderId, SentTimestamp, ApproximateReceiveCount, and/or
ApproximateFirstReceiveTimestamp. SentTimestamp and
ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.
String 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.
SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more
information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide.
String stringValue
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
ByteBuffer binaryValue
Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
SdkInternalList<T> stringListValues
Not implemented. Reserved for future use.
SdkInternalList<T> binaryListValues
Not implemented. Reserved for future use.
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 and Validation in the Amazon Simple Queue Service Developer Guide.
String queueUrl
The URL of the queue from which the PurgeQueue action deletes messages.
Queue URLs are case-sensitive.
String queueUrl
The URL of the Amazon SQS queue from which messages are received.
Queue URLs are case-sensitive.
SdkInternalList<T> 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) are ignored:
ApproximateNumberOfMessages
ApproximateNumberOfMessagesDelayed
ApproximateNumberOfMessagesNotVisible
CreatedTimestamp
ContentBasedDeduplication
DelaySeconds
FifoQueue
LastModifiedTimestamp
MaximumMessageSize
MessageRetentionPeriod
Policy
QueueArn,
ReceiveMessageWaitTimeSeconds
RedrivePolicy
VisibilityTimeout
SdkInternalList<T> messageAttributeNames
The name of the message attribute, where N is the index.
The name can contain alphanumeric characters and the underscore (_), hyphen (-), and
period (.).
The name is case-sensitive and must be unique among all attribute names for the message.
The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any
casing variants).
The name must not start or end with a period (.), and it should not have periods in succession (
..).
The name can be up to 256 characters long.
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 all message
attributes starting with a prefix, for example bar.*.
Integer maxNumberOfMessages
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values are 1 to 10. Default is 1.
Integer visibilityTimeout
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being
retrieved by a ReceiveMessage request.
Integer waitTimeSeconds
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a
message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and
the wait time expires, the call returns successfully with an empty list of messages.
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 work
until the original visibility timeout expires. As a result, delays might occur but the messages in the queue
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.
SdkInternalList<T> messages
A list of messages.
String queueUrl
The URL of the Amazon SQS queue from which permissions are removed.
Queue URLs are case-sensitive.
String label
The identification of the permission to remove. This is the label added using the
AddPermission action.
String queueUrl
The URL of the Amazon SQS queue to which batched messages are sent.
Queue URLs are case-sensitive.
SdkInternalList<T> entries
A list of SendMessageBatchRequestEntry items.
String id
An identifier for a message in this batch used to communicate the result.
The Ids of a batch request need to be unique within a request
String messageBody
The body of the message.
Integer 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.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this
parameter only on a queue level.
SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more
information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide.
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 Simple Queue Service 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.
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.
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.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
SdkInternalList<T> successful
A list of SendMessageBatchResultEntry items.
SdkInternalList<T> failed
A list of BatchResultErrorEntry items with error details about each message that can't be
enqueued.
String id
An identifier for the message in this batch.
String messageId
An identifier for the message.
String mD5OfMessageBody
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.
String 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.
String 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.
String queueUrl
The URL of the Amazon SQS queue to which a message is sent.
Queue URLs are case-sensitive.
String messageBody
The message to send. The maximum string size is 256 KB.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF |
#xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
Integer delaySeconds
The length of time, in seconds, for which to delay a specific message. 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 applies.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this
parameter only on a queue level.
SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more
information, see Message Attribute Items and Validation in the Amazon Simple Queue Service Developer Guide.
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 Simple Queue Service 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.
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.
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.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
String mD5OfMessageBody
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.
String 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.
String messageId
An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.
String 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. SequenceNumber continues to increase for a
particular MessageGroupId.
String queueUrl
The URL of the Amazon SQS queue whose attributes are set.
Queue URLs are case-sensitive.
SdkInternalMap<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 length of time, in seconds, for which the delivery of all messages in the queue
is delayed. Valid values: 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.
Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256
KiB).
MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message.
Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (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 length of time, in seconds, for which a
ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20
(seconds). The default is 0.
RedrivePolicy - The string that includes 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 Simple Queue Service Developer Guide.
deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS
moves messages after the value of maxReceiveCount is exceeded.
maxReceiveCount - The number of times a message is delivered to the source queue before being moved
to the dead-letter queue.
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. Valid values: an integer from 0 to 43,200
(12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.
For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the
alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or
decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and
86,400 seconds (24 hours). The default is 300 (5 minutes). A shorter time period provides better security but
results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
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 Simple Queue Service 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.
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 (such as the following) are ignored:
ApproximateNumberOfMessages
ApproximateNumberOfMessagesDelayed
ApproximateNumberOfMessagesNotVisible
CreatedTimestamp
LastModifiedTimestamp
QueueArn
String queueUrl
The URL of the queue.
SdkInternalMap<K,V> tags
The list of tags to be added to the specified queue.
String queueUrl
The URL of the queue.
SdkInternalList<T> tagKeys
The list of tags to be removed from the specified queue.
Copyright © 2018. All rights reserved.