@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSFinSpaceDataClient extends AmazonWebServiceClient implements AWSFinSpaceData
The FinSpace APIs let you take actions inside the FinSpace.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSFinSpaceDataClientBuilder builder()
@Deprecated public AssociateUserToPermissionGroupResult associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest request)
Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
associateUserToPermissionGroup in interface AWSFinSpaceDataassociateUserToPermissionGroupRequest - 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 public CreateChangesetResult createChangeset(CreateChangesetRequest request)
Creates a new Changeset in a FinSpace Dataset.
createChangeset in interface AWSFinSpaceDatacreateChangesetRequest - 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 public CreateDataViewResult createDataView(CreateDataViewRequest request)
Creates a Dataview for a Dataset.
createDataView in interface AWSFinSpaceDatacreateDataViewRequest - 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 public CreateDatasetResult createDataset(CreateDatasetRequest request)
Creates a new FinSpace Dataset.
createDataset in interface AWSFinSpaceDatacreateDatasetRequest - 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 public CreatePermissionGroupResult createPermissionGroup(CreatePermissionGroupRequest request)
Creates a group of permissions for various actions that a user can perform in FinSpace.
createPermissionGroup in interface AWSFinSpaceDatacreatePermissionGroupRequest - 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 public CreateUserResult createUser(CreateUserRequest request)
Creates a new user in FinSpace.
createUser in interface AWSFinSpaceDatacreateUserRequest - 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 public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
Deletes a FinSpace Dataset.
deleteDataset in interface AWSFinSpaceDatadeleteDatasetRequest - 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 public DeletePermissionGroupResult deletePermissionGroup(DeletePermissionGroupRequest request)
Deletes a permission group. This action is irreversible.
deletePermissionGroup in interface AWSFinSpaceDatadeletePermissionGroupRequest - 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 public DisableUserResult disableUser(DisableUserRequest request)
Denies access to the FinSpace web application and API for the specified user.
disableUser in interface AWSFinSpaceDatadisableUserRequest - 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 public DisassociateUserFromPermissionGroupResult disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest request)
Removes a user from a permission group.
disassociateUserFromPermissionGroup in interface AWSFinSpaceDatadisassociateUserFromPermissionGroupRequest - 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 public EnableUserResult enableUser(EnableUserRequest request)
Allows the specified user to access the FinSpace web application and API.
enableUser in interface AWSFinSpaceDataenableUserRequest - 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 public GetChangesetResult getChangeset(GetChangesetRequest request)
Get information about a Changeset.
getChangeset in interface AWSFinSpaceDatagetChangesetRequest - 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 public GetDataViewResult getDataView(GetDataViewRequest request)
Gets information about a Dataview.
getDataView in interface AWSFinSpaceDatagetDataViewRequest - 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 public GetDatasetResult getDataset(GetDatasetRequest request)
Returns information about a Dataset.
getDataset in interface AWSFinSpaceDatagetDatasetRequest - 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 public GetExternalDataViewAccessDetailsResult getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest request)
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.
getExternalDataViewAccessDetails in interface AWSFinSpaceDatagetExternalDataViewAccessDetailsRequest - 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 public GetPermissionGroupResult getPermissionGroup(GetPermissionGroupRequest request)
Retrieves the details of a specific permission group.
getPermissionGroup in interface AWSFinSpaceDatagetPermissionGroupRequest - 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 public GetProgrammaticAccessCredentialsResult getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest request)
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.
getProgrammaticAccessCredentials in interface AWSFinSpaceDatagetProgrammaticAccessCredentialsRequest - 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 public GetUserResult getUser(GetUserRequest request)
Retrieves details for a specific user.
getUser in interface AWSFinSpaceDatagetUserRequest - 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 public 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.
getWorkingLocation in interface AWSFinSpaceDatagetWorkingLocationRequest - 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 public ListChangesetsResult listChangesets(ListChangesetsRequest request)
Lists the FinSpace Changesets for a Dataset.
listChangesets in interface AWSFinSpaceDatalistChangesetsRequest - 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 public ListDataViewsResult listDataViews(ListDataViewsRequest request)
Lists all available Dataviews for a Dataset.
listDataViews in interface AWSFinSpaceDatalistDataViewsRequest - 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 public ListDatasetsResult listDatasets(ListDatasetsRequest request)
Lists all of the active Datasets that a user has access to.
listDatasets in interface AWSFinSpaceDatalistDatasetsRequest - 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 public ListPermissionGroupsResult listPermissionGroups(ListPermissionGroupsRequest request)
Lists all available permission groups in FinSpace.
listPermissionGroups in interface AWSFinSpaceDatalistPermissionGroupsRequest - 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 public ListPermissionGroupsByUserResult listPermissionGroupsByUser(ListPermissionGroupsByUserRequest request)
Lists all the permission groups that are associated with a specific user.
listPermissionGroupsByUser in interface AWSFinSpaceDatalistPermissionGroupsByUserRequest - 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 public ListUsersResult listUsers(ListUsersRequest request)
Lists all available users in FinSpace.
listUsers in interface AWSFinSpaceDatalistUsersRequest - 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 public ListUsersByPermissionGroupResult listUsersByPermissionGroup(ListUsersByPermissionGroupRequest request)
Lists details of all the users in a specific permission group.
listUsersByPermissionGroup in interface AWSFinSpaceDatalistUsersByPermissionGroupRequest - 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 public ResetUserPasswordResult resetUserPassword(ResetUserPasswordRequest request)
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.
resetUserPassword in interface AWSFinSpaceDataresetUserPasswordRequest - 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 public UpdateChangesetResult updateChangeset(UpdateChangesetRequest request)
Updates a FinSpace Changeset.
updateChangeset in interface AWSFinSpaceDataupdateChangesetRequest - 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 public UpdateDatasetResult updateDataset(UpdateDatasetRequest request)
Updates a FinSpace Dataset.
updateDataset in interface AWSFinSpaceDataupdateDatasetRequest - 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 public UpdatePermissionGroupResult updatePermissionGroup(UpdatePermissionGroupRequest request)
Modifies the details of a permission group. You cannot modify a permissionGroupID.
updatePermissionGroup in interface AWSFinSpaceDataupdatePermissionGroupRequest - 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 public UpdateUserResult updateUser(UpdateUserRequest request)
Modifies the details of the specified user. You cannot update the userId for a user.
updateUser in interface AWSFinSpaceDataupdateUserRequest - 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.public 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 the request.
getCachedResponseMetadata in interface AWSFinSpaceDatarequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSFinSpaceDatashutdown in class AmazonWebServiceClient