R/aws.sqs-package.R

#' @name aws.sqs-package
#' @title AWS SQS Client Package
#' @description A simple client package for the Amazon Web Services (AWS) Simple Queue
#' Service (SQS) REST API.
#' @aliases aws.sqs-package aws.sqs
#' @docType package
#' @author Thomas J. Leeper <[email protected]@gmail.com>
#' @examples
#' \dontrun{
#'   # list current queues
#'   list_queues()
#'   
#'   # create a queue
#'   queue <- create_queue("ExampleQueue")
#'   get_queue_url("ExampleQueue")
#'   
#'   # send message to queue
#'   send_msg("ExampleQueue", "This is a test message")
#'   # receive a message
#'   (m <- receive_msg("ExampleQueue", timeout = 0))
#'   
#'   # delete a message from queue
#'   delete_msg("ExampleQueue", m$ReceiptHandle[1])
#'   
#'   # delete queue
#'   delete_queue("ExampleQueue")
#'   
#' }
#' @keywords package
NULL
cloudyr/aws.sqs documentation built on Aug. 16, 2018, 2:25 a.m.