Amazon DynamoDB · JSON Structure

Dynamodb Openapi Update Item Input Structure

UpdateItemInput schema from Amazon DynamoDB API

Type: object Properties: 7 Required: 2
DatabaseDocument StoreKey-ValueNoSQLServerless

UpdateItemInput is a JSON Structure definition published by Amazon DynamoDB, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

TableName Key UpdateExpression ConditionExpression ExpressionAttributeNames ExpressionAttributeValues ReturnValues

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-dynamodb/refs/heads/main/json-structure/dynamodb-openapi-update-item-input-structure.json",
  "name": "UpdateItemInput",
  "description": "UpdateItemInput schema from Amazon DynamoDB API",
  "type": "object",
  "properties": {
    "TableName": {
      "type": "string",
      "description": "The name of the table containing the item to update"
    },
    "Key": {
      "type": "object",
      "description": "The primary key of the item to be updated",
      "additionalProperties": {
        "$ref": "#/components/schemas/AttributeValue"
      }
    },
    "UpdateExpression": {
      "type": "string",
      "description": "An expression that defines attributes to be updated"
    },
    "ConditionExpression": {
      "type": "string",
      "description": "A condition that must be satisfied for the update to succeed"
    },
    "ExpressionAttributeNames": {
      "type": "object",
      "description": "Substitution tokens for attribute names in an expression",
      "additionalProperties": {
        "type": "string"
      }
    },
    "ExpressionAttributeValues": {
      "type": "object",
      "description": "Values that can be substituted in an expression",
      "additionalProperties": {
        "$ref": "#/components/schemas/AttributeValue"
      }
    },
    "ReturnValues": {
      "type": "string",
      "description": "Determines the return values after the operation",
      "enum": [
        "NONE",
        "UPDATED_OLD",
        "ALL_OLD",
        "UPDATED_NEW",
        "ALL_NEW"
      ]
    }
  },
  "required": [
    "TableName",
    "Key"
  ]
}