Amazon DynamoDB · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon DynamoDB Tables API

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

$.info
$.paths['/'].post
$.paths['/#DescribeTable'].post
$.paths['/#ListTables'].post
$.paths['/#UpdateTable'].post
$.paths['/#DeleteTable'].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 Tables API
  version: 1.0.0
extends: openapi/amazon-dynamodb-tables-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: 5
- target: $.paths['/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new DynamoDB table
      effect: write
      questions:
      - How do I create a new table in DynamoDB with a partition key and sort key?
      - Can I add global or local secondary indexes when I first create a table?
      - Which billing mode should I set when creating a table, on-demand or provisioned throughput?
      instructions:
      - text: Create a table named {table_name} with key schema {key_schema}.
        slots:
          table_name: requestBody.TableName
          key_schema: requestBody.KeySchema
      - text: Create table {table_name} using attribute definitions {attributes} and billing mode {billing_mode}.
        slots:
          table_name: requestBody.TableName
          attributes: requestBody.AttributeDefinitions
          billing_mode: requestBody.BillingMode
      - text: Create a new table {table_name} tagged {tags}.
        slots:
          table_name: requestBody.TableName
          tags: requestBody.Tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#DescribeTable'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a table's status, key schema and indexes
      effect: read
      questions:
      - Is my DynamoDB table still being created, or is it active yet?
      - What primary key schema and indexes does an existing table have?
      - When was a particular table created?
      instructions:
      - text: Describe the table {table_name}.
        slots:
          table_name: requestBody.TableName
      - text: Show me the current status and indexes of table {table_name}.
        slots:
          table_name: requestBody.TableName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#ListTables'].post
  update:
    x-apievangelist-phrasing:
      intent: List the tables in my account
      effect: read
      questions:
      - What tables do I have in this account and Region?
      - Can I page through my table names a few at a time?
      instructions:
      - text: List all my DynamoDB table names.
      - text: List up to {limit} table names starting after {start_table}.
        slots:
          limit: requestBody.Limit
          start_table: requestBody.ExclusiveStartTableName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#UpdateTable'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a table's throughput, billing or indexes
      effect: write
      questions:
      - How do I raise the provisioned read and write capacity on an existing table?
      - Can I add or remove a global secondary index on a table that already exists?
      - Is it possible to switch an existing table to a different billing mode?
      instructions:
      - text: Change the provisioned throughput of table {table_name} to {throughput}.
        slots:
          table_name: requestBody.TableName
          throughput: requestBody.ProvisionedThroughput
      - text: Switch existing table {table_name} to billing mode {billing_mode}.
        slots:
          table_name: requestBody.TableName
          billing_mode: requestBody.BillingMode
      - text: Apply global secondary index changes {index_updates} to table {table_name}.
        slots:
          index_updates: requestBody.GlobalSecondaryIndexUpdates
          table_name: requestBody.TableName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/#DeleteTable'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a table and all its items
      effect: destructive
      questions:
      - How do I permanently drop a DynamoDB table along with its data?
      - What state is a table in right after I ask for it to be deleted?
      instructions:
      - text: Delete the table {table_name} and everything in it.
        slots:
          table_name: requestBody.TableName
      - text: Drop table {table_name}.
        slots:
          table_name: requestBody.TableName
      method: generated
      generated: '2026-09-26'