com.amazonaws.services.finspacedata

Interface AWSFinSpaceData

All Known Subinterfaces:

AWSFinSpaceDataAsync

All Known Implementing Classes:

AbstractAWSFinSpaceData, AbstractAWSFinSpaceDataAsync, AWSFinSpaceDataAsyncClient, AWSFinSpaceDataClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSFinSpaceData

Interface for accessing FinSpace Data.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateChangesetResult	createChangeset(CreateChangesetRequest createChangesetRequest) Creates a new Changeset in a FinSpace Dataset.
CreateDatasetResult	createDataset(CreateDatasetRequest createDatasetRequest) Creates a new FinSpace Dataset.
CreateDataViewResult	createDataView(CreateDataViewRequest createDataViewRequest) Creates a Dataview for a Dataset.
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes a FinSpace Dataset.
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 getChangesetRequest) Get information about a Changeset.
GetDatasetResult	getDataset(GetDatasetRequest getDatasetRequest) Returns information about a Dataset.
GetDataViewResult	getDataView(GetDataViewRequest getDataViewRequest) Gets information about a Dataview.
GetProgrammaticAccessCredentialsResult	getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest) Request programmatic credentials to use with FinSpace SDK.
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.
ListChangesetsResult	listChangesets(ListChangesetsRequest listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.
ListDatasetsResult	listDatasets(ListDatasetsRequest listDatasetsRequest) Lists all of the active Datasets that a user has access to.
ListDataViewsResult	listDataViews(ListDataViewsRequest listDataViewsRequest) Lists all available Dataviews for a Dataset.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateChangesetResult	updateChangeset(UpdateChangesetRequest updateChangesetRequest) Updates a FinSpace Changeset.
UpdateDatasetResult	updateDataset(UpdateDatasetRequest updateDatasetRequest) Updates a FinSpace Dataset.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createChangeset

CreateChangesetResult createChangeset(CreateChangesetRequest createChangesetRequest)

Creates a new Changeset in a FinSpace Dataset.

Parameters:

createChangesetRequest - The request for a CreateChangeset operation.

Returns:

Result of the CreateChangeset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDataView

CreateDataViewResult createDataView(CreateDataViewRequest createDataViewRequest)

Creates a Dataview for a Dataset.

Parameters:

createDataViewRequest - Request for creating a data view.

Returns:

Result of the CreateDataView operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDataset

CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest)

Creates a new FinSpace Dataset.

Parameters:

createDatasetRequest - The request for a CreateDataset operation

Returns:

Result of the CreateDataset operation returned by the service.

Throws:

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.

ResourceNotFoundException - One or more resources can't be found.

See Also:

AWS API Documentation

deleteDataset

DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)

Deletes a FinSpace Dataset.

Parameters:

deleteDatasetRequest - The request for a DeleteDataset operation.

Returns:

Result of the DeleteDataset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getChangeset

GetChangesetResult getChangeset(GetChangesetRequest getChangesetRequest)

Get information about a Changeset.

Parameters:

getChangesetRequest - Request to describe a changeset.

Returns:

Result of the GetChangeset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDataView

GetDataViewResult getDataView(GetDataViewRequest getDataViewRequest)

Gets information about a Dataview.

Parameters:

getDataViewRequest - 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.

Throws:

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.

See Also:

AWS API Documentation

getDataset

GetDatasetResult getDataset(GetDatasetRequest getDatasetRequest)

Returns information about a Dataset.

Parameters:

getDatasetRequest - Request for the GetDataset operation.

Returns:

Result of the GetDataset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getProgrammaticAccessCredentials

GetProgrammaticAccessCredentialsResult getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest)

Request programmatic credentials to use with FinSpace SDK.

Parameters:

getProgrammaticAccessCredentialsRequest - Request for GetProgrammaticAccessCredentials operation

Returns:

Result of the GetProgrammaticAccessCredentials operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getWorkingLocation

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.

Parameters:

getWorkingLocationRequest -

Returns:

Result of the GetWorkingLocation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listChangesets

ListChangesetsResult listChangesets(ListChangesetsRequest listChangesetsRequest)

Lists the FinSpace Changesets for a Dataset.

Parameters:

listChangesetsRequest - Request to ListChangesetsRequest. It exposes minimal query filters.

Returns:

Result of the ListChangesets operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDataViews

ListDataViewsResult listDataViews(ListDataViewsRequest listDataViewsRequest)

Lists all available Dataviews for a Dataset.

Parameters:

listDataViewsRequest - Request for a list data views.

Returns:

Result of the ListDataViews operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDatasets

ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)

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

Parameters:

listDatasetsRequest - Request for the ListDatasets operation.

Returns:

Result of the ListDatasets operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateChangeset

UpdateChangesetResult updateChangeset(UpdateChangesetRequest updateChangesetRequest)

Updates a FinSpace Changeset.

Parameters:

updateChangesetRequest - Request to update an existing changeset.

Returns:

Result of the UpdateChangeset operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateDataset

UpdateDatasetResult updateDataset(UpdateDatasetRequest updateDatasetRequest)

Updates a FinSpace Dataset.

Parameters:

updateDatasetRequest - The request for an UpdateDataset operation

Returns:

Result of the UpdateDataset operation returned by the service.

Throws:

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.

ResourceNotFoundException - One or more resources can't be found.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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. 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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.