* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.keyspaces.AbstractAmazonKeyspaces} 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKeyspaces { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "cassandra"; /** *
* 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. *
* * @param createKeyspaceRequest * @return Result of the CreateKeyspace operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws ConflictException * Amazon Keyspaces could not 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. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonKeyspaces.CreateKeyspace * @see AWS API * Documentation */ CreateKeyspaceResult createKeyspace(CreateKeyspaceRequest createKeyspaceRequest); /** *
* 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. *
* * @param createTableRequest * @return Result of the CreateTable operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws ConflictException * Amazon Keyspaces could not 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. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.CreateTable
* @see AWS API
* Documentation
*/
CreateTableResult createTable(CreateTableRequest createTableRequest);
/**
*
* The DeleteKeyspace operation deletes a keyspace and all of its tables.
*
ACTIVE.
* @sample AmazonKeyspaces.DeleteKeyspace
* @see AWS API
* Documentation
*/
DeleteKeyspaceResult deleteKeyspace(DeleteKeyspaceRequest deleteKeyspaceRequest);
/**
*
* 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.
*
ACTIVE.
* @sample AmazonKeyspaces.DeleteTable
* @see AWS API
* Documentation
*/
DeleteTableResult deleteTable(DeleteTableRequest deleteTableRequest);
/**
* * Returns the name and the Amazon Resource Name (ARN) of the specified table. *
* * @param getKeyspaceRequest * @return Result of the GetKeyspace operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.GetKeyspace
* @see AWS API
* Documentation
*/
GetKeyspaceResult getKeyspace(GetKeyspaceRequest getKeyspaceRequest);
/**
* * 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.
*
ACTIVE.
* @sample AmazonKeyspaces.GetTable
* @see AWS API
* Documentation
*/
GetTableResult getTable(GetTableRequest getTableRequest);
/**
* * Returns a list of keyspaces. *
* * @param listKeyspacesRequest * @return Result of the ListKeyspaces operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.ListKeyspaces
* @see AWS API
* Documentation
*/
ListKeyspacesResult listKeyspaces(ListKeyspacesRequest listKeyspacesRequest);
/**
* * Returns a list of tables for a specified keyspace. *
* * @param listTablesRequest * @return Result of the ListTables operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.ListTables
* @see AWS API
* Documentation
*/
ListTablesResult listTables(ListTablesRequest listTablesRequest);
/**
* * Returns a list of all tags associated with the specified Amazon Keyspaces resource. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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 *
*ACTIVE.
* @sample AmazonKeyspaces.RestoreTable
* @see AWS API
* Documentation
*/
RestoreTableResult restoreTable(RestoreTableRequest restoreTableRequest);
/**
* * 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. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
* * Removes the association of tags from a Amazon Keyspaces resource. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws ConflictException * Amazon Keyspaces could not 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. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* * 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. *
* * @param updateTableRequest * @return Result of the UpdateTable operation returned by the service. * @throws ValidationException * The operation failed due to an invalid or malformed request. * @throws ServiceQuotaExceededException * The operation exceeded the service quota for this resource. For more information on service quotas, see * Quotas in the Amazon * Keyspaces Developer Guide. * @throws InternalServerException * Amazon Keyspaces was unable to fully process this request because of an internal server error. * @throws ConflictException * Amazon Keyspaces could not 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. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws 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 beACTIVE.
* @sample AmazonKeyspaces.UpdateTable
* @see AWS API
* Documentation
*/
UpdateTableResult updateTable(UpdateTableRequest updateTableRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
* * Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }