Keyspaces

import { Keyspaces } from "https://aws-api.deno.dev/v0.4/services/keyspaces.ts?docs=full";

class Keyspaces {

constructor(apiFactory: client.ApiFactory);

async createKeyspace(params: CreateKeyspaceRequest, opts?: client.RequestOptions): Promise<CreateKeyspaceResponse>;

async createTable(params: CreateTableRequest, opts?: client.RequestOptions): Promise<CreateTableResponse>;

async deleteKeyspace(params: DeleteKeyspaceRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTable(params: DeleteTableRequest, opts?: client.RequestOptions): Promise<void>;

async getKeyspace(params: GetKeyspaceRequest, opts?: client.RequestOptions): Promise<GetKeyspaceResponse>;

async getTable(params: GetTableRequest, opts?: client.RequestOptions): Promise<GetTableResponse>;

async listKeyspaces(params?: ListKeyspacesRequest, opts?: client.RequestOptions): Promise<ListKeyspacesResponse>;

async listTables(params: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async restoreTable(params: RestoreTableRequest, opts?: client.RequestOptions): Promise<RestoreTableResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateTable(params: UpdateTableRequest, opts?: client.RequestOptions): Promise<UpdateTableResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Keyspaces(apiFactory: client.ApiFactory)

[src]

§Methods

createKeyspace(params: CreateKeyspaceRequest, opts?: client.RequestOptions): Promise<CreateKeyspaceResponse>

[src]

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.

createTable(params: CreateTableRequest, opts?: client.RequestOptions): Promise<CreateTableResponse>

[src]

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.

deleteKeyspace(params: DeleteKeyspaceRequest, opts?: client.RequestOptions): Promise<void>

[src]

The DeleteKeyspace operation deletes a keyspace and all of its tables.

deleteTable(params: DeleteTableRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

getKeyspace(params: GetKeyspaceRequest, opts?: client.RequestOptions): Promise<GetKeyspaceResponse>

[src]

Returns the name and the Amazon Resource Name (ARN) of the specified table.

getTable(params: GetTableRequest, opts?: client.RequestOptions): Promise<GetTableResponse>

[src]

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.

listKeyspaces(params?: ListKeyspacesRequest, opts?: client.RequestOptions): Promise<ListKeyspacesResponse>

[src]

Returns a list of keyspaces.

listTables(params: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResponse>

[src]

Returns a list of tables for a specified keyspace.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

restoreTable(params: RestoreTableRequest, opts?: client.RequestOptions): Promise<RestoreTableResponse>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the association of tags from a Amazon Keyspaces resource.

updateTable(params: UpdateTableRequest, opts?: client.RequestOptions): Promise<UpdateTableResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]