finspacedata/aws.sdk.kotlin.services.finspacedata

Package-level declarations

Types

FinspaceDataClient

interface FinspaceDataClient : SdkClient

The FinSpace APIs let you take actions inside the FinSpace.

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Functions

associateUserToPermissionGroup

inline suspend fun FinspaceDataClient.~~associateUserToPermissionGroup~~(crossinline block: AssociateUserToPermissionGroupRequest.Builder.() -> Unit): AssociateUserToPermissionGroupResponse

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

createChangeset

inline suspend fun FinspaceDataClient.~~createChangeset~~(crossinline block: CreateChangesetRequest.Builder.() -> Unit): CreateChangesetResponse

Creates a new Changeset in a FinSpace Dataset.

inline suspend fun FinspaceDataClient.~~createDataset~~(crossinline block: CreateDatasetRequest.Builder.() -> Unit): CreateDatasetResponse

Creates a new FinSpace Dataset.

inline suspend fun FinspaceDataClient.~~createDataView~~(crossinline block: CreateDataViewRequest.Builder.() -> Unit): CreateDataViewResponse

Creates a Dataview for a Dataset.

createPermissionGroup

inline suspend fun FinspaceDataClient.~~createPermissionGroup~~(crossinline block: CreatePermissionGroupRequest.Builder.() -> Unit): CreatePermissionGroupResponse

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

inline suspend fun FinspaceDataClient.~~createUser~~(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates a new user in FinSpace.

inline suspend fun FinspaceDataClient.~~deleteDataset~~(crossinline block: DeleteDatasetRequest.Builder.() -> Unit): DeleteDatasetResponse

Deletes a FinSpace Dataset.

deletePermissionGroup

inline suspend fun FinspaceDataClient.~~deletePermissionGroup~~(crossinline block: DeletePermissionGroupRequest.Builder.() -> Unit): DeletePermissionGroupResponse

Deletes a permission group. This action is irreversible.

inline suspend fun FinspaceDataClient.~~disableUser~~(crossinline block: DisableUserRequest.Builder.() -> Unit): DisableUserResponse

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

disassociateUserFromPermissionGroup

inline suspend fun FinspaceDataClient.~~disassociateUserFromPermissionGroup~~(crossinline block: DisassociateUserFromPermissionGroupRequest.Builder.() -> Unit): DisassociateUserFromPermissionGroupResponse

Removes a user from a permission group.

inline suspend fun FinspaceDataClient.~~enableUser~~(crossinline block: EnableUserRequest.Builder.() -> Unit): EnableUserResponse

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

inline suspend fun FinspaceDataClient.~~getChangeset~~(crossinline block: GetChangesetRequest.Builder.() -> Unit): GetChangesetResponse

Get information about a Changeset.

inline suspend fun FinspaceDataClient.~~getDataset~~(crossinline block: GetDatasetRequest.Builder.() -> Unit): GetDatasetResponse

Returns information about a Dataset.

inline suspend fun FinspaceDataClient.~~getDataView~~(crossinline block: GetDataViewRequest.Builder.() -> Unit): GetDataViewResponse

Gets information about a Dataview.

getExternalDataViewAccessDetails

inline suspend fun FinspaceDataClient.~~getExternalDataViewAccessDetails~~(crossinline block: GetExternalDataViewAccessDetailsRequest.Builder.() -> Unit): GetExternalDataViewAccessDetailsResponse

Returns the credentials to access the external Dataview from an S3 location. To call this API:

getPermissionGroup

inline suspend fun FinspaceDataClient.~~getPermissionGroup~~(crossinline block: GetPermissionGroupRequest.Builder.() -> Unit): GetPermissionGroupResponse

Retrieves the details of a specific permission group.

getProgrammaticAccessCredentials

inline suspend fun FinspaceDataClient.~~getProgrammaticAccessCredentials~~(crossinline block: GetProgrammaticAccessCredentialsRequest.Builder.() -> Unit): GetProgrammaticAccessCredentialsResponse

Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.

inline suspend fun FinspaceDataClient.~~getUser~~(crossinline block: GetUserRequest.Builder.() -> Unit): GetUserResponse

Retrieves details for a specific user.

getWorkingLocation

inline suspend fun FinspaceDataClient.~~getWorkingLocation~~(crossinline block: GetWorkingLocationRequest.Builder.() -> Unit): GetWorkingLocationResponse

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.

inline suspend fun FinspaceDataClient.~~listChangesets~~(crossinline block: ListChangesetsRequest.Builder.() -> Unit): ListChangesetsResponse

Lists the FinSpace Changesets for a Dataset.

inline suspend fun FinspaceDataClient.~~listDatasets~~(crossinline block: ListDatasetsRequest.Builder.() -> Unit): ListDatasetsResponse

Lists all of the active Datasets that a user has access to.

inline suspend fun FinspaceDataClient.~~listDataViews~~(crossinline block: ListDataViewsRequest.Builder.() -> Unit): ListDataViewsResponse

Lists all available Dataviews for a Dataset.

listPermissionGroups

inline suspend fun FinspaceDataClient.~~listPermissionGroups~~(crossinline block: ListPermissionGroupsRequest.Builder.() -> Unit): ListPermissionGroupsResponse

Lists all available permission groups in FinSpace.

listPermissionGroupsByUser

inline suspend fun FinspaceDataClient.~~listPermissionGroupsByUser~~(crossinline block: ListPermissionGroupsByUserRequest.Builder.() -> Unit): ListPermissionGroupsByUserResponse

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

inline suspend fun FinspaceDataClient.~~listUsers~~(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

Lists all available users in FinSpace.

listUsersByPermissionGroup

inline suspend fun FinspaceDataClient.~~listUsersByPermissionGroup~~(crossinline block: ListUsersByPermissionGroupRequest.Builder.() -> Unit): ListUsersByPermissionGroupResponse

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

resetUserPassword

inline suspend fun FinspaceDataClient.~~resetUserPassword~~(crossinline block: ResetUserPasswordRequest.Builder.() -> Unit): ResetUserPasswordResponse

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.

updateChangeset

inline suspend fun FinspaceDataClient.~~updateChangeset~~(crossinline block: UpdateChangesetRequest.Builder.() -> Unit): UpdateChangesetResponse

Updates a FinSpace Changeset.

inline suspend fun FinspaceDataClient.~~updateDataset~~(crossinline block: UpdateDatasetRequest.Builder.() -> Unit): UpdateDatasetResponse

Updates a FinSpace Dataset.

updatePermissionGroup

inline suspend fun FinspaceDataClient.~~updatePermissionGroup~~(crossinline block: UpdatePermissionGroupRequest.Builder.() -> Unit): UpdatePermissionGroupResponse

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

inline suspend fun FinspaceDataClient.~~updateUser~~(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

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

fun FinspaceDataClient.withConfig(block: FinspaceDataClient.Config.Builder.() -> Unit): FinspaceDataClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.