Amazon DynamoDB · JSON Structure

Dynamodb Openapi Global Secondary Index Structure

Represents the properties of a global secondary index

Type: object Properties: 4 Required: 3
DatabaseDocument StoreKey-ValueNoSQLServerless

GlobalSecondaryIndex is a JSON Structure definition published by Amazon DynamoDB, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

IndexName KeySchema Projection ProvisionedThroughput

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-global-secondary-index-structure.json",
  "name": "GlobalSecondaryIndex",
  "description": "Represents the properties of a global secondary index",
  "type": "object",
  "properties": {
    "IndexName": {
      "type": "string",
      "description": "The name of the global secondary index"
    },
    "KeySchema": {
      "type": "array",
      "description": "The complete key schema for the index",
      "items": {
        "$ref": "#/components/schemas/KeySchemaElement"
      },
      "minItems": 1,
      "maxItems": 2
    },
    "Projection": {
      "$ref": "#/components/schemas/Projection"
    },
    "ProvisionedThroughput": {
      "$ref": "#/components/schemas/ProvisionedThroughput"
    }
  },
  "required": [
    "IndexName",
    "KeySchema",
    "Projection"
  ]
}