Amazon DynamoDB · Schema

GetItemInput

GetItemInput schema from Amazon DynamoDB API

DatabaseDocument StoreKey-ValueNoSQLServerless

Properties

Name Type Description
TableName string The name of the table containing the requested item
Key object A map of attribute names to AttributeValue objects for the primary key
ProjectionExpression string A string that identifies attributes to retrieve
ConsistentRead boolean Determines the read consistency model
ExpressionAttributeNames object Substitution tokens for attribute names in an expression
View JSON Schema on GitHub

JSON Schema

dynamodb-openapi-get-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-get-item-input-schema.json",
  "title": "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"
  ]
}