ScanInput is a JSON Structure definition published by Amazon DynamoDB, describing 12 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-dynamodb/refs/heads/main/json-structure/dynamodb-openapi-scan-input-structure.json",
"name": "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": "int32",
"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": "int32",
"description": "For parallel scan, identifies the segment to be scanned",
"minimum": 0
},
"TotalSegments": {
"type": "int32",
"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"
]
}