R/finspacedata_service.R

In paws.storage: 'Amazon Web Services' Storage Services

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common new_handlers new_service set_config merge_config
NULL

#' FinSpace Public API
#'
#' @description
#' The FinSpace APIs let you take actions inside the FinSpace.
#'
#' @param
#' config
#' Optional configuration of credentials, endpoint, and/or region.
#' \itemize{
#' \item{\strong{credentials}:} {\itemize{
#' \item{\strong{creds}:} {\itemize{
#' \item{\strong{access_key_id}:} {AWS access key ID}
#' \item{\strong{secret_access_key}:} {AWS secret access key}
#' \item{\strong{session_token}:} {AWS temporary session token}
#' }}
#' \item{\strong{profile}:} {The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}:} {Set anonymous credentials.}
#' \item{\strong{endpoint}:} {The complete URL to use for the constructed client.}
#' \item{\strong{region}:} {The AWS Region used in instantiating the client.}
#' }}
#' \item{\strong{close_connection}:} {Immediately close all HTTP connections.}
#' \item{\strong{timeout}:} {The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.}
#' \item{\strong{s3_force_path_style}:} {Set this to `true` to force the request to use path-style addressing, i.e. `http://s3.amazonaws.com/BUCKET/KEY`.}
#' \item{\strong{sts_regional_endpoint}:} {Set sts regional endpoint resolver to regional or legacy \url{https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html}}
#' }
#' @param
#' credentials
#' Optional credentials shorthand for the config parameter
#' \itemize{
#' \item{\strong{creds}:} {\itemize{
#' \item{\strong{access_key_id}:} {AWS access key ID}
#' \item{\strong{secret_access_key}:} {AWS secret access key}
#' \item{\strong{session_token}:} {AWS temporary session token}
#' }}
#' \item{\strong{profile}:} {The name of a profile to use. If not given, then the default profile is used.}
#' \item{\strong{anonymous}:} {Set anonymous credentials.}
#' }
#' @param
#' endpoint
#' Optional shorthand for complete URL to use for the constructed client.
#' @param
#' region
#' Optional shorthand for AWS Region used in instantiating the client.
#'
#' @section Service syntax:
#' ```
#' svc <- finspacedata(
#'   config = list(
#'     credentials = list(
#'       creds = list(
#'         access_key_id = "string",
#'         secret_access_key = "string",
#'         session_token = "string"
#'       ),
#'       profile = "string",
#'       anonymous = "logical"
#'     ),
#'     endpoint = "string",
#'     region = "string",
#'     close_connection = "logical",
#'     timeout = "numeric",
#'     s3_force_path_style = "logical",
#'     sts_regional_endpoint = "string"
#'   ),
#'   credentials = list(
#'     creds = list(
#'       access_key_id = "string",
#'       secret_access_key = "string",
#'       session_token = "string"
#'     ),
#'     profile = "string",
#'     anonymous = "logical"
#'   ),
#'   endpoint = "string",
#'   region = "string"
#' )
#' ```
#'
#' @examples
#' \dontrun{
#' svc <- finspacedata()
#' svc$associate_user_to_permission_group(
#'   Foo = 123
#' )
#' }
#'
#' @section Operations:
#' \tabular{ll}{
#'  \link[=finspacedata_associate_user_to_permission_group]{associate_user_to_permission_group} \tab Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace\cr
#'  \link[=finspacedata_create_changeset]{create_changeset} \tab Creates a new Changeset in a FinSpace Dataset\cr
#'  \link[=finspacedata_create_dataset]{create_dataset} \tab Creates a new FinSpace Dataset\cr
#'  \link[=finspacedata_create_data_view]{create_data_view} \tab Creates a Dataview for a Dataset\cr
#'  \link[=finspacedata_create_permission_group]{create_permission_group} \tab Creates a group of permissions for various actions that a user can perform in FinSpace\cr
#'  \link[=finspacedata_create_user]{create_user} \tab Creates a new user in FinSpace\cr
#'  \link[=finspacedata_delete_dataset]{delete_dataset} \tab Deletes a FinSpace Dataset\cr
#'  \link[=finspacedata_delete_permission_group]{delete_permission_group} \tab Deletes a permission group\cr
#'  \link[=finspacedata_disable_user]{disable_user} \tab Denies access to the FinSpace web application and API for the specified user\cr
#'  \link[=finspacedata_disassociate_user_from_permission_group]{disassociate_user_from_permission_group} \tab Removes a user account from a permission group\cr
#'  \link[=finspacedata_enable_user]{enable_user} \tab Allows the specified user to access the FinSpace web application and API\cr
#'  \link[=finspacedata_get_changeset]{get_changeset} \tab Get information about a Changeset\cr
#'  \link[=finspacedata_get_dataset]{get_dataset} \tab Returns information about a Dataset\cr
#'  \link[=finspacedata_get_data_view]{get_data_view} \tab Gets information about a Dataview\cr
#'  \link[=finspacedata_get_external_data_view_access_details]{get_external_data_view_access_details} \tab Returns the credentials to access the external Dataview from an S3 location\cr
#'  \link[=finspacedata_get_permission_group]{get_permission_group} \tab Retrieves the details of a specific permission group\cr
#'  \link[=finspacedata_get_programmatic_access_credentials]{get_programmatic_access_credentials} \tab Request programmatic credentials to use with FinSpace SDK\cr
#'  \link[=finspacedata_get_user]{get_user} \tab Retrieves details for a specific user\cr
#'  \link[=finspacedata_get_working_location]{get_working_location} \tab A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook\cr
#'  \link[=finspacedata_list_changesets]{list_changesets} \tab Lists the FinSpace Changesets for a Dataset\cr
#'  \link[=finspacedata_list_datasets]{list_datasets} \tab Lists all of the active Datasets that a user has access to\cr
#'  \link[=finspacedata_list_data_views]{list_data_views} \tab Lists all available Dataviews for a Dataset\cr
#'  \link[=finspacedata_list_permission_groups]{list_permission_groups} \tab Lists all available permission groups in FinSpace\cr
#'  \link[=finspacedata_list_permission_groups_by_user]{list_permission_groups_by_user} \tab Lists all the permission groups that are associated with a specific user account\cr
#'  \link[=finspacedata_list_users]{list_users} \tab Lists all available user accounts in FinSpace\cr
#'  \link[=finspacedata_list_users_by_permission_group]{list_users_by_permission_group} \tab Lists details of all the users in a specific permission group\cr
#'  \link[=finspacedata_reset_user_password]{reset_user_password} \tab Resets the password for a specified user ID and generates a temporary one\cr
#'  \link[=finspacedata_update_changeset]{update_changeset} \tab Updates a FinSpace Changeset\cr
#'  \link[=finspacedata_update_dataset]{update_dataset} \tab Updates a FinSpace Dataset\cr
#'  \link[=finspacedata_update_permission_group]{update_permission_group} \tab Modifies the details of a permission group\cr
#'  \link[=finspacedata_update_user]{update_user} \tab Modifies the details of the specified user account
#' }
#'
#' @return
#' A client for the service. You can call the service's operations using
#' syntax like `svc$operation(...)`, where `svc` is the name you've assigned
#' to the client. The available operations are listed in the
#' Operations section.
#'
#' @rdname finspacedata
#' @export
finspacedata <- function(config = list(), credentials = list(), endpoint = NULL, region = NULL) {
  config <- merge_config(
    config,
    list(
      credentials = credentials,
      endpoint = endpoint,
      region = region
    )
  )
  svc <- .finspacedata$operations
  svc <- set_config(svc, config)
  return(svc)
}

# Private API objects: metadata, handlers, interfaces, etc.
.finspacedata <- list()

.finspacedata$operations <- list()

.finspacedata$metadata <- list(
  service_name = "finspacedata",
  endpoints = list("*" = list(endpoint = "finspace-api.{region}.amazonaws.com", global = FALSE), "cn-*" = list(endpoint = "finspace-api.{region}.amazonaws.com.cn", global = FALSE), "us-iso-*" = list(endpoint = "finspace-api.{region}.c2s.ic.gov", global = FALSE), "us-isob-*" = list(endpoint = "finspace-api.{region}.sc2s.sgov.gov", global = FALSE)),
  service_id = "finspace data",
  api_version = "2020-07-13",
  signing_name = "finspace-api",
  json_version = "1.1",
  target_prefix = ""
)

.finspacedata$service <- function(config = list()) {
  handlers <- new_handlers("restjson", "v4")
  new_service(.finspacedata$metadata, handlers, config)
}