QueryInput

CloudDatabaseDocument StoreKey-ValueManaged ServiceNoSQLServerless

Properties

Name	Type	Description
TableName	string	The name of the table containing the requested items
IndexName	string	The name of a secondary index to query
KeyConditionExpression	string	The condition that specifies the key values for items to be retrieved by the Query action. Must specify the partition key name and value as an equality condition.
FilterExpression	string	A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned
ProjectionExpression	string	A string that identifies attributes to retrieve from the table
ExpressionAttributeNames	object
ExpressionAttributeValues	object
Select	string	The attributes to be returned in the result
ScanIndexForward	boolean	If true (default), the traversal is performed in ascending order; if false, in descending order
Limit	integer	The maximum number of items to evaluate
ConsistentRead	boolean	Whether to use strongly consistent reads
ExclusiveStartKey	object	The primary key of the first item for this query to evaluate
ReturnConsumedCapacity	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "QueryInput",
  "type": "object",
  "properties": {
    "TableName": {
      "type": "string",
      "description": "The name of the table containing the requested items"
    },
    "IndexName": {
      "type": "string",
      "description": "The name of a secondary index to query"
    },
    "KeyConditionExpression": {
      "type": "string",
      "description": "The condition that specifies the key values for items to be retrieved by the Query action. Must specify the partition key name and value as an equality condition."
    },
    "FilterExpression": {
      "type": "string",
      "description": "A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned"
    },
    "ProjectionExpression": {
      "type": "string",
      "description": "A string that identifies attributes to retrieve from the table"
    },
    "ExpressionAttributeNames": {
      "type": "object"
    },
    "ExpressionAttributeValues": {
      "type": "object"
    },
    "Select": {
      "type": "string",
      "description": "The attributes to be returned in the result"
    },
    "ScanIndexForward": {
      "type": "boolean",
      "description": "If true (default), the traversal is performed in ascending order; if false, in descending order"
    },
    "Limit": {
      "type": "integer",
      "description": "The maximum number of items to evaluate"
    },
    "ConsistentRead": {
      "type": "boolean",
      "description": "Whether to use strongly consistent reads"
    },
    "ExclusiveStartKey": {
      "type": "object",
      "description": "The primary key of the first item for this query to evaluate"
    },
    "ReturnConsumedCapacity": {
      "type": "string"
    }
  }
}