software.amazon.awssdk.services.finspacedata

Interface FinspaceDataClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface FinspaceDataClient
extends SdkClient

Service client for accessing FinSpace Data. This can be created using the static builder() method.

The FinSpace APIs let you take actions inside the FinSpace environment.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static FinspaceDataClientBuilder	builder() Create a builder that can be used to configure and create a FinspaceDataClient.
static FinspaceDataClient	create() Create a FinspaceDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateChangesetResponse	createChangeset(Consumer<CreateChangesetRequest.Builder> createChangesetRequest) Creates a new changeset in a FinSpace dataset.
default CreateChangesetResponse	createChangeset(CreateChangesetRequest createChangesetRequest) Creates a new changeset in a FinSpace dataset.
default GetProgrammaticAccessCredentialsResponse	getProgrammaticAccessCredentials(Consumer<GetProgrammaticAccessCredentialsRequest.Builder> getProgrammaticAccessCredentialsRequest) Request programmatic credentials to use with Habanero SDK.
default GetProgrammaticAccessCredentialsResponse	getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest) Request programmatic credentials to use with Habanero SDK.
default GetWorkingLocationResponse	getWorkingLocation(Consumer<GetWorkingLocationRequest.Builder> getWorkingLocationRequest) A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.
default GetWorkingLocationResponse	getWorkingLocation(GetWorkingLocationRequest getWorkingLocationRequest) A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

create

static FinspaceDataClient create()

Create a FinspaceDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static FinspaceDataClientBuilder builder()

Create a builder that can be used to configure and create a FinspaceDataClient.

createChangeset

default CreateChangesetResponse createChangeset(CreateChangesetRequest createChangesetRequest)
                                         throws ResourceNotFoundException,
                                                InternalServerException,
                                                ValidationException,
                                                ThrottlingException,
                                                AccessDeniedException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FinspaceDataException

Creates a new changeset in a FinSpace dataset.

Parameters:

createChangesetRequest -

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FinspaceDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createChangeset

default CreateChangesetResponse createChangeset(Consumer<CreateChangesetRequest.Builder> createChangesetRequest)
                                         throws ResourceNotFoundException,
                                                InternalServerException,
                                                ValidationException,
                                                ThrottlingException,
                                                AccessDeniedException,
                                                AwsServiceException,
                                                SdkClientException,
                                                FinspaceDataException

Creates a new changeset in a FinSpace dataset.

This is a convenience which creates an instance of the CreateChangesetRequest.Builder avoiding the need to create one manually via CreateChangesetRequest.builder()

Parameters:

createChangesetRequest - A Consumer that will call methods on CreateChangesetRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FinspaceDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getProgrammaticAccessCredentials

default GetProgrammaticAccessCredentialsResponse getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest)
                                                                           throws InternalServerException,
                                                                                  ThrottlingException,
                                                                                  AccessDeniedException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  FinspaceDataException

Request programmatic credentials to use with Habanero SDK.

Parameters:

getProgrammaticAccessCredentialsRequest -

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.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FinspaceDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getProgrammaticAccessCredentials

default GetProgrammaticAccessCredentialsResponse getProgrammaticAccessCredentials(Consumer<GetProgrammaticAccessCredentialsRequest.Builder> getProgrammaticAccessCredentialsRequest)
                                                                           throws InternalServerException,
                                                                                  ThrottlingException,
                                                                                  AccessDeniedException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  FinspaceDataException

Request programmatic credentials to use with Habanero SDK.

This is a convenience which creates an instance of the GetProgrammaticAccessCredentialsRequest.Builder avoiding the need to create one manually via GetProgrammaticAccessCredentialsRequest.builder()

Parameters:

getProgrammaticAccessCredentialsRequest - A Consumer that will call methods on GetProgrammaticAccessCredentialsRequest.Builder to create a request.

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.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FinspaceDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getWorkingLocation

default GetWorkingLocationResponse getWorkingLocation(GetWorkingLocationRequest getWorkingLocationRequest)
                                               throws InternalServerException,
                                                      AccessDeniedException,
                                                      ThrottlingException,
                                                      ValidationException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      FinspaceDataException

A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero 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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FinspaceDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getWorkingLocation

default GetWorkingLocationResponse getWorkingLocation(Consumer<GetWorkingLocationRequest.Builder> getWorkingLocationRequest)
                                               throws InternalServerException,
                                                      AccessDeniedException,
                                                      ThrottlingException,
                                                      ValidationException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      FinspaceDataException

A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.

This is a convenience which creates an instance of the GetWorkingLocationRequest.Builder avoiding the need to create one manually via GetWorkingLocationRequest.builder()

Parameters:

getWorkingLocationRequest - A Consumer that will call methods on GetWorkingLocationRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

FinspaceDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()