@aws-sdk/client-keyspaces 3.378.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -18,6 +18,7 @@
18
18
  */
19
19
  export * from "./KeyspacesClient";
20
20
  export * from "./Keyspaces";
21
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
21
22
  export * from "./commands";
22
23
  export * from "./pagination";
23
24
  export * from "./models";
@@ -42,6 +42,7 @@ export type ThroughputMode = (typeof ThroughputMode)[keyof typeof ThroughputMode
42
42
  */
43
43
  export interface CapacitySpecification {
44
44
  /**
45
+ * @public
45
46
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
46
47
  * <ul>
47
48
  * <li>
@@ -60,11 +61,13 @@ export interface CapacitySpecification {
60
61
  */
61
62
  throughputMode: ThroughputMode | string | undefined;
62
63
  /**
64
+ * @public
63
65
  * <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code>
64
66
  * <code>(RCUs)</code>.</p>
65
67
  */
66
68
  readCapacityUnits?: number;
67
69
  /**
70
+ * @public
68
71
  * <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code>
69
72
  * <code>(WCUs)</code>.</p>
70
73
  */
@@ -88,6 +91,7 @@ export interface CapacitySpecification {
88
91
  */
89
92
  export interface CapacitySpecificationSummary {
90
93
  /**
94
+ * @public
91
95
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
92
96
  * <ul>
93
97
  * <li>
@@ -106,16 +110,19 @@ export interface CapacitySpecificationSummary {
106
110
  */
107
111
  throughputMode: ThroughputMode | string | undefined;
108
112
  /**
113
+ * @public
109
114
  * <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code>
110
115
  * <code>(RCUs)</code>.</p>
111
116
  */
112
117
  readCapacityUnits?: number;
113
118
  /**
119
+ * @public
114
120
  * <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code>
115
121
  * <code>(WCUs)</code>.</p>
116
122
  */
117
123
  writeCapacityUnits?: number;
118
124
  /**
125
+ * @public
119
126
  * <p>The timestamp of the last operation that changed the provisioned throughput capacity of a table.</p>
120
127
  */
121
128
  lastUpdateToPayPerRequestTimestamp?: Date;
@@ -139,6 +146,7 @@ export type ClientSideTimestampsStatus = (typeof ClientSideTimestampsStatus)[key
139
146
  */
140
147
  export interface ClientSideTimestamps {
141
148
  /**
149
+ * @public
142
150
  * <p>Shows how to enable client-side timestamps settings for the specified table.</p>
143
151
  */
144
152
  status: ClientSideTimestampsStatus | string | undefined;
@@ -161,10 +169,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
161
169
  */
162
170
  export interface ClusteringKey {
163
171
  /**
172
+ * @public
164
173
  * <p>The name(s) of the clustering column(s).</p>
165
174
  */
166
175
  name: string | undefined;
167
176
  /**
177
+ * @public
168
178
  * <p>Sets the ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p>
169
179
  */
170
180
  orderBy: SortOrder | string | undefined;
@@ -175,10 +185,12 @@ export interface ClusteringKey {
175
185
  */
176
186
  export interface ColumnDefinition {
177
187
  /**
188
+ * @public
178
189
  * <p>The name of the column.</p>
179
190
  */
180
191
  name: string | undefined;
181
192
  /**
193
+ * @public
182
194
  * <p>The data type of the column. For a list of available data types, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer
183
195
  * Guide</i>.</p>
184
196
  */
@@ -190,6 +202,7 @@ export interface ColumnDefinition {
190
202
  */
191
203
  export interface Comment {
192
204
  /**
205
+ * @public
193
206
  * <p>An optional description of the table.</p>
194
207
  */
195
208
  message: string | undefined;
@@ -238,6 +251,7 @@ export type Rs = (typeof Rs)[keyof typeof Rs];
238
251
  */
239
252
  export interface ReplicationSpecification {
240
253
  /**
254
+ * @public
241
255
  * <p>
242
256
  * The <code>replicationStrategy</code> of a keyspace, the required value is <code>SINGLE_REGION</code> or
243
257
  * <code>MULTI_REGION</code>.
@@ -245,6 +259,7 @@ export interface ReplicationSpecification {
245
259
  */
246
260
  replicationStrategy: Rs | string | undefined;
247
261
  /**
262
+ * @public
248
263
  * <p>
249
264
  * The <code>regionList</code> can contain up to six Amazon Web Services Regions where the keyspace is replicated in.
250
265
  * </p>
@@ -262,11 +277,13 @@ export interface ReplicationSpecification {
262
277
  */
263
278
  export interface Tag {
264
279
  /**
280
+ * @public
265
281
  * <p>The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an
266
282
  * existing tag (same key), the existing tag value will be updated to the new value.</p>
267
283
  */
268
284
  key: string | undefined;
269
285
  /**
286
+ * @public
270
287
  * <p>The value of the tag. Tag values are case-sensitive and can be null.</p>
271
288
  */
272
289
  value: string | undefined;
@@ -276,16 +293,19 @@ export interface Tag {
276
293
  */
277
294
  export interface CreateKeyspaceRequest {
278
295
  /**
296
+ * @public
279
297
  * <p>The name of the keyspace to be created.</p>
280
298
  */
281
299
  keyspaceName: string | undefined;
282
300
  /**
301
+ * @public
283
302
  * <p>A list of key-value pair tags to be attached to the keyspace.</p>
284
303
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
285
304
  * Guide</i>.</p>
286
305
  */
287
306
  tags?: Tag[];
288
307
  /**
308
+ * @public
289
309
  * <p>
290
310
  * The replication specification of the keyspace includes:</p>
291
311
  * <ul>
@@ -310,6 +330,7 @@ export interface CreateKeyspaceRequest {
310
330
  */
311
331
  export interface CreateKeyspaceResponse {
312
332
  /**
333
+ * @public
313
334
  * <p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>
314
335
  */
315
336
  resourceArn: string | undefined;
@@ -382,6 +403,7 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
382
403
  */
383
404
  export interface EncryptionSpecification {
384
405
  /**
406
+ * @public
385
407
  * <p>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</p>
386
408
  * <ul>
387
409
  * <li>
@@ -401,6 +423,7 @@ export interface EncryptionSpecification {
401
423
  */
402
424
  type: EncryptionType | string | undefined;
403
425
  /**
426
+ * @public
404
427
  * <p>The Amazon Resource Name (ARN) of the customer managed KMS key, for example <code>kms_key_identifier:ARN</code>.</p>
405
428
  */
406
429
  kmsKeyIdentifier?: string;
@@ -425,6 +448,7 @@ export type PointInTimeRecoveryStatus = (typeof PointInTimeRecoveryStatus)[keyof
425
448
  */
426
449
  export interface PointInTimeRecovery {
427
450
  /**
451
+ * @public
428
452
  * <p>The options are:</p>
429
453
  * <ul>
430
454
  * <li>
@@ -449,6 +473,7 @@ export interface PointInTimeRecovery {
449
473
  */
450
474
  export interface PartitionKey {
451
475
  /**
476
+ * @public
452
477
  * <p>The name(s) of the partition key column(s).</p>
453
478
  */
454
479
  name: string | undefined;
@@ -459,6 +484,7 @@ export interface PartitionKey {
459
484
  */
460
485
  export interface StaticColumn {
461
486
  /**
487
+ * @public
462
488
  * <p>The name of the static column.</p>
463
489
  */
464
490
  name: string | undefined;
@@ -469,18 +495,22 @@ export interface StaticColumn {
469
495
  */
470
496
  export interface SchemaDefinition {
471
497
  /**
498
+ * @public
472
499
  * <p>The regular columns of the table.</p>
473
500
  */
474
501
  allColumns: ColumnDefinition[] | undefined;
475
502
  /**
503
+ * @public
476
504
  * <p>The columns that are part of the partition key of the table .</p>
477
505
  */
478
506
  partitionKeys: PartitionKey[] | undefined;
479
507
  /**
508
+ * @public
480
509
  * <p>The columns that are part of the clustering key of the table.</p>
481
510
  */
482
511
  clusteringKeys?: ClusteringKey[];
483
512
  /**
513
+ * @public
484
514
  * <p>The columns that have been defined as <code>STATIC</code>. Static columns store values that are shared by all rows in the same partition.</p>
485
515
  */
486
516
  staticColumns?: StaticColumn[];
@@ -504,6 +534,7 @@ export type TimeToLiveStatus = (typeof TimeToLiveStatus)[keyof typeof TimeToLive
504
534
  */
505
535
  export interface TimeToLive {
506
536
  /**
537
+ * @public
507
538
  * <p>Shows how to enable custom Time to Live (TTL) settings for the specified table.</p>
508
539
  */
509
540
  status: TimeToLiveStatus | string | undefined;
@@ -513,14 +544,17 @@ export interface TimeToLive {
513
544
  */
514
545
  export interface CreateTableRequest {
515
546
  /**
547
+ * @public
516
548
  * <p>The name of the keyspace that the table is going to be created in.</p>
517
549
  */
518
550
  keyspaceName: string | undefined;
519
551
  /**
552
+ * @public
520
553
  * <p>The name of the table.</p>
521
554
  */
522
555
  tableName: string | undefined;
523
556
  /**
557
+ * @public
524
558
  * <p>The <code>schemaDefinition</code> consists of the
525
559
  * following parameters.</p>
526
560
  * <p>For each column to be created:</p>
@@ -582,10 +616,12 @@ export interface CreateTableRequest {
582
616
  */
583
617
  schemaDefinition: SchemaDefinition | undefined;
584
618
  /**
619
+ * @public
585
620
  * <p>This parameter allows to enter a description of the table.</p>
586
621
  */
587
622
  comment?: Comment;
588
623
  /**
624
+ * @public
589
625
  * <p>Specifies the read/write throughput capacity mode for the table. The options are:</p>
590
626
  * <ul>
591
627
  * <li>
@@ -605,6 +641,7 @@ export interface CreateTableRequest {
605
641
  */
606
642
  capacitySpecification?: CapacitySpecification;
607
643
  /**
644
+ * @public
608
645
  * <p>Specifies how the encryption key for encryption at rest is managed for the table.
609
646
  * You can choose one of the following KMS key (KMS key):</p>
610
647
  * <ul>
@@ -625,6 +662,7 @@ export interface CreateTableRequest {
625
662
  */
626
663
  encryptionSpecification?: EncryptionSpecification;
627
664
  /**
665
+ * @public
628
666
  * <p>Specifies if <code>pointInTimeRecovery</code> is enabled or disabled for the
629
667
  * table. The options are:</p>
630
668
  * <ul>
@@ -646,6 +684,7 @@ export interface CreateTableRequest {
646
684
  */
647
685
  pointInTimeRecovery?: PointInTimeRecovery;
648
686
  /**
687
+ * @public
649
688
  * <p>Enables Time to Live custom settings for the
650
689
  * table. The options are:</p>
651
690
  * <ul>
@@ -668,6 +707,7 @@ export interface CreateTableRequest {
668
707
  */
669
708
  ttl?: TimeToLive;
670
709
  /**
710
+ * @public
671
711
  * <p>The default Time to Live setting in seconds for the
672
712
  * table.</p>
673
713
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer
@@ -675,6 +715,7 @@ export interface CreateTableRequest {
675
715
  */
676
716
  defaultTimeToLive?: number;
677
717
  /**
718
+ * @public
678
719
  * <p>A list of key-value pair tags to be
679
720
  * attached to the resource. </p>
680
721
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
@@ -682,6 +723,7 @@ export interface CreateTableRequest {
682
723
  */
683
724
  tags?: Tag[];
684
725
  /**
726
+ * @public
685
727
  * <p>
686
728
  * Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
687
729
  * client-side timestamps with the following option:</p>
@@ -701,6 +743,7 @@ export interface CreateTableRequest {
701
743
  */
702
744
  export interface CreateTableResponse {
703
745
  /**
746
+ * @public
704
747
  * <p>The unique identifier of the table in the format of an Amazon Resource Name (ARN).</p>
705
748
  */
706
749
  resourceArn: string | undefined;
@@ -713,6 +756,7 @@ export declare class ResourceNotFoundException extends __BaseException {
713
756
  readonly name: "ResourceNotFoundException";
714
757
  readonly $fault: "client";
715
758
  /**
759
+ * @public
716
760
  * <p>The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.</p>
717
761
  */
718
762
  resourceArn?: string;
@@ -726,6 +770,7 @@ export declare class ResourceNotFoundException extends __BaseException {
726
770
  */
727
771
  export interface DeleteKeyspaceRequest {
728
772
  /**
773
+ * @public
729
774
  * <p>The name of the keyspace to be deleted.</p>
730
775
  */
731
776
  keyspaceName: string | undefined;
@@ -740,10 +785,12 @@ export interface DeleteKeyspaceResponse {
740
785
  */
741
786
  export interface DeleteTableRequest {
742
787
  /**
788
+ * @public
743
789
  * <p>The name of the keyspace of the to be deleted table.</p>
744
790
  */
745
791
  keyspaceName: string | undefined;
746
792
  /**
793
+ * @public
747
794
  * <p>The name of the table to be deleted.</p>
748
795
  */
749
796
  tableName: string | undefined;
@@ -758,6 +805,7 @@ export interface DeleteTableResponse {
758
805
  */
759
806
  export interface GetKeyspaceRequest {
760
807
  /**
808
+ * @public
761
809
  * <p>The name of the keyspace.</p>
762
810
  */
763
811
  keyspaceName: string | undefined;
@@ -767,20 +815,24 @@ export interface GetKeyspaceRequest {
767
815
  */
768
816
  export interface GetKeyspaceResponse {
769
817
  /**
818
+ * @public
770
819
  * <p>The name of the keyspace.</p>
771
820
  */
772
821
  keyspaceName: string | undefined;
773
822
  /**
823
+ * @public
774
824
  * <p>Returns the ARN of the keyspace.</p>
775
825
  */
776
826
  resourceArn: string | undefined;
777
827
  /**
828
+ * @public
778
829
  * <p>
779
830
  * Returns the replication strategy of the keyspace. The options are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
780
831
  * </p>
781
832
  */
782
833
  replicationStrategy: Rs | string | undefined;
783
834
  /**
835
+ * @public
784
836
  * <p>
785
837
  * If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
786
838
  * </p>
@@ -792,10 +844,12 @@ export interface GetKeyspaceResponse {
792
844
  */
793
845
  export interface GetTableRequest {
794
846
  /**
847
+ * @public
795
848
  * <p>The name of the keyspace that the table is stored in.</p>
796
849
  */
797
850
  keyspaceName: string | undefined;
798
851
  /**
852
+ * @public
799
853
  * <p>The name of the table.</p>
800
854
  */
801
855
  tableName: string | undefined;
@@ -806,10 +860,12 @@ export interface GetTableRequest {
806
860
  */
807
861
  export interface PointInTimeRecoverySummary {
808
862
  /**
863
+ * @public
809
864
  * <p>Shows if point-in-time recovery is enabled or disabled for the specified table.</p>
810
865
  */
811
866
  status: PointInTimeRecoveryStatus | string | undefined;
812
867
  /**
868
+ * @public
813
869
  * <p>Specifies the earliest possible restore point of the table in ISO 8601 format.</p>
814
870
  */
815
871
  earliestRestorableTimestamp?: Date;
@@ -836,30 +892,37 @@ export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
836
892
  */
837
893
  export interface GetTableResponse {
838
894
  /**
895
+ * @public
839
896
  * <p>The name of the keyspace that the specified table is stored in.</p>
840
897
  */
841
898
  keyspaceName: string | undefined;
842
899
  /**
900
+ * @public
843
901
  * <p>The name of the specified table.</p>
844
902
  */
845
903
  tableName: string | undefined;
846
904
  /**
905
+ * @public
847
906
  * <p>The Amazon Resource Name (ARN) of the specified table.</p>
848
907
  */
849
908
  resourceArn: string | undefined;
850
909
  /**
910
+ * @public
851
911
  * <p>The creation timestamp of the specified table.</p>
852
912
  */
853
913
  creationTimestamp?: Date;
854
914
  /**
915
+ * @public
855
916
  * <p>The current status of the specified table.</p>
856
917
  */
857
918
  status?: TableStatus | string;
858
919
  /**
920
+ * @public
859
921
  * <p>The schema definition of the specified table.</p>
860
922
  */
861
923
  schemaDefinition?: SchemaDefinition;
862
924
  /**
925
+ * @public
863
926
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
864
927
  * <ul>
865
928
  * <li>
@@ -876,26 +939,32 @@ export interface GetTableResponse {
876
939
  */
877
940
  capacitySpecification?: CapacitySpecificationSummary;
878
941
  /**
942
+ * @public
879
943
  * <p>The encryption settings of the specified table.</p>
880
944
  */
881
945
  encryptionSpecification?: EncryptionSpecification;
882
946
  /**
947
+ * @public
883
948
  * <p>The point-in-time recovery status of the specified table.</p>
884
949
  */
885
950
  pointInTimeRecovery?: PointInTimeRecoverySummary;
886
951
  /**
952
+ * @public
887
953
  * <p>The custom Time to Live settings of the specified table.</p>
888
954
  */
889
955
  ttl?: TimeToLive;
890
956
  /**
957
+ * @public
891
958
  * <p>The default Time to Live settings in seconds of the specified table.</p>
892
959
  */
893
960
  defaultTimeToLive?: number;
894
961
  /**
962
+ * @public
895
963
  * <p>The the description of the specified table.</p>
896
964
  */
897
965
  comment?: Comment;
898
966
  /**
967
+ * @public
899
968
  * <p>
900
969
  * The client-side timestamps setting of the table.</p>
901
970
  */
@@ -906,10 +975,12 @@ export interface GetTableResponse {
906
975
  */
907
976
  export interface ListKeyspacesRequest {
908
977
  /**
978
+ * @public
909
979
  * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</p>
910
980
  */
911
981
  nextToken?: string;
912
982
  /**
983
+ * @public
913
984
  * <p>The total number of keyspaces to return in the output. If the total number of keyspaces available
914
985
  * is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
915
986
  * provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
@@ -922,14 +993,17 @@ export interface ListKeyspacesRequest {
922
993
  */
923
994
  export interface KeyspaceSummary {
924
995
  /**
996
+ * @public
925
997
  * <p>The name of the keyspace.</p>
926
998
  */
927
999
  keyspaceName: string | undefined;
928
1000
  /**
1001
+ * @public
929
1002
  * <p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>
930
1003
  */
931
1004
  resourceArn: string | undefined;
932
1005
  /**
1006
+ * @public
933
1007
  * <p>
934
1008
  * This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available
935
1009
  * values are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
@@ -937,6 +1011,7 @@ export interface KeyspaceSummary {
937
1011
  */
938
1012
  replicationStrategy: Rs | string | undefined;
939
1013
  /**
1014
+ * @public
940
1015
  * <p>
941
1016
  * If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
942
1017
  * </p>
@@ -948,10 +1023,12 @@ export interface KeyspaceSummary {
948
1023
  */
949
1024
  export interface ListKeyspacesResponse {
950
1025
  /**
1026
+ * @public
951
1027
  * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
952
1028
  */
953
1029
  nextToken?: string;
954
1030
  /**
1031
+ * @public
955
1032
  * <p>A list of keyspaces.</p>
956
1033
  */
957
1034
  keyspaces: KeyspaceSummary[] | undefined;
@@ -961,16 +1038,19 @@ export interface ListKeyspacesResponse {
961
1038
  */
962
1039
  export interface ListTablesRequest {
963
1040
  /**
1041
+ * @public
964
1042
  * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
965
1043
  */
966
1044
  nextToken?: string;
967
1045
  /**
1046
+ * @public
968
1047
  * <p>The total number of tables to return in the output. If the total number of tables available
969
1048
  * is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
970
1049
  * provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
971
1050
  */
972
1051
  maxResults?: number;
973
1052
  /**
1053
+ * @public
974
1054
  * <p>The name of the keyspace.</p>
975
1055
  */
976
1056
  keyspaceName: string | undefined;
@@ -981,14 +1061,17 @@ export interface ListTablesRequest {
981
1061
  */
982
1062
  export interface TableSummary {
983
1063
  /**
1064
+ * @public
984
1065
  * <p>The name of the keyspace that the table is stored in.</p>
985
1066
  */
986
1067
  keyspaceName: string | undefined;
987
1068
  /**
1069
+ * @public
988
1070
  * <p>The name of the table.</p>
989
1071
  */
990
1072
  tableName: string | undefined;
991
1073
  /**
1074
+ * @public
992
1075
  * <p>The unique identifier of the table in the format of an Amazon Resource Name (ARN).</p>
993
1076
  */
994
1077
  resourceArn: string | undefined;
@@ -998,10 +1081,12 @@ export interface TableSummary {
998
1081
  */
999
1082
  export interface ListTablesResponse {
1000
1083
  /**
1084
+ * @public
1001
1085
  * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
1002
1086
  */
1003
1087
  nextToken?: string;
1004
1088
  /**
1089
+ * @public
1005
1090
  * <p>A list of tables.</p>
1006
1091
  */
1007
1092
  tables?: TableSummary[];
@@ -1011,14 +1096,17 @@ export interface ListTablesResponse {
1011
1096
  */
1012
1097
  export interface ListTagsForResourceRequest {
1013
1098
  /**
1099
+ * @public
1014
1100
  * <p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.</p>
1015
1101
  */
1016
1102
  resourceArn: string | undefined;
1017
1103
  /**
1104
+ * @public
1018
1105
  * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</p>
1019
1106
  */
1020
1107
  nextToken?: string;
1021
1108
  /**
1109
+ * @public
1022
1110
  * <p>The total number of tags to return in the output. If the total number of tags available
1023
1111
  * is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
1024
1112
  * provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
@@ -1030,10 +1118,12 @@ export interface ListTagsForResourceRequest {
1030
1118
  */
1031
1119
  export interface ListTagsForResourceResponse {
1032
1120
  /**
1121
+ * @public
1033
1122
  * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
1034
1123
  */
1035
1124
  nextToken?: string;
1036
1125
  /**
1126
+ * @public
1037
1127
  * <p>A list of tags.</p>
1038
1128
  */
1039
1129
  tags?: Tag[];
@@ -1043,26 +1133,32 @@ export interface ListTagsForResourceResponse {
1043
1133
  */
1044
1134
  export interface RestoreTableRequest {
1045
1135
  /**
1136
+ * @public
1046
1137
  * <p>The keyspace name of the source table.</p>
1047
1138
  */
1048
1139
  sourceKeyspaceName: string | undefined;
1049
1140
  /**
1141
+ * @public
1050
1142
  * <p>The name of the source table.</p>
1051
1143
  */
1052
1144
  sourceTableName: string | undefined;
1053
1145
  /**
1146
+ * @public
1054
1147
  * <p>The name of the target keyspace.</p>
1055
1148
  */
1056
1149
  targetKeyspaceName: string | undefined;
1057
1150
  /**
1151
+ * @public
1058
1152
  * <p>The name of the target table.</p>
1059
1153
  */
1060
1154
  targetTableName: string | undefined;
1061
1155
  /**
1156
+ * @public
1062
1157
  * <p>The restore timestamp in ISO 8601 format.</p>
1063
1158
  */
1064
1159
  restoreTimestamp?: Date;
1065
1160
  /**
1161
+ * @public
1066
1162
  * <p>Specifies the read/write throughput capacity mode for the target table. The options are:</p>
1067
1163
  * <ul>
1068
1164
  * <li>
@@ -1082,6 +1178,7 @@ export interface RestoreTableRequest {
1082
1178
  */
1083
1179
  capacitySpecificationOverride?: CapacitySpecification;
1084
1180
  /**
1181
+ * @public
1085
1182
  * <p>Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):</p>
1086
1183
  * <ul>
1087
1184
  * <li>
@@ -1101,6 +1198,7 @@ export interface RestoreTableRequest {
1101
1198
  */
1102
1199
  encryptionSpecificationOverride?: EncryptionSpecification;
1103
1200
  /**
1201
+ * @public
1104
1202
  * <p>Specifies the <code>pointInTimeRecovery</code> settings for the target
1105
1203
  * table. The options are:</p>
1106
1204
  * <ul>
@@ -1121,6 +1219,7 @@ export interface RestoreTableRequest {
1121
1219
  */
1122
1220
  pointInTimeRecoveryOverride?: PointInTimeRecovery;
1123
1221
  /**
1222
+ * @public
1124
1223
  * <p>A list of key-value pair tags to be
1125
1224
  * attached to the restored table. </p>
1126
1225
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
@@ -1133,6 +1232,7 @@ export interface RestoreTableRequest {
1133
1232
  */
1134
1233
  export interface RestoreTableResponse {
1135
1234
  /**
1235
+ * @public
1136
1236
  * <p>The Amazon Resource Name (ARN) of the restored table.</p>
1137
1237
  */
1138
1238
  restoredTableARN: string | undefined;
@@ -1142,10 +1242,12 @@ export interface RestoreTableResponse {
1142
1242
  */
1143
1243
  export interface TagResourceRequest {
1144
1244
  /**
1245
+ * @public
1145
1246
  * <p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.</p>
1146
1247
  */
1147
1248
  resourceArn: string | undefined;
1148
1249
  /**
1250
+ * @public
1149
1251
  * <p>The tags to be assigned to the Amazon Keyspaces resource.</p>
1150
1252
  */
1151
1253
  tags: Tag[] | undefined;
@@ -1160,10 +1262,12 @@ export interface TagResourceResponse {
1160
1262
  */
1161
1263
  export interface UntagResourceRequest {
1162
1264
  /**
1265
+ * @public
1163
1266
  * <p>The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).</p>
1164
1267
  */
1165
1268
  resourceArn: string | undefined;
1166
1269
  /**
1270
+ * @public
1167
1271
  * <p>A list of existing tags to be removed from the Amazon Keyspaces resource.</p>
1168
1272
  */
1169
1273
  tags: Tag[] | undefined;
@@ -1178,14 +1282,17 @@ export interface UntagResourceResponse {
1178
1282
  */
1179
1283
  export interface UpdateTableRequest {
1180
1284
  /**
1285
+ * @public
1181
1286
  * <p>The name of the keyspace the specified table is stored in.</p>
1182
1287
  */
1183
1288
  keyspaceName: string | undefined;
1184
1289
  /**
1290
+ * @public
1185
1291
  * <p>The name of the table.</p>
1186
1292
  */
1187
1293
  tableName: string | undefined;
1188
1294
  /**
1295
+ * @public
1189
1296
  * <p>For each column to be added to the specified table:</p>
1190
1297
  * <ul>
1191
1298
  * <li>
@@ -1203,6 +1310,7 @@ export interface UpdateTableRequest {
1203
1310
  */
1204
1311
  addColumns?: ColumnDefinition[];
1205
1312
  /**
1313
+ * @public
1206
1314
  * <p>Modifies the read/write throughput capacity mode for the table. The options are:</p>
1207
1315
  * <ul>
1208
1316
  * <li>
@@ -1221,6 +1329,7 @@ export interface UpdateTableRequest {
1221
1329
  */
1222
1330
  capacitySpecification?: CapacitySpecification;
1223
1331
  /**
1332
+ * @public
1224
1333
  * <p>Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):</p>
1225
1334
  * <ul>
1226
1335
  * <li>
@@ -1240,6 +1349,7 @@ export interface UpdateTableRequest {
1240
1349
  */
1241
1350
  encryptionSpecification?: EncryptionSpecification;
1242
1351
  /**
1352
+ * @public
1243
1353
  * <p>Modifies the <code>pointInTimeRecovery</code> settings of the table. The options are:</p>
1244
1354
  * <ul>
1245
1355
  * <li>
@@ -1259,6 +1369,7 @@ export interface UpdateTableRequest {
1259
1369
  */
1260
1370
  pointInTimeRecovery?: PointInTimeRecovery;
1261
1371
  /**
1372
+ * @public
1262
1373
  * <p>Modifies Time to Live custom settings for the table. The options are:</p>
1263
1374
  * <ul>
1264
1375
  * <li>
@@ -1280,12 +1391,14 @@ export interface UpdateTableRequest {
1280
1391
  */
1281
1392
  ttl?: TimeToLive;
1282
1393
  /**
1394
+ * @public
1283
1395
  * <p>The default Time to Live setting in seconds for the table.</p>
1284
1396
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer
1285
1397
  * Guide</i>.</p>
1286
1398
  */
1287
1399
  defaultTimeToLive?: number;
1288
1400
  /**
1401
+ * @public
1289
1402
  * <p>Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
1290
1403
  * client-side timestamps with the following option:</p>
1291
1404
  * <ul>
@@ -1304,6 +1417,7 @@ export interface UpdateTableRequest {
1304
1417
  */
1305
1418
  export interface UpdateTableResponse {
1306
1419
  /**
1420
+ * @public
1307
1421
  * <p>The Amazon Resource Name (ARN) of the modified table.</p>
1308
1422
  */
1309
1423
  resourceArn: string | undefined;
@@ -1,5 +1,6 @@
1
1
  export * from "./KeyspacesClient";
2
2
  export * from "./Keyspaces";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-keyspaces",
3
3
  "description": "AWS SDK for JavaScript Keyspaces Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",