getIndex

AWS v7.53.0, Nov 2 26

Viewing docs for AWS v7.53.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v7.53.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.kendra.getIndex({
    id: "12345678-1234-1234-1234-123456789123",
});

import pulumi
import pulumi_aws as aws

example = aws.kendra.get_index(id="12345678-1234-1234-1234-123456789123")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kendra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kendra.LookupIndex(ctx, &kendra.LookupIndexArgs{
			Id: "12345678-1234-1234-1234-123456789123",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Kendra.GetIndex.Invoke(new()
    {
        Id = "12345678-1234-1234-1234-123456789123",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kendra.KendraFunctions;
import com.pulumi.aws.kendra.inputs.GetIndexArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = KendraFunctions.getIndex(GetIndexArgs.builder()
            .id("12345678-1234-1234-1234-123456789123")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:kendra:getIndex
      arguments:
        id: 12345678-1234-1234-1234-123456789123

terraform {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_kendra_index" "example" {
  id = "12345678-1234-1234-1234-123456789123"
}

Using getIndex

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getIndex(args: GetIndexArgs, opts?: InvokeOptions): Promise<GetIndexResult>
function getIndexOutput(args: GetIndexOutputArgs, opts?: InvokeOutputOptions): Output<GetIndexResult>

def get_index(id: Optional[str] = None,
              region: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              opts: Optional[InvokeOptions] = None) -> GetIndexResult
def get_index_output(id: pulumi.Input[Optional[str]] = None,
              region: pulumi.Input[Optional[str]] = None,
              tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
              opts: Optional[InvokeOutputOptions] = None) -> Output[GetIndexResult]

func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

> Note: This function is named LookupIndex in the Go SDK.

public static class GetIndex 
{
    public static Task<GetIndexResult> InvokeAsync(GetIndexArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexResult> Invoke(GetIndexInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
public static Output<GetIndexResult> getIndex(GetIndexArgs args, InvokeOptions options)
public static Output<GetIndexResult> getIndex(GetIndexArgs args, InvokeOutputOptions options)

fn::invoke:
  function: aws:kendra/getIndex:getIndex
  arguments:
    # arguments dictionary

data "aws_kendra_get_index" "name" {
    # arguments
}

The following arguments are supported:

Id string: Returns information on a specific Index by ID.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags Dictionary<string, string>: Metadata that helps organize the Indices you create.

Id string: Returns information on a specific Index by ID.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags map[string]string: Metadata that helps organize the Indices you create.

id string: Returns information on a specific Index by ID.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags map(string): Metadata that helps organize the Indices you create.

id String: Returns information on a specific Index by ID.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String,String>: Metadata that helps organize the Indices you create.

id string: Returns information on a specific Index by ID.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags {[key: string]: string}: Metadata that helps organize the Indices you create.

id str: Returns information on a specific Index by ID.
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Mapping[str, str]: Metadata that helps organize the Indices you create.

id String: Returns information on a specific Index by ID.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String>: Metadata that helps organize the Indices you create.

getIndex Result

The following output properties are available:

Arn string: ARN of the Index.
CapacityUnits List<GetIndexCapacityUnit>: Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
CreatedAt string: Unix datetime that the index was created.
Description string: Description of the Index.
DocumentMetadataConfigurationUpdates List<GetIndexDocumentMetadataConfigurationUpdate>: One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.
Edition string: Amazon Kendra edition for the index.
ErrorMessage string: When the Status field value is FAILED, this contains a message that explains why.
Id string
IndexStatistics List<GetIndexIndexStatistic>: Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
Name string: Name of the index field. Minimum length of 1. Maximum length of 30.
Region string
RoleArn string: AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
ServerSideEncryptionConfigurations List<GetIndexServerSideEncryptionConfiguration>: Block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
Status string: 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.
Tags Dictionary<string, string>: Metadata that helps organize the Indices you create.
UpdatedAt string: Unix datetime that the index was last updated.
UserContextPolicy string: User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy.
UserGroupResolutionConfigurations List<GetIndexUserGroupResolutionConfiguration>: Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.
UserTokenConfigurations List<GetIndexUserTokenConfiguration>: Block that specifies the user token configuration. Detailed below.

Arn string: ARN of the Index.
CapacityUnits []GetIndexCapacityUnit: Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
CreatedAt string: Unix datetime that the index was created.
Description string: Description of the Index.
DocumentMetadataConfigurationUpdates []GetIndexDocumentMetadataConfigurationUpdate: One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.
Edition string: Amazon Kendra edition for the index.
ErrorMessage string: When the Status field value is FAILED, this contains a message that explains why.
Id string
IndexStatistics []GetIndexIndexStatistic: Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
Name string: Name of the index field. Minimum length of 1. Maximum length of 30.
Region string
RoleArn string: AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
ServerSideEncryptionConfigurations []GetIndexServerSideEncryptionConfiguration: Block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
Status string: 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.
Tags map[string]string: Metadata that helps organize the Indices you create.
UpdatedAt string: Unix datetime that the index was last updated.
UserContextPolicy string: User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy.
UserGroupResolutionConfigurations []GetIndexUserGroupResolutionConfiguration: Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.
UserTokenConfigurations []GetIndexUserTokenConfiguration: Block that specifies the user token configuration. Detailed below.

arn string: ARN of the Index.
capacity_units list(object): Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
created_at string: Unix datetime that the index was created.
description string: Description of the Index.
document_metadata_configuration_updates list(object): One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.
edition string: Amazon Kendra edition for the index.
error_message string: When the Status field value is FAILED, this contains a message that explains why.
id string
index_statistics list(object): Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
name string: Name of the index field. Minimum length of 1. Maximum length of 30.
region string
role_arn string: AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
server_side_encryption_configurations list(object): Block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
status string: 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.
tags map(string): Metadata that helps organize the Indices you create.
updated_at string: Unix datetime that the index was last updated.
user_context_policy string: User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy.
user_group_resolution_configurations list(object): Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.
user_token_configurations list(object): Block that specifies the user token configuration. Detailed below.

arn String: ARN of the Index.
capacityUnits List<GetIndexCapacityUnit>: Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
createdAt String: Unix datetime that the index was created.
description String: Description of the Index.
documentMetadataConfigurationUpdates List<GetIndexDocumentMetadataConfigurationUpdate>: One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.
edition String: Amazon Kendra edition for the index.
errorMessage String: When the Status field value is FAILED, this contains a message that explains why.
id String
indexStatistics List<GetIndexIndexStatistic>: Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
name String: Name of the index field. Minimum length of 1. Maximum length of 30.
region String
roleArn String: AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
serverSideEncryptionConfigurations List<GetIndexServerSideEncryptionConfiguration>: Block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
status String: 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.
tags Map<String,String>: Metadata that helps organize the Indices you create.
updatedAt String: Unix datetime that the index was last updated.
userContextPolicy String: User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy.
userGroupResolutionConfigurations List<GetIndexUserGroupResolutionConfiguration>: Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.
userTokenConfigurations List<GetIndexUserTokenConfiguration>: Block that specifies the user token configuration. Detailed below.

arn string: ARN of the Index.
capacityUnits GetIndexCapacityUnit[]: Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
createdAt string: Unix datetime that the index was created.
description string: Description of the Index.
documentMetadataConfigurationUpdates GetIndexDocumentMetadataConfigurationUpdate[]: One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.
edition string: Amazon Kendra edition for the index.
errorMessage string: When the Status field value is FAILED, this contains a message that explains why.
id string
indexStatistics GetIndexIndexStatistic[]: Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
name string: Name of the index field. Minimum length of 1. Maximum length of 30.
region string
roleArn string: AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
serverSideEncryptionConfigurations GetIndexServerSideEncryptionConfiguration[]: Block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
status string: 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.
tags {[key: string]: string}: Metadata that helps organize the Indices you create.
updatedAt string: Unix datetime that the index was last updated.
userContextPolicy string: User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy.
userGroupResolutionConfigurations GetIndexUserGroupResolutionConfiguration[]: Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.
userTokenConfigurations GetIndexUserTokenConfiguration[]: Block that specifies the user token configuration. Detailed below.

arn str: ARN of the Index.
capacity_units Sequence[GetIndexCapacityUnit]: Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
created_at str: Unix datetime that the index was created.
description str: Description of the Index.
document_metadata_configuration_updates Sequence[GetIndexDocumentMetadataConfigurationUpdate]: One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.
edition str: Amazon Kendra edition for the index.
error_message str: When the Status field value is FAILED, this contains a message that explains why.
id str
index_statistics Sequence[GetIndexIndexStatistic]: Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
name str: Name of the index field. Minimum length of 1. Maximum length of 30.
region str
role_arn str: AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
server_side_encryption_configurations Sequence[GetIndexServerSideEncryptionConfiguration]: Block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
status str: 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.
tags Mapping[str, str]: Metadata that helps organize the Indices you create.
updated_at str: Unix datetime that the index was last updated.
user_context_policy str: User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy.
user_group_resolution_configurations Sequence[GetIndexUserGroupResolutionConfiguration]: Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.
user_token_configurations Sequence[GetIndexUserTokenConfiguration]: Block that specifies the user token configuration. Detailed below.

arn String: ARN of the Index.
capacityUnits List<Property Map>: Block that sets the number of additional document storage and query capacity units that should be used by the index. Detailed below.
createdAt String: Unix datetime that the index was created.
description String: Description of the Index.
documentMetadataConfigurationUpdates List<Property Map>: One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Detailed below.
edition String: Amazon Kendra edition for the index.
errorMessage String: When the Status field value is FAILED, this contains a message that explains why.
id String
indexStatistics List<Property Map>: Block that provides information about the number of FAQ questions and answers and the number of text documents indexed. Detailed below.
name String: Name of the index field. Minimum length of 1. Maximum length of 30.
region String
roleArn String: AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
serverSideEncryptionConfigurations List<Property Map>: Block that specifies the identifier of the AWS KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. Detailed below.
status String: 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.
tags Map<String>: Metadata that helps organize the Indices you create.
updatedAt String: Unix datetime that the index was last updated.
userContextPolicy String: User context policy. Valid values are ATTRIBUTE_FILTER or USER_TOKEN. For more information, refer to UserContextPolicy.
userGroupResolutionConfigurations List<Property Map>: Block that enables fetching access levels of groups and users from an AWS Single Sign-On identity source. Detailed below.
userTokenConfigurations List<Property Map>: Block that specifies the user token configuration. Detailed below.

Supporting Types

GetIndexCapacityUnit

QueryCapacityUnits int: Amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
StorageCapacityUnits int: Amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

QueryCapacityUnits int: Amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
StorageCapacityUnits int: Amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

query_capacity_units number: Amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
storage_capacity_units number: Amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

queryCapacityUnits Integer: Amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
storageCapacityUnits Integer: Amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

queryCapacityUnits number: Amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
storageCapacityUnits number: Amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

query_capacity_units int: Amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
storage_capacity_units int: Amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

queryCapacityUnits Number: Amount of extra query capacity for an index and GetQuerySuggestions capacity. For more information, refer to QueryCapacityUnits.
storageCapacityUnits Number: Amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. Minimum value of 0.

GetIndexDocumentMetadataConfigurationUpdate

Name string: Name of the index field. Minimum length of 1. Maximum length of 30.
Relevances List<GetIndexDocumentMetadataConfigurationUpdateRelevance>: Block that provides manual tuning parameters to determine how the field affects the search results. Detailed below.
Searches List<GetIndexDocumentMetadataConfigurationUpdateSearch>: Block that provides information about how the field is used during a search. Detailed below.
Type string: Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

Name string: Name of the index field. Minimum length of 1. Maximum length of 30.
Relevances []GetIndexDocumentMetadataConfigurationUpdateRelevance: Block that provides manual tuning parameters to determine how the field affects the search results. Detailed below.
Searches []GetIndexDocumentMetadataConfigurationUpdateSearch: Block that provides information about how the field is used during a search. Detailed below.
Type string: Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

name string: Name of the index field. Minimum length of 1. Maximum length of 30.
relevances list(object): Block that provides manual tuning parameters to determine how the field affects the search results. Detailed below.
searches list(object): Block that provides information about how the field is used during a search. Detailed below.
type string: Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

name String: Name of the index field. Minimum length of 1. Maximum length of 30.
relevances List<GetIndexDocumentMetadataConfigurationUpdateRelevance>: Block that provides manual tuning parameters to determine how the field affects the search results. Detailed below.
searches List<GetIndexDocumentMetadataConfigurationUpdateSearch>: Block that provides information about how the field is used during a search. Detailed below.
type String: Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

name string: Name of the index field. Minimum length of 1. Maximum length of 30.
relevances GetIndexDocumentMetadataConfigurationUpdateRelevance[]: Block that provides manual tuning parameters to determine how the field affects the search results. Detailed below.
searches GetIndexDocumentMetadataConfigurationUpdateSearch[]: Block that provides information about how the field is used during a search. Detailed below.
type string: Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

name str: Name of the index field. Minimum length of 1. Maximum length of 30.
relevances Sequence[GetIndexDocumentMetadataConfigurationUpdateRelevance]: Block that provides manual tuning parameters to determine how the field affects the search results. Detailed below.
searches Sequence[GetIndexDocumentMetadataConfigurationUpdateSearch]: Block that provides information about how the field is used during a search. Detailed below.
type str: Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

name String: Name of the index field. Minimum length of 1. Maximum length of 30.
relevances List<Property Map>: Block that provides manual tuning parameters to determine how the field affects the search results. Detailed below.
searches List<Property Map>: Block that provides information about how the field is used during a search. Detailed below.
type String: Data type of the index field. Valid values are STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE.

GetIndexDocumentMetadataConfigurationUpdateRelevance

Duration string: Time period that the boost applies to. For more information, refer to Duration.
Freshness bool: How "fresh" a document is. For more information, refer to Freshness.
Importance int: Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
RankOrder string: How values should be interpreted. For more information, refer to RankOrder.
ValuesImportanceMap Dictionary<string, int>: List of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

Duration string: Time period that the boost applies to. For more information, refer to Duration.
Freshness bool: How "fresh" a document is. For more information, refer to Freshness.
Importance int: Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
RankOrder string: How values should be interpreted. For more information, refer to RankOrder.
ValuesImportanceMap map[string]int: List of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

duration string: Time period that the boost applies to. For more information, refer to Duration.
freshness bool: How "fresh" a document is. For more information, refer to Freshness.
importance number: Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
rank_order string: How values should be interpreted. For more information, refer to RankOrder.
values_importance_map map(number): List of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

duration String: Time period that the boost applies to. For more information, refer to Duration.
freshness Boolean: How "fresh" a document is. For more information, refer to Freshness.
importance Integer: Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
rankOrder String: How values should be interpreted. For more information, refer to RankOrder.
valuesImportanceMap Map<String,Integer>: List of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

duration string: Time period that the boost applies to. For more information, refer to Duration.
freshness boolean: How "fresh" a document is. For more information, refer to Freshness.
importance number: Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
rankOrder string: How values should be interpreted. For more information, refer to RankOrder.
valuesImportanceMap {[key: string]: number}: List of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

duration str: Time period that the boost applies to. For more information, refer to Duration.
freshness bool: How "fresh" a document is. For more information, refer to Freshness.
importance int: Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
rank_order str: How values should be interpreted. For more information, refer to RankOrder.
values_importance_map Mapping[str, int]: List of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

duration String: Time period that the boost applies to. For more information, refer to Duration.
freshness Boolean: How "fresh" a document is. For more information, refer to Freshness.
importance Number: Relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. Minimum value of 1. Maximum value of 10.
rankOrder String: How values should be interpreted. For more information, refer to RankOrder.
valuesImportanceMap Map<Number>: List of values that should be given a different boost when they appear in the result list. For more information, refer to ValueImportanceMap.

GetIndexDocumentMetadataConfigurationUpdateSearch

Displayable bool: Whether the field is returned in the query response. The default is true.
Facetable bool: Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
Searchable bool: Whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
Sortable bool: Whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Displayable bool: Whether the field is returned in the query response. The default is true.
Facetable bool: Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
Searchable bool: Whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
Sortable bool: Whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

displayable bool: Whether the field is returned in the query response. The default is true.
facetable bool: Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
searchable bool: Whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
sortable bool: Whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

displayable Boolean: Whether the field is returned in the query response. The default is true.
facetable Boolean: Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
searchable Boolean: Whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
sortable Boolean: Whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

displayable boolean: Whether the field is returned in the query response. The default is true.
facetable boolean: Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
searchable boolean: Whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
sortable boolean: Whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

displayable bool: Whether the field is returned in the query response. The default is true.
facetable bool: Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
searchable bool: Whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
sortable bool: Whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

displayable Boolean: Whether the field is returned in the query response. The default is true.
facetable Boolean: Whether the field can be used to create search facets, a count of results for each value in the field. The default is false.
searchable Boolean: Whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
sortable Boolean: Whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

GetIndexIndexStatistic

FaqStatistics List<GetIndexIndexStatisticFaqStatistic>: Block that specifies the number of question and answer topics in the index. Detailed below.
TextDocumentStatistics List<GetIndexIndexStatisticTextDocumentStatistic>: Block that specifies the number of text documents indexed. Detailed below.

FaqStatistics []GetIndexIndexStatisticFaqStatistic: Block that specifies the number of question and answer topics in the index. Detailed below.
TextDocumentStatistics []GetIndexIndexStatisticTextDocumentStatistic: Block that specifies the number of text documents indexed. Detailed below.

faq_statistics list(object): Block that specifies the number of question and answer topics in the index. Detailed below.
text_document_statistics list(object): Block that specifies the number of text documents indexed. Detailed below.

faqStatistics List<GetIndexIndexStatisticFaqStatistic>: Block that specifies the number of question and answer topics in the index. Detailed below.
textDocumentStatistics List<GetIndexIndexStatisticTextDocumentStatistic>: Block that specifies the number of text documents indexed. Detailed below.

faqStatistics GetIndexIndexStatisticFaqStatistic[]: Block that specifies the number of question and answer topics in the index. Detailed below.
textDocumentStatistics GetIndexIndexStatisticTextDocumentStatistic[]: Block that specifies the number of text documents indexed. Detailed below.

faq_statistics Sequence[GetIndexIndexStatisticFaqStatistic]: Block that specifies the number of question and answer topics in the index. Detailed below.
text_document_statistics Sequence[GetIndexIndexStatisticTextDocumentStatistic]: Block that specifies the number of text documents indexed. Detailed below.

faqStatistics List<Property Map>: Block that specifies the number of question and answer topics in the index. Detailed below.
textDocumentStatistics List<Property Map>: Block that specifies the number of text documents indexed. Detailed below.

GetIndexIndexStatisticFaqStatistic

IndexedQuestionAnswersCount int: Total number of FAQ questions and answers contained in the index.

IndexedQuestionAnswersCount int: Total number of FAQ questions and answers contained in the index.

indexed_question_answers_count number: Total number of FAQ questions and answers contained in the index.

indexedQuestionAnswersCount Integer: Total number of FAQ questions and answers contained in the index.

indexedQuestionAnswersCount number: Total number of FAQ questions and answers contained in the index.

indexed_question_answers_count int: Total number of FAQ questions and answers contained in the index.

indexedQuestionAnswersCount Number: Total number of FAQ questions and answers contained in the index.

GetIndexIndexStatisticTextDocumentStatistic

IndexedTextBytes int: Total size, in bytes, of the indexed documents.
IndexedTextDocumentsCount int: Number of text documents indexed.

IndexedTextBytes int: Total size, in bytes, of the indexed documents.
IndexedTextDocumentsCount int: Number of text documents indexed.

indexed_text_bytes number: Total size, in bytes, of the indexed documents.
indexed_text_documents_count number: Number of text documents indexed.

indexedTextBytes Integer: Total size, in bytes, of the indexed documents.
indexedTextDocumentsCount Integer: Number of text documents indexed.

indexedTextBytes number: Total size, in bytes, of the indexed documents.
indexedTextDocumentsCount number: Number of text documents indexed.

indexed_text_bytes int: Total size, in bytes, of the indexed documents.
indexed_text_documents_count int: Number of text documents indexed.

indexedTextBytes Number: Total size, in bytes, of the indexed documents.
indexedTextDocumentsCount Number: Number of text documents indexed.

GetIndexServerSideEncryptionConfiguration

KmsKeyId string: Identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

KmsKeyId string: Identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

kms_key_id string: Identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

kmsKeyId String: Identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

kmsKeyId string: Identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

kms_key_id str: Identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

kmsKeyId String: Identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

GetIndexUserGroupResolutionConfiguration

UserGroupResolutionMode string: Identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or NONE.

UserGroupResolutionMode string: Identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or NONE.

user_group_resolution_mode string: Identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or NONE.

userGroupResolutionMode String: Identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or NONE.

userGroupResolutionMode string: Identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or NONE.

user_group_resolution_mode str: Identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or NONE.

userGroupResolutionMode String: Identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode. Valid Values are AWS_SSO or NONE.

GetIndexUserTokenConfiguration

JsonTokenTypeConfigurations List<GetIndexUserTokenConfigurationJsonTokenTypeConfiguration>: Block that specifies the information about the JSON token type configuration. Detailed below.
JwtTokenTypeConfigurations List<GetIndexUserTokenConfigurationJwtTokenTypeConfiguration>: Block that specifies the information about the JWT token type configuration. Detailed below.

JsonTokenTypeConfigurations []GetIndexUserTokenConfigurationJsonTokenTypeConfiguration: Block that specifies the information about the JSON token type configuration. Detailed below.
JwtTokenTypeConfigurations []GetIndexUserTokenConfigurationJwtTokenTypeConfiguration: Block that specifies the information about the JWT token type configuration. Detailed below.

json_token_type_configurations list(object): Block that specifies the information about the JSON token type configuration. Detailed below.
jwt_token_type_configurations list(object): Block that specifies the information about the JWT token type configuration. Detailed below.

jsonTokenTypeConfigurations List<GetIndexUserTokenConfigurationJsonTokenTypeConfiguration>: Block that specifies the information about the JSON token type configuration. Detailed below.
jwtTokenTypeConfigurations List<GetIndexUserTokenConfigurationJwtTokenTypeConfiguration>: Block that specifies the information about the JWT token type configuration. Detailed below.

jsonTokenTypeConfigurations GetIndexUserTokenConfigurationJsonTokenTypeConfiguration[]: Block that specifies the information about the JSON token type configuration. Detailed below.
jwtTokenTypeConfigurations GetIndexUserTokenConfigurationJwtTokenTypeConfiguration[]: Block that specifies the information about the JWT token type configuration. Detailed below.

json_token_type_configurations Sequence[GetIndexUserTokenConfigurationJsonTokenTypeConfiguration]: Block that specifies the information about the JSON token type configuration. Detailed below.
jwt_token_type_configurations Sequence[GetIndexUserTokenConfigurationJwtTokenTypeConfiguration]: Block that specifies the information about the JWT token type configuration. Detailed below.

jsonTokenTypeConfigurations List<Property Map>: Block that specifies the information about the JSON token type configuration. Detailed below.
jwtTokenTypeConfigurations List<Property Map>: Block that specifies the information about the JWT token type configuration. Detailed below.

GetIndexUserTokenConfigurationJsonTokenTypeConfiguration

GroupAttributeField string: Group attribute field.
UserNameAttributeField string: User name attribute field.

GroupAttributeField string: Group attribute field.
UserNameAttributeField string: User name attribute field.

group_attribute_field string: Group attribute field.
user_name_attribute_field string: User name attribute field.

groupAttributeField String: Group attribute field.
userNameAttributeField String: User name attribute field.

groupAttributeField string: Group attribute field.
userNameAttributeField string: User name attribute field.

group_attribute_field str: Group attribute field.
user_name_attribute_field str: User name attribute field.

groupAttributeField String: Group attribute field.
userNameAttributeField String: User name attribute field.

GetIndexUserTokenConfigurationJwtTokenTypeConfiguration

ClaimRegex string: Regular expression that identifies the claim.
GroupAttributeField string: Group attribute field.
Issuer string: Issuer of the token.
KeyLocation string: Location of the key. Valid values are URL or SECRET_MANAGER.
SecretsManagerArn string: ARN of the secret.
Url string: Signing key URL.
UserNameAttributeField string: User name attribute field.

ClaimRegex string: Regular expression that identifies the claim.
GroupAttributeField string: Group attribute field.
Issuer string: Issuer of the token.
KeyLocation string: Location of the key. Valid values are URL or SECRET_MANAGER.
SecretsManagerArn string: ARN of the secret.
Url string: Signing key URL.
UserNameAttributeField string: User name attribute field.

claim_regex string: Regular expression that identifies the claim.
group_attribute_field string: Group attribute field.
issuer string: Issuer of the token.
key_location string: Location of the key. Valid values are URL or SECRET_MANAGER.
secrets_manager_arn string: ARN of the secret.
url string: Signing key URL.
user_name_attribute_field string: User name attribute field.

claimRegex String: Regular expression that identifies the claim.
groupAttributeField String: Group attribute field.
issuer String: Issuer of the token.
keyLocation String: Location of the key. Valid values are URL or SECRET_MANAGER.
secretsManagerArn String: ARN of the secret.
url String: Signing key URL.
userNameAttributeField String: User name attribute field.

claimRegex string: Regular expression that identifies the claim.
groupAttributeField string: Group attribute field.
issuer string: Issuer of the token.
keyLocation string: Location of the key. Valid values are URL or SECRET_MANAGER.
secretsManagerArn string: ARN of the secret.
url string: Signing key URL.
userNameAttributeField string: User name attribute field.

claim_regex str: Regular expression that identifies the claim.
group_attribute_field str: Group attribute field.
issuer str: Issuer of the token.
key_location str: Location of the key. Valid values are URL or SECRET_MANAGER.
secrets_manager_arn str: ARN of the secret.
url str: Signing key URL.
user_name_attribute_field str: User name attribute field.

claimRegex String: Regular expression that identifies the claim.
groupAttributeField String: Group attribute field.
issuer String: Issuer of the token.
keyLocation String: Location of the key. Valid values are URL or SECRET_MANAGER.
secretsManagerArn String: ARN of the secret.
url String: Signing key URL.
userNameAttributeField String: User name attribute field.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

Viewing docs for AWS v7.53.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

aws.kendra.getIndex

On this page

On this page

Example Usage

Using getIndex

getIndex Result

Supporting Types

GetIndexCapacityUnit

GetIndexDocumentMetadataConfigurationUpdate

GetIndexDocumentMetadataConfigurationUpdateRelevance

GetIndexDocumentMetadataConfigurationUpdateSearch

GetIndexIndexStatistic

GetIndexIndexStatisticFaqStatistic

GetIndexIndexStatisticTextDocumentStatistic

GetIndexServerSideEncryptionConfiguration

GetIndexUserGroupResolutionConfiguration

GetIndexUserTokenConfiguration

GetIndexUserTokenConfigurationJsonTokenTypeConfiguration

GetIndexUserTokenConfigurationJwtTokenTypeConfiguration

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

aws.kendra.getIndex

On this page

On this page

Example Usage

Using getIndex

getIndex Result

Supporting Types

GetIndexCapacityUnit

GetIndexDocumentMetadataConfigurationUpdate

GetIndexDocumentMetadataConfigurationUpdateRelevance

GetIndexDocumentMetadataConfigurationUpdateSearch

GetIndexIndexStatistic

GetIndexIndexStatisticFaqStatistic

GetIndexIndexStatisticTextDocumentStatistic

GetIndexServerSideEncryptionConfiguration

GetIndexUserGroupResolutionConfiguration

GetIndexUserTokenConfiguration

GetIndexUserTokenConfigurationJsonTokenTypeConfiguration

GetIndexUserTokenConfigurationJwtTokenTypeConfiguration

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.