com.amazonaws.services.finspace

Interface AWSfinspace

All Known Subinterfaces:

AWSfinspaceAsync

All Known Implementing Classes:

AbstractAWSfinspace, AbstractAWSfinspaceAsync, AWSfinspaceAsyncClient, AWSfinspaceClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSfinspace

Interface for accessing finspace.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSfinspace instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Deprecated.
CreateKxChangesetResult	createKxChangeset(CreateKxChangesetRequest createKxChangesetRequest) Creates a changeset for a kdb database.
CreateKxClusterResult	createKxCluster(CreateKxClusterRequest createKxClusterRequest) Creates a new kdb cluster.
CreateKxDatabaseResult	createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest) Creates a new kdb database in the environment.
CreateKxDataviewResult	createKxDataview(CreateKxDataviewRequest createKxDataviewRequest) Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.
CreateKxEnvironmentResult	createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest) Creates a managed kdb environment for the account.
CreateKxScalingGroupResult	createKxScalingGroup(CreateKxScalingGroupRequest createKxScalingGroupRequest) Creates a new scaling group.
CreateKxUserResult	createKxUser(CreateKxUserRequest createKxUserRequest) Creates a user in FinSpace kdb environment with an associated IAM role.
CreateKxVolumeResult	createKxVolume(CreateKxVolumeRequest createKxVolumeRequest) Creates a new volume with a specific amount of throughput and storage capacity.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deprecated.
DeleteKxClusterResult	deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest) Deletes a kdb cluster.
DeleteKxClusterNodeResult	deleteKxClusterNode(DeleteKxClusterNodeRequest deleteKxClusterNodeRequest) Deletes the specified nodes from a cluster.
DeleteKxDatabaseResult	deleteKxDatabase(DeleteKxDatabaseRequest deleteKxDatabaseRequest) Deletes the specified database and all of its associated data.
DeleteKxDataviewResult	deleteKxDataview(DeleteKxDataviewRequest deleteKxDataviewRequest) Deletes the specified dataview.
DeleteKxEnvironmentResult	deleteKxEnvironment(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest) Deletes the kdb environment.
DeleteKxScalingGroupResult	deleteKxScalingGroup(DeleteKxScalingGroupRequest deleteKxScalingGroupRequest) Deletes the specified scaling group.
DeleteKxUserResult	deleteKxUser(DeleteKxUserRequest deleteKxUserRequest) Deletes a user in the specified kdb environment.
DeleteKxVolumeResult	deleteKxVolume(DeleteKxVolumeRequest deleteKxVolumeRequest) Deletes a volume.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetEnvironmentResult	getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Deprecated.
GetKxChangesetResult	getKxChangeset(GetKxChangesetRequest getKxChangesetRequest) Returns information about a kdb changeset.
GetKxClusterResult	getKxCluster(GetKxClusterRequest getKxClusterRequest) Retrieves information about a kdb cluster.
GetKxConnectionStringResult	getKxConnectionString(GetKxConnectionStringRequest getKxConnectionStringRequest) Retrieves a connection string for a user to connect to a kdb cluster.
GetKxDatabaseResult	getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest) Returns database information for the specified environment ID.
GetKxDataviewResult	getKxDataview(GetKxDataviewRequest getKxDataviewRequest) Retrieves details of the dataview.
GetKxEnvironmentResult	getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest) Retrieves all the information for the specified kdb environment.
GetKxScalingGroupResult	getKxScalingGroup(GetKxScalingGroupRequest getKxScalingGroupRequest) Retrieves details of a scaling group.
GetKxUserResult	getKxUser(GetKxUserRequest getKxUserRequest) Retrieves information about the specified kdb user.
GetKxVolumeResult	getKxVolume(GetKxVolumeRequest getKxVolumeRequest) Retrieves the information about the volume.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Deprecated.
ListKxChangesetsResult	listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest) Returns a list of all the changesets for a database.
ListKxClusterNodesResult	listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest) Lists all the nodes in a kdb cluster.
ListKxClustersResult	listKxClusters(ListKxClustersRequest listKxClustersRequest) Returns a list of clusters.
ListKxDatabasesResult	listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest) Returns a list of all the databases in the kdb environment.
ListKxDataviewsResult	listKxDataviews(ListKxDataviewsRequest listKxDataviewsRequest) Returns a list of all the dataviews in the database.
ListKxEnvironmentsResult	listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest) Returns a list of kdb environments created in an account.
ListKxScalingGroupsResult	listKxScalingGroups(ListKxScalingGroupsRequest listKxScalingGroupsRequest) Returns a list of scaling groups in a kdb environment.
ListKxUsersResult	listKxUsers(ListKxUsersRequest listKxUsersRequest) Lists all the users in a kdb environment.
ListKxVolumesResult	listKxVolumes(ListKxVolumesRequest listKxVolumesRequest) Lists all the volumes in a kdb environment.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) A list of all tags for a resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds metadata tags to a FinSpace resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from a FinSpace resource.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Deprecated.
UpdateKxClusterCodeConfigurationResult	updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest updateKxClusterCodeConfigurationRequest) Allows you to update code configuration on a running cluster.
UpdateKxClusterDatabasesResult	updateKxClusterDatabases(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest) Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached.
UpdateKxDatabaseResult	updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest) Updates information for the given kdb database.
UpdateKxDataviewResult	updateKxDataview(UpdateKxDataviewRequest updateKxDataviewRequest) Updates the specified dataview.
UpdateKxEnvironmentResult	updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest) Updates information for the given kdb environment.
UpdateKxEnvironmentNetworkResult	updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest updateKxEnvironmentNetworkRequest) Updates environment network to connect to your internal network by using a transit gateway.
UpdateKxUserResult	updateKxUser(UpdateKxUserRequest updateKxUserRequest) Updates the user details.
UpdateKxVolumeResult	updateKxVolume(UpdateKxVolumeRequest updateKxVolumeRequest) Updates the throughput or capacity of a volume.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createEnvironment

@Deprecated
CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)

Deprecated.

Create a new FinSpace environment.

Parameters:

createEnvironmentRequest -

Returns:

Result of the CreateEnvironment operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

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

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A service limit or quota is exceeded.

See Also:

AWS API Documentation

createKxChangeset

CreateKxChangesetResult createKxChangeset(CreateKxChangesetRequest createKxChangesetRequest)

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

Parameters:

createKxChangesetRequest -

Returns:

Result of the CreateKxChangeset operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

ConflictException - There was a conflict with this action, and it could not be completed.

LimitExceededException - A service limit or quota is exceeded.

See Also:

AWS API Documentation

createKxCluster

CreateKxClusterResult createKxCluster(CreateKxClusterRequest createKxClusterRequest)

Creates a new kdb cluster.

Parameters:

createKxClusterRequest -

Returns:

Result of the CreateKxCluster operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

createKxDatabase

CreateKxDatabaseResult createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest)

Creates a new kdb database in the environment.

Parameters:

createKxDatabaseRequest -

Returns:

Result of the CreateKxDatabase operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

ConflictException - 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.

See Also:

AWS API Documentation

createKxDataview

CreateKxDataviewResult createKxDataview(CreateKxDataviewRequest createKxDataviewRequest)

Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.

Parameters:

createKxDataviewRequest -

Returns:

Result of the CreateKxDataview operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

ConflictException - There was a conflict with this action, and it could not be completed.

LimitExceededException - A service limit or quota is exceeded.

ResourceAlreadyExistsException - The specified resource group already exists.

See Also:

AWS API Documentation

createKxEnvironment

CreateKxEnvironmentResult createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest)

Creates a managed kdb environment for the account.

Parameters:

createKxEnvironmentRequest -

Returns:

Result of the CreateKxEnvironment operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

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

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A service limit or quota is exceeded.

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

createKxScalingGroup

CreateKxScalingGroupResult createKxScalingGroup(CreateKxScalingGroupRequest createKxScalingGroupRequest)

Creates a new scaling group.

Parameters:

createKxScalingGroupRequest -

Returns:

Result of the CreateKxScalingGroup operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

createKxUser

CreateKxUserResult createKxUser(CreateKxUserRequest createKxUserRequest)

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

Parameters:

createKxUserRequest -

Returns:

Result of the CreateKxUser operation returned by the service.

Throws:

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

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

ThrottlingException - The request was denied due to request throttling.

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.

See Also:

AWS API Documentation

createKxVolume

CreateKxVolumeResult createKxVolume(CreateKxVolumeRequest createKxVolumeRequest)

Creates a new volume with a specific amount of throughput and storage capacity.

Parameters:

createKxVolumeRequest -

Returns:

Result of the CreateKxVolume operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

ResourceAlreadyExistsException - The specified resource group already exists.

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

See Also:

AWS API Documentation

deleteEnvironment

@Deprecated
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)

Deprecated.

Delete an FinSpace environment.

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment operation returned by the service.

Throws:

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

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

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

deleteKxCluster

DeleteKxClusterResult deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest)

Deletes a kdb cluster.

Parameters:

deleteKxClusterRequest -

Returns:

Result of the DeleteKxCluster operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

deleteKxClusterNode

DeleteKxClusterNodeResult deleteKxClusterNode(DeleteKxClusterNodeRequest deleteKxClusterNodeRequest)

Deletes the specified nodes from a cluster.

Parameters:

deleteKxClusterNodeRequest -

Returns:

Result of the DeleteKxClusterNode operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

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

See Also:

AWS API Documentation

deleteKxDatabase

DeleteKxDatabaseResult deleteKxDatabase(DeleteKxDatabaseRequest deleteKxDatabaseRequest)

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

Parameters:

deleteKxDatabaseRequest -

Returns:

Result of the DeleteKxDatabase operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

deleteKxDataview

DeleteKxDataviewResult deleteKxDataview(DeleteKxDataviewRequest deleteKxDataviewRequest)

Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.

Parameters:

deleteKxDataviewRequest -

Returns:

Result of the DeleteKxDataview operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

deleteKxEnvironment

DeleteKxEnvironmentResult deleteKxEnvironment(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest)

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

Parameters:

deleteKxEnvironmentRequest -

Returns:

Result of the DeleteKxEnvironment operation returned by the service.

Throws:

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

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

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

deleteKxScalingGroup

DeleteKxScalingGroupResult deleteKxScalingGroup(DeleteKxScalingGroupRequest deleteKxScalingGroupRequest)

Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.

Parameters:

deleteKxScalingGroupRequest -

Returns:

Result of the DeleteKxScalingGroup operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

deleteKxUser

DeleteKxUserResult deleteKxUser(DeleteKxUserRequest deleteKxUserRequest)

Deletes a user in the specified kdb environment.

Parameters:

deleteKxUserRequest -

Returns:

Result of the DeleteKxUser operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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

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.

See Also:

AWS API Documentation

deleteKxVolume

DeleteKxVolumeResult deleteKxVolume(DeleteKxVolumeRequest deleteKxVolumeRequest)

Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

Parameters:

deleteKxVolumeRequest -

Returns:

Result of the DeleteKxVolume operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

getEnvironment

@Deprecated
GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)

Deprecated.

Returns the FinSpace environment object.

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment operation returned by the service.

Throws:

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

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

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

See Also:

AWS API Documentation

getKxChangeset

GetKxChangesetResult getKxChangeset(GetKxChangesetRequest getKxChangesetRequest)

Returns information about a kdb changeset.

Parameters:

getKxChangesetRequest -

Returns:

Result of the GetKxChangeset operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

See Also:

AWS API Documentation

getKxCluster

GetKxClusterResult getKxCluster(GetKxClusterRequest getKxClusterRequest)

Retrieves information about a kdb cluster.

Parameters:

getKxClusterRequest -

Returns:

Result of the GetKxCluster operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

getKxConnectionString

GetKxConnectionStringResult getKxConnectionString(GetKxConnectionStringRequest getKxConnectionStringRequest)

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

Parameters:

getKxConnectionStringRequest -

Returns:

Result of the GetKxConnectionString operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

getKxDatabase

GetKxDatabaseResult getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest)

Returns database information for the specified environment ID.

Parameters:

getKxDatabaseRequest -

Returns:

Result of the GetKxDatabase operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

See Also:

AWS API Documentation

getKxDataview

GetKxDataviewResult getKxDataview(GetKxDataviewRequest getKxDataviewRequest)

Retrieves details of the dataview.

Parameters:

getKxDataviewRequest -

Returns:

Result of the GetKxDataview operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

See Also:

AWS API Documentation

getKxEnvironment

GetKxEnvironmentResult getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest)

Retrieves all the information for the specified kdb environment.

Parameters:

getKxEnvironmentRequest -

Returns:

Result of the GetKxEnvironment operation returned by the service.

Throws:

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

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

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

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

getKxScalingGroup

GetKxScalingGroupResult getKxScalingGroup(GetKxScalingGroupRequest getKxScalingGroupRequest)

Retrieves details of a scaling group.

Parameters:

getKxScalingGroupRequest -

Returns:

Result of the GetKxScalingGroup operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

getKxUser

GetKxUserResult getKxUser(GetKxUserRequest getKxUserRequest)

Retrieves information about the specified kdb user.

Parameters:

getKxUserRequest -

Returns:

Result of the GetKxUser operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

getKxVolume

GetKxVolumeResult getKxVolume(GetKxVolumeRequest getKxVolumeRequest)

Retrieves the information about the volume.

Parameters:

getKxVolumeRequest -

Returns:

Result of the GetKxVolume operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

listEnvironments

@Deprecated
ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)

Deprecated.

A list of all of your FinSpace environments.

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

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

See Also:

AWS API Documentation

listKxChangesets

ListKxChangesetsResult listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest)

Returns a list of all the changesets for a database.

Parameters:

listKxChangesetsRequest -

Returns:

Result of the ListKxChangesets operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

See Also:

AWS API Documentation

listKxClusterNodes

ListKxClusterNodesResult listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest)

Lists all the nodes in a kdb cluster.

Parameters:

listKxClusterNodesRequest -

Returns:

Result of the ListKxClusterNodes operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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.

See Also:

AWS API Documentation

listKxClusters

ListKxClustersResult listKxClusters(ListKxClustersRequest listKxClustersRequest)

Returns a list of clusters.

Parameters:

listKxClustersRequest -

Returns:

Result of the ListKxClusters operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

listKxDatabases

ListKxDatabasesResult listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest)

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

Parameters:

listKxDatabasesRequest -

Returns:

Result of the ListKxDatabases operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

See Also:

AWS API Documentation

listKxDataviews

ListKxDataviewsResult listKxDataviews(ListKxDataviewsRequest listKxDataviewsRequest)

Returns a list of all the dataviews in the database.

Parameters:

listKxDataviewsRequest -

Returns:

Result of the ListKxDataviews operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

See Also:

AWS API Documentation

listKxEnvironments

ListKxEnvironmentsResult listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest)

Returns a list of kdb environments created in an account.

Parameters:

listKxEnvironmentsRequest -

Returns:

Result of the ListKxEnvironments operation returned by the service.

Throws:

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

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

listKxScalingGroups

ListKxScalingGroupsResult listKxScalingGroups(ListKxScalingGroupsRequest listKxScalingGroupsRequest)

Returns a list of scaling groups in a kdb environment.

Parameters:

listKxScalingGroupsRequest -

Returns:

Result of the ListKxScalingGroups operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

listKxUsers

ListKxUsersResult listKxUsers(ListKxUsersRequest listKxUsersRequest)

Lists all the users in a kdb environment.

Parameters:

listKxUsersRequest -

Returns:

Result of the ListKxUsers operation returned by the service.

Throws:

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

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

ThrottlingException - The request was denied due to request throttling.

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

listKxVolumes

ListKxVolumesResult listKxVolumes(ListKxVolumesRequest listKxVolumesRequest)

Lists all the volumes in a kdb environment.

Parameters:

listKxVolumesRequest -

Returns:

Result of the ListKxVolumes operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

LimitExceededException - A 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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

A list of all tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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

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

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

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds metadata tags to a FinSpace resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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

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

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

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes metadata tags from a FinSpace resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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

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

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

See Also:

AWS API Documentation

updateEnvironment

@Deprecated
UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)

Deprecated.

Update your FinSpace environment.

Parameters:

updateEnvironmentRequest -

Returns:

Result of the UpdateEnvironment operation returned by the service.

Throws:

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

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

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

updateKxClusterCodeConfiguration

UpdateKxClusterCodeConfigurationResult updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest updateKxClusterCodeConfigurationRequest)

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

Parameters:

updateKxClusterCodeConfigurationRequest -

Returns:

Result of the UpdateKxClusterCodeConfiguration operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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.

See Also:

AWS API Documentation

updateKxClusterDatabases

UpdateKxClusterDatabasesResult updateKxClusterDatabases(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest)

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

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

Parameters:

updateKxClusterDatabasesRequest -

Returns:

Result of the UpdateKxClusterDatabases operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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.

See Also:

AWS API Documentation

updateKxDatabase

UpdateKxDatabaseResult updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest)

Updates information for the given kdb database.

Parameters:

updateKxDatabaseRequest -

Returns:

Result of the UpdateKxDatabase operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

updateKxDataview

UpdateKxDataviewResult updateKxDataview(UpdateKxDataviewRequest updateKxDataviewRequest)

Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations

Parameters:

updateKxDataviewRequest -

Returns:

Result of the UpdateKxDataview operation returned by the service.

Throws:

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

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ThrottlingException - The request was denied due to request throttling.

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

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

ConflictException - There was a conflict with this action, and it could not be completed.

ResourceAlreadyExistsException - The specified resource group already exists.

See Also:

AWS API Documentation

updateKxEnvironment

UpdateKxEnvironmentResult updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest)

Updates information for the given kdb environment.

Parameters:

updateKxEnvironmentRequest -

Returns:

Result of the UpdateKxEnvironment operation returned by the service.

Throws:

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

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

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

updateKxEnvironmentNetwork

UpdateKxEnvironmentNetworkResult updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest updateKxEnvironmentNetworkRequest)

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

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

Parameters:

updateKxEnvironmentNetworkRequest -

Returns:

Result of the UpdateKxEnvironmentNetwork operation returned by the service.

Throws:

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

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

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

ConflictException - There was a conflict with this action, and it could not be completed.

See Also:

AWS API Documentation

updateKxUser

UpdateKxUserResult updateKxUser(UpdateKxUserRequest updateKxUserRequest)

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

Parameters:

updateKxUserRequest -

Returns:

Result of the UpdateKxUser operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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.

See Also:

AWS API Documentation

updateKxVolume

UpdateKxVolumeResult updateKxVolume(UpdateKxVolumeRequest updateKxVolumeRequest)

Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.

Parameters:

updateKxVolumeRequest -

Returns:

Result of the UpdateKxVolume operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

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

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.