pollyHTTP: Execute AWS Polly API Request

In aws.polly: Client for AWS Polly

Description

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

Usage

pollyHTTP(
  action,
  query = list(),
  headers = list(),
  body = NULL,
  verb = c("GET", "POST", "PUT", "DELETE"),
  version = "v1",
  raw_response = if (verb == "POST") TRUE else FALSE,
  verbose = getOption("verbose", FALSE),
  region = Sys.getenv("AWS_DEFAULT_REGION", "us-east-1"),
  key = NULL,
  secret = NULL,
  session_token = NULL,
  ...
)

Arguments

action	A character string specifying the API action to take
query	An optional named list containing query string parameters and their character values.
headers	A list of headers to pass to the HTTP request.
body	A request body
verb	A character string specifying the HTTP verb to implement.
version	A character string specifying the API version.
raw_response	A logical indicating whether to return the raw response body.
verbose	A logical indicating whether to be verbose. Default is given by options("verbose").
region	A character string specifying an AWS region. See locate_credentials.
key	A character string specifying an AWS Access Key. See locate_credentials.
secret	A character string specifying an AWS Secret Key. See locate_credentials.
session_token	Optionally, a character string specifying an AWS temporary Session Token to use in signing a request. See locate_credentials.
...	Additional arguments passed to GET.

Details

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

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.

Author(s)

Thomas J. Leeper

aws.polly documentation built on April 14, 2020, 7:37 p.m.