Amazon DynamoDB · JSON Structure

Dynamodb Openapi Get Item Input Structure

GetItemInput schema from Amazon DynamoDB API

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

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

Properties

TableName Key ProjectionExpression ConsistentRead ExpressionAttributeNames

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-get-item-input-structure.json",
  "name": "GetItemInput",
  "description": "GetItemInput schema from Amazon DynamoDB API",
  "type": "object",
  "properties": {
    "TableName": {
      "type": "string",
      "description": "The name of the table containing the requested item"
    },
    "Key": {
      "type": "object",
      "description": "A map of attribute names to AttributeValue objects for the primary key",
      "additionalProperties": {
        "$ref": "#/components/schemas/AttributeValue"
      }
    },
    "ProjectionExpression": {
      "type": "string",
      "description": "A string that identifies attributes to retrieve"
    },
    "ConsistentRead": {
      "type": "boolean",
      "description": "Determines the read consistency model"
    },
    "ExpressionAttributeNames": {
      "type": "object",
      "description": "Substitution tokens for attribute names in an expression",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "TableName",
    "Key"
  ]
}