Skip to content

Client

finspacedata R Documentation

FinSpace Public API

Description

The FinSpace APIs let you take actions inside the FinSpace.

Usage

finspacedata(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • 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⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value

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.

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"
)

Operations

associate_user_to_permission_group Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace
create_changeset Creates a new Changeset in a FinSpace Dataset
create_dataset Creates a new FinSpace Dataset
create_data_view Creates a Dataview for a Dataset
create_permission_group Creates a group of permissions for various actions that a user can perform in FinSpace
create_user Creates a new user in FinSpace
delete_dataset Deletes a FinSpace Dataset
delete_permission_group Deletes a permission group
disable_user Denies access to the FinSpace web application and API for the specified user
disassociate_user_from_permission_group Removes a user from a permission group
enable_user Allows the specified user to access the FinSpace web application and API
get_changeset Get information about a Changeset
get_dataset Returns information about a Dataset
get_data_view Gets information about a Dataview
get_external_data_view_access_details Returns the credentials to access the external Dataview from an S3 location
get_permission_group Retrieves the details of a specific permission group
get_programmatic_access_credentials Request programmatic credentials to use with FinSpace SDK
get_user Retrieves details for a specific user
get_working_location 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
list_changesets Lists the FinSpace Changesets for a Dataset
list_datasets Lists all of the active Datasets that a user has access to
list_data_views Lists all available Dataviews for a Dataset
list_permission_groups Lists all available permission groups in FinSpace
list_permission_groups_by_user Lists all the permission groups that are associated with a specific user
list_users Lists all available users in FinSpace
list_users_by_permission_group Lists details of all the users in a specific permission group
reset_user_password Resets the password for a specified user ID and generates a temporary one
update_changeset Updates a FinSpace Changeset
update_dataset Updates a FinSpace Dataset
update_permission_group Modifies the details of a permission group
update_user Modifies the details of the specified user

Examples

## Not run: 
svc <- finspacedata()
svc$associate_user_to_permission_group(
  Foo = 123
)

## End(Not run)