com.amazonaws.services.finspace

Class AWSfinspaceClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.finspace.AWSfinspaceClient

All Implemented Interfaces:

AWSfinspace

Direct Known Subclasses:

AWSfinspaceAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSfinspaceClient
extends AmazonWebServiceClient
implements AWSfinspace

Client for accessing finspace. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.finspace.AWSfinspace

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSfinspaceClientBuilder	builder()
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest request) Deprecated.
CreateKxChangesetResult	createKxChangeset(CreateKxChangesetRequest request) Creates a changeset for a kdb database.
CreateKxClusterResult	createKxCluster(CreateKxClusterRequest request) Creates a new kdb cluster.
CreateKxDatabaseResult	createKxDatabase(CreateKxDatabaseRequest request) Creates a new kdb database in the environment.
CreateKxDataviewResult	createKxDataview(CreateKxDataviewRequest request) Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.
CreateKxEnvironmentResult	createKxEnvironment(CreateKxEnvironmentRequest request) Creates a managed kdb environment for the account.
CreateKxScalingGroupResult	createKxScalingGroup(CreateKxScalingGroupRequest request) Creates a new scaling group.
CreateKxUserResult	createKxUser(CreateKxUserRequest request) Creates a user in FinSpace kdb environment with an associated IAM role.
CreateKxVolumeResult	createKxVolume(CreateKxVolumeRequest request) Creates a new volume with a specific amount of throughput and storage capacity.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest request) Deprecated.
DeleteKxClusterResult	deleteKxCluster(DeleteKxClusterRequest request) Deletes a kdb cluster.
DeleteKxClusterNodeResult	deleteKxClusterNode(DeleteKxClusterNodeRequest request) Deletes the specified nodes from a cluster.
DeleteKxDatabaseResult	deleteKxDatabase(DeleteKxDatabaseRequest request) Deletes the specified database and all of its associated data.
DeleteKxDataviewResult	deleteKxDataview(DeleteKxDataviewRequest request) Deletes the specified dataview.
DeleteKxEnvironmentResult	deleteKxEnvironment(DeleteKxEnvironmentRequest request) Deletes the kdb environment.
DeleteKxScalingGroupResult	deleteKxScalingGroup(DeleteKxScalingGroupRequest request) Deletes the specified scaling group.
DeleteKxUserResult	deleteKxUser(DeleteKxUserRequest request) Deletes a user in the specified kdb environment.
DeleteKxVolumeResult	deleteKxVolume(DeleteKxVolumeRequest request) 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 request) Deprecated.
GetKxChangesetResult	getKxChangeset(GetKxChangesetRequest request) Returns information about a kdb changeset.
GetKxClusterResult	getKxCluster(GetKxClusterRequest request) Retrieves information about a kdb cluster.
GetKxConnectionStringResult	getKxConnectionString(GetKxConnectionStringRequest request) Retrieves a connection string for a user to connect to a kdb cluster.
GetKxDatabaseResult	getKxDatabase(GetKxDatabaseRequest request) Returns database information for the specified environment ID.
GetKxDataviewResult	getKxDataview(GetKxDataviewRequest request) Retrieves details of the dataview.
GetKxEnvironmentResult	getKxEnvironment(GetKxEnvironmentRequest request) Retrieves all the information for the specified kdb environment.
GetKxScalingGroupResult	getKxScalingGroup(GetKxScalingGroupRequest request) Retrieves details of a scaling group.
GetKxUserResult	getKxUser(GetKxUserRequest request) Retrieves information about the specified kdb user.
GetKxVolumeResult	getKxVolume(GetKxVolumeRequest request) Retrieves the information about the volume.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest request) Deprecated.
ListKxChangesetsResult	listKxChangesets(ListKxChangesetsRequest request) Returns a list of all the changesets for a database.
ListKxClusterNodesResult	listKxClusterNodes(ListKxClusterNodesRequest request) Lists all the nodes in a kdb cluster.
ListKxClustersResult	listKxClusters(ListKxClustersRequest request) Returns a list of clusters.
ListKxDatabasesResult	listKxDatabases(ListKxDatabasesRequest request) Returns a list of all the databases in the kdb environment.
ListKxDataviewsResult	listKxDataviews(ListKxDataviewsRequest request) Returns a list of all the dataviews in the database.
ListKxEnvironmentsResult	listKxEnvironments(ListKxEnvironmentsRequest request) Returns a list of kdb environments created in an account.
ListKxScalingGroupsResult	listKxScalingGroups(ListKxScalingGroupsRequest request) Returns a list of scaling groups in a kdb environment.
ListKxUsersResult	listKxUsers(ListKxUsersRequest request) Lists all the users in a kdb environment.
ListKxVolumesResult	listKxVolumes(ListKxVolumesRequest request) Lists all the volumes in a kdb environment.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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 request) Adds metadata tags to a FinSpace resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes metadata tags from a FinSpace resource.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest request) Deprecated.
UpdateKxClusterCodeConfigurationResult	updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest request) Allows you to update code configuration on a running cluster.
UpdateKxClusterDatabasesResult	updateKxClusterDatabases(UpdateKxClusterDatabasesRequest request) Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached.
UpdateKxDatabaseResult	updateKxDatabase(UpdateKxDatabaseRequest request) Updates information for the given kdb database.
UpdateKxDataviewResult	updateKxDataview(UpdateKxDataviewRequest request) Updates the specified dataview.
UpdateKxEnvironmentResult	updateKxEnvironment(UpdateKxEnvironmentRequest request) Updates information for the given kdb environment.
UpdateKxEnvironmentNetworkResult	updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest request) Updates environment network to connect to your internal network by using a transit gateway.
UpdateKxUserResult	updateKxUser(UpdateKxUserRequest request) Updates the user details.
UpdateKxVolumeResult	updateKxVolume(UpdateKxVolumeRequest request) Updates the throughput or capacity of a volume.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSfinspaceClientBuilder builder()

createEnvironment

@Deprecated
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)

Deprecated.

Create a new FinSpace environment.

Specified by:

createEnvironment in interface AWSfinspace

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

public CreateKxChangesetResult createKxChangeset(CreateKxChangesetRequest request)

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.

Specified by:

createKxChangeset in interface AWSfinspace

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

public CreateKxClusterResult createKxCluster(CreateKxClusterRequest request)

Creates a new kdb cluster.

Specified by:

createKxCluster in interface AWSfinspace

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

public CreateKxDatabaseResult createKxDatabase(CreateKxDatabaseRequest request)

Creates a new kdb database in the environment.

Specified by:

createKxDatabase in interface AWSfinspace

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

public CreateKxDataviewResult createKxDataview(CreateKxDataviewRequest request)

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.

Specified by:

createKxDataview in interface AWSfinspace

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

public CreateKxEnvironmentResult createKxEnvironment(CreateKxEnvironmentRequest request)

Creates a managed kdb environment for the account.

Specified by:

createKxEnvironment in interface AWSfinspace

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

public CreateKxScalingGroupResult createKxScalingGroup(CreateKxScalingGroupRequest request)

Creates a new scaling group.

Specified by:

createKxScalingGroup in interface AWSfinspace

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

public CreateKxUserResult createKxUser(CreateKxUserRequest request)

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

Specified by:

createKxUser in interface AWSfinspace

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

public CreateKxVolumeResult createKxVolume(CreateKxVolumeRequest request)

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

Specified by:

createKxVolume in interface AWSfinspace

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
public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

Deprecated.

Delete an FinSpace environment.

Specified by:

deleteEnvironment in interface AWSfinspace

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

public DeleteKxClusterResult deleteKxCluster(DeleteKxClusterRequest request)

Deletes a kdb cluster.

Specified by:

deleteKxCluster in interface AWSfinspace

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

public DeleteKxClusterNodeResult deleteKxClusterNode(DeleteKxClusterNodeRequest request)

Deletes the specified nodes from a cluster.

Specified by:

deleteKxClusterNode in interface AWSfinspace

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

public DeleteKxDatabaseResult deleteKxDatabase(DeleteKxDatabaseRequest request)

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.

Specified by:

deleteKxDatabase in interface AWSfinspace

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

public DeleteKxDataviewResult deleteKxDataview(DeleteKxDataviewRequest request)

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

Specified by:

deleteKxDataview in interface AWSfinspace

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

public DeleteKxEnvironmentResult deleteKxEnvironment(DeleteKxEnvironmentRequest request)

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

Specified by:

deleteKxEnvironment in interface AWSfinspace

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

public DeleteKxScalingGroupResult deleteKxScalingGroup(DeleteKxScalingGroupRequest request)

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.

Specified by:

deleteKxScalingGroup in interface AWSfinspace

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

public DeleteKxUserResult deleteKxUser(DeleteKxUserRequest request)

Deletes a user in the specified kdb environment.

Specified by:

deleteKxUser in interface AWSfinspace

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

public DeleteKxVolumeResult deleteKxVolume(DeleteKxVolumeRequest request)

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.

Specified by:

deleteKxVolume in interface AWSfinspace

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
public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)

Deprecated.

Returns the FinSpace environment object.

Specified by:

getEnvironment in interface AWSfinspace

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

public GetKxChangesetResult getKxChangeset(GetKxChangesetRequest request)

Returns information about a kdb changeset.

Specified by:

getKxChangeset in interface AWSfinspace

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

public GetKxClusterResult getKxCluster(GetKxClusterRequest request)

Retrieves information about a kdb cluster.

Specified by:

getKxCluster in interface AWSfinspace

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

public GetKxConnectionStringResult getKxConnectionString(GetKxConnectionStringRequest request)

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.

Specified by:

getKxConnectionString in interface AWSfinspace

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

public GetKxDatabaseResult getKxDatabase(GetKxDatabaseRequest request)

Returns database information for the specified environment ID.

Specified by:

getKxDatabase in interface AWSfinspace

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

public GetKxDataviewResult getKxDataview(GetKxDataviewRequest request)

Retrieves details of the dataview.

Specified by:

getKxDataview in interface AWSfinspace

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

public GetKxEnvironmentResult getKxEnvironment(GetKxEnvironmentRequest request)

Retrieves all the information for the specified kdb environment.

Specified by:

getKxEnvironment in interface AWSfinspace

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

public GetKxScalingGroupResult getKxScalingGroup(GetKxScalingGroupRequest request)

Retrieves details of a scaling group.

Specified by:

getKxScalingGroup in interface AWSfinspace

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

public GetKxUserResult getKxUser(GetKxUserRequest request)

Retrieves information about the specified kdb user.

Specified by:

getKxUser in interface AWSfinspace

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

public GetKxVolumeResult getKxVolume(GetKxVolumeRequest request)

Retrieves the information about the volume.

Specified by:

getKxVolume in interface AWSfinspace

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
public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)

Deprecated.

A list of all of your FinSpace environments.

Specified by:

listEnvironments in interface AWSfinspace

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

public ListKxChangesetsResult listKxChangesets(ListKxChangesetsRequest request)

Returns a list of all the changesets for a database.

Specified by:

listKxChangesets in interface AWSfinspace

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

public ListKxClusterNodesResult listKxClusterNodes(ListKxClusterNodesRequest request)

Lists all the nodes in a kdb cluster.

Specified by:

listKxClusterNodes in interface AWSfinspace

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

public ListKxClustersResult listKxClusters(ListKxClustersRequest request)

Returns a list of clusters.

Specified by:

listKxClusters in interface AWSfinspace

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

public ListKxDatabasesResult listKxDatabases(ListKxDatabasesRequest request)

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

Specified by:

listKxDatabases in interface AWSfinspace

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

public ListKxDataviewsResult listKxDataviews(ListKxDataviewsRequest request)

Returns a list of all the dataviews in the database.

Specified by:

listKxDataviews in interface AWSfinspace

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

public ListKxEnvironmentsResult listKxEnvironments(ListKxEnvironmentsRequest request)

Returns a list of kdb environments created in an account.

Specified by:

listKxEnvironments in interface AWSfinspace

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

public ListKxScalingGroupsResult listKxScalingGroups(ListKxScalingGroupsRequest request)

Returns a list of scaling groups in a kdb environment.

Specified by:

listKxScalingGroups in interface AWSfinspace

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

public ListKxUsersResult listKxUsers(ListKxUsersRequest request)

Lists all the users in a kdb environment.

Specified by:

listKxUsers in interface AWSfinspace

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

public ListKxVolumesResult listKxVolumes(ListKxVolumesRequest request)

Lists all the volumes in a kdb environment.

Specified by:

listKxVolumes in interface AWSfinspace

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

A list of all tags for a resource.

Specified by:

listTagsForResource in interface AWSfinspace

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

public TagResourceResult tagResource(TagResourceRequest request)

Adds metadata tags to a FinSpace resource.

Specified by:

tagResource in interface AWSfinspace

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes metadata tags from a FinSpace resource.

Specified by:

untagResource in interface AWSfinspace

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
public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)

Deprecated.

Update your FinSpace environment.

Specified by:

updateEnvironment in interface AWSfinspace

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

public UpdateKxClusterCodeConfigurationResult updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest request)

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.

Specified by:

updateKxClusterCodeConfiguration in interface AWSfinspace

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

public UpdateKxClusterDatabasesResult updateKxClusterDatabases(UpdateKxClusterDatabasesRequest request)

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.

Specified by:

updateKxClusterDatabases in interface AWSfinspace

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

public UpdateKxDatabaseResult updateKxDatabase(UpdateKxDatabaseRequest request)

Updates information for the given kdb database.

Specified by:

updateKxDatabase in interface AWSfinspace

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

public UpdateKxDataviewResult updateKxDataview(UpdateKxDataviewRequest request)

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

Specified by:

updateKxDataview in interface AWSfinspace

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

public UpdateKxEnvironmentResult updateKxEnvironment(UpdateKxEnvironmentRequest request)

Updates information for the given kdb environment.

Specified by:

updateKxEnvironment in interface AWSfinspace

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

public UpdateKxEnvironmentNetworkResult updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest request)

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.

Specified by:

updateKxEnvironmentNetwork in interface AWSfinspace

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

public UpdateKxUserResult updateKxUser(UpdateKxUserRequest request)

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

Specified by:

updateKxUser in interface AWSfinspace

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

public UpdateKxVolumeResult updateKxVolume(UpdateKxVolumeRequest request)

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.

Specified by:

updateKxVolume in interface AWSfinspace

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSfinspace

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSfinspace

Overrides:

shutdown in class AmazonWebServiceClient