Amazon Kendra · Schema

DataSource

A data source connector for an Amazon Kendra index.

AIEnterprise SearchKnowledge ManagementMachine LearningNatural Language

Properties

Name Type Description
Id string The identifier of the data source.
Name string The name of the data source.
Type string The type of the data source.
Status string The status of the data source.
Schedule string The cron schedule for sync.
IndexId string The ID of the index this data source belongs to.
View JSON Schema on GitHub

JSON Schema

amazon-kendra-data-source-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-kendra/refs/heads/main/json-schema/amazon-kendra-data-source-schema.json",
  "title": "DataSource",
  "description": "A data source connector for an Amazon Kendra index.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "The identifier of the data source.",
      "example": "ds-abc12345"
    },
    "Name": {
      "type": "string",
      "description": "The name of the data source.",
      "example": "sharepoint-connector"
    },
    "Type": {
      "type": "string",
      "enum": [
        "S3",
        "SHAREPOINT",
        "DATABASE",
        "SALESFORCE",
        "ONEDRIVE",
        "SERVICENOW",
        "CUSTOM",
        "CONFLUENCE",
        "GOOGLEDRIVE",
        "WEBCRAWLER",
        "WORKDOCS"
      ],
      "description": "The type of the data source.",
      "example": "S3"
    },
    "Status": {
      "type": "string",
      "enum": [
        "CREATING",
        "DELETING",
        "FAILED",
        "UPDATING",
        "ACTIVE"
      ],
      "description": "The status of the data source.",
      "example": "ACTIVE"
    },
    "Schedule": {
      "type": "string",
      "description": "The cron schedule for sync.",
      "example": "cron(0 11 * * ? *)"
    },
    "IndexId": {
      "type": "string",
      "description": "The ID of the index this data source belongs to.",
      "example": "abc12345-6789-def0-1234-abcdef012345"
    }
  }
}