Learn R Programming
aws.sqs (version 0.1.10)

sqsHTTP: Execute SQS API Request

Description

This is the workhorse function to execute calls to the SQS API.

Usage

sqsHTTP(url = NULL, query = list(),
  region = Sys.getenv("AWS_DEFAULT_REGION", "us-east-1"), key = NULL,
  secret = NULL, session_token = NULL, ...)

Arguments

url

A character string containing an SQS API endpoint URL.

query

An optional named list containing query string parameters and their character values.

region

A character string containing an AWS region. If missing, the default “us-east-1” is used.

key

A character string containing an AWS Access Key ID. See locate_credentials.

secret

A character string containing an AWS Secret Access Key. See locate_credentials.

session_token

Optionally, a character string containing an AWS temporary Session Token. See locate_credentials.

...

Additional arguments passed to GET.

Value

If successful, a named list. Otherwise, a data structure of class “aws_error” containing any error message(s) from AWS and information about the request attempt.

Details

This function constructs and signs an SQS API request and returns the results thereof, or relevant debugging information in the case of error.