@aws-lite/dynamodb
Advanced tools
Readme
@aws-lite/dynamodbOfficial
aws-liteplugin for DynamoDB
Maintained by: @architect
npm i @aws-lite/dynamodb
Optionally install types:
npm i -D @aws-lite/dynamodb-types
Reference documentation with examples at aws-lite.org
BatchExecuteStatementProperties:
Statements (array) [required]
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEBatchGetItemProperties:
RequestItems (object) [required]
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEBatchWriteItemProperties:
RequestItems (object) [required]
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEReturnItemCollectionMetrics (string)
SIZE, or NONE (default)CreateBackupProperties:
TableName (string) [required]
BackupName (string) [required]
CreateGlobalTableProperties:
GlobalTableName (string) [required]
ReplicationGroup (array) [required]
CreateTableProperties:
TableName (string) [required]
AttributeDefinitions (array) [required]
KeySchema (array) [required]
KeySchema must also be defined in the AttributeDefinitions arrayBillingMode (string)
PROVISIONED, or PAY_PER_REQUESTDeletionProtectionEnabled (boolean)
GlobalSecondaryIndexes (array)
LocalSecondaryIndexes (array)
ProvisionedThroughput (object)
SSESpecification (object)
StreamSpecification (object)
StreamEnabled (boolean), and StreamViewType (KEYS_ONLY, NEW_IMAGE, OLD_IMAGE, or NEW_AND_OLD_IMAGES)TableClass (string)
STANDARD, or STANDARD_INFREQUENT_ACCESSTags (array)
DeleteBackupProperties:
BackupArn (string) [required]
DeleteItemProperties:
TableName (string) [required]
Key (object) [required]
ConditionalOperator (string)
FilterExpression insteadConditionExpression (string)
Expected (object)
ConditionExpression insteadExpressionAttributeNames (object)
ExpressionAttributeValues (object)
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEReturnItemCollectionMetrics (string)
SIZE, or NONE (default)ReturnValues (string)
NONE (default), or ALL_OLDReturnValuesOnConditionCheckFailure (string)
NONE, or ALL_OLDDeleteTableProperties:
TableName (string) [required]
DescribeBackupProperties:
BackupArn (string) [required]
DescribeContinuousBackupsProperties:
TableName (string) [required]
DescribeContributorInsightsProperties:
TableName (string) [required]
IndexName (string)
DescribeEndpointsProperties:
DescribeExportProperties:
ExportArn (string) [required]
DescribeGlobalTableProperties:
GlobalTableName (string) [required]
DescribeGlobalTableSettingsProperties:
GlobalTableName (string) [required]
DescribeImportProperties:
ImportArn (string) [required]
DescribeKinesisStreamingDestinationProperties:
TableName (string) [required]
DescribeLimitsProperties:
DescribeTableProperties:
TableName (string) [required]
DescribeTableReplicaAutoScalingProperties:
TableName (string) [required]
DescribeTimeToLiveProperties:
TableName (string) [required]
DisableKinesisStreamingDestinationProperties:
TableName (string) [required]
StreamArn (string) [required]
EnableKinesisStreamingDestinationProperties:
TableName (string) [required]
StreamArn (string) [required]
ExecuteStatementProperties:
TableName (string) [required]
Statement (string) [required]
ConsistentRead (boolean)
Limit (number)
NextToken (string)
NextToken was returned in a previous responseParameters (array)
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEReturnValuesOnConditionCheckFailure (string)
NONE, or ALL_OLDExecuteTransactionProperties:
TableName (string) [required]
TransactStatements (array) [required]
ClientRequestToken (string)
NextToken was returned in a previous responseReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEExportTableToPointInTimeProperties:
S3Bucket (string) [required]
TableArn (string) [required]
ClientToken (string)
ExportFormat (string)
DYNAMODB_JSON, or IOExportTime (number)
S3BucketOwner (string)
S3Prefix (string)
S3SseAlgorithm (string)
AES256, or KMSS3SseKmsKeyId (string)
GetItemProperties:
TableName (string) [required]
Key (object) [required]
AttributesToGet (array)
ProjectionExpression insteadConsistentRead (boolean)
ExpressionAttributeNames (object)
ProjectionExpression (string)
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEImportTableProperties:
InputFormat (string) [required]
CSV, DYNAMODB_JSON, or IONS3BucketSource (object) [required]
TableCreationParameters (object) [required]
ClientToken (string)
InputCompressionType (string)
GZIP, ZSTD, or NONEInputFormatOptions (object)
ListBackupsProperties:
BackupType (string)
USER SYSTEM, AWS_BACKUP, or ALLExclusiveStartBackupArn (string)
LastEvaluatedBackupArn was returned in a previous responseLimit (number)
TableName (string)
TimeRangeLowerBound (number)
TimeRangeUpperBound (number)
ListContributorInsightsProperties:
MaxResults (number)
NextToken (string)
NextToken was returned in a previous responseTableName (string)
ListExportsProperties:
MaxResults (number)
NextToken (string)
NextToken was returned in a previous responseTableArn (string)
ListGlobalTablesProperties:
ExclusiveStartGlobalTableName (string)
LastEvaluatedGlobalTableName was returned in a previous responseLimit (number)
RegionName (string)
ListImportsProperties:
NextToken (string)
NextToken was returned in a previous responsePageSize (number)
TableArn (string)
ListTablesProperties:
ExclusiveStartTableName (string)
LastEvaluatedTableName was returned in a previous responseLimit (number)
ListTagsOfResourceProperties:
NextToken (string)
NextToken was returned in a previous responseResourceArn (string) [required]
PutItemProperties:
TableName (string) [required]
Item (object) [required]
ConditionalOperator (string)
FilterExpression insteadConditionExpression (string)
Expected (object)
ConditionExpression insteadExpressionAttributeNames (object)
ExpressionAttributeValues (object)
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEReturnItemCollectionMetrics (string)
SIZE, or NONE (default)ReturnValues (string)
NONE (default), or ALL_OLDReturnValuesOnConditionCheckFailure (string)
NONE, or ALL_OLDQueryProperties:
TableName (string) [required]
AttributesToGet (array)
ProjectionExpression insteadConditionalOperator (string)
FilterExpression insteadConsistentRead (boolean)
ExclusiveStartKey (object)
LastEvaluatedKey was returned in a previous responseExpressionAttributeNames (object)
ExpressionAttributeValues (object)
FilterExpression (string)
IndexName (string)
KeyConditionExpression (string)
KeyConditions (object)
KeyConditionExpression insteadLimit (number)
ProjectionExpression (string)
QueryFilter (object)
FilterExpression insteadReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEScanIndexForward (boolean)
true (default) for ascending, false for descending orderSelect (string)
ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, COUNT, or SPECIFIC_ATTRIBUTESpaginate (boolean)
RestoreTableFromBackupProperties:
BackupArn (string) [required]
TargetTableName (string) [required]
BillingModeOverride (string)
PROVISIONED, or PAY_PER_REQUESTGlobalSecondaryIndexOverride (array)
LocalSecondaryIndexOverride (array)
ProvisionedThroughputOverride (object)
SSESpecificationOverride (object)
RestoreTableToPointInTimeProperties:
TargetTableName (string) [required]
BillingModeOverride (string)
PROVISIONED, or PAY_PER_REQUESTGlobalSecondaryIndexOverride (array)
LocalSecondaryIndexOverride (array)
ProvisionedThroughputOverride (object)
RestoreDateTime (number)
SourceTableArn (string)
SourceTableName (string)
SSESpecificationOverride (object)
UseLatestRestorableTime (boolean)
ScanProperties:
TableName (string) [required]
AttributesToGet (array)
ProjectionExpression insteadConditionalOperator (string)
FilterExpression insteadConsistentRead (boolean)
ExclusiveStartKey (object)
LastEvaluatedKey was returned in a previous responseExpressionAttributeNames (object)
ExpressionAttributeValues (object)
FilterExpression (string)
IndexName (string)
Limit (number)
ProjectionExpression (string)
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEScanFilter (object)
FilterExpression insteadSegment (number)
Scan requestSelect (string)
ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, COUNT, or SPECIFIC_ATTRIBUTESTotalSegments (number)
Scan requestpaginate (boolean)
TagResourceProperties:
ResourceArn (string) [required]
Tags (array) [required]
TransactGetItemsProperties:
TransactItems (array) [required]
TransactGetItem objects, each of which containing a Get objectReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONETransactWriteItemsProperties:
TransactItems (array) [required]
TransactWriteItem objects, each of which containing a ConditionCheck, Put, Update, or Delete objectClientRequestToken (string)
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEReturnItemCollectionMetrics (string)
SIZE, or NONE (default)UntagResourceProperties:
ResourceArn (string) [required]
TagKeys (array) [required]
UpdateContinuousBackupsProperties:
TableName (string) [required]
PointInTimeRecoverySpecification (object)
UpdateContributorInsightsProperties:
TableName (string) [required]
ContributorInsightsAction (string)
ENABLE or DISABLEIndexName (string)
UpdateGlobalTableProperties:
GlobalTableName (string) [required]
ReplicaUpdates (array)
UpdateGlobalTableSettingsProperties:
GlobalTableName (string) [required]
GlobalTableBillingMode (string)
PROVISIONED, or PAY_PER_REQUESTGlobalTableGlobalSecondaryIndexSettingsUpdate (array)
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate (object)
GlobalTableProvisionedWriteCapacityUnits (number)
ThrottlingExceptionReplicaSettingsUpdate (array)
UpdateItemProperties:
Key (object) [required]
TableName (string) [required]
AttributeUpdates (object)
UpdateExpression insteadConditionalOperator (string)
ConditionExpression insteadConditionExpression (string)
Expected (object)
ConditionExpression insteadExpressionAttributeNames (object)
ExpressionAttributeValues (object)
ReturnConsumedCapacity (string)
INDEXES, TOTAL, or NONEReturnItemCollectionMetrics (string)
SIZE, or NONE (default)ReturnValues (string)
NONE (default), ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEWReturnValuesOnConditionCheckFailure (string)
NONE, or ALL_OLDUpdateExpression (string)
UpdateTableProperties:
TableName (string) [required]
AttributeDefinitions (array)
BillingMode (string)
PROVISIONED, or PAY_PER_REQUESTDeletionProtectionEnabled (boolean)
GlobalSecondaryIndexUpdates (array)
Create, Update, or DeleteProvisionedThroughput (object)
ReplicaUpdates (array)
Create, Update, or DeleteSSESpecification (object)
StreamSpecification (object)
StreamEnabled (boolean), and StreamViewType (KEYS_ONLY, NEW_IMAGE, OLD_IMAGE, or NEW_AND_OLD_IMAGES)TableClass (string)
STANDARD, or STANDARD_INFREQUENT_ACCESSUpdateTableReplicaAutoScalingProperties:
TableName (string) [required]
GlobalSecondaryIndexUpdates (array)
ProvisionedWriteCapacityAutoScalingUpdate (object)
ReplicaUpdates (array)
UpdateTimeToLiveProperties:
TableName (string) [required]
TimeToLiveSpecification (object)
This plugin covers all DynamoDB methods (listed & linked below), utilizing DynamoDB's semantics.
By default, with the exception of certain legacy properties (noted below), this plugin will automatically (de)serialize AWS-flavored JSON in requests and responses, so you do not have to treat that as a concern.
Legacy properties (which DynamoDB discourages the use of) that will not be automatically (de)serialized:
DeleteItem.Expected,PutItem.Expected,Query.KeyConditions,Query.QueryFilter,Scan.ScanFilter,UpdateItem.Expected
import awsLite from '@aws-lite/client'
const aws = await awsLite()
// See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html
await aws.dynamodb.PutItem({
TableName: 'your-table-name',
Item: { id: 'hello', ts: new Date().toISOString() }
})
BatchExecuteStatementBatchGetItemBatchWriteItemCreateBackupCreateGlobalTableCreateTableDeleteBackupDeleteItemDeleteTableDescribeBackupDescribeContinuousBackupsDescribeContributorInsightsDescribeEndpointsDescribeExportDescribeGlobalTableDescribeGlobalTableSettingsDescribeImportDescribeKinesisStreamingDestinationDescribeLimitsDescribeTableDescribeTableReplicaAutoScalingDescribeTimeToLiveDisableKinesisStreamingDestinationEnableKinesisStreamingDestinationExecuteStatementExecuteTransactionExportTableToPointInTimeGetItemImportTableListBackupsListContributorInsightsListExportsListGlobalTablesListImportsListTablesListTagsOfResourcePutItemQueryRestoreTableFromBackupRestoreTableToPointInTimeScanTagResourceTransactGetItemsTransactWriteItemsUntagResourceUpdateContinuousBackupsUpdateContributorInsightsUpdateGlobalTableUpdateGlobalTableSettingsUpdateItemUpdateTableUpdateTableReplicaAutoScalingUpdateTimeToLiveFAQs
Official `aws-lite` plugin for DynamoDB
We found that @aws-lite/dynamodb demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.