Awso_finspace_data_syncSourceval associate_user_to_permission_group :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.AssociateUserToPermissionGroupRequest.t ->
(Awso_finspace_data.Values.AssociateUserToPermissionGroupResponse.t,
Awso_finspace_data.Values.AssociateUserToPermissionGroupResponse.error)
Result.tval create_changeset :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.CreateChangesetRequest.t ->
(Awso_finspace_data.Values.CreateChangesetResponse.t,
Awso_finspace_data.Values.CreateChangesetResponse.error)
Result.tval create_data_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.CreateDataViewRequest.t ->
(Awso_finspace_data.Values.CreateDataViewResponse.t,
Awso_finspace_data.Values.CreateDataViewResponse.error)
Result.tval create_dataset :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.CreateDatasetRequest.t ->
(Awso_finspace_data.Values.CreateDatasetResponse.t,
Awso_finspace_data.Values.CreateDatasetResponse.error)
Result.tval create_permission_group :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.CreatePermissionGroupRequest.t ->
(Awso_finspace_data.Values.CreatePermissionGroupResponse.t,
Awso_finspace_data.Values.CreatePermissionGroupResponse.error)
Result.tval create_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.CreateUserRequest.t ->
(Awso_finspace_data.Values.CreateUserResponse.t,
Awso_finspace_data.Values.CreateUserResponse.error)
Result.tval delete_dataset :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.DeleteDatasetRequest.t ->
(Awso_finspace_data.Values.DeleteDatasetResponse.t,
Awso_finspace_data.Values.DeleteDatasetResponse.error)
Result.tval delete_permission_group :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.DeletePermissionGroupRequest.t ->
(Awso_finspace_data.Values.DeletePermissionGroupResponse.t,
Awso_finspace_data.Values.DeletePermissionGroupResponse.error)
Result.tval disable_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.DisableUserRequest.t ->
(Awso_finspace_data.Values.DisableUserResponse.t,
Awso_finspace_data.Values.DisableUserResponse.error)
Result.tval disassociate_user_from_permission_group :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.DisassociateUserFromPermissionGroupRequest.t ->
(Awso_finspace_data.Values.DisassociateUserFromPermissionGroupResponse.t,
Awso_finspace_data.Values.DisassociateUserFromPermissionGroupResponse.error)
Result.tval enable_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.EnableUserRequest.t ->
(Awso_finspace_data.Values.EnableUserResponse.t,
Awso_finspace_data.Values.EnableUserResponse.error)
Result.tval get_changeset :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetChangesetRequest.t ->
(Awso_finspace_data.Values.GetChangesetResponse.t,
Awso_finspace_data.Values.GetChangesetResponse.error)
Result.tval get_data_view :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetDataViewRequest.t ->
(Awso_finspace_data.Values.GetDataViewResponse.t,
Awso_finspace_data.Values.GetDataViewResponse.error)
Result.tval get_dataset :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetDatasetRequest.t ->
(Awso_finspace_data.Values.GetDatasetResponse.t,
Awso_finspace_data.Values.GetDatasetResponse.error)
Result.tval get_external_data_view_access_details :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetExternalDataViewAccessDetailsRequest.t ->
(Awso_finspace_data.Values.GetExternalDataViewAccessDetailsResponse.t,
Awso_finspace_data.Values.GetExternalDataViewAccessDetailsResponse.error)
Result.tval get_permission_group :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetPermissionGroupRequest.t ->
(Awso_finspace_data.Values.GetPermissionGroupResponse.t,
Awso_finspace_data.Values.GetPermissionGroupResponse.error)
Result.tval get_programmatic_access_credentials :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetProgrammaticAccessCredentialsRequest.t ->
(Awso_finspace_data.Values.GetProgrammaticAccessCredentialsResponse.t,
Awso_finspace_data.Values.GetProgrammaticAccessCredentialsResponse.error)
Result.tval get_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetUserRequest.t ->
(Awso_finspace_data.Values.GetUserResponse.t,
Awso_finspace_data.Values.GetUserResponse.error)
Result.tval get_working_location :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.GetWorkingLocationRequest.t ->
(Awso_finspace_data.Values.GetWorkingLocationResponse.t,
Awso_finspace_data.Values.GetWorkingLocationResponse.error)
Result.tval list_changesets :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ListChangesetsRequest.t ->
(Awso_finspace_data.Values.ListChangesetsResponse.t,
Awso_finspace_data.Values.ListChangesetsResponse.error)
Result.tval list_data_views :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ListDataViewsRequest.t ->
(Awso_finspace_data.Values.ListDataViewsResponse.t,
Awso_finspace_data.Values.ListDataViewsResponse.error)
Result.tval list_datasets :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ListDatasetsRequest.t ->
(Awso_finspace_data.Values.ListDatasetsResponse.t,
Awso_finspace_data.Values.ListDatasetsResponse.error)
Result.tval list_permission_groups :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ListPermissionGroupsRequest.t ->
(Awso_finspace_data.Values.ListPermissionGroupsResponse.t,
Awso_finspace_data.Values.ListPermissionGroupsResponse.error)
Result.tval list_permission_groups_by_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ListPermissionGroupsByUserRequest.t ->
(Awso_finspace_data.Values.ListPermissionGroupsByUserResponse.t,
Awso_finspace_data.Values.ListPermissionGroupsByUserResponse.error)
Result.tval list_users :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ListUsersRequest.t ->
(Awso_finspace_data.Values.ListUsersResponse.t,
Awso_finspace_data.Values.ListUsersResponse.error)
Result.tval list_users_by_permission_group :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ListUsersByPermissionGroupRequest.t ->
(Awso_finspace_data.Values.ListUsersByPermissionGroupResponse.t,
Awso_finspace_data.Values.ListUsersByPermissionGroupResponse.error)
Result.tval reset_user_password :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.ResetUserPasswordRequest.t ->
(Awso_finspace_data.Values.ResetUserPasswordResponse.t,
Awso_finspace_data.Values.ResetUserPasswordResponse.error)
Result.tval update_changeset :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.UpdateChangesetRequest.t ->
(Awso_finspace_data.Values.UpdateChangesetResponse.t,
Awso_finspace_data.Values.UpdateChangesetResponse.error)
Result.tval update_dataset :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.UpdateDatasetRequest.t ->
(Awso_finspace_data.Values.UpdateDatasetResponse.t,
Awso_finspace_data.Values.UpdateDatasetResponse.error)
Result.tval update_permission_group :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.UpdatePermissionGroupRequest.t ->
(Awso_finspace_data.Values.UpdatePermissionGroupResponse.t,
Awso_finspace_data.Values.UpdatePermissionGroupResponse.error)
Result.tval update_user :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_finspace_data.Values.UpdateUserRequest.t ->
(Awso_finspace_data.Values.UpdateUserResponse.t,
Awso_finspace_data.Values.UpdateUserResponse.error)
Result.tinclude module type of struct include Awso_finspace_data.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Column Description
Column Name
The definition of a column in a tabular Dataset.
1 - 250 character String
PhoneNumber of Dataset Owner
Definition for a schema on a tabular Dataset.
DataView Destination Type
Changeset Error Message
1 - 255 character String
1 - 250 character String
Milliseconds since UTC epoch
module PermissionGroupMembershipStatus =
Awso_finspace_data.Values.PermissionGroupMembershipStatusArn of a Dataset
Description of a dataset
ID for a given Dataset
A structure for Dataset owner info.
Title for a given Dataset
A union of schema types.
Common Boolean data type
Arn of a DataView
module DataViewDestinationTypeParams =
Awso_finspace_data.Values.DataViewDestinationTypeParamsStructure for the Dataview destination type parameters.
The structure with error messages.
DataView ID
Arn for a given Changeset
The structure with error messages.
ID used to identify a Changeset
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.
The details of the user.
The structure of a user associated with a permission group.
The structure for a permission group.
The structure of a permission group associated with a user.
The structure for a Dataset.
Structure for the summary of a Dataview.
A Changeset is unit of data in a Dataset.
You do not have sufficient access to perform this action.
The request conflicts with an existing resource.
The request processing has failed because of an unknown error, exception or failure.
One or more resources can't be found.
The request was denied due to request throttling.
The input fails to satisfy the constraints specified by an AWS service.
Idempotence Token for API operations
Short term API credentials.
The credentials required to access the external Dataview from the S3 location.
The location of an external Dataview in an S3 bucket.
A limit has exceeded.
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"} ] }
Modifies the details of the specified user. You cannot update the userId for a user.
Modifies the details of the specified user. You cannot update the userId for a user.
module UpdatePermissionGroupResponse =
Awso_finspace_data.Values.UpdatePermissionGroupResponseModifies the details of a permission group. You cannot modify a permissionGroupID.
Modifies the details of a permission group. You cannot modify a permissionGroupID.
The response from an UpdateDataset operation
The request for an UpdateDataset operation
The response from a update changeset operation.
Request to update an existing changeset.
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.
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.
Lists all available users in FinSpace.
Lists all available users in FinSpace.
module ListUsersByPermissionGroupResponse =
Awso_finspace_data.Values.ListUsersByPermissionGroupResponseLists details of all the users in a specific permission group.
module ListUsersByPermissionGroupRequest =
Awso_finspace_data.Values.ListUsersByPermissionGroupRequestLists details of all the users in a specific permission group.
Lists all available permission groups in FinSpace.
Lists all available permission groups in FinSpace.
module ListPermissionGroupsByUserResponse =
Awso_finspace_data.Values.ListPermissionGroupsByUserResponseLists all the permission groups that are associated with a specific user.
module ListPermissionGroupsByUserRequest =
Awso_finspace_data.Values.ListPermissionGroupsByUserRequestLists all the permission groups that are associated with a specific user.
Response for the ListDatasets operation
Request for the ListDatasets operation.
Lists all available Dataviews for a Dataset.
Request for a list data views.
Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
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.
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.
Retrieves details for a specific user.
Retrieves details for a specific user.
module GetProgrammaticAccessCredentialsResponse =
Awso_finspace_data.Values.GetProgrammaticAccessCredentialsResponseResponse for GetProgrammaticAccessCredentials operation
module GetProgrammaticAccessCredentialsRequest =
Awso_finspace_data.Values.GetProgrammaticAccessCredentialsRequestRequest for GetProgrammaticAccessCredentials operation
Retrieves the details of a specific permission group.
Retrieves the details of a specific permission group.
module GetExternalDataViewAccessDetailsResponse =
Awso_finspace_data.Values.GetExternalDataViewAccessDetailsResponseReturns 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.
module GetExternalDataViewAccessDetailsRequest =
Awso_finspace_data.Values.GetExternalDataViewAccessDetailsRequestReturns 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.
Response for the GetDataset operation
Request for the GetDataset operation.
Response from retrieving a dataview, which includes details on the target database and table name
Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.
The response from a describe changeset operation
Request to describe a changeset.
Allows the specified user to access the FinSpace web application and API.
Allows the specified user to access the FinSpace web application and API.
module DisassociateUserFromPermissionGroupResponse =
Awso_finspace_data.Values.DisassociateUserFromPermissionGroupResponseRemoves a user from a permission group.
module DisassociateUserFromPermissionGroupRequest =
Awso_finspace_data.Values.DisassociateUserFromPermissionGroupRequestRemoves a user from a permission group.
Denies access to the FinSpace web application and API for the specified user.
Denies access to the FinSpace web application and API for the specified user.
module DeletePermissionGroupResponse =
Awso_finspace_data.Values.DeletePermissionGroupResponseDeletes a permission group. This action is irreversible.
Deletes a permission group. This action is irreversible.
The response from an DeleteDataset operation
The request for a DeleteDataset operation.
Creates a new user in FinSpace.
Creates a new user in FinSpace.
module CreatePermissionGroupResponse =
Awso_finspace_data.Values.CreatePermissionGroupResponseCreates 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.
The response from a CreateDataset operation
The request for a CreateDataset operation
Response for creating a data view.
Request for creating a data view.
The response from a CreateChangeset operation.
The request for a CreateChangeset operation.
module AssociateUserToPermissionGroupResponse =
Awso_finspace_data.Values.AssociateUserToPermissionGroupResponseAdds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
module AssociateUserToPermissionGroupRequest =
Awso_finspace_data.Values.AssociateUserToPermissionGroupRequestAdds a user to a permission group to grant permissions for actions a user can perform in FinSpace.