software.amazon.awssdk.services.finspace

Interface FinspaceClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

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

The FinSpace management service provides the APIs for managing FinSpace environments.

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 FinspaceClientBuilder	builder() Create a builder that can be used to configure and create a FinspaceClient.
static FinspaceClient	create() Create a FinspaceClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateEnvironmentResponse	createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Create a new FinSpace environment.
default CreateEnvironmentResponse	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Create a new FinSpace environment.
default DeleteEnvironmentResponse	deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Delete an FinSpace environment.
default DeleteEnvironmentResponse	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Delete an FinSpace environment.
default GetEnvironmentResponse	getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Returns the FinSpace environment object.
default GetEnvironmentResponse	getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Returns the FinSpace environment object.
default ListEnvironmentsResponse	listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) A list of all of your FinSpace environments.
default ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) A list of all of your FinSpace environments.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) A list of all tags for a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) A list of all tags for a resource.
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds metadata tags to a FinSpace resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Adds metadata tags to a FinSpace resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes metadata tags from a FinSpace resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from a FinSpace resource.
default UpdateEnvironmentResponse	updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Update your FinSpace environment.
default UpdateEnvironmentResponse	updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Update your FinSpace environment.

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 FinspaceClient create()

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

builder

static FinspaceClientBuilder builder()

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

createEnvironment

default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
                                             throws InternalServerException,
                                                    ValidationException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    ServiceQuotaExceededException,
                                                    LimitExceededException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    FinspaceException

Create a new FinSpace environment.

Parameters:

createEnvironmentRequest -

Returns:

Result of the CreateEnvironment 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.

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

ThrottlingException - The request was denied due to request throttling.

ServiceQuotaExceededException - You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

LimitExceededException - A service limit or quota is exceeded.

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.

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

AwsServiceException

See Also:

AWS API Documentation

createEnvironment

default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
                                             throws InternalServerException,
                                                    ValidationException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    ServiceQuotaExceededException,
                                                    LimitExceededException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    FinspaceException

Create a new FinSpace environment.

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

Parameters:

createEnvironmentRequest - A Consumer that will call methods on CreateEnvironmentRequest.Builder to create a request.

Returns:

Result of the CreateEnvironment 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.

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

ThrottlingException - The request was denied due to request throttling.

ServiceQuotaExceededException - You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

LimitExceededException - A service limit or quota is exceeded.

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.

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

AwsServiceException

See Also:

AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    ValidationException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    FinspaceException

Delete an FinSpace environment.

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment 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.

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.

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

AwsServiceException

See Also:

AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    ValidationException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    FinspaceException

Delete an FinSpace environment.

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

Parameters:

deleteEnvironmentRequest - A Consumer that will call methods on DeleteEnvironmentRequest.Builder to create a request.

Returns:

Result of the DeleteEnvironment 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.

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.

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

AwsServiceException

See Also:

AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
                                       throws ResourceNotFoundException,
                                              InternalServerException,
                                              ValidationException,
                                              AccessDeniedException,
                                              AwsServiceException,
                                              SdkClientException,
                                              FinspaceException

Returns the FinSpace environment object.

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment 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.

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.

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

AwsServiceException

See Also:

AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
                                       throws ResourceNotFoundException,
                                              InternalServerException,
                                              ValidationException,
                                              AccessDeniedException,
                                              AwsServiceException,
                                              SdkClientException,
                                              FinspaceException

Returns the FinSpace environment object.

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

Parameters:

getEnvironmentRequest - A Consumer that will call methods on GetEnvironmentRequest.Builder to create a request.

Returns:

Result of the GetEnvironment 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.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
                                           throws InternalServerException,
                                                  ValidationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FinspaceException

A list of all of your FinSpace environments.

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments 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.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                           throws InternalServerException,
                                                  ValidationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  FinspaceException

A list of all of your FinSpace environments.

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

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsRequest.Builder to create a request.

Returns:

Result of the ListEnvironments 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.

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.

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

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
                                                        InvalidRequestException,
                                                        ResourceNotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FinspaceException

A list of all tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
                                                        InvalidRequestException,
                                                        ResourceNotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        FinspaceException

A list of all tags for a resource.

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
                                        InvalidRequestException,
                                        ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        FinspaceException

Adds metadata tags to a FinSpace resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
                                        InvalidRequestException,
                                        ResourceNotFoundException,
                                        AwsServiceException,
                                        SdkClientException,
                                        FinspaceException

Adds metadata tags to a FinSpace resource.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
                                            InvalidRequestException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            FinspaceException

Removes metadata tags from a FinSpace resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
                                            InvalidRequestException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            FinspaceException

Removes metadata tags from a FinSpace resource.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception or failure.

InvalidRequestException - The request is invalid. Something is wrong with the input to the request.

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

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.

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

AwsServiceException

See Also:

AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    ValidationException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    FinspaceException

Update your FinSpace environment.

Parameters:

updateEnvironmentRequest -

Returns:

Result of the UpdateEnvironment 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.

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.

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

AwsServiceException

See Also:

AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    InternalServerException,
                                                    AccessDeniedException,
                                                    ThrottlingException,
                                                    ValidationException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    FinspaceException

Update your FinSpace environment.

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

Parameters:

updateEnvironmentRequest - A Consumer that will call methods on UpdateEnvironmentRequest.Builder to create a request.

Returns:

Result of the UpdateEnvironment 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.

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.

FinspaceException - 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()