@aws-sdk/client-keyspaces 3.490.0 → 3.494.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.
- package/README.md +8 -0
- package/dist-cjs/Keyspaces.js +2 -0
- package/dist-cjs/commands/GetTableAutoScalingSettingsCommand.js +28 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_0.js +196 -3
- package/dist-es/Keyspaces.js +2 -0
- package/dist-es/commands/GetTableAutoScalingSettingsCommand.js +24 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +194 -3
- package/dist-types/Keyspaces.d.ts +7 -0
- package/dist-types/KeyspacesClient.d.ts +3 -2
- package/dist-types/commands/CreateKeyspaceCommand.d.ts +2 -2
- package/dist-types/commands/CreateTableCommand.d.ts +49 -2
- package/dist-types/commands/DeleteKeyspaceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTableCommand.d.ts +2 -2
- package/dist-types/commands/GetKeyspaceCommand.d.ts +1 -1
- package/dist-types/commands/GetTableAutoScalingSettingsCommand.d.ts +142 -0
- package/dist-types/commands/GetTableCommand.d.ts +13 -1
- package/dist-types/commands/ListKeyspacesCommand.d.ts +1 -1
- package/dist-types/commands/ListTablesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/RestoreTableCommand.d.ts +55 -9
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateTableCommand.d.ts +50 -3
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +362 -2
- package/dist-types/protocols/Aws_json1_0.d.ts +9 -0
- package/dist-types/ts3.4/Keyspaces.d.ts +17 -0
- package/dist-types/ts3.4/KeyspacesClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/GetTableAutoScalingSettingsCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +51 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +12 -0
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { KeyspacesServiceException as __BaseException } from "./KeyspacesServiceException";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
|
-
* <p>You
|
|
5
|
+
* <p>You don't have sufficient access permissions to perform this action. </p>
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -12,6 +12,159 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
12
12
|
*/
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* <p>The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.</p>
|
|
18
|
+
*/
|
|
19
|
+
export interface TargetTrackingScalingPolicyConfiguration {
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Specifies if <code>scale-in</code> is enabled.</p>
|
|
23
|
+
* <p>When auto scaling automatically decreases capacity for a table,
|
|
24
|
+
* the table <i>scales in</i>. When scaling policies are set, they can't
|
|
25
|
+
* scale in the table lower than its minimum capacity.</p>
|
|
26
|
+
*/
|
|
27
|
+
disableScaleIn?: boolean;
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
* <p>Specifies a <code>scale-in</code> cool down period.</p>
|
|
31
|
+
* <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
|
|
32
|
+
*/
|
|
33
|
+
scaleInCooldown?: number;
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
* <p>Specifies a scale out cool down period.</p>
|
|
37
|
+
* <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
|
|
38
|
+
*/
|
|
39
|
+
scaleOutCooldown?: number;
|
|
40
|
+
/**
|
|
41
|
+
* @public
|
|
42
|
+
* <p>Specifies the target value for the target tracking auto scaling policy.</p>
|
|
43
|
+
* <p>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization
|
|
44
|
+
* rate, and then back down when it falls below the target. This ensures that the ratio of
|
|
45
|
+
* consumed capacity to provisioned capacity stays at or near this value. You
|
|
46
|
+
* define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90.</p>
|
|
47
|
+
*/
|
|
48
|
+
targetValue: number | undefined;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* @public
|
|
52
|
+
* <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling
|
|
53
|
+
* ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You
|
|
54
|
+
* define the target value as a percentage between 20 and 90.</p>
|
|
55
|
+
*/
|
|
56
|
+
export interface AutoScalingPolicy {
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
* <p>Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down
|
|
60
|
+
* when it falls below the target. A <code>double</code> between 20 and 90.</p>
|
|
61
|
+
*/
|
|
62
|
+
targetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* @public
|
|
66
|
+
* <p>The optional auto scaling settings for a table with provisioned throughput capacity.</p>
|
|
67
|
+
* <p>To turn on auto scaling for a table in <code>throughputMode:PROVISIONED</code>,
|
|
68
|
+
* you must specify the following parameters. </p>
|
|
69
|
+
* <p>Configure the minimum and maximum units for write and read capacity. The auto scaling policy ensures that capacity never goes below the
|
|
70
|
+
* minimum or above the maximum range.</p>
|
|
71
|
+
* <ul>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>
|
|
74
|
+
* <code>minimumUnits</code>: The minimum level of throughput the table should always be ready to support. The value must be between 1
|
|
75
|
+
* and the max throughput per second quota for your account (40,000 by default).</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>
|
|
79
|
+
* <code>maximumUnits</code>: The maximum level of throughput the table should always be ready to
|
|
80
|
+
* support. The value must be between 1 and the max throughput per second quota for your
|
|
81
|
+
* account (40,000 by default).</p>
|
|
82
|
+
* </li>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>
|
|
85
|
+
* <code>scalingPolicy</code>: Amazon Keyspaces supports the <code>target tracking</code> scaling policy.
|
|
86
|
+
* The auto scaling target is the provisioned read and write capacity of the table.
|
|
87
|
+
* </p>
|
|
88
|
+
* <ul>
|
|
89
|
+
* <li>
|
|
90
|
+
* <p>
|
|
91
|
+
* <code>targetTrackingScalingPolicyConfiguration</code>: To define the target tracking policy, you must define the target value.
|
|
92
|
+
* </p>
|
|
93
|
+
* <ul>
|
|
94
|
+
* <li>
|
|
95
|
+
* <p>
|
|
96
|
+
* <code>targetValue</code>: The target utilization rate of the table. Amazon Keyspaces auto scaling ensures that the ratio of
|
|
97
|
+
* consumed capacity to provisioned capacity stays at or near this value. You
|
|
98
|
+
* define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90. (Required)</p>
|
|
99
|
+
* </li>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>
|
|
102
|
+
* <code>disableScaleIn</code>: A <code>boolean</code> that specifies if <code>scale-in</code> is
|
|
103
|
+
* disabled or enabled for the table. This parameter is disabled by default.
|
|
104
|
+
* To turn on <code>scale-in</code>, set the <code>boolean</code> value to
|
|
105
|
+
* <code>FALSE</code>. This means that capacity for a table can be
|
|
106
|
+
* automatically scaled down on your behalf. (Optional) </p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p>
|
|
110
|
+
* <code>scaleInCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize
|
|
111
|
+
* before another scale in activity starts. If no value is provided, the default is 0. (Optional) </p>
|
|
112
|
+
* </li>
|
|
113
|
+
* <li>
|
|
114
|
+
* <p>
|
|
115
|
+
* <code>scaleOutCooldown</code>: A cooldown period in seconds between scaling activities that lets the table stabilize
|
|
116
|
+
* before another scale out activity starts. If no value is provided, the default is 0. (Optional) </p>
|
|
117
|
+
* </li>
|
|
118
|
+
* </ul>
|
|
119
|
+
* </li>
|
|
120
|
+
* </ul>
|
|
121
|
+
* </li>
|
|
122
|
+
* </ul>
|
|
123
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
124
|
+
* Guide</i>.</p>
|
|
125
|
+
*/
|
|
126
|
+
export interface AutoScalingSettings {
|
|
127
|
+
/**
|
|
128
|
+
* @public
|
|
129
|
+
* <p>This optional parameter enables auto scaling for the table if set to <code>false</code>.</p>
|
|
130
|
+
*/
|
|
131
|
+
autoScalingDisabled?: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
* <p>The minimum level of throughput the table should always be ready to support. The value must be between 1
|
|
135
|
+
* and the max throughput per second quota for your account (40,000 by default).</p>
|
|
136
|
+
*/
|
|
137
|
+
minimumUnits?: number;
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* <p>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1
|
|
141
|
+
* and the max throughput per second quota for your account (40,000 by default).</p>
|
|
142
|
+
*/
|
|
143
|
+
maximumUnits?: number;
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
* <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling
|
|
147
|
+
* ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You
|
|
148
|
+
* define the target value as a percentage between 20 and 90.</p>
|
|
149
|
+
*/
|
|
150
|
+
scalingPolicy?: AutoScalingPolicy;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* @public
|
|
154
|
+
* <p>The optional auto scaling settings for read and write capacity of a table in provisioned capacity mode.</p>
|
|
155
|
+
*/
|
|
156
|
+
export interface AutoScalingSpecification {
|
|
157
|
+
/**
|
|
158
|
+
* @public
|
|
159
|
+
* <p>The auto scaling settings for the table's write capacity.</p>
|
|
160
|
+
*/
|
|
161
|
+
writeCapacityAutoScaling?: AutoScalingSettings;
|
|
162
|
+
/**
|
|
163
|
+
* @public
|
|
164
|
+
* <p>The auto scaling settings for the table's read capacity.</p>
|
|
165
|
+
*/
|
|
166
|
+
readCapacityAutoScaling?: AutoScalingSettings;
|
|
167
|
+
}
|
|
15
168
|
/**
|
|
16
169
|
* @public
|
|
17
170
|
* @enum
|
|
@@ -209,7 +362,7 @@ export interface Comment {
|
|
|
209
362
|
}
|
|
210
363
|
/**
|
|
211
364
|
* @public
|
|
212
|
-
* <p>Amazon Keyspaces
|
|
365
|
+
* <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to
|
|
213
366
|
* perform an action and the same or a different action is already
|
|
214
367
|
* in progress, or if you try to create a resource that already exists. </p>
|
|
215
368
|
*/
|
|
@@ -465,6 +618,43 @@ export interface PointInTimeRecovery {
|
|
|
465
618
|
*/
|
|
466
619
|
status: PointInTimeRecoveryStatus | undefined;
|
|
467
620
|
}
|
|
621
|
+
/**
|
|
622
|
+
* @public
|
|
623
|
+
* <p>The Amazon Web Services Region specific settings of a multi-Region table.</p>
|
|
624
|
+
* <p>For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters.</p>
|
|
625
|
+
* <ul>
|
|
626
|
+
* <li>
|
|
627
|
+
* <p>
|
|
628
|
+
* <code>region</code>: The Region where these settings are applied. (Required)</p>
|
|
629
|
+
* </li>
|
|
630
|
+
* <li>
|
|
631
|
+
* <p>
|
|
632
|
+
* <code>readCapacityUnits</code>: The provisioned read capacity units. (Optional)</p>
|
|
633
|
+
* </li>
|
|
634
|
+
* <li>
|
|
635
|
+
* <p>
|
|
636
|
+
* <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional)</p>
|
|
637
|
+
* </li>
|
|
638
|
+
* </ul>
|
|
639
|
+
*/
|
|
640
|
+
export interface ReplicaSpecification {
|
|
641
|
+
/**
|
|
642
|
+
* @public
|
|
643
|
+
* <p>The Amazon Web Services Region.</p>
|
|
644
|
+
*/
|
|
645
|
+
region: string | undefined;
|
|
646
|
+
/**
|
|
647
|
+
* @public
|
|
648
|
+
* <p>The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.</p>
|
|
649
|
+
*/
|
|
650
|
+
readCapacityUnits?: number;
|
|
651
|
+
/**
|
|
652
|
+
* @public
|
|
653
|
+
* <p>The read capacity auto scaling settings for the multi-Region
|
|
654
|
+
* table in the specified Amazon Web Services Region.</p>
|
|
655
|
+
*/
|
|
656
|
+
readCapacityAutoScaling?: AutoScalingSettings;
|
|
657
|
+
}
|
|
468
658
|
/**
|
|
469
659
|
* @public
|
|
470
660
|
* <p>The partition key portion of the primary key is required
|
|
@@ -737,6 +927,39 @@ export interface CreateTableRequest {
|
|
|
737
927
|
* <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
738
928
|
*/
|
|
739
929
|
clientSideTimestamps?: ClientSideTimestamps;
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
* <p>The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity
|
|
933
|
+
* automatically on your behalf.</p>
|
|
934
|
+
* <p>Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
|
|
935
|
+
* your table's read and write capacity automatically in response to application traffic. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
936
|
+
* Guide</i>.</p>
|
|
937
|
+
* <p>By default, auto scaling is disabled for a table. </p>
|
|
938
|
+
*/
|
|
939
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
940
|
+
/**
|
|
941
|
+
* @public
|
|
942
|
+
* <p>The optional Amazon Web Services Region specific settings of a multi-Region table.
|
|
943
|
+
* These settings overwrite the general settings of the table for the specified Region. </p>
|
|
944
|
+
* <p>For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however,
|
|
945
|
+
* remains synchronized between all replicas to ensure that there's enough capacity to replicate writes across all Regions. To define the read capacity for a table
|
|
946
|
+
* replica in a specific Region, you can do so by configuring the following parameters.</p>
|
|
947
|
+
* <ul>
|
|
948
|
+
* <li>
|
|
949
|
+
* <p>
|
|
950
|
+
* <code>region</code>: The Region where these settings are applied. (Required)</p>
|
|
951
|
+
* </li>
|
|
952
|
+
* <li>
|
|
953
|
+
* <p>
|
|
954
|
+
* <code>readCapacityUnits</code>: The provisioned read capacity units. (Optional)</p>
|
|
955
|
+
* </li>
|
|
956
|
+
* <li>
|
|
957
|
+
* <p>
|
|
958
|
+
* <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional) </p>
|
|
959
|
+
* </li>
|
|
960
|
+
* </ul>
|
|
961
|
+
*/
|
|
962
|
+
replicaSpecifications?: ReplicaSpecification[];
|
|
740
963
|
}
|
|
741
964
|
/**
|
|
742
965
|
* @public
|
|
@@ -887,6 +1110,43 @@ export declare const TableStatus: {
|
|
|
887
1110
|
* @public
|
|
888
1111
|
*/
|
|
889
1112
|
export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
|
|
1113
|
+
/**
|
|
1114
|
+
* @public
|
|
1115
|
+
* <p>The Region-specific settings of a multi-Region table in the specified Amazon Web Services Region.</p>
|
|
1116
|
+
* <p>If the multi-Region table is using provisioned capacity and has optional auto scaling policies configured, note that
|
|
1117
|
+
* the Region specific summary returns both read and write capacity settings. But only Region specific read capacity settings can be configured for a
|
|
1118
|
+
* multi-Region table. In a multi-Region table, your write capacity units will be synced across all Amazon Web Services Regions to ensure that there is enough
|
|
1119
|
+
* capacity to replicate write events across Regions.</p>
|
|
1120
|
+
*/
|
|
1121
|
+
export interface ReplicaSpecificationSummary {
|
|
1122
|
+
/**
|
|
1123
|
+
* @public
|
|
1124
|
+
* <p>The Amazon Web Services Region.</p>
|
|
1125
|
+
*/
|
|
1126
|
+
region?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* @public
|
|
1129
|
+
* <p>The status of the multi-Region table in the specified Amazon Web Services Region.</p>
|
|
1130
|
+
*/
|
|
1131
|
+
status?: TableStatus;
|
|
1132
|
+
/**
|
|
1133
|
+
* @public
|
|
1134
|
+
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
1135
|
+
* <ul>
|
|
1136
|
+
* <li>
|
|
1137
|
+
* <p>
|
|
1138
|
+
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
1139
|
+
* </li>
|
|
1140
|
+
* <li>
|
|
1141
|
+
* <p>
|
|
1142
|
+
* <code>throughputMode:PROVISIONED</code>.</p>
|
|
1143
|
+
* </li>
|
|
1144
|
+
* </ul>
|
|
1145
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
1146
|
+
* Guide</i>.</p>
|
|
1147
|
+
*/
|
|
1148
|
+
capacitySpecification?: CapacitySpecificationSummary;
|
|
1149
|
+
}
|
|
890
1150
|
/**
|
|
891
1151
|
* @public
|
|
892
1152
|
*/
|
|
@@ -969,6 +1229,72 @@ export interface GetTableResponse {
|
|
|
969
1229
|
* The client-side timestamps setting of the table.</p>
|
|
970
1230
|
*/
|
|
971
1231
|
clientSideTimestamps?: ClientSideTimestamps;
|
|
1232
|
+
/**
|
|
1233
|
+
* @public
|
|
1234
|
+
* <p>Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.</p>
|
|
1235
|
+
*/
|
|
1236
|
+
replicaSpecifications?: ReplicaSpecificationSummary[];
|
|
1237
|
+
}
|
|
1238
|
+
/**
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
export interface GetTableAutoScalingSettingsRequest {
|
|
1242
|
+
/**
|
|
1243
|
+
* @public
|
|
1244
|
+
* <p>The name of the keyspace.</p>
|
|
1245
|
+
*/
|
|
1246
|
+
keyspaceName: string | undefined;
|
|
1247
|
+
/**
|
|
1248
|
+
* @public
|
|
1249
|
+
* <p>The name of the table.</p>
|
|
1250
|
+
*/
|
|
1251
|
+
tableName: string | undefined;
|
|
1252
|
+
}
|
|
1253
|
+
/**
|
|
1254
|
+
* @public
|
|
1255
|
+
* <p>The auto scaling settings of a multi-Region table in the specified Amazon Web Services Region.</p>
|
|
1256
|
+
*/
|
|
1257
|
+
export interface ReplicaAutoScalingSpecification {
|
|
1258
|
+
/**
|
|
1259
|
+
* @public
|
|
1260
|
+
* <p>The Amazon Web Services Region.</p>
|
|
1261
|
+
*/
|
|
1262
|
+
region?: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* @public
|
|
1265
|
+
* <p>The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region.</p>
|
|
1266
|
+
*/
|
|
1267
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
1268
|
+
}
|
|
1269
|
+
/**
|
|
1270
|
+
* @public
|
|
1271
|
+
*/
|
|
1272
|
+
export interface GetTableAutoScalingSettingsResponse {
|
|
1273
|
+
/**
|
|
1274
|
+
* @public
|
|
1275
|
+
* <p>The name of the keyspace.</p>
|
|
1276
|
+
*/
|
|
1277
|
+
keyspaceName: string | undefined;
|
|
1278
|
+
/**
|
|
1279
|
+
* @public
|
|
1280
|
+
* <p>The name of the table.</p>
|
|
1281
|
+
*/
|
|
1282
|
+
tableName: string | undefined;
|
|
1283
|
+
/**
|
|
1284
|
+
* @public
|
|
1285
|
+
* <p>The Amazon Resource Name (ARN) of the table.</p>
|
|
1286
|
+
*/
|
|
1287
|
+
resourceArn: string | undefined;
|
|
1288
|
+
/**
|
|
1289
|
+
* @public
|
|
1290
|
+
* <p>The auto scaling settings of the table.</p>
|
|
1291
|
+
*/
|
|
1292
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
1293
|
+
/**
|
|
1294
|
+
* @public
|
|
1295
|
+
* <p>The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in.</p>
|
|
1296
|
+
*/
|
|
1297
|
+
replicaSpecifications?: ReplicaAutoScalingSpecification[];
|
|
972
1298
|
}
|
|
973
1299
|
/**
|
|
974
1300
|
* @public
|
|
@@ -1226,6 +1552,22 @@ export interface RestoreTableRequest {
|
|
|
1226
1552
|
* Guide</i>.</p>
|
|
1227
1553
|
*/
|
|
1228
1554
|
tagsOverride?: Tag[];
|
|
1555
|
+
/**
|
|
1556
|
+
* @public
|
|
1557
|
+
* <p>The optional auto scaling settings for the restored table in provisioned capacity mode.
|
|
1558
|
+
* Specifies if the service can manage throughput capacity of a provisioned table
|
|
1559
|
+
* automatically on your behalf.
|
|
1560
|
+
* Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
|
|
1561
|
+
* your table's read and write capacity automatically in response to application traffic.</p>
|
|
1562
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
1563
|
+
* Guide</i>.</p>
|
|
1564
|
+
*/
|
|
1565
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
1566
|
+
/**
|
|
1567
|
+
* @public
|
|
1568
|
+
* <p>The optional Region specific settings of a multi-Regional table.</p>
|
|
1569
|
+
*/
|
|
1570
|
+
replicaSpecifications?: ReplicaSpecification[];
|
|
1229
1571
|
}
|
|
1230
1572
|
/**
|
|
1231
1573
|
* @public
|
|
@@ -1411,6 +1753,24 @@ export interface UpdateTableRequest {
|
|
|
1411
1753
|
* <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
1412
1754
|
*/
|
|
1413
1755
|
clientSideTimestamps?: ClientSideTimestamps;
|
|
1756
|
+
/**
|
|
1757
|
+
* @public
|
|
1758
|
+
* <p>The optional auto scaling settings to update for a table in provisioned capacity mode.
|
|
1759
|
+
* Specifies if the service can manage throughput capacity of a provisioned table
|
|
1760
|
+
* automatically on your behalf.
|
|
1761
|
+
* Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
|
|
1762
|
+
* your table's read and write capacity automatically in response to application traffic.</p>
|
|
1763
|
+
* <p>If auto scaling is already enabled for the table, you can use <code>UpdateTable</code> to update the minimum and maximum values or the
|
|
1764
|
+
* auto scaling policy settings independently.</p>
|
|
1765
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
|
|
1766
|
+
* Guide</i>.</p>
|
|
1767
|
+
*/
|
|
1768
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
1769
|
+
/**
|
|
1770
|
+
* @public
|
|
1771
|
+
* <p>The Region specific settings of a multi-Regional table.</p>
|
|
1772
|
+
*/
|
|
1773
|
+
replicaSpecifications?: ReplicaSpecification[];
|
|
1414
1774
|
}
|
|
1415
1775
|
/**
|
|
1416
1776
|
* @public
|
|
@@ -5,6 +5,7 @@ import { CreateTableCommandInput, CreateTableCommandOutput } from "../commands/C
|
|
|
5
5
|
import { DeleteKeyspaceCommandInput, DeleteKeyspaceCommandOutput } from "../commands/DeleteKeyspaceCommand";
|
|
6
6
|
import { DeleteTableCommandInput, DeleteTableCommandOutput } from "../commands/DeleteTableCommand";
|
|
7
7
|
import { GetKeyspaceCommandInput, GetKeyspaceCommandOutput } from "../commands/GetKeyspaceCommand";
|
|
8
|
+
import { GetTableAutoScalingSettingsCommandInput, GetTableAutoScalingSettingsCommandOutput } from "../commands/GetTableAutoScalingSettingsCommand";
|
|
8
9
|
import { GetTableCommandInput, GetTableCommandOutput } from "../commands/GetTableCommand";
|
|
9
10
|
import { ListKeyspacesCommandInput, ListKeyspacesCommandOutput } from "../commands/ListKeyspacesCommand";
|
|
10
11
|
import { ListTablesCommandInput, ListTablesCommandOutput } from "../commands/ListTablesCommand";
|
|
@@ -37,6 +38,10 @@ export declare const se_GetKeyspaceCommand: (input: GetKeyspaceCommandInput, con
|
|
|
37
38
|
* serializeAws_json1_0GetTableCommand
|
|
38
39
|
*/
|
|
39
40
|
export declare const se_GetTableCommand: (input: GetTableCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
41
|
+
/**
|
|
42
|
+
* serializeAws_json1_0GetTableAutoScalingSettingsCommand
|
|
43
|
+
*/
|
|
44
|
+
export declare const se_GetTableAutoScalingSettingsCommand: (input: GetTableAutoScalingSettingsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
40
45
|
/**
|
|
41
46
|
* serializeAws_json1_0ListKeyspacesCommand
|
|
42
47
|
*/
|
|
@@ -89,6 +94,10 @@ export declare const de_GetKeyspaceCommand: (output: __HttpResponse, context: __
|
|
|
89
94
|
* deserializeAws_json1_0GetTableCommand
|
|
90
95
|
*/
|
|
91
96
|
export declare const de_GetTableCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetTableCommandOutput>;
|
|
97
|
+
/**
|
|
98
|
+
* deserializeAws_json1_0GetTableAutoScalingSettingsCommand
|
|
99
|
+
*/
|
|
100
|
+
export declare const de_GetTableAutoScalingSettingsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetTableAutoScalingSettingsCommandOutput>;
|
|
92
101
|
/**
|
|
93
102
|
* deserializeAws_json1_0ListKeyspacesCommand
|
|
94
103
|
*/
|
|
@@ -19,6 +19,10 @@ import {
|
|
|
19
19
|
GetKeyspaceCommandInput,
|
|
20
20
|
GetKeyspaceCommandOutput,
|
|
21
21
|
} from "./commands/GetKeyspaceCommand";
|
|
22
|
+
import {
|
|
23
|
+
GetTableAutoScalingSettingsCommandInput,
|
|
24
|
+
GetTableAutoScalingSettingsCommandOutput,
|
|
25
|
+
} from "./commands/GetTableAutoScalingSettingsCommand";
|
|
22
26
|
import {
|
|
23
27
|
GetTableCommandInput,
|
|
24
28
|
GetTableCommandOutput,
|
|
@@ -131,6 +135,19 @@ export interface Keyspaces {
|
|
|
131
135
|
options: __HttpHandlerOptions,
|
|
132
136
|
cb: (err: any, data?: GetTableCommandOutput) => void
|
|
133
137
|
): void;
|
|
138
|
+
getTableAutoScalingSettings(
|
|
139
|
+
args: GetTableAutoScalingSettingsCommandInput,
|
|
140
|
+
options?: __HttpHandlerOptions
|
|
141
|
+
): Promise<GetTableAutoScalingSettingsCommandOutput>;
|
|
142
|
+
getTableAutoScalingSettings(
|
|
143
|
+
args: GetTableAutoScalingSettingsCommandInput,
|
|
144
|
+
cb: (err: any, data?: GetTableAutoScalingSettingsCommandOutput) => void
|
|
145
|
+
): void;
|
|
146
|
+
getTableAutoScalingSettings(
|
|
147
|
+
args: GetTableAutoScalingSettingsCommandInput,
|
|
148
|
+
options: __HttpHandlerOptions,
|
|
149
|
+
cb: (err: any, data?: GetTableAutoScalingSettingsCommandOutput) => void
|
|
150
|
+
): void;
|
|
134
151
|
listKeyspaces(
|
|
135
152
|
args: ListKeyspacesCommandInput,
|
|
136
153
|
options?: __HttpHandlerOptions
|
|
@@ -65,6 +65,10 @@ import {
|
|
|
65
65
|
GetKeyspaceCommandInput,
|
|
66
66
|
GetKeyspaceCommandOutput,
|
|
67
67
|
} from "./commands/GetKeyspaceCommand";
|
|
68
|
+
import {
|
|
69
|
+
GetTableAutoScalingSettingsCommandInput,
|
|
70
|
+
GetTableAutoScalingSettingsCommandOutput,
|
|
71
|
+
} from "./commands/GetTableAutoScalingSettingsCommand";
|
|
68
72
|
import {
|
|
69
73
|
GetTableCommandInput,
|
|
70
74
|
GetTableCommandOutput,
|
|
@@ -110,6 +114,7 @@ export type ServiceInputTypes =
|
|
|
110
114
|
| DeleteKeyspaceCommandInput
|
|
111
115
|
| DeleteTableCommandInput
|
|
112
116
|
| GetKeyspaceCommandInput
|
|
117
|
+
| GetTableAutoScalingSettingsCommandInput
|
|
113
118
|
| GetTableCommandInput
|
|
114
119
|
| ListKeyspacesCommandInput
|
|
115
120
|
| ListTablesCommandInput
|
|
@@ -124,6 +129,7 @@ export type ServiceOutputTypes =
|
|
|
124
129
|
| DeleteKeyspaceCommandOutput
|
|
125
130
|
| DeleteTableCommandOutput
|
|
126
131
|
| GetKeyspaceCommandOutput
|
|
132
|
+
| GetTableAutoScalingSettingsCommandOutput
|
|
127
133
|
| GetTableCommandOutput
|
|
128
134
|
| ListKeyspacesCommandOutput
|
|
129
135
|
| ListTablesCommandOutput
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import {
|
|
4
|
+
KeyspacesClientResolvedConfig,
|
|
5
|
+
ServiceInputTypes,
|
|
6
|
+
ServiceOutputTypes,
|
|
7
|
+
} from "../KeyspacesClient";
|
|
8
|
+
import {
|
|
9
|
+
GetTableAutoScalingSettingsRequest,
|
|
10
|
+
GetTableAutoScalingSettingsResponse,
|
|
11
|
+
} from "../models/models_0";
|
|
12
|
+
export { __MetadataBearer, $Command };
|
|
13
|
+
export interface GetTableAutoScalingSettingsCommandInput
|
|
14
|
+
extends GetTableAutoScalingSettingsRequest {}
|
|
15
|
+
export interface GetTableAutoScalingSettingsCommandOutput
|
|
16
|
+
extends GetTableAutoScalingSettingsResponse,
|
|
17
|
+
__MetadataBearer {}
|
|
18
|
+
declare const GetTableAutoScalingSettingsCommand_base: {
|
|
19
|
+
new (
|
|
20
|
+
input: GetTableAutoScalingSettingsCommandInput
|
|
21
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
22
|
+
GetTableAutoScalingSettingsCommandInput,
|
|
23
|
+
GetTableAutoScalingSettingsCommandOutput,
|
|
24
|
+
KeyspacesClientResolvedConfig,
|
|
25
|
+
ServiceInputTypes,
|
|
26
|
+
ServiceOutputTypes
|
|
27
|
+
>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
export declare class GetTableAutoScalingSettingsCommand extends GetTableAutoScalingSettingsCommand_base {}
|
|
@@ -3,6 +3,7 @@ export * from "./CreateTableCommand";
|
|
|
3
3
|
export * from "./DeleteKeyspaceCommand";
|
|
4
4
|
export * from "./DeleteTableCommand";
|
|
5
5
|
export * from "./GetKeyspaceCommand";
|
|
6
|
+
export * from "./GetTableAutoScalingSettingsCommand";
|
|
6
7
|
export * from "./GetTableCommand";
|
|
7
8
|
export * from "./ListKeyspacesCommand";
|
|
8
9
|
export * from "./ListTablesCommand";
|
|
@@ -7,6 +7,25 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
7
7
|
opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
|
|
8
8
|
);
|
|
9
9
|
}
|
|
10
|
+
export interface TargetTrackingScalingPolicyConfiguration {
|
|
11
|
+
disableScaleIn?: boolean;
|
|
12
|
+
scaleInCooldown?: number;
|
|
13
|
+
scaleOutCooldown?: number;
|
|
14
|
+
targetValue: number | undefined;
|
|
15
|
+
}
|
|
16
|
+
export interface AutoScalingPolicy {
|
|
17
|
+
targetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration;
|
|
18
|
+
}
|
|
19
|
+
export interface AutoScalingSettings {
|
|
20
|
+
autoScalingDisabled?: boolean;
|
|
21
|
+
minimumUnits?: number;
|
|
22
|
+
maximumUnits?: number;
|
|
23
|
+
scalingPolicy?: AutoScalingPolicy;
|
|
24
|
+
}
|
|
25
|
+
export interface AutoScalingSpecification {
|
|
26
|
+
writeCapacityAutoScaling?: AutoScalingSettings;
|
|
27
|
+
readCapacityAutoScaling?: AutoScalingSettings;
|
|
28
|
+
}
|
|
10
29
|
export declare const ThroughputMode: {
|
|
11
30
|
readonly PAY_PER_REQUEST: "PAY_PER_REQUEST";
|
|
12
31
|
readonly PROVISIONED: "PROVISIONED";
|
|
@@ -114,6 +133,11 @@ export type PointInTimeRecoveryStatus =
|
|
|
114
133
|
export interface PointInTimeRecovery {
|
|
115
134
|
status: PointInTimeRecoveryStatus | undefined;
|
|
116
135
|
}
|
|
136
|
+
export interface ReplicaSpecification {
|
|
137
|
+
region: string | undefined;
|
|
138
|
+
readCapacityUnits?: number;
|
|
139
|
+
readCapacityAutoScaling?: AutoScalingSettings;
|
|
140
|
+
}
|
|
117
141
|
export interface PartitionKey {
|
|
118
142
|
name: string | undefined;
|
|
119
143
|
}
|
|
@@ -146,6 +170,8 @@ export interface CreateTableRequest {
|
|
|
146
170
|
defaultTimeToLive?: number;
|
|
147
171
|
tags?: Tag[];
|
|
148
172
|
clientSideTimestamps?: ClientSideTimestamps;
|
|
173
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
174
|
+
replicaSpecifications?: ReplicaSpecification[];
|
|
149
175
|
}
|
|
150
176
|
export interface CreateTableResponse {
|
|
151
177
|
resourceArn: string | undefined;
|
|
@@ -194,6 +220,11 @@ export declare const TableStatus: {
|
|
|
194
220
|
readonly UPDATING: "UPDATING";
|
|
195
221
|
};
|
|
196
222
|
export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
|
|
223
|
+
export interface ReplicaSpecificationSummary {
|
|
224
|
+
region?: string;
|
|
225
|
+
status?: TableStatus;
|
|
226
|
+
capacitySpecification?: CapacitySpecificationSummary;
|
|
227
|
+
}
|
|
197
228
|
export interface GetTableResponse {
|
|
198
229
|
keyspaceName: string | undefined;
|
|
199
230
|
tableName: string | undefined;
|
|
@@ -208,6 +239,22 @@ export interface GetTableResponse {
|
|
|
208
239
|
defaultTimeToLive?: number;
|
|
209
240
|
comment?: Comment;
|
|
210
241
|
clientSideTimestamps?: ClientSideTimestamps;
|
|
242
|
+
replicaSpecifications?: ReplicaSpecificationSummary[];
|
|
243
|
+
}
|
|
244
|
+
export interface GetTableAutoScalingSettingsRequest {
|
|
245
|
+
keyspaceName: string | undefined;
|
|
246
|
+
tableName: string | undefined;
|
|
247
|
+
}
|
|
248
|
+
export interface ReplicaAutoScalingSpecification {
|
|
249
|
+
region?: string;
|
|
250
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
251
|
+
}
|
|
252
|
+
export interface GetTableAutoScalingSettingsResponse {
|
|
253
|
+
keyspaceName: string | undefined;
|
|
254
|
+
tableName: string | undefined;
|
|
255
|
+
resourceArn: string | undefined;
|
|
256
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
257
|
+
replicaSpecifications?: ReplicaAutoScalingSpecification[];
|
|
211
258
|
}
|
|
212
259
|
export interface ListKeyspacesRequest {
|
|
213
260
|
nextToken?: string;
|
|
@@ -256,6 +303,8 @@ export interface RestoreTableRequest {
|
|
|
256
303
|
encryptionSpecificationOverride?: EncryptionSpecification;
|
|
257
304
|
pointInTimeRecoveryOverride?: PointInTimeRecovery;
|
|
258
305
|
tagsOverride?: Tag[];
|
|
306
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
307
|
+
replicaSpecifications?: ReplicaSpecification[];
|
|
259
308
|
}
|
|
260
309
|
export interface RestoreTableResponse {
|
|
261
310
|
restoredTableARN: string | undefined;
|
|
@@ -280,6 +329,8 @@ export interface UpdateTableRequest {
|
|
|
280
329
|
ttl?: TimeToLive;
|
|
281
330
|
defaultTimeToLive?: number;
|
|
282
331
|
clientSideTimestamps?: ClientSideTimestamps;
|
|
332
|
+
autoScalingSpecification?: AutoScalingSpecification;
|
|
333
|
+
replicaSpecifications?: ReplicaSpecification[];
|
|
283
334
|
}
|
|
284
335
|
export interface UpdateTableResponse {
|
|
285
336
|
resourceArn: string | undefined;
|