Amazon Kendra · JSON Structure

Amazon Kendra Index Structure

An Amazon Kendra search index.

Type: object Properties: 7
AIEnterprise SearchKnowledge ManagementMachine LearningNatural Language

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

Properties

Id Name Status Edition RoleArn CreatedAt UpdatedAt

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-kendra/refs/heads/main/json-structure/amazon-kendra-index-structure.json",
  "name": "Index",
  "description": "An Amazon Kendra search index.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "The unique identifier of the index.",
      "example": "abc12345-6789-def0-1234-abcdef012345"
    },
    "Name": {
      "type": "string",
      "description": "The name of the index.",
      "example": "my-enterprise-index"
    },
    "Status": {
      "type": "string",
      "enum": [
        "CREATING",
        "ACTIVE",
        "DELETING",
        "FAILED",
        "UPDATING",
        "SYSTEM_UPDATING"
      ],
      "description": "The current status of the index.",
      "example": "ACTIVE"
    },
    "Edition": {
      "type": "string",
      "enum": [
        "DEVELOPER_EDITION",
        "ENTERPRISE_EDITION",
        "GEN_AI_ENTERPRISE_EDITION"
      ],
      "description": "The Amazon Kendra edition.",
      "example": "ENTERPRISE_EDITION"
    },
    "RoleArn": {
      "type": "string",
      "description": "The IAM role ARN for the index.",
      "example": "arn:aws:iam::123456789012:role/KendraRole"
    },
    "CreatedAt": {
      "type": "datetime",
      "description": "When the index was created."
    },
    "UpdatedAt": {
      "type": "datetime",
      "description": "When the index was last updated."
    }
  }
}