AbstractAWSFinSpaceData (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.finspacedata.AbstractAWSFinSpaceData

All Implemented Interfaces:

AWSFinSpaceData

Direct Known Subclasses:

AbstractAWSFinSpaceDataAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSFinSpaceData
extends Object
implements AWSFinSpaceData
```
Abstract implementation of AWSFinSpaceData. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.finspacedata.AWSFinSpaceData
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateUserToPermissionGroupResult`	`associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest request)` Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
`CreateChangesetResult`	`createChangeset(CreateChangesetRequest request)` Creates a new Changeset in a FinSpace Dataset.
`CreateDatasetResult`	`createDataset(CreateDatasetRequest request)` Creates a new FinSpace Dataset.
`CreateDataViewResult`	`createDataView(CreateDataViewRequest request)` Creates a Dataview for a Dataset.
`CreatePermissionGroupResult`	`createPermissionGroup(CreatePermissionGroupRequest request)` Creates a group of permissions for various actions that a user can perform in FinSpace.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates a new user in FinSpace.
`DeleteDatasetResult`	`deleteDataset(DeleteDatasetRequest request)` Deletes a FinSpace Dataset.
`DeletePermissionGroupResult`	`deletePermissionGroup(DeletePermissionGroupRequest request)` Deletes a permission group.
`DisableUserResult`	`disableUser(DisableUserRequest request)` Denies access to the FinSpace web application and API for the specified user.
`DisassociateUserFromPermissionGroupResult`	`disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest request)` Removes a user account from a permission group.
`EnableUserResult`	`enableUser(EnableUserRequest request)` Allows the specified user to access the FinSpace web application and API.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetChangesetResult`	`getChangeset(GetChangesetRequest request)` Get information about a Changeset.
`GetDatasetResult`	`getDataset(GetDatasetRequest request)` Returns information about a Dataset.
`GetDataViewResult`	`getDataView(GetDataViewRequest request)` Gets information about a Dataview.
`GetExternalDataViewAccessDetailsResult`	`getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest request)` Returns the credentials to access the external Dataview from an S3 location.
`GetPermissionGroupResult`	`getPermissionGroup(GetPermissionGroupRequest request)` Retrieves the details of a specific permission group.
`GetProgrammaticAccessCredentialsResult`	`getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest request)` Request programmatic credentials to use with FinSpace SDK.
`GetUserResult`	`getUser(GetUserRequest request)` Retrieves details for a specific user.
`GetWorkingLocationResult`	`getWorkingLocation(GetWorkingLocationRequest request)` 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.
`ListChangesetsResult`	`listChangesets(ListChangesetsRequest request)` Lists the FinSpace Changesets for a Dataset.
`ListDatasetsResult`	`listDatasets(ListDatasetsRequest request)` Lists all of the active Datasets that a user has access to.
`ListDataViewsResult`	`listDataViews(ListDataViewsRequest request)` Lists all available Dataviews for a Dataset.
`ListPermissionGroupsResult`	`listPermissionGroups(ListPermissionGroupsRequest request)` Lists all available permission groups in FinSpace.
`ListPermissionGroupsByUserResult`	`listPermissionGroupsByUser(ListPermissionGroupsByUserRequest request)` Lists all the permission groups that are associated with a specific user account.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Lists all available user accounts in FinSpace.
`ListUsersByPermissionGroupResult`	`listUsersByPermissionGroup(ListUsersByPermissionGroupRequest request)` Lists details of all the users in a specific permission group.
`ResetUserPasswordResult`	`resetUserPassword(ResetUserPasswordRequest request)` Resets the password for a specified user ID and generates a temporary one.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateChangesetResult`	`updateChangeset(UpdateChangesetRequest request)` Updates a FinSpace Changeset.
`UpdateDatasetResult`	`updateDataset(UpdateDatasetRequest request)` Updates a FinSpace Dataset.
`UpdatePermissionGroupResult`	`updatePermissionGroup(UpdatePermissionGroupRequest request)` Modifies the details of a permission group.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Modifies the details of the specified user account.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateUserToPermissionGroup
```
public AssociateUserToPermissionGroupResult associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
    
    Specified by:
    
    associateUserToPermissionGroup in interface AWSFinSpaceData
    
    Returns:
    
    Result of the AssociateUserToPermissionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createChangeset
```
public CreateChangesetResult createChangeset(CreateChangesetRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Creates a new Changeset in a FinSpace Dataset.
    
    Specified by:
    
    createChangeset in interface AWSFinSpaceData
    
    Parameters:
    
    request - The request for a CreateChangeset operation.
    
    Returns:
    
    Result of the CreateChangeset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataView
```
public CreateDataViewResult createDataView(CreateDataViewRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Creates a Dataview for a Dataset.
    
    Specified by:
    
    createDataView in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request for creating a data view.
    
    Returns:
    
    Result of the CreateDataView operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataset
```
public CreateDatasetResult createDataset(CreateDatasetRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Creates a new FinSpace Dataset.
    
    Specified by:
    
    createDataset in interface AWSFinSpaceData
    
    Parameters:
    
    request - The request for a CreateDataset operation
    
    Returns:
    
    Result of the CreateDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPermissionGroup
```
public CreatePermissionGroupResult createPermissionGroup(CreatePermissionGroupRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Creates a group of permissions for various actions that a user can perform in FinSpace.
    
    Specified by:
    
    createPermissionGroup in interface AWSFinSpaceData
    
    Returns:
    
    Result of the CreatePermissionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Creates a new user in FinSpace.
    
    Specified by:
    
    createUser in interface AWSFinSpaceData
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataset
```
public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Deletes a FinSpace Dataset.
    
    Specified by:
    
    deleteDataset in interface AWSFinSpaceData
    
    Parameters:
    
    request - The request for a DeleteDataset operation.
    
    Returns:
    
    Result of the DeleteDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePermissionGroup
```
public DeletePermissionGroupResult deletePermissionGroup(DeletePermissionGroupRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Deletes a permission group. This action is irreversible.
    
    Specified by:
    
    deletePermissionGroup in interface AWSFinSpaceData
    
    Returns:
    
    Result of the DeletePermissionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disableUser
```
public DisableUserResult disableUser(DisableUserRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Denies access to the FinSpace web application and API for the specified user.
    
    Specified by:
    
    disableUser in interface AWSFinSpaceData
    
    Returns:
    
    Result of the DisableUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateUserFromPermissionGroup
```
public DisassociateUserFromPermissionGroupResult disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Removes a user account from a permission group.
    
    Specified by:
    
    disassociateUserFromPermissionGroup in interface AWSFinSpaceData
    
    Returns:
    
    Result of the DisassociateUserFromPermissionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableUser
```
public EnableUserResult enableUser(EnableUserRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Allows the specified user to access the FinSpace web application and API.
    
    Specified by:
    
    enableUser in interface AWSFinSpaceData
    
    Returns:
    
    Result of the EnableUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getChangeset
```
public GetChangesetResult getChangeset(GetChangesetRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Get information about a Changeset.
    
    Specified by:
    
    getChangeset in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request to describe a changeset.
    
    Returns:
    
    Result of the GetChangeset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDataView
```
public GetDataViewResult getDataView(GetDataViewRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Gets information about a Dataview.
    
    Specified by:
    
    getDataView in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.
    
    Returns:
    
    Result of the GetDataView operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDataset
```
public GetDatasetResult getDataset(GetDatasetRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Returns information about a Dataset.
    
    Specified by:
    
    getDataset in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request for the GetDataset operation.
    
    Returns:
    
    Result of the GetDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getExternalDataViewAccessDetails
```
public GetExternalDataViewAccessDetailsResult getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest request)
```
    Description copied from interface: AWSFinSpaceData
    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.
    Specified by:
    
    getExternalDataViewAccessDetails in interface AWSFinSpaceData
    
    Returns:
    
    Result of the GetExternalDataViewAccessDetails operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPermissionGroup
```
public GetPermissionGroupResult getPermissionGroup(GetPermissionGroupRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Retrieves the details of a specific permission group.
    
    Specified by:
    
    getPermissionGroup in interface AWSFinSpaceData
    
    Returns:
    
    Result of the GetPermissionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getProgrammaticAccessCredentials
```
public GetProgrammaticAccessCredentialsResult getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Request programmatic credentials to use with FinSpace SDK.
    
    Specified by:
    
    getProgrammaticAccessCredentials in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request for GetProgrammaticAccessCredentials operation
    
    Returns:
    
    Result of the GetProgrammaticAccessCredentials operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getUser
```
public GetUserResult getUser(GetUserRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Retrieves details for a specific user.
    
    Specified by:
    
    getUser in interface AWSFinSpaceData
    
    Returns:
    
    Result of the GetUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWorkingLocation
```
public GetWorkingLocationResult getWorkingLocation(GetWorkingLocationRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    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.
    
    Specified by:
    
    getWorkingLocation in interface AWSFinSpaceData
    
    Returns:
    
    Result of the GetWorkingLocation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listChangesets
```
public ListChangesetsResult listChangesets(ListChangesetsRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Lists the FinSpace Changesets for a Dataset.
    
    Specified by:
    
    listChangesets in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request to ListChangesetsRequest. It exposes minimal query filters.
    
    Returns:
    
    Result of the ListChangesets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataViews
```
public ListDataViewsResult listDataViews(ListDataViewsRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Lists all available Dataviews for a Dataset.
    
    Specified by:
    
    listDataViews in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request for a list data views.
    
    Returns:
    
    Result of the ListDataViews operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatasets
```
public ListDatasetsResult listDatasets(ListDatasetsRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Lists all of the active Datasets that a user has access to.
    
    Specified by:
    
    listDatasets in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request for the ListDatasets operation.
    
    Returns:
    
    Result of the ListDatasets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPermissionGroups
```
public ListPermissionGroupsResult listPermissionGroups(ListPermissionGroupsRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Lists all available permission groups in FinSpace.
    
    Specified by:
    
    listPermissionGroups in interface AWSFinSpaceData
    
    Returns:
    
    Result of the ListPermissionGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPermissionGroupsByUser
```
public ListPermissionGroupsByUserResult listPermissionGroupsByUser(ListPermissionGroupsByUserRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Lists all the permission groups that are associated with a specific user account.
    
    Specified by:
    
    listPermissionGroupsByUser in interface AWSFinSpaceData
    
    Returns:
    
    Result of the ListPermissionGroupsByUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Lists all available user accounts in FinSpace.
    
    Specified by:
    
    listUsers in interface AWSFinSpaceData
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsersByPermissionGroup
```
public ListUsersByPermissionGroupResult listUsersByPermissionGroup(ListUsersByPermissionGroupRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Lists details of all the users in a specific permission group.
    
    Specified by:
    
    listUsersByPermissionGroup in interface AWSFinSpaceData
    
    Returns:
    
    Result of the ListUsersByPermissionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resetUserPassword
```
public ResetUserPasswordResult resetUserPassword(ResetUserPasswordRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    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.
    
    Specified by:
    
    resetUserPassword in interface AWSFinSpaceData
    
    Returns:
    
    Result of the ResetUserPassword operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateChangeset
```
public UpdateChangesetResult updateChangeset(UpdateChangesetRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Updates a FinSpace Changeset.
    
    Specified by:
    
    updateChangeset in interface AWSFinSpaceData
    
    Parameters:
    
    request - Request to update an existing changeset.
    
    Returns:
    
    Result of the UpdateChangeset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataset
```
public UpdateDatasetResult updateDataset(UpdateDatasetRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Updates a FinSpace Dataset.
    
    Specified by:
    
    updateDataset in interface AWSFinSpaceData
    
    Parameters:
    
    request - The request for an UpdateDataset operation
    
    Returns:
    
    Result of the UpdateDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePermissionGroup
```
public UpdatePermissionGroupResult updatePermissionGroup(UpdatePermissionGroupRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Modifies the details of a permission group. You cannot modify a permissionGroupID.
    
    Specified by:
    
    updatePermissionGroup in interface AWSFinSpaceData
    
    Returns:
    
    Result of the UpdatePermissionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Modifies the details of the specified user account. You cannot update the userId for a user.
    
    Specified by:
    
    updateUser in interface AWSFinSpaceData
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSFinSpaceData
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSFinSpaceData
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSFinSpaceData
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSFinSpaceData
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSFinSpaceData

Field Summary

Fields inherited from interface com.amazonaws.services.finspacedata.AWSFinSpaceData

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateUserToPermissionGroup

createChangeset

createDataView

createDataset

createPermissionGroup

createUser

deleteDataset

deletePermissionGroup

disableUser

disassociateUserFromPermissionGroup

enableUser

getChangeset

getDataView

getDataset

getExternalDataViewAccessDetails

getPermissionGroup

getProgrammaticAccessCredentials

getUser

getWorkingLocation

listChangesets

listDataViews

listDatasets

listPermissionGroups

listPermissionGroupsByUser

listUsers

listUsersByPermissionGroup

resetUserPassword

updateChangeset

updateDataset

updatePermissionGroup

updateUser

shutdown

getCachedResponseMetadata