@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSFinSpaceData
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSFinSpaceData
instead.
The FinSpace APIs let you take actions inside the FinSpace.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
static final String ENDPOINT_PREFIX
@Deprecated AssociateUserToPermissionGroupResult associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest)
Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
associateUserToPermissionGroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- The request conflicts with an existing resource.@Deprecated CreateChangesetResult createChangeset(CreateChangesetRequest createChangesetRequest)
Creates a new Changeset in a FinSpace Dataset.
createChangesetRequest
- The request for a CreateChangeset operation.ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.@Deprecated CreateDataViewResult createDataView(CreateDataViewRequest createDataViewRequest)
Creates a Dataview for a Dataset.
createDataViewRequest
- Request for creating a data view.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.ResourceNotFoundException
- One or more resources can't be found.@Deprecated CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest)
Creates a new FinSpace Dataset.
createDatasetRequest
- The request for a CreateDataset operationInternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.ResourceNotFoundException
- One or more resources can't be found.@Deprecated CreatePermissionGroupResult createPermissionGroup(CreatePermissionGroupRequest createPermissionGroupRequest)
Creates a group of permissions for various actions that a user can perform in FinSpace.
createPermissionGroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.@Deprecated CreateUserResult createUser(CreateUserRequest createUserRequest)
Creates a new user in FinSpace.
createUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.@Deprecated DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes a FinSpace Dataset.
deleteDatasetRequest
- The request for a DeleteDataset operation.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.@Deprecated DeletePermissionGroupResult deletePermissionGroup(DeletePermissionGroupRequest deletePermissionGroupRequest)
Deletes a permission group. This action is irreversible.
deletePermissionGroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.@Deprecated DisableUserResult disableUser(DisableUserRequest disableUserRequest)
Denies access to the FinSpace web application and API for the specified user.
disableUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- The request conflicts with an existing resource.@Deprecated DisassociateUserFromPermissionGroupResult disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest)
Removes a user from a permission group.
disassociateUserFromPermissionGroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- The request conflicts with an existing resource.@Deprecated EnableUserResult enableUser(EnableUserRequest enableUserRequest)
Allows the specified user to access the FinSpace web application and API.
enableUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.LimitExceededException
- A limit has exceeded.ConflictException
- The request conflicts with an existing resource.@Deprecated GetChangesetResult getChangeset(GetChangesetRequest getChangesetRequest)
Get information about a Changeset.
getChangesetRequest
- Request to describe a changeset.ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ConflictException
- The request conflicts with an existing resource.@Deprecated GetDataViewResult getDataView(GetDataViewRequest getDataViewRequest)
Gets information about a Dataview.
getDataViewRequest
- Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- The request conflicts with an existing resource.@Deprecated GetDatasetResult getDataset(GetDatasetRequest getDatasetRequest)
Returns information about a Dataset.
getDatasetRequest
- Request for the GetDataset operation.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- The request conflicts with an existing resource.@Deprecated GetExternalDataViewAccessDetailsResult getExternalDataViewAccessDetails(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
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.@Deprecated GetPermissionGroupResult getPermissionGroup(GetPermissionGroupRequest getPermissionGroupRequest)
Retrieves the details of a specific permission group.
getPermissionGroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.@Deprecated GetProgrammaticAccessCredentialsResult getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest)
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.
getProgrammaticAccessCredentialsRequest
- Request for GetProgrammaticAccessCredentials operationInternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.@Deprecated GetUserResult getUser(GetUserRequest getUserRequest)
Retrieves details for a specific user.
getUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.@Deprecated GetWorkingLocationResult getWorkingLocation(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
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.@Deprecated ListChangesetsResult listChangesets(ListChangesetsRequest listChangesetsRequest)
Lists the FinSpace Changesets for a Dataset.
listChangesetsRequest
- Request to ListChangesetsRequest. It exposes minimal query filters.ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ConflictException
- The request conflicts with an existing resource.@Deprecated ListDataViewsResult listDataViews(ListDataViewsRequest listDataViewsRequest)
Lists all available Dataviews for a Dataset.
listDataViewsRequest
- Request for a list data views.ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- The request conflicts with an existing resource.@Deprecated ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)
Lists all of the active Datasets that a user has access to.
listDatasetsRequest
- Request for the ListDatasets operation.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- The request conflicts with an existing resource.ResourceNotFoundException
- One or more resources can't be found.@Deprecated ListPermissionGroupsResult listPermissionGroups(ListPermissionGroupsRequest listPermissionGroupsRequest)
Lists all available permission groups in FinSpace.
listPermissionGroupsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.@Deprecated ListPermissionGroupsByUserResult listPermissionGroupsByUser(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest)
Lists all the permission groups that are associated with a specific user.
listPermissionGroupsByUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.@Deprecated ListUsersResult listUsers(ListUsersRequest listUsersRequest)
Lists all available users in FinSpace.
listUsersRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.@Deprecated ListUsersByPermissionGroupResult listUsersByPermissionGroup(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest)
Lists details of all the users in a specific permission group.
listUsersByPermissionGroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.@Deprecated ResetUserPasswordResult resetUserPassword(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
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- The request conflicts with an existing resource.@Deprecated UpdateChangesetResult updateChangeset(UpdateChangesetRequest updateChangesetRequest)
Updates a FinSpace Changeset.
updateChangesetRequest
- Request to update an existing changeset.ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ConflictException
- The request conflicts with an existing resource.@Deprecated UpdateDatasetResult updateDataset(UpdateDatasetRequest updateDatasetRequest)
Updates a FinSpace Dataset.
updateDatasetRequest
- The request for an UpdateDataset operationInternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ConflictException
- The request conflicts with an existing resource.ResourceNotFoundException
- One or more resources can't be found.@Deprecated UpdatePermissionGroupResult updatePermissionGroup(UpdatePermissionGroupRequest updatePermissionGroupRequest)
Modifies the details of a permission group. You cannot modify a permissionGroupID
.
updatePermissionGroupRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- The request conflicts with an existing resource.@Deprecated UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
Modifies the details of the specified user. You cannot update the userId
for a user.
updateUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- The request conflicts with an existing resource.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.