@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSfinspace
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
static final String ENDPOINT_PREFIX
@Deprecated CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Create a new FinSpace environment.
createEnvironmentRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ServiceQuotaExceededException
- You have exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use Service Quotas to request a service quota increase.LimitExceededException
- A service limit or quota is exceeded.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.
createKxChangesetRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- There was a conflict with this action, and it could not be completed.LimitExceededException
- A service limit or quota is exceeded.CreateKxClusterResult createKxCluster(CreateKxClusterRequest createKxClusterRequest)
Creates a new kdb cluster.
createKxClusterRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A service limit or quota is exceeded.ConflictException
- There was a conflict with this action, and it could not be completed.ResourceNotFoundException
- One or more resources can't be found.AccessDeniedException
- You do not have sufficient access to perform this action.CreateKxDatabaseResult createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest)
Creates a new kdb database in the environment.
createKxDatabaseRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ConflictException
- There was a conflict with this action, and it could not be completed.ResourceAlreadyExistsException
- The specified resource group already exists.ResourceNotFoundException
- One or more resources can't be found.LimitExceededException
- A service limit or quota is exceeded.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.
createKxDataviewRequest
- 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.CreateKxEnvironmentResult createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest)
Creates a managed kdb environment for the account.
createKxEnvironmentRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ServiceQuotaExceededException
- You have exceeded your service quota. To perform the requested action, remove some of the relevant
resources, or use Service Quotas to request a service quota increase.LimitExceededException
- A service limit or quota is exceeded.ConflictException
- There was a conflict with this action, and it could not be completed.CreateKxScalingGroupResult createKxScalingGroup(CreateKxScalingGroupRequest createKxScalingGroupRequest)
Creates a new scaling group.
createKxScalingGroupRequest
- 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.CreateKxUserResult createKxUser(CreateKxUserRequest createKxUserRequest)
Creates a user in FinSpace kdb environment with an associated IAM role.
createKxUserRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ResourceAlreadyExistsException
- The specified resource group already exists.LimitExceededException
- A service limit or quota is exceeded.ConflictException
- There was a conflict with this action, and it could not be completed.CreateKxVolumeResult createKxVolume(CreateKxVolumeRequest createKxVolumeRequest)
Creates a new volume with a specific amount of throughput and storage capacity.
createKxVolumeRequest
- 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.@Deprecated DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Delete an FinSpace environment.
deleteEnvironmentRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.DeleteKxClusterResult deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest)
Deletes a kdb cluster.
deleteKxClusterRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A service limit or quota is exceeded.ConflictException
- There was a conflict with this action, and it could not be completed.ResourceNotFoundException
- One or more resources can't be found.DeleteKxClusterNodeResult deleteKxClusterNode(DeleteKxClusterNodeRequest deleteKxClusterNodeRequest)
Deletes the specified nodes from a cluster.
deleteKxClusterNodeRequest
- 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.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.
deleteKxDatabaseRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- There was a conflict with this action, and it could not be completed.DeleteKxDataviewResult deleteKxDataview(DeleteKxDataviewRequest deleteKxDataviewRequest)
Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
deleteKxDataviewRequest
- 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.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.
deleteKxEnvironmentRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- There was a conflict with this action, and it could not be completed.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.
deleteKxScalingGroupRequest
- 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.DeleteKxUserResult deleteKxUser(DeleteKxUserRequest deleteKxUserRequest)
Deletes a user in the specified kdb environment.
deleteKxUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- There was a conflict with this action, and it could not be completed.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.
deleteKxVolumeRequest
- 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.@Deprecated GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Returns the FinSpace environment object.
getEnvironmentRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.GetKxChangesetResult getKxChangeset(GetKxChangesetRequest getKxChangesetRequest)
Returns information about a kdb changeset.
getKxChangesetRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.GetKxClusterResult getKxCluster(GetKxClusterRequest getKxClusterRequest)
Retrieves information about a kdb cluster.
getKxClusterRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A service limit or quota is exceeded.ConflictException
- There was a conflict with this action, and it could not be completed.ResourceNotFoundException
- One or more resources can't be found.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.
getKxConnectionStringRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.GetKxDatabaseResult getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest)
Returns database information for the specified environment ID.
getKxDatabaseRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.GetKxDataviewResult getKxDataview(GetKxDataviewRequest getKxDataviewRequest)
Retrieves details of the dataview.
getKxDataviewRequest
- 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.GetKxEnvironmentResult getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest)
Retrieves all the information for the specified kdb environment.
getKxEnvironmentRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.ConflictException
- There was a conflict with this action, and it could not be completed.GetKxScalingGroupResult getKxScalingGroup(GetKxScalingGroupRequest getKxScalingGroupRequest)
Retrieves details of a scaling group.
getKxScalingGroupRequest
- 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.GetKxUserResult getKxUser(GetKxUserRequest getKxUserRequest)
Retrieves information about the specified kdb user.
getKxUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.GetKxVolumeResult getKxVolume(GetKxVolumeRequest getKxVolumeRequest)
Retrieves the information about the volume.
getKxVolumeRequest
- 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.@Deprecated ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
A list of all of your FinSpace environments.
listEnvironmentsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.AccessDeniedException
- You do not have sufficient access to perform this action.ListKxChangesetsResult listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest)
Returns a list of all the changesets for a database.
listKxChangesetsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ListKxClusterNodesResult listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest)
Lists all the nodes in a kdb cluster.
listKxClusterNodesRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A service limit or quota is exceeded.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ResourceNotFoundException
- One or more resources can't be found.ListKxClustersResult listKxClusters(ListKxClustersRequest listKxClustersRequest)
Returns a list of clusters.
listKxClustersRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A service limit or quota is exceeded.ConflictException
- There was a conflict with this action, and it could not be completed.ResourceNotFoundException
- One or more resources can't be found.ListKxDatabasesResult listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest)
Returns a list of all the databases in the kdb environment.
listKxDatabasesRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ListKxDataviewsResult listKxDataviews(ListKxDataviewsRequest listKxDataviewsRequest)
Returns a list of all the dataviews in the database.
listKxDataviewsRequest
- 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.ListKxEnvironmentsResult listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest)
Returns a list of kdb environments created in an account.
listKxEnvironmentsRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.AccessDeniedException
- You do not have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ListKxScalingGroupsResult listKxScalingGroups(ListKxScalingGroupsRequest listKxScalingGroupsRequest)
Returns a list of scaling groups in a kdb environment.
listKxScalingGroupsRequest
- 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.ListKxUsersResult listKxUsers(ListKxUsersRequest listKxUsersRequest)
Lists all the users in a kdb environment.
listKxUsersRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ListKxVolumesResult listKxVolumes(ListKxVolumesRequest listKxVolumesRequest)
Lists all the volumes in a kdb environment.
listKxVolumesRequest
- 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
A list of all tags for a resource.
listTagsForResourceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.InvalidRequestException
- The request is invalid. Something is wrong with the input to the request.ResourceNotFoundException
- One or more resources can't be found.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a FinSpace resource.
tagResourceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.InvalidRequestException
- The request is invalid. Something is wrong with the input to the request.ResourceNotFoundException
- One or more resources can't be found.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a FinSpace resource.
untagResourceRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.InvalidRequestException
- The request is invalid. Something is wrong with the input to the request.ResourceNotFoundException
- One or more resources can't be found.@Deprecated UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Update your FinSpace environment.
updateEnvironmentRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.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.
updateKxClusterCodeConfigurationRequest
- 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.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.
updateKxClusterDatabasesRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.LimitExceededException
- A service limit or quota is exceeded.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- There was a conflict with this action, and it could not be completed.ResourceNotFoundException
- One or more resources can't be found.UpdateKxDatabaseResult updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest)
Updates information for the given kdb database.
updateKxDatabaseRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ConflictException
- There was a conflict with this action, and it could not be completed.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
updateKxDataviewRequest
- 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.UpdateKxEnvironmentResult updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest)
Updates information for the given kdb environment.
updateKxEnvironmentRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- There was a conflict with this action, and it could not be completed.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.
updateKxEnvironmentNetworkRequest
- ResourceNotFoundException
- One or more resources can't be found.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.AccessDeniedException
- You do not have sufficient access to perform this action.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- There was a conflict with this action, and it could not be completed.UpdateKxUserResult updateKxUser(UpdateKxUserRequest updateKxUserRequest)
Updates the user details. You can only update the IAM role associated with a user.
updateKxUserRequest
- InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ResourceNotFoundException
- One or more resources can't be found.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.LimitExceededException
- A service limit or quota is exceeded.ConflictException
- There was a conflict with this action, and it could not be completed.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.
updateKxVolumeRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.