com.amazonaws.services.finspacedata

Class AWSFinSpaceDataClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.finspacedata.AWSFinSpaceDataClient

All Implemented Interfaces:

AWSFinSpaceData

Direct Known Subclasses:

AWSFinSpaceDataAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSFinSpaceDataClient
extends AmazonWebServiceClient
implements AWSFinSpaceData

Client for accessing FinSpace Data. All service calls made using this client are blocking, and will not return until the service call completes.

The FinSpace APIs let you take actions inside the FinSpace.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSFinSpaceDataClientBuilder	builder()
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.
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest request) 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 request) Get information about a Changeset.
GetDatasetResult	getDataset(GetDatasetRequest request) Returns information about a Dataset.
GetDataViewResult	getDataView(GetDataViewRequest request) Gets information about a Dataview.
GetProgrammaticAccessCredentialsResult	getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest request) Request programmatic credentials to use with FinSpace SDK.
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.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSFinSpaceDataClientBuilder builder()

createChangeset

public CreateChangesetResult createChangeset(CreateChangesetRequest request)

Creates a new Changeset in a FinSpace Dataset.

Specified by:

createChangeset in interface AWSFinSpaceData

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

public CreateDataViewResult createDataView(CreateDataViewRequest request)

Creates a Dataview for a Dataset.

Specified by:

createDataView in interface AWSFinSpaceData

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

public CreateDatasetResult createDataset(CreateDatasetRequest request)

Creates a new FinSpace Dataset.

Specified by:

createDataset in interface AWSFinSpaceData

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

public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)

Deletes a FinSpace Dataset.

Specified by:

deleteDataset in interface AWSFinSpaceData

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

public GetChangesetResult getChangeset(GetChangesetRequest request)

Get information about a Changeset.

Specified by:

getChangeset in interface AWSFinSpaceData

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

public GetDataViewResult getDataView(GetDataViewRequest request)

Gets information about a Dataview.

Specified by:

getDataView in interface AWSFinSpaceData

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

public GetDatasetResult getDataset(GetDatasetRequest request)

Returns information about a Dataset.

Specified by:

getDataset in interface AWSFinSpaceData

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

public GetProgrammaticAccessCredentialsResult getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest request)

Request programmatic credentials to use with FinSpace SDK.

Specified by:

getProgrammaticAccessCredentials in interface AWSFinSpaceData

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

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.

Specified by:

getWorkingLocation in interface AWSFinSpaceData

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

public ListChangesetsResult listChangesets(ListChangesetsRequest request)

Lists the FinSpace Changesets for a Dataset.

Specified by:

listChangesets in interface AWSFinSpaceData

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

public ListDataViewsResult listDataViews(ListDataViewsRequest request)

Lists all available Dataviews for a Dataset.

Specified by:

listDataViews in interface AWSFinSpaceData

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

public ListDatasetsResult listDatasets(ListDatasetsRequest request)

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

Specified by:

listDatasets in interface AWSFinSpaceData

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

public UpdateChangesetResult updateChangeset(UpdateChangesetRequest request)

Updates a FinSpace Changeset.

Specified by:

updateChangeset in interface AWSFinSpaceData

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

public UpdateDatasetResult updateDataset(UpdateDatasetRequest request)

Updates a FinSpace Dataset.

Specified by:

updateDataset in interface AWSFinSpaceData

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

getCachedResponseMetadata

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSFinSpaceData

Overrides:

shutdown in class AmazonWebServiceClient