Module Awso_finspace_data.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule ColumnDataType : sig ... end
Sourcemodule ColumnDescription : sig ... end

Column Description

Sourcemodule ColumnName : sig ... end

Column Name

Sourcemodule ColumnDefinition : sig ... end

The definition of a column in a tabular Dataset.

Sourcemodule ColumnList : sig ... end
Sourcemodule ColumnNameList : sig ... end
Sourcemodule StringMapKey : sig ... end
Sourcemodule StringMapValue : sig ... end
Sourcemodule ApplicationPermission : sig ... end
Sourcemodule Email : sig ... end
Sourcemodule OwnerName : sig ... end

1 - 250 character String

Sourcemodule PhoneNumber : sig ... end

PhoneNumber of Dataset Owner

Sourcemodule SchemaDefinition : sig ... end

Definition for a schema on a tabular Dataset.

Sourcemodule DataViewDestinationType : sig ... end

DataView Destination Type

Sourcemodule ExportFileFormat : sig ... end
Sourcemodule ErrorCategory : sig ... end
Sourcemodule ErrorMessage : sig ... end

Changeset Error Message

Sourcemodule StringValueLength1to255 : sig ... end

1 - 255 character String

Sourcemodule StringValueLength1to250 : sig ... end

1 - 250 character String

Sourcemodule ApiAccess : sig ... end
Sourcemodule FirstName : sig ... end
Sourcemodule LastName : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule TimestampEpoch : sig ... end

Milliseconds since UTC epoch

Sourcemodule UserId : sig ... end
Sourcemodule UserStatus : sig ... end
Sourcemodule UserType : sig ... end
Sourcemodule ApplicationPermissionList : sig ... end
Sourcemodule PermissionGroupId : sig ... end
Sourcemodule PermissionGroupName : sig ... end
Sourcemodule AliasString : sig ... end
Sourcemodule DatasetArn : sig ... end

Arn of a Dataset

Sourcemodule DatasetDescription : sig ... end

Description of a dataset

Sourcemodule DatasetId : sig ... end

ID for a given Dataset

Sourcemodule DatasetKind : sig ... end
Sourcemodule DatasetOwnerInfo : sig ... end

A structure for Dataset owner info.

Sourcemodule DatasetTitle : sig ... end

Title for a given Dataset

Sourcemodule SchemaUnion : sig ... end

A union of schema types.

Sourcemodule Boolean : sig ... end

Common Boolean data type

Sourcemodule DataViewArn : sig ... end

Arn of a DataView

Structure for the Dataview destination type parameters.

Sourcemodule DataViewErrorInfo : sig ... end

The structure with error messages.

Sourcemodule DataViewId : sig ... end

DataView ID

Sourcemodule DataViewStatus : sig ... end
Sourcemodule PartitionColumnList : sig ... end
Sourcemodule SortColumnList : sig ... end
Sourcemodule ChangeType : sig ... end
Sourcemodule ChangesetArn : sig ... end

Arn for a given Changeset

Sourcemodule ChangesetErrorInfo : sig ... end

The structure with error messages.

Sourcemodule ChangesetId : sig ... end

ID used to identify a Changeset

Sourcemodule FormatParams : sig ... end
Sourcemodule IngestionStatus : sig ... end
Sourcemodule SourceParams : sig ... end
Sourcemodule ResourcePermission : sig ... end

Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets. The following is a list of valid dataset permissions that you can apply: ViewDatasetDetails ReadDatasetDetails AddDatasetData CreateDataView EditDatasetMetadata DeleteDataset For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

Sourcemodule User : sig ... end

The details of the user.

Sourcemodule UserByPermissionGroup : sig ... end

The structure of a user associated with a permission group.

Sourcemodule PermissionGroup : sig ... end

The structure for a permission group.

Sourcemodule PermissionGroupByUser : sig ... end

The structure of a permission group associated with a user.

Sourcemodule Dataset : sig ... end

The structure for a Dataset.

Sourcemodule DataViewSummary : sig ... end

Structure for the summary of a Dataview.

Sourcemodule ChangesetSummary : sig ... end

A Changeset is unit of data in a Dataset.

Sourcemodule StringValueMaxLength1000 : sig ... end
Sourcemodule AccessKeyId : sig ... end
Sourcemodule SecretAccessKey : sig ... end
Sourcemodule SessionToken : sig ... end
Sourcemodule S3BucketName : sig ... end
Sourcemodule S3Key : sig ... end
Sourcemodule ResourcePermissionsList : sig ... end
Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule ConflictException : sig ... end

The request conflicts with an existing resource.

Sourcemodule InternalServerException : sig ... end

The request processing has failed because of an unknown error, exception or failure.

Sourcemodule ResourceNotFoundException : sig ... end

One or more resources can't be found.

Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

The input fails to satisfy the constraints specified by an AWS service.

Sourcemodule ClientToken : sig ... end

Idempotence Token for API operations

Sourcemodule Password : sig ... end
Sourcemodule PaginationToken : sig ... end
Sourcemodule UserList : sig ... end
Sourcemodule ResultLimit : sig ... end
Sourcemodule UserByPermissionGroupList : sig ... end
Sourcemodule PermissionGroupList : sig ... end
Sourcemodule PermissionGroupByUserList : sig ... end
Sourcemodule DatasetList : sig ... end
Sourcemodule DataViewList : sig ... end
Sourcemodule ChangesetList : sig ... end
Sourcemodule StringValueLength1to1024 : sig ... end
Sourcemodule StringValueLength1to63 : sig ... end
Sourcemodule LocationType : sig ... end
Sourcemodule Credentials : sig ... end

Short term API credentials.

Sourcemodule SessionDuration : sig ... end
Sourcemodule IdType : sig ... end
Sourcemodule AwsCredentials : sig ... end

The credentials required to access the external Dataview from the S3 location.

Sourcemodule S3Location : sig ... end

The location of an external Dataview in an S3 bucket.

Sourcemodule DatasetStatus : sig ... end
Sourcemodule LimitExceededException : sig ... end

A limit has exceeded.

Sourcemodule StatusCode : sig ... end
Sourcemodule PermissionGroupParams : sig ... end

Permission group parameters for Dataset permissions. Here is an example of how you could specify the PermissionGroupParams: { "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ {"permission": "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, {"permission": "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] }

Sourcemodule UpdateUserResponse : sig ... end

Modifies the details of the specified user. You cannot update the userId for a user.

Sourcemodule UpdateUserRequest : sig ... end

Modifies the details of the specified user. You cannot update the userId for a user.

Modifies the details of a permission group. You cannot modify a permissionGroupID.

Modifies the details of a permission group. You cannot modify a permissionGroupID.

Sourcemodule UpdateDatasetResponse : sig ... end

The response from an UpdateDataset operation

Sourcemodule UpdateDatasetRequest : sig ... end

The request for an UpdateDataset operation

Sourcemodule UpdateChangesetResponse : sig ... end

The response from a update changeset operation.

Sourcemodule UpdateChangesetRequest : sig ... end

Request to update an existing changeset.

Sourcemodule ResetUserPasswordResponse : sig ... end

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

Sourcemodule ResetUserPasswordRequest : sig ... end

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

Sourcemodule ListUsersResponse : sig ... end

Lists all available users in FinSpace.

Sourcemodule ListUsersRequest : sig ... end

Lists all available users in FinSpace.

Lists details of all the users in a specific permission group.

Lists details of all the users in a specific permission group.

Lists all available permission groups in FinSpace.

Lists all available permission groups in FinSpace.

Lists all the permission groups that are associated with a specific user.

Lists all the permission groups that are associated with a specific user.

Sourcemodule ListDatasetsResponse : sig ... end

Response for the ListDatasets operation

Sourcemodule ListDatasetsRequest : sig ... end

Request for the ListDatasets operation.

Sourcemodule ListDataViewsResponse : sig ... end

Lists all available Dataviews for a Dataset.

Sourcemodule ListDataViewsRequest : sig ... end

Request for a list data views.

Sourcemodule ListChangesetsResponse : sig ... end

Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.

Sourcemodule ListChangesetsRequest : sig ... end

Request to ListChangesetsRequest. It exposes minimal query filters.

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.

Sourcemodule GetWorkingLocationRequest : sig ... end

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.

Sourcemodule GetUserResponse : sig ... end

Retrieves details for a specific user.

Sourcemodule GetUserRequest : sig ... end

Retrieves details for a specific user.

Response for GetProgrammaticAccessCredentials operation

Request for GetProgrammaticAccessCredentials operation

Retrieves the details of a specific permission group.

Sourcemodule GetPermissionGroupRequest : sig ... end

Retrieves the details of a specific permission group.

Returns the credentials to access the external Dataview from an S3 location. To call this API: You must retrieve the programmatic credentials. You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

Returns the credentials to access the external Dataview from an S3 location. To call this API: You must retrieve the programmatic credentials. You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

Sourcemodule GetDatasetResponse : sig ... end

Response for the GetDataset operation

Sourcemodule GetDatasetRequest : sig ... end

Request for the GetDataset operation.

Sourcemodule GetDataViewResponse : sig ... end

Response from retrieving a dataview, which includes details on the target database and table name

Sourcemodule GetDataViewRequest : sig ... end

Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.

Sourcemodule GetChangesetResponse : sig ... end

The response from a describe changeset operation

Sourcemodule GetChangesetRequest : sig ... end

Request to describe a changeset.

Sourcemodule EnableUserResponse : sig ... end

Allows the specified user to access the FinSpace web application and API.

Sourcemodule EnableUserRequest : sig ... end

Allows the specified user to access the FinSpace web application and API.

Removes a user from a permission group.

Removes a user from a permission group.

Sourcemodule DisableUserResponse : sig ... end

Denies access to the FinSpace web application and API for the specified user.

Sourcemodule DisableUserRequest : sig ... end

Denies access to the FinSpace web application and API for the specified user.

Deletes a permission group. This action is irreversible.

Deletes a permission group. This action is irreversible.

Sourcemodule DeleteDatasetResponse : sig ... end

The response from an DeleteDataset operation

Sourcemodule DeleteDatasetRequest : sig ... end

The request for a DeleteDataset operation.

Sourcemodule CreateUserResponse : sig ... end

Creates a new user in FinSpace.

Sourcemodule CreateUserRequest : sig ... end

Creates a new user in FinSpace.

Creates a group of permissions for various actions that a user can perform in FinSpace.

Creates a group of permissions for various actions that a user can perform in FinSpace.

Sourcemodule CreateDatasetResponse : sig ... end

The response from a CreateDataset operation

Sourcemodule CreateDatasetRequest : sig ... end

The request for a CreateDataset operation

Sourcemodule CreateDataViewResponse : sig ... end

Response for creating a data view.

Sourcemodule CreateDataViewRequest : sig ... end

Request for creating a data view.

Sourcemodule CreateChangesetResponse : sig ... end

The response from a CreateChangeset operation.

Sourcemodule CreateChangesetRequest : sig ... end

The request for a CreateChangeset operation.

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.