Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

DescribeIndexResponse

import type { DescribeIndexResponse } from "https://aws-api.deno.dev/v0.3/services/kendra.ts?docs=full";
interface DescribeIndexResponse {
CapacityUnits?: CapacityUnitsConfiguration | null;
CreatedAt?: Date | number | null;
Description?: string | null;
DocumentMetadataConfigurations?: DocumentMetadataConfiguration[] | null;
Edition?: IndexEdition | null;
ErrorMessage?: string | null;
Id?: string | null;
IndexStatistics?: IndexStatistics | null;
Name?: string | null;
RoleArn?: string | null;
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | null;
Status?: IndexStatus | null;
UpdatedAt?: Date | number | null;
UserContextPolicy?: UserContextPolicy | null;
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | null;
UserTokenConfigurations?: UserTokenConfiguration[] | null;
}

§Properties

§
CapacityUnits?: CapacityUnitsConfiguration | null
[src]

For Enterprise edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A 0 for the query capacity or the storage capacity indicates that the index is using the default capacity for the index.

§
CreatedAt?: Date | number | null
[src]

The Unix datetime that the index was created.

§
Description?: string | null
[src]

The description of the index.

§
DocumentMetadataConfigurations?: DocumentMetadataConfiguration[] | null
[src]

Configuration settings for any metadata applied to the documents in the index.

§
Edition?: IndexEdition | null
[src]

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

§
ErrorMessage?: string | null
[src]

When th eStatus field value is FAILED, the ErrorMessage field contains a message that explains why.

§
Id?: string | null
[src]

The name of the index.

§
IndexStatistics?: IndexStatistics | null
[src]

Provides information about the number of FAQ questions and answers and the number of text documents indexed.

§
Name?: string | null
[src]

The name of the index.

§
RoleArn?: string | null
[src]

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

§
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | null
[src]

The identifier of the KMScustomer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

§
Status?: IndexStatus | null
[src]

The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

§
UpdatedAt?: Date | number | null
[src]

The Unix datetime that the index was last updated.

§
UserContextPolicy?: UserContextPolicy | null
[src]

The user context policy for the Amazon Kendra index.

§
UserGroupResolutionConfiguration?: UserGroupResolutionConfiguration | null
[src]

Shows whether you have enabled the configuration for fetching access levels of groups and users from an Amazon Web Services Single Sign On identity source.

§
UserTokenConfigurations?: UserTokenConfiguration[] | null
[src]

The user token configuration for the Amazon Kendra index.