Package-level declarations

Types

Link copied to clipboard
data class DataSourceConfiguration(val s3Configuration: DataSourceConfigurationS3Configuration? = null, val templateConfiguration: DataSourceConfigurationTemplateConfiguration? = null, val webCrawlerConfiguration: DataSourceConfigurationWebCrawlerConfiguration? = null)
Link copied to clipboard
data class DataSourceConfigurationS3Configuration(val accessControlListConfiguration: DataSourceConfigurationS3ConfigurationAccessControlListConfiguration? = null, val bucketName: String, val documentsMetadataConfiguration: DataSourceConfigurationS3ConfigurationDocumentsMetadataConfiguration? = null, val exclusionPatterns: List<String>? = null, val inclusionPatterns: List<String>? = null, val inclusionPrefixes: List<String>? = null)
data class DataSourceConfigurationWebCrawlerConfiguration(val authenticationConfiguration: DataSourceConfigurationWebCrawlerConfigurationAuthenticationConfiguration? = null, val crawlDepth: Int? = null, val maxContentSizePerPageInMegaBytes: Double? = null, val maxLinksPerPage: Int? = null, val maxUrlsPerMinuteCrawlRate: Int? = null, val proxyConfiguration: DataSourceConfigurationWebCrawlerConfigurationProxyConfiguration? = null, val urlExclusionPatterns: List<String>? = null, val urlInclusionPatterns: List<String>? = null, val urls: DataSourceConfigurationWebCrawlerConfigurationUrls)
data class DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationConditionConditionOnValue(val dateValue: String? = null, val longValue: Int? = null, val stringListValues: List<String>? = null, val stringValue: String? = null)
data class DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTarget(val targetDocumentAttributeKey: String? = null, val targetDocumentAttributeValue: DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTargetTargetDocumentAttributeValue? = null, val targetDocumentAttributeValueDeletion: Boolean? = null)
data class DataSourceCustomDocumentEnrichmentConfigurationInlineConfigurationTargetTargetDocumentAttributeValue(val dateValue: String? = null, val longValue: Int? = null, val stringListValues: List<String>? = null, val stringValue: String? = null)
Link copied to clipboard
data class ExperienceConfiguration(val contentSourceConfiguration: ExperienceConfigurationContentSourceConfiguration? = null, val userIdentityConfiguration: ExperienceConfigurationUserIdentityConfiguration? = null)
data class ExperienceConfigurationContentSourceConfiguration(val dataSourceIds: List<String>? = null, val directPutContent: Boolean? = null, val faqIds: List<String>? = null)
data class ExperienceConfigurationUserIdentityConfiguration(val identityAttributeName: String)
Link copied to clipboard
data class ExperienceEndpoint(val endpoint: String? = null, val endpointType: String? = null)
Link copied to clipboard
data class FaqS3Path(val bucket: String, val key: String)
Link copied to clipboard
data class GetExperienceConfigurationContentSourceConfiguration(val dataSourceIds: List<String>, val directPutContent: Boolean, val faqIds: List<String>)
Link copied to clipboard
data class GetExperienceEndpoint(val endpoint: String, val endpointType: String)
Link copied to clipboard
data class GetExperienceResult(val arn: String, val configurations: List<GetExperienceConfiguration>, val createdAt: String, val description: String, val endpoints: List<GetExperienceEndpoint>, val errorMessage: String, val experienceId: String, val id: String, val indexId: String, val name: String, val roleArn: String, val status: String, val updatedAt: String)

A collection of values returned by getExperience.

Link copied to clipboard
data class GetFaqResult(val arn: String, val createdAt: String, val description: String, val errorMessage: String, val faqId: String, val fileFormat: String, val id: String, val indexId: String, val languageCode: String, val name: String, val roleArn: String, val s3Paths: List<GetFaqS3Path>, val status: String, val tags: Map<String, String>, val updatedAt: String)

A collection of values returned by getFaq.

Link copied to clipboard
data class GetFaqS3Path(val bucket: String, val key: String)
Link copied to clipboard
data class GetIndexCapacityUnit(val queryCapacityUnits: Int, val storageCapacityUnits: Int)
data class GetIndexDocumentMetadataConfigurationUpdateRelevance(val duration: String, val freshness: Boolean, val importance: Int, val rankOrder: String, val valuesImportanceMap: Map<String, Int>)
data class GetIndexDocumentMetadataConfigurationUpdateSearch(val displayable: Boolean, val facetable: Boolean, val searchable: Boolean, val sortable: Boolean)
Link copied to clipboard
Link copied to clipboard
data class GetIndexIndexStatisticFaqStatistic(val indexedQuestionAnswersCount: Int)
data class GetIndexIndexStatisticTextDocumentStatistic(val indexedTextBytes: Int, val indexedTextDocumentsCount: Int)
Link copied to clipboard
data class GetIndexResult(val arn: String, val capacityUnits: List<GetIndexCapacityUnit>, val createdAt: String, val description: String, val documentMetadataConfigurationUpdates: List<GetIndexDocumentMetadataConfigurationUpdate>, val edition: String, val errorMessage: String, val id: String, val indexStatistics: List<GetIndexIndexStatistic>, val name: String, val roleArn: String, val serverSideEncryptionConfigurations: List<GetIndexServerSideEncryptionConfiguration>, val status: String, val tags: Map<String, String>, val updatedAt: String, val userContextPolicy: String, val userGroupResolutionConfigurations: List<GetIndexUserGroupResolutionConfiguration>, val userTokenConfigurations: List<GetIndexUserTokenConfiguration>)

A collection of values returned by getIndex.

Link copied to clipboard
data class GetIndexUserGroupResolutionConfiguration(val userGroupResolutionMode: String)
data class GetIndexUserTokenConfigurationJsonTokenTypeConfiguration(val groupAttributeField: String, val userNameAttributeField: String)
data class GetIndexUserTokenConfigurationJwtTokenTypeConfiguration(val claimRegex: String, val groupAttributeField: String, val issuer: String, val keyLocation: String, val secretsManagerArn: String, val url: String, val userNameAttributeField: String)
Link copied to clipboard
data class GetQuerySuggestionsBlockListResult(val arn: String, val createdAt: String, val description: String, val errorMessage: String, val fileSizeBytes: Int, val id: String, val indexId: String, val itemCount: Int, val name: String, val querySuggestionsBlockListId: String, val roleArn: String, val sourceS3Paths: List<GetQuerySuggestionsBlockListSourceS3Path>, val status: String, val tags: Map<String, String>, val updatedAt: String)

A collection of values returned by getQuerySuggestionsBlockList.

Link copied to clipboard
data class GetQuerySuggestionsBlockListSourceS3Path(val bucket: String, val key: String)
Link copied to clipboard
data class GetThesaurusResult(val arn: String, val createdAt: String, val description: String, val errorMessage: String, val fileSizeBytes: Int, val id: String, val indexId: String, val name: String, val roleArn: String, val sourceS3Paths: List<GetThesaurusSourceS3Path>, val status: String, val synonymRuleCount: Int, val tags: Map<String, String>, val termCount: Int, val thesaurusId: String, val updatedAt: String)

A collection of values returned by getThesaurus.

Link copied to clipboard
data class GetThesaurusSourceS3Path(val bucket: String, val key: String)
Link copied to clipboard
data class IndexCapacityUnits(val queryCapacityUnits: Int? = null, val storageCapacityUnits: Int? = null)
data class IndexDocumentMetadataConfigurationUpdateRelevance(val duration: String? = null, val freshness: Boolean? = null, val importance: Int? = null, val rankOrder: String? = null, val valuesImportanceMap: Map<String, Int>? = null)
data class IndexDocumentMetadataConfigurationUpdateSearch(val displayable: Boolean? = null, val facetable: Boolean? = null, val searchable: Boolean? = null, val sortable: Boolean? = null)
Link copied to clipboard
data class IndexIndexStatistic(val faqStatistics: List<IndexIndexStatisticFaqStatistic>? = null, val textDocumentStatistics: List<IndexIndexStatisticTextDocumentStatistic>? = null)
Link copied to clipboard
data class IndexIndexStatisticFaqStatistic(val indexedQuestionAnswersCount: Int? = null)
Link copied to clipboard
data class IndexIndexStatisticTextDocumentStatistic(val indexedTextBytes: Int? = null, val indexedTextDocumentsCount: Int? = null)
Link copied to clipboard
data class IndexServerSideEncryptionConfiguration(val kmsKeyId: String? = null)
Link copied to clipboard
data class IndexUserGroupResolutionConfiguration(val userGroupResolutionMode: String)
Link copied to clipboard
data class IndexUserTokenConfigurations(val jsonTokenTypeConfiguration: IndexUserTokenConfigurationsJsonTokenTypeConfiguration? = null, val jwtTokenTypeConfiguration: IndexUserTokenConfigurationsJwtTokenTypeConfiguration? = null)
data class IndexUserTokenConfigurationsJsonTokenTypeConfiguration(val groupAttributeField: String, val userNameAttributeField: String)
data class IndexUserTokenConfigurationsJwtTokenTypeConfiguration(val claimRegex: String? = null, val groupAttributeField: String? = null, val issuer: String? = null, val keyLocation: String, val secretsManagerArn: String? = null, val url: String? = null, val userNameAttributeField: String? = null)
Link copied to clipboard
data class QuerySuggestionsBlockListSourceS3Path(val bucket: String, val key: String)
Link copied to clipboard
data class ThesaurusSourceS3Path(val bucket: String, val key: String)