@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSFinSpaceDataAsync extends AWSFinSpaceData
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSFinSpaceDataAsync instead.
The FinSpace APIs let you take actions inside the FinSpace.
ENDPOINT_PREFIXassociateUserToPermissionGroup, createChangeset, createDataset, createDataView, createPermissionGroup, createUser, deleteDataset, deletePermissionGroup, disableUser, disassociateUserFromPermissionGroup, enableUser, getCachedResponseMetadata, getChangeset, getDataset, getDataView, getExternalDataViewAccessDetails, getPermissionGroup, getProgrammaticAccessCredentials, getUser, getWorkingLocation, listChangesets, listDatasets, listDataViews, listPermissionGroups, listPermissionGroupsByUser, listUsers, listUsersByPermissionGroup, resetUserPassword, shutdown, updateChangeset, updateDataset, updatePermissionGroup, updateUserFuture<AssociateUserToPermissionGroupResult> associateUserToPermissionGroupAsync(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest)
Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
associateUserToPermissionGroupRequest - Future<AssociateUserToPermissionGroupResult> associateUserToPermissionGroupAsync(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest, AsyncHandler<AssociateUserToPermissionGroupRequest,AssociateUserToPermissionGroupResult> asyncHandler)
Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
associateUserToPermissionGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateChangesetResult> createChangesetAsync(CreateChangesetRequest createChangesetRequest)
Creates a new Changeset in a FinSpace Dataset.
createChangesetRequest - The request for a CreateChangeset operation.Future<CreateChangesetResult> createChangesetAsync(CreateChangesetRequest createChangesetRequest, AsyncHandler<CreateChangesetRequest,CreateChangesetResult> asyncHandler)
Creates a new Changeset in a FinSpace Dataset.
createChangesetRequest - The request for a CreateChangeset operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDataViewResult> createDataViewAsync(CreateDataViewRequest createDataViewRequest)
Creates a Dataview for a Dataset.
createDataViewRequest - Request for creating a data view.Future<CreateDataViewResult> createDataViewAsync(CreateDataViewRequest createDataViewRequest, AsyncHandler<CreateDataViewRequest,CreateDataViewResult> asyncHandler)
Creates a Dataview for a Dataset.
createDataViewRequest - Request for creating a data view.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest createDatasetRequest)
Creates a new FinSpace Dataset.
createDatasetRequest - The request for a CreateDataset operationFuture<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest createDatasetRequest, AsyncHandler<CreateDatasetRequest,CreateDatasetResult> asyncHandler)
Creates a new FinSpace Dataset.
createDatasetRequest - The request for a CreateDataset operationasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePermissionGroupResult> createPermissionGroupAsync(CreatePermissionGroupRequest createPermissionGroupRequest)
Creates a group of permissions for various actions that a user can perform in FinSpace.
createPermissionGroupRequest - Future<CreatePermissionGroupResult> createPermissionGroupAsync(CreatePermissionGroupRequest createPermissionGroupRequest, AsyncHandler<CreatePermissionGroupRequest,CreatePermissionGroupResult> asyncHandler)
Creates a group of permissions for various actions that a user can perform in FinSpace.
createPermissionGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest)
Creates a new user in FinSpace.
createUserRequest - Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
Creates a new user in FinSpace.
createUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest)
Deletes a FinSpace Dataset.
deleteDatasetRequest - The request for a DeleteDataset operation.Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
Deletes a FinSpace Dataset.
deleteDatasetRequest - The request for a DeleteDataset operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePermissionGroupResult> deletePermissionGroupAsync(DeletePermissionGroupRequest deletePermissionGroupRequest)
Deletes a permission group. This action is irreversible.
deletePermissionGroupRequest - Future<DeletePermissionGroupResult> deletePermissionGroupAsync(DeletePermissionGroupRequest deletePermissionGroupRequest, AsyncHandler<DeletePermissionGroupRequest,DeletePermissionGroupResult> asyncHandler)
Deletes a permission group. This action is irreversible.
deletePermissionGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisableUserResult> disableUserAsync(DisableUserRequest disableUserRequest)
Denies access to the FinSpace web application and API for the specified user.
disableUserRequest - Future<DisableUserResult> disableUserAsync(DisableUserRequest disableUserRequest, AsyncHandler<DisableUserRequest,DisableUserResult> asyncHandler)
Denies access to the FinSpace web application and API for the specified user.
disableUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateUserFromPermissionGroupResult> disassociateUserFromPermissionGroupAsync(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest)
Removes a user account from a permission group.
disassociateUserFromPermissionGroupRequest - Future<DisassociateUserFromPermissionGroupResult> disassociateUserFromPermissionGroupAsync(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest, AsyncHandler<DisassociateUserFromPermissionGroupRequest,DisassociateUserFromPermissionGroupResult> asyncHandler)
Removes a user account from a permission group.
disassociateUserFromPermissionGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EnableUserResult> enableUserAsync(EnableUserRequest enableUserRequest)
Allows the specified user to access the FinSpace web application and API.
enableUserRequest - Future<EnableUserResult> enableUserAsync(EnableUserRequest enableUserRequest, AsyncHandler<EnableUserRequest,EnableUserResult> asyncHandler)
Allows the specified user to access the FinSpace web application and API.
enableUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetChangesetResult> getChangesetAsync(GetChangesetRequest getChangesetRequest)
Get information about a Changeset.
getChangesetRequest - Request to describe a changeset.Future<GetChangesetResult> getChangesetAsync(GetChangesetRequest getChangesetRequest, AsyncHandler<GetChangesetRequest,GetChangesetResult> asyncHandler)
Get information about a Changeset.
getChangesetRequest - Request to describe a changeset.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDataViewResult> getDataViewAsync(GetDataViewRequest getDataViewRequest)
Gets information about a Dataview.
getDataViewRequest - Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.Future<GetDataViewResult> getDataViewAsync(GetDataViewRequest getDataViewRequest, AsyncHandler<GetDataViewRequest,GetDataViewResult> asyncHandler)
Gets information about a Dataview.
getDataViewRequest - Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDatasetResult> getDatasetAsync(GetDatasetRequest getDatasetRequest)
Returns information about a Dataset.
getDatasetRequest - Request for the GetDataset operation.Future<GetDatasetResult> getDatasetAsync(GetDatasetRequest getDatasetRequest, AsyncHandler<GetDatasetRequest,GetDatasetResult> asyncHandler)
Returns information about a Dataset.
getDatasetRequest - Request for the GetDataset operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetExternalDataViewAccessDetailsResult> getExternalDataViewAccessDetailsAsync(GetExternalDataViewAccessDetailsRequest getExternalDataViewAccessDetailsRequest)
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.
getExternalDataViewAccessDetailsRequest - Future<GetExternalDataViewAccessDetailsResult> getExternalDataViewAccessDetailsAsync(GetExternalDataViewAccessDetailsRequest getExternalDataViewAccessDetailsRequest, AsyncHandler<GetExternalDataViewAccessDetailsRequest,GetExternalDataViewAccessDetailsResult> asyncHandler)
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.
getExternalDataViewAccessDetailsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPermissionGroupResult> getPermissionGroupAsync(GetPermissionGroupRequest getPermissionGroupRequest)
Retrieves the details of a specific permission group.
getPermissionGroupRequest - Future<GetPermissionGroupResult> getPermissionGroupAsync(GetPermissionGroupRequest getPermissionGroupRequest, AsyncHandler<GetPermissionGroupRequest,GetPermissionGroupResult> asyncHandler)
Retrieves the details of a specific permission group.
getPermissionGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetProgrammaticAccessCredentialsResult> getProgrammaticAccessCredentialsAsync(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest)
Request programmatic credentials to use with FinSpace SDK.
getProgrammaticAccessCredentialsRequest - Request for GetProgrammaticAccessCredentials operationFuture<GetProgrammaticAccessCredentialsResult> getProgrammaticAccessCredentialsAsync(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest, AsyncHandler<GetProgrammaticAccessCredentialsRequest,GetProgrammaticAccessCredentialsResult> asyncHandler)
Request programmatic credentials to use with FinSpace SDK.
getProgrammaticAccessCredentialsRequest - Request for GetProgrammaticAccessCredentials operationasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest)
Retrieves details for a specific user.
getUserRequest - Future<GetUserResult> getUserAsync(GetUserRequest getUserRequest, AsyncHandler<GetUserRequest,GetUserResult> asyncHandler)
Retrieves details for a specific user.
getUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetWorkingLocationResult> getWorkingLocationAsync(GetWorkingLocationRequest getWorkingLocationRequest)
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.
getWorkingLocationRequest - Future<GetWorkingLocationResult> getWorkingLocationAsync(GetWorkingLocationRequest getWorkingLocationRequest, AsyncHandler<GetWorkingLocationRequest,GetWorkingLocationResult> asyncHandler)
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.
getWorkingLocationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListChangesetsResult> listChangesetsAsync(ListChangesetsRequest listChangesetsRequest)
Lists the FinSpace Changesets for a Dataset.
listChangesetsRequest - Request to ListChangesetsRequest. It exposes minimal query filters.Future<ListChangesetsResult> listChangesetsAsync(ListChangesetsRequest listChangesetsRequest, AsyncHandler<ListChangesetsRequest,ListChangesetsResult> asyncHandler)
Lists the FinSpace Changesets for a Dataset.
listChangesetsRequest - Request to ListChangesetsRequest. It exposes minimal query filters.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDataViewsResult> listDataViewsAsync(ListDataViewsRequest listDataViewsRequest)
Lists all available Dataviews for a Dataset.
listDataViewsRequest - Request for a list data views.Future<ListDataViewsResult> listDataViewsAsync(ListDataViewsRequest listDataViewsRequest, AsyncHandler<ListDataViewsRequest,ListDataViewsResult> asyncHandler)
Lists all available Dataviews for a Dataset.
listDataViewsRequest - Request for a list data views.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest)
Lists all of the active Datasets that a user has access to.
listDatasetsRequest - Request for the ListDatasets operation.Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
Lists all of the active Datasets that a user has access to.
listDatasetsRequest - Request for the ListDatasets operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPermissionGroupsResult> listPermissionGroupsAsync(ListPermissionGroupsRequest listPermissionGroupsRequest)
Lists all available permission groups in FinSpace.
listPermissionGroupsRequest - Future<ListPermissionGroupsResult> listPermissionGroupsAsync(ListPermissionGroupsRequest listPermissionGroupsRequest, AsyncHandler<ListPermissionGroupsRequest,ListPermissionGroupsResult> asyncHandler)
Lists all available permission groups in FinSpace.
listPermissionGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPermissionGroupsByUserResult> listPermissionGroupsByUserAsync(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest)
Lists all the permission groups that are associated with a specific user account.
listPermissionGroupsByUserRequest - Future<ListPermissionGroupsByUserResult> listPermissionGroupsByUserAsync(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest, AsyncHandler<ListPermissionGroupsByUserRequest,ListPermissionGroupsByUserResult> asyncHandler)
Lists all the permission groups that are associated with a specific user account.
listPermissionGroupsByUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Lists all available user accounts in FinSpace.
listUsersRequest - Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Lists all available user accounts in FinSpace.
listUsersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListUsersByPermissionGroupResult> listUsersByPermissionGroupAsync(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest)
Lists details of all the users in a specific permission group.
listUsersByPermissionGroupRequest - Future<ListUsersByPermissionGroupResult> listUsersByPermissionGroupAsync(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest, AsyncHandler<ListUsersByPermissionGroupRequest,ListUsersByPermissionGroupResult> asyncHandler)
Lists details of all the users in a specific permission group.
listUsersByPermissionGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResetUserPasswordResult> resetUserPasswordAsync(ResetUserPasswordRequest resetUserPasswordRequest)
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.
resetUserPasswordRequest - Future<ResetUserPasswordResult> resetUserPasswordAsync(ResetUserPasswordRequest resetUserPasswordRequest, AsyncHandler<ResetUserPasswordRequest,ResetUserPasswordResult> asyncHandler)
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.
resetUserPasswordRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateChangesetResult> updateChangesetAsync(UpdateChangesetRequest updateChangesetRequest)
Updates a FinSpace Changeset.
updateChangesetRequest - Request to update an existing changeset.Future<UpdateChangesetResult> updateChangesetAsync(UpdateChangesetRequest updateChangesetRequest, AsyncHandler<UpdateChangesetRequest,UpdateChangesetResult> asyncHandler)
Updates a FinSpace Changeset.
updateChangesetRequest - Request to update an existing changeset.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDatasetResult> updateDatasetAsync(UpdateDatasetRequest updateDatasetRequest)
Updates a FinSpace Dataset.
updateDatasetRequest - The request for an UpdateDataset operationFuture<UpdateDatasetResult> updateDatasetAsync(UpdateDatasetRequest updateDatasetRequest, AsyncHandler<UpdateDatasetRequest,UpdateDatasetResult> asyncHandler)
Updates a FinSpace Dataset.
updateDatasetRequest - The request for an UpdateDataset operationasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePermissionGroupResult> updatePermissionGroupAsync(UpdatePermissionGroupRequest updatePermissionGroupRequest)
Modifies the details of a permission group. You cannot modify a permissionGroupID.
updatePermissionGroupRequest - Future<UpdatePermissionGroupResult> updatePermissionGroupAsync(UpdatePermissionGroupRequest updatePermissionGroupRequest, AsyncHandler<UpdatePermissionGroupRequest,UpdatePermissionGroupResult> asyncHandler)
Modifies the details of a permission group. You cannot modify a permissionGroupID.
updatePermissionGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
Modifies the details of the specified user account. You cannot update the userId for a user.
updateUserRequest - Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Modifies the details of the specified user account. You cannot update the userId for a user.
updateUserRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.