@aws-lite/dynamodb

公务 aws-lite dynamoDB 插件

由下列人员维护: @ architect

安装

npm i @aws-lite/dynamodb

可选安装类型 :

npm i -D @aws-lite/dynamodb-types

参考文献

在aws-lite.org提供实例参考文件

方法

BatchExecuteStatement

Canonical AWS API API 文档

属性 :

• Statements (阵) [需要]
  • 代表正在运行的批次的 PartiQL 语句阵列
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE

BatchGetItem

Canonical AWS API API 文档

属性 :

• RequestItems (对象)[需要]
  • 包含 QQ1 表格名称的对象,以及每个表格中描述 QQ1 项的对象
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE

BatchWriteItem

Canonical AWS API API 文档

属性 :

• RequestItems (对象)[需要]
  • 包含 QQ1 表格名称和每个表格中描述 QQ1 项的内容的对象
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ReturnItemCollectionMetrics (弦声)
  • 作为回应的返回收集指标可设定为: SIZE,或 NONE (默认)

CreateBackup

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• BackupName (弦) [须]
  • 指定备份的名称

CreateGlobalTable

Canonical AWS API API 文档

属性 :

• GlobalTableName (弦) [须]
  • DynamoDB 表格名称
• ReplicationGroup (阵) [需要]
  • AWS 需要创建全球表格的区域

CreateTable

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• AttributeDefinitions (阵) [需要]
  • 描述表格主( 和排序) 方案属性矩阵
• KeySchema (阵) [需要]
  • 构成表格或索引主要密钥的属性。 属性在 KeySchema 还必须在 AttributeDefinitions 数组
• BillingMode (弦声)
  • 设置表格中读取/写入吞吐量的方式 : PROVISIONED,或 PAY_PER_REQUEST
• DeletionProtectionEnabled (布尔)
  • 启用或禁用删除保护
• GlobalSecondaryIndexes (阵列)
  • 1-20个全球二级指数将立于桌面
  • 更详细情况( AWS)
• LocalSecondaryIndexes (阵列)
  • 1-5 拟在桌面上创建的本地二级指数
  • 更详细情况( AWS)
• ProvisionedThroughput (标 题)
  • 规定的吞吐量设定
• SSESpecification (标 题)
  • 服务器侧加密设置
• StreamSpecification (标 题)
  • 流的设置,包括: StreamEnabled (布尔),和 StreamViewType (单位:千美元)KEYS_ONLY, (中文(简体) ), NEW_IMAGE, (中文(简体) ), OLD_IMAGE,或 NEW_AND_OLD_IMAGES(中文(简体) )
• TableClass (弦声)
  • 表格的类别可设定为: STANDARD,或 STANDARD_INFREQUENT_ACCESS
• Tags (阵列)
  • 标签表格的对数组

DeleteBackup

Canonical AWS API API 文档

属性 :

• BackupArn (弦) [须]
  • 指定备份的 ARN

DeleteItem

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• Key (对象)[需要]
  • 有关项目的初级(和排序)密钥
• ConditionalOperator (弦声)
  • 遗留参数, 使用 FilterExpression 换成
• ConditionExpression (弦声)
  • 完成行动必须满足的条件
  • 更详细情况( AWS)
• Expected (标 题)
  • 遗留参数, 使用 ConditionExpression 换成
• ExpressionAttributeNames (标 题)
  • 在表达式中替换属性名称的符号
  • 更详细情况( AWS)
• ExpressionAttributeValues (标 题)
  • 在表达式中可被替换的值
  • 更详细情况( AWS)
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ReturnItemCollectionMetrics (弦声)
  • 作为回应的返回收集指标可设定为: SIZE,或 NONE (默认)
• ReturnValues (弦声)
  • 将操作前的物品归还,可以设定为 NONE (违约),或 ALL_OLD
• ReturnValuesOnConditionCheckFailure (弦声)
  • 返回失败的条件检查的项目属性, 可以设置为 NONE,或 ALL_OLD

DeleteTable

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称

DescribeBackup

Canonical AWS API API 文档

属性 :

• BackupArn (弦) [须]
  • 指定备份的 ARN

DescribeContinuousBackups

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称

DescribeContributorInsights

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• IndexName (弦声)
  • DynamoDB 全球二级索引名称(如果适用)

DescribeEndpoints

Canonical AWS API API 文档

属性 :

DescribeExport

Canonical AWS API API 文档

属性 :

• ExportArn (弦) [须]
  • 指定出口的 ARN

DescribeGlobalTable

Canonical AWS API API 文档

属性 :

• GlobalTableName (弦) [须]
  • DynamoDB 全球表格名称

DescribeGlobalTableSettings

Canonical AWS API API 文档

属性 :

• GlobalTableName (弦) [须]
  • DynamoDB 全球表格名称

DescribeImport

Canonical AWS API API 文档

属性 :

• ImportArn (弦) [须]
  • 指定的导入的 ARN

DescribeKinesisStreamingDestination

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称

DescribeLimits

Canonical AWS API API 文档

属性 :

DescribeTable

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称

DescribeTableReplicaAutoScaling

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称

DescribeTimeToLive

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称

DisableKinesisStreamingDestination

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• StreamArn (弦) [须]
  • 指定 Kinesis 数据流的 ARN

EnableKinesisStreamingDestination

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• StreamArn (弦) [须]
  • 指定 Kinesis 数据流的 ARN

ExecuteStatement

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• Statement (弦) [须]
  • 代表运行操作的PartiQL 语句
• ConsistentRead (布尔)
  • 启用强烈一致的读取; 默认情况下使用最终一致的读取
• Limit (数目)
  • 评价和返回的最大项目数
• NextToken (弦声)
  • 如果 NextToken 先前的答复中退回
• Parameters (阵列)
  • PartiQL 语句参数,如果有的话
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ReturnValuesOnConditionCheckFailure (弦声)
  • 返回失败的条件检查的项目属性, 可以设置为 NONE,或 ALL_OLD

ExecuteTransaction

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• TransactStatements (阵) [需要]
  • 代表要运行的交易的PartiQL 语句参数
• ClientRequestToken (弦声)
  • 如果 NextToken 先前的答复中退回
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE

ExportTableToPointInTime

Canonical AWS API API 文档

属性 :

• S3Bucket (弦) [须]
  • 快取导出的目标 S3 桶
• TableArn (弦) [须]
  • 导出表格的 ARN
• ClientToken (弦声)
  • 确保操作请求具有一能性
• ExportFormat (弦声)
  • 导出数据的格式可设定为: DYNAMODB_JSON,或 IO
• ExportTime (数目)
  • 导出表格数据的时间点( 以时代秒计)
• S3BucketOwner (弦声)
  • 拥有目的地 S3 桶的 AWS 账户 ID
• S3Prefix (弦声)
  • 用作导出快照的文件名和路径的 S3 桶前缀
• S3SseAlgorithm (弦声)
  • 用于存储导出数据的桶上的加密类型,可设定为 AES256,或 KMS
• S3SseKmsKeyId (弦声)
  • AWS KMS 管理用于加密目的地 S3 桶的密钥ID( 如果适用)

GetItem

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• Key (对象)[需要]
  • 有关项目的初级(和排序)密钥
• AttributesToGet (阵列)
  • 遗留参数, 使用 ProjectionExpression 换成
• ConsistentRead (布尔)
  • 启用强烈一致的读取; 默认情况下使用最终一致的读取
• ExpressionAttributeNames (标 题)
  • 在表达式中替换属性名称的符号
  • 更详细情况( AWS)
• ProjectionExpression (弦声)
  • 逗号分隔字符串,用于识别要从表格中获取的一个或多个属性
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE

ImportTable

Canonical AWS API API 文档

属性 :

• InputFormat (弦) [须]
  • 源数据格式,可设定为: CSV, (中文(简体) ), DYNAMODB_JSON,或 ION
• S3BucketSource (对象)[需要]
  • 快照导入的目标 S3 桶
• TableCreationParameters (对象)[需要]
  • 用于导入数据的表格参数
  • 更详细情况( AWS)
• ClientToken (弦声)
  • 确保操作请求具有一能性
• InputCompressionType (弦声)
  • 输入压缩类型,可以设置为: GZIP, (中文(简体) ), ZSTD,或 NONE
• InputFormatOptions (标 题)
  • 其他输入格式化选项

ListBackups

Canonical AWS API API 文档

属性 :

• BackupType (弦声)
  • 按类型限制备份,可以设置为: USER SYSTEM, (中文(简体) ), AWS_BACKUP,或 ALL
• ExclusiveStartBackupArn (弦声)
  • 相接光标符 ARN , 如果 LastEvaluatedBackupArn 先前的答复中退回
• Limit (数目)
  • 评价和返回的最大项目数
• TableName (弦声)
  • 按 DynamoDB 表格名称列出备份
• TimeRangeLowerBound (数目)
  • 包含在此之后创建的备份
• TimeRangeUpperBound (数目)
  • 完全返回此时之前创建的备份
• paginate (布尔,字符串)
  • 启用自动结果 pagination; 使用此选项, 而不是自制个人 pagination 请求

ListContributorInsights

Canonical AWS API API 文档

属性 :

• MaxResults (数目)
  • 评价和返回的最大项目数
• NextToken (弦声)
  • 如果 NextToken 先前的答复中退回
• TableName (弦声)
  • DynamoDB 表格名称

ListExports

Canonical AWS API API 文档

属性 :

• MaxResults (数目)
  • 评价和返回的最大项目数
• NextToken (弦声)
  • 如果 NextToken 先前的答复中退回
• TableArn (弦声)
  • 导出表格的 ARN

ListGlobalTables

Canonical AWS API API 文档

属性 :

• ExclusiveStartGlobalTableName (弦声)
  • 如果 LastEvaluatedGlobalTableName 先前的答复中退回
• Limit (数目)
  • 评价和返回的最大项目数
• RegionName (弦声)
  • 列出特定区域的全球表格

ListImports

Canonical AWS API API 文档

属性 :

• NextToken (弦声)
  • 如果 NextToken 先前的答复中退回
• PageSize (数目)
  • 评价和返回的最大项目数
• TableArn (弦声)
  • 导入表格的 ARN

ListTables

Canonical AWS API API 文档

属性 :

• ExclusiveStartTableName (弦声)
  • 如果 LastEvaluatedTableName 先前的答复中退回
• Limit (数目)
  • 评价和返回的最大项目数

ListTagsOfResource

Canonical AWS API API 文档

属性 :

• NextToken (弦声)
  • 如果 NextToken 先前的答复中退回
• ResourceArn (弦) [须]
  • 要返回的资源标记

PutItem

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• Item (对象)[需要]
  • 将写入 DynamoDB 的项目
• ConditionalOperator (弦声)
  • 遗留参数, 使用 FilterExpression 换成
• ConditionExpression (弦声)
  • 完成行动必须满足的条件
  • 更详细情况( AWS)
• Expected (标 题)
  • 遗留参数, 使用 ConditionExpression 换成
• ExpressionAttributeNames (标 题)
  • 在表达式中替换属性名称的符号
  • 更详细情况( AWS)
• ExpressionAttributeValues (标 题)
  • 在表达式中可被替换的值
  • 更详细情况( AWS)
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ReturnItemCollectionMetrics (弦声)
  • 作为回应的返回收集指标可设定为: SIZE,或 NONE (默认)
• ReturnValues (弦声)
  • 将操作前的物品归还,可以设定为 NONE (违约),或 ALL_OLD
• ReturnValuesOnConditionCheckFailure (弦声)
  • 返回失败的条件检查的项目属性, 可以设置为 NONE,或 ALL_OLD

Query

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• AttributesToGet (阵列)
  • 遗留参数, 使用 ProjectionExpression 换成
• ConditionalOperator (弦声)
  • 遗留参数, 使用 FilterExpression 换成
• ConsistentRead (布尔)
  • 启用强烈一致的读取; 默认情况下使用最终一致的读取
• ExclusiveStartKey (标 题)
  • 相接光标符 ARN , 如果 LastEvaluatedKey 先前的答复中退回
• ExpressionAttributeNames (标 题)
  • 在表达式中替换属性名称的符号
  • 更详细情况( AWS)
• ExpressionAttributeValues (标 题)
  • 在表达式中可被替换的值
  • 更详细情况( AWS)
• FilterExpression (弦声)
  • 返回数据前使用的过滤条件字符串
  • 更详细情况( AWS)
• IndexName (弦声)
  • DynamoDB 全球二级索引名称(如果适用)
• KeyConditionExpression (弦声)
  • 指定要检索项目的关键值的条件; 条件必须在单个分区密钥值上进行等值测试
  • 更详细情况( AWS)
• KeyConditions (标 题)
  • 遗留参数, 使用 KeyConditionExpression 换成
• Limit (数目)
  • 评价和返回的最大项目数
• ProjectionExpression (弦声)
  • 逗号分隔字符串,用于识别要从表格中获取的一个或多个属性
• QueryFilter (标 题)
  • 遗留参数, 使用 FilterExpression 换成
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ScanIndexForward (布尔)
  • 索引倒转顺序 : true 以至升天的时候, false 降序顺序
• Select (弦声)
  • 在结果中返回的属性可设定为: ALL_ATTRIBUTES, (中文(简体) ), ALL_PROJECTED_ATTRIBUTES, (中文(简体) ), COUNT,或 SPECIFIC_ATTRIBUTES
  • 更详细情况( AWS)
• paginate (布尔,字符串)
  • 启用自动结果 pagination; 使用此选项, 而不是自制个人 pagination 请求

RestoreTableFromBackup

Canonical AWS API API 文档

属性 :

• BackupArn (弦) [须]
  • 指定备份的 ARN
• TargetTableName (弦) [须]
  • 恢复备份的新表格名称
• BillingModeOverride (弦声)
  • 设置表格中读取/写入吞吐量的方式 : PROVISIONED,或 PAY_PER_REQUEST
• GlobalSecondaryIndexOverride (阵列)
  • 恢复表的全球二级指数清单;包括的指数应与现有的二级指数相匹配,尽管可以排除指数
• LocalSecondaryIndexOverride (阵列)
  • 恢复表的本地二级指数清单;包括的指数应与现有的二级指数相匹配,尽管可以排除指数
• ProvisionedThroughputOverride (标 题)
  • 规定的吞吐量设定
• SSESpecificationOverride (标 题)
  • 服务器侧加密设置

RestoreTableToPointInTime

Canonical AWS API API 文档

属性 :

• TargetTableName (弦) [须]
  • 恢复备份的新表格名称
• BillingModeOverride (弦声)
  • 设置表格中读取/写入吞吐量的方式 : PROVISIONED,或 PAY_PER_REQUEST
• GlobalSecondaryIndexOverride (阵列)
  • 恢复表的全球二级指数清单;包括的指数应与现有的二级指数相匹配,尽管可以排除指数
• LocalSecondaryIndexOverride (阵列)
  • 恢复表的本地二级指数清单;包括的指数应与现有的二级指数相匹配,尽管可以排除指数
• ProvisionedThroughputOverride (标 题)
  • 规定的吞吐量设定
• RestoreDateTime (数目)
  • 过去将表格恢复到
• SourceTableArn (弦声)
  • 指定备份的 ARN
• SourceTableName (弦声)
  • 恢复源表格的名称
• SSESpecificationOverride (标 题)
  • 服务器侧加密设置
• UseLatestRestorableTime (布尔)
  • 恢复到最近可能的时间;通常在目前时间之前5分钟

Scan

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• AttributesToGet (阵列)
  • 遗留参数, 使用 ProjectionExpression 换成
• ConditionalOperator (弦声)
  • 遗留参数, 使用 FilterExpression 换成
• ConsistentRead (布尔)
  • 启用强烈一致的读取; 默认情况下使用最终一致的读取
• ExclusiveStartKey (标 题)
  • 相接光标符 ARN , 如果 LastEvaluatedKey 先前的答复中退回
• ExpressionAttributeNames (标 题)
  • 在表达式中替换属性名称的符号
  • 更详细情况( AWS)
• ExpressionAttributeValues (标 题)
  • 在表达式中可被替换的值
  • 更详细情况( AWS)
• FilterExpression (弦声)
  • 返回数据前使用的过滤条件字符串
  • 更详细情况( AWS)
• IndexName (弦声)
  • DynamoDB 全球二级索引名称(如果适用)
• Limit (数目)
  • 评价和返回的最大项目数
• ProjectionExpression (弦声)
  • 逗号分隔字符串,用于识别要从表格中获取的一个或多个属性
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ScanFilter (标 题)
  • 遗留参数, 使用 FilterExpression 换成
• Segment (数目)
  • 需平行扫描的单个部分 Scan 请求
  • 更详细情况( AWS)
• Select (弦声)
  • 在结果中返回的属性可设定为: ALL_ATTRIBUTES, (中文(简体) ), ALL_PROJECTED_ATTRIBUTES, (中文(简体) ), COUNT,或 SPECIFIC_ATTRIBUTES
  • 更详细情况( AWS)
• TotalSegments (数目)
  • 平行扫描的片段总数 Scan 请求
  • 更详细情况( AWS)
• paginate (布尔,字符串)
  • 启用自动结果 pagination; 使用此选项, 而不是自制个人 pagination 请求

TagResource

Canonical AWS API API 文档

属性 :

• ResourceArn (弦) [须]
  • 要添加标签的资源
• Tags (阵) [需要]
  • 要指定的标记

TransactGetItems

Canonical AWS API API 文档

属性 :

• TransactItems (阵) [需要]
  • 订购最多100个阵列 TransactGetItem 对象,每个对象包含一个 Get 对象
  • 更详细情况( AWS)
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE

TransactWriteItems

Canonical AWS API API 文档

属性 :

• TransactItems (阵) [需要]
  • 订购最多100个阵列 TransactWriteItem 对象,每个对象包含一个 ConditionCheck, (中文(简体) ), Put, (中文(简体) ), Update,或 Delete 对象
  • 更详细情况( AWS)
• ClientRequestToken (弦声)
  • 确保操作请求具有一能性
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ReturnItemCollectionMetrics (弦声)
  • 作为回应的返回收集指标可设定为: SIZE,或 NONE (默认)

UntagResource

Canonical AWS API API 文档

属性 :

• ResourceArn (弦) [须]
  • 删除标签的资源
• TagKeys (阵) [需要]
  • 要删除的标记

UpdateContinuousBackups

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• PointInTimeRecoverySpecification (标 题)
  • 时间恢复设置中的点
  • 更详细情况( AWS)

UpdateContributorInsights

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• ContributorInsightsAction (弦声)
  • 贡献者的洞察力行动可确定为: ENABLE 或者说 DISABLE
• IndexName (弦声)
  • DynamoDB 全球二级索引名称(如果适用)

UpdateGlobalTable

Canonical AWS API API 文档

属性 :

• GlobalTableName (弦) [须]
  • DynamoDB 全球表格名称
• ReplicaUpdates (阵列)
  • 从全球表格中增列或删除的区域清单

UpdateGlobalTableSettings

Canonical AWS API API 文档

属性 :

• GlobalTableName (弦) [须]
  • DynamoDB 全球表格名称
• GlobalTableBillingMode (弦声)
  • 设置表格中读取/写入吞吐量的方式 : PROVISIONED,或 PAY_PER_REQUEST
• GlobalTableGlobalSecondaryIndexSettingsUpdate (阵列)
  • 1-20个全球二级指数有待修改
  • 更详细情况( AWS)
• GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate (标 题)
  • 用于管理提供书写能力的自动缩放设置
  • 更详细情况( AWS)
• GlobalTableProvisionedWriteCapacityUnits (数目)
  • 返回前每秒最大写数a ThrottlingException
• ReplicaSettingsUpdate (阵列)
  • 要修改的全局表格设置
  • 更详细情况( AWS)

UpdateItem

Canonical AWS API API 文档

属性 :

• Key (对象)[需要]
  • 有关项目的初级(和排序)密钥
• TableName (弦) [须]
  • DynamoDB 表格名称
• AttributeUpdates (标 题)
  • 遗留参数, 使用 UpdateExpression 换成
• ConditionalOperator (弦声)
  • 遗留参数, 使用 ConditionExpression 换成
• ConditionExpression (弦声)
  • 完成行动必须满足的条件
  • 更详细情况( AWS)
• Expected (标 题)
  • 遗留参数, 使用 ConditionExpression 换成
• ExpressionAttributeNames (标 题)
  • 在表达式中替换属性名称的符号
  • 更详细情况( AWS)
• ExpressionAttributeValues (标 题)
  • 在表达式中可被替换的值
  • 更详细情况( AWS)
• ReturnConsumedCapacity (弦声)
  • 作为回应的回流吞吐量消耗可被设定为: INDEXES, (中文(简体) ), TOTAL,或 NONE
• ReturnItemCollectionMetrics (弦声)
  • 作为回应的返回收集指标可设定为: SIZE,或 NONE (默认)
• ReturnValues (弦声)
  • 将操作前的物品归还,可以设定为 NONE (违约), ALL_OLD, (中文(简体) ), UPDATED_OLD, (中文(简体) ), ALL_NEW, (中文(简体) ), UPDATED_NEW
• ReturnValuesOnConditionCheckFailure (弦声)
  • 返回失败的条件检查的项目属性, 可以设置为 NONE,或 ALL_OLD
• UpdateExpression (弦声)
  • 定义要更新的属性的表达式、 要对每个属性采取的行动及其新值
  • 更详细情况( AWS)

UpdateTable

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• AttributeDefinitions (阵列)
  • 描述表格主( 和排序) 方案属性矩阵
• BillingMode (弦声)
  • 设置表格中读取/写入吞吐量的方式 : PROVISIONED,或 PAY_PER_REQUEST
• DeletionProtectionEnabled (布尔)
  • 启用或禁用删除保护
• GlobalSecondaryIndexUpdates (阵列)
  • 全球二级指数更新,每次更新可以是: Create, (中文(简体) ), Update,或 Delete
  • 更详细情况( AWS)
• ProvisionedThroughput (标 题)
  • 规定的吞吐量设定
• ReplicaUpdates (阵列)
  • 表格复制更新,每个更新可以是: Create, (中文(简体) ), Update,或 Delete
  • 更详细情况( AWS)
• SSESpecification (标 题)
  • 服务器侧加密设置
• StreamSpecification (标 题)
  • 流的设置,包括: StreamEnabled (布尔),和 StreamViewType (单位:千美元)KEYS_ONLY, (中文(简体) ), NEW_IMAGE, (中文(简体) ), OLD_IMAGE,或 NEW_AND_OLD_IMAGES(中文(简体) )
• TableClass (弦声)
  • 表格的类别可设定为: STANDARD,或 STANDARD_INFREQUENT_ACCESS

UpdateTableReplicaAutoScaling

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• GlobalSecondaryIndexUpdates (阵列)
  • 复制品全球二级索引的自动缩放设置
  • 更详细情况( AWS)
• ProvisionedWriteCapacityAutoScalingUpdate (标 题)
  • 全局表格或全局二级索引的自动缩放设置
  • 更详细情况( AWS)
• ReplicaUpdates (阵列)
  • 自动=表格复制件的缩放设置
  • 更详细情况( AWS)

UpdateTimeToLive

Canonical AWS API API 文档

属性 :

• TableName (弦) [须]
  • DynamoDB 表格名称
• TimeToLiveSpecification (标 题)
  • 指定表格的 TTL 设置

使用量

这个插件涵盖了所有的DynamoDB方法(下面列出和链接),使用DynamoDB的语义.

默认情况下,除了某些遗留属性(以下注出)外,这个插件会在请求和响应中自动(去)将AWS-flavorored JSON进行序列化,所以你不必将此作为关注.

(DynamoDB不鼓励使用)不会自动(去)序列化的后遗症属性: 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() }
})

迪纳摩DB方法

• BatchExecuteStatement
• BatchGetItem
• BatchWriteItem
• CreateBackup
• CreateGlobalTable
• CreateTable
• DeleteBackup
• DeleteItem
• DeleteTable
• DescribeBackup
• DescribeContinuousBackups
• DescribeContributorInsights
• DescribeEndpoints
• DescribeExport
• DescribeGlobalTable
• DescribeGlobalTableSettings
• DescribeImport
• DescribeKinesisStreamingDestination
• DescribeLimits
• DescribeTable
• DescribeTableReplicaAutoScaling
• DescribeTimeToLive
• DisableKinesisStreamingDestination
• EnableKinesisStreamingDestination
• ExecuteStatement
• ExecuteTransaction
• ExportTableToPointInTime
• GetItem
• ImportTable
• ListBackups
• ListContributorInsights
• ListExports
• ListGlobalTables
• ListImports
• ListTables
• ListTagsOfResource
• PutItem
• Query
• RestoreTableFromBackup
• RestoreTableToPointInTime
• Scan
• TagResource
• TransactGetItems
• TransactWriteItems
• UntagResource
• UpdateContinuousBackups
• UpdateContributorInsights
• UpdateGlobalTable
• UpdateGlobalTableSettings
• UpdateItem
• UpdateTable
• UpdateTableReplicaAutoScaling
• UpdateTimeToLive

学多点

• 更多关于 aws-lite 插件 API
• 学着如何促进这个和其他 aws-lite 插件