Amazon DynamoDB · JSON Structure

Dynamodb Openapi Table Description Structure

Represents the properties of a DynamoDB table

Type: object Properties: 13
DatabaseDocument StoreKey-ValueNoSQLServerless

TableDescription is a JSON Structure definition published by Amazon DynamoDB, describing 13 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

TableName TableStatus TableArn TableId CreationDateTime KeySchema AttributeDefinitions ProvisionedThroughput TableSizeBytes ItemCount GlobalSecondaryIndexes LocalSecondaryIndexes BillingModeSummary

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-dynamodb/refs/heads/main/json-structure/dynamodb-openapi-table-description-structure.json",
  "name": "TableDescription",
  "description": "Represents the properties of a DynamoDB table",
  "type": "object",
  "properties": {
    "TableName": {
      "type": "string",
      "description": "The name of the table"
    },
    "TableStatus": {
      "type": "string",
      "description": "The current state of the table",
      "enum": [
        "CREATING",
        "UPDATING",
        "DELETING",
        "ACTIVE",
        "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
        "ARCHIVING",
        "ARCHIVED"
      ]
    },
    "TableArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the table"
    },
    "TableId": {
      "type": "string",
      "description": "Unique identifier for the table"
    },
    "CreationDateTime": {
      "type": "double",
      "description": "The date and time when the table was created"
    },
    "KeySchema": {
      "type": "array",
      "description": "The primary key structure for the table",
      "items": {
        "$ref": "#/components/schemas/KeySchemaElement"
      }
    },
    "AttributeDefinitions": {
      "type": "array",
      "description": "An array of attribute definitions for the table",
      "items": {
        "$ref": "#/components/schemas/AttributeDefinition"
      }
    },
    "ProvisionedThroughput": {
      "$ref": "#/components/schemas/ProvisionedThroughputDescription"
    },
    "TableSizeBytes": {
      "type": "int32",
      "description": "The total size of the table in bytes"
    },
    "ItemCount": {
      "type": "int32",
      "description": "The number of items in the table"
    },
    "GlobalSecondaryIndexes": {
      "type": "array",
      "description": "The global secondary indexes on the table",
      "items": {
        "type": "object"
      }
    },
    "LocalSecondaryIndexes": {
      "type": "array",
      "description": "The local secondary indexes on the table",
      "items": {
        "type": "object"
      }
    },
    "BillingModeSummary": {
      "type": "object",
      "description": "Contains details about the billing mode for the table",
      "properties": {
        "BillingMode": {
          "type": "string",
          "enum": [
            "PROVISIONED",
            "PAY_PER_REQUEST"
          ]
        },
        "LastUpdateToPayPerRequestDateTime": {
          "type": "double"
        }
      }
    }
  }
}