Package software.amazon.awssdk.services.finspace

Interface FinspaceClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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 CreateKxChangesetResponse	createKxChangeset(Consumer<CreateKxChangesetRequest.Builder> createKxChangesetRequest)	Creates a changeset for a kdb database.
default CreateKxChangesetResponse	createKxChangeset(CreateKxChangesetRequest createKxChangesetRequest)	Creates a changeset for a kdb database.
default CreateKxClusterResponse	createKxCluster(Consumer<CreateKxClusterRequest.Builder> createKxClusterRequest)	Creates a new kdb cluster.
default CreateKxClusterResponse	createKxCluster(CreateKxClusterRequest createKxClusterRequest)	Creates a new kdb cluster.
default CreateKxDatabaseResponse	createKxDatabase(Consumer<CreateKxDatabaseRequest.Builder> createKxDatabaseRequest)	Creates a new kdb database in the environment.
default CreateKxDatabaseResponse	createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest)	Creates a new kdb database in the environment.
default CreateKxEnvironmentResponse	createKxEnvironment(Consumer<CreateKxEnvironmentRequest.Builder> createKxEnvironmentRequest)	Creates a managed kdb environment for the account.
default CreateKxEnvironmentResponse	createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest)	Creates a managed kdb environment for the account.
default CreateKxUserResponse	createKxUser(Consumer<CreateKxUserRequest.Builder> createKxUserRequest)	Creates a user in FinSpace kdb environment with an associated IAM role.
default CreateKxUserResponse	createKxUser(CreateKxUserRequest createKxUserRequest)	Creates a user in FinSpace kdb environment with an associated IAM role.
default DeleteEnvironmentResponse	deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)	Delete an FinSpace environment.
default DeleteEnvironmentResponse	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)	Delete an FinSpace environment.
default DeleteKxClusterResponse	deleteKxCluster(Consumer<DeleteKxClusterRequest.Builder> deleteKxClusterRequest)	Deletes a kdb cluster.
default DeleteKxClusterResponse	deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest)	Deletes a kdb cluster.
default DeleteKxDatabaseResponse	deleteKxDatabase(Consumer<DeleteKxDatabaseRequest.Builder> deleteKxDatabaseRequest)	Deletes the specified database and all of its associated data.
default DeleteKxDatabaseResponse	deleteKxDatabase(DeleteKxDatabaseRequest deleteKxDatabaseRequest)	Deletes the specified database and all of its associated data.
default DeleteKxEnvironmentResponse	deleteKxEnvironment(Consumer<DeleteKxEnvironmentRequest.Builder> deleteKxEnvironmentRequest)	Deletes the kdb environment.
default DeleteKxEnvironmentResponse	deleteKxEnvironment(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest)	Deletes the kdb environment.
default DeleteKxUserResponse	deleteKxUser(Consumer<DeleteKxUserRequest.Builder> deleteKxUserRequest)	Deletes a user in the specified kdb environment.
default DeleteKxUserResponse	deleteKxUser(DeleteKxUserRequest deleteKxUserRequest)	Deletes a user in the specified kdb environment.
default GetEnvironmentResponse	getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)	Returns the FinSpace environment object.
default GetEnvironmentResponse	getEnvironment(GetEnvironmentRequest getEnvironmentRequest)	Returns the FinSpace environment object.
default GetKxChangesetResponse	getKxChangeset(Consumer<GetKxChangesetRequest.Builder> getKxChangesetRequest)	Returns information about a kdb changeset.
default GetKxChangesetResponse	getKxChangeset(GetKxChangesetRequest getKxChangesetRequest)	Returns information about a kdb changeset.
default GetKxClusterResponse	getKxCluster(Consumer<GetKxClusterRequest.Builder> getKxClusterRequest)	Retrieves information about a kdb cluster.
default GetKxClusterResponse	getKxCluster(GetKxClusterRequest getKxClusterRequest)	Retrieves information about a kdb cluster.
default GetKxConnectionStringResponse	getKxConnectionString(Consumer<GetKxConnectionStringRequest.Builder> getKxConnectionStringRequest)	Retrieves a connection string for a user to connect to a kdb cluster.
default GetKxConnectionStringResponse	getKxConnectionString(GetKxConnectionStringRequest getKxConnectionStringRequest)	Retrieves a connection string for a user to connect to a kdb cluster.
default GetKxDatabaseResponse	getKxDatabase(Consumer<GetKxDatabaseRequest.Builder> getKxDatabaseRequest)	Returns database information for the specified environment ID.
default GetKxDatabaseResponse	getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest)	Returns database information for the specified environment ID.
default GetKxEnvironmentResponse	getKxEnvironment(Consumer<GetKxEnvironmentRequest.Builder> getKxEnvironmentRequest)	Retrieves all the information for the specified kdb environment.
default GetKxEnvironmentResponse	getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest)	Retrieves all the information for the specified kdb environment.
default GetKxUserResponse	getKxUser(Consumer<GetKxUserRequest.Builder> getKxUserRequest)	Retrieves information about the specified kdb user.
default GetKxUserResponse	getKxUser(GetKxUserRequest getKxUserRequest)	Retrieves information about the specified kdb user.
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 ListKxChangesetsResponse	listKxChangesets(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest)	Returns a list of all the changesets for a database.
default ListKxChangesetsResponse	listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest)	Returns a list of all the changesets for a database.
default ListKxChangesetsIterable	listKxChangesetsPaginator(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest)	Returns a list of all the changesets for a database.
default ListKxChangesetsIterable	listKxChangesetsPaginator(ListKxChangesetsRequest listKxChangesetsRequest)	Returns a list of all the changesets for a database.
default ListKxClusterNodesResponse	listKxClusterNodes(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest)	Lists all the nodes in a kdb cluster.
default ListKxClusterNodesResponse	listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest)	Lists all the nodes in a kdb cluster.
default ListKxClusterNodesIterable	listKxClusterNodesPaginator(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest)	Lists all the nodes in a kdb cluster.
default ListKxClusterNodesIterable	listKxClusterNodesPaginator(ListKxClusterNodesRequest listKxClusterNodesRequest)	Lists all the nodes in a kdb cluster.
default ListKxClustersResponse	listKxClusters(Consumer<ListKxClustersRequest.Builder> listKxClustersRequest)	Returns a list of clusters.
default ListKxClustersResponse	listKxClusters(ListKxClustersRequest listKxClustersRequest)	Returns a list of clusters.
default ListKxDatabasesResponse	listKxDatabases(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest)	Returns a list of all the databases in the kdb environment.
default ListKxDatabasesResponse	listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest)	Returns a list of all the databases in the kdb environment.
default ListKxDatabasesIterable	listKxDatabasesPaginator(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest)	Returns a list of all the databases in the kdb environment.
default ListKxDatabasesIterable	listKxDatabasesPaginator(ListKxDatabasesRequest listKxDatabasesRequest)	Returns a list of all the databases in the kdb environment.
default ListKxEnvironmentsResponse	listKxEnvironments(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest)	Returns a list of kdb environments created in an account.
default ListKxEnvironmentsResponse	listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest)	Returns a list of kdb environments created in an account.
default ListKxEnvironmentsIterable	listKxEnvironmentsPaginator(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest)	Returns a list of kdb environments created in an account.
default ListKxEnvironmentsIterable	listKxEnvironmentsPaginator(ListKxEnvironmentsRequest listKxEnvironmentsRequest)	Returns a list of kdb environments created in an account.
default ListKxUsersResponse	listKxUsers(Consumer<ListKxUsersRequest.Builder> listKxUsersRequest)	Lists all the users in a kdb environment.
default ListKxUsersResponse	listKxUsers(ListKxUsersRequest listKxUsersRequest)	Lists all the users in a kdb environment.
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.
default FinspaceServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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.
default UpdateKxClusterCodeConfigurationResponse	updateKxClusterCodeConfiguration(Consumer<UpdateKxClusterCodeConfigurationRequest.Builder> updateKxClusterCodeConfigurationRequest)	Allows you to update code configuration on a running cluster.
default UpdateKxClusterCodeConfigurationResponse	updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest updateKxClusterCodeConfigurationRequest)	Allows you to update code configuration on a running cluster.
default UpdateKxClusterDatabasesResponse	updateKxClusterDatabases(Consumer<UpdateKxClusterDatabasesRequest.Builder> updateKxClusterDatabasesRequest)	Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached.
default UpdateKxClusterDatabasesResponse	updateKxClusterDatabases(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest)	Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached.
default UpdateKxDatabaseResponse	updateKxDatabase(Consumer<UpdateKxDatabaseRequest.Builder> updateKxDatabaseRequest)	Updates information for the given kdb database.
default UpdateKxDatabaseResponse	updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest)	Updates information for the given kdb database.
default UpdateKxEnvironmentResponse	updateKxEnvironment(Consumer<UpdateKxEnvironmentRequest.Builder> updateKxEnvironmentRequest)	Updates information for the given kdb environment.
default UpdateKxEnvironmentResponse	updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest)	Updates information for the given kdb environment.
default UpdateKxEnvironmentNetworkResponse	updateKxEnvironmentNetwork(Consumer<UpdateKxEnvironmentNetworkRequest.Builder> updateKxEnvironmentNetworkRequest)	Updates environment network to connect to your internal network by using a transit gateway.
default UpdateKxEnvironmentNetworkResponse	updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest updateKxEnvironmentNetworkRequest)	Updates environment network to connect to your internal network by using a transit gateway.
default UpdateKxUserResponse	updateKxUser(Consumer<UpdateKxUserRequest.Builder> updateKxUserRequest)	Updates the user details.
default UpdateKxUserResponse	updateKxUser(UpdateKxUserRequest updateKxUserRequest)	Updates the user details.

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

close

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

serviceName

Field Details

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 Details

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.

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.

See Also:

• AWS API Documentation

createKxChangeset

default CreateKxChangesetResponse createKxChangeset(CreateKxChangesetRequest createKxChangesetRequest)
                                             throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
LimitExceededException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.

Parameters:

createKxChangesetRequest -

Returns:

Result of the CreateKxChangeset operation returned by the service.

See Also:

• AWS API Documentation

createKxChangeset

default CreateKxChangesetResponse createKxChangeset(Consumer<CreateKxChangesetRequest.Builder> createKxChangesetRequest)
                                             throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
LimitExceededException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.

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

Parameters:

createKxChangesetRequest - A Consumer that will call methods on CreateKxChangesetRequest.Builder to create a request.

Returns:

Result of the CreateKxChangeset operation returned by the service.

See Also:

• AWS API Documentation

createKxCluster

default CreateKxClusterResponse createKxCluster(CreateKxClusterRequest createKxClusterRequest)
                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a new kdb cluster.

Parameters:

createKxClusterRequest -

Returns:

Result of the CreateKxCluster operation returned by the service.

See Also:

• AWS API Documentation

createKxCluster

default CreateKxClusterResponse createKxCluster(Consumer<CreateKxClusterRequest.Builder> createKxClusterRequest)
                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a new kdb cluster.

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

Parameters:

createKxClusterRequest - A Consumer that will call methods on CreateKxClusterRequest.Builder to create a request.

Returns:

Result of the CreateKxCluster operation returned by the service.

See Also:

• AWS API Documentation

createKxDatabase

default CreateKxDatabaseResponse createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
LimitExceededException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a new kdb database in the environment.

Parameters:

createKxDatabaseRequest -

Returns:

Result of the CreateKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

createKxDatabase

default CreateKxDatabaseResponse createKxDatabase(Consumer<CreateKxDatabaseRequest.Builder> createKxDatabaseRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ConflictException,
ResourceAlreadyExistsException,
ResourceNotFoundException,
LimitExceededException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a new kdb database in the environment.

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

Parameters:

createKxDatabaseRequest - A Consumer that will call methods on CreateKxDatabaseRequest.Builder to create a request.

Returns:

Result of the CreateKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

createKxEnvironment

default CreateKxEnvironmentResponse createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest)
                                                 throws InternalServerException,
ValidationException,
AccessDeniedException,
ThrottlingException,
ServiceQuotaExceededException,
LimitExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a managed kdb environment for the account.

Parameters:

createKxEnvironmentRequest -

Returns:

Result of the CreateKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

createKxEnvironment

default CreateKxEnvironmentResponse createKxEnvironment(Consumer<CreateKxEnvironmentRequest.Builder> createKxEnvironmentRequest)
                                                 throws InternalServerException,
ValidationException,
AccessDeniedException,
ThrottlingException,
ServiceQuotaExceededException,
LimitExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a managed kdb environment for the account.

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

Parameters:

createKxEnvironmentRequest - A Consumer that will call methods on CreateKxEnvironmentRequest.Builder to create a request.

Returns:

Result of the CreateKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

createKxUser

default CreateKxUserResponse createKxUser(CreateKxUserRequest createKxUserRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ValidationException,
ResourceAlreadyExistsException,
LimitExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a user in FinSpace kdb environment with an associated IAM role.

Parameters:

createKxUserRequest -

Returns:

Result of the CreateKxUser operation returned by the service.

See Also:

• AWS API Documentation

createKxUser

default CreateKxUserResponse createKxUser(Consumer<CreateKxUserRequest.Builder> createKxUserRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ValidationException,
ResourceAlreadyExistsException,
LimitExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Creates a user in FinSpace kdb environment with an associated IAM role.

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

Parameters:

createKxUserRequest - A Consumer that will call methods on CreateKxUserRequest.Builder to create a request.

Returns:

Result of the CreateKxUser operation returned by the service.

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.

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.

See Also:

• AWS API Documentation

deleteKxCluster

default DeleteKxClusterResponse deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest)
                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes a kdb cluster.

Parameters:

deleteKxClusterRequest -

Returns:

Result of the DeleteKxCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteKxCluster

default DeleteKxClusterResponse deleteKxCluster(Consumer<DeleteKxClusterRequest.Builder> deleteKxClusterRequest)
                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes a kdb cluster.

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

Parameters:

deleteKxClusterRequest - A Consumer that will call methods on DeleteKxClusterRequest.Builder to create a request.

Returns:

Result of the DeleteKxCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteKxDatabase

default DeleteKxDatabaseResponse deleteKxDatabase(DeleteKxDatabaseRequest deleteKxDatabaseRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.

Parameters:

deleteKxDatabaseRequest -

Returns:

Result of the DeleteKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

deleteKxDatabase

default DeleteKxDatabaseResponse deleteKxDatabase(Consumer<DeleteKxDatabaseRequest.Builder> deleteKxDatabaseRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.

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

Parameters:

deleteKxDatabaseRequest - A Consumer that will call methods on DeleteKxDatabaseRequest.Builder to create a request.

Returns:

Result of the DeleteKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

deleteKxEnvironment

default DeleteKxEnvironmentResponse deleteKxEnvironment(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest)
                                                 throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

Parameters:

deleteKxEnvironmentRequest -

Returns:

Result of the DeleteKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteKxEnvironment

default DeleteKxEnvironmentResponse deleteKxEnvironment(Consumer<DeleteKxEnvironmentRequest.Builder> deleteKxEnvironmentRequest)
                                                 throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

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

Parameters:

deleteKxEnvironmentRequest - A Consumer that will call methods on DeleteKxEnvironmentRequest.Builder to create a request.

Returns:

Result of the DeleteKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

deleteKxUser

default DeleteKxUserResponse deleteKxUser(DeleteKxUserRequest deleteKxUserRequest)
                                   throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes a user in the specified kdb environment.

Parameters:

deleteKxUserRequest -

Returns:

Result of the DeleteKxUser operation returned by the service.

See Also:

• AWS API Documentation

deleteKxUser

default DeleteKxUserResponse deleteKxUser(Consumer<DeleteKxUserRequest.Builder> deleteKxUserRequest)
                                   throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Deletes a user in the specified kdb environment.

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

Parameters:

deleteKxUserRequest - A Consumer that will call methods on DeleteKxUserRequest.Builder to create a request.

Returns:

Result of the DeleteKxUser operation returned by the service.

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.

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.

See Also:

• AWS API Documentation

getKxChangeset

default GetKxChangesetResponse getKxChangeset(GetKxChangesetRequest getKxChangesetRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns information about a kdb changeset.

Parameters:

getKxChangesetRequest -

Returns:

Result of the GetKxChangeset operation returned by the service.

See Also:

• AWS API Documentation

getKxChangeset

default GetKxChangesetResponse getKxChangeset(Consumer<GetKxChangesetRequest.Builder> getKxChangesetRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns information about a kdb changeset.

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

Parameters:

getKxChangesetRequest - A Consumer that will call methods on GetKxChangesetRequest.Builder to create a request.

Returns:

Result of the GetKxChangeset operation returned by the service.

See Also:

• AWS API Documentation

getKxCluster

default GetKxClusterResponse getKxCluster(GetKxClusterRequest getKxClusterRequest)
                                   throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves information about a kdb cluster.

Parameters:

getKxClusterRequest -

Returns:

Result of the GetKxCluster operation returned by the service.

See Also:

• AWS API Documentation

getKxCluster

default GetKxClusterResponse getKxCluster(Consumer<GetKxClusterRequest.Builder> getKxClusterRequest)
                                   throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves information about a kdb cluster.

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

Parameters:

getKxClusterRequest - A Consumer that will call methods on GetKxClusterRequest.Builder to create a request.

Returns:

Result of the GetKxCluster operation returned by the service.

See Also:

• AWS API Documentation

getKxConnectionString

default GetKxConnectionStringResponse getKxConnectionString(GetKxConnectionStringRequest getKxConnectionStringRequest)
                                                     throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.

Parameters:

getKxConnectionStringRequest -

Returns:

Result of the GetKxConnectionString operation returned by the service.

See Also:

• AWS API Documentation

getKxConnectionString

default GetKxConnectionStringResponse getKxConnectionString(Consumer<GetKxConnectionStringRequest.Builder> getKxConnectionStringRequest)
                                                     throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.

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

Parameters:

getKxConnectionStringRequest - A Consumer that will call methods on GetKxConnectionStringRequest.Builder to create a request.

Returns:

Result of the GetKxConnectionString operation returned by the service.

See Also:

• AWS API Documentation

getKxDatabase

default GetKxDatabaseResponse getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest)
                                     throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns database information for the specified environment ID.

Parameters:

getKxDatabaseRequest -

Returns:

Result of the GetKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

getKxDatabase

default GetKxDatabaseResponse getKxDatabase(Consumer<GetKxDatabaseRequest.Builder> getKxDatabaseRequest)
                                     throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns database information for the specified environment ID.

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

Parameters:

getKxDatabaseRequest - A Consumer that will call methods on GetKxDatabaseRequest.Builder to create a request.

Returns:

Result of the GetKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

getKxEnvironment

default GetKxEnvironmentResponse getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves all the information for the specified kdb environment.

Parameters:

getKxEnvironmentRequest -

Returns:

Result of the GetKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

getKxEnvironment

default GetKxEnvironmentResponse getKxEnvironment(Consumer<GetKxEnvironmentRequest.Builder> getKxEnvironmentRequest)
                                           throws ResourceNotFoundException,
InternalServerException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves all the information for the specified kdb environment.

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

Parameters:

getKxEnvironmentRequest - A Consumer that will call methods on GetKxEnvironmentRequest.Builder to create a request.

Returns:

Result of the GetKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

getKxUser

default GetKxUserResponse getKxUser(GetKxUserRequest getKxUserRequest)
                             throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves information about the specified kdb user.

Parameters:

getKxUserRequest -

Returns:

Result of the GetKxUser operation returned by the service.

See Also:

• AWS API Documentation

getKxUser

default GetKxUserResponse getKxUser(Consumer<GetKxUserRequest.Builder> getKxUserRequest)
                             throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Retrieves information about the specified kdb user.

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

Parameters:

getKxUserRequest - A Consumer that will call methods on GetKxUserRequest.Builder to create a request.

Returns:

Result of the GetKxUser operation returned by the service.

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.

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.

See Also:

• AWS API Documentation

listKxChangesets

default ListKxChangesetsResponse listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the changesets for a database.

Parameters:

listKxChangesetsRequest -

Returns:

Result of the ListKxChangesets operation returned by the service.

See Also:

• AWS API Documentation

listKxChangesets

default ListKxChangesetsResponse listKxChangesets(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the changesets for a database.

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

Parameters:

listKxChangesetsRequest - A Consumer that will call methods on ListKxChangesetsRequest.Builder to create a request.

Returns:

Result of the ListKxChangesets operation returned by the service.

See Also:

• AWS API Documentation

listKxChangesetsPaginator

default ListKxChangesetsIterable listKxChangesetsPaginator(ListKxChangesetsRequest listKxChangesetsRequest)
                                                    throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the changesets for a database.

This is a variant of listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client
             .listKxChangesetsPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation.

Parameters:

listKxChangesetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxChangesetsPaginator

default ListKxChangesetsIterable listKxChangesetsPaginator(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest)
                                                    throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the changesets for a database.

This is a variant of listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client
             .listKxChangesetsPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation.

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

Parameters:

listKxChangesetsRequest - A Consumer that will call methods on ListKxChangesetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxClusterNodes

default ListKxClusterNodesResponse listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest)
                                               throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Lists all the nodes in a kdb cluster.

Parameters:

listKxClusterNodesRequest -

Returns:

Result of the ListKxClusterNodes operation returned by the service.

See Also:

• AWS API Documentation

listKxClusterNodes

default ListKxClusterNodesResponse listKxClusterNodes(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest)
                                               throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Lists all the nodes in a kdb cluster.

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

Parameters:

listKxClusterNodesRequest - A Consumer that will call methods on ListKxClusterNodesRequest.Builder to create a request.

Returns:

Result of the ListKxClusterNodes operation returned by the service.

See Also:

• AWS API Documentation

listKxClusterNodesPaginator

default ListKxClusterNodesIterable listKxClusterNodesPaginator(ListKxClusterNodesRequest listKxClusterNodesRequest)
                                                        throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Lists all the nodes in a kdb cluster.

This is a variant of listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client
             .listKxClusterNodesPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest) operation.

Parameters:

listKxClusterNodesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxClusterNodesPaginator

default ListKxClusterNodesIterable listKxClusterNodesPaginator(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest)
                                                        throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Lists all the nodes in a kdb cluster.

This is a variant of listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client
             .listKxClusterNodesPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest) operation.

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

Parameters:

listKxClusterNodesRequest - A Consumer that will call methods on ListKxClusterNodesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxClusters

default ListKxClustersResponse listKxClusters(ListKxClustersRequest listKxClustersRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of clusters.

Parameters:

listKxClustersRequest -

Returns:

Result of the ListKxClusters operation returned by the service.

See Also:

• AWS API Documentation

listKxClusters

default ListKxClustersResponse listKxClusters(Consumer<ListKxClustersRequest.Builder> listKxClustersRequest)
                                       throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of clusters.

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

Parameters:

listKxClustersRequest - A Consumer that will call methods on ListKxClustersRequest.Builder to create a request.

Returns:

Result of the ListKxClusters operation returned by the service.

See Also:

• AWS API Documentation

listKxDatabases

default ListKxDatabasesResponse listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest)
                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the databases in the kdb environment.

Parameters:

listKxDatabasesRequest -

Returns:

Result of the ListKxDatabases operation returned by the service.

See Also:

• AWS API Documentation

listKxDatabases

default ListKxDatabasesResponse listKxDatabases(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest)
                                         throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the databases in the kdb environment.

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

Parameters:

listKxDatabasesRequest - A Consumer that will call methods on ListKxDatabasesRequest.Builder to create a request.

Returns:

Result of the ListKxDatabases operation returned by the service.

See Also:

• AWS API Documentation

listKxDatabasesPaginator

default ListKxDatabasesIterable listKxDatabasesPaginator(ListKxDatabasesRequest listKxDatabasesRequest)
                                                  throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the databases in the kdb environment.

This is a variant of listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client
             .listKxDatabasesPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation.

Parameters:

listKxDatabasesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxDatabasesPaginator

default ListKxDatabasesIterable listKxDatabasesPaginator(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest)
                                                  throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of all the databases in the kdb environment.

This is a variant of listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client
             .listKxDatabasesPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation.

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

Parameters:

listKxDatabasesRequest - A Consumer that will call methods on ListKxDatabasesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxEnvironments

default ListKxEnvironmentsResponse listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of kdb environments created in an account.

Parameters:

listKxEnvironmentsRequest -

Returns:

Result of the ListKxEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listKxEnvironments

default ListKxEnvironmentsResponse listKxEnvironments(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest)
                                               throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of kdb environments created in an account.

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

Parameters:

listKxEnvironmentsRequest - A Consumer that will call methods on ListKxEnvironmentsRequest.Builder to create a request.

Returns:

Result of the ListKxEnvironments operation returned by the service.

See Also:

• AWS API Documentation

listKxEnvironmentsPaginator

default ListKxEnvironmentsIterable listKxEnvironmentsPaginator(ListKxEnvironmentsRequest listKxEnvironmentsRequest)
                                                        throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of kdb environments created in an account.

This is a variant of listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client
             .listKxEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest) operation.

Parameters:

listKxEnvironmentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxEnvironmentsPaginator

default ListKxEnvironmentsIterable listKxEnvironmentsPaginator(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest)
                                                        throws InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Returns a list of kdb environments created in an account.

This is a variant of listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client
             .listKxEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest) operation.

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

Parameters:

listKxEnvironmentsRequest - A Consumer that will call methods on ListKxEnvironmentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listKxUsers

default ListKxUsersResponse listKxUsers(ListKxUsersRequest listKxUsersRequest)
                                 throws ResourceNotFoundException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Lists all the users in a kdb environment.

Parameters:

listKxUsersRequest -

Returns:

Result of the ListKxUsers operation returned by the service.

See Also:

• AWS API Documentation

listKxUsers

default ListKxUsersResponse listKxUsers(Consumer<ListKxUsersRequest.Builder> listKxUsersRequest)
                                 throws ResourceNotFoundException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
FinspaceException

Lists all the users in a kdb environment.

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

Parameters:

listKxUsersRequest - A Consumer that will call methods on ListKxUsersRequest.Builder to create a request.

Returns:

Result of the ListKxUsers operation returned by the service.

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.

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.

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.

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.

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.

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.

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.

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.

See Also:

• AWS API Documentation

updateKxClusterCodeConfiguration

default UpdateKxClusterCodeConfigurationResponse updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest updateKxClusterCodeConfigurationRequest)
                                                                           throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.

Parameters:

updateKxClusterCodeConfigurationRequest -

Returns:

Result of the UpdateKxClusterCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateKxClusterCodeConfiguration

default UpdateKxClusterCodeConfigurationResponse updateKxClusterCodeConfiguration(Consumer<UpdateKxClusterCodeConfigurationRequest.Builder> updateKxClusterCodeConfigurationRequest)
                                                                           throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.

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

Parameters:

updateKxClusterCodeConfigurationRequest - A Consumer that will call methods on UpdateKxClusterCodeConfigurationRequest.Builder to create a request.

Returns:

Result of the UpdateKxClusterCodeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateKxClusterDatabases

default UpdateKxClusterDatabasesResponse updateKxClusterDatabases(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest)
                                                           throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

Parameters:

updateKxClusterDatabasesRequest -

Returns:

Result of the UpdateKxClusterDatabases operation returned by the service.

See Also:

• AWS API Documentation

updateKxClusterDatabases

default UpdateKxClusterDatabasesResponse updateKxClusterDatabases(Consumer<UpdateKxClusterDatabasesRequest.Builder> updateKxClusterDatabasesRequest)
                                                           throws InternalServerException,
ThrottlingException,
AccessDeniedException,
LimitExceededException,
ValidationException,
ConflictException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

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

Parameters:

updateKxClusterDatabasesRequest - A Consumer that will call methods on UpdateKxClusterDatabasesRequest.Builder to create a request.

Returns:

Result of the UpdateKxClusterDatabases operation returned by the service.

See Also:

• AWS API Documentation

updateKxDatabase

default UpdateKxDatabaseResponse updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates information for the given kdb database.

Parameters:

updateKxDatabaseRequest -

Returns:

Result of the UpdateKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

updateKxDatabase

default UpdateKxDatabaseResponse updateKxDatabase(Consumer<UpdateKxDatabaseRequest.Builder> updateKxDatabaseRequest)
                                           throws InternalServerException,
ValidationException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates information for the given kdb database.

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

Parameters:

updateKxDatabaseRequest - A Consumer that will call methods on UpdateKxDatabaseRequest.Builder to create a request.

Returns:

Result of the UpdateKxDatabase operation returned by the service.

See Also:

• AWS API Documentation

updateKxEnvironment

default UpdateKxEnvironmentResponse updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest)
                                                 throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates information for the given kdb environment.

Parameters:

updateKxEnvironmentRequest -

Returns:

Result of the UpdateKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

updateKxEnvironment

default UpdateKxEnvironmentResponse updateKxEnvironment(Consumer<UpdateKxEnvironmentRequest.Builder> updateKxEnvironmentRequest)
                                                 throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates information for the given kdb environment.

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

Parameters:

updateKxEnvironmentRequest - A Consumer that will call methods on UpdateKxEnvironmentRequest.Builder to create a request.

Returns:

Result of the UpdateKxEnvironment operation returned by the service.

See Also:

• AWS API Documentation

updateKxEnvironmentNetwork

default UpdateKxEnvironmentNetworkResponse updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest updateKxEnvironmentNetworkRequest)
                                                               throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.

Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

Parameters:

updateKxEnvironmentNetworkRequest -

Returns:

Result of the UpdateKxEnvironmentNetwork operation returned by the service.

See Also:

• AWS API Documentation

updateKxEnvironmentNetwork

default UpdateKxEnvironmentNetworkResponse updateKxEnvironmentNetwork(Consumer<UpdateKxEnvironmentNetworkRequest.Builder> updateKxEnvironmentNetworkRequest)
                                                               throws ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.

Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.

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

Parameters:

updateKxEnvironmentNetworkRequest - A Consumer that will call methods on UpdateKxEnvironmentNetworkRequest.Builder to create a request.

Returns:

Result of the UpdateKxEnvironmentNetwork operation returned by the service.

See Also:

• AWS API Documentation

updateKxUser

default UpdateKxUserResponse updateKxUser(UpdateKxUserRequest updateKxUserRequest)
                                   throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
LimitExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates the user details. You can only update the IAM role associated with a user.

Parameters:

updateKxUserRequest -

Returns:

Result of the UpdateKxUser operation returned by the service.

See Also:

• AWS API Documentation

updateKxUser

default UpdateKxUserResponse updateKxUser(Consumer<UpdateKxUserRequest.Builder> updateKxUserRequest)
                                   throws InternalServerException,
ThrottlingException,
AccessDeniedException,
ResourceNotFoundException,
ValidationException,
LimitExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
FinspaceException

Updates the user details. You can only update the IAM role associated with a user.

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

Parameters:

updateKxUserRequest - A Consumer that will call methods on UpdateKxUserRequest.Builder to create a request.

Returns:

Result of the UpdateKxUser operation returned by the service.

See Also:

• AWS API Documentation

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.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default FinspaceServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration