Learn R Programming

aws.sqs (version 0.1.10)

get_queue_attrs: Queue Attributes

Description

Get and set queue attributes

Usage

get_queue_attrs(queue, attributes = "All", query = NULL, ...)

set_queue_attrs(queue, attributes, query = NULL, ...)

Arguments

queue

A character string containing a queue URL, or the name of the queue.

attributes

For get_queue_attrs, a vector of attribute names to return. For set_queue_attrs, a named character vector or named list of attributes and their values (as character strings). Allowed attributes are: “Policy”, “VisibilityTimeout”, “MaximumMessageSize”, “MessageRetentionPeriod”, “ApproximateNumberOfMessages”, “ApproximateNumberOfMessagesNotVisible”, “CreatedTimestamp”, “LastModifiedTimestamp”, “QueueArn”, “ApproximateNumberOfMessagesDelayed”, “DelaySeconds”, “ReceiveMessageWaitTimeSeconds”, “RedrivePolicy”.

query

A list specifying additional query arguments to be passed to the query argument of sqsHTTP.

...

Additional arguments passed to sqsHTTP.

Value

For get_queue_attrs, a data.frame list of queue attributes. Otherwise, a data structure of class “aws_error” containing any error message(s) from AWS and information about the request attempt.

For set_queue_attrs, a logical TRUE if operation was successful. Otherwise, a data structure of class “aws_error” containing any error message(s) from AWS and information about the request attempt.

Details

Get or set the attributes for a queue.

References

ReceiveMessage

See Also

link{create_queue}