API Reference

Resources

DynamodbTable

A cloud Dynamodb table.

Initializers

bring ex;

new ex.DynamodbTable(props: DynamodbTableProps);

Name	Type	Description
props	DynamodbTableProps	No description.

---

props^Required

• Type: DynamodbTableProps

---

Methods

Inflight Methods

Name	Description
batchGetItem	Return the attributes of one or more items.
batchWriteItem	Put or delete multiple items.
deleteItem	Delete an item from the table.
getItem	Get an item from the table.
putItem	Put an item into the table.
query	Return all items with a given partition key value.
scan	Return one or more items and item attributes by accessing every item in a table or a secondary index.
transactGetItems	Perform a synchronous read operation that groups up to 100 item retrievals.
transactWriteItems	Perform a synchronous write operation that groups up to 100 action requests.
updateItem	Edit an existing item's attributes, or add a new item to the table if it does not already exist.

---

batchGetItem

inflight batchGetItem(options: DynamodbTableBatchGetItemOptions): DynamodbTableBatchGetItemResult

Return the attributes of one or more items.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchGetItem.html

options^Required

• Type: DynamodbTableBatchGetItemOptions

options for the batch get item operation.

---

batchWriteItem

inflight batchWriteItem(options: DynamodbTableBatchWriteItemOptions): DynamodbTableBatchWriteItemResult

Put or delete multiple items.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html

options^Required

• Type: DynamodbTableBatchWriteItemOptions

options for the batch write item operation.

---

deleteItem

inflight deleteItem(options: DynamodbTableDeleteItemOptions): DynamodbTableDeleteItemResult

Delete an item from the table.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html

options^Required

• Type: DynamodbTableDeleteItemOptions

dynamodb DeleteItem options.

---

getItem

inflight getItem(options: DynamodbTableGetItemOptions): DynamodbTableGetItemResult

Get an item from the table.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html

options^Required

• Type: DynamodbTableGetItemOptions

options for the getItem operation.

---

putItem

inflight putItem(options: DynamodbTablePutItemOptions): DynamodbTablePutItemResult

Put an item into the table.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html

options^Required

• Type: DynamodbTablePutItemOptions

dynamodb PutItem options.

---

query

inflight query(options: DynamodbTableQueryOptions): DynamodbTableQueryResult

Return all items with a given partition key value.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html

options^Required

• Type: DynamodbTableQueryOptions

options for the query operation.

---

scan

inflight scan(options?: DynamodbTableScanOptions): DynamodbTableScanResult

Return one or more items and item attributes by accessing every item in a table or a secondary index.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html

options^Optional

• Type: DynamodbTableScanOptions

options for the scan operation.

---

transactGetItems

inflight transactGetItems(options: DynamodbTransactGetItemsOptions): DynamodbTableTransactGetItemsResult

Perform a synchronous read operation that groups up to 100 item retrievals.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html

options^Required

• Type: DynamodbTransactGetItemsOptions

options for the query operation.

---

transactWriteItems

inflight transactWriteItems(options: DynamodbTransactWriteItemsOptions): DynamodbTableTransactWriteItemsResult

Perform a synchronous write operation that groups up to 100 action requests.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html

options^Required

• Type: DynamodbTransactWriteItemsOptions

options for the transact write items operation.

---

updateItem

inflight updateItem(options: DynamodbTableUpdateItemOptions): DynamodbTableUpdateItemResult

Edit an existing item's attributes, or add a new item to the table if it does not already exist.

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html

options^Required

• Type: DynamodbTableUpdateItemOptions

dynamodb UpdateItem options.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
name	str	Table name.

---

node^Required

node: Node;

• Type: constructs.Node

The tree node.

---

name^Required

name: str;

• Type: str

Table name.

---

Classes

DynamodbTableClientBase

• Implements: IDynamodbTableClient

Base class for DynamodbTable Client.

Initializers

bring ex;

new ex.DynamodbTableClientBase(tableName: str);

Name	Type	Description
tableName	str	the table name.

---

tableName^Required

• Type: str

the table name.

---

Methods

Name	Description
batchGetItem	Return the attributes of one or more items.
batchWriteItem	Put or delete multiple items.
deleteItem	Delete an item from the table.
getItem	Get an item from the table.
putItem	Put an item into the table.
query	Return all items with a given partition key value.
scan	Return one or more items and item attributes by accessing every item in a table or a secondary index.
transactGetItems	Perform a synchronous read operation that groups up to 100 item retrievals.
transactWriteItems	Perform a synchronous write operation that groups up to 100 action requests.
updateItem	Edit an existing item's attributes, or add a new item to the table if it does not already exist.

---

batchGetItem

batchGetItem(options: DynamodbTableBatchGetItemOptions): DynamodbTableBatchGetItemResult

Return the attributes of one or more items.

options^Required

• Type: DynamodbTableBatchGetItemOptions

---

batchWriteItem

batchWriteItem(options: DynamodbTableBatchWriteItemOptions): DynamodbTableBatchWriteItemResult

Put or delete multiple items.

options^Required

• Type: DynamodbTableBatchWriteItemOptions

---

deleteItem

deleteItem(options: DynamodbTableDeleteItemOptions): DynamodbTableDeleteItemResult

Delete an item from the table.

options^Required

• Type: DynamodbTableDeleteItemOptions

---

getItem

getItem(options: DynamodbTableGetItemOptions): DynamodbTableGetItemResult

Get an item from the table.

options^Required

• Type: DynamodbTableGetItemOptions

---

putItem

putItem(options: DynamodbTablePutItemOptions): DynamodbTablePutItemResult

Put an item into the table.

options^Required

• Type: DynamodbTablePutItemOptions

---

query

query(options: DynamodbTableQueryOptions): DynamodbTableQueryResult

Return all items with a given partition key value.

options^Required

• Type: DynamodbTableQueryOptions

---

scan

scan(options?: DynamodbTableScanOptions): DynamodbTableScanResult

Return one or more items and item attributes by accessing every item in a table or a secondary index.

options^Optional

• Type: DynamodbTableScanOptions

---

transactGetItems

transactGetItems(options: DynamodbTransactGetItemsOptions): DynamodbTableTransactGetItemsResult

Perform a synchronous read operation that groups up to 100 item retrievals.

options^Required

• Type: DynamodbTransactGetItemsOptions

---

transactWriteItems

transactWriteItems(options: DynamodbTransactWriteItemsOptions): DynamodbTableTransactWriteItemsResult

Perform a synchronous write operation that groups up to 100 action requests.

options^Required

• Type: DynamodbTransactWriteItemsOptions

---

updateItem

updateItem(options: DynamodbTableUpdateItemOptions): DynamodbTableUpdateItemResult

Edit an existing item's attributes, or add a new item to the table if it does not already exist.

options^Required

• Type: DynamodbTableUpdateItemOptions

---

Structs

DynamodbTableBatchGetItemOptions

Options for DynamodbTable.batchGetItem.

Initializer

bring ex;

let DynamodbTableBatchGetItemOptions = ex.DynamodbTableBatchGetItemOptions{ ... };

Properties

Name	Type	Description
requestItem	DynamodbTableBatchGetItemRequestItem	Describes one or more items to retrieve from that table.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.

---

requestItem^Required

requestItem: DynamodbTableBatchGetItemRequestItem;

• Type: DynamodbTableBatchGetItemRequestItem

Describes one or more items to retrieve from that table.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

DynamodbTableBatchGetItemRequestItem

Options for DynamodbTable.batchGetItem request item.

Initializer

bring ex;

let DynamodbTableBatchGetItemRequestItem = ex.DynamodbTableBatchGetItemRequestItem{ ... };

Properties

Name	Type	Description
keys	MutArray<Json>	The primary key attribute values that define the items and the attributes associated with the items.
consistentRead	bool	The consistency of a read operation.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
projectionExpression	str	A string that identifies one or more attributes to retrieve from the table.

---

keys^Required

keys: MutArray<Json>;

• Type: MutArray<Json>

The primary key attribute values that define the items and the attributes associated with the items.

---

consistentRead^Optional

consistentRead: bool;

• Type: bool
• Default: false

The consistency of a read operation.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

projectionExpression^Optional

projectionExpression: str;

• Type: str

A string that identifies one or more attributes to retrieve from the table.

---

DynamodbTableBatchGetItemResult

Result for DynamodbTable.batchGetItem.

Initializer

bring ex;

let DynamodbTableBatchGetItemResult = ex.DynamodbTableBatchGetItemResult{ ... };

Properties

Name	Type	Description
consumedCapacity	Json	The capacity units consumed by the operation.
responses	MutArray<Json>	The list of items that are returned, with the attributes requested.
unprocessedKeys	DynamodbTableBatchGetItemRequestItem	A list of keys that were not processed.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

responses^Optional

responses: MutArray<Json>;

• Type: MutArray<Json>

The list of items that are returned, with the attributes requested.

---

unprocessedKeys^Optional

unprocessedKeys: DynamodbTableBatchGetItemRequestItem;

• Type: DynamodbTableBatchGetItemRequestItem

A list of keys that were not processed.

---

DynamodbTableBatchWriteItemDeleteRequestOptions

Options for DynamodbTable.batchWriteItem's delete request.

Initializer

bring ex;

let DynamodbTableBatchWriteItemDeleteRequestOptions = ex.DynamodbTableBatchWriteItemDeleteRequestOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be deleted.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be deleted.

---

DynamodbTableBatchWriteItemOptions

Options for DynamodbTable.batchWriteItem.

Initializer

bring ex;

let DynamodbTableBatchWriteItemOptions = ex.DynamodbTableBatchWriteItemOptions{ ... };

Properties

Name	Type	Description
requestItems	MutArray<DynamodbTableBatchWriteItemRequestItem>	A list of operations to be performed (DeleteRequest or PutRequest).
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.
returnItemCollectionMetrics	str	Determines whether item collection metrics are returned.

---

requestItems^Required

requestItems: MutArray<DynamodbTableBatchWriteItemRequestItem>;

• Type: MutArray<DynamodbTableBatchWriteItemRequestItem>

A list of operations to be performed (DeleteRequest or PutRequest).

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

returnItemCollectionMetrics^Optional

returnItemCollectionMetrics: str;

• Type: str
• Default: "NONE"

Determines whether item collection metrics are returned.

---

DynamodbTableBatchWriteItemPutRequestOptions

Options for DynamodbTable.batchWriteItem's put request.

Initializer

bring ex;

let DynamodbTableBatchWriteItemPutRequestOptions = ex.DynamodbTableBatchWriteItemPutRequestOptions{ ... };

Properties

Name	Type	Description
item	Json	The values of the item to be put.

---

item^Required

item: Json;

• Type: Json

The values of the item to be put.

---

DynamodbTableBatchWriteItemRequestItem

Options for DynamodbTable.batchWriteItem request item.

Initializer

bring ex;

let DynamodbTableBatchWriteItemRequestItem = ex.DynamodbTableBatchWriteItemRequestItem{ ... };

Properties

Name	Type	Description
deleteRequest	DynamodbTableBatchWriteItemDeleteRequestOptions	A request to perform a delete operation.
putRequest	DynamodbTableBatchWriteItemPutRequestOptions	A request to perform a put operation.

---

deleteRequest^Optional

deleteRequest: DynamodbTableBatchWriteItemDeleteRequestOptions;

• Type: DynamodbTableBatchWriteItemDeleteRequestOptions

A request to perform a delete operation.

---

putRequest^Optional

putRequest: DynamodbTableBatchWriteItemPutRequestOptions;

• Type: DynamodbTableBatchWriteItemPutRequestOptions

A request to perform a put operation.

---

DynamodbTableBatchWriteItemResult

Result for DynamodbTable.batchWriteItem.

Initializer

bring ex;

let DynamodbTableBatchWriteItemResult = ex.DynamodbTableBatchWriteItemResult{ ... };

Properties

Name	Type	Description
consumedCapacity	Json	The capacity units consumed by the operation.
itemCollectionMetrics	Json	Information about item collections, if any, that were affected by the operation.
unprocessedItems	MutArray<DynamodbTableBatchWriteItemRequestItem>	The unprocessed items from the operation.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

itemCollectionMetrics^Optional

itemCollectionMetrics: Json;

• Type: Json

Information about item collections, if any, that were affected by the operation.

---

unprocessedItems^Optional

unprocessedItems: MutArray<DynamodbTableBatchWriteItemRequestItem>;

• Type: MutArray<DynamodbTableBatchWriteItemRequestItem>

The unprocessed items from the operation.

---

DynamodbTableDeleteItemOptions

Options for DynamodbTable.deleteItem.

Initializer

bring ex;

let DynamodbTableDeleteItemOptions = ex.DynamodbTableDeleteItemOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be deleted.
conditionExpression	str	A condition that must be satisfied in order for an operation to succeed.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.
returnItemCollectionMetrics	str	Determines whether item collection metrics are returned.
returnValues	str	Whether to return the item attributes as they appeared before they were deleted.
returnValuesOnConditionCheckFailure	str	Whether to return the item attributes if the condition fails.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be deleted.

---

conditionExpression^Optional

conditionExpression: str;

• Type: str

A condition that must be satisfied in order for an operation to succeed.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

returnItemCollectionMetrics^Optional

returnItemCollectionMetrics: str;

• Type: str
• Default: "NONE"

Determines whether item collection metrics are returned.

---

returnValues^Optional

returnValues: str;

• Type: str
• Default: "NONE"

Whether to return the item attributes as they appeared before they were deleted.

---

returnValuesOnConditionCheckFailure^Optional

returnValuesOnConditionCheckFailure: str;

• Type: str
• Default: "NONE"

Whether to return the item attributes if the condition fails.

---

DynamodbTableDeleteItemResult

Result for DynamodbTable.deleteItem.

Initializer

bring ex;

let DynamodbTableDeleteItemResult = ex.DynamodbTableDeleteItemResult{ ... };

Properties

Name	Type	Description
attributes	Json	The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.
consumedCapacity	Json	The capacity units consumed by the operation.
itemCollectionMetrics	Json	Information about item collections, if any, that were affected by the operation.

---

attributes^Optional

attributes: Json;

• Type: Json

The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

itemCollectionMetrics^Optional

itemCollectionMetrics: Json;

• Type: Json

Information about item collections, if any, that were affected by the operation.

---

DynamodbTableGetItemOptions

Options for DynamodbTable.getItem.

Initializer

bring ex;

let DynamodbTableGetItemOptions = ex.DynamodbTableGetItemOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be retrieved.
consistentRead	bool	Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
projectionExpression	str	A string that identifies one or more attributes to retrieve from the table.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be retrieved.

---

consistentRead^Optional

consistentRead: bool;

• Type: bool
• Default: false

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;

otherwise, the operation uses eventually consistent reads.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

projectionExpression^Optional

projectionExpression: str;

• Type: str

A string that identifies one or more attributes to retrieve from the table.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

DynamodbTableGetItemResult

Result for DynamodbTable.getItem.

Initializer

bring ex;

let DynamodbTableGetItemResult = ex.DynamodbTableGetItemResult{ ... };

Properties

Name	Type	Description
consumedCapacity	Json	The capacity units consumed by the operation.
item	Json	A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

item^Optional

item: Json;

• Type: Json

A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

---

DynamodbTableProps

Properties for DynamodbTable.

Initializer

bring ex;

let DynamodbTableProps = ex.DynamodbTableProps{ ... };

Properties

Name	Type	Description
attributeDefinitions	Json	Table attribute definitions.
hashKey	str	Hash key for this table.
name	str	The table's name.
rangeKey	str	Range key for this table.

---

attributeDefinitions^Required

attributeDefinitions: Json;

• Type: Json

Table attribute definitions.

e.g. { "myKey": "S", "myOtherKey": "S" }.

---

hashKey^Required

hashKey: str;

• Type: str

Hash key for this table.

---

name^Required

name: str;

• Type: str

The table's name.

---

rangeKey^Optional

rangeKey: str;

• Type: str
• Default: undefined

Range key for this table.

---

DynamodbTablePutItemOptions

Options for DynamodbTable.putItem.

Initializer

bring ex;

let DynamodbTablePutItemOptions = ex.DynamodbTablePutItemOptions{ ... };

Properties

Name	Type	Description
item	Json	The values of the item to be put.
conditionExpression	str	A condition that must be satisfied in order for an operation to succeed.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.
returnItemCollectionMetrics	str	Determines whether item collection metrics are returned.
returnValuesOnConditionCheckFailure	str	Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails.

---

item^Required

item: Json;

• Type: Json

The values of the item to be put.

---

conditionExpression^Optional

conditionExpression: str;

• Type: str

A condition that must be satisfied in order for an operation to succeed.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

returnItemCollectionMetrics^Optional

returnItemCollectionMetrics: str;

• Type: str
• Default: "NONE"

Determines whether item collection metrics are returned.

---

returnValuesOnConditionCheckFailure^Optional

returnValuesOnConditionCheckFailure: str;

• Type: str
• Default: "NONE"

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails.

---

DynamodbTablePutItemResult

Result for DynamodbTable.putItem.

Initializer

bring ex;

let DynamodbTablePutItemResult = ex.DynamodbTablePutItemResult{ ... };

Properties

Name	Type	Description
attributes	Json	The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.
consumedCapacity	Json	The capacity units consumed by the operation.
itemCollectionMetrics	Json	Information about item collections, if any, that were affected by the operation.

---

attributes^Optional

attributes: Json;

• Type: Json

The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

itemCollectionMetrics^Optional

itemCollectionMetrics: Json;

• Type: Json

Information about item collections, if any, that were affected by the operation.

---

DynamodbTableQueryOptions

Options for DynamodbTable.query.

Initializer

bring ex;

let DynamodbTableQueryOptions = ex.DynamodbTableQueryOptions{ ... };

Properties

Name	Type	Description
keyConditionExpression	str	The condition that specifies the key values for items to be retrieved by the Query action.
consistentRead	bool	Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
exclusiveStartKey	Json	The primary key of the first item that this operation will evaluate.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
filterExpression	str	A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you.
indexName	str	The name of an index to query.
limit	num	The maximum number of items to evaluate (not necessarily the number of matching items).
projectionExpression	str	A string that identifies one or more attributes to retrieve from the table.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.
scanIndexForward	bool	Specifies the order for index traversal.
select	str	The attributes to be returned in the result.

---

keyConditionExpression^Required

keyConditionExpression: str;

• Type: str

The condition that specifies the key values for items to be retrieved by the Query action.

---

consistentRead^Optional

consistentRead: bool;

• Type: bool
• Default: false

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;

otherwise, the operation uses eventually consistent reads.

---

exclusiveStartKey^Optional

exclusiveStartKey: Json;

• Type: Json

The primary key of the first item that this operation will evaluate.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

filterExpression^Optional

filterExpression: str;

• Type: str

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you.

---

indexName^Optional

indexName: str;

• Type: str

The name of an index to query.

---

limit^Optional

limit: num;

• Type: num

The maximum number of items to evaluate (not necessarily the number of matching items).

---

projectionExpression^Optional

projectionExpression: str;

• Type: str

A string that identifies one or more attributes to retrieve from the table.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

scanIndexForward^Optional

scanIndexForward: bool;

• Type: bool
• Default: true

Specifies the order for index traversal.

---

select^Optional

select: str;

• Type: str

The attributes to be returned in the result.

---

DynamodbTableQueryResult

Result for DynamodbTable.query.

Initializer

bring ex;

let DynamodbTableQueryResult = ex.DynamodbTableQueryResult{ ... };

Properties

Name	Type	Description
count	num	The number of items in the response.
items	MutArray<Json>	An array of item attributes that match the scan criteria.
scannedCount	num	The number of items evaluated, before any QueryFilter is applied.
consumedCapacity	Json	The capacity units consumed by the operation.
lastEvaluatedKey	Json	The primary key of the item where the operation stopped, inclusive of the previous result set.

---

count^Required

count: num;

• Type: num

The number of items in the response.

---

items^Required

items: MutArray<Json>;

• Type: MutArray<Json>

An array of item attributes that match the scan criteria.

---

scannedCount^Required

scannedCount: num;

• Type: num

The number of items evaluated, before any QueryFilter is applied.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

lastEvaluatedKey^Optional

lastEvaluatedKey: Json;

• Type: Json

The primary key of the item where the operation stopped, inclusive of the previous result set.

---

DynamodbTableScanOptions

Options for DynamodbTable.scan.

Initializer

bring ex;

let DynamodbTableScanOptions = ex.DynamodbTableScanOptions{ ... };

Properties

Name	Type	Description
consistentRead	bool	Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
exclusiveStartKey	Json	The primary key of the first item that this operation will evaluate.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
filterExpression	str	A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you.
indexName	str	The name of an index to query.
limit	num	The maximum number of items to evaluate (not necessarily the number of matching items).
projectionExpression	str	A string that identifies one or more attributes to retrieve from the table.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.
segment	num	For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.
select	str	The attributes to be returned in the result.
totalSegments	num	For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided.

---

consistentRead^Optional

consistentRead: bool;

• Type: bool
• Default: false

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;

otherwise, the operation uses eventually consistent reads.

---

exclusiveStartKey^Optional

exclusiveStartKey: Json;

• Type: Json

The primary key of the first item that this operation will evaluate.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

filterExpression^Optional

filterExpression: str;

• Type: str

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you.

---

indexName^Optional

indexName: str;

• Type: str

The name of an index to query.

---

limit^Optional

limit: num;

• Type: num

The maximum number of items to evaluate (not necessarily the number of matching items).

---

projectionExpression^Optional

projectionExpression: str;

• Type: str

A string that identifies one or more attributes to retrieve from the table.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

segment^Optional

segment: num;

• Type: num
• Default: 0

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

---

select^Optional

select: str;

• Type: str

The attributes to be returned in the result.

---

totalSegments^Optional

totalSegments: num;

• Type: num
• Default: 1

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided.

---

DynamodbTableScanResult

Result for DynamodbTable.scan.

Initializer

bring ex;

let DynamodbTableScanResult = ex.DynamodbTableScanResult{ ... };

Properties

Name	Type	Description
count	num	The number of items in the response.
items	MutArray<Json>	An array of item attributes that match the scan criteria.
scannedCount	num	The number of items evaluated, before any ScanFilter is applied.
consumedCapacity	Json	The capacity units consumed by the operation.
lastEvaluatedKey	Json	The primary key of the item where the operation stopped, inclusive of the previous result set.

---

count^Required

count: num;

• Type: num

The number of items in the response.

---

items^Required

items: MutArray<Json>;

• Type: MutArray<Json>

An array of item attributes that match the scan criteria.

---

scannedCount^Required

scannedCount: num;

• Type: num

The number of items evaluated, before any ScanFilter is applied.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

lastEvaluatedKey^Optional

lastEvaluatedKey: Json;

• Type: Json

The primary key of the item where the operation stopped, inclusive of the previous result set.

---

DynamodbTableTransactGetItemsResponseItem

Details of the requested item.

Initializer

bring ex;

let DynamodbTableTransactGetItemsResponseItem = ex.DynamodbTableTransactGetItemsResponseItem{ ... };

Properties

Name	Type	Description
item	Json	The values of the item.

---

item^Required

item: Json;

• Type: Json

The values of the item.

---

DynamodbTableTransactGetItemsResult

Result for DynamodbTable.transactGetItems.

Initializer

bring ex;

let DynamodbTableTransactGetItemsResult = ex.DynamodbTableTransactGetItemsResult{ ... };

Properties

Name	Type	Description
responses	MutArray<DynamodbTableTransactGetItemsResponseItem>	An ordered array of up to 100 DynamodbTableTransactGetItemsResponseItem objects.
consumedCapacity	Json	The capacity units consumed by the operation.

---

responses^Required

responses: MutArray<DynamodbTableTransactGetItemsResponseItem>;

• Type: MutArray<DynamodbTableTransactGetItemsResponseItem>

An ordered array of up to 100 DynamodbTableTransactGetItemsResponseItem objects.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

DynamodbTableTransactWriteItemsResult

Result for DynamodbTable.transactWriteItems.

Initializer

bring ex;

let DynamodbTableTransactWriteItemsResult = ex.DynamodbTableTransactWriteItemsResult{ ... };

Properties

Name	Type	Description
attributes	Json	The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.
consumedCapacity	Json	The capacity units consumed by the operation.
itemCollectionMetrics	Json	Information about item collections, if any, that were affected by the operation.

---

attributes^Optional

attributes: Json;

• Type: Json

The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

itemCollectionMetrics^Optional

itemCollectionMetrics: Json;

• Type: Json

Information about item collections, if any, that were affected by the operation.

---

DynamodbTableUpdateItemOptions

Options for DynamodbTable.updateItem.

Initializer

bring ex;

let DynamodbTableUpdateItemOptions = ex.DynamodbTableUpdateItemOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be updated.
conditionExpression	str	A condition that must be satisfied in order for a conditional update to succeed.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.
returnItemCollectionMetrics	str	Determines whether item collection metrics are returned.
returnValues	str	Use ReturnValues to get the item attributes if the Update operation succeeds.
returnValuesOnConditionCheckFailure	str	Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails.
updateExpression	str	An expression that defines one or more attributes to be updated.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be updated.

---

conditionExpression^Optional

conditionExpression: str;

• Type: str

A condition that must be satisfied in order for a conditional update to succeed.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

returnItemCollectionMetrics^Optional

returnItemCollectionMetrics: str;

• Type: str
• Default: "NONE"

Determines whether item collection metrics are returned.

---

returnValues^Optional

returnValues: str;

• Type: str
• Default: "NONE"

Use ReturnValues to get the item attributes if the Update operation succeeds.

---

returnValuesOnConditionCheckFailure^Optional

returnValuesOnConditionCheckFailure: str;

• Type: str
• Default: "NONE"

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails.

---

updateExpression^Optional

updateExpression: str;

• Type: str

An expression that defines one or more attributes to be updated.

---

DynamodbTableUpdateItemResult

Result for DynamodbTable.updateItem.

Initializer

bring ex;

let DynamodbTableUpdateItemResult = ex.DynamodbTableUpdateItemResult{ ... };

Properties

Name	Type	Description
attributes	Json	The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.
consumedCapacity	Json	The capacity units consumed by the operation.
itemCollectionMetrics	Json	Information about item collections, if any, that were affected by the operation.

---

attributes^Optional

attributes: Json;

• Type: Json

The attribute values as they appeared before the operation, but only if ReturnValues is specified as "ALL_OLD" in the request.

---

consumedCapacity^Optional

consumedCapacity: Json;

• Type: Json

The capacity units consumed by the operation.

---

itemCollectionMetrics^Optional

itemCollectionMetrics: Json;

• Type: Json

Information about item collections, if any, that were affected by the operation.

---

DynamodbTransactGetItem

Dynamodb transact get operation.

Initializer

bring ex;

let DynamodbTransactGetItem = ex.DynamodbTransactGetItem{ ... };

Properties

Name	Type	Description
get	DynamodbTransactGetItemGetOptions	A request to perform a get operation.

---

get^Optional

get: DynamodbTransactGetItemGetOptions;

• Type: DynamodbTransactGetItemGetOptions

A request to perform a get operation.

---

DynamodbTransactGetItemGetOptions

Options for DynamodbTable.transactGetItems's get operation.

Initializer

bring ex;

let DynamodbTransactGetItemGetOptions = ex.DynamodbTransactGetItemGetOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be retrieved.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
projectionExpression	str	A string that identifies one or more attributes to retrieve from the table.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be retrieved.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json
• Default: undefined

One or more substitution tokens for attribute names in an expression.

---

projectionExpression^Optional

projectionExpression: str;

• Type: str
• Default: undefined

A string that identifies one or more attributes to retrieve from the table.

---

DynamodbTransactGetItemsOptions

Options for DynamodbTable.transactGetItems.

Initializer

bring ex;

let DynamodbTransactGetItemsOptions = ex.DynamodbTransactGetItemsOptions{ ... };

Properties

Name	Type	Description
transactItems	MutArray<DynamodbTransactGetItem>	An ordered array of up to 100 DynamodbTransactGetItem objects, each of which contains a DynamodbTransactGetItem structure.
returnConsumedCapacity	str	Determines the level of detail about either provisioned or on-demand throughput consumption.

---

transactItems^Required

transactItems: MutArray<DynamodbTransactGetItem>;

• Type: MutArray<DynamodbTransactGetItem>

An ordered array of up to 100 DynamodbTransactGetItem objects, each of which contains a DynamodbTransactGetItem structure.

---

returnConsumedCapacity^Optional

returnConsumedCapacity: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

DynamodbTransactWriteItem

Dynamodb transact write operation.

Initializer

bring ex;

let DynamodbTransactWriteItem = ex.DynamodbTransactWriteItem{ ... };

Properties

Name	Type	Description
conditionCheck	DynamodbTransactWriteItemConditionCheckOptions	A request to perform a condition check operation.
delete	DynamodbTransactWriteItemDeleteOptions	A request to perform a delete operation.
put	DynamodbTransactWriteItemPutOptions	A request to perform a put operation.
update	DynamodbTransactWriteItemUpdateOptions	A request to perform a update operation.

---

conditionCheck^Optional

conditionCheck: DynamodbTransactWriteItemConditionCheckOptions;

• Type: DynamodbTransactWriteItemConditionCheckOptions

A request to perform a condition check operation.

---

delete^Optional

delete: DynamodbTransactWriteItemDeleteOptions;

• Type: DynamodbTransactWriteItemDeleteOptions

A request to perform a delete operation.

---

put^Optional

put: DynamodbTransactWriteItemPutOptions;

• Type: DynamodbTransactWriteItemPutOptions

A request to perform a put operation.

---

update^Optional

update: DynamodbTransactWriteItemUpdateOptions;

• Type: DynamodbTransactWriteItemUpdateOptions

A request to perform a update operation.

---

DynamodbTransactWriteItemConditionCheckOptions

Options for transact write item's condition check operation.

Initializer

bring ex;

let DynamodbTransactWriteItemConditionCheckOptions = ex.DynamodbTransactWriteItemConditionCheckOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be checked.
conditionExpression	str	A condition that must be satisfied in order for an operation to succeed.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
returnValuesOnConditionCheckFailure	str	Determines the level of detail about either provisioned or on-demand throughput consumption.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be checked.

---

conditionExpression^Optional

conditionExpression: str;

• Type: str

A condition that must be satisfied in order for an operation to succeed.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

returnValuesOnConditionCheckFailure^Optional

returnValuesOnConditionCheckFailure: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

DynamodbTransactWriteItemDeleteOptions

Options for transact write item's delete operation.

Initializer

bring ex;

let DynamodbTransactWriteItemDeleteOptions = ex.DynamodbTransactWriteItemDeleteOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be deleted.
conditionExpression	str	A condition that must be satisfied in order for an operation to succeed.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
returnValuesOnConditionCheckFailure	str	Determines the level of detail about either provisioned or on-demand throughput consumption.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be deleted.

---

conditionExpression^Optional

conditionExpression: str;

• Type: str

A condition that must be satisfied in order for an operation to succeed.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

returnValuesOnConditionCheckFailure^Optional

returnValuesOnConditionCheckFailure: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

DynamodbTransactWriteItemPutOptions

Options for transact write item's update operation.

Initializer

bring ex;

let DynamodbTransactWriteItemPutOptions = ex.DynamodbTransactWriteItemPutOptions{ ... };

Properties

Name	Type	Description
item	Json	The values of the item to be put.
conditionExpression	str	A condition that must be satisfied in order for the operation to succeed.

---

item^Required

item: Json;

• Type: Json

The values of the item to be put.

---

conditionExpression^Optional

conditionExpression: str;

• Type: str
• Default: undefined

A condition that must be satisfied in order for the operation to succeed.

---

DynamodbTransactWriteItemsOptions

Options for DynamodbTable.transactWriteItems.

Initializer

bring ex;

let DynamodbTransactWriteItemsOptions = ex.DynamodbTransactWriteItemsOptions{ ... };

Properties

Name	Type	Description
transactItems	MutArray<DynamodbTransactWriteItem>	The write transact items.

---

transactItems^Required

transactItems: MutArray<DynamodbTransactWriteItem>;

• Type: MutArray<DynamodbTransactWriteItem>

The write transact items.

---

DynamodbTransactWriteItemUpdateOptions

Options for transact write item's update operation.

Initializer

bring ex;

let DynamodbTransactWriteItemUpdateOptions = ex.DynamodbTransactWriteItemUpdateOptions{ ... };

Properties

Name	Type	Description
key	Json	The primary key of the item to be updated.
conditionExpression	str	A condition that must be satisfied in order for an operation to succeed.
expressionAttributeNames	Json	One or more substitution tokens for attribute names in an expression.
expressionAttributeValues	Json	One or more values that can be substituted in an expression.
returnValuesOnConditionCheckFailure	str	Determines the level of detail about either provisioned or on-demand throughput consumption.
updateExpression	str	An expression that defines one or more attributes to be updated.

---

key^Required

key: Json;

• Type: Json

The primary key of the item to be updated.

---

conditionExpression^Optional

conditionExpression: str;

• Type: str

A condition that must be satisfied in order for an operation to succeed.

---

expressionAttributeNames^Optional

expressionAttributeNames: Json;

• Type: Json

One or more substitution tokens for attribute names in an expression.

---

expressionAttributeValues^Optional

expressionAttributeValues: Json;

• Type: Json

One or more values that can be substituted in an expression.

---

returnValuesOnConditionCheckFailure^Optional

returnValuesOnConditionCheckFailure: str;

• Type: str
• Default: "NONE"

Determines the level of detail about either provisioned or on-demand throughput consumption.

---

updateExpression^Optional

updateExpression: str;

• Type: str

An expression that defines one or more attributes to be updated.

---