Amazon DynamoDB · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon DynamoDB Transactions API

3 actions 3 updates phrasing extends openapi/amazon-dynamodb-transactions-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['/#TransactGetItems'].post

$.paths['/#TransactWriteItems'].post

OpenAPI Overlay

# 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 Transactions API
  version: 1.0.0
extends: openapi/amazon-dynamodb-transactions-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['/#TransactGetItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Read several items atomically
      effect: read
      questions:
      - How do I read several items as one consistent, all-or-nothing snapshot?
      - How many Get actions can one transactional read include?
      instructions:
      - text: 'Read these items in a single transaction: {transact_items}.'
        slots:
          transact_items: requestBody.TransactItems
      - text: Atomically fetch the items {transact_items} from across my tables.
        slots:
          transact_items: requestBody.TransactItems
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#TransactWriteItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Write several items atomically
      effect: write
      questions:
      - How do I make several writes succeed or fail together across tables?
      - Can I retry a transactional write safely without applying it twice?
      - What's the maximum number of actions in one all-or-nothing write?
      instructions:
      - text: 'Apply these writes as one atomic transaction: {transact_items}.'
        slots:
          transact_items: requestBody.TransactItems
      - text: Run transactional write {transact_items} with idempotency token {token}.
        slots:
          transact_items: requestBody.TransactItems
          token: requestBody.ClientRequestToken
      method: generated
      generated: '2026-09-26'