String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
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.
com.amazonaws.internal.SdkInternalList<T> 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.
com.amazonaws.internal.SdkInternalList<T> 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
.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
com.amazonaws.internal.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. This is used to communicate the result. Note that the
Id
s of a batch request need to be unique within the request.
String receiptHandle
A receipt handle.
Integer visibilityTimeout
The new value (in seconds) for the message's visibility timeout.
com.amazonaws.internal.SdkInternalList<T> successful
A list of ChangeMessageVisibilityBatchResultEntry items.
com.amazonaws.internal.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 to take action on.
Queue URLs are case-sensitive.
String receiptHandle
The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.
Integer visibilityTimeout
The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.
String queueName
The name for the queue to be created.
Queue names are case-sensitive.
com.amazonaws.internal.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 the
CreateQueue
action uses:
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed.
An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it.
An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256
KiB).
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing
seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (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 time for which a ReceiveMessage call will wait for a
message to arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0.
RedrivePolicy
- The parameters for dead letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using
Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The
default for this attribute is 30. For more information about visibility timeout, see Visibility
Timeout in the Amazon SQS Developer Guide.
Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages
,
ApproximateNumberOfMessagesDelayed
, ApproximateNumberOfMessagesNotVisible
,
CreatedTimestamp
, LastModifiedTimestamp
, and QueueArn
) will be ignored.
String queueUrl
The URL for the created Amazon SQS queue.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
com.amazonaws.internal.SdkInternalList<T> entries
A list of receipt handles for the messages to be deleted.
com.amazonaws.internal.SdkInternalList<T> successful
A list of DeleteMessageBatchResultEntry items.
com.amazonaws.internal.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 take action on.
Queue URLs are case-sensitive.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
com.amazonaws.internal.SdkInternalList<T> attributeNames
A list of attributes to retrieve information for. 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.
ApproximateNumberOfMessagesNotVisible
- returns the approximate number of messages that are not
timed-out and not deleted. For more information, see Resources
Required to Process Messages in the Amazon SQS Developer Guide.
VisibilityTimeout
- returns the visibility timeout for the queue. For more information about
visibility timeout, see Visibility
Timeout in the Amazon SQS Developer Guide.
CreatedTimestamp
- returns the time when the queue was created (epoch time in seconds).
LastModifiedTimestamp
- returns the time when the queue was last changed (epoch time in seconds).
Policy
- returns the queue's policy.
MaximumMessageSize
- returns the limit of how many bytes a message can contain before Amazon SQS
rejects it.
MessageRetentionPeriod
- returns the number of seconds Amazon SQS retains a message.
QueueArn
- returns the queue's Amazon resource name (ARN).
ApproximateNumberOfMessagesDelayed
- returns the approximate number of messages that are pending to
be added to the queue.
DelaySeconds
- returns the default delay on the queue in seconds.
ReceiveMessageWaitTimeSeconds
- returns the time for which a 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 RedrivePolicy and dead letter queues, see Using
Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.
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.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of attributes to the respective values.
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.
String queueOwnerAWSAccountId
The AWS account ID of the account that created the queue.
String queueUrl
The URL for the queue.
String queueUrl
The queue URL of a dead letter queue.
Queue URLs are case-sensitive.
com.amazonaws.internal.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.
com.amazonaws.internal.SdkInternalList<T> queueUrls
A list of queue URLs, up to 1000 entries.
String messageId
A unique identifier for the message. Message IDs are 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).
com.amazonaws.internal.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. 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, go to http://www.faqs.org/rfcs/rfc1321.html.
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
String stringValue
Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
ByteBuffer binaryValue
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.
com.amazonaws.internal.SdkInternalList<T> stringListValues
Not implemented. Reserved for future use.
com.amazonaws.internal.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.
String queueUrl
The queue URL of the queue to delete the messages from when using the PurgeQueue
API.
Queue URLs are case-sensitive.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
com.amazonaws.internal.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 when 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
- returns the AWS account number (or the IP address, if anonymous access is allowed) of the
sender.
SentTimestamp
- returns the time when the message was sent to the queue (epoch time in
milliseconds).
Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages
,
ApproximateNumberOfMessagesDelayed
, ApproximateNumberOfMessagesNotVisible
,
CreatedTimestamp
, DelaySeconds
, LastModifiedTimestamp
,
MaximumMessageSize
, MessageRetentionPeriod
, Policy
, QueueArn
,
ReceiveMessageWaitTimeSeconds
, RedrivePolicy
, and VisibilityTimeout
) will
be ignored.
com.amazonaws.internal.SdkInternalList<T> 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 cannot 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.
Integer maxNumberOfMessages
The maximum number of messages to return. Amazon SQS never returns more messages than this value but may return fewer. Values can be from 1 to 10. Default is 1.
All of the messages are not necessarily returned.
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 will wait for a message to arrive in the queue before returning. If a message is available, the call will return sooner than WaitTimeSeconds.
com.amazonaws.internal.SdkInternalList<T> messages
A list of messages.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
String label
The identification of the permission to remove. This is the label added with the AddPermission action.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
com.amazonaws.internal.SdkInternalList<T> entries
A list of SendMessageBatchRequestEntry items.
String id
An identifier for the message in this batch. This is used to communicate the result. Note that the
Id
s of a batch request need to be unique within the request.
String messageBody
Body of the message.
Integer delaySeconds
The number of seconds for which the message has to be delayed.
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
com.amazonaws.internal.SdkInternalList<T> successful
A list of SendMessageBatchResultEntry items.
com.amazonaws.internal.SdkInternalList<T> failed
A list of BatchResultErrorEntry items with the error detail about each message that could not 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 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, go to http://www.faqs.org/rfcs/rfc1321.html.
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, go to http://www.faqs.org/rfcs/rfc1321.html.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
String messageBody
The message to send. String maximum 256 KB in size. For a list of allowed characters, see the preceding important note.
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.
com.amazonaws.internal.SdkInternalMap<K,V> messageAttributes
Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items.
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, go to http://www.faqs.org/rfcs/rfc1321.html.
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, go to http://www.faqs.org/rfcs/rfc1321.html.
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.
String queueUrl
The URL of the Amazon SQS queue to take action on.
Queue URLs are case-sensitive.
com.amazonaws.internal.SdkInternalMap<K,V> attributes
A map of attributes to set.
The following lists the names, descriptions, and values of the special request parameters the
SetQueueAttributes
action uses:
DelaySeconds
- The time in seconds that the delivery of all messages in the queue will be delayed.
An integer from 0 to 900 (15 minutes). The default for this attribute is 0 (zero).
MaximumMessageSize
- The limit of how many bytes a message can contain before Amazon SQS rejects it.
An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256
KiB).
MessageRetentionPeriod
- The number of seconds Amazon SQS retains a message. Integer representing
seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (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 time for which a ReceiveMessage call will wait for a message to
arrive. An integer from 0 to 20 (seconds). The default for this attribute is 0.
VisibilityTimeout
- The visibility timeout for the queue. An integer from 0 to 43200 (12 hours). The
default for this attribute is 30. For more information about visibility timeout, see Visibility Timeout in the
Amazon SQS Developer Guide.
RedrivePolicy
- The parameters for dead letter queue functionality of the source queue. For more
information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon
SQS Developer Guide.
Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages
,
ApproximateNumberOfMessagesDelayed
, ApproximateNumberOfMessagesNotVisible
,
CreatedTimestamp
, LastModifiedTimestamp
, and QueueArn
) will be ignored.
Copyright © 2016. All rights reserved.