Interface KeyspacesAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.
In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail.
For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide.
For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic KeyspacesAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aKeyspacesAsyncClient
.static KeyspacesAsyncClient
create()
Create aKeyspacesAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateKeyspaceResponse> createKeyspace
(Consumer<CreateKeyspaceRequest.Builder> createKeyspaceRequest) TheCreateKeyspace
operation adds a new keyspace to your account.default CompletableFuture
<CreateKeyspaceResponse> createKeyspace
(CreateKeyspaceRequest createKeyspaceRequest) TheCreateKeyspace
operation adds a new keyspace to your account.default CompletableFuture
<CreateTableResponse> createTable
(Consumer<CreateTableRequest.Builder> createTableRequest) TheCreateTable
operation adds a new table to the specified keyspace.default CompletableFuture
<CreateTableResponse> createTable
(CreateTableRequest createTableRequest) TheCreateTable
operation adds a new table to the specified keyspace.default CompletableFuture
<DeleteKeyspaceResponse> deleteKeyspace
(Consumer<DeleteKeyspaceRequest.Builder> deleteKeyspaceRequest) TheDeleteKeyspace
operation deletes a keyspace and all of its tables.default CompletableFuture
<DeleteKeyspaceResponse> deleteKeyspace
(DeleteKeyspaceRequest deleteKeyspaceRequest) TheDeleteKeyspace
operation deletes a keyspace and all of its tables.default CompletableFuture
<DeleteTableResponse> deleteTable
(Consumer<DeleteTableRequest.Builder> deleteTableRequest) TheDeleteTable
operation deletes a table and all of its data.default CompletableFuture
<DeleteTableResponse> deleteTable
(DeleteTableRequest deleteTableRequest) TheDeleteTable
operation deletes a table and all of its data.default CompletableFuture
<GetKeyspaceResponse> getKeyspace
(Consumer<GetKeyspaceRequest.Builder> getKeyspaceRequest) Returns the name and the Amazon Resource Name (ARN) of the specified table.default CompletableFuture
<GetKeyspaceResponse> getKeyspace
(GetKeyspaceRequest getKeyspaceRequest) Returns the name and the Amazon Resource Name (ARN) of the specified table.default CompletableFuture
<GetTableResponse> getTable
(Consumer<GetTableRequest.Builder> getTableRequest) Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.default CompletableFuture
<GetTableResponse> getTable
(GetTableRequest getTableRequest) Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.getTableAutoScalingSettings
(Consumer<GetTableAutoScalingSettingsRequest.Builder> getTableAutoScalingSettingsRequest) Returns auto scaling related settings of the specified table in JSON format.getTableAutoScalingSettings
(GetTableAutoScalingSettingsRequest getTableAutoScalingSettingsRequest) Returns auto scaling related settings of the specified table in JSON format.default CompletableFuture
<ListKeyspacesResponse> listKeyspaces
(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest) Returns a list of keyspaces.default CompletableFuture
<ListKeyspacesResponse> listKeyspaces
(ListKeyspacesRequest listKeyspacesRequest) Returns a list of keyspaces.default ListKeyspacesPublisher
listKeyspacesPaginator
(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest) This is a variant oflistKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
operation.default ListKeyspacesPublisher
listKeyspacesPaginator
(ListKeyspacesRequest listKeyspacesRequest) This is a variant oflistKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
operation.default CompletableFuture
<ListTablesResponse> listTables
(Consumer<ListTablesRequest.Builder> listTablesRequest) Returns a list of tables for a specified keyspace.default CompletableFuture
<ListTablesResponse> listTables
(ListTablesRequest listTablesRequest) Returns a list of tables for a specified keyspace.default ListTablesPublisher
listTablesPaginator
(Consumer<ListTablesRequest.Builder> listTablesRequest) This is a variant oflistTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
operation.default ListTablesPublisher
listTablesPaginator
(ListTablesRequest listTablesRequest) This is a variant oflistTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of all tags associated with the specified Amazon Keyspaces resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of all tags associated with the specified Amazon Keyspaces resource.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation.default CompletableFuture
<RestoreTableResponse> restoreTable
(Consumer<RestoreTableRequest.Builder> restoreTableRequest) Restores the table to the specified point in time within theearliest_restorable_timestamp
and the current time.default CompletableFuture
<RestoreTableResponse> restoreTable
(RestoreTableRequest restoreTableRequest) Restores the table to the specified point in time within theearliest_restorable_timestamp
and the current time.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates a set of tags with a Amazon Keyspaces resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associates a set of tags with a Amazon Keyspaces resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of tags from a Amazon Keyspaces resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the association of tags from a Amazon Keyspaces resource.default CompletableFuture
<UpdateTableResponse> updateTable
(Consumer<UpdateTableRequest.Builder> updateTableRequest) Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings.default CompletableFuture
<UpdateTableResponse> updateTable
(UpdateTableRequest updateTableRequest) Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createKeyspace
default CompletableFuture<CreateKeyspaceResponse> createKeyspace(CreateKeyspaceRequest createKeyspaceRequest) The
CreateKeyspace
operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.CreateKeyspace
is an asynchronous operation. You can monitor the creation status of the new keyspace by using theGetKeyspace
operation.For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
- Parameters:
createKeyspaceRequest
-- Returns:
- A Java Future containing the result of the CreateKeyspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKeyspace
default CompletableFuture<CreateKeyspaceResponse> createKeyspace(Consumer<CreateKeyspaceRequest.Builder> createKeyspaceRequest) The
CreateKeyspace
operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.CreateKeyspace
is an asynchronous operation. You can monitor the creation status of the new keyspace by using theGetKeyspace
operation.For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
This is a convenience which creates an instance of the
CreateKeyspaceRequest.Builder
avoiding the need to create one manually viaCreateKeyspaceRequest.builder()
- Parameters:
createKeyspaceRequest
- AConsumer
that will call methods onCreateKeyspaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKeyspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTable
The
CreateTable
operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.CreateTable
is an asynchronous operation. When the request is received, the status of the table is set toCREATING
. You can monitor the creation status of the new table by using theGetTable
operation, which returns the currentstatus
of the table. You can start using a table when the status isACTIVE
.For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
- Parameters:
createTableRequest
-- Returns:
- A Java Future containing the result of the CreateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTable
default CompletableFuture<CreateTableResponse> createTable(Consumer<CreateTableRequest.Builder> createTableRequest) The
CreateTable
operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.CreateTable
is an asynchronous operation. When the request is received, the status of the table is set toCREATING
. You can monitor the creation status of the new table by using theGetTable
operation, which returns the currentstatus
of the table. You can start using a table when the status isACTIVE
.For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
This is a convenience which creates an instance of the
CreateTableRequest.Builder
avoiding the need to create one manually viaCreateTableRequest.builder()
- Parameters:
createTableRequest
- AConsumer
that will call methods onCreateTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKeyspace
default CompletableFuture<DeleteKeyspaceResponse> deleteKeyspace(DeleteKeyspaceRequest deleteKeyspaceRequest) The
DeleteKeyspace
operation deletes a keyspace and all of its tables.- Parameters:
deleteKeyspaceRequest
-- Returns:
- A Java Future containing the result of the DeleteKeyspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKeyspace
default CompletableFuture<DeleteKeyspaceResponse> deleteKeyspace(Consumer<DeleteKeyspaceRequest.Builder> deleteKeyspaceRequest) The
DeleteKeyspace
operation deletes a keyspace and all of its tables.
This is a convenience which creates an instance of the
DeleteKeyspaceRequest.Builder
avoiding the need to create one manually viaDeleteKeyspaceRequest.builder()
- Parameters:
deleteKeyspaceRequest
- AConsumer
that will call methods onDeleteKeyspaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKeyspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTable
The
DeleteTable
operation deletes a table and all of its data. After aDeleteTable
request is received, the specified table is in theDELETING
state until Amazon Keyspaces completes the deletion. If the table is in theACTIVE
state, you can delete it. If a table is either in theCREATING
orUPDATING
states, then Amazon Keyspaces returns aResourceInUseException
. If the specified table does not exist, Amazon Keyspaces returns aResourceNotFoundException
. If the table is already in theDELETING
state, no error is returned.- Parameters:
deleteTableRequest
-- Returns:
- A Java Future containing the result of the DeleteTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTable
default CompletableFuture<DeleteTableResponse> deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest) The
DeleteTable
operation deletes a table and all of its data. After aDeleteTable
request is received, the specified table is in theDELETING
state until Amazon Keyspaces completes the deletion. If the table is in theACTIVE
state, you can delete it. If a table is either in theCREATING
orUPDATING
states, then Amazon Keyspaces returns aResourceInUseException
. If the specified table does not exist, Amazon Keyspaces returns aResourceNotFoundException
. If the table is already in theDELETING
state, no error is returned.
This is a convenience which creates an instance of the
DeleteTableRequest.Builder
avoiding the need to create one manually viaDeleteTableRequest.builder()
- Parameters:
deleteTableRequest
- AConsumer
that will call methods onDeleteTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKeyspace
Returns the name and the Amazon Resource Name (ARN) of the specified table.
- Parameters:
getKeyspaceRequest
-- Returns:
- A Java Future containing the result of the GetKeyspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKeyspace
default CompletableFuture<GetKeyspaceResponse> getKeyspace(Consumer<GetKeyspaceRequest.Builder> getKeyspaceRequest) Returns the name and the Amazon Resource Name (ARN) of the specified table.
This is a convenience which creates an instance of the
GetKeyspaceRequest.Builder
avoiding the need to create one manually viaGetKeyspaceRequest.builder()
- Parameters:
getKeyspaceRequest
- AConsumer
that will call methods onGetKeyspaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKeyspace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTable
Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using
GetTable
,Select
action permissions for the table and system tables are required to complete the operation.- Parameters:
getTableRequest
-- Returns:
- A Java Future containing the result of the GetTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTable
default CompletableFuture<GetTableResponse> getTable(Consumer<GetTableRequest.Builder> getTableRequest) Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using
GetTable
,Select
action permissions for the table and system tables are required to complete the operation.
This is a convenience which creates an instance of the
GetTableRequest.Builder
avoiding the need to create one manually viaGetTableRequest.builder()
- Parameters:
getTableRequest
- AConsumer
that will call methods onGetTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTableAutoScalingSettings
default CompletableFuture<GetTableAutoScalingSettingsResponse> getTableAutoScalingSettings(GetTableAutoScalingSettingsRequest getTableAutoScalingSettingsRequest) Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.
Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
GetTableAutoScalingSettings
can't be used as an action in an IAM policy.To define permissions for
GetTableAutoScalingSettings
, you must allow the following two actions in the IAM policy statement'sAction
element:-
application-autoscaling:DescribeScalableTargets
-
application-autoscaling:DescribeScalingPolicies
- Parameters:
getTableAutoScalingSettingsRequest
-- Returns:
- A Java Future containing the result of the GetTableAutoScalingSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getTableAutoScalingSettings
default CompletableFuture<GetTableAutoScalingSettingsResponse> getTableAutoScalingSettings(Consumer<GetTableAutoScalingSettingsRequest.Builder> getTableAutoScalingSettingsRequest) Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.
Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
GetTableAutoScalingSettings
can't be used as an action in an IAM policy.To define permissions for
GetTableAutoScalingSettings
, you must allow the following two actions in the IAM policy statement'sAction
element:-
application-autoscaling:DescribeScalableTargets
-
application-autoscaling:DescribeScalingPolicies
This is a convenience which creates an instance of the
GetTableAutoScalingSettingsRequest.Builder
avoiding the need to create one manually viaGetTableAutoScalingSettingsRequest.builder()
- Parameters:
getTableAutoScalingSettingsRequest
- AConsumer
that will call methods onGetTableAutoScalingSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTableAutoScalingSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listKeyspaces
default CompletableFuture<ListKeyspacesResponse> listKeyspaces(ListKeyspacesRequest listKeyspacesRequest) Returns a list of keyspaces.
- Parameters:
listKeyspacesRequest
-- Returns:
- A Java Future containing the result of the ListKeyspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKeyspaces
default CompletableFuture<ListKeyspacesResponse> listKeyspaces(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest) Returns a list of keyspaces.
This is a convenience which creates an instance of the
ListKeyspacesRequest.Builder
avoiding the need to create one manually viaListKeyspacesRequest.builder()
- Parameters:
listKeyspacesRequest
- AConsumer
that will call methods onListKeyspacesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKeyspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKeyspacesPaginator
This is a variant of
listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
operation.- Parameters:
listKeyspacesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKeyspacesPaginator
default ListKeyspacesPublisher listKeyspacesPaginator(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest) This is a variant of
listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
operation.
This is a convenience which creates an instance of the
ListKeyspacesRequest.Builder
avoiding the need to create one manually viaListKeyspacesRequest.builder()
- Parameters:
listKeyspacesRequest
- AConsumer
that will call methods onListKeyspacesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTables
Returns a list of tables for a specified keyspace.
- Parameters:
listTablesRequest
-- Returns:
- A Java Future containing the result of the ListTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTables
default CompletableFuture<ListTablesResponse> listTables(Consumer<ListTablesRequest.Builder> listTablesRequest) Returns a list of tables for a specified keyspace.
This is a convenience which creates an instance of the
ListTablesRequest.Builder
avoiding the need to create one manually viaListTablesRequest.builder()
- Parameters:
listTablesRequest
- AConsumer
that will call methods onListTablesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTables operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTablesPaginator
This is a variant of
listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTablesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTablesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
operation.- Parameters:
listTablesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTablesPaginator
default ListTablesPublisher listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest) This is a variant of
listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTablesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTablesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
operation.
This is a convenience which creates an instance of the
ListTablesRequest.Builder
avoiding the need to create one manually viaListTablesRequest.builder()
- Parameters:
listTablesRequest
- AConsumer
that will call methods onListTablesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of all tags associated with the specified Amazon Keyspaces resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of all tags associated with the specified Amazon Keyspaces resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreTable
default CompletableFuture<RestoreTableResponse> restoreTable(RestoreTableRequest restoreTableRequest) Restores the table to the specified point in time within the
earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp
(day:hour:minute:second)
to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.In addition to the table's schema, data, and TTL settings,
RestoreTable
restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.You can also overwrite these settings during restore:
-
Read/write capacity mode
-
Provisioned throughput capacity units
-
Auto scaling settings
-
Point-in-time (PITR) settings
-
Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for the new table:
-
Identity and Access Management (IAM) policies
-
Amazon CloudWatch metrics and alarms
- Parameters:
restoreTableRequest
-- Returns:
- A Java Future containing the result of the RestoreTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
restoreTable
default CompletableFuture<RestoreTableResponse> restoreTable(Consumer<RestoreTableRequest.Builder> restoreTableRequest) Restores the table to the specified point in time within the
earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp
(day:hour:minute:second)
to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.In addition to the table's schema, data, and TTL settings,
RestoreTable
restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.You can also overwrite these settings during restore:
-
Read/write capacity mode
-
Provisioned throughput capacity units
-
Auto scaling settings
-
Point-in-time (PITR) settings
-
Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for the new table:
-
Identity and Access Management (IAM) policies
-
Amazon CloudWatch metrics and alarms
This is a convenience which creates an instance of the
RestoreTableRequest.Builder
avoiding the need to create one manually viaRestoreTableRequest.builder()
- Parameters:
restoreTableRequest
- AConsumer
that will call methods onRestoreTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the association of tags from a Amazon Keyspaces resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the association of tags from a Amazon Keyspaces resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTable
Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
- Parameters:
updateTableRequest
-- Returns:
- A Java Future containing the result of the UpdateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTable
default CompletableFuture<UpdateTableResponse> updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest) Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
This is a convenience which creates an instance of the
UpdateTableRequest.Builder
avoiding the need to create one manually viaUpdateTableRequest.builder()
- Parameters:
updateTableRequest
- AConsumer
that will call methods onUpdateTableRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTable operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The operation failed due to an invalid or malformed request.
- ServiceQuotaExceededException The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
- InternalServerException Amazon Keyspaces was unable to fully process this request because of an internal server error.
- ConflictException Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
- AccessDeniedException You don't have sufficient access permissions to perform this action.
- ResourceNotFoundException The operation tried to access a keyspace or table that doesn't exist. The
resource might not be specified correctly, or its status might not be
ACTIVE
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- KeyspacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aKeyspacesAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aKeyspacesAsyncClient
.
-