@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface FinspaceClient extends AwsClient
builder() method.
The FinSpace management service provides the APIs for managing FinSpace environments.
| 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 |
| 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 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() |
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 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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException
Create a new FinSpace environment.
createEnvironmentRequest - 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.AwsServiceExceptiondefault 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()
createEnvironmentRequest - A Consumer that will call methods on
CreateEnvironmentRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
createKxChangesetRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
createKxChangesetRequest - A Consumer that will call methods on
CreateKxChangesetRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault CreateKxClusterResponse createKxCluster(CreateKxClusterRequest createKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Creates a new kdb cluster.
createKxClusterRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
createKxClusterRequest - A Consumer that will call methods on
CreateKxClusterRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault CreateKxDatabaseResponse createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException
Creates a new kdb database in the environment.
createKxDatabaseRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - There was a conflict with this action, and it could not be completed.ResourceAlreadyExistsException - The specified resource group already exists.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
createKxDatabaseRequest - A Consumer that will call methods on
CreateKxDatabaseRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ConflictException - There was a conflict with this action, and it could not be completed.ResourceAlreadyExistsException - The specified resource group already exists.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault CreateKxEnvironmentResponse createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceException
Creates a managed kdb environment for the account.
createKxEnvironmentRequest - 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.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
createKxEnvironmentRequest - A Consumer that will call methods on
CreateKxEnvironmentRequest.Builder to create a
request.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.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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.
createKxUserRequest - ResourceNotFoundException - One or more resources can't be found.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceAlreadyExistsException - The specified resource group already exists.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
createKxUserRequest - A Consumer that will call methods on
CreateKxUserRequest.Builder to create a request.ResourceNotFoundException - One or more resources can't be found.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ResourceAlreadyExistsException - The specified resource group already exists.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceException
Delete an FinSpace environment.
deleteEnvironmentRequest - 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.AwsServiceExceptiondefault 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()
deleteEnvironmentRequest - A Consumer that will call methods on
DeleteEnvironmentRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteKxClusterResponse deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Deletes a kdb cluster.
deleteKxClusterRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
deleteKxClusterRequest - A Consumer that will call methods on
DeleteKxClusterRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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.
deleteKxDatabaseRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
deleteKxDatabaseRequest - A Consumer that will call methods on
DeleteKxDatabaseRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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.
deleteKxEnvironmentRequest - 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.AwsServiceExceptiondefault 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()
deleteKxEnvironmentRequest - A Consumer that will call methods on
DeleteKxEnvironmentRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteKxUserResponse deleteKxUser(DeleteKxUserRequest deleteKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, FinspaceException
Deletes a user in the specified kdb environment.
deleteKxUserRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
deleteKxUserRequest - A Consumer that will call methods on
DeleteKxUserRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceException
Returns the FinSpace environment object.
getEnvironmentRequest - 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.AwsServiceExceptiondefault 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()
getEnvironmentRequest - A Consumer that will call methods on
GetEnvironmentRequest.Builder to create a request.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.AwsServiceExceptiondefault GetKxChangesetResponse getKxChangeset(GetKxChangesetRequest getKxChangesetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Returns information about a kdb changeset.
getKxChangesetRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
getKxChangesetRequest - A Consumer that will call methods on
GetKxChangesetRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault GetKxClusterResponse getKxCluster(GetKxClusterRequest getKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Retrieves information about a kdb cluster.
getKxClusterRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
getKxClusterRequest - A Consumer that will call methods on
GetKxClusterRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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.
getKxConnectionStringRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
getKxConnectionStringRequest - A Consumer that will call methods on
GetKxConnectionStringRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault GetKxDatabaseResponse getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Returns database information for the specified environment ID.
getKxDatabaseRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
getKxDatabaseRequest - A Consumer that will call methods on
GetKxDatabaseRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault GetKxEnvironmentResponse getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceException
Retrieves all the information for the specified kdb environment.
getKxEnvironmentRequest - 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.AwsServiceExceptiondefault 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()
getKxEnvironmentRequest - A Consumer that will call methods on
GetKxEnvironmentRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetKxUserResponse getKxUser(GetKxUserRequest getKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, FinspaceException
Retrieves information about the specified kdb user.
getKxUserRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
getKxUserRequest - A Consumer that will call methods on
GetKxUserRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, FinspaceException
A list of all of your FinSpace environments.
listEnvironmentsRequest - 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.AwsServiceExceptiondefault 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()
listEnvironmentsRequest - A Consumer that will call methods on
ListEnvironmentsRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListKxChangesetsResponse listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Returns a list of all the changesets for a database.
listKxChangesetsRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
listKxChangesetsRequest - A Consumer that will call methods on
ListKxChangesetsRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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.
listKxChangesetsRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
listKxChangesetsRequest - A Consumer that will call methods on
ListKxChangesetsRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault ListKxClusterNodesResponse listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Lists all the nodes in a kdb cluster.
listKxClusterNodesRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ValidationException - The input fails to satisfy the constraints specified by an AWS service.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.AwsServiceExceptiondefault 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()
listKxClusterNodesRequest - A Consumer that will call methods on
ListKxClusterNodesRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ValidationException - The input fails to satisfy the constraints specified by an AWS service.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.AwsServiceExceptiondefault 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.
listKxClusterNodesRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ValidationException - The input fails to satisfy the constraints specified by an AWS service.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.AwsServiceExceptiondefault 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()
listKxClusterNodesRequest - A Consumer that will call methods on
ListKxClusterNodesRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ValidationException - The input fails to satisfy the constraints specified by an AWS service.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.AwsServiceExceptiondefault ListKxClustersResponse listKxClusters(ListKxClustersRequest listKxClustersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Returns a list of clusters.
listKxClustersRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
listKxClustersRequest - A Consumer that will call methods on
ListKxClustersRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault ListKxDatabasesResponse listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Returns a list of all the databases in the kdb environment.
listKxDatabasesRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
listKxDatabasesRequest - A Consumer that will call methods on
ListKxDatabasesRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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.
listKxDatabasesRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault 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()
listKxDatabasesRequest - A Consumer that will call methods on
ListKxDatabasesRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.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.AwsServiceExceptiondefault ListKxEnvironmentsResponse listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest) throws InternalServerException, ValidationException, AwsServiceException, SdkClientException, FinspaceException
Returns a list of kdb environments created in an account.
listKxEnvironmentsRequest - 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.AwsServiceExceptiondefault 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()
listKxEnvironmentsRequest - A Consumer that will call methods on
ListKxEnvironmentsRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
listKxEnvironmentsRequest - 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.AwsServiceExceptiondefault 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()
listKxEnvironmentsRequest - A Consumer that will call methods on
ListKxEnvironmentsRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListKxUsersResponse listKxUsers(ListKxUsersRequest listKxUsersRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, FinspaceException
Lists all the users in a kdb environment.
listKxUsersRequest - ResourceNotFoundException - One or more resources can't be found.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.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.AwsServiceExceptiondefault 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()
listKxUsersRequest - A Consumer that will call methods on
ListKxUsersRequest.Builder to create a request.ResourceNotFoundException - One or more resources can't be found.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
A list of all tags for a resource.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault 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()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Adds metadata tags to a FinSpace resource.
tagResourceRequest - 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.AwsServiceExceptiondefault 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()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException
Removes metadata tags from a FinSpace resource.
untagResourceRequest - 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.AwsServiceExceptiondefault 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()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceException
Update your FinSpace environment.
updateEnvironmentRequest - 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.AwsServiceExceptiondefault 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()
updateEnvironmentRequest - A Consumer that will call methods on
UpdateEnvironmentRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
updateKxClusterDatabasesRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
updateKxClusterDatabasesRequest - A Consumer that will call methods on
UpdateKxClusterDatabasesRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.LimitExceededException - A service limit or quota is exceeded.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault UpdateKxDatabaseResponse updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceException
Updates information for the given kdb database.
updateKxDatabaseRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
updateKxDatabaseRequest - A Consumer that will call methods on
UpdateKxDatabaseRequest.Builder to create a
request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ValidationException - The input fails to satisfy the constraints specified by an AWS service.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault UpdateKxEnvironmentResponse updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException
Updates information for the given kdb environment.
updateKxEnvironmentRequest - 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.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
updateKxEnvironmentRequest - A Consumer that will call methods on
UpdateKxEnvironmentRequest.Builder to create a
request.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.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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.
updateKxEnvironmentNetworkRequest - 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.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
updateKxEnvironmentNetworkRequest - A Consumer that will call methods on
UpdateKxEnvironmentNetworkRequest.Builder to create
a request.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.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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.
updateKxUserRequest - InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptiondefault 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()
updateKxUserRequest - A Consumer that will call methods on
UpdateKxUserRequest.Builder to create a request.InternalServerException - The request processing has failed because of an unknown error, exception or failure.ThrottlingException - The request was denied due to request throttling.AccessDeniedException - You do not have sufficient access to perform this action.ResourceNotFoundException - One or more resources can't be found.ValidationException - The input fails to satisfy the constraints specified by an AWS service.LimitExceededException - A service limit or quota is exceeded.ConflictException - There was a conflict with this action, and it could not be completed.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.AwsServiceExceptionstatic FinspaceClient create()
FinspaceClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static FinspaceClientBuilder builder()
FinspaceClient.static ServiceMetadata serviceMetadata()
default FinspaceServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.