Package sqs :: Module generator :: Class SQSGenerator
[hide private]
[frames] | no frames]

Class SQSGenerator

source code


Generator class

Objects of this class are used for generating authenticated URLs for accessing Amazon's SQS service.

Instance Methods [hide private]
  __init__(self, pub_key, priv_key, host=sqs.DEFAULT_HOST, port=None, secure=True)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  set_expires_in(self, expires_in)
Set relative expiration time from the url creation moment.
  set_expires(self, expires)
Set absolute expiration time.
  _auth_header_value(self, action, timestamp)
  _headers(self, headers=None, length=None)
  _params(self, params, acl=False)
  _path(self, queue=None, message=None, acl=False)
  _io_len(self, io)
  _generate(self, method, queue=None, message=None, send_io=None, params=None, headers=None, acl=False)
string create_queue(self, name, timeout=None)
Create a queue.
string list_queues(self, prefix=None)
List all queues or queues with a certan prefix.
string delete_queue(self, queue_url)
Delete a queue.
string send_message(self, queue_url, message)
Save a message into Queue.
string receave_message(self, queue_url, number=None, timeout=None)
Get message(s) from Queue.
string delete_message(self, queue_url, message_id)
Delete a message from Queue.
string peek_message(self, queue_url, message_id)
Returns a preview of the message specified in the MessageId parameter.
  set_timeout(self)
  get_timeout(self)
  add_grant(self)
  get_grant(self)
  del_grant(self)

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__


Properties [hide private]

Inherited from object: __class__


Method Details [hide private]

__init__(self, pub_key, priv_key, host=sqs.DEFAULT_HOST, port=None, secure=True)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

set_expires_in(self, expires_in)

source code 
Set relative expiration time from the url creation moment.
Parameters:
  • expires_in (int) - Relative expiration time

set_expires(self, expires)

source code 
Set absolute expiration time.
Parameters:
  • expires (time.time()) - Absolute expiration time

_auth_header_value(self, action, timestamp)

source code 
None

_headers(self, headers=None, length=None)

source code 
None

_params(self, params, acl=False)

source code 
None

_path(self, queue=None, message=None, acl=False)

source code 
None

_io_len(self, io)

source code 
None

_generate(self, method, queue=None, message=None, send_io=None, params=None, headers=None, acl=False)

source code 
None

create_queue(self, name, timeout=None)

source code 
Create a queue.
Parameters:
  • name (string) - The name to use for the Queue created. The Queue name must be unique for all queues created by the given Access Key ID.
  • timeout (int) - Default visibility timeout for this Queue. If this parameter is not included, the default value is set to 30 seconds
Returns: string
Authenticated URL for creating a new Queue.

list_queues(self, prefix=None)

source code 
List all queues or queues with a certan prefix.
Parameters:
  • prefix (string) - This parameter can be used to filter results returned. When specified, only queues with queue names beginning with the specified string are returned.
Returns: string
Authenticated URL for listing Queues.

delete_queue(self, queue_url)

source code 
Delete a queue.
Parameters:
  • queue_url (string) - Queue url
Returns: string
Authenticated URL for deleting queue

send_message(self, queue_url, message)

source code 
Save a message into Queue.
Parameters:
  • queue_url (string) - URL for the Queue in which the message should be saved
  • message (string) - Message body
Returns: string
Authenticated URL for saving message into Queue

receave_message(self, queue_url, number=None, timeout=None)

source code 
Get message(s) from Queue.
Parameters:
  • queue_url (string) - URL for the Queue from which the message should be relatived
  • number (int) - Maximum number of messages to return. If the number of messages in the queue is less than value specified by NumberOfMessages, then the number of messages returned is up to the number of messages in the queue. Not necessarily all the messages in the queue will be returned. If no value is provided, the default value of 1 is used.
  • timeout (int) - The duration, in seconds, that the messages are visible in the queue. If no value is specified, the default value for the queue is used
Returns: string
Authenticated URL for retreaving messages from Queue

delete_message(self, queue_url, message_id)

source code 
Delete a message from Queue.
Parameters:
  • queue_url (string) - URL for the Queue from which the message should be deleted
  • message_id (string) - The ID of the message to delete
Returns: string
Authenticated URL for deleting message from Queue

peek_message(self, queue_url, message_id)

source code 

Returns a preview of the message specified in the MessageId parameter.

The message is returned regardless of the VisibilityTimeout state on the queue. The visibility state is not modified when PeekMessage is used, thereby not affecting which messages get returned from a subsequent ReceiveMessage request.
Parameters:
  • queue_url (string) - URL for the Queue from which the message should be peeked
  • message_id (string) - The ID of the message to retreave
Returns: string
Authenticated URL for retreaveing a message

set_timeout(self)

source code 
None

get_timeout(self)

source code 
None

add_grant(self)

source code 
None

get_grant(self)

source code 
None

del_grant(self)

source code 
None