Amazon DynamoDB · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon DynamoDB Items API

5 actions 5 updates phrasing extends openapi/amazon-dynamodb-items-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 5

$.info
$.paths['/#PutItem'].post
$.paths['/#GetItem'].post
$.paths['/#UpdateItem'].post
$.paths['/#DeleteItem'].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 Items API
  version: 1.0.0
extends: openapi/amazon-dynamodb-items-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: 4
- target: $.paths['/#PutItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Write or replace an item in a table
      effect: write
      questions:
      - How do I insert a new record into a DynamoDB table?
      - What happens if I put an item whose primary key already exists?
      - Can I only write the item when a condition holds, so I don't overwrite existing data?
      instructions:
      - text: Put item {item} into table {table_name}, replacing any item with the same key.
        slots:
          item: requestBody.Item
          table_name: requestBody.TableName
      - text: Write item {item} to {table_name} only if {condition}.
        slots:
          item: requestBody.Item
          table_name: requestBody.TableName
          condition: requestBody.ConditionExpression
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#GetItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch one item by its primary key
      effect: read
      questions:
      - How do I look up a single record in a table by its primary key?
      - Can I get a strongly consistent read of one item instead of an eventually consistent one?
      - What comes back when no item matches the key I asked for?
      instructions:
      - text: Get the item with key {key} from table {table_name}.
        slots:
          key: requestBody.Key
          table_name: requestBody.TableName
      - text: Fetch only the attributes {projection} of item {key} in {table_name}.
        slots:
          projection: requestBody.ProjectionExpression
          key: requestBody.Key
          table_name: requestBody.TableName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#UpdateItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit attributes on an existing item
      effect: write
      questions:
      - How do I change just a few attributes on an existing item without rewriting the whole thing?
      - Can I increment a counter or remove an attribute with an update expression?
      - Does updating a key that doesn't exist yet create the item?
      instructions:
      - text: Update item {key} in table {table_name} with expression {update_expression}.
        slots:
          key: requestBody.Key
          table_name: requestBody.TableName
          update_expression: requestBody.UpdateExpression
      - text: Change attributes on item {key} in {table_name} only if {condition}, and return the updated values.
        slots:
          key: requestBody.Key
          table_name: requestBody.TableName
          condition: requestBody.ConditionExpression
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#DeleteItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete one item by its primary key
      effect: destructive
      questions:
      - How do I remove a single record from a DynamoDB table?
      - Can I delete an item only if one of its attributes has an expected value?
      instructions:
      - text: Delete the item with key {key} from table {table_name}.
        slots:
          key: requestBody.Key
          table_name: requestBody.TableName
      - text: Remove item {key} from {table_name} only if {condition}.
        slots:
          key: requestBody.Key
          table_name: requestBody.TableName
          condition: requestBody.ConditionExpression
      method: generated
      generated: '2026-09-26'