@aws-sdk/client-keyspaces 3.296.0 → 3.298.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { KeyspacesServiceException as __BaseException } from "./KeyspacesServiceException";
 /**
+ * @public
  * <p>You do not have sufficient access to perform this action. </p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -11,11 +12,15 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ThroughputMode {
     PAY_PER_REQUEST = "PAY_PER_REQUEST",
     PROVISIONED = "PROVISIONED"
 }
 /**
+ * @public
  * <p>Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables: </p>
  *          <ul>
  *             <li>
@@ -61,6 +66,7 @@ export interface CapacitySpecification {
     writeCapacityUnits?: number;
 }
 /**
+ * @public
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
  *          <ul>
  *             <li>
@@ -109,10 +115,14 @@ export interface CapacitySpecificationSummary {
      */
     lastUpdateToPayPerRequestTimestamp?: Date;
 }
+/**
+ * @public
+ */
 export declare enum ClientSideTimestampsStatus {
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>The client-side timestamp setting of the table.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html">How it works: Amazon Keyspaces client-side timestamps</a> in the <i>Amazon Keyspaces Developer
  *             Guide</i>.</p>
@@ -123,11 +133,15 @@ export interface ClientSideTimestamps {
      */
     status: ClientSideTimestampsStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /**
+ * @public
  * <p>The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.</p>
  */
 export interface ClusteringKey {
@@ -141,6 +155,7 @@ export interface ClusteringKey {
     orderBy: SortOrder | string | undefined;
 }
 /**
+ * @public
  * <p>The names and data types of regular columns.</p>
  */
 export interface ColumnDefinition {
@@ -155,6 +170,7 @@ export interface ColumnDefinition {
     type: string | undefined;
 }
 /**
+ * @public
  * <p>An optional comment that describes the table.</p>
  */
 export interface Comment {
@@ -164,6 +180,7 @@ export interface Comment {
     message: string | undefined;
 }
 /**
+ * @public
  * <p>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. </p>
@@ -177,6 +194,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.</p>
  *          <p>Amazon Web Services-assigned tag names and values are automatically assigned the <code>aws:</code> prefix, which the user cannot assign.
  *          Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the
@@ -195,6 +213,9 @@ export interface Tag {
      */
     value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateKeyspaceRequest {
     /**
      * <p>The name of the keyspace to be created.</p>
@@ -207,6 +228,9 @@ export interface CreateKeyspaceRequest {
      */
     tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface CreateKeyspaceResponse {
     /**
      * <p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>
@@ -214,6 +238,7 @@ export interface CreateKeyspaceResponse {
     resourceArn: string | undefined;
 }
 /**
+ * @public
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -225,6 +250,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>The operation exceeded the service quota for this resource.  For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
  *             Guide</i>.</p>
  */
@@ -237,6 +263,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The operation failed due to an invalid or malformed request.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -247,11 +274,15 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum EncryptionType {
     AWS_OWNED_KMS_KEY = "AWS_OWNED_KMS_KEY",
     CUSTOMER_MANAGED_KMS_KEY = "CUSTOMER_MANAGED_KMS_KEY"
 }
 /**
+ * @public
  * <p>Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key.
  *          You can choose one of the following KMS keys (KMS keys):</p>
  *          <ul>
@@ -292,11 +323,15 @@ export interface EncryptionSpecification {
      */
     kmsKeyIdentifier?: string;
 }
+/**
+ * @public
+ */
 export declare enum PointInTimeRecoveryStatus {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
  *             Guide</i>.</p>
@@ -320,6 +355,7 @@ export interface PointInTimeRecovery {
     status: PointInTimeRecoveryStatus | string | undefined;
 }
 /**
+ * @public
  * <p>The partition key portion of the primary key is required
  *          and determines how Amazon Keyspaces stores the data.
  *          The partition key can be a single column, or it can be a compound value composed of two or more columns.</p>
@@ -331,6 +367,7 @@ export interface PartitionKey {
     name: string | undefined;
 }
 /**
+ * @public
  * <p>The static columns of the table. Static columns store values that are shared by all rows in the same partition.</p>
  */
 export interface StaticColumn {
@@ -340,6 +377,7 @@ export interface StaticColumn {
     name: string | undefined;
 }
 /**
+ * @public
  * <p>Describes the schema of the table.</p>
  */
 export interface SchemaDefinition {
@@ -360,10 +398,14 @@ export interface SchemaDefinition {
      */
     staticColumns?: StaticColumn[];
 }
+/**
+ * @public
+ */
 export declare enum TimeToLiveStatus {
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.</p>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling">Enabling TTL on tables</a> in the <i>Amazon Keyspaces Developer
  *             Guide</i>.</p>
@@ -374,6 +416,9 @@ export interface TimeToLive {
      */
     status: TimeToLiveStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateTableRequest {
     /**
      * <p>The name of the keyspace that the table is going to be created in.</p>
@@ -559,6 +604,9 @@ export interface CreateTableRequest {
      */
     clientSideTimestamps?: ClientSideTimestamps;
 }
+/**
+ * @public
+ */
 export interface CreateTableResponse {
     /**
      * <p>The unique identifier of the table in the format of an Amazon Resource Name (ARN).</p>
@@ -566,6 +614,7 @@ export interface CreateTableResponse {
     resourceArn: string | undefined;
 }
 /**
+ * @public
  * <p>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 <code>ACTIVE</code>.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -580,14 +629,23 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteKeyspaceRequest {
     /**
      * <p>The name of the keyspace to be deleted.</p>
      */
     keyspaceName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteKeyspaceResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteTableRequest {
     /**
      * <p>The name of the keyspace of the to be deleted table.</p>
@@ -598,14 +656,23 @@ export interface DeleteTableRequest {
      */
     tableName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteTableResponse {
 }
+/**
+ * @public
+ */
 export interface GetKeyspaceRequest {
     /**
      * <p>The name of the keyspace.</p>
      */
     keyspaceName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetKeyspaceResponse {
     /**
      * <p>The name of the keyspace.</p>
@@ -616,6 +683,9 @@ export interface GetKeyspaceResponse {
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetTableRequest {
     /**
      * <p>The name of the keyspace that the table is stored in.</p>
@@ -627,6 +697,7 @@ export interface GetTableRequest {
     tableName: string | undefined;
 }
 /**
+ * @public
  * <p>The point-in-time recovery status of the specified table.</p>
  */
 export interface PointInTimeRecoverySummary {
@@ -639,6 +710,9 @@ export interface PointInTimeRecoverySummary {
      */
     earliestRestorableTimestamp?: Date;
 }
+/**
+ * @public
+ */
 export declare enum TableStatus {
     ACTIVE = "ACTIVE",
     CREATING = "CREATING",
@@ -648,6 +722,9 @@ export declare enum TableStatus {
     RESTORING = "RESTORING",
     UPDATING = "UPDATING"
 }
+/**
+ * @public
+ */
 export interface GetTableResponse {
     /**
      * <p>The name of the keyspace that the specified table is stored in.</p>
@@ -715,6 +792,9 @@ export interface GetTableResponse {
      */
     clientSideTimestamps?: ClientSideTimestamps;
 }
+/**
+ * @public
+ */
 export interface ListKeyspacesRequest {
     /**
      * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</p>
@@ -728,6 +808,7 @@ export interface ListKeyspacesRequest {
     maxResults?: number;
 }
 /**
+ * @public
  * <p>Represents the properties of a keyspace.</p>
  */
 export interface KeyspaceSummary {
@@ -740,6 +821,9 @@ export interface KeyspaceSummary {
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListKeyspacesResponse {
     /**
      * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
@@ -750,6 +834,9 @@ export interface ListKeyspacesResponse {
      */
     keyspaces: KeyspaceSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTablesRequest {
     /**
      * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
@@ -767,6 +854,7 @@ export interface ListTablesRequest {
     keyspaceName: string | undefined;
 }
 /**
+ * @public
  * <p>Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).</p>
  */
 export interface TableSummary {
@@ -783,6 +871,9 @@ export interface TableSummary {
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTablesResponse {
     /**
      * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
@@ -793,6 +884,9 @@ export interface ListTablesResponse {
      */
     tables?: TableSummary[];
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.</p>
@@ -809,6 +903,9 @@ export interface ListTagsForResourceRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
@@ -819,6 +916,9 @@ export interface ListTagsForResourceResponse {
      */
     tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface RestoreTableRequest {
     /**
      * <p>The keyspace name of the source table.</p>
@@ -906,12 +1006,18 @@ export interface RestoreTableRequest {
      */
     tagsOverride?: Tag[];
 }
+/**
+ * @public
+ */
 export interface RestoreTableResponse {
     /**
      * <p>The Amazon Resource Name (ARN) of the restored table.</p>
      */
     restoredTableARN: string | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.</p>
@@ -922,8 +1028,14 @@ export interface TagResourceRequest {
      */
     tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).</p>
@@ -934,8 +1046,14 @@ export interface UntagResourceRequest {
      */
     tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateTableRequest {
     /**
      * <p>The name of the keyspace the specified table is stored in.</p>
@@ -1059,177 +1177,12 @@ export interface UpdateTableRequest {
      */
     clientSideTimestamps?: ClientSideTimestamps;
 }
+/**
+ * @public
+ */
 export interface UpdateTableResponse {
     /**
      * <p>The Amazon Resource Name (ARN) of the modified table.</p>
      */
     resourceArn: string | undefined;
 }
-/**
- * @internal
- */
-export declare const CapacitySpecificationFilterSensitiveLog: (obj: CapacitySpecification) => any;
-/**
- * @internal
- */
-export declare const CapacitySpecificationSummaryFilterSensitiveLog: (obj: CapacitySpecificationSummary) => any;
-/**
- * @internal
- */
-export declare const ClientSideTimestampsFilterSensitiveLog: (obj: ClientSideTimestamps) => any;
-/**
- * @internal
- */
-export declare const ClusteringKeyFilterSensitiveLog: (obj: ClusteringKey) => any;
-/**
- * @internal
- */
-export declare const ColumnDefinitionFilterSensitiveLog: (obj: ColumnDefinition) => any;
-/**
- * @internal
- */
-export declare const CommentFilterSensitiveLog: (obj: Comment) => any;
-/**
- * @internal
- */
-export declare const TagFilterSensitiveLog: (obj: Tag) => any;
-/**
- * @internal
- */
-export declare const CreateKeyspaceRequestFilterSensitiveLog: (obj: CreateKeyspaceRequest) => any;
-/**
- * @internal
- */
-export declare const CreateKeyspaceResponseFilterSensitiveLog: (obj: CreateKeyspaceResponse) => any;
-/**
- * @internal
- */
-export declare const EncryptionSpecificationFilterSensitiveLog: (obj: EncryptionSpecification) => any;
-/**
- * @internal
- */
-export declare const PointInTimeRecoveryFilterSensitiveLog: (obj: PointInTimeRecovery) => any;
-/**
- * @internal
- */
-export declare const PartitionKeyFilterSensitiveLog: (obj: PartitionKey) => any;
-/**
- * @internal
- */
-export declare const StaticColumnFilterSensitiveLog: (obj: StaticColumn) => any;
-/**
- * @internal
- */
-export declare const SchemaDefinitionFilterSensitiveLog: (obj: SchemaDefinition) => any;
-/**
- * @internal
- */
-export declare const TimeToLiveFilterSensitiveLog: (obj: TimeToLive) => any;
-/**
- * @internal
- */
-export declare const CreateTableRequestFilterSensitiveLog: (obj: CreateTableRequest) => any;
-/**
- * @internal
- */
-export declare const CreateTableResponseFilterSensitiveLog: (obj: CreateTableResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteKeyspaceRequestFilterSensitiveLog: (obj: DeleteKeyspaceRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteKeyspaceResponseFilterSensitiveLog: (obj: DeleteKeyspaceResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteTableRequestFilterSensitiveLog: (obj: DeleteTableRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteTableResponseFilterSensitiveLog: (obj: DeleteTableResponse) => any;
-/**
- * @internal
- */
-export declare const GetKeyspaceRequestFilterSensitiveLog: (obj: GetKeyspaceRequest) => any;
-/**
- * @internal
- */
-export declare const GetKeyspaceResponseFilterSensitiveLog: (obj: GetKeyspaceResponse) => any;
-/**
- * @internal
- */
-export declare const GetTableRequestFilterSensitiveLog: (obj: GetTableRequest) => any;
-/**
- * @internal
- */
-export declare const PointInTimeRecoverySummaryFilterSensitiveLog: (obj: PointInTimeRecoverySummary) => any;
-/**
- * @internal
- */
-export declare const GetTableResponseFilterSensitiveLog: (obj: GetTableResponse) => any;
-/**
- * @internal
- */
-export declare const ListKeyspacesRequestFilterSensitiveLog: (obj: ListKeyspacesRequest) => any;
-/**
- * @internal
- */
-export declare const KeyspaceSummaryFilterSensitiveLog: (obj: KeyspaceSummary) => any;
-/**
- * @internal
- */
-export declare const ListKeyspacesResponseFilterSensitiveLog: (obj: ListKeyspacesResponse) => any;
-/**
- * @internal
- */
-export declare const ListTablesRequestFilterSensitiveLog: (obj: ListTablesRequest) => any;
-/**
- * @internal
- */
-export declare const TableSummaryFilterSensitiveLog: (obj: TableSummary) => any;
-/**
- * @internal
- */
-export declare const ListTablesResponseFilterSensitiveLog: (obj: ListTablesResponse) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
-/**
- * @internal
- */
-export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
-/**
- * @internal
- */
-export declare const RestoreTableRequestFilterSensitiveLog: (obj: RestoreTableRequest) => any;
-/**
- * @internal
- */
-export declare const RestoreTableResponseFilterSensitiveLog: (obj: RestoreTableResponse) => any;
-/**
- * @internal
- */
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateTableRequestFilterSensitiveLog: (obj: UpdateTableRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateTableResponseFilterSensitiveLog: (obj: UpdateTableResponse) => any;

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { KeyspacesClient } from "../KeyspacesClient";
+/**
+ * @public
+ */
 export interface KeyspacesPaginationConfiguration extends PaginationConfiguration {
     client: KeyspacesClient;
 }

package/dist-types/pagination/ListKeyspacesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListKeyspacesCommandInput, ListKeyspacesCommandOutput } from "../commands/ListKeyspacesCommand";
 import { KeyspacesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListKeyspaces(config: KeyspacesPaginationConfiguration, input: ListKeyspacesCommandInput, ...additionalArguments: any): Paginator<ListKeyspacesCommandOutput>;

package/dist-types/pagination/ListTablesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTablesCommandInput, ListTablesCommandOutput } from "../commands/ListTablesCommand";
 import { KeyspacesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTables(config: KeyspacesPaginationConfiguration, input: ListTablesCommandInput, ...additionalArguments: any): Paginator<ListTablesCommandOutput>;

package/dist-types/pagination/ListTagsForResourcePaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
 import { KeyspacesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTagsForResource(config: KeyspacesPaginationConfiguration, input: ListTagsForResourceCommandInput, ...additionalArguments: any): Paginator<ListTagsForResourceCommandOutput>;