transcribeHTTP: Execute AWS Transcribe API Request

Description Usage Arguments Details Value Author(s)

View source: R/transcribeHTTP.R

Description

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

Usage

1
2
transcribeHTTP(action, query = list(), body = NULL, version = "v1",
  region = NULL, key = NULL, secret = NULL, session_token = NULL, ...)

Arguments

action

A character string specifying an API endpoint.

query

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

body

A request body

version

A character string specifying the API version.

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. The default is pulled from environment variable “AWS_ACCESS_KEY_ID”.

secret

A character string containing an AWS Secret Access Key. The default is pulled from environment variable “AWS_SECRET_ACCESS_KEY”.

session_token

Optionally, a character string containing an AWS temporary Session Token. If missing, defaults to value stored in environment variable “AWS_SESSION_TOKEN”.

...

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.transcribe documentation built on April 9, 2018, 5:04 p.m.