Document search
POST/search
Document search query request;
Supports searching DynamoDB for document(s) by a single TAG key and/or value. Value can be "exacted" or "begins_with" matched. Search can be filtered to only check certain documentIds (up to 100 documentIds accepted).
If using Enteprise Composite Keys feature then multiple tag(s) can be searched for.
For attributes defined with dataType JSON, use an attribute criterion's json filter with a path to compare a nested field. The eq and eqOr operators accept strings, including inside json filters. Match JSON boolean fields using the strings "true" or "false". Compare JSON numeric fields using gt, gte, lt, and lte. Paths support object properties and explicit array positions; wildcard, recursive, and array any-element matching are not supported. Multiple conditions on different paths under the same attribute key are supported. All conditions must match the same document or artifact.
JSON path filtering is applied after candidate records are read and does not reduce read capacity consumed for those candidates. A stored JSON value does not automatically create an index for its nested fields. Continue through empty filtered pages until the next token is absent; candidate and time-budget limits still apply.
If Typesense is enabled, full text search is supported through the "text" parameter. Full text search will look for the text in the "content" and/or document "metadata".
When documentIds is supplied, all supplied IDs are checked against the search criteria and all matching documents are returned. The limit query parameter is ignored. Up to 100 document IDs are accepted.
Use the projection parameter to return matching documents or a count of matching documents. Count responses are capped at 10,000 and indicate when the count was truncated.
Multi-attribute searches requiring additional attribute filtering use a 25-second processing budget
for index batches, attribute filtering, and document loading. The budget starts after index selection and empty-index prechecks. Searches with explicit
documentIds or a composite key covering every search attribute are exempt.
The budget is checked before starting each read; an in-flight read is allowed to finish.
If the budget expires, document searches return completed matches with truncated=true and a next token;
count searches return a partial lower bound with truncated=true.
See requestBody examples below for commmon examples.
Request
Responses
- 200
- 400
200 OK
Response Headers
Invalid attribute search value, JSON path, or operator combination.