Amazon DynamoDB · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon DynamoDB Queries API

3 actions 3 updates phrasing extends openapi/amazon-dynamodb-queries-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon DynamoDB's API. It is a proposal applied on top of the contract, not a document Amazon DynamoDB publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/#Query'].post
$.paths['/#Scan'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon DynamoDB Queries API
  version: 1.0.0
extends: openapi/amazon-dynamodb-queries-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/#Query'].post
  update:
    x-apievangelist-phrasing:
      intent: Find items by partition key value
      effect: read
      questions:
      - How do I get all items that share one partition key value?
      - Can I query a secondary index instead of the base table?
      - Is there a way to return query results newest-first by sort key?
      - Which items for a given key match an extra filter on non-key attributes?
      instructions:
      - text: Query table {table_name} for items where {key_condition}.
        slots:
          table_name: requestBody.TableName
          key_condition: requestBody.KeyConditionExpression
      - text: Query index {index_name} on {table_name} with key condition {key_condition}.
        slots:
          index_name: requestBody.IndexName
          table_name: requestBody.TableName
          key_condition: requestBody.KeyConditionExpression
      - text: Query {table_name} by {key_condition}, keep only items where {filter}, at most {limit} evaluated.
        slots:
          table_name: requestBody.TableName
          key_condition: requestBody.KeyConditionExpression
          filter: requestBody.FilterExpression
          limit: requestBody.Limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#Scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Read every item in a table or index
      effect: read
      questions:
      - How do I read through every item in a table without knowing the keys?
      - Can I split a full-table scan into parallel segments to go faster?
      - What's the way to filter a scan down to items matching some attribute condition?
      instructions:
      - text: Scan the whole table {table_name}.
        slots:
          table_name: requestBody.TableName
      - text: Scan {table_name} and return only items where {filter}.
        slots:
          table_name: requestBody.TableName
          filter: requestBody.FilterExpression
      - text: Scan segment {segment} of {total_segments} of table {table_name} in parallel.
        slots:
          segment: requestBody.Segment
          total_segments: requestBody.TotalSegments
          table_name: requestBody.TableName
      method: generated
      generated: '2026-09-26'