ScanInput

ScanInput schema from Amazon DynamoDB API

DatabaseDocument StoreKey-ValueNoSQLServerless

Properties

Name	Type	Description
TableName	string	The name of the table to scan
IndexName	string	The name of a secondary index to scan
FilterExpression	string	A string that contains conditions for filtering the scan results
ProjectionExpression	string	A string that identifies attributes to retrieve
ExpressionAttributeNames	object	Substitution tokens for attribute names in an expression
ExpressionAttributeValues	object	Values that can be substituted in an expression
Limit	integer	The maximum number of items to evaluate
ConsistentRead	boolean	Determines the read consistency model
ExclusiveStartKey	object	The primary key of the first item that this operation evaluates
Segment	integer	For parallel scan, identifies the segment to be scanned
TotalSegments	integer	For parallel scan, the total number of segments
Select	string	The attributes to be returned in the result

View JSON Schema on GitHub

JSON Schema

{
  "$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-scan-input-schema.json",
  "title": "ScanInput",
  "description": "ScanInput schema from Amazon DynamoDB API",
  "type": "object",
  "properties": {
    "TableName": {
      "type": "string",
      "description": "The name of the table to scan"
    },
    "IndexName": {
      "type": "string",
      "description": "The name of a secondary index to scan"
    },
    "FilterExpression": {
      "type": "string",
      "description": "A string that contains conditions for filtering the scan results"
    },
    "ProjectionExpression": {
      "type": "string",
      "description": "A string that identifies attributes to retrieve"
    },
    "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"
      }
    },
    "Limit": {
      "type": "integer",
      "description": "The maximum number of items to evaluate",
      "minimum": 1
    },
    "ConsistentRead": {
      "type": "boolean",
      "description": "Determines the read consistency model"
    },
    "ExclusiveStartKey": {
      "type": "object",
      "description": "The primary key of the first item that this operation evaluates",
      "additionalProperties": {
        "$ref": "#/components/schemas/AttributeValue"
      }
    },
    "Segment": {
      "type": "integer",
      "description": "For parallel scan, identifies the segment to be scanned",
      "minimum": 0
    },
    "TotalSegments": {
      "type": "integer",
      "description": "For parallel scan, the total number of segments",
      "minimum": 1,
      "maximum": 1000000
    },
    "Select": {
      "type": "string",
      "description": "The attributes to be returned in the result",
      "enum": [
        "ALL_ATTRIBUTES",
        "ALL_PROJECTED_ATTRIBUTES",
        "COUNT",
        "SPECIFIC_ATTRIBUTES"
      ]
    }
  },
  "required": [
    "TableName"
  ]
}