Skip to content

GetIndex

Source: src/AWS/OpenSearchServerless/GetIndex.ts

Runtime binding for the GetIndex operation scoped to one collection (IAM action aoss:APIAccessAll on the collection ARN).

Reads an index’s schema definition from the bound Collection. A missing index surfaces the typed ResourceNotFoundException. The calling principal must also be granted aoss:DescribeIndex on the index pattern by a data AccessPolicy. Provide the implementation with Effect.provide(AWS.OpenSearchServerless.GetIndexHttp).

const getIndex = yield* AWS.OpenSearchServerless.GetIndex(collection);
const { indexSchema } = yield* getIndex({ indexName: "tenant-42" });