Amazon DynamoDB · Schema

PutItemInput

PutItemInput schema from Amazon DynamoDB API

DatabaseDocument StoreKey-ValueNoSQLServerless

Properties

Name Type Description
TableName string The name of the table to contain the item
Item object A map of attribute name to attribute values, representing the item
ConditionExpression string A condition that must be satisfied for a put to succeed
ExpressionAttributeNames object Substitution tokens for attribute names in an expression
ExpressionAttributeValues object Values that can be substituted in an expression
ReturnValues string Determines the return values after the operation
View JSON Schema on GitHub

JSON Schema

dynamodb-openapi-put-item-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-dynamodb/refs/heads/main/json-schema/dynamodb-openapi-put-item-input-schema.json",
  "title": "PutItemInput",
  "description": "PutItemInput schema from Amazon DynamoDB API",
  "type": "object",
  "properties": {
    "TableName": {
      "type": "string",
      "description": "The name of the table to contain the item"
    },
    "Item": {
      "type": "object",
      "description": "A map of attribute name to attribute values, representing the item",
      "additionalProperties": {
        "$ref": "#/components/schemas/AttributeValue"
      }
    },
    "ConditionExpression": {
      "type": "string",
      "description": "A condition that must be satisfied for a put 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",
        "ALL_OLD"
      ]
    }
  },
  "required": [
    "TableName",
    "Item"
  ]
}