UNPKG

182 kBTypeScriptView Raw
1import DynamoDB = require('../../clients/dynamodb');
2import * as stream from 'stream';
3import {Request} from '../request';
4import {AWSError} from '../error';
5
6interface File {}
7interface Blob {}
8
9/**
10 * The document client simplifies working with items in Amazon DynamoDB
11 * by abstracting away the notion of attribute values. This abstraction
12 * annotates native JavaScript types supplied as input parameters, as well
13 * as converts annotated response data to native JavaScript types.
14 */
15export class DocumentClient {
16 /**
17 * Creates a DynamoDB document client with a set of configuration options.
18 */
19 constructor(options?: DocumentClient.DocumentClientOptions & DynamoDB.Types.ClientConfiguration)
20
21 /**
22 * Creates a set of elements inferring the type of set from the type of the first element. Amazon DynamoDB currently supports the number sets, string sets, and binary sets. For more information about DynamoDB data types see the documentation on the Amazon DynamoDB Data Model.
23 */
24 createSet(list: number[]|string[]|DocumentClient.binaryType[], options?: DocumentClient.CreateSetOptions): DocumentClient.DynamoDbSet;
25 /**
26 * Returns the attributes of one or more items from one or more tables by delegating to AWS.DynamoDB.batchGetItem().
27 */
28 batchGet(params: DocumentClient.BatchGetItemInput, callback?: (err: AWSError, data: DocumentClient.BatchGetItemOutput) => void): Request<DocumentClient.BatchGetItemOutput, AWSError>;
29 /**
30 * Puts or deletes multiple items in one or more tables by delegating to AWS.DynamoDB.batchWriteItem().
31 */
32 batchWrite(params: DocumentClient.BatchWriteItemInput, callback?: (err: AWSError, data: DocumentClient.BatchWriteItemOutput) => void): Request<DocumentClient.BatchWriteItemOutput, AWSError>;
33 /**
34 * Deletes a single item in a table by primary key by delegating to AWS.DynamoDB.deleteItem().
35 */
36 delete(params: DocumentClient.DeleteItemInput, callback?: (err: AWSError, data: DocumentClient.DeleteItemOutput) => void): Request<DocumentClient.DeleteItemOutput, AWSError>;
37 /**
38 * Returns a set of attributes for the item with the given primary key by delegating to AWS.DynamoDB.getItem().
39 */
40 get(params: DocumentClient.GetItemInput, callback?: (err: AWSError, data: DocumentClient.GetItemOutput) => void): Request<DocumentClient.GetItemOutput, AWSError>;
41 /**
42 * Creates a new item, or replaces an old item with a new item by delegating to AWS.DynamoDB.putItem().
43 */
44 put(params: DocumentClient.PutItemInput, callback?: (err: AWSError, data: DocumentClient.PutItemOutput) => void): Request<DocumentClient.PutItemOutput, AWSError>;
45 /**
46 * Directly access items from a table by primary key or a secondary index.
47 */
48 query(params: DocumentClient.QueryInput, callback?: (err: AWSError, data: DocumentClient.QueryOutput) => void): Request<DocumentClient.QueryOutput, AWSError>;
49 /**
50 * Returns one or more items and item attributes by accessing every item in a table or a secondary index.
51 */
52 scan(params: DocumentClient.ScanInput, callback?: (err: AWSError, data: DocumentClient.ScanOutput) => void): Request<DocumentClient.ScanOutput, AWSError>;
53 /**
54 * Edits an existing item's attributes, or adds a new item to the table if it does not already exist by delegating to AWS.DynamoDB.updateItem().
55 */
56 update(params: DocumentClient.UpdateItemInput, callback?: (err: AWSError, data: DocumentClient.UpdateItemOutput) => void): Request<DocumentClient.UpdateItemOutput, AWSError>;
57
58 /**
59 * Atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and region.
60 */
61 transactGet(params: DocumentClient.TransactGetItemsInput, callback?: (err: AWSError, data: DocumentClient.TransactGetItemsOutput) => void): Request<DocumentClient.TransactGetItemsOutput, AWSError>;
62
63 /**
64 * Synchronous write operation that groups up to 10 action requests
65 */
66 transactWrite(params: DocumentClient.TransactWriteItemsInput, callback?: (err: AWSError, data: DocumentClient.TransactWriteItemsOutput) => void): Request<DocumentClient.TransactWriteItemsOutput, AWSError>;
67}
68
69export namespace DocumentClient {
70 interface ConverterOptions {
71 /**
72 * An optional flag indicating that the document client should cast
73 * empty strings, buffers, and sets to NULL shapes
74 */
75 convertEmptyValues?: boolean;
76
77 /**
78 * Whether to return numbers as a NumberValue object instead of
79 * converting them to native JavaScript numbers. This allows for the
80 * safe round-trip transport of numbers of arbitrary size.
81 */
82 wrapNumbers?: boolean;
83 }
84
85 export interface DocumentClientOptions extends ConverterOptions {
86 /**
87 * An optional map of parameters to bind to every request sent by this service object.
88 */
89 params?: {[key: string]: any}
90 /**
91 * An optional pre-configured instance of the AWS.DynamoDB service object to use for requests. The object may bound parameters used by the document client.
92 */
93 service?: DynamoDB
94 }
95
96 export interface CreateSetOptions {
97 /**
98 * Set to true if you want to validate the type of each element in the set. Defaults to false.
99 */
100 validate?: boolean
101 }
102
103 export type binaryType = Buffer|File|Blob|ArrayBuffer|DataView|Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array|stream.Stream;
104
105 interface StringSet {
106 type: 'String';
107 values: Array<string>;
108 }
109
110 interface NumberSet {
111 type: 'Number';
112 values: Array<number>;
113 }
114
115 interface BinarySet {
116 type: 'Binary';
117 values: Array<binaryType>;
118 }
119
120 export type DynamoDbSet = StringSet|NumberSet|BinarySet;
121}
122
123export namespace DocumentClient {
124 //<!--auto-generated start-->
125 interface Blob {}
126 export type AttributeAction = "ADD"|"PUT"|"DELETE"|string;
127 export interface AttributeDefinition {
128 /**
129 * A name for the attribute.
130 */
131 AttributeName: KeySchemaAttributeName;
132 /**
133 * The data type for the attribute, where: S - the attribute is of type String N - the attribute is of type Number B - the attribute is of type Binary
134 */
135 AttributeType: ScalarAttributeType;
136 }
137 export type AttributeDefinitions = AttributeDefinition[];
138 export type AttributeMap = {[key: string]: AttributeValue};
139 export type AttributeName = string;
140 export type AttributeNameList = AttributeName[];
141 export type AttributeUpdates = {[key: string]: AttributeValueUpdate};
142 /**
143 * A JavaScript object or native type.
144 */
145 export type AttributeValue = any;
146 export type AttributeValueList = AttributeValue[];
147 export interface AttributeValueUpdate {
148 /**
149 * Represents the data for an attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide.
150 */
151 Value?: AttributeValue;
152 /**
153 * Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table. If an item with the specified Key is found in the table: PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error. ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute: If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute. If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3. If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types. If no item with the specified Key is found: PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute. DELETE - Nothing happens; there is no attribute to delete. ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
154 */
155 Action?: AttributeAction;
156 }
157 export interface AutoScalingPolicyDescription {
158 /**
159 * The name of the scaling policy.
160 */
161 PolicyName?: AutoScalingPolicyName;
162 /**
163 * Represents a target tracking scaling policy configuration.
164 */
165 TargetTrackingScalingPolicyConfiguration?: AutoScalingTargetTrackingScalingPolicyConfigurationDescription;
166 }
167 export type AutoScalingPolicyDescriptionList = AutoScalingPolicyDescription[];
168 export type AutoScalingPolicyName = string;
169 export interface AutoScalingPolicyUpdate {
170 /**
171 * The name of the scaling policy.
172 */
173 PolicyName?: AutoScalingPolicyName;
174 /**
175 * Represents a target tracking scaling policy configuration.
176 */
177 TargetTrackingScalingPolicyConfiguration: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate;
178 }
179 export type AutoScalingRoleArn = string;
180 export interface AutoScalingSettingsDescription {
181 /**
182 * The minimum capacity units that a global table or global secondary index should be scaled down to.
183 */
184 MinimumUnits?: PositiveLongObject;
185 /**
186 * The maximum capacity units that a global table or global secondary index should be scaled up to.
187 */
188 MaximumUnits?: PositiveLongObject;
189 /**
190 * Disabled autoscaling for this global table or global secondary index.
191 */
192 AutoScalingDisabled?: BooleanObject;
193 /**
194 * Role ARN used for configuring autoScaling policy.
195 */
196 AutoScalingRoleArn?: String;
197 /**
198 * Information about the scaling policies.
199 */
200 ScalingPolicies?: AutoScalingPolicyDescriptionList;
201 }
202 export interface AutoScalingSettingsUpdate {
203 /**
204 * The minimum capacity units that a global table or global secondary index should be scaled down to.
205 */
206 MinimumUnits?: PositiveLongObject;
207 /**
208 * The maximum capacity units that a global table or global secondary index should be scaled up to.
209 */
210 MaximumUnits?: PositiveLongObject;
211 /**
212 * Disabled autoscaling for this global table or global secondary index.
213 */
214 AutoScalingDisabled?: BooleanObject;
215 /**
216 * Role ARN used for configuring autoscaling policy.
217 */
218 AutoScalingRoleArn?: AutoScalingRoleArn;
219 /**
220 * The scaling policy to apply for scaling target global table or global secondary index capacity units.
221 */
222 ScalingPolicyUpdate?: AutoScalingPolicyUpdate;
223 }
224 export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription {
225 /**
226 * Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
227 */
228 DisableScaleIn?: BooleanObject;
229 /**
230 * The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.
231 */
232 ScaleInCooldown?: IntegerObject;
233 /**
234 * The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
235 */
236 ScaleOutCooldown?: IntegerObject;
237 /**
238 * The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
239 */
240 TargetValue: Double;
241 }
242 export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate {
243 /**
244 * Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
245 */
246 DisableScaleIn?: BooleanObject;
247 /**
248 * The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.
249 */
250 ScaleInCooldown?: IntegerObject;
251 /**
252 * The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
253 */
254 ScaleOutCooldown?: IntegerObject;
255 /**
256 * The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
257 */
258 TargetValue: Double;
259 }
260 export type Backfilling = boolean;
261 export type BackupArn = string;
262 export type BackupCreationDateTime = Date;
263 export interface BackupDescription {
264 /**
265 * Contains the details of the backup created for the table.
266 */
267 BackupDetails?: BackupDetails;
268 /**
269 * Contains the details of the table when the backup was created.
270 */
271 SourceTableDetails?: SourceTableDetails;
272 /**
273 * Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
274 */
275 SourceTableFeatureDetails?: SourceTableFeatureDetails;
276 }
277 export interface BackupDetails {
278 /**
279 * ARN associated with the backup.
280 */
281 BackupArn: BackupArn;
282 /**
283 * Name of the requested backup.
284 */
285 BackupName: BackupName;
286 /**
287 * Size of the backup in bytes.
288 */
289 BackupSizeBytes?: BackupSizeBytes;
290 /**
291 * Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
292 */
293 BackupStatus: BackupStatus;
294 /**
295 * BackupType: USER - You create and manage these using the on-demand backup feature. SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. AWS_BACKUP - On-demand backup created by you from AWS Backup service.
296 */
297 BackupType: BackupType;
298 /**
299 * Time at which the backup was created. This is the request time of the backup.
300 */
301 BackupCreationDateTime: BackupCreationDateTime;
302 /**
303 * Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.
304 */
305 BackupExpiryDateTime?: _Date;
306 }
307 export type BackupName = string;
308 export type BackupSizeBytes = number;
309 export type BackupStatus = "CREATING"|"DELETED"|"AVAILABLE"|string;
310 export type BackupSummaries = BackupSummary[];
311 export interface BackupSummary {
312 /**
313 * Name of the table.
314 */
315 TableName?: TableName;
316 /**
317 * Unique identifier for the table.
318 */
319 TableId?: TableId;
320 /**
321 * ARN associated with the table.
322 */
323 TableArn?: TableArn;
324 /**
325 * ARN associated with the backup.
326 */
327 BackupArn?: BackupArn;
328 /**
329 * Name of the specified backup.
330 */
331 BackupName?: BackupName;
332 /**
333 * Time at which the backup was created.
334 */
335 BackupCreationDateTime?: BackupCreationDateTime;
336 /**
337 * Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.
338 */
339 BackupExpiryDateTime?: _Date;
340 /**
341 * Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
342 */
343 BackupStatus?: BackupStatus;
344 /**
345 * BackupType: USER - You create and manage these using the on-demand backup feature. SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. AWS_BACKUP - On-demand backup created by you from AWS Backup service.
346 */
347 BackupType?: BackupType;
348 /**
349 * Size of the backup in bytes.
350 */
351 BackupSizeBytes?: BackupSizeBytes;
352 }
353 export type BackupType = "USER"|"SYSTEM"|"AWS_BACKUP"|string;
354 export type BackupTypeFilter = "USER"|"SYSTEM"|"AWS_BACKUP"|"ALL"|string;
355 export type BackupsInputLimit = number;
356 export interface BatchGetItemInput {
357 /**
358 * A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request. Each element in the map of items to retrieve consists of the following: ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used. ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value. ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
359 */
360 RequestItems: BatchGetRequestMap;
361 ReturnConsumedCapacity?: ReturnConsumedCapacity;
362 }
363 export interface BatchGetItemOutput {
364 /**
365 * A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.
366 */
367 Responses?: BatchGetResponseMap;
368 /**
369 * A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section. Each element consists of: Keys - An array of primary key attribute values that define specific items in the table. ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result. ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used. If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
370 */
371 UnprocessedKeys?: BatchGetRequestMap;
372 /**
373 * The read capacity units consumed by the entire BatchGetItem operation. Each element consists of: TableName - The table that consumed the provisioned throughput. CapacityUnits - The total number of capacity units consumed.
374 */
375 ConsumedCapacity?: ConsumedCapacityMultiple;
376 }
377 export type BatchGetRequestMap = {[key: string]: KeysAndAttributes};
378 export type BatchGetResponseMap = {[key: string]: ItemList};
379 export interface BatchWriteItemInput {
380 /**
381 * A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following: DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement: Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement: Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
382 */
383 RequestItems: BatchWriteItemRequestMap;
384 ReturnConsumedCapacity?: ReturnConsumedCapacity;
385 /**
386 * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
387 */
388 ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics;
389 }
390 export interface BatchWriteItemOutput {
391 /**
392 * A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section. Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest). DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement: Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement: Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
393 */
394 UnprocessedItems?: BatchWriteItemRequestMap;
395 /**
396 * A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations. Each entry consists of the following subelements: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item. SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
397 */
398 ItemCollectionMetrics?: ItemCollectionMetricsPerTable;
399 /**
400 * The capacity units consumed by the entire BatchWriteItem operation. Each element consists of: TableName - The table that consumed the provisioned throughput. CapacityUnits - The total number of capacity units consumed.
401 */
402 ConsumedCapacity?: ConsumedCapacityMultiple;
403 }
404 export type BatchWriteItemRequestMap = {[key: string]: WriteRequests};
405 export type BillingMode = "PROVISIONED"|"PAY_PER_REQUEST"|string;
406 export interface BillingModeSummary {
407 /**
408 * Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
409 */
410 BillingMode?: BillingMode;
411 /**
412 * Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
413 */
414 LastUpdateToPayPerRequestDateTime?: _Date;
415 }
416 export type BinaryAttributeValue = Buffer|Uint8Array|Blob|string;
417 export type BinarySetAttributeValue = BinaryAttributeValue[];
418 export type BooleanAttributeValue = boolean;
419 export type BooleanObject = boolean;
420 export interface Capacity {
421 /**
422 * The total number of read capacity units consumed on a table or an index.
423 */
424 ReadCapacityUnits?: ConsumedCapacityUnits;
425 /**
426 * The total number of write capacity units consumed on a table or an index.
427 */
428 WriteCapacityUnits?: ConsumedCapacityUnits;
429 /**
430 * The total number of capacity units consumed on a table or an index.
431 */
432 CapacityUnits?: ConsumedCapacityUnits;
433 }
434 export type ClientRequestToken = string;
435 export type ComparisonOperator = "EQ"|"NE"|"IN"|"LE"|"LT"|"GE"|"GT"|"BETWEEN"|"NOT_NULL"|"NULL"|"CONTAINS"|"NOT_CONTAINS"|"BEGINS_WITH"|string;
436 export interface Condition {
437 /**
438 * One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
439 */
440 AttributeValueList?: AttributeValueList;
441 /**
442 * A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. EQ : Equal. EQ is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. NE : Not equal. NE is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps. This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator. NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps. This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator. CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). IN : Checks for matching elements in a list. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]} For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
443 */
444 ComparisonOperator: ComparisonOperator;
445 }
446 export interface ConditionCheck {
447 /**
448 * The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
449 */
450 Key: Key;
451 /**
452 * Name of the table for the check item request.
453 */
454 TableName: TableName;
455 /**
456 * A condition that must be satisfied in order for a conditional update to succeed.
457 */
458 ConditionExpression: ConditionExpression;
459 /**
460 * One or more substitution tokens for attribute names in an expression.
461 */
462 ExpressionAttributeNames?: ExpressionAttributeNameMap;
463 /**
464 * One or more values that can be substituted in an expression.
465 */
466 ExpressionAttributeValues?: ExpressionAttributeValueMap;
467 /**
468 * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
469 */
470 ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure;
471 }
472 export type ConditionExpression = string;
473 export type ConditionalOperator = "AND"|"OR"|string;
474 export type ConsistentRead = boolean;
475 export interface ConsumedCapacity {
476 /**
477 * The name of the table that was affected by the operation.
478 */
479 TableName?: TableName;
480 /**
481 * The total number of capacity units consumed by the operation.
482 */
483 CapacityUnits?: ConsumedCapacityUnits;
484 /**
485 * The total number of read capacity units consumed by the operation.
486 */
487 ReadCapacityUnits?: ConsumedCapacityUnits;
488 /**
489 * The total number of write capacity units consumed by the operation.
490 */
491 WriteCapacityUnits?: ConsumedCapacityUnits;
492 /**
493 * The amount of throughput consumed on the table affected by the operation.
494 */
495 Table?: Capacity;
496 /**
497 * The amount of throughput consumed on each local index affected by the operation.
498 */
499 LocalSecondaryIndexes?: SecondaryIndexesCapacityMap;
500 /**
501 * The amount of throughput consumed on each global index affected by the operation.
502 */
503 GlobalSecondaryIndexes?: SecondaryIndexesCapacityMap;
504 }
505 export type ConsumedCapacityMultiple = ConsumedCapacity[];
506 export type ConsumedCapacityUnits = number;
507 export interface ContinuousBackupsDescription {
508 /**
509 * ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
510 */
511 ContinuousBackupsStatus: ContinuousBackupsStatus;
512 /**
513 * The description of the point in time recovery settings applied to the table.
514 */
515 PointInTimeRecoveryDescription?: PointInTimeRecoveryDescription;
516 }
517 export type ContinuousBackupsStatus = "ENABLED"|"DISABLED"|string;
518 export interface CreateBackupInput {
519 /**
520 * The name of the table.
521 */
522 TableName: TableName;
523 /**
524 * Specified name for the backup.
525 */
526 BackupName: BackupName;
527 }
528 export interface CreateBackupOutput {
529 /**
530 * Contains the details of the backup created for the table.
531 */
532 BackupDetails?: BackupDetails;
533 }
534 export interface CreateGlobalSecondaryIndexAction {
535 /**
536 * The name of the global secondary index to be created.
537 */
538 IndexName: IndexName;
539 /**
540 * The key schema for the global secondary index.
541 */
542 KeySchema: KeySchema;
543 /**
544 * Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
545 */
546 Projection: Projection;
547 /**
548 * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
549 */
550 ProvisionedThroughput?: ProvisionedThroughput;
551 }
552 export interface CreateGlobalTableInput {
553 /**
554 * The global table name.
555 */
556 GlobalTableName: TableName;
557 /**
558 * The regions where the global table needs to be created.
559 */
560 ReplicationGroup: ReplicaList;
561 }
562 export interface CreateGlobalTableOutput {
563 /**
564 * Contains the details of the global table.
565 */
566 GlobalTableDescription?: GlobalTableDescription;
567 }
568 export interface CreateReplicaAction {
569 /**
570 * The region of the replica to be added.
571 */
572 RegionName: RegionName;
573 }
574 export interface CreateTableInput {
575 /**
576 * An array of attributes that describe the key schema for the table and indexes.
577 */
578 AttributeDefinitions: AttributeDefinitions;
579 /**
580 * The name of the table to create.
581 */
582 TableName: TableName;
583 /**
584 * Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide. Each KeySchemaElement in the array is composed of: AttributeName - The name of this key attribute. KeyType - The role that the key attribute will assume: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE. For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
585 */
586 KeySchema: KeySchema;
587 /**
588 * One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following: IndexName - The name of the local secondary index. Must be unique only for this table. KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
589 */
590 LocalSecondaryIndexes?: LocalSecondaryIndexList;
591 /**
592 * One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following: IndexName - The name of the global secondary index. Must be unique only for this table. KeySchema - Specifies the key schema for the global secondary index. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
593 */
594 GlobalSecondaryIndexes?: GlobalSecondaryIndexList;
595 /**
596 * Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
597 */
598 BillingMode?: BillingMode;
599 /**
600 * Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
601 */
602 ProvisionedThroughput?: ProvisionedThroughput;
603 /**
604 * The settings for DynamoDB Streams on the table. These settings consist of: StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false). StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified item are written to the stream. NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
605 */
606 StreamSpecification?: StreamSpecification;
607 /**
608 * Represents the settings used to enable server-side encryption.
609 */
610 SSESpecification?: SSESpecification;
611 }
612 export interface CreateTableOutput {
613 /**
614 * Represents the properties of the table.
615 */
616 TableDescription?: TableDescription;
617 }
618 export type _Date = Date;
619 export interface Delete {
620 /**
621 * The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.
622 */
623 Key: Key;
624 /**
625 * Name of the table in which the item to be deleted resides.
626 */
627 TableName: TableName;
628 /**
629 * A condition that must be satisfied in order for a conditional delete to succeed.
630 */
631 ConditionExpression?: ConditionExpression;
632 /**
633 * One or more substitution tokens for attribute names in an expression.
634 */
635 ExpressionAttributeNames?: ExpressionAttributeNameMap;
636 /**
637 * One or more values that can be substituted in an expression.
638 */
639 ExpressionAttributeValues?: ExpressionAttributeValueMap;
640 /**
641 * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
642 */
643 ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure;
644 }
645 export interface DeleteBackupInput {
646 /**
647 * The ARN associated with the backup.
648 */
649 BackupArn: BackupArn;
650 }
651 export interface DeleteBackupOutput {
652 /**
653 * Contains the description of the backup created for the table.
654 */
655 BackupDescription?: BackupDescription;
656 }
657 export interface DeleteGlobalSecondaryIndexAction {
658 /**
659 * The name of the global secondary index to be deleted.
660 */
661 IndexName: IndexName;
662 }
663 export interface DeleteItemInput {
664 /**
665 * The name of the table from which to delete the item.
666 */
667 TableName: TableName;
668 /**
669 * A map of attribute names to AttributeValue objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
670 */
671 Key: Key;
672 /**
673 * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
674 */
675 Expected?: ExpectedAttributeMap;
676 /**
677 * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
678 */
679 ConditionalOperator?: ConditionalOperator;
680 /**
681 * Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.) ALL_OLD - The content of the old item is returned. The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.
682 */
683 ReturnValues?: ReturnValue;
684 ReturnConsumedCapacity?: ReturnConsumedCapacity;
685 /**
686 * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
687 */
688 ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics;
689 /**
690 * A condition that must be satisfied in order for a conditional DeleteItem to succeed. An expression can contain any of the following: Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size These function names are case-sensitive. Comparison operators: = | &lt;&gt; | &lt; | &gt; | &lt;= | &gt;= | BETWEEN | IN Logical operators: AND | OR | NOT For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
691 */
692 ConditionExpression?: ConditionExpression;
693 /**
694 * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
695 */
696 ExpressionAttributeNames?: ExpressionAttributeNameMap;
697 /**
698 * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
699 */
700 ExpressionAttributeValues?: ExpressionAttributeValueMap;
701 }
702 export interface DeleteItemOutput {
703 /**
704 * A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.
705 */
706 Attributes?: AttributeMap;
707 /**
708 * The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
709 */
710 ConsumedCapacity?: ConsumedCapacity;
711 /**
712 * Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
713 */
714 ItemCollectionMetrics?: ItemCollectionMetrics;
715 }
716 export interface DeleteReplicaAction {
717 /**
718 * The region of the replica to be removed.
719 */
720 RegionName: RegionName;
721 }
722 export interface DeleteRequest {
723 /**
724 * A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.
725 */
726 Key: Key;
727 }
728 export interface DeleteTableInput {
729 /**
730 * The name of the table to delete.
731 */
732 TableName: TableName;
733 }
734 export interface DeleteTableOutput {
735 /**
736 * Represents the properties of a table.
737 */
738 TableDescription?: TableDescription;
739 }
740 export interface DescribeBackupInput {
741 /**
742 * The ARN associated with the backup.
743 */
744 BackupArn: BackupArn;
745 }
746 export interface DescribeBackupOutput {
747 /**
748 * Contains the description of the backup created for the table.
749 */
750 BackupDescription?: BackupDescription;
751 }
752 export interface DescribeContinuousBackupsInput {
753 /**
754 * Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.
755 */
756 TableName: TableName;
757 }
758 export interface DescribeContinuousBackupsOutput {
759 /**
760 * Represents the continuous backups and point in time recovery settings on the table.
761 */
762 ContinuousBackupsDescription?: ContinuousBackupsDescription;
763 }
764 export interface DescribeEndpointsRequest {
765 }
766 export interface DescribeEndpointsResponse {
767 /**
768 * List of endpoints.
769 */
770 Endpoints: Endpoints;
771 }
772 export interface DescribeGlobalTableInput {
773 /**
774 * The name of the global table.
775 */
776 GlobalTableName: TableName;
777 }
778 export interface DescribeGlobalTableOutput {
779 /**
780 * Contains the details of the global table.
781 */
782 GlobalTableDescription?: GlobalTableDescription;
783 }
784 export interface DescribeGlobalTableSettingsInput {
785 /**
786 * The name of the global table to describe.
787 */
788 GlobalTableName: TableName;
789 }
790 export interface DescribeGlobalTableSettingsOutput {
791 /**
792 * The name of the global table.
793 */
794 GlobalTableName?: TableName;
795 /**
796 * The region specific settings for the global table.
797 */
798 ReplicaSettings?: ReplicaSettingsDescriptionList;
799 }
800 export interface DescribeLimitsInput {
801 }
802 export interface DescribeLimitsOutput {
803 /**
804 * The maximum total read capacity units that your account allows you to provision across all of your tables in this region.
805 */
806 AccountMaxReadCapacityUnits?: PositiveLongObject;
807 /**
808 * The maximum total write capacity units that your account allows you to provision across all of your tables in this region.
809 */
810 AccountMaxWriteCapacityUnits?: PositiveLongObject;
811 /**
812 * The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs).
813 */
814 TableMaxReadCapacityUnits?: PositiveLongObject;
815 /**
816 * The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs).
817 */
818 TableMaxWriteCapacityUnits?: PositiveLongObject;
819 }
820 export interface DescribeTableInput {
821 /**
822 * The name of the table to describe.
823 */
824 TableName: TableName;
825 }
826 export interface DescribeTableOutput {
827 /**
828 * The properties of the table.
829 */
830 Table?: TableDescription;
831 }
832 export interface DescribeTimeToLiveInput {
833 /**
834 * The name of the table to be described.
835 */
836 TableName: TableName;
837 }
838 export interface DescribeTimeToLiveOutput {
839 /**
840 *
841 */
842 TimeToLiveDescription?: TimeToLiveDescription;
843 }
844 export type Double = number;
845 export interface Endpoint {
846 /**
847 * IP address of the endpoint.
848 */
849 Address: String;
850 /**
851 * Endpoint cache time to live (TTL) value.
852 */
853 CachePeriodInMinutes: Long;
854 }
855 export type Endpoints = Endpoint[];
856 export type ExpectedAttributeMap = {[key: string]: ExpectedAttributeValue};
857 export interface ExpectedAttributeValue {
858 /**
859 * Represents the data for the expected attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide.
860 */
861 Value?: AttributeValue;
862 /**
863 * Causes DynamoDB to evaluate the value before attempting a conditional operation: If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException. If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException. The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied. DynamoDB returns a ValidationException if: Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.) Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
864 */
865 Exists?: BooleanObject;
866 /**
867 * A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. EQ : Equal. EQ is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. NE : Not equal. NE is supported for all data types, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}. LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}. NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps. This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator. NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps. This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator. CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list. BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). IN : Checks for matching elements in a list. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true. BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}
868 */
869 ComparisonOperator?: ComparisonOperator;
870 /**
871 * One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
872 */
873 AttributeValueList?: AttributeValueList;
874 }
875 export type ExpressionAttributeNameMap = {[key: string]: AttributeName};
876 export type ExpressionAttributeNameVariable = string;
877 export type ExpressionAttributeValueMap = {[key: string]: AttributeValue};
878 export type ExpressionAttributeValueVariable = string;
879 export type FilterConditionMap = {[key: string]: Condition};
880 export interface Get {
881 /**
882 * A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.
883 */
884 Key: Key;
885 /**
886 * The name of the table from which to retrieve the specified item.
887 */
888 TableName: TableName;
889 /**
890 * A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.
891 */
892 ProjectionExpression?: ProjectionExpression;
893 /**
894 * One or more substitution tokens for attribute names in the ProjectionExpression parameter.
895 */
896 ExpressionAttributeNames?: ExpressionAttributeNameMap;
897 }
898 export interface GetItemInput {
899 /**
900 * The name of the table containing the requested item.
901 */
902 TableName: TableName;
903 /**
904 * A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
905 */
906 Key: Key;
907 /**
908 * This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
909 */
910 AttributesToGet?: AttributeNameList;
911 /**
912 * Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
913 */
914 ConsistentRead?: ConsistentRead;
915 ReturnConsumedCapacity?: ReturnConsumedCapacity;
916 /**
917 * A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
918 */
919 ProjectionExpression?: ProjectionExpression;
920 /**
921 * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
922 */
923 ExpressionAttributeNames?: ExpressionAttributeNameMap;
924 }
925 export interface GetItemOutput {
926 /**
927 * A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.
928 */
929 Item?: AttributeMap;
930 /**
931 * The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
932 */
933 ConsumedCapacity?: ConsumedCapacity;
934 }
935 export interface GlobalSecondaryIndex {
936 /**
937 * The name of the global secondary index. The name must be unique among all other indexes on this table.
938 */
939 IndexName: IndexName;
940 /**
941 * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
942 */
943 KeySchema: KeySchema;
944 /**
945 * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
946 */
947 Projection: Projection;
948 /**
949 * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
950 */
951 ProvisionedThroughput?: ProvisionedThroughput;
952 }
953 export interface GlobalSecondaryIndexDescription {
954 /**
955 * The name of the global secondary index.
956 */
957 IndexName?: IndexName;
958 /**
959 * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
960 */
961 KeySchema?: KeySchema;
962 /**
963 * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
964 */
965 Projection?: Projection;
966 /**
967 * The current state of the global secondary index: CREATING - The index is being created. UPDATING - The index is being updated. DELETING - The index is being deleted. ACTIVE - The index is ready for use.
968 */
969 IndexStatus?: IndexStatus;
970 /**
971 * Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false. For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
972 */
973 Backfilling?: Backfilling;
974 /**
975 * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
976 */
977 ProvisionedThroughput?: ProvisionedThroughputDescription;
978 /**
979 * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
980 */
981 IndexSizeBytes?: Long;
982 /**
983 * The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
984 */
985 ItemCount?: Long;
986 /**
987 * The Amazon Resource Name (ARN) that uniquely identifies the index.
988 */
989 IndexArn?: String;
990 }
991 export type GlobalSecondaryIndexDescriptionList = GlobalSecondaryIndexDescription[];
992 export interface GlobalSecondaryIndexInfo {
993 /**
994 * The name of the global secondary index.
995 */
996 IndexName?: IndexName;
997 /**
998 * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
999 */
1000 KeySchema?: KeySchema;
1001 /**
1002 * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
1003 */
1004 Projection?: Projection;
1005 /**
1006 * Represents the provisioned throughput settings for the specified global secondary index.
1007 */
1008 ProvisionedThroughput?: ProvisionedThroughput;
1009 }
1010 export type GlobalSecondaryIndexList = GlobalSecondaryIndex[];
1011 export interface GlobalSecondaryIndexUpdate {
1012 /**
1013 * The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
1014 */
1015 Update?: UpdateGlobalSecondaryIndexAction;
1016 /**
1017 * The parameters required for creating a global secondary index on an existing table: IndexName KeySchema AttributeDefinitions Projection ProvisionedThroughput
1018 */
1019 Create?: CreateGlobalSecondaryIndexAction;
1020 /**
1021 * The name of an existing global secondary index to be removed.
1022 */
1023 Delete?: DeleteGlobalSecondaryIndexAction;
1024 }
1025 export type GlobalSecondaryIndexUpdateList = GlobalSecondaryIndexUpdate[];
1026 export type GlobalSecondaryIndexes = GlobalSecondaryIndexInfo[];
1027 export interface GlobalTable {
1028 /**
1029 * The global table name.
1030 */
1031 GlobalTableName?: TableName;
1032 /**
1033 * The regions where the global table has replicas.
1034 */
1035 ReplicationGroup?: ReplicaList;
1036 }
1037 export type GlobalTableArnString = string;
1038 export interface GlobalTableDescription {
1039 /**
1040 * The regions where the global table has replicas.
1041 */
1042 ReplicationGroup?: ReplicaDescriptionList;
1043 /**
1044 * The unique identifier of the global table.
1045 */
1046 GlobalTableArn?: GlobalTableArnString;
1047 /**
1048 * The creation time of the global table.
1049 */
1050 CreationDateTime?: _Date;
1051 /**
1052 * The current state of the global table: CREATING - The global table is being created. UPDATING - The global table is being updated. DELETING - The global table is being deleted. ACTIVE - The global table is ready for use.
1053 */
1054 GlobalTableStatus?: GlobalTableStatus;
1055 /**
1056 * The global table name.
1057 */
1058 GlobalTableName?: TableName;
1059 }
1060 export interface GlobalTableGlobalSecondaryIndexSettingsUpdate {
1061 /**
1062 * The name of the global secondary index. The name must be unique among all other indexes on this table.
1063 */
1064 IndexName: IndexName;
1065 /**
1066 * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
1067 */
1068 ProvisionedWriteCapacityUnits?: PositiveLongObject;
1069 /**
1070 * AutoScaling settings for managing a global secondary index's write capacity units.
1071 */
1072 ProvisionedWriteCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate;
1073 }
1074 export type GlobalTableGlobalSecondaryIndexSettingsUpdateList = GlobalTableGlobalSecondaryIndexSettingsUpdate[];
1075 export type GlobalTableList = GlobalTable[];
1076 export type GlobalTableStatus = "CREATING"|"ACTIVE"|"DELETING"|"UPDATING"|string;
1077 export type IndexName = string;
1078 export type IndexStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|string;
1079 export type Integer = number;
1080 export type IntegerObject = number;
1081 export type ItemCollectionKeyAttributeMap = {[key: string]: AttributeValue};
1082 export interface ItemCollectionMetrics {
1083 /**
1084 * The partition key value of the item collection. This value is the same as the partition key value of the item.
1085 */
1086 ItemCollectionKey?: ItemCollectionKeyAttributeMap;
1087 /**
1088 * An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
1089 */
1090 SizeEstimateRangeGB?: ItemCollectionSizeEstimateRange;
1091 }
1092 export type ItemCollectionMetricsMultiple = ItemCollectionMetrics[];
1093 export type ItemCollectionMetricsPerTable = {[key: string]: ItemCollectionMetricsMultiple};
1094 export type ItemCollectionSizeEstimateBound = number;
1095 export type ItemCollectionSizeEstimateRange = ItemCollectionSizeEstimateBound[];
1096 export type ItemCount = number;
1097 export type ItemList = AttributeMap[];
1098 export interface ItemResponse {
1099 /**
1100 * Map of attribute data consisting of the data type and attribute value.
1101 */
1102 Item?: AttributeMap;
1103 }
1104 export type ItemResponseList = ItemResponse[];
1105 export type KMSMasterKeyArn = string;
1106 export type KMSMasterKeyId = string;
1107 export type Key = {[key: string]: AttributeValue};
1108 export type KeyConditions = {[key: string]: Condition};
1109 export type KeyExpression = string;
1110 export type KeyList = Key[];
1111 export type KeySchema = KeySchemaElement[];
1112 export type KeySchemaAttributeName = string;
1113 export interface KeySchemaElement {
1114 /**
1115 * The name of a key attribute.
1116 */
1117 AttributeName: KeySchemaAttributeName;
1118 /**
1119 * The role that this key attribute will assume: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
1120 */
1121 KeyType: KeyType;
1122 }
1123 export type KeyType = "HASH"|"RANGE"|string;
1124 export interface KeysAndAttributes {
1125 /**
1126 * The primary key attribute values that define the items and the attributes associated with the items.
1127 */
1128 Keys: KeyList;
1129 /**
1130 * This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
1131 */
1132 AttributesToGet?: AttributeNameList;
1133 /**
1134 * The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
1135 */
1136 ConsistentRead?: ConsistentRead;
1137 /**
1138 * A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
1139 */
1140 ProjectionExpression?: ProjectionExpression;
1141 /**
1142 * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
1143 */
1144 ExpressionAttributeNames?: ExpressionAttributeNameMap;
1145 }
1146 export type ListAttributeValue = AttributeValue[];
1147 export interface ListBackupsInput {
1148 /**
1149 * The backups from the table specified by TableName are listed.
1150 */
1151 TableName?: TableName;
1152 /**
1153 * Maximum number of backups to return at once.
1154 */
1155 Limit?: BackupsInputLimit;
1156 /**
1157 * Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
1158 */
1159 TimeRangeLowerBound?: TimeRangeLowerBound;
1160 /**
1161 * Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
1162 */
1163 TimeRangeUpperBound?: TimeRangeUpperBound;
1164 /**
1165 * LastEvaluatedBackupArn is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.
1166 */
1167 ExclusiveStartBackupArn?: BackupArn;
1168 /**
1169 * The backups from the table specified by BackupType are listed. Where BackupType can be: USER - On-demand backup created by you. SYSTEM - On-demand backup automatically created by DynamoDB. ALL - All types of on-demand backups (USER and SYSTEM).
1170 */
1171 BackupType?: BackupTypeFilter;
1172 }
1173 export interface ListBackupsOutput {
1174 /**
1175 * List of BackupSummary objects.
1176 */
1177 BackupSummaries?: BackupSummaries;
1178 /**
1179 * The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results. If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved. If LastEvaluatedBackupArn is not empty, this may or may not indicate there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.
1180 */
1181 LastEvaluatedBackupArn?: BackupArn;
1182 }
1183 export interface ListGlobalTablesInput {
1184 /**
1185 * The first global table name that this operation will evaluate.
1186 */
1187 ExclusiveStartGlobalTableName?: TableName;
1188 /**
1189 * The maximum number of table names to return.
1190 */
1191 Limit?: PositiveIntegerObject;
1192 /**
1193 * Lists the global tables in a specific region.
1194 */
1195 RegionName?: RegionName;
1196 }
1197 export interface ListGlobalTablesOutput {
1198 /**
1199 * List of global table names.
1200 */
1201 GlobalTables?: GlobalTableList;
1202 /**
1203 * Last evaluated global table name.
1204 */
1205 LastEvaluatedGlobalTableName?: TableName;
1206 }
1207 export interface ListTablesInput {
1208 /**
1209 * The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.
1210 */
1211 ExclusiveStartTableName?: TableName;
1212 /**
1213 * A maximum number of table names to return. If this parameter is not specified, the limit is 100.
1214 */
1215 Limit?: ListTablesInputLimit;
1216 }
1217 export type ListTablesInputLimit = number;
1218 export interface ListTablesOutput {
1219 /**
1220 * The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
1221 */
1222 TableNames?: TableNameList;
1223 /**
1224 * The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned. If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
1225 */
1226 LastEvaluatedTableName?: TableName;
1227 }
1228 export interface ListTagsOfResourceInput {
1229 /**
1230 * The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
1231 */
1232 ResourceArn: ResourceArnString;
1233 /**
1234 * An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.
1235 */
1236 NextToken?: NextTokenString;
1237 }
1238 export interface ListTagsOfResourceOutput {
1239 /**
1240 * The tags currently associated with the Amazon DynamoDB resource.
1241 */
1242 Tags?: TagList;
1243 /**
1244 * If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.
1245 */
1246 NextToken?: NextTokenString;
1247 }
1248 export interface LocalSecondaryIndex {
1249 /**
1250 * The name of the local secondary index. The name must be unique among all other indexes on this table.
1251 */
1252 IndexName: IndexName;
1253 /**
1254 * The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
1255 */
1256 KeySchema: KeySchema;
1257 /**
1258 * Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
1259 */
1260 Projection: Projection;
1261 }
1262 export interface LocalSecondaryIndexDescription {
1263 /**
1264 * Represents the name of the local secondary index.
1265 */
1266 IndexName?: IndexName;
1267 /**
1268 * The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
1269 */
1270 KeySchema?: KeySchema;
1271 /**
1272 * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
1273 */
1274 Projection?: Projection;
1275 /**
1276 * The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
1277 */
1278 IndexSizeBytes?: Long;
1279 /**
1280 * The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
1281 */
1282 ItemCount?: Long;
1283 /**
1284 * The Amazon Resource Name (ARN) that uniquely identifies the index.
1285 */
1286 IndexArn?: String;
1287 }
1288 export type LocalSecondaryIndexDescriptionList = LocalSecondaryIndexDescription[];
1289 export interface LocalSecondaryIndexInfo {
1290 /**
1291 * Represents the name of the local secondary index.
1292 */
1293 IndexName?: IndexName;
1294 /**
1295 * The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
1296 */
1297 KeySchema?: KeySchema;
1298 /**
1299 * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
1300 */
1301 Projection?: Projection;
1302 }
1303 export type LocalSecondaryIndexList = LocalSecondaryIndex[];
1304 export type LocalSecondaryIndexes = LocalSecondaryIndexInfo[];
1305 export type Long = number;
1306 export type MapAttributeValue = {[key: string]: AttributeValue};
1307 export type NextTokenString = string;
1308 export type NonKeyAttributeName = string;
1309 export type NonKeyAttributeNameList = NonKeyAttributeName[];
1310 export type NonNegativeLongObject = number;
1311 export type NullAttributeValue = boolean;
1312 export type NumberAttributeValue = string;
1313 export type NumberSetAttributeValue = NumberAttributeValue[];
1314 export interface PointInTimeRecoveryDescription {
1315 /**
1316 * The current state of point in time recovery: ENABLING - Point in time recovery is being enabled. ENABLED - Point in time recovery is enabled. DISABLED - Point in time recovery is disabled.
1317 */
1318 PointInTimeRecoveryStatus?: PointInTimeRecoveryStatus;
1319 /**
1320 * Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days.
1321 */
1322 EarliestRestorableDateTime?: _Date;
1323 /**
1324 * LatestRestorableDateTime is typically 5 minutes before the current time.
1325 */
1326 LatestRestorableDateTime?: _Date;
1327 }
1328 export interface PointInTimeRecoverySpecification {
1329 /**
1330 * Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
1331 */
1332 PointInTimeRecoveryEnabled: BooleanObject;
1333 }
1334 export type PointInTimeRecoveryStatus = "ENABLED"|"DISABLED"|string;
1335 export type PositiveIntegerObject = number;
1336 export type PositiveLongObject = number;
1337 export interface Projection {
1338 /**
1339 * The set of attributes that are projected into the index: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index.
1340 */
1341 ProjectionType?: ProjectionType;
1342 /**
1343 * Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
1344 */
1345 NonKeyAttributes?: NonKeyAttributeNameList;
1346 }
1347 export type ProjectionExpression = string;
1348 export type ProjectionType = "ALL"|"KEYS_ONLY"|"INCLUDE"|string;
1349 export interface ProvisionedThroughput {
1350 /**
1351 * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
1352 */
1353 ReadCapacityUnits: PositiveLongObject;
1354 /**
1355 * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide. If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
1356 */
1357 WriteCapacityUnits: PositiveLongObject;
1358 }
1359 export interface ProvisionedThroughputDescription {
1360 /**
1361 * The date and time of the last provisioned throughput increase for this table.
1362 */
1363 LastIncreaseDateTime?: _Date;
1364 /**
1365 * The date and time of the last provisioned throughput decrease for this table.
1366 */
1367 LastDecreaseDateTime?: _Date;
1368 /**
1369 * The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.
1370 */
1371 NumberOfDecreasesToday?: PositiveLongObject;
1372 /**
1373 * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
1374 */
1375 ReadCapacityUnits?: NonNegativeLongObject;
1376 /**
1377 * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
1378 */
1379 WriteCapacityUnits?: NonNegativeLongObject;
1380 }
1381 export interface Put {
1382 /**
1383 * A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.
1384 */
1385 Item: PutItemInputAttributeMap;
1386 /**
1387 * Name of the table in which to write the item.
1388 */
1389 TableName: TableName;
1390 /**
1391 * A condition that must be satisfied in order for a conditional update to succeed.
1392 */
1393 ConditionExpression?: ConditionExpression;
1394 /**
1395 * One or more substitution tokens for attribute names in an expression.
1396 */
1397 ExpressionAttributeNames?: ExpressionAttributeNameMap;
1398 /**
1399 * One or more values that can be substituted in an expression.
1400 */
1401 ExpressionAttributeValues?: ExpressionAttributeValueMap;
1402 /**
1403 * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
1404 */
1405 ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure;
1406 }
1407 export interface PutItemInput {
1408 /**
1409 * The name of the table to contain the item.
1410 */
1411 TableName: TableName;
1412 /**
1413 * A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. Each element in the Item map is an AttributeValue object.
1414 */
1415 Item: PutItemInputAttributeMap;
1416 /**
1417 * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
1418 */
1419 Expected?: ExpectedAttributeMap;
1420 /**
1421 * Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.) ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned. The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
1422 */
1423 ReturnValues?: ReturnValue;
1424 ReturnConsumedCapacity?: ReturnConsumedCapacity;
1425 /**
1426 * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
1427 */
1428 ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics;
1429 /**
1430 * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
1431 */
1432 ConditionalOperator?: ConditionalOperator;
1433 /**
1434 * A condition that must be satisfied in order for a conditional PutItem operation to succeed. An expression can contain any of the following: Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size These function names are case-sensitive. Comparison operators: = | &lt;&gt; | &lt; | &gt; | &lt;= | &gt;= | BETWEEN | IN Logical operators: AND | OR | NOT For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
1435 */
1436 ConditionExpression?: ConditionExpression;
1437 /**
1438 * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
1439 */
1440 ExpressionAttributeNames?: ExpressionAttributeNameMap;
1441 /**
1442 * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
1443 */
1444 ExpressionAttributeValues?: ExpressionAttributeValueMap;
1445 }
1446 export type PutItemInputAttributeMap = {[key: string]: AttributeValue};
1447 export interface PutItemOutput {
1448 /**
1449 * The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.
1450 */
1451 Attributes?: AttributeMap;
1452 /**
1453 * The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
1454 */
1455 ConsumedCapacity?: ConsumedCapacity;
1456 /**
1457 * Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
1458 */
1459 ItemCollectionMetrics?: ItemCollectionMetrics;
1460 }
1461 export interface PutRequest {
1462 /**
1463 * A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.
1464 */
1465 Item: PutItemInputAttributeMap;
1466 }
1467 export interface QueryInput {
1468 /**
1469 * The name of the table containing the requested items.
1470 */
1471 TableName: TableName;
1472 /**
1473 * The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.
1474 */
1475 IndexName?: IndexName;
1476 /**
1477 * The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES. COUNT - Returns the number of matching items, rather than the matching items themselves. SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select. If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.) If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
1478 */
1479 Select?: Select;
1480 /**
1481 * This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
1482 */
1483 AttributesToGet?: AttributeNameList;
1484 /**
1485 * The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
1486 */
1487 Limit?: PositiveIntegerObject;
1488 /**
1489 * Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
1490 */
1491 ConsistentRead?: ConsistentRead;
1492 /**
1493 * This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
1494 */
1495 KeyConditions?: KeyConditions;
1496 /**
1497 * This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
1498 */
1499 QueryFilter?: FilterConditionMap;
1500 /**
1501 * This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
1502 */
1503 ConditionalOperator?: ConditionalOperator;
1504 /**
1505 * Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order. Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned. If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
1506 */
1507 ScanIndexForward?: BooleanObject;
1508 /**
1509 * The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
1510 */
1511 ExclusiveStartKey?: Key;
1512 ReturnConsumedCapacity?: ReturnConsumedCapacity;
1513 /**
1514 * A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
1515 */
1516 ProjectionExpression?: ProjectionExpression;
1517 /**
1518 * A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned. A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key. A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
1519 */
1520 FilterExpression?: ConditionExpression;
1521 /**
1522 * The condition that specifies the key value(s) for items to be retrieved by the Query action. The condition must perform an equality test on a single partition key value. The condition can optionally perform one of several comparison tests on a single sort key value. This allows Query to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values. The partition key equality test is required, and must be specified in the following format: partitionKeyName = :partitionkeyval If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key: partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval Valid comparisons for the sort key condition are as follows: sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval. sortKeyName &lt; :sortkeyval - true if the sort key value is less than :sortkeyval. sortKeyName &lt;= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval. sortKeyName &gt; :sortkeyval - true if the sort key value is greater than :sortkeyval. sortKeyName &gt;= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval. sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2. begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive. Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime. You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word: Size = :myval To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows: #S = :myval For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide. For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
1523 */
1524 KeyConditionExpression?: KeyExpression;
1525 /**
1526 * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
1527 */
1528 ExpressionAttributeNames?: ExpressionAttributeNameMap;
1529 /**
1530 * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
1531 */
1532 ExpressionAttributeValues?: ExpressionAttributeValueMap;
1533 }
1534 export interface QueryOutput {
1535 /**
1536 * An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
1537 */
1538 Items?: ItemList;
1539 /**
1540 * The number of items in the response. If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied. If you did not use a filter in the request, then Count and ScannedCount are the same.
1541 */
1542 Count?: Integer;
1543 /**
1544 * The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide. If you did not use a filter in the request, then ScannedCount is the same as Count.
1545 */
1546 ScannedCount?: Integer;
1547 /**
1548 * The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
1549 */
1550 LastEvaluatedKey?: Key;
1551 /**
1552 * The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
1553 */
1554 ConsumedCapacity?: ConsumedCapacity;
1555 }
1556 export type RegionName = string;
1557 export interface Replica {
1558 /**
1559 * The region where the replica needs to be created.
1560 */
1561 RegionName?: RegionName;
1562 }
1563 export interface ReplicaDescription {
1564 /**
1565 * The name of the region.
1566 */
1567 RegionName?: RegionName;
1568 }
1569 export type ReplicaDescriptionList = ReplicaDescription[];
1570 export interface ReplicaGlobalSecondaryIndexSettingsDescription {
1571 /**
1572 * The name of the global secondary index. The name must be unique among all other indexes on this table.
1573 */
1574 IndexName: IndexName;
1575 /**
1576 * The current status of the global secondary index: CREATING - The global secondary index is being created. UPDATING - The global secondary index is being updated. DELETING - The global secondary index is being deleted. ACTIVE - The global secondary index is ready for use.
1577 */
1578 IndexStatus?: IndexStatus;
1579 /**
1580 * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
1581 */
1582 ProvisionedReadCapacityUnits?: PositiveLongObject;
1583 /**
1584 * Autoscaling settings for a global secondary index replica's read capacity units.
1585 */
1586 ProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
1587 /**
1588 * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
1589 */
1590 ProvisionedWriteCapacityUnits?: PositiveLongObject;
1591 /**
1592 * AutoScaling settings for a global secondary index replica's write capacity units.
1593 */
1594 ProvisionedWriteCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
1595 }
1596 export type ReplicaGlobalSecondaryIndexSettingsDescriptionList = ReplicaGlobalSecondaryIndexSettingsDescription[];
1597 export interface ReplicaGlobalSecondaryIndexSettingsUpdate {
1598 /**
1599 * The name of the global secondary index. The name must be unique among all other indexes on this table.
1600 */
1601 IndexName: IndexName;
1602 /**
1603 * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
1604 */
1605 ProvisionedReadCapacityUnits?: PositiveLongObject;
1606 /**
1607 * Autoscaling settings for managing a global secondary index replica's read capacity units.
1608 */
1609 ProvisionedReadCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate;
1610 }
1611 export type ReplicaGlobalSecondaryIndexSettingsUpdateList = ReplicaGlobalSecondaryIndexSettingsUpdate[];
1612 export type ReplicaList = Replica[];
1613 export interface ReplicaSettingsDescription {
1614 /**
1615 * The region name of the replica.
1616 */
1617 RegionName: RegionName;
1618 /**
1619 * The current state of the region: CREATING - The region is being created. UPDATING - The region is being updated. DELETING - The region is being deleted. ACTIVE - The region is ready for use.
1620 */
1621 ReplicaStatus?: ReplicaStatus;
1622 /**
1623 * The read/write capacity mode of the replica.
1624 */
1625 ReplicaBillingModeSummary?: BillingModeSummary;
1626 /**
1627 * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
1628 */
1629 ReplicaProvisionedReadCapacityUnits?: NonNegativeLongObject;
1630 /**
1631 * Autoscaling settings for a global table replica's read capacity units.
1632 */
1633 ReplicaProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
1634 /**
1635 * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
1636 */
1637 ReplicaProvisionedWriteCapacityUnits?: NonNegativeLongObject;
1638 /**
1639 * AutoScaling settings for a global table replica's write capacity units.
1640 */
1641 ReplicaProvisionedWriteCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
1642 /**
1643 * Replica global secondary index settings for the global table.
1644 */
1645 ReplicaGlobalSecondaryIndexSettings?: ReplicaGlobalSecondaryIndexSettingsDescriptionList;
1646 }
1647 export type ReplicaSettingsDescriptionList = ReplicaSettingsDescription[];
1648 export interface ReplicaSettingsUpdate {
1649 /**
1650 * The region of the replica to be added.
1651 */
1652 RegionName: RegionName;
1653 /**
1654 * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
1655 */
1656 ReplicaProvisionedReadCapacityUnits?: PositiveLongObject;
1657 /**
1658 * Autoscaling settings for managing a global table replica's read capacity units.
1659 */
1660 ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate;
1661 /**
1662 * Represents the settings of a global secondary index for a global table that will be modified.
1663 */
1664 ReplicaGlobalSecondaryIndexSettingsUpdate?: ReplicaGlobalSecondaryIndexSettingsUpdateList;
1665 }
1666 export type ReplicaSettingsUpdateList = ReplicaSettingsUpdate[];
1667 export type ReplicaStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|string;
1668 export interface ReplicaUpdate {
1669 /**
1670 * The parameters required for creating a replica on an existing global table.
1671 */
1672 Create?: CreateReplicaAction;
1673 /**
1674 * The name of the existing replica to be removed.
1675 */
1676 Delete?: DeleteReplicaAction;
1677 }
1678 export type ReplicaUpdateList = ReplicaUpdate[];
1679 export type ResourceArnString = string;
1680 export type RestoreInProgress = boolean;
1681 export interface RestoreSummary {
1682 /**
1683 * ARN of the backup from which the table was restored.
1684 */
1685 SourceBackupArn?: BackupArn;
1686 /**
1687 * ARN of the source table of the backup that is being restored.
1688 */
1689 SourceTableArn?: TableArn;
1690 /**
1691 * Point in time or source backup time.
1692 */
1693 RestoreDateTime: _Date;
1694 /**
1695 * Indicates if a restore is in progress or not.
1696 */
1697 RestoreInProgress: RestoreInProgress;
1698 }
1699 export interface RestoreTableFromBackupInput {
1700 /**
1701 * The name of the new table to which the backup must be restored.
1702 */
1703 TargetTableName: TableName;
1704 /**
1705 * The ARN associated with the backup.
1706 */
1707 BackupArn: BackupArn;
1708 }
1709 export interface RestoreTableFromBackupOutput {
1710 /**
1711 * The description of the table created from an existing backup.
1712 */
1713 TableDescription?: TableDescription;
1714 }
1715 export interface RestoreTableToPointInTimeInput {
1716 /**
1717 * Name of the source table that is being restored.
1718 */
1719 SourceTableName: TableName;
1720 /**
1721 * The name of the new table to which it must be restored to.
1722 */
1723 TargetTableName: TableName;
1724 /**
1725 * Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.
1726 */
1727 UseLatestRestorableTime?: BooleanObject;
1728 /**
1729 * Time in the past to restore the table to.
1730 */
1731 RestoreDateTime?: _Date;
1732 }
1733 export interface RestoreTableToPointInTimeOutput {
1734 /**
1735 * Represents the properties of a table.
1736 */
1737 TableDescription?: TableDescription;
1738 }
1739 export type ReturnConsumedCapacity = "INDEXES"|"TOTAL"|"NONE"|string;
1740 export type ReturnItemCollectionMetrics = "SIZE"|"NONE"|string;
1741 export type ReturnValue = "NONE"|"ALL_OLD"|"UPDATED_OLD"|"ALL_NEW"|"UPDATED_NEW"|string;
1742 export type ReturnValuesOnConditionCheckFailure = "ALL_OLD"|"NONE"|string;
1743 export interface SSEDescription {
1744 /**
1745 * The current state of server-side encryption: ENABLING - Server-side encryption is being enabled. ENABLED - Server-side encryption is enabled. DISABLING - Server-side encryption is being disabled. DISABLED - Server-side encryption is disabled. UPDATING - Server-side encryption is being updated.
1746 */
1747 Status?: SSEStatus;
1748 /**
1749 * Server-side encryption type: AES256 - Server-side encryption which uses the AES256 algorithm (not applicable). KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
1750 */
1751 SSEType?: SSEType;
1752 /**
1753 * The KMS master key ARN used for the KMS encryption.
1754 */
1755 KMSMasterKeyArn?: KMSMasterKeyArn;
1756 }
1757 export type SSEEnabled = boolean;
1758 export interface SSESpecification {
1759 /**
1760 * Indicates whether server-side encryption is enabled (true) or disabled (false) on the table. If enabled (true), server-side encryption type is set to KMS. If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
1761 */
1762 Enabled?: SSEEnabled;
1763 /**
1764 * Server-side encryption type: AES256 - Server-side encryption which uses the AES256 algorithm (not applicable). KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).
1765 */
1766 SSEType?: SSEType;
1767 /**
1768 * The KMS Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS Master Key alias/aws/dynamodb.
1769 */
1770 KMSMasterKeyId?: KMSMasterKeyId;
1771 }
1772 export type SSEStatus = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED"|"UPDATING"|string;
1773 export type SSEType = "AES256"|"KMS"|string;
1774 export type ScalarAttributeType = "S"|"N"|"B"|string;
1775 export interface ScanInput {
1776 /**
1777 * The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.
1778 */
1779 TableName: TableName;
1780 /**
1781 * The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.
1782 */
1783 IndexName?: IndexName;
1784 /**
1785 * This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
1786 */
1787 AttributesToGet?: AttributeNameList;
1788 /**
1789 * The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
1790 */
1791 Limit?: PositiveIntegerObject;
1792 /**
1793 * The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index. ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required. ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES. COUNT - Returns the number of matching items, rather than the matching items themselves. SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select. If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency. If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table. If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.) If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
1794 */
1795 Select?: Select;
1796 /**
1797 * This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
1798 */
1799 ScanFilter?: FilterConditionMap;
1800 /**
1801 * This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
1802 */
1803 ConditionalOperator?: ConditionalOperator;
1804 /**
1805 * The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed. In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
1806 */
1807 ExclusiveStartKey?: Key;
1808 ReturnConsumedCapacity?: ReturnConsumedCapacity;
1809 /**
1810 * For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel. If you specify TotalSegments, you must also specify Segment.
1811 */
1812 TotalSegments?: ScanTotalSegments;
1813 /**
1814 * For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on. The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation. The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments. If you provide Segment, you must also provide TotalSegments.
1815 */
1816 Segment?: ScanSegment;
1817 /**
1818 * A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
1819 */
1820 ProjectionExpression?: ProjectionExpression;
1821 /**
1822 * A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned. A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
1823 */
1824 FilterExpression?: ConditionExpression;
1825 /**
1826 * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
1827 */
1828 ExpressionAttributeNames?: ExpressionAttributeNameMap;
1829 /**
1830 * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
1831 */
1832 ExpressionAttributeValues?: ExpressionAttributeValueMap;
1833 /**
1834 * A Boolean value that determines the read consistency model during the scan: If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response. The default setting for ConsistentRead is false. The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
1835 */
1836 ConsistentRead?: ConsistentRead;
1837 }
1838 export interface ScanOutput {
1839 /**
1840 * An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
1841 */
1842 Items?: ItemList;
1843 /**
1844 * The number of items in the response. If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied. If you did not use a filter in the request, then Count is the same as ScannedCount.
1845 */
1846 Count?: Integer;
1847 /**
1848 * The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide. If you did not use a filter in the request, then ScannedCount is the same as Count.
1849 */
1850 ScannedCount?: Integer;
1851 /**
1852 * The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
1853 */
1854 LastEvaluatedKey?: Key;
1855 /**
1856 * The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
1857 */
1858 ConsumedCapacity?: ConsumedCapacity;
1859 }
1860 export type ScanSegment = number;
1861 export type ScanTotalSegments = number;
1862 export type SecondaryIndexesCapacityMap = {[key: string]: Capacity};
1863 export type Select = "ALL_ATTRIBUTES"|"ALL_PROJECTED_ATTRIBUTES"|"SPECIFIC_ATTRIBUTES"|"COUNT"|string;
1864 export interface SourceTableDetails {
1865 /**
1866 * The name of the table for which the backup was created.
1867 */
1868 TableName: TableName;
1869 /**
1870 * Unique identifier for the table for which the backup was created.
1871 */
1872 TableId: TableId;
1873 /**
1874 * ARN of the table for which backup was created.
1875 */
1876 TableArn?: TableArn;
1877 /**
1878 * Size of the table in bytes. Please note this is an approximate value.
1879 */
1880 TableSizeBytes?: Long;
1881 /**
1882 * Schema of the table.
1883 */
1884 KeySchema: KeySchema;
1885 /**
1886 * Time when the source table was created.
1887 */
1888 TableCreationDateTime: TableCreationDateTime;
1889 /**
1890 * Read IOPs and Write IOPS on the table when the backup was created.
1891 */
1892 ProvisionedThroughput: ProvisionedThroughput;
1893 /**
1894 * Number of items in the table. Please note this is an approximate value.
1895 */
1896 ItemCount?: ItemCount;
1897 /**
1898 * Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
1899 */
1900 BillingMode?: BillingMode;
1901 }
1902 export interface SourceTableFeatureDetails {
1903 /**
1904 * Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.
1905 */
1906 LocalSecondaryIndexes?: LocalSecondaryIndexes;
1907 /**
1908 * Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup.
1909 */
1910 GlobalSecondaryIndexes?: GlobalSecondaryIndexes;
1911 /**
1912 * Stream settings on the table when the backup was created.
1913 */
1914 StreamDescription?: StreamSpecification;
1915 /**
1916 * Time to Live settings on the table when the backup was created.
1917 */
1918 TimeToLiveDescription?: TimeToLiveDescription;
1919 /**
1920 * The description of the server-side encryption status on the table when the backup was created.
1921 */
1922 SSEDescription?: SSEDescription;
1923 }
1924 export type StreamArn = string;
1925 export type StreamEnabled = boolean;
1926 export interface StreamSpecification {
1927 /**
1928 * Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
1929 */
1930 StreamEnabled?: StreamEnabled;
1931 /**
1932 * When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified item are written to the stream. NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
1933 */
1934 StreamViewType?: StreamViewType;
1935 }
1936 export type StreamViewType = "NEW_IMAGE"|"OLD_IMAGE"|"NEW_AND_OLD_IMAGES"|"KEYS_ONLY"|string;
1937 export type String = string;
1938 export type StringAttributeValue = string;
1939 export type StringSetAttributeValue = StringAttributeValue[];
1940 export type TableArn = string;
1941 export type TableCreationDateTime = Date;
1942 export interface TableDescription {
1943 /**
1944 * An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of: AttributeName - The name of the attribute. AttributeType - The data type for the attribute.
1945 */
1946 AttributeDefinitions?: AttributeDefinitions;
1947 /**
1948 * The name of the table.
1949 */
1950 TableName?: TableName;
1951 /**
1952 * The primary key structure for the table. Each KeySchemaElement consists of: AttributeName - The name of the attribute. KeyType - The role of the attribute: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
1953 */
1954 KeySchema?: KeySchema;
1955 /**
1956 * The current state of the table: CREATING - The table is being created. UPDATING - The table is being updated. DELETING - The table is being deleted. ACTIVE - The table is ready for use.
1957 */
1958 TableStatus?: TableStatus;
1959 /**
1960 * The date and time when the table was created, in UNIX epoch time format.
1961 */
1962 CreationDateTime?: _Date;
1963 /**
1964 * The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
1965 */
1966 ProvisionedThroughput?: ProvisionedThroughputDescription;
1967 /**
1968 * The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
1969 */
1970 TableSizeBytes?: Long;
1971 /**
1972 * The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
1973 */
1974 ItemCount?: Long;
1975 /**
1976 * The Amazon Resource Name (ARN) that uniquely identifies the table.
1977 */
1978 TableArn?: String;
1979 /**
1980 * Unique identifier for the table for which the backup was created.
1981 */
1982 TableId?: TableId;
1983 /**
1984 * Contains the details for the read/write capacity mode.
1985 */
1986 BillingModeSummary?: BillingModeSummary;
1987 /**
1988 * Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: IndexName - The name of the local secondary index. KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the DELETING state, no information about indexes will be returned.
1989 */
1990 LocalSecondaryIndexes?: LocalSecondaryIndexDescriptionList;
1991 /**
1992 * The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.) IndexName - The name of the global secondary index. IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. IndexStatus - The current status of the global secondary index: CREATING - The index is being created. UPDATING - The index is being updated. DELETING - The index is being deleted. ACTIVE - The index is ready for use. ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the DELETING state, no information about indexes will be returned.
1993 */
1994 GlobalSecondaryIndexes?: GlobalSecondaryIndexDescriptionList;
1995 /**
1996 * The current DynamoDB Streams configuration for the table.
1997 */
1998 StreamSpecification?: StreamSpecification;
1999 /**
2000 * A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: the AWS customer ID. the table name. the StreamLabel.
2001 */
2002 LatestStreamLabel?: String;
2003 /**
2004 * The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
2005 */
2006 LatestStreamArn?: StreamArn;
2007 /**
2008 * Contains details for the restore.
2009 */
2010 RestoreSummary?: RestoreSummary;
2011 /**
2012 * The description of the server-side encryption status on the specified table.
2013 */
2014 SSEDescription?: SSEDescription;
2015 }
2016 export type TableId = string;
2017 export type TableName = string;
2018 export type TableNameList = TableName[];
2019 export type TableStatus = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|string;
2020 export interface Tag {
2021 /**
2022 * The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
2023 */
2024 Key: TagKeyString;
2025 /**
2026 * The value of the tag. Tag values are case-sensitive and can be null.
2027 */
2028 Value: TagValueString;
2029 }
2030 export type TagKeyList = TagKeyString[];
2031 export type TagKeyString = string;
2032 export type TagList = Tag[];
2033 export interface TagResourceInput {
2034 /**
2035 * Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).
2036 */
2037 ResourceArn: ResourceArnString;
2038 /**
2039 * The tags to be assigned to the Amazon DynamoDB resource.
2040 */
2041 Tags: TagList;
2042 }
2043 export type TagValueString = string;
2044 export type TimeRangeLowerBound = Date;
2045 export type TimeRangeUpperBound = Date;
2046 export type TimeToLiveAttributeName = string;
2047 export interface TimeToLiveDescription {
2048 /**
2049 * The Time to Live status for the table.
2050 */
2051 TimeToLiveStatus?: TimeToLiveStatus;
2052 /**
2053 * The name of the Time to Live attribute for items in the table.
2054 */
2055 AttributeName?: TimeToLiveAttributeName;
2056 }
2057 export type TimeToLiveEnabled = boolean;
2058 export interface TimeToLiveSpecification {
2059 /**
2060 * Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table.
2061 */
2062 Enabled: TimeToLiveEnabled;
2063 /**
2064 * The name of the Time to Live attribute used to store the expiration time for items in the table.
2065 */
2066 AttributeName: TimeToLiveAttributeName;
2067 }
2068 export type TimeToLiveStatus = "ENABLING"|"DISABLING"|"ENABLED"|"DISABLED"|string;
2069 export interface TransactGetItem {
2070 /**
2071 * Contains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve.
2072 */
2073 Get: Get;
2074 }
2075 export type TransactGetItemList = TransactGetItem[];
2076 export interface TransactGetItemsInput {
2077 /**
2078 * An ordered array of up to 10 TransactGetItem objects, each of which contains a Get structure.
2079 */
2080 TransactItems: TransactGetItemList;
2081 /**
2082 * A value of TOTAL causes consumed capacity information to be returned, and a value of NONE prevents that information from being returned. No other value is valid.
2083 */
2084 ReturnConsumedCapacity?: ReturnConsumedCapacity;
2085 }
2086 export interface TransactGetItemsOutput {
2087 /**
2088 * If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table.
2089 */
2090 ConsumedCapacity?: ConsumedCapacityMultiple;
2091 /**
2092 * An ordered array of up to 10 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item. If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
2093 */
2094 Responses?: ItemResponseList;
2095 }
2096 export interface TransactWriteItem {
2097 /**
2098 * A request to perform a check item operation.
2099 */
2100 ConditionCheck?: ConditionCheck;
2101 /**
2102 * A request to perform a PutItem operation.
2103 */
2104 Put?: Put;
2105 /**
2106 * A request to perform a DeleteItem operation.
2107 */
2108 Delete?: Delete;
2109 /**
2110 * A request to perform an UpdateItem operation.
2111 */
2112 Update?: Update;
2113 }
2114 export type TransactWriteItemList = TransactWriteItem[];
2115 export interface TransactWriteItemsInput {
2116 /**
2117 * An ordered array of up to 10 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and region, and no two of them can operate on the same item.
2118 */
2119 TransactItems: TransactWriteItemList;
2120 ReturnConsumedCapacity?: ReturnConsumedCapacity;
2121 /**
2122 * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to NONE (the default), no statistics are returned.
2123 */
2124 ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics;
2125 /**
2126 * Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call. Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls may not be the same. If the ReturnConsumedCapacity&gt; parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes, and subsequent TransactWriteItems calls with the same client token return the amount of read capacity units consumed in reading the item. A client request token is valid for 10 minutes after the first request that uses it completes. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes or the result may not be idempotent. If you submit a request with the same client token but a change in other parameters within the 10 minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.
2127 */
2128 ClientRequestToken?: ClientRequestToken;
2129 }
2130 export interface TransactWriteItemsOutput {
2131 /**
2132 * The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter.
2133 */
2134 ConsumedCapacity?: ConsumedCapacityMultiple;
2135 /**
2136 * A list of tables that were processed by TransactWriteItems and, for each table, information about any item collections that were affected by individual UpdateItem, PutItem or DeleteItem operations.
2137 */
2138 ItemCollectionMetrics?: ItemCollectionMetricsPerTable;
2139 }
2140 export interface UntagResourceInput {
2141 /**
2142 * The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN).
2143 */
2144 ResourceArn: ResourceArnString;
2145 /**
2146 * A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource.
2147 */
2148 TagKeys: TagKeyList;
2149 }
2150 export interface Update {
2151 /**
2152 * The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
2153 */
2154 Key: Key;
2155 /**
2156 * An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
2157 */
2158 UpdateExpression: UpdateExpression;
2159 /**
2160 * Name of the table for the UpdateItem request.
2161 */
2162 TableName: TableName;
2163 /**
2164 * A condition that must be satisfied in order for a conditional update to succeed.
2165 */
2166 ConditionExpression?: ConditionExpression;
2167 /**
2168 * One or more substitution tokens for attribute names in an expression.
2169 */
2170 ExpressionAttributeNames?: ExpressionAttributeNameMap;
2171 /**
2172 * One or more values that can be substituted in an expression.
2173 */
2174 ExpressionAttributeValues?: ExpressionAttributeValueMap;
2175 /**
2176 * Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
2177 */
2178 ReturnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure;
2179 }
2180 export interface UpdateContinuousBackupsInput {
2181 /**
2182 * The name of the table.
2183 */
2184 TableName: TableName;
2185 /**
2186 * Represents the settings used to enable point in time recovery.
2187 */
2188 PointInTimeRecoverySpecification: PointInTimeRecoverySpecification;
2189 }
2190 export interface UpdateContinuousBackupsOutput {
2191 /**
2192 * Represents the continuous backups and point in time recovery settings on the table.
2193 */
2194 ContinuousBackupsDescription?: ContinuousBackupsDescription;
2195 }
2196 export type UpdateExpression = string;
2197 export interface UpdateGlobalSecondaryIndexAction {
2198 /**
2199 * The name of the global secondary index to be updated.
2200 */
2201 IndexName: IndexName;
2202 /**
2203 * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
2204 */
2205 ProvisionedThroughput: ProvisionedThroughput;
2206 }
2207 export interface UpdateGlobalTableInput {
2208 /**
2209 * The global table name.
2210 */
2211 GlobalTableName: TableName;
2212 /**
2213 * A list of regions that should be added or removed from the global table.
2214 */
2215 ReplicaUpdates: ReplicaUpdateList;
2216 }
2217 export interface UpdateGlobalTableOutput {
2218 /**
2219 * Contains the details of the global table.
2220 */
2221 GlobalTableDescription?: GlobalTableDescription;
2222 }
2223 export interface UpdateGlobalTableSettingsInput {
2224 /**
2225 * The name of the global table
2226 */
2227 GlobalTableName: TableName;
2228 /**
2229 * The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.
2230 */
2231 GlobalTableBillingMode?: BillingMode;
2232 /**
2233 * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
2234 */
2235 GlobalTableProvisionedWriteCapacityUnits?: PositiveLongObject;
2236 /**
2237 * AutoScaling settings for managing provisioned write capacity for the global table.
2238 */
2239 GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate;
2240 /**
2241 * Represents the settings of a global secondary index for a global table that will be modified.
2242 */
2243 GlobalTableGlobalSecondaryIndexSettingsUpdate?: GlobalTableGlobalSecondaryIndexSettingsUpdateList;
2244 /**
2245 * Represents the settings for a global table in a region that will be modified.
2246 */
2247 ReplicaSettingsUpdate?: ReplicaSettingsUpdateList;
2248 }
2249 export interface UpdateGlobalTableSettingsOutput {
2250 /**
2251 * The name of the global table.
2252 */
2253 GlobalTableName?: TableName;
2254 /**
2255 * The region specific settings for the global table.
2256 */
2257 ReplicaSettings?: ReplicaSettingsDescriptionList;
2258 }
2259 export interface UpdateItemInput {
2260 /**
2261 * The name of the table containing the item to update.
2262 */
2263 TableName: TableName;
2264 /**
2265 * The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
2266 */
2267 Key: Key;
2268 /**
2269 * This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
2270 */
2271 AttributeUpdates?: AttributeUpdates;
2272 /**
2273 * This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
2274 */
2275 Expected?: ExpectedAttributeMap;
2276 /**
2277 * This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
2278 */
2279 ConditionalOperator?: ConditionalOperator;
2280 /**
2281 * Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are: NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.) ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation. UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation. ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation. UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The values returned are strongly consistent.
2282 */
2283 ReturnValues?: ReturnValue;
2284 ReturnConsumedCapacity?: ReturnConsumedCapacity;
2285 /**
2286 * Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
2287 */
2288 ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics;
2289 /**
2290 * An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. The following action values are available for UpdateExpression. SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val SET supports the following functions: if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item. list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. These function names are case-sensitive. REMOVE - Removes one or more attributes from an item. ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute: If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute. If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3. If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes. DELETE - Deletes an element from a set. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error. The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes. You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5 For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
2291 */
2292 UpdateExpression?: UpdateExpression;
2293 /**
2294 * A condition that must be satisfied in order for a conditional update to succeed. An expression can contain any of the following: Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size These function names are case-sensitive. Comparison operators: = | &lt;&gt; | &lt; | &gt; | &lt;= | &gt;= | BETWEEN | IN Logical operators: AND | OR | NOT For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
2295 */
2296 ConditionExpression?: ConditionExpression;
2297 /**
2298 * One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames: To access an attribute whose name conflicts with a DynamoDB reserved word. To create a placeholder for repeating occurrences of an attribute name in an expression. To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames: {"#P":"Percentile"} You could then use this substitution in an expression, as in this example: #P = :val Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
2299 */
2300 ExpressionAttributeNames?: ExpressionAttributeNameMap;
2301 /**
2302 * One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: Available | Backordered | Discontinued You would first need to specify ExpressionAttributeValues as follows: { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} } You could then use these values in an expression, such as this: ProductStatus IN (:avail, :back, :disc) For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
2303 */
2304 ExpressionAttributeValues?: ExpressionAttributeValueMap;
2305 }
2306 export interface UpdateItemOutput {
2307 /**
2308 * A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter. The Attributes map is only present if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.
2309 */
2310 Attributes?: AttributeMap;
2311 /**
2312 * The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
2313 */
2314 ConsumedCapacity?: ConsumedCapacity;
2315 /**
2316 * Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response. Each ItemCollectionMetrics element consists of: ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself. SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
2317 */
2318 ItemCollectionMetrics?: ItemCollectionMetrics;
2319 }
2320 export interface UpdateTableInput {
2321 /**
2322 * An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
2323 */
2324 AttributeDefinitions?: AttributeDefinitions;
2325 /**
2326 * The name of the table to be updated.
2327 */
2328 TableName: TableName;
2329 /**
2330 * Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes. PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
2331 */
2332 BillingMode?: BillingMode;
2333 /**
2334 * The new provisioned throughput settings for the specified table or index.
2335 */
2336 ProvisionedThroughput?: ProvisionedThroughput;
2337 /**
2338 * An array of one or more global secondary indexes for the table. For each index in the array, you can request one action: Create - add a new global secondary index to the table. Update - modify the provisioned throughput settings of an existing global secondary index. Delete - remove a global secondary index from the table. For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
2339 */
2340 GlobalSecondaryIndexUpdates?: GlobalSecondaryIndexUpdateList;
2341 /**
2342 * Represents the DynamoDB Streams configuration for the table. You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.
2343 */
2344 StreamSpecification?: StreamSpecification;
2345 /**
2346 * The new server-side encryption settings for the specified table.
2347 */
2348 SSESpecification?: SSESpecification;
2349 }
2350 export interface UpdateTableOutput {
2351 /**
2352 * Represents the properties of the table.
2353 */
2354 TableDescription?: TableDescription;
2355 }
2356 export interface UpdateTimeToLiveInput {
2357 /**
2358 * The name of the table to be configured.
2359 */
2360 TableName: TableName;
2361 /**
2362 * Represents the settings used to enable or disable Time to Live for the specified table.
2363 */
2364 TimeToLiveSpecification: TimeToLiveSpecification;
2365 }
2366 export interface UpdateTimeToLiveOutput {
2367 /**
2368 * Represents the output of an UpdateTimeToLive operation.
2369 */
2370 TimeToLiveSpecification?: TimeToLiveSpecification;
2371 }
2372 export interface WriteRequest {
2373 /**
2374 * A request to perform a PutItem operation.
2375 */
2376 PutRequest?: PutRequest;
2377 /**
2378 * A request to perform a DeleteItem operation.
2379 */
2380 DeleteRequest?: DeleteRequest;
2381 }
2382 export type WriteRequests = WriteRequest[];
2383
2384 //<!--auto-generated end-->
2385}