---
title: "Dynamo-like API interface"
method: POST
path: "/_api/dynamo"
tags: ["Dynamo"]
---

# Dynamo-like API interface

`POST /_api/dynamo`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/dynamo/post.ts> (a function with typed inputs; its response is checked against the schema)

Dynamo-like API interface.

Set your JWT token or APIKEY as a aws_access_key_id (ex. '*bearer XXXXX*' or '*apikey XXXXX*').

Currently supported Dynamo actions (set as *'x-amz-target'* header tag):

  - **CreateTable**
  - **CreateGlobalTable**
  - **DeleteItem**
  - **DeleteTable**
  - **DescribeGlobalTable**
  - **DescribeTable**
  - **DescribeTimeToLive**
  - **GetItem**
  - **ListGlobalTables**
  - **ListTables**
  - **PutItem**
  - **Query**
  - **UpdateItem**
  - **UpdateTable**
  - **UpdateTimeToLive**
  - **Scan**
  - **BatchGetItem**
  - **BatchWriteItem**

## Headers

- `x-amz-target` string, string, required

## Request body

- object
  - `AttributeDefinitions` object[]
    - `AttributeName` string
    - `AttributeType` string
  - `TableName` string
  - `KeySchema` object[]
    - `AttributeName` string
    - `KeyType` string
  - `ProvisionedThroughput` object
    - `ReadCapacityUnits` number
    - `WriteCapacityUnits` number

## Response `200`

Successfully returned after execution.

- object
  - `code` integer: HTTP response code.
  - `error` boolean: Flag if there is an error in response. *False* for this response.
  - `result` object: Result is based on Dynamo actions given in JSON body.
    - `TableDescription` object
      - `AttributeDefinitions` object[]
        - `AttributeName` string
        - `AttributeType` string
      - `TableName` string
      - `KeySchema` object[]
        - `AttributeName` string
        - `KeyType` string
      - `TableStatus` string
      - `CreationDateTime` number
      - `TableSizeBytes` number
      - `ItemCount` number

## Other responses

- `400`: Failed due to missing or malformed data. Verify that all parameters are complete.

---

[API](https://skmtc.dev/macrometa/apis/macrometa-api-reference.md) - [All operations](https://skmtc.dev/macrometa/apis/macrometa-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/macrometa/apis/macrometa-api-reference/revisions/2006b6d7f31d?raw)