Amazon Q · Schema

Index

Index schema from openapi

Artificial IntelligenceAssistantEnterpriseGenerative AI

Properties

Name	Type	Description
indexId	string	The unique identifier of the index.
displayName	string	The name of the index.
status	string	The status of the index.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-q/refs/heads/main/json-schema/amazon-q-openapi-index-schema.json",
  "title": "Index",
  "description": "Index schema from openapi",
  "type": "object",
  "properties": {
    "indexId": {
      "type": "string",
      "description": "The unique identifier of the index."
    },
    "displayName": {
      "type": "string",
      "description": "The name of the index."
    },
    "status": {
      "type": "string",
      "enum": [
        "CREATING",
        "ACTIVE",
        "DELETING",
        "FAILED",
        "UPDATING"
      ],
      "description": "The status of the index."
    }
  }
}