@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonKeyspaces extends Object implements AmazonKeyspaces
AmazonKeyspaces. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
CreateKeyspaceResult |
createKeyspace(CreateKeyspaceRequest request)
The
CreateKeyspace operation adds a new keyspace to your account. |
CreateTableResult |
createTable(CreateTableRequest request)
The
CreateTable operation adds a new table to the specified keyspace. |
DeleteKeyspaceResult |
deleteKeyspace(DeleteKeyspaceRequest request)
The
DeleteKeyspace operation deletes a keyspace and all of its tables. |
DeleteTableResult |
deleteTable(DeleteTableRequest request)
The
DeleteTable operation deletes a table and all of its data. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetKeyspaceResult |
getKeyspace(GetKeyspaceRequest request)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
|
GetTableResult |
getTable(GetTableRequest request)
Returns information about the table, including the table's name and current status, the keyspace name,
configuration settings, and metadata.
|
GetTableAutoScalingSettingsResult |
getTableAutoScalingSettings(GetTableAutoScalingSettingsRequest request)
Returns auto scaling related settings of the specified table in JSON format.
|
ListKeyspacesResult |
listKeyspaces(ListKeyspacesRequest request)
Returns a list of keyspaces.
|
ListTablesResult |
listTables(ListTablesRequest request)
Returns a list of tables for a specified keyspace.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
|
RestoreTableResult |
restoreTable(RestoreTableRequest request)
Restores the table to the specified point in time within the
earliest_restorable_timestamp and the
current time. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates a set of tags with a Amazon Keyspaces resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the association of tags from a Amazon Keyspaces resource.
|
UpdateTableResult |
updateTable(UpdateTableRequest request)
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.
|
public CreateKeyspaceResult createKeyspace(CreateKeyspaceRequest request)
AmazonKeyspaces
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.
createKeyspace in interface AmazonKeyspacespublic CreateTableResult createTable(CreateTableRequest request)
AmazonKeyspaces
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.
createTable in interface AmazonKeyspacespublic DeleteKeyspaceResult deleteKeyspace(DeleteKeyspaceRequest request)
AmazonKeyspaces
The DeleteKeyspace operation deletes a keyspace and all of its tables.
deleteKeyspace in interface AmazonKeyspacespublic DeleteTableResult deleteTable(DeleteTableRequest request)
AmazonKeyspaces
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.
deleteTable in interface AmazonKeyspacespublic GetKeyspaceResult getKeyspace(GetKeyspaceRequest request)
AmazonKeyspacesReturns the name and the Amazon Resource Name (ARN) of the specified table.
getKeyspace in interface AmazonKeyspacespublic GetTableResult getTable(GetTableRequest request)
AmazonKeyspacesReturns 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.
getTable in interface AmazonKeyspacespublic GetTableAutoScalingSettingsResult getTableAutoScalingSettings(GetTableAutoScalingSettingsRequest request)
AmazonKeyspacesReturns 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's Action element:
application-autoscaling:DescribeScalableTargets
application-autoscaling:DescribeScalingPolicies
getTableAutoScalingSettings in interface AmazonKeyspacespublic ListKeyspacesResult listKeyspaces(ListKeyspacesRequest request)
AmazonKeyspacesReturns a list of keyspaces.
listKeyspaces in interface AmazonKeyspacespublic ListTablesResult listTables(ListTablesRequest request)
AmazonKeyspacesReturns a list of tables for a specified keyspace.
listTables in interface AmazonKeyspacespublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonKeyspacesReturns a list of all tags associated with the specified Amazon Keyspaces resource.
listTagsForResource in interface AmazonKeyspacespublic RestoreTableResult restoreTable(RestoreTableRequest request)
AmazonKeyspaces
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
restoreTable in interface AmazonKeyspacespublic TagResourceResult tagResource(TagResourceRequest request)
AmazonKeyspacesAssociates 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.
tagResource in interface AmazonKeyspacespublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonKeyspacesRemoves the association of tags from a Amazon Keyspaces resource.
untagResource in interface AmazonKeyspacespublic UpdateTableResult updateTable(UpdateTableRequest request)
AmazonKeyspacesAdds 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.
updateTable in interface AmazonKeyspacespublic void shutdown()
AmazonKeyspacesshutdown in interface AmazonKeyspacespublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonKeyspacesResponse 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.
getCachedResponseMetadata in interface AmazonKeyspacesrequest - The originally executed request.