Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Update

Represents a request to perform an UpdateItem operation.

Hierarchy

  • Update

Index

Properties

Optional ConditionExpression

ConditionExpression: undefined | string

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

Optional ExpressionAttributeNames

ExpressionAttributeNames: Record<string, string>

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

Optional ExpressionAttributeValues

ExpressionAttributeValues: Record<string, AttributeValue>

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

Key

Key: Record<string, AttributeValue> | undefined

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

Optional ReturnValuesOnConditionCheckFailure

ReturnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailure | string

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.

TableName

TableName: string | undefined

Name of the table for the UpdateItem request.

UpdateExpression

UpdateExpression: string | undefined

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.