ec2HTTP: EC2 API Requests

Description Usage Arguments Value

View source: R/ec2HTTP.R

Description

Internal workhorse function to execute an EC2 API Request

Usage

1
2
3
4
5
ec2HTTP(query = list(), headers = list(), dryrun = FALSE,
  verbose = getOption("verbose", FALSE),
  region = Sys.getenv("AWS_DEFAULT_REGION", "us-east-1"), key = NULL,
  secret = NULL, session_token = NULL, version = "2016-11-15",
  clean_response = TRUE, ...)

Arguments

query

A named list of query string parameters.

headers

A list of headers to pass to the HTTP request.

dryrun

An optional logical specifying whether to execute a consequence-free “dry run” of the request.

verbose

A logical indicating whether to be verbose. Default is given by options("verbose").

region

A character string specifying an AWS region. See aws.signature::locate_credentials().

key

A character string specifying an AWS Access Key. See aws.signature::locate_credentials().

secret

A character string specifying an AWS Secret Key. See aws.signature::locate_credentials().

session_token

Optionally, a character string specifying an AWS temporary Session Token to use in signing a request. See aws.signature::locate_credentials().

version

A character string specifying an API version. Default is “2016-11-15”.

clean_response

A logical indicating whether to remove line breaks from the response. This is useful for returning a clean response object, but may not be appropriate if the XML-formatted API response contains meaningful linebreaks (e.g., in a keypair).

...

Additional arguments passed to httr::GET().

Value

A list


HanjoStudy/awsR documentation built on May 6, 2019, 9:06 a.m.