kmsHTTP: Execute AWS KMS API Request

In aws.kms: 'AWS Key Management Service' Client Package

Description

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

Usage

kmsHTTP(
  action,
  query = list(),
  headers = list(),
  body = NULL,
  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
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 a KMS 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.kms documentation built on April 14, 2020, 5:16 p.m.