NAME
Paws::SQS - Perl Interface to AWS Amazon Simple Queue Service
SYNOPSIS
use Paws;
my $obj = Paws->service('SQS');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
Welcome to the Amazon Simple Queue Service API Reference. This section describes who should read this guide, how the guide is organized, and other resources related to the Amazon Simple Queue Service (Amazon SQS).
Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available.
Helpful Links:
Current WSDL (2012-11-05)
Making API Requests
Amazon SQS product page
Using Amazon SQS Message Attributes
Using Amazon SQS Dead Letter Queues
Regions and Endpoints
We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as:
Cryptographically signing your service requests
Retrying requests
Handling error responses
For a list of available SDKs, go to Tools for Amazon Web Services.
METHODS
AddPermission(Actions => ArrayRef[Str], AWSAccountIds => ArrayRef[Str], Label => Str, QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::AddPermission
Returns: nothing
Adds a permission to a queue for a specific principal. This allows for
sharing access to the queue.When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.
AddPermission writes an Amazon SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
ChangeMessageVisibility(QueueUrl => Str, ReceiptHandle => Str, VisibilityTimeout => Int)
Each argument is described in detail in: Paws::SQS::ChangeMessageVisibility
Returns: nothing
Changes the visibility timeout of a specified message in a queue to a
new value. The maximum allowed timeout value you can set the value to
is 12 hours. This means you can't extend the timeout of a message in an
existing queue to more than a total visibility timeout of 12 hours.
(For more information visibility timeout, see Visibility Timeout in the
I<Amazon SQS Developer Guide>.)For example, let's say you have a message and its default message visibility timeout is 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message would be extended by 10 minutes beyond the time of the ChangeMessageVisibility call. This results in a total visibility timeout of 13 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend beyond 12 hours, the request will be rejected.
There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon SQS. To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages.
If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.
Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.
ChangeMessageVisibilityBatch(Entries => ArrayRef[Paws::SQS::ChangeMessageVisibilityBatchRequestEntry], QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::ChangeMessageVisibilityBatch
Returns: a Paws::SQS::ChangeMessageVisibilityBatchResult instance
Changes the visibility timeout of multiple messages. This is a batch
version of ChangeMessageVisibility. The result of the action on each
message is reported individually in the response. You can send up to 10
ChangeMessageVisibility requests with each
C<ChangeMessageVisibilityBatch> action.Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
CreateQueue(QueueName => Str, [Attributes => Paws::SQS::QueueAttributeMap])
Each argument is described in detail in: Paws::SQS::CreateQueue
Returns: a Paws::SQS::CreateQueueResult instance
Creates a new queue, or returns the URL of an existing one. When you
request C<CreateQueue>, you provide a name for the queue. To
successfully create a new queue, you must provide a name that is unique
within the scope of your own queues.If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute.
Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName parameter.
If you provide the name of an existing queue, along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue. If the queue name, attribute names, or attribute values do not match an existing queue, CreateQueue returns an error.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
DeleteMessage(QueueUrl => Str, ReceiptHandle => Str)
Each argument is described in detail in: Paws::SQS::DeleteMessage
Returns: nothing
Deletes the specified message from the specified queue. You specify the
message by using the message's C<receipt handle> and not the C<message
ID> you received when you sent the message. Even if the message is
locked by another reader due to the visibility timeout setting, it is
still deleted from the queue. If you leave a message in the queue for
longer than the queue's configured retention period, Amazon SQS
automatically deletes it.The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request DeleteMessage, if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted.
It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.
DeleteMessageBatch(Entries => ArrayRef[Paws::SQS::DeleteMessageBatchRequestEntry], QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::DeleteMessageBatch
Returns: a Paws::SQS::DeleteMessageBatchResult instance
Deletes up to ten messages from the specified queue. This is a batch
version of DeleteMessage. The result of the delete action on each
message is reported individually in the response.Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
DeleteQueue(QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::DeleteQueue
Returns: nothing
Deletes the queue specified by the B<queue URL>, regardless of whether
the queue is empty. If the specified queue does not exist, Amazon SQS
returns a successful response.Use DeleteQueue with care; once you delete your queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide.
GetQueueAttributes(QueueUrl => Str, [AttributeNames => ArrayRef[Str]])
Each argument is described in detail in: Paws::SQS::GetQueueAttributes
Returns: a Paws::SQS::GetQueueAttributesResult instance
Gets attributes for the specified queue.Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
GetQueueUrl(QueueName => Str, [QueueOwnerAWSAccountId => Str])
Each argument is described in detail in: Paws::SQS::GetQueueUrl
Returns: a Paws::SQS::GetQueueUrlResult instance
Returns the URL of an existing queue. This action provides a simple way
to retrieve the URL of an Amazon SQS queue.To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or go to Shared Queues in the Amazon SQS Developer Guide.
ListDeadLetterSourceQueues(QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::ListDeadLetterSourceQueues
Returns: a Paws::SQS::ListDeadLetterSourceQueuesResult instance
Returns a list of your queues that have the RedrivePolicy queue
attribute configured with a dead letter queue.For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues.
ListQueues([QueueNamePrefix => Str])
Each argument is described in detail in: Paws::SQS::ListQueues
Returns: a Paws::SQS::ListQueuesResult instance
Returns a list of your queues. The maximum number of queues that can be
returned is 1000. If you specify a value for the optional
C<QueueNamePrefix> parameter, only queues with a name beginning with
the specified value are returned.PurgeQueue(QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::PurgeQueue
Returns: nothing
Deletes the messages in a queue specified by the B<queue URL>.When you use the PurgeQueue API, the deleted messages in the queue cannot be retrieved.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue was called may be received, but will be deleted within the next minute.
ReceiveMessage(QueueUrl => Str, [AttributeNames => ArrayRef[Str], MaxNumberOfMessages => Int, MessageAttributeNames => ArrayRef[Str], VisibilityTimeout => Int, WaitTimeSeconds => Int])
Each argument is described in detail in: Paws::SQS::ReceiveMessage
Returns: a Paws::SQS::ReceiveMessageResult instance
Retrieves one or more messages, with a maximum limit of 10 messages,
from the specified queue. Long poll support is enabled by using the
C<WaitTimeSeconds> parameter. For more information, see Amazon SQS Long
Poll in the I<Amazon SQS Developer Guide>.Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response; in which case you should repeat the request.
For each message returned, the response includes the following:
Message body
MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html.
Message ID you received when you sent the message to the queue.
Receipt handle.
Message attributes.
MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.
You can provide the VisibilityTimeout parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout 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.
RemovePermission(Label => Str, QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::RemovePermission
Returns: nothing
Revokes any permissions in the queue policy that matches the specified
C<Label> parameter. Only the owner of the queue can remove permissions.SendMessage(MessageBody => Str, QueueUrl => Str, [DelaySeconds => Int, MessageAttributes => Paws::SQS::MessageAttributeMap])
Each argument is described in detail in: Paws::SQS::SendMessage
Returns: a Paws::SQS::SendMessageResult instance
Delivers a message to the specified queue. With Amazon SQS, you now
have the ability to send large payload messages that are up to 256KB
(262,144 bytes) in size. To send large payloads, you must use an AWS
SDK that supports SigV4 signing. To verify whether SigV4 is supported
for an AWS SDK, check the SDK release notes.The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/ not included in the list, your request will be rejected.
SendMessageBatch(Entries => ArrayRef[Paws::SQS::SendMessageBatchRequestEntry], QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::SendMessageBatch
Returns: a Paws::SQS::SendMessageBatchResult instance
Delivers up to ten messages to the specified queue. This is a batch
version of SendMessage. The result of the send action on each message
is reported individually in the response. The maximum allowed
individual message size is 256 KB (262,144 bytes).The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes).
If the DelaySeconds parameter is not specified for an entry, the default for the queue is used.
The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html. If you send any characters that are not included in the list, your request will be rejected.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
SetQueueAttributes(Attributes => Paws::SQS::QueueAttributeMap, QueueUrl => Str)
Each argument is described in detail in: Paws::SQS::SetQueueAttributes
Returns: nothing
Sets the value of one or more queue attributes. When you change a
queue's attributes, the change can take up to 60 seconds for most of
the attributes to propagate throughout the SQS system. Changes made to
the C<MessageRetentionPeriod> attribute can take up to 15 minutes.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.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues