Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • UpdateExpressionDefinitionChain

Index

Properties

add

add: function

adds or manipulates a value to an attribute of type N(umber) or S(et), manipulation behaviour differs based on attribute type

param

--update-expression "ADD QuantityOnHand :q" \ --expression-attribute-values '{":q": {"N": "5"}}' \

--update-expression "ADD Color :c" \ --expression-attribute-values '{":c": {"SS":["Orange", "Purple"]}}' \

Type declaration

appendToList

appendToList: function

appends one or more values to the start or end of a list, value must be of type L(ist)

Type declaration

decrementBy

decrementBy: function

Type declaration

incrementBy

incrementBy: function

Type declaration

remove

remove: function

removeFromListAt

removeFromListAt: function

removes an item at the given position(s), the remaining elements are shifted

Type declaration

removeFromSet

removeFromSet: function
param
returns

--update-expression "DELETE Color :p" \ --expression-attribute-values '{":p": {"SS": ["Yellow", "Purple"]}}'

Type declaration

set

set: function

will update the item at the path, path can be a top level atribute or a nested attribute. samples:

  • persons.age
  • places[0].address.street

Type declaration

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc