@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKeyspacesAsync extends AmazonKeyspaces
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonKeyspacesAsync instead.
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.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<CreateKeyspaceResult> |
createKeyspaceAsync(CreateKeyspaceRequest createKeyspaceRequest)
The
CreateKeyspace operation adds a new keyspace to your account. |
Future<CreateKeyspaceResult> |
createKeyspaceAsync(CreateKeyspaceRequest createKeyspaceRequest,
AsyncHandler<CreateKeyspaceRequest,CreateKeyspaceResult> asyncHandler)
The
CreateKeyspace operation adds a new keyspace to your account. |
Future<CreateTableResult> |
createTableAsync(CreateTableRequest createTableRequest)
The
CreateTable operation adds a new table to the specified keyspace. |
Future<CreateTableResult> |
createTableAsync(CreateTableRequest createTableRequest,
AsyncHandler<CreateTableRequest,CreateTableResult> asyncHandler)
The
CreateTable operation adds a new table to the specified keyspace. |
Future<DeleteKeyspaceResult> |
deleteKeyspaceAsync(DeleteKeyspaceRequest deleteKeyspaceRequest)
The
DeleteKeyspace operation deletes a keyspace and all of its tables. |
Future<DeleteKeyspaceResult> |
deleteKeyspaceAsync(DeleteKeyspaceRequest deleteKeyspaceRequest,
AsyncHandler<DeleteKeyspaceRequest,DeleteKeyspaceResult> asyncHandler)
The
DeleteKeyspace operation deletes a keyspace and all of its tables. |
Future<DeleteTableResult> |
deleteTableAsync(DeleteTableRequest deleteTableRequest)
The
DeleteTable operation deletes a table and all of its data. |
Future<DeleteTableResult> |
deleteTableAsync(DeleteTableRequest deleteTableRequest,
AsyncHandler<DeleteTableRequest,DeleteTableResult> asyncHandler)
The
DeleteTable operation deletes a table and all of its data. |
Future<GetKeyspaceResult> |
getKeyspaceAsync(GetKeyspaceRequest getKeyspaceRequest)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
|
Future<GetKeyspaceResult> |
getKeyspaceAsync(GetKeyspaceRequest getKeyspaceRequest,
AsyncHandler<GetKeyspaceRequest,GetKeyspaceResult> asyncHandler)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
|
Future<GetTableResult> |
getTableAsync(GetTableRequest getTableRequest)
Returns information about the table, including the table's name and current status, the keyspace name,
configuration settings, and metadata.
|
Future<GetTableResult> |
getTableAsync(GetTableRequest getTableRequest,
AsyncHandler<GetTableRequest,GetTableResult> asyncHandler)
Returns information about the table, including the table's name and current status, the keyspace name,
configuration settings, and metadata.
|
Future<ListKeyspacesResult> |
listKeyspacesAsync(ListKeyspacesRequest listKeyspacesRequest)
Returns a list of keyspaces.
|
Future<ListKeyspacesResult> |
listKeyspacesAsync(ListKeyspacesRequest listKeyspacesRequest,
AsyncHandler<ListKeyspacesRequest,ListKeyspacesResult> asyncHandler)
Returns a list of keyspaces.
|
Future<ListTablesResult> |
listTablesAsync(ListTablesRequest listTablesRequest)
Returns a list of tables for a specified keyspace.
|
Future<ListTablesResult> |
listTablesAsync(ListTablesRequest listTablesRequest,
AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler)
Returns a list of tables for a specified keyspace.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
|
Future<RestoreTableResult> |
restoreTableAsync(RestoreTableRequest restoreTableRequest)
Restores the specified table to the specified point in time within the
earliest_restorable_timestamp
and the current time. |
Future<RestoreTableResult> |
restoreTableAsync(RestoreTableRequest restoreTableRequest,
AsyncHandler<RestoreTableRequest,RestoreTableResult> asyncHandler)
Restores the specified table to the specified point in time within the
earliest_restorable_timestamp
and the current time. |
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Associates a set of tags with a Amazon Keyspaces resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Associates a set of tags with a Amazon Keyspaces resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Amazon Keyspaces resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the association of tags from a Amazon Keyspaces resource.
|
Future<UpdateTableResult> |
updateTableAsync(UpdateTableRequest updateTableRequest)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption,
point-in-time recovery, or ttl settings.
|
Future<UpdateTableResult> |
updateTableAsync(UpdateTableRequest updateTableRequest,
AsyncHandler<UpdateTableRequest,UpdateTableResult> asyncHandler)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption,
point-in-time recovery, or ttl settings.
|
createKeyspace, createTable, deleteKeyspace, deleteTable, getCachedResponseMetadata, getKeyspace, getTable, listKeyspaces, listTables, listTagsForResource, restoreTable, shutdown, tagResource, untagResource, updateTableFuture<CreateKeyspaceResult> createKeyspaceAsync(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 the GetKeyspace operation.
For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
createKeyspaceRequest - Future<CreateKeyspaceResult> createKeyspaceAsync(CreateKeyspaceRequest createKeyspaceRequest, AsyncHandler<CreateKeyspaceRequest,CreateKeyspaceResult> asyncHandler)
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 the GetKeyspace operation.
For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
createKeyspaceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateTableResult> createTableAsync(CreateTableRequest 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 to CREATING. You can monitor the creation status of the new table by using the
GetTable operation, which returns the current status of the table. You can start using
a table when the status is ACTIVE.
For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
createTableRequest - Future<CreateTableResult> createTableAsync(CreateTableRequest createTableRequest, AsyncHandler<CreateTableRequest,CreateTableResult> asyncHandler)
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 to CREATING. You can monitor the creation status of the new table by using the
GetTable operation, which returns the current status of the table. You can start using
a table when the status is ACTIVE.
For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
createTableRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteKeyspaceResult> deleteKeyspaceAsync(DeleteKeyspaceRequest deleteKeyspaceRequest)
The DeleteKeyspace operation deletes a keyspace and all of its tables.
deleteKeyspaceRequest - Future<DeleteKeyspaceResult> deleteKeyspaceAsync(DeleteKeyspaceRequest deleteKeyspaceRequest, AsyncHandler<DeleteKeyspaceRequest,DeleteKeyspaceResult> asyncHandler)
The DeleteKeyspace operation deletes a keyspace and all of its tables.
deleteKeyspaceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTableResult> deleteTableAsync(DeleteTableRequest deleteTableRequest)
The DeleteTable operation deletes a table and all of its data. After a DeleteTable
request is received, the specified table is in the DELETING state until Amazon Keyspaces completes
the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the
CREATING or UPDATING states, then Amazon Keyspaces returns a
ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a
ResourceNotFoundException. If the table is already in the DELETING state, no error is
returned.
deleteTableRequest - Future<DeleteTableResult> deleteTableAsync(DeleteTableRequest deleteTableRequest, AsyncHandler<DeleteTableRequest,DeleteTableResult> asyncHandler)
The DeleteTable operation deletes a table and all of its data. After a DeleteTable
request is received, the specified table is in the DELETING state until Amazon Keyspaces completes
the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the
CREATING or UPDATING states, then Amazon Keyspaces returns a
ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a
ResourceNotFoundException. If the table is already in the DELETING state, no error is
returned.
deleteTableRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetKeyspaceResult> getKeyspaceAsync(GetKeyspaceRequest getKeyspaceRequest)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
getKeyspaceRequest - Future<GetKeyspaceResult> getKeyspaceAsync(GetKeyspaceRequest getKeyspaceRequest, AsyncHandler<GetKeyspaceRequest,GetKeyspaceResult> asyncHandler)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
getKeyspaceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTableResult> getTableAsync(GetTableRequest 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.
getTableRequest - Future<GetTableResult> getTableAsync(GetTableRequest getTableRequest, AsyncHandler<GetTableRequest,GetTableResult> asyncHandler)
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.
getTableRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListKeyspacesResult> listKeyspacesAsync(ListKeyspacesRequest listKeyspacesRequest)
Returns a list of keyspaces.
listKeyspacesRequest - Future<ListKeyspacesResult> listKeyspacesAsync(ListKeyspacesRequest listKeyspacesRequest, AsyncHandler<ListKeyspacesRequest,ListKeyspacesResult> asyncHandler)
Returns a list of keyspaces.
listKeyspacesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest)
Returns a list of tables for a specified keyspace.
listTablesRequest - Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest, AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler)
Returns a list of tables for a specified keyspace.
listTablesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RestoreTableResult> restoreTableAsync(RestoreTableRequest restoreTableRequest)
Restores the specified 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,
encryption, 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 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:
Automatic scaling policies (for tables that use provisioned capacity mode)
Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms
restoreTableRequest - Future<RestoreTableResult> restoreTableAsync(RestoreTableRequest restoreTableRequest, AsyncHandler<RestoreTableRequest,RestoreTableResult> asyncHandler)
Restores the specified 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,
encryption, 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 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:
Automatic scaling policies (for tables that use provisioned capacity mode)
Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms
restoreTableRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest 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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Amazon Keyspaces resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the association of tags from a Amazon Keyspaces resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateTableResult> updateTableAsync(UpdateTableRequest updateTableRequest)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
updateTableRequest - Future<UpdateTableResult> updateTableAsync(UpdateTableRequest updateTableRequest, AsyncHandler<UpdateTableRequest,UpdateTableResult> asyncHandler)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
updateTableRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.