kendra

package
v1.51.31 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 29, 2024 License: Apache-2.0 Imports: 10 Imported by: 18

Documentation

Overview

Package kendra provides the client and types for making API requests to AWSKendraFrontendService.

Amazon Kendra is a service for indexing large document sets.

See https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03 for more information on this service.

See kendra package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kendra/

Using the Client

To contact AWSKendraFrontendService with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWSKendraFrontendService client Kendra for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kendra/#New

Index

Constants

View Source 
const (
	// AlfrescoEntityWiki is a AlfrescoEntity enum value
	AlfrescoEntityWiki = "wiki"

	// AlfrescoEntityBlog is a AlfrescoEntity enum value
	AlfrescoEntityBlog = "blog"

	// AlfrescoEntityDocumentLibrary is a AlfrescoEntity enum value
	AlfrescoEntityDocumentLibrary = "documentLibrary"
)
View Source 
const (
	// AttributeSuggestionsModeActive is a AttributeSuggestionsMode enum value
	AttributeSuggestionsModeActive = "ACTIVE"

	// AttributeSuggestionsModeInactive is a AttributeSuggestionsMode enum value
	AttributeSuggestionsModeInactive = "INACTIVE"
)
View Source 
const (
	// ConditionOperatorGreaterThan is a ConditionOperator enum value
	ConditionOperatorGreaterThan = "GreaterThan"

	// ConditionOperatorGreaterThanOrEquals is a ConditionOperator enum value
	ConditionOperatorGreaterThanOrEquals = "GreaterThanOrEquals"

	// ConditionOperatorLessThan is a ConditionOperator enum value
	ConditionOperatorLessThan = "LessThan"

	// ConditionOperatorLessThanOrEquals is a ConditionOperator enum value
	ConditionOperatorLessThanOrEquals = "LessThanOrEquals"

	// ConditionOperatorEquals is a ConditionOperator enum value
	ConditionOperatorEquals = "Equals"

	// ConditionOperatorNotEquals is a ConditionOperator enum value
	ConditionOperatorNotEquals = "NotEquals"

	// ConditionOperatorContains is a ConditionOperator enum value
	ConditionOperatorContains = "Contains"

	// ConditionOperatorNotContains is a ConditionOperator enum value
	ConditionOperatorNotContains = "NotContains"

	// ConditionOperatorExists is a ConditionOperator enum value
	ConditionOperatorExists = "Exists"

	// ConditionOperatorNotExists is a ConditionOperator enum value
	ConditionOperatorNotExists = "NotExists"

	// ConditionOperatorBeginsWith is a ConditionOperator enum value
	ConditionOperatorBeginsWith = "BeginsWith"
)
View Source 
const (
	// ConfluenceAttachmentFieldNameAuthor is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameAuthor = "AUTHOR"

	// ConfluenceAttachmentFieldNameContentType is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameContentType = "CONTENT_TYPE"

	// ConfluenceAttachmentFieldNameCreatedDate is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameCreatedDate = "CREATED_DATE"

	// ConfluenceAttachmentFieldNameDisplayUrl is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameDisplayUrl = "DISPLAY_URL"

	// ConfluenceAttachmentFieldNameFileSize is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameFileSize = "FILE_SIZE"

	// ConfluenceAttachmentFieldNameItemType is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameItemType = "ITEM_TYPE"

	// ConfluenceAttachmentFieldNameParentId is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameParentId = "PARENT_ID"

	// ConfluenceAttachmentFieldNameSpaceKey is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameSpaceKey = "SPACE_KEY"

	// ConfluenceAttachmentFieldNameSpaceName is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameSpaceName = "SPACE_NAME"

	// ConfluenceAttachmentFieldNameUrl is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameUrl = "URL"

	// ConfluenceAttachmentFieldNameVersion is a ConfluenceAttachmentFieldName enum value
	ConfluenceAttachmentFieldNameVersion = "VERSION"
)
View Source 
const (
	// ConfluenceAuthenticationTypeHttpBasic is a ConfluenceAuthenticationType enum value
	ConfluenceAuthenticationTypeHttpBasic = "HTTP_BASIC"

	// ConfluenceAuthenticationTypePat is a ConfluenceAuthenticationType enum value
	ConfluenceAuthenticationTypePat = "PAT"
)
View Source 
const (
	// ConfluenceBlogFieldNameAuthor is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameAuthor = "AUTHOR"

	// ConfluenceBlogFieldNameDisplayUrl is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameDisplayUrl = "DISPLAY_URL"

	// ConfluenceBlogFieldNameItemType is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameItemType = "ITEM_TYPE"

	// ConfluenceBlogFieldNameLabels is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameLabels = "LABELS"

	// ConfluenceBlogFieldNamePublishDate is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNamePublishDate = "PUBLISH_DATE"

	// ConfluenceBlogFieldNameSpaceKey is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameSpaceKey = "SPACE_KEY"

	// ConfluenceBlogFieldNameSpaceName is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameSpaceName = "SPACE_NAME"

	// ConfluenceBlogFieldNameUrl is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameUrl = "URL"

	// ConfluenceBlogFieldNameVersion is a ConfluenceBlogFieldName enum value
	ConfluenceBlogFieldNameVersion = "VERSION"
)
View Source 
const (
	// ConfluencePageFieldNameAuthor is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameAuthor = "AUTHOR"

	// ConfluencePageFieldNameContentStatus is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameContentStatus = "CONTENT_STATUS"

	// ConfluencePageFieldNameCreatedDate is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameCreatedDate = "CREATED_DATE"

	// ConfluencePageFieldNameDisplayUrl is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameDisplayUrl = "DISPLAY_URL"

	// ConfluencePageFieldNameItemType is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameItemType = "ITEM_TYPE"

	// ConfluencePageFieldNameLabels is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameLabels = "LABELS"

	// ConfluencePageFieldNameModifiedDate is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameModifiedDate = "MODIFIED_DATE"

	// ConfluencePageFieldNameParentId is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameParentId = "PARENT_ID"

	// ConfluencePageFieldNameSpaceKey is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameSpaceKey = "SPACE_KEY"

	// ConfluencePageFieldNameSpaceName is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameSpaceName = "SPACE_NAME"

	// ConfluencePageFieldNameUrl is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameUrl = "URL"

	// ConfluencePageFieldNameVersion is a ConfluencePageFieldName enum value
	ConfluencePageFieldNameVersion = "VERSION"
)
View Source 
const (
	// ConfluenceSpaceFieldNameDisplayUrl is a ConfluenceSpaceFieldName enum value
	ConfluenceSpaceFieldNameDisplayUrl = "DISPLAY_URL"

	// ConfluenceSpaceFieldNameItemType is a ConfluenceSpaceFieldName enum value
	ConfluenceSpaceFieldNameItemType = "ITEM_TYPE"

	// ConfluenceSpaceFieldNameSpaceKey is a ConfluenceSpaceFieldName enum value
	ConfluenceSpaceFieldNameSpaceKey = "SPACE_KEY"

	// ConfluenceSpaceFieldNameUrl is a ConfluenceSpaceFieldName enum value
	ConfluenceSpaceFieldNameUrl = "URL"
)
View Source 
const (
	// ConfluenceVersionCloud is a ConfluenceVersion enum value
	ConfluenceVersionCloud = "CLOUD"

	// ConfluenceVersionServer is a ConfluenceVersion enum value
	ConfluenceVersionServer = "SERVER"
)
View Source 
const (
	// ContentTypePdf is a ContentType enum value
	ContentTypePdf = "PDF"

	// ContentTypeHtml is a ContentType enum value
	ContentTypeHtml = "HTML"

	// ContentTypeMsWord is a ContentType enum value
	ContentTypeMsWord = "MS_WORD"

	// ContentTypePlainText is a ContentType enum value
	ContentTypePlainText = "PLAIN_TEXT"

	// ContentTypePpt is a ContentType enum value
	ContentTypePpt = "PPT"

	// ContentTypeRtf is a ContentType enum value
	ContentTypeRtf = "RTF"

	// ContentTypeXml is a ContentType enum value
	ContentTypeXml = "XML"

	// ContentTypeXslt is a ContentType enum value
	ContentTypeXslt = "XSLT"

	// ContentTypeMsExcel is a ContentType enum value
	ContentTypeMsExcel = "MS_EXCEL"

	// ContentTypeCsv is a ContentType enum value
	ContentTypeCsv = "CSV"

	// ContentTypeJson is a ContentType enum value
	ContentTypeJson = "JSON"

	// ContentTypeMd is a ContentType enum value
	ContentTypeMd = "MD"
)
View Source 
const (
	// DataSourceStatusCreating is a DataSourceStatus enum value
	DataSourceStatusCreating = "CREATING"

	// DataSourceStatusDeleting is a DataSourceStatus enum value
	DataSourceStatusDeleting = "DELETING"

	// DataSourceStatusFailed is a DataSourceStatus enum value
	DataSourceStatusFailed = "FAILED"

	// DataSourceStatusUpdating is a DataSourceStatus enum value
	DataSourceStatusUpdating = "UPDATING"

	// DataSourceStatusActive is a DataSourceStatus enum value
	DataSourceStatusActive = "ACTIVE"
)
View Source 
const (
	// DataSourceSyncJobStatusFailed is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusFailed = "FAILED"

	// DataSourceSyncJobStatusSucceeded is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusSucceeded = "SUCCEEDED"

	// DataSourceSyncJobStatusSyncing is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusSyncing = "SYNCING"

	// DataSourceSyncJobStatusIncomplete is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusIncomplete = "INCOMPLETE"

	// DataSourceSyncJobStatusStopping is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusStopping = "STOPPING"

	// DataSourceSyncJobStatusAborted is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusAborted = "ABORTED"

	// DataSourceSyncJobStatusSyncingIndexing is a DataSourceSyncJobStatus enum value
	DataSourceSyncJobStatusSyncingIndexing = "SYNCING_INDEXING"
)
View Source 
const (
	// DataSourceTypeS3 is a DataSourceType enum value
	DataSourceTypeS3 = "S3"

	// DataSourceTypeSharepoint is a DataSourceType enum value
	DataSourceTypeSharepoint = "SHAREPOINT"

	// DataSourceTypeDatabase is a DataSourceType enum value
	DataSourceTypeDatabase = "DATABASE"

	// DataSourceTypeSalesforce is a DataSourceType enum value
	DataSourceTypeSalesforce = "SALESFORCE"

	// DataSourceTypeOnedrive is a DataSourceType enum value
	DataSourceTypeOnedrive = "ONEDRIVE"

	// DataSourceTypeServicenow is a DataSourceType enum value
	DataSourceTypeServicenow = "SERVICENOW"

	// DataSourceTypeCustom is a DataSourceType enum value
	DataSourceTypeCustom = "CUSTOM"

	// DataSourceTypeConfluence is a DataSourceType enum value
	DataSourceTypeConfluence = "CONFLUENCE"

	// DataSourceTypeGoogledrive is a DataSourceType enum value
	DataSourceTypeGoogledrive = "GOOGLEDRIVE"

	// DataSourceTypeWebcrawler is a DataSourceType enum value
	DataSourceTypeWebcrawler = "WEBCRAWLER"

	// DataSourceTypeWorkdocs is a DataSourceType enum value
	DataSourceTypeWorkdocs = "WORKDOCS"

	// DataSourceTypeFsx is a DataSourceType enum value
	DataSourceTypeFsx = "FSX"

	// DataSourceTypeSlack is a DataSourceType enum value
	DataSourceTypeSlack = "SLACK"

	// DataSourceTypeBox is a DataSourceType enum value
	DataSourceTypeBox = "BOX"

	// DataSourceTypeQuip is a DataSourceType enum value
	DataSourceTypeQuip = "QUIP"

	// DataSourceTypeJira is a DataSourceType enum value
	DataSourceTypeJira = "JIRA"

	// DataSourceTypeGithub is a DataSourceType enum value
	DataSourceTypeGithub = "GITHUB"

	// DataSourceTypeAlfresco is a DataSourceType enum value
	DataSourceTypeAlfresco = "ALFRESCO"

	// DataSourceTypeTemplate is a DataSourceType enum value
	DataSourceTypeTemplate = "TEMPLATE"
)
View Source 
const (
	// DatabaseEngineTypeRdsAuroraMysql is a DatabaseEngineType enum value
	DatabaseEngineTypeRdsAuroraMysql = "RDS_AURORA_MYSQL"

	// DatabaseEngineTypeRdsAuroraPostgresql is a DatabaseEngineType enum value
	DatabaseEngineTypeRdsAuroraPostgresql = "RDS_AURORA_POSTGRESQL"

	// DatabaseEngineTypeRdsMysql is a DatabaseEngineType enum value
	DatabaseEngineTypeRdsMysql = "RDS_MYSQL"

	// DatabaseEngineTypeRdsPostgresql is a DatabaseEngineType enum value
	DatabaseEngineTypeRdsPostgresql = "RDS_POSTGRESQL"
)
View Source 
const (
	// DocumentAttributeValueTypeStringValue is a DocumentAttributeValueType enum value
	DocumentAttributeValueTypeStringValue = "STRING_VALUE"

	// DocumentAttributeValueTypeStringListValue is a DocumentAttributeValueType enum value
	DocumentAttributeValueTypeStringListValue = "STRING_LIST_VALUE"

	// DocumentAttributeValueTypeLongValue is a DocumentAttributeValueType enum value
	DocumentAttributeValueTypeLongValue = "LONG_VALUE"

	// DocumentAttributeValueTypeDateValue is a DocumentAttributeValueType enum value
	DocumentAttributeValueTypeDateValue = "DATE_VALUE"
)
View Source 
const (
	// DocumentStatusNotFound is a DocumentStatus enum value
	DocumentStatusNotFound = "NOT_FOUND"

	// DocumentStatusProcessing is a DocumentStatus enum value
	DocumentStatusProcessing = "PROCESSING"

	// DocumentStatusIndexed is a DocumentStatus enum value
	DocumentStatusIndexed = "INDEXED"

	// DocumentStatusUpdated is a DocumentStatus enum value
	DocumentStatusUpdated = "UPDATED"

	// DocumentStatusFailed is a DocumentStatus enum value
	DocumentStatusFailed = "FAILED"

	// DocumentStatusUpdateFailed is a DocumentStatus enum value
	DocumentStatusUpdateFailed = "UPDATE_FAILED"
)
View Source 
const (
	// EntityTypeUser is a EntityType enum value
	EntityTypeUser = "USER"

	// EntityTypeGroup is a EntityType enum value
	EntityTypeGroup = "GROUP"
)
View Source 
const (
	// ErrorCodeInternalError is a ErrorCode enum value
	ErrorCodeInternalError = "InternalError"

	// ErrorCodeInvalidRequest is a ErrorCode enum value
	ErrorCodeInvalidRequest = "InvalidRequest"
)
View Source 
const (
	// ExperienceStatusCreating is a ExperienceStatus enum value
	ExperienceStatusCreating = "CREATING"

	// ExperienceStatusActive is a ExperienceStatus enum value
	ExperienceStatusActive = "ACTIVE"

	// ExperienceStatusDeleting is a ExperienceStatus enum value
	ExperienceStatusDeleting = "DELETING"

	// ExperienceStatusFailed is a ExperienceStatus enum value
	ExperienceStatusFailed = "FAILED"
)
View Source 
const (
	// FaqFileFormatCsv is a FaqFileFormat enum value
	FaqFileFormatCsv = "CSV"

	// FaqFileFormatCsvWithHeader is a FaqFileFormat enum value
	FaqFileFormatCsvWithHeader = "CSV_WITH_HEADER"

	// FaqFileFormatJson is a FaqFileFormat enum value
	FaqFileFormatJson = "JSON"
)
View Source 
const (
	// FaqStatusCreating is a FaqStatus enum value
	FaqStatusCreating = "CREATING"

	// FaqStatusUpdating is a FaqStatus enum value
	FaqStatusUpdating = "UPDATING"

	// FaqStatusActive is a FaqStatus enum value
	FaqStatusActive = "ACTIVE"

	// FaqStatusDeleting is a FaqStatus enum value
	FaqStatusDeleting = "DELETING"

	// FaqStatusFailed is a FaqStatus enum value
	FaqStatusFailed = "FAILED"
)
View Source 
const (
	// FeaturedResultsSetStatusActive is a FeaturedResultsSetStatus enum value
	FeaturedResultsSetStatusActive = "ACTIVE"

	// FeaturedResultsSetStatusInactive is a FeaturedResultsSetStatus enum value
	FeaturedResultsSetStatusInactive = "INACTIVE"
)
View Source 
const (
	// HighlightTypeStandard is a HighlightType enum value
	HighlightTypeStandard = "STANDARD"

	// HighlightTypeThesaurusSynonym is a HighlightType enum value
	HighlightTypeThesaurusSynonym = "THESAURUS_SYNONYM"
)
View Source 
const (
	// IndexEditionDeveloperEdition is a IndexEdition enum value
	IndexEditionDeveloperEdition = "DEVELOPER_EDITION"

	// IndexEditionEnterpriseEdition is a IndexEdition enum value
	IndexEditionEnterpriseEdition = "ENTERPRISE_EDITION"
)
View Source 
const (
	// IndexStatusCreating is a IndexStatus enum value
	IndexStatusCreating = "CREATING"

	// IndexStatusActive is a IndexStatus enum value
	IndexStatusActive = "ACTIVE"

	// IndexStatusDeleting is a IndexStatus enum value
	IndexStatusDeleting = "DELETING"

	// IndexStatusFailed is a IndexStatus enum value
	IndexStatusFailed = "FAILED"

	// IndexStatusUpdating is a IndexStatus enum value
	IndexStatusUpdating = "UPDATING"

	// IndexStatusSystemUpdating is a IndexStatus enum value
	IndexStatusSystemUpdating = "SYSTEM_UPDATING"
)
View Source 
const (
	// IntervalThisMonth is a Interval enum value
	IntervalThisMonth = "THIS_MONTH"

	// IntervalThisWeek is a Interval enum value
	IntervalThisWeek = "THIS_WEEK"

	// IntervalOneWeekAgo is a Interval enum value
	IntervalOneWeekAgo = "ONE_WEEK_AGO"

	// IntervalTwoWeeksAgo is a Interval enum value
	IntervalTwoWeeksAgo = "TWO_WEEKS_AGO"

	// IntervalOneMonthAgo is a Interval enum value
	IntervalOneMonthAgo = "ONE_MONTH_AGO"

	// IntervalTwoMonthsAgo is a Interval enum value
	IntervalTwoMonthsAgo = "TWO_MONTHS_AGO"
)
View Source 
const (
	// IssueSubEntityComments is a IssueSubEntity enum value
	IssueSubEntityComments = "COMMENTS"

	// IssueSubEntityAttachments is a IssueSubEntity enum value
	IssueSubEntityAttachments = "ATTACHMENTS"

	// IssueSubEntityWorklogs is a IssueSubEntity enum value
	IssueSubEntityWorklogs = "WORKLOGS"
)
View Source 
const (
	// KeyLocationUrl is a KeyLocation enum value
	KeyLocationUrl = "URL"

	// KeyLocationSecretManager is a KeyLocation enum value
	KeyLocationSecretManager = "SECRET_MANAGER"
)
View Source 
const (
	// MetricTypeQueriesByCount is a MetricType enum value
	MetricTypeQueriesByCount = "QUERIES_BY_COUNT"

	// MetricTypeQueriesByZeroClickRate is a MetricType enum value
	MetricTypeQueriesByZeroClickRate = "QUERIES_BY_ZERO_CLICK_RATE"

	// MetricTypeQueriesByZeroResultRate is a MetricType enum value
	MetricTypeQueriesByZeroResultRate = "QUERIES_BY_ZERO_RESULT_RATE"

	// MetricTypeDocsByClickCount is a MetricType enum value
	MetricTypeDocsByClickCount = "DOCS_BY_CLICK_COUNT"

	// MetricTypeAggQueryDocMetrics is a MetricType enum value
	MetricTypeAggQueryDocMetrics = "AGG_QUERY_DOC_METRICS"

	// MetricTypeTrendQueryDocMetrics is a MetricType enum value
	MetricTypeTrendQueryDocMetrics = "TREND_QUERY_DOC_METRICS"
)
View Source 
const (
	// MissingAttributeKeyStrategyIgnore is a MissingAttributeKeyStrategy enum value
	MissingAttributeKeyStrategyIgnore = "IGNORE"

	// MissingAttributeKeyStrategyCollapse is a MissingAttributeKeyStrategy enum value
	MissingAttributeKeyStrategyCollapse = "COLLAPSE"

	// MissingAttributeKeyStrategyExpand is a MissingAttributeKeyStrategy enum value
	MissingAttributeKeyStrategyExpand = "EXPAND"
)
View Source 
const (
	// ModeEnabled is a Mode enum value
	ModeEnabled = "ENABLED"

	// ModeLearnOnly is a Mode enum value
	ModeLearnOnly = "LEARN_ONLY"
)
View Source 
const (
	// OrderAscending is a Order enum value
	OrderAscending = "ASCENDING"

	// OrderDescending is a Order enum value
	OrderDescending = "DESCENDING"
)
View Source 
const (
	// PersonaOwner is a Persona enum value
	PersonaOwner = "OWNER"

	// PersonaViewer is a Persona enum value
	PersonaViewer = "VIEWER"
)
View Source 
const (
	// PrincipalMappingStatusFailed is a PrincipalMappingStatus enum value
	PrincipalMappingStatusFailed = "FAILED"

	// PrincipalMappingStatusSucceeded is a PrincipalMappingStatus enum value
	PrincipalMappingStatusSucceeded = "SUCCEEDED"

	// PrincipalMappingStatusProcessing is a PrincipalMappingStatus enum value
	PrincipalMappingStatusProcessing = "PROCESSING"

	// PrincipalMappingStatusDeleting is a PrincipalMappingStatus enum value
	PrincipalMappingStatusDeleting = "DELETING"

	// PrincipalMappingStatusDeleted is a PrincipalMappingStatus enum value
	PrincipalMappingStatusDeleted = "DELETED"
)
View Source 
const (
	// PrincipalTypeUser is a PrincipalType enum value
	PrincipalTypeUser = "USER"

	// PrincipalTypeGroup is a PrincipalType enum value
	PrincipalTypeGroup = "GROUP"
)
View Source 
const (
	// QueryIdentifiersEnclosingOptionDoubleQuotes is a QueryIdentifiersEnclosingOption enum value
	QueryIdentifiersEnclosingOptionDoubleQuotes = "DOUBLE_QUOTES"

	// QueryIdentifiersEnclosingOptionNone is a QueryIdentifiersEnclosingOption enum value
	QueryIdentifiersEnclosingOptionNone = "NONE"
)
View Source 
const (
	// QueryResultFormatTable is a QueryResultFormat enum value
	QueryResultFormatTable = "TABLE"

	// QueryResultFormatText is a QueryResultFormat enum value
	QueryResultFormatText = "TEXT"
)
View Source 
const (
	// QueryResultTypeDocument is a QueryResultType enum value
	QueryResultTypeDocument = "DOCUMENT"

	// QueryResultTypeQuestionAnswer is a QueryResultType enum value
	QueryResultTypeQuestionAnswer = "QUESTION_ANSWER"

	// QueryResultTypeAnswer is a QueryResultType enum value
	QueryResultTypeAnswer = "ANSWER"
)
View Source 
const (
	// QuerySuggestionsBlockListStatusActive is a QuerySuggestionsBlockListStatus enum value
	QuerySuggestionsBlockListStatusActive = "ACTIVE"

	// QuerySuggestionsBlockListStatusCreating is a QuerySuggestionsBlockListStatus enum value
	QuerySuggestionsBlockListStatusCreating = "CREATING"

	// QuerySuggestionsBlockListStatusDeleting is a QuerySuggestionsBlockListStatus enum value
	QuerySuggestionsBlockListStatusDeleting = "DELETING"

	// QuerySuggestionsBlockListStatusUpdating is a QuerySuggestionsBlockListStatus enum value
	QuerySuggestionsBlockListStatusUpdating = "UPDATING"

	// QuerySuggestionsBlockListStatusActiveButUpdateFailed is a QuerySuggestionsBlockListStatus enum value
	QuerySuggestionsBlockListStatusActiveButUpdateFailed = "ACTIVE_BUT_UPDATE_FAILED"

	// QuerySuggestionsBlockListStatusFailed is a QuerySuggestionsBlockListStatus enum value
	QuerySuggestionsBlockListStatusFailed = "FAILED"
)
View Source 
const (
	// QuerySuggestionsStatusActive is a QuerySuggestionsStatus enum value
	QuerySuggestionsStatusActive = "ACTIVE"

	// QuerySuggestionsStatusUpdating is a QuerySuggestionsStatus enum value
	QuerySuggestionsStatusUpdating = "UPDATING"
)
View Source 
const (
	// ReadAccessTypeAllow is a ReadAccessType enum value
	ReadAccessTypeAllow = "ALLOW"

	// ReadAccessTypeDeny is a ReadAccessType enum value
	ReadAccessTypeDeny = "DENY"
)
View Source 
const (
	// RelevanceTypeRelevant is a RelevanceType enum value
	RelevanceTypeRelevant = "RELEVANT"

	// RelevanceTypeNotRelevant is a RelevanceType enum value
	RelevanceTypeNotRelevant = "NOT_RELEVANT"
)
View Source 
const (
	// SalesforceChatterFeedIncludeFilterTypeActiveUser is a SalesforceChatterFeedIncludeFilterType enum value
	SalesforceChatterFeedIncludeFilterTypeActiveUser = "ACTIVE_USER"

	// SalesforceChatterFeedIncludeFilterTypeStandardUser is a SalesforceChatterFeedIncludeFilterType enum value
	SalesforceChatterFeedIncludeFilterTypeStandardUser = "STANDARD_USER"
)
View Source 
const (
	// SalesforceKnowledgeArticleStateDraft is a SalesforceKnowledgeArticleState enum value
	SalesforceKnowledgeArticleStateDraft = "DRAFT"

	// SalesforceKnowledgeArticleStatePublished is a SalesforceKnowledgeArticleState enum value
	SalesforceKnowledgeArticleStatePublished = "PUBLISHED"

	// SalesforceKnowledgeArticleStateArchived is a SalesforceKnowledgeArticleState enum value
	SalesforceKnowledgeArticleStateArchived = "ARCHIVED"
)
View Source 
const (
	// SalesforceStandardObjectNameAccount is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameAccount = "ACCOUNT"

	// SalesforceStandardObjectNameCampaign is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameCampaign = "CAMPAIGN"

	// SalesforceStandardObjectNameCase is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameCase = "CASE"

	// SalesforceStandardObjectNameContact is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameContact = "CONTACT"

	// SalesforceStandardObjectNameContract is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameContract = "CONTRACT"

	// SalesforceStandardObjectNameDocument is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameDocument = "DOCUMENT"

	// SalesforceStandardObjectNameGroup is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameGroup = "GROUP"

	// SalesforceStandardObjectNameIdea is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameIdea = "IDEA"

	// SalesforceStandardObjectNameLead is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameLead = "LEAD"

	// SalesforceStandardObjectNameOpportunity is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameOpportunity = "OPPORTUNITY"

	// SalesforceStandardObjectNamePartner is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNamePartner = "PARTNER"

	// SalesforceStandardObjectNamePricebook is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNamePricebook = "PRICEBOOK"

	// SalesforceStandardObjectNameProduct is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameProduct = "PRODUCT"

	// SalesforceStandardObjectNameProfile is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameProfile = "PROFILE"

	// SalesforceStandardObjectNameSolution is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameSolution = "SOLUTION"

	// SalesforceStandardObjectNameTask is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameTask = "TASK"

	// SalesforceStandardObjectNameUser is a SalesforceStandardObjectName enum value
	SalesforceStandardObjectNameUser = "USER"
)
View Source 
const (
	// ScoreConfidenceVeryHigh is a ScoreConfidence enum value
	ScoreConfidenceVeryHigh = "VERY_HIGH"

	// ScoreConfidenceHigh is a ScoreConfidence enum value
	ScoreConfidenceHigh = "HIGH"

	// ScoreConfidenceMedium is a ScoreConfidence enum value
	ScoreConfidenceMedium = "MEDIUM"

	// ScoreConfidenceLow is a ScoreConfidence enum value
	ScoreConfidenceLow = "LOW"

	// ScoreConfidenceNotAvailable is a ScoreConfidence enum value
	ScoreConfidenceNotAvailable = "NOT_AVAILABLE"
)

Enumeration for query score confidence.

View Source 
const (
	// ServiceNowAuthenticationTypeHttpBasic is a ServiceNowAuthenticationType enum value
	ServiceNowAuthenticationTypeHttpBasic = "HTTP_BASIC"

	// ServiceNowAuthenticationTypeOauth2 is a ServiceNowAuthenticationType enum value
	ServiceNowAuthenticationTypeOauth2 = "OAUTH2"
)
View Source 
const (
	// ServiceNowBuildVersionTypeLondon is a ServiceNowBuildVersionType enum value
	ServiceNowBuildVersionTypeLondon = "LONDON"

	// ServiceNowBuildVersionTypeOthers is a ServiceNowBuildVersionType enum value
	ServiceNowBuildVersionTypeOthers = "OTHERS"
)
View Source 
const (
	// SharePointOnlineAuthenticationTypeHttpBasic is a SharePointOnlineAuthenticationType enum value
	SharePointOnlineAuthenticationTypeHttpBasic = "HTTP_BASIC"

	// SharePointOnlineAuthenticationTypeOauth2 is a SharePointOnlineAuthenticationType enum value
	SharePointOnlineAuthenticationTypeOauth2 = "OAUTH2"
)
View Source 
const (
	// SharePointVersionSharepoint2013 is a SharePointVersion enum value
	SharePointVersionSharepoint2013 = "SHAREPOINT_2013"

	// SharePointVersionSharepoint2016 is a SharePointVersion enum value
	SharePointVersionSharepoint2016 = "SHAREPOINT_2016"

	// SharePointVersionSharepointOnline is a SharePointVersion enum value
	SharePointVersionSharepointOnline = "SHAREPOINT_ONLINE"

	// SharePointVersionSharepoint2019 is a SharePointVersion enum value
	SharePointVersionSharepoint2019 = "SHAREPOINT_2019"
)
View Source 
const (
	// SlackEntityPublicChannel is a SlackEntity enum value
	SlackEntityPublicChannel = "PUBLIC_CHANNEL"

	// SlackEntityPrivateChannel is a SlackEntity enum value
	SlackEntityPrivateChannel = "PRIVATE_CHANNEL"

	// SlackEntityGroupMessage is a SlackEntity enum value
	SlackEntityGroupMessage = "GROUP_MESSAGE"

	// SlackEntityDirectMessage is a SlackEntity enum value
	SlackEntityDirectMessage = "DIRECT_MESSAGE"
)
View Source 
const (
	// SortOrderDesc is a SortOrder enum value
	SortOrderDesc = "DESC"

	// SortOrderAsc is a SortOrder enum value
	SortOrderAsc = "ASC"
)
View Source 
const (
	// SuggestionTypeQuery is a SuggestionType enum value
	SuggestionTypeQuery = "QUERY"

	// SuggestionTypeDocumentAttributes is a SuggestionType enum value
	SuggestionTypeDocumentAttributes = "DOCUMENT_ATTRIBUTES"
)
View Source 
const (
	// ThesaurusStatusCreating is a ThesaurusStatus enum value
	ThesaurusStatusCreating = "CREATING"

	// ThesaurusStatusActive is a ThesaurusStatus enum value
	ThesaurusStatusActive = "ACTIVE"

	// ThesaurusStatusDeleting is a ThesaurusStatus enum value
	ThesaurusStatusDeleting = "DELETING"

	// ThesaurusStatusUpdating is a ThesaurusStatus enum value
	ThesaurusStatusUpdating = "UPDATING"

	// ThesaurusStatusActiveButUpdateFailed is a ThesaurusStatus enum value
	ThesaurusStatusActiveButUpdateFailed = "ACTIVE_BUT_UPDATE_FAILED"

	// ThesaurusStatusFailed is a ThesaurusStatus enum value
	ThesaurusStatusFailed = "FAILED"
)
View Source 
const (
	// TypeSaas is a Type enum value
	TypeSaas = "SAAS"

	// TypeOnPremise is a Type enum value
	TypeOnPremise = "ON_PREMISE"
)
View Source 
const (
	// UserContextPolicyAttributeFilter is a UserContextPolicy enum value
	UserContextPolicyAttributeFilter = "ATTRIBUTE_FILTER"

	// UserContextPolicyUserToken is a UserContextPolicy enum value
	UserContextPolicyUserToken = "USER_TOKEN"
)
View Source 
const (
	// UserGroupResolutionModeAwsSso is a UserGroupResolutionMode enum value
	UserGroupResolutionModeAwsSso = "AWS_SSO"

	// UserGroupResolutionModeNone is a UserGroupResolutionMode enum value
	UserGroupResolutionModeNone = "NONE"
)
View Source 
const (
	// WebCrawlerModeHostOnly is a WebCrawlerMode enum value
	WebCrawlerModeHostOnly = "HOST_ONLY"

	// WebCrawlerModeSubdomains is a WebCrawlerMode enum value
	WebCrawlerModeSubdomains = "SUBDOMAINS"

	// WebCrawlerModeEverything is a WebCrawlerMode enum value
	WebCrawlerModeEverything = "EVERYTHING"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have sufficient access to perform this action. Please ensure you
	// have the required permission policies and user accounts and try again.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A conflict occurred with the request. Please fix any inconsistences with
	// your resources and try again.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeFeaturedResultsConflictException for service response error code
	// "FeaturedResultsConflictException".
	//
	// An error message with a list of conflicting queries used across different
	// sets of featured results. This occurred with the request for a new featured
	// results set. Check that the queries you specified for featured results are
	// unique per featured results set for each index.
	ErrCodeFeaturedResultsConflictException = "FeaturedResultsConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An issue occurred with the internal server used for your Amazon Kendra service.
	// Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/)
	// for help.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The input to the request is not valid. Please provide the correct input and
	// try again.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeResourceAlreadyExistException for service response error code
	// "ResourceAlreadyExistException".
	//
	// The resource you want to use already exists. Please check you have provided
	// the correct resource and try again.
	ErrCodeResourceAlreadyExistException = "ResourceAlreadyExistException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The resource you want to use is currently in use. Please check you have provided
	// the correct resource and try again.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource you want to use doesn’t exist. Please check you have provided
	// the correct resource and try again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceUnavailableException for service response error code
	// "ResourceUnavailableException".
	//
	// The resource you want to use isn't available. Please check you have provided
	// the correct resource and try again.
	ErrCodeResourceUnavailableException = "ResourceUnavailableException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You have exceeded the set limits for your Amazon Kendra service. Please see
	// Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more
	// information, or contact Support (http://aws.amazon.com/contact-us/) to inquire
	// about an increase of limits.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling. Please reduce the number
	// of requests and try again.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints set by the Amazon Kendra service.
	// Please provide the correct input and try again.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "kendra"    // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "kendra"    // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// AdditionalResultAttributeValueTypeTextWithHighlightsValue is a AdditionalResultAttributeValueType enum value
	AdditionalResultAttributeValueTypeTextWithHighlightsValue = "TEXT_WITH_HIGHLIGHTS_VALUE"
)
View Source 
const (
	// EndpointTypeHome is a EndpointType enum value
	EndpointTypeHome = "HOME"
)
View Source 
const (
	// FsxFileSystemTypeWindows is a FsxFileSystemType enum value
	FsxFileSystemTypeWindows = "WINDOWS"
)
View Source 
const (
	// WarningCodeQueryLanguageInvalidSyntax is a WarningCode enum value
	WarningCodeQueryLanguageInvalidSyntax = "QUERY_LANGUAGE_INVALID_SYNTAX"
)

Variables

This section is empty.

Functions

func AdditionalResultAttributeValueType_Values added in v1.34.3 

func AdditionalResultAttributeValueType_Values() []string

AdditionalResultAttributeValueType_Values returns all elements of the AdditionalResultAttributeValueType enum

func AlfrescoEntity_Values added in v1.44.46 

func AlfrescoEntity_Values() []string

AlfrescoEntity_Values returns all elements of the AlfrescoEntity enum

func AttributeSuggestionsMode_Values added in v1.44.255 

func AttributeSuggestionsMode_Values() []string

AttributeSuggestionsMode_Values returns all elements of the AttributeSuggestionsMode enum

func ConditionOperator_Values added in v1.42.17 

func ConditionOperator_Values() []string

ConditionOperator_Values returns all elements of the ConditionOperator enum

func ConfluenceAttachmentFieldName_Values added in v1.35.15 

func ConfluenceAttachmentFieldName_Values() []string

ConfluenceAttachmentFieldName_Values returns all elements of the ConfluenceAttachmentFieldName enum

func ConfluenceAuthenticationType_Values added in v1.44.81 

func ConfluenceAuthenticationType_Values() []string

ConfluenceAuthenticationType_Values returns all elements of the ConfluenceAuthenticationType enum

func ConfluenceBlogFieldName_Values added in v1.35.15 

func ConfluenceBlogFieldName_Values() []string

ConfluenceBlogFieldName_Values returns all elements of the ConfluenceBlogFieldName enum

func ConfluencePageFieldName_Values added in v1.35.15 

func ConfluencePageFieldName_Values() []string

ConfluencePageFieldName_Values returns all elements of the ConfluencePageFieldName enum

func ConfluenceSpaceFieldName_Values added in v1.35.15 

func ConfluenceSpaceFieldName_Values() []string

ConfluenceSpaceFieldName_Values returns all elements of the ConfluenceSpaceFieldName enum

func ConfluenceVersion_Values added in v1.35.15 

func ConfluenceVersion_Values() []string

ConfluenceVersion_Values returns all elements of the ConfluenceVersion enum

func ContentType_Values added in v1.34.3 

func ContentType_Values() []string

ContentType_Values returns all elements of the ContentType enum

func DataSourceStatus_Values added in v1.34.3 

func DataSourceStatus_Values() []string

DataSourceStatus_Values returns all elements of the DataSourceStatus enum

func DataSourceSyncJobStatus_Values added in v1.34.3 

func DataSourceSyncJobStatus_Values() []string

DataSourceSyncJobStatus_Values returns all elements of the DataSourceSyncJobStatus enum

func DataSourceType_Values added in v1.34.3 

func DataSourceType_Values() []string

DataSourceType_Values returns all elements of the DataSourceType enum

func DatabaseEngineType_Values added in v1.34.3 

func DatabaseEngineType_Values() []string

DatabaseEngineType_Values returns all elements of the DatabaseEngineType enum

func DocumentAttributeValueType_Values added in v1.34.3 

func DocumentAttributeValueType_Values() []string

DocumentAttributeValueType_Values returns all elements of the DocumentAttributeValueType enum

func DocumentStatus_Values added in v1.38.58 

func DocumentStatus_Values() []string

DocumentStatus_Values returns all elements of the DocumentStatus enum

func EndpointType_Values added in v1.42.17 

func EndpointType_Values() []string

EndpointType_Values returns all elements of the EndpointType enum

func EntityType_Values added in v1.42.17 

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func ErrorCode_Values added in v1.34.3 

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func ExperienceStatus_Values added in v1.42.17 

func ExperienceStatus_Values() []string

ExperienceStatus_Values returns all elements of the ExperienceStatus enum

func FaqFileFormat_Values added in v1.34.26 

func FaqFileFormat_Values() []string

FaqFileFormat_Values returns all elements of the FaqFileFormat enum

func FaqStatus_Values added in v1.34.3 

func FaqStatus_Values() []string

FaqStatus_Values returns all elements of the FaqStatus enum

func FeaturedResultsSetStatus_Values added in v1.44.233 

func FeaturedResultsSetStatus_Values() []string

FeaturedResultsSetStatus_Values returns all elements of the FeaturedResultsSetStatus enum

func FsxFileSystemType_Values added in v1.42.49 

func FsxFileSystemType_Values() []string

FsxFileSystemType_Values returns all elements of the FsxFileSystemType enum

func HighlightType_Values added in v1.36.6 

func HighlightType_Values() []string

HighlightType_Values returns all elements of the HighlightType enum

func IndexEdition_Values added in v1.34.3 

func IndexEdition_Values() []string

IndexEdition_Values returns all elements of the IndexEdition enum

func IndexStatus_Values added in v1.34.3 

func IndexStatus_Values() []string

IndexStatus_Values returns all elements of the IndexStatus enum

func Interval_Values added in v1.42.17 

func Interval_Values() []string

Interval_Values returns all elements of the Interval enum

func IssueSubEntity_Values added in v1.44.13 

func IssueSubEntity_Values() []string

IssueSubEntity_Values returns all elements of the IssueSubEntity enum

func KeyLocation_Values added in v1.35.22 

func KeyLocation_Values() []string

KeyLocation_Values returns all elements of the KeyLocation enum

func MetricType_Values added in v1.42.17 

func MetricType_Values() []string

MetricType_Values returns all elements of the MetricType enum

func MissingAttributeKeyStrategy_Values added in v1.45.28 

func MissingAttributeKeyStrategy_Values() []string

MissingAttributeKeyStrategy_Values returns all elements of the MissingAttributeKeyStrategy enum

func Mode_Values added in v1.38.50 

func Mode_Values() []string

Mode_Values returns all elements of the Mode enum

func Order_Values added in v1.34.3 

func Order_Values() []string

Order_Values returns all elements of the Order enum

func Persona_Values added in v1.42.17 

func Persona_Values() []string

Persona_Values returns all elements of the Persona enum

func PrincipalMappingStatus_Values added in v1.39.5 

func PrincipalMappingStatus_Values() []string

PrincipalMappingStatus_Values returns all elements of the PrincipalMappingStatus enum

func PrincipalType_Values added in v1.34.3 

func PrincipalType_Values() []string

PrincipalType_Values returns all elements of the PrincipalType enum

func QueryIdentifiersEnclosingOption_Values added in v1.34.3 

func QueryIdentifiersEnclosingOption_Values() []string

QueryIdentifiersEnclosingOption_Values returns all elements of the QueryIdentifiersEnclosingOption enum

func QueryResultFormat_Values added in v1.44.146 

func QueryResultFormat_Values() []string

QueryResultFormat_Values returns all elements of the QueryResultFormat enum

func QueryResultType_Values added in v1.34.3 

func QueryResultType_Values() []string

QueryResultType_Values returns all elements of the QueryResultType enum

func QuerySuggestionsBlockListStatus_Values added in v1.38.50 

func QuerySuggestionsBlockListStatus_Values() []string

QuerySuggestionsBlockListStatus_Values returns all elements of the QuerySuggestionsBlockListStatus enum

func QuerySuggestionsStatus_Values added in v1.38.50 

func QuerySuggestionsStatus_Values() []string

QuerySuggestionsStatus_Values returns all elements of the QuerySuggestionsStatus enum

func ReadAccessType_Values added in v1.34.3 

func ReadAccessType_Values() []string

ReadAccessType_Values returns all elements of the ReadAccessType enum

func RelevanceType_Values added in v1.34.3 

func RelevanceType_Values() []string

RelevanceType_Values returns all elements of the RelevanceType enum

func SalesforceChatterFeedIncludeFilterType_Values added in v1.34.3 

func SalesforceChatterFeedIncludeFilterType_Values() []string

SalesforceChatterFeedIncludeFilterType_Values returns all elements of the SalesforceChatterFeedIncludeFilterType enum

func SalesforceKnowledgeArticleState_Values added in v1.34.3 

func SalesforceKnowledgeArticleState_Values() []string

SalesforceKnowledgeArticleState_Values returns all elements of the SalesforceKnowledgeArticleState enum

func SalesforceStandardObjectName_Values added in v1.34.3 

func SalesforceStandardObjectName_Values() []string

SalesforceStandardObjectName_Values returns all elements of the SalesforceStandardObjectName enum

func ScoreConfidence_Values added in v1.34.17 

func ScoreConfidence_Values() []string

ScoreConfidence_Values returns all elements of the ScoreConfidence enum

func ServiceNowAuthenticationType_Values added in v1.38.11 

func ServiceNowAuthenticationType_Values() []string

ServiceNowAuthenticationType_Values returns all elements of the ServiceNowAuthenticationType enum

func ServiceNowBuildVersionType_Values added in v1.34.3 

func ServiceNowBuildVersionType_Values() []string

ServiceNowBuildVersionType_Values returns all elements of the ServiceNowBuildVersionType enum

func SharePointOnlineAuthenticationType_Values added in v1.44.60 

func SharePointOnlineAuthenticationType_Values() []string

SharePointOnlineAuthenticationType_Values returns all elements of the SharePointOnlineAuthenticationType enum

func SharePointVersion_Values added in v1.34.3 

func SharePointVersion_Values() []string

SharePointVersion_Values returns all elements of the SharePointVersion enum

func SlackEntity_Values added in v1.43.18 

func SlackEntity_Values() []string

SlackEntity_Values returns all elements of the SlackEntity enum

func SortOrder_Values added in v1.34.3 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func SuggestionType_Values added in v1.44.255 

func SuggestionType_Values() []string

SuggestionType_Values returns all elements of the SuggestionType enum

func ThesaurusStatus_Values added in v1.36.6 

func ThesaurusStatus_Values() []string

ThesaurusStatus_Values returns all elements of the ThesaurusStatus enum

func Type_Values added in v1.44.27 

func Type_Values() []string

Type_Values returns all elements of the Type enum

func UserContextPolicy_Values added in v1.35.22 

func UserContextPolicy_Values() []string

UserContextPolicy_Values returns all elements of the UserContextPolicy enum

func UserGroupResolutionMode_Values added in v1.40.57 

func UserGroupResolutionMode_Values() []string

UserGroupResolutionMode_Values returns all elements of the UserGroupResolutionMode enum

func WarningCode_Values added in v1.42.32 

func WarningCode_Values() []string

WarningCode_Values returns all elements of the WarningCode enum

func WebCrawlerMode_Values added in v1.38.64 

func WebCrawlerMode_Values() []string

WebCrawlerMode_Values returns all elements of the WebCrawlerMode enum

Types

type AccessControlConfigurationSummary added in v1.44.55 

type AccessControlConfigurationSummary struct {

	// The identifier of the access control configuration.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Summary information on an access control configuration that you created for your documents in an index.

func (AccessControlConfigurationSummary) GoString added in v1.44.55 

func (s AccessControlConfigurationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessControlConfigurationSummary) SetId added in v1.44.55 

func (s *AccessControlConfigurationSummary) SetId(v string) *AccessControlConfigurationSummary

SetId sets the Id field's value.

func (AccessControlConfigurationSummary) String added in v1.44.55 

func (s AccessControlConfigurationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccessControlListConfiguration 

type AccessControlListConfiguration struct {

	// Path to the Amazon S3 bucket that contains the ACL files.
	KeyPath *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html).

func (AccessControlListConfiguration) GoString 

func (s AccessControlListConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessControlListConfiguration) SetKeyPath 

func (s *AccessControlListConfiguration) SetKeyPath(v string) *AccessControlListConfiguration

SetKeyPath sets the KeyPath field's value.

func (AccessControlListConfiguration) String 

func (s AccessControlListConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessControlListConfiguration) Validate 

func (s *AccessControlListConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AclConfiguration 

type AclConfiguration struct {

	// A list of groups, separated by semi-colons, that filters a query response
	// based on user context. The document is only returned to users that are in
	// one of the groups specified in the UserContext field of the Query API.
	//
	// AllowedGroupsColumnName is a required field
	AllowedGroupsColumnName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the column that should be used for filtering the query response by groups.

func (AclConfiguration) GoString 

func (s AclConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AclConfiguration) SetAllowedGroupsColumnName 

func (s *AclConfiguration) SetAllowedGroupsColumnName(v string) *AclConfiguration

SetAllowedGroupsColumnName sets the AllowedGroupsColumnName field's value.

func (AclConfiguration) String 

func (s AclConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AclConfiguration) Validate 

func (s *AclConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdditionalResultAttribute 

type AdditionalResultAttribute struct {

	// The key that identifies the attribute.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// An object that contains the attribute value.
	//
	// Value is a required field
	Value *AdditionalResultAttributeValue `type:"structure" required:"true"`

	// The data type of the Value property.
	//
	// ValueType is a required field
	ValueType *string `type:"string" required:"true" enum:"AdditionalResultAttributeValueType"`
	// contains filtered or unexported fields
}

An attribute returned from an index query.

func (AdditionalResultAttribute) GoString 

func (s AdditionalResultAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdditionalResultAttribute) SetKey 

func (s *AdditionalResultAttribute) SetKey(v string) *AdditionalResultAttribute

SetKey sets the Key field's value.

func (*AdditionalResultAttribute) SetValue 

func (s *AdditionalResultAttribute) SetValue(v *AdditionalResultAttributeValue) *AdditionalResultAttribute

SetValue sets the Value field's value.

func (*AdditionalResultAttribute) SetValueType 

func (s *AdditionalResultAttribute) SetValueType(v string) *AdditionalResultAttribute

SetValueType sets the ValueType field's value.

func (AdditionalResultAttribute) String 

func (s AdditionalResultAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdditionalResultAttributeValue 

type AdditionalResultAttributeValue struct {

	// The text associated with the attribute and information about the highlight
	// to apply to the text.
	TextWithHighlightsValue *TextWithHighlights `type:"structure"`
	// contains filtered or unexported fields
}

An attribute returned with a document from a search.

func (AdditionalResultAttributeValue) GoString 

func (s AdditionalResultAttributeValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdditionalResultAttributeValue) SetTextWithHighlightsValue 

func (s *AdditionalResultAttributeValue) SetTextWithHighlightsValue(v *TextWithHighlights) *AdditionalResultAttributeValue

SetTextWithHighlightsValue sets the TextWithHighlightsValue field's value.

func (AdditionalResultAttributeValue) String 

func (s AdditionalResultAttributeValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AlfrescoConfiguration added in v1.44.46 

type AlfrescoConfiguration struct {

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Alfresco blogs to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Alfresco fields. For more
	// information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Alfresco data source field names must exist in your Alfresco custom metadata.
	BlogFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// TRUE to index comments of blogs and other content.
	CrawlComments *bool `type:"boolean"`

	// TRUE to index shared files.
	CrawlSystemFolders *bool `type:"boolean"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Alfresco document libraries to Amazon Kendra index field names.
	// To create custom fields, use the UpdateIndex API before you map to Alfresco
	// fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Alfresco data source field names must exist in your Alfresco custom metadata.
	DocumentLibraryFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// Specify whether to index document libraries, wikis, or blogs. You can specify
	// one or more of these options.
	EntityFilter []*string `min:"1" type:"list" enum:"AlfrescoEntity"`

	// A list of regular expression patterns to exclude certain files in your Alfresco
	// data source. Files that match the patterns are excluded from the index. Files
	// that don't match the patterns are included in the index. If a file matches
	// both an inclusion pattern and an exclusion pattern, the exclusion pattern
	// takes precedence and the file isn't included in the index.
	ExclusionPatterns []*string `type:"list"`

	// A list of regular expression patterns to include certain files in your Alfresco
	// data source. Files that match the patterns are included in the index. Files
	// that don't match the patterns are excluded from the index. If a file matches
	// both an inclusion pattern and an exclusion pattern, the exclusion pattern
	// takes precedence and the file isn't included in the index.
	InclusionPatterns []*string `type:"list"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the key-value pairs required to connect to your Alfresco data source. The
	// secret must contain a JSON structure with the following keys:
	//
	//    * username—The user name of the Alfresco account.
	//
	//    * password—The password of the Alfresco account.
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The identifier of the Alfresco site. For example, my-site.
	//
	// SiteId is a required field
	SiteId *string `min:"1" type:"string" required:"true"`

	// The URL of the Alfresco site. For example, https://hostname:8080.
	//
	// SiteUrl is a required field
	SiteUrl *string `min:"1" type:"string" required:"true"`

	// The path to the SSL certificate stored in an Amazon S3 bucket. You use this
	// to connect to Alfresco if you require a secure SSL connection.
	//
	// You can simply generate a self-signed X509 certificate on any computer using
	// OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
	// Create and sign an X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html).
	//
	// SslCertificateS3Path is a required field
	SslCertificateS3Path *S3Path `type:"structure" required:"true"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your Alfresco. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Alfresco wikis to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Alfresco fields. For more
	// information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Alfresco data source field names must exist in your Alfresco custom metadata.
	WikiFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Alfresco as your data source.

Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or using the Alfresco data source template schema / TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API.

func (AlfrescoConfiguration) GoString added in v1.44.46 

func (s AlfrescoConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlfrescoConfiguration) SetBlogFieldMappings added in v1.44.46 

func (s *AlfrescoConfiguration) SetBlogFieldMappings(v []*DataSourceToIndexFieldMapping) *AlfrescoConfiguration

SetBlogFieldMappings sets the BlogFieldMappings field's value.

func (*AlfrescoConfiguration) SetCrawlComments added in v1.44.46 

func (s *AlfrescoConfiguration) SetCrawlComments(v bool) *AlfrescoConfiguration

SetCrawlComments sets the CrawlComments field's value.

func (*AlfrescoConfiguration) SetCrawlSystemFolders added in v1.44.46 

func (s *AlfrescoConfiguration) SetCrawlSystemFolders(v bool) *AlfrescoConfiguration

SetCrawlSystemFolders sets the CrawlSystemFolders field's value.

func (*AlfrescoConfiguration) SetDocumentLibraryFieldMappings added in v1.44.46 

func (s *AlfrescoConfiguration) SetDocumentLibraryFieldMappings(v []*DataSourceToIndexFieldMapping) *AlfrescoConfiguration

SetDocumentLibraryFieldMappings sets the DocumentLibraryFieldMappings field's value.

func (*AlfrescoConfiguration) SetEntityFilter added in v1.44.46 

func (s *AlfrescoConfiguration) SetEntityFilter(v []*string) *AlfrescoConfiguration

SetEntityFilter sets the EntityFilter field's value.

func (*AlfrescoConfiguration) SetExclusionPatterns added in v1.44.46 

func (s *AlfrescoConfiguration) SetExclusionPatterns(v []*string) *AlfrescoConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*AlfrescoConfiguration) SetInclusionPatterns added in v1.44.46 

func (s *AlfrescoConfiguration) SetInclusionPatterns(v []*string) *AlfrescoConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*AlfrescoConfiguration) SetSecretArn added in v1.44.46 

func (s *AlfrescoConfiguration) SetSecretArn(v string) *AlfrescoConfiguration

SetSecretArn sets the SecretArn field's value.

func (*AlfrescoConfiguration) SetSiteId added in v1.44.46 

func (s *AlfrescoConfiguration) SetSiteId(v string) *AlfrescoConfiguration

SetSiteId sets the SiteId field's value.

func (*AlfrescoConfiguration) SetSiteUrl added in v1.44.46 

func (s *AlfrescoConfiguration) SetSiteUrl(v string) *AlfrescoConfiguration

SetSiteUrl sets the SiteUrl field's value.

func (*AlfrescoConfiguration) SetSslCertificateS3Path added in v1.44.46 

func (s *AlfrescoConfiguration) SetSslCertificateS3Path(v *S3Path) *AlfrescoConfiguration

SetSslCertificateS3Path sets the SslCertificateS3Path field's value.

func (*AlfrescoConfiguration) SetVpcConfiguration added in v1.44.46 

func (s *AlfrescoConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *AlfrescoConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*AlfrescoConfiguration) SetWikiFieldMappings added in v1.44.46 

func (s *AlfrescoConfiguration) SetWikiFieldMappings(v []*DataSourceToIndexFieldMapping) *AlfrescoConfiguration

SetWikiFieldMappings sets the WikiFieldMappings field's value.

func (AlfrescoConfiguration) String added in v1.44.46 

func (s AlfrescoConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlfrescoConfiguration) Validate added in v1.44.46 

func (s *AlfrescoConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateEntitiesToExperienceInput added in v1.42.17 

type AssociateEntitiesToExperienceInput struct {

	// Lists users or groups in your IAM Identity Center identity source.
	//
	// EntityList is a required field
	EntityList []*EntityConfiguration `min:"1" type:"list" required:"true"`

	// The identifier of your Amazon Kendra experience.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateEntitiesToExperienceInput) GoString added in v1.42.17 

func (s AssociateEntitiesToExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateEntitiesToExperienceInput) SetEntityList added in v1.42.17 

func (s *AssociateEntitiesToExperienceInput) SetEntityList(v []*EntityConfiguration) *AssociateEntitiesToExperienceInput

SetEntityList sets the EntityList field's value.

func (*AssociateEntitiesToExperienceInput) SetId added in v1.42.17 

func (s *AssociateEntitiesToExperienceInput) SetId(v string) *AssociateEntitiesToExperienceInput

SetId sets the Id field's value.

func (*AssociateEntitiesToExperienceInput) SetIndexId added in v1.42.17 

func (s *AssociateEntitiesToExperienceInput) SetIndexId(v string) *AssociateEntitiesToExperienceInput

SetIndexId sets the IndexId field's value.

func (AssociateEntitiesToExperienceInput) String added in v1.42.17 

func (s AssociateEntitiesToExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateEntitiesToExperienceInput) Validate added in v1.42.17 

func (s *AssociateEntitiesToExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateEntitiesToExperienceOutput added in v1.42.17 

type AssociateEntitiesToExperienceOutput struct {

	// Lists the users or groups in your IAM Identity Center identity source that
	// failed to properly configure with your Amazon Kendra experience.
	FailedEntityList []*FailedEntity `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (AssociateEntitiesToExperienceOutput) GoString added in v1.42.17 

func (s AssociateEntitiesToExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateEntitiesToExperienceOutput) SetFailedEntityList added in v1.42.17 

func (s *AssociateEntitiesToExperienceOutput) SetFailedEntityList(v []*FailedEntity) *AssociateEntitiesToExperienceOutput

SetFailedEntityList sets the FailedEntityList field's value.

func (AssociateEntitiesToExperienceOutput) String added in v1.42.17 

func (s AssociateEntitiesToExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociatePersonasToEntitiesInput added in v1.42.17 

type AssociatePersonasToEntitiesInput struct {

	// The identifier of your Amazon Kendra experience.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The personas that define the specific permissions of users or groups in your
	// IAM Identity Center identity source. The available personas or access roles
	// are Owner and Viewer. For more information on these personas, see Providing
	// access to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience).
	//
	// Personas is a required field
	Personas []*EntityPersonaConfiguration `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AssociatePersonasToEntitiesInput) GoString added in v1.42.17 

func (s AssociatePersonasToEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePersonasToEntitiesInput) SetId added in v1.42.17 

func (s *AssociatePersonasToEntitiesInput) SetId(v string) *AssociatePersonasToEntitiesInput

SetId sets the Id field's value.

func (*AssociatePersonasToEntitiesInput) SetIndexId added in v1.42.17 

func (s *AssociatePersonasToEntitiesInput) SetIndexId(v string) *AssociatePersonasToEntitiesInput

SetIndexId sets the IndexId field's value.

func (*AssociatePersonasToEntitiesInput) SetPersonas added in v1.42.17 

func (s *AssociatePersonasToEntitiesInput) SetPersonas(v []*EntityPersonaConfiguration) *AssociatePersonasToEntitiesInput

SetPersonas sets the Personas field's value.

func (AssociatePersonasToEntitiesInput) String added in v1.42.17 

func (s AssociatePersonasToEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePersonasToEntitiesInput) Validate added in v1.42.17 

func (s *AssociatePersonasToEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociatePersonasToEntitiesOutput added in v1.42.17 

type AssociatePersonasToEntitiesOutput struct {

	// Lists the users or groups in your IAM Identity Center identity source that
	// failed to properly configure with your Amazon Kendra experience.
	FailedEntityList []*FailedEntity `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (AssociatePersonasToEntitiesOutput) GoString added in v1.42.17 

func (s AssociatePersonasToEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatePersonasToEntitiesOutput) SetFailedEntityList added in v1.42.17 

func (s *AssociatePersonasToEntitiesOutput) SetFailedEntityList(v []*FailedEntity) *AssociatePersonasToEntitiesOutput

SetFailedEntityList sets the FailedEntityList field's value.

func (AssociatePersonasToEntitiesOutput) String added in v1.42.17 

func (s AssociatePersonasToEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttributeFilter 

type AttributeFilter struct {

	// Performs a logical AND operation on all filters that you specify.
	AndAllFilters []*AttributeFilter `type:"list"`

	// Returns true when a document contains all of the specified document attributes/fields.
	// This filter is only applicable to StringListValue (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html).
	ContainsAll *DocumentAttribute `type:"structure"`

	// Returns true when a document contains any of the specified document attributes/fields.
	// This filter is only applicable to StringListValue (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html).
	ContainsAny *DocumentAttribute `type:"structure"`

	// Performs an equals operation on document attributes/fields and their values.
	EqualsTo *DocumentAttribute `type:"structure"`

	// Performs a greater than operation on document attributes/fields and their
	// values. Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html)
	// Date or Long.
	GreaterThan *DocumentAttribute `type:"structure"`

	// Performs a greater or equals than operation on document attributes/fields
	// and their values. Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html)
	// Date or Long.
	GreaterThanOrEquals *DocumentAttribute `type:"structure"`

	// Performs a less than operation on document attributes/fields and their values.
	// Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html)
	// Date or Long.
	LessThan *DocumentAttribute `type:"structure"`

	// Performs a less than or equals operation on document attributes/fields and
	// their values. Use with the document attribute type (https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html)
	// Date or Long.
	LessThanOrEquals *DocumentAttribute `type:"structure"`

	// Performs a logical NOT operation on all filters that you specify.
	NotFilter *AttributeFilter `type:"structure"`

	// Performs a logical OR operation on all filters that you specify.
	OrAllFilters []*AttributeFilter `type:"list"`
	// contains filtered or unexported fields
}

Filters the search results based on document attributes or fields.

You can filter results using attributes for your particular documents. The attributes must exist in your index. For example, if your documents include the custom attribute "Department", you can filter documents that belong to the "HR" department. You would use the EqualsTo operation to filter results or documents with "Department" equals to "HR".

You can use AndAllFilters and AndOrFilters in combination with each other or with other operations such as EqualsTo. For example:

AndAllFilters

  • EqualsTo: "Department", "HR"

  • AndOrFilters ContainsAny: "Project Name", ["new hires", "new hiring"]

This example filters results or documents that belong to the HR department and belong to projects that contain "new hires" or "new hiring" in the project name (must use ContainAny with StringListValue). This example is filtering with a depth of 2.

You cannot filter more than a depth of 2, otherwise you receive a ValidationException exception with the message "AttributeFilter cannot have a depth of more than 2." Also, if you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message "AttributeFilter cannot have a length of more than 10".

For examples of using AttributeFilter, see Using document attributes to filter search results (https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering).

func (AttributeFilter) GoString 

func (s AttributeFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeFilter) SetAndAllFilters 

func (s *AttributeFilter) SetAndAllFilters(v []*AttributeFilter) *AttributeFilter

SetAndAllFilters sets the AndAllFilters field's value.

func (*AttributeFilter) SetContainsAll 

func (s *AttributeFilter) SetContainsAll(v *DocumentAttribute) *AttributeFilter

SetContainsAll sets the ContainsAll field's value.

func (*AttributeFilter) SetContainsAny 

func (s *AttributeFilter) SetContainsAny(v *DocumentAttribute) *AttributeFilter

SetContainsAny sets the ContainsAny field's value.

func (*AttributeFilter) SetEqualsTo 

func (s *AttributeFilter) SetEqualsTo(v *DocumentAttribute) *AttributeFilter

SetEqualsTo sets the EqualsTo field's value.

func (*AttributeFilter) SetGreaterThan 

func (s *AttributeFilter) SetGreaterThan(v *DocumentAttribute) *AttributeFilter

SetGreaterThan sets the GreaterThan field's value.

func (*AttributeFilter) SetGreaterThanOrEquals 

func (s *AttributeFilter) SetGreaterThanOrEquals(v *DocumentAttribute) *AttributeFilter

SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value.

func (*AttributeFilter) SetLessThan 

func (s *AttributeFilter) SetLessThan(v *DocumentAttribute) *AttributeFilter

SetLessThan sets the LessThan field's value.

func (*AttributeFilter) SetLessThanOrEquals 

func (s *AttributeFilter) SetLessThanOrEquals(v *DocumentAttribute) *AttributeFilter

SetLessThanOrEquals sets the LessThanOrEquals field's value.

func (*AttributeFilter) SetNotFilter 

func (s *AttributeFilter) SetNotFilter(v *AttributeFilter) *AttributeFilter

SetNotFilter sets the NotFilter field's value.

func (*AttributeFilter) SetOrAllFilters 

func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter

SetOrAllFilters sets the OrAllFilters field's value.

func (AttributeFilter) String 

func (s AttributeFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeFilter) Validate 

func (s *AttributeFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttributeSuggestionsDescribeConfig added in v1.44.255 

type AttributeSuggestionsDescribeConfig struct {

	// The mode is set to either ACTIVE or INACTIVE. If the Mode for query history
	// is set to ENABLED when calling UpdateQuerySuggestionsConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html)
	// and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and
	// you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then
	// Amazon Kendra uses the query history.
	AttributeSuggestionsMode *string `type:"string" enum:"AttributeSuggestionsMode"`

	// The list of fields/attributes that you want to set as suggestible for query
	// suggestions.
	SuggestableConfigList []*SuggestableConfig `type:"list"`
	// contains filtered or unexported fields
}

Gets information on the configuration of document fields/attributes that you want to base query suggestions on. To change your configuration, use AttributeSuggestionsUpdateConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_AttributeSuggestionsUpdateConfig.html) and then call UpdateQuerySuggestionsConfig (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html).

func (AttributeSuggestionsDescribeConfig) GoString added in v1.44.255 

func (s AttributeSuggestionsDescribeConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeSuggestionsDescribeConfig) SetAttributeSuggestionsMode added in v1.44.255 

func (s *AttributeSuggestionsDescribeConfig) SetAttributeSuggestionsMode(v string) *AttributeSuggestionsDescribeConfig

SetAttributeSuggestionsMode sets the AttributeSuggestionsMode field's value.

func (*AttributeSuggestionsDescribeConfig) SetSuggestableConfigList added in v1.44.255 

func (s *AttributeSuggestionsDescribeConfig) SetSuggestableConfigList(v []*SuggestableConfig) *AttributeSuggestionsDescribeConfig

SetSuggestableConfigList sets the SuggestableConfigList field's value.

func (AttributeSuggestionsDescribeConfig) String added in v1.44.255 

func (s AttributeSuggestionsDescribeConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttributeSuggestionsGetConfig added in v1.44.255 

type AttributeSuggestionsGetConfig struct {

	// The list of additional document field/attribute keys or field names to include
	// in the response. You can use additional fields to provide extra information
	// in the response. Additional fields are not used to based suggestions on.
	AdditionalResponseAttributes []*string `min:"1" type:"list"`

	// Filters the search results based on document fields/attributes.
	AttributeFilter *AttributeFilter `type:"structure"`

	// The list of document field/attribute keys or field names to use for query
	// suggestions. If the content within any of the fields match what your user
	// starts typing as their query, then the field content is returned as a query
	// suggestion.
	SuggestionAttributes []*string `min:"1" type:"list"`

	// Applies user context filtering so that only users who are given access to
	// certain documents see these document in their search results.
	UserContext *UserContext `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for the document fields/attributes that you want to base query suggestions on.

func (AttributeSuggestionsGetConfig) GoString added in v1.44.255 

func (s AttributeSuggestionsGetConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeSuggestionsGetConfig) SetAdditionalResponseAttributes added in v1.44.255 

func (s *AttributeSuggestionsGetConfig) SetAdditionalResponseAttributes(v []*string) *AttributeSuggestionsGetConfig

SetAdditionalResponseAttributes sets the AdditionalResponseAttributes field's value.

func (*AttributeSuggestionsGetConfig) SetAttributeFilter added in v1.44.255 

func (s *AttributeSuggestionsGetConfig) SetAttributeFilter(v *AttributeFilter) *AttributeSuggestionsGetConfig

SetAttributeFilter sets the AttributeFilter field's value.

func (*AttributeSuggestionsGetConfig) SetSuggestionAttributes added in v1.44.255 

func (s *AttributeSuggestionsGetConfig) SetSuggestionAttributes(v []*string) *AttributeSuggestionsGetConfig

SetSuggestionAttributes sets the SuggestionAttributes field's value.

func (*AttributeSuggestionsGetConfig) SetUserContext added in v1.44.255 

func (s *AttributeSuggestionsGetConfig) SetUserContext(v *UserContext) *AttributeSuggestionsGetConfig

SetUserContext sets the UserContext field's value.

func (AttributeSuggestionsGetConfig) String added in v1.44.255 

func (s AttributeSuggestionsGetConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeSuggestionsGetConfig) Validate added in v1.44.255 

func (s *AttributeSuggestionsGetConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttributeSuggestionsUpdateConfig added in v1.44.255 

type AttributeSuggestionsUpdateConfig struct {

	// You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes
	// as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions
	// (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html).
	// If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig
	// (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html)
	// and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and
	// you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then
	// Amazon Kendra uses the query history.
	AttributeSuggestionsMode *string `type:"string" enum:"AttributeSuggestionsMode"`

	// The list of fields/attributes that you want to set as suggestible for query
	// suggestions.
	SuggestableConfigList []*SuggestableConfig `type:"list"`
	// contains filtered or unexported fields
}

Updates the configuration information for the document fields/attributes that you want to base query suggestions on.

To deactivate using documents fields for query suggestions, set the mode to INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html). If you set to QUERY, then Amazon Kendra uses the query history to base suggestions on. If you set to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the contents of document fields to base suggestions on.

func (AttributeSuggestionsUpdateConfig) GoString added in v1.44.255 

func (s AttributeSuggestionsUpdateConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeSuggestionsUpdateConfig) SetAttributeSuggestionsMode added in v1.44.255 

func (s *AttributeSuggestionsUpdateConfig) SetAttributeSuggestionsMode(v string) *AttributeSuggestionsUpdateConfig

SetAttributeSuggestionsMode sets the AttributeSuggestionsMode field's value.

func (*AttributeSuggestionsUpdateConfig) SetSuggestableConfigList added in v1.44.255 

func (s *AttributeSuggestionsUpdateConfig) SetSuggestableConfigList(v []*SuggestableConfig) *AttributeSuggestionsUpdateConfig

SetSuggestableConfigList sets the SuggestableConfigList field's value.

func (AttributeSuggestionsUpdateConfig) String added in v1.44.255 

func (s AttributeSuggestionsUpdateConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeSuggestionsUpdateConfig) Validate added in v1.44.255 

func (s *AttributeSuggestionsUpdateConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AuthenticationConfiguration added in v1.38.64 

type AuthenticationConfiguration struct {

	// The list of configuration information that's required to connect to and crawl
	// a website host using basic authentication credentials.
	//
	// The list includes the name and port number of the website host.
	BasicAuthentication []*BasicAuthenticationConfiguration `type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to websites that require user authentication.

func (AuthenticationConfiguration) GoString added in v1.38.64 

func (s AuthenticationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationConfiguration) SetBasicAuthentication added in v1.38.64 

func (s *AuthenticationConfiguration) SetBasicAuthentication(v []*BasicAuthenticationConfiguration) *AuthenticationConfiguration

SetBasicAuthentication sets the BasicAuthentication field's value.

func (AuthenticationConfiguration) String added in v1.38.64 

func (s AuthenticationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationConfiguration) Validate added in v1.38.64 

func (s *AuthenticationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BasicAuthenticationConfiguration added in v1.38.64 

type BasicAuthenticationConfiguration struct {

	// Your secret ARN, which you can create in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
	//
	// You use a secret if basic authentication credentials are required to connect
	// to a website. The secret stores your credentials of user name and password.
	//
	// Credentials is a required field
	Credentials *string `min:"1" type:"string" required:"true"`

	// The name of the website host you want to connect to using authentication
	// credentials.
	//
	// For example, the host name of https://a.example.com/page1.html is "a.example.com".
	//
	// Host is a required field
	Host *string `min:"1" type:"string" required:"true"`

	// The port number of the website host you want to connect to using authentication
	// credentials.
	//
	// For example, the port for https://a.example.com/page1.html is 443, the standard
	// port for HTTPS.
	//
	// Port is a required field
	Port *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to websites that require basic user authentication.

func (BasicAuthenticationConfiguration) GoString added in v1.38.64 

func (s BasicAuthenticationConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BasicAuthenticationConfiguration) SetCredentials added in v1.38.64 

func (s *BasicAuthenticationConfiguration) SetCredentials(v string) *BasicAuthenticationConfiguration

SetCredentials sets the Credentials field's value.

func (*BasicAuthenticationConfiguration) SetHost added in v1.38.64 

func (s *BasicAuthenticationConfiguration) SetHost(v string) *BasicAuthenticationConfiguration

SetHost sets the Host field's value.

func (*BasicAuthenticationConfiguration) SetPort added in v1.38.64 

func (s *BasicAuthenticationConfiguration) SetPort(v int64) *BasicAuthenticationConfiguration

SetPort sets the Port field's value.

func (BasicAuthenticationConfiguration) String added in v1.38.64 

func (s BasicAuthenticationConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BasicAuthenticationConfiguration) Validate added in v1.38.64 

func (s *BasicAuthenticationConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDeleteDocumentInput 

type BatchDeleteDocumentInput struct {

	// Maps a particular data source sync job to a particular data source.
	DataSourceSyncJobMetricTarget *DataSourceSyncJobMetricTarget `type:"structure"`

	// One or more identifiers for documents to delete from the index.
	//
	// DocumentIdList is a required field
	DocumentIdList []*string `min:"1" type:"list" required:"true"`

	// The identifier of the index that contains the documents to delete.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteDocumentInput) GoString 

func (s BatchDeleteDocumentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDocumentInput) SetDataSourceSyncJobMetricTarget added in v1.30.25 

func (s *BatchDeleteDocumentInput) SetDataSourceSyncJobMetricTarget(v *DataSourceSyncJobMetricTarget) *BatchDeleteDocumentInput

SetDataSourceSyncJobMetricTarget sets the DataSourceSyncJobMetricTarget field's value.

func (*BatchDeleteDocumentInput) SetDocumentIdList 

func (s *BatchDeleteDocumentInput) SetDocumentIdList(v []*string) *BatchDeleteDocumentInput

SetDocumentIdList sets the DocumentIdList field's value.

func (*BatchDeleteDocumentInput) SetIndexId 

func (s *BatchDeleteDocumentInput) SetIndexId(v string) *BatchDeleteDocumentInput

SetIndexId sets the IndexId field's value.

func (BatchDeleteDocumentInput) String 

func (s BatchDeleteDocumentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDocumentInput) Validate 

func (s *BatchDeleteDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDeleteDocumentOutput 

type BatchDeleteDocumentOutput struct {

	// A list of documents that could not be removed from the index. Each entry
	// contains an error message that indicates why the document couldn't be removed
	// from the index.
	FailedDocuments []*BatchDeleteDocumentResponseFailedDocument `type:"list"`
	// contains filtered or unexported fields
}

func (BatchDeleteDocumentOutput) GoString 

func (s BatchDeleteDocumentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDocumentOutput) SetFailedDocuments 

func (s *BatchDeleteDocumentOutput) SetFailedDocuments(v []*BatchDeleteDocumentResponseFailedDocument) *BatchDeleteDocumentOutput

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchDeleteDocumentOutput) String 

func (s BatchDeleteDocumentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteDocumentResponseFailedDocument 

type BatchDeleteDocumentResponseFailedDocument struct {

	// The error code for why the document couldn't be removed from the index.
	ErrorCode *string `type:"string" enum:"ErrorCode"`

	// An explanation for why the document couldn't be removed from the index.
	ErrorMessage *string `min:"1" type:"string"`

	// The identifier of the document that couldn't be removed from the index.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about documents that could not be removed from an index by the BatchDeleteDocument API.

func (BatchDeleteDocumentResponseFailedDocument) GoString 

func (s BatchDeleteDocumentResponseFailedDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteDocumentResponseFailedDocument) SetErrorCode 

func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorCode(v string) *BatchDeleteDocumentResponseFailedDocument

SetErrorCode sets the ErrorCode field's value.

func (*BatchDeleteDocumentResponseFailedDocument) SetErrorMessage 

func (s *BatchDeleteDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchDeleteDocumentResponseFailedDocument

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchDeleteDocumentResponseFailedDocument) SetId 

func (s *BatchDeleteDocumentResponseFailedDocument) SetId(v string) *BatchDeleteDocumentResponseFailedDocument

SetId sets the Id field's value.

func (BatchDeleteDocumentResponseFailedDocument) String 

func (s BatchDeleteDocumentResponseFailedDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteFeaturedResultsSetError added in v1.44.233 

type BatchDeleteFeaturedResultsSetError struct {

	// The error code for why the set of featured results couldn't be removed from
	// the index.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true" enum:"ErrorCode"`

	// An explanation for why the set of featured results couldn't be removed from
	// the index.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `min:"1" type:"string" required:"true"`

	// The identifier of the set of featured results that couldn't be removed from
	// the index.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides information about a set of featured results that couldn't be removed from an index by the BatchDeleteFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteFeaturedResultsSet.html) API.

func (BatchDeleteFeaturedResultsSetError) GoString added in v1.44.233 

func (s BatchDeleteFeaturedResultsSetError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteFeaturedResultsSetError) SetErrorCode added in v1.44.233 

func (s *BatchDeleteFeaturedResultsSetError) SetErrorCode(v string) *BatchDeleteFeaturedResultsSetError

SetErrorCode sets the ErrorCode field's value.

func (*BatchDeleteFeaturedResultsSetError) SetErrorMessage added in v1.44.233 

func (s *BatchDeleteFeaturedResultsSetError) SetErrorMessage(v string) *BatchDeleteFeaturedResultsSetError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchDeleteFeaturedResultsSetError) SetId added in v1.44.233 

func (s *BatchDeleteFeaturedResultsSetError) SetId(v string) *BatchDeleteFeaturedResultsSetError

SetId sets the Id field's value.

func (BatchDeleteFeaturedResultsSetError) String added in v1.44.233 

func (s BatchDeleteFeaturedResultsSetError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteFeaturedResultsSetInput added in v1.44.233 

type BatchDeleteFeaturedResultsSetInput struct {

	// The identifiers of the featured results sets that you want to delete.
	//
	// FeaturedResultsSetIds is a required field
	FeaturedResultsSetIds []*string `min:"1" type:"list" required:"true"`

	// The identifier of the index used for featuring results.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteFeaturedResultsSetInput) GoString added in v1.44.233 

func (s BatchDeleteFeaturedResultsSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteFeaturedResultsSetInput) SetFeaturedResultsSetIds added in v1.44.233 

func (s *BatchDeleteFeaturedResultsSetInput) SetFeaturedResultsSetIds(v []*string) *BatchDeleteFeaturedResultsSetInput

SetFeaturedResultsSetIds sets the FeaturedResultsSetIds field's value.

func (*BatchDeleteFeaturedResultsSetInput) SetIndexId added in v1.44.233 

func (s *BatchDeleteFeaturedResultsSetInput) SetIndexId(v string) *BatchDeleteFeaturedResultsSetInput

SetIndexId sets the IndexId field's value.

func (BatchDeleteFeaturedResultsSetInput) String added in v1.44.233 

func (s BatchDeleteFeaturedResultsSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteFeaturedResultsSetInput) Validate added in v1.44.233 

func (s *BatchDeleteFeaturedResultsSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDeleteFeaturedResultsSetOutput added in v1.44.233 

type BatchDeleteFeaturedResultsSetOutput struct {

	// The list of errors for the featured results set IDs, explaining why they
	// couldn't be removed from the index.
	//
	// Errors is a required field
	Errors []*BatchDeleteFeaturedResultsSetError `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteFeaturedResultsSetOutput) GoString added in v1.44.233 

func (s BatchDeleteFeaturedResultsSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteFeaturedResultsSetOutput) SetErrors added in v1.44.233 

func (s *BatchDeleteFeaturedResultsSetOutput) SetErrors(v []*BatchDeleteFeaturedResultsSetError) *BatchDeleteFeaturedResultsSetOutput

SetErrors sets the Errors field's value.

func (BatchDeleteFeaturedResultsSetOutput) String added in v1.44.233 

func (s BatchDeleteFeaturedResultsSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetDocumentStatusInput added in v1.38.58 

type BatchGetDocumentStatusInput struct {

	// A list of DocumentInfo objects that identify the documents for which to get
	// the status. You identify the documents by their document ID and optional
	// attributes.
	//
	// DocumentInfoList is a required field
	DocumentInfoList []*DocumentInfo `min:"1" type:"list" required:"true"`

	// The identifier of the index to add documents to. The index ID is returned
	// by the CreateIndex (https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html)
	// API.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetDocumentStatusInput) GoString added in v1.38.58 

func (s BatchGetDocumentStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDocumentStatusInput) SetDocumentInfoList added in v1.38.58 

func (s *BatchGetDocumentStatusInput) SetDocumentInfoList(v []*DocumentInfo) *BatchGetDocumentStatusInput

SetDocumentInfoList sets the DocumentInfoList field's value.

func (*BatchGetDocumentStatusInput) SetIndexId added in v1.38.58 

func (s *BatchGetDocumentStatusInput) SetIndexId(v string) *BatchGetDocumentStatusInput

SetIndexId sets the IndexId field's value.

func (BatchGetDocumentStatusInput) String added in v1.38.58 

func (s BatchGetDocumentStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDocumentStatusInput) Validate added in v1.38.58 

func (s *BatchGetDocumentStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetDocumentStatusOutput added in v1.38.58 

type BatchGetDocumentStatusOutput struct {

	// The status of documents. The status indicates if the document is waiting
	// to be indexed, is in the process of indexing, has completed indexing, or
	// failed indexing. If a document failed indexing, the status provides the reason
	// why.
	DocumentStatusList []*Status `type:"list"`

	// A list of documents that Amazon Kendra couldn't get the status for. The list
	// includes the ID of the document and the reason that the status couldn't be
	// found.
	Errors []*BatchGetDocumentStatusResponseError `type:"list"`
	// contains filtered or unexported fields
}

func (BatchGetDocumentStatusOutput) GoString added in v1.38.58 

func (s BatchGetDocumentStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDocumentStatusOutput) SetDocumentStatusList added in v1.38.58 

func (s *BatchGetDocumentStatusOutput) SetDocumentStatusList(v []*Status) *BatchGetDocumentStatusOutput

SetDocumentStatusList sets the DocumentStatusList field's value.

func (*BatchGetDocumentStatusOutput) SetErrors added in v1.38.58 

func (s *BatchGetDocumentStatusOutput) SetErrors(v []*BatchGetDocumentStatusResponseError) *BatchGetDocumentStatusOutput

SetErrors sets the Errors field's value.

func (BatchGetDocumentStatusOutput) String added in v1.38.58 

func (s BatchGetDocumentStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetDocumentStatusResponseError added in v1.38.58 

type BatchGetDocumentStatusResponseError struct {

	// The identifier of the document whose status could not be retrieved.
	DocumentId *string `min:"1" type:"string"`

	// Indicates the source of the error.
	ErrorCode *string `type:"string" enum:"ErrorCode"`

	// States that the API could not get the status of a document. This could be
	// because the request is not valid or there is a system error.
	ErrorMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides a response when the status of a document could not be retrieved.

func (BatchGetDocumentStatusResponseError) GoString added in v1.38.58 

func (s BatchGetDocumentStatusResponseError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetDocumentStatusResponseError) SetDocumentId added in v1.38.58 

func (s *BatchGetDocumentStatusResponseError) SetDocumentId(v string) *BatchGetDocumentStatusResponseError

SetDocumentId sets the DocumentId field's value.

func (*BatchGetDocumentStatusResponseError) SetErrorCode added in v1.38.58 

func (s *BatchGetDocumentStatusResponseError) SetErrorCode(v string) *BatchGetDocumentStatusResponseError

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetDocumentStatusResponseError) SetErrorMessage added in v1.38.58 

func (s *BatchGetDocumentStatusResponseError) SetErrorMessage(v string) *BatchGetDocumentStatusResponseError

SetErrorMessage sets the ErrorMessage field's value.

func (BatchGetDocumentStatusResponseError) String added in v1.38.58 

func (s BatchGetDocumentStatusResponseError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutDocumentInput 

type BatchPutDocumentInput struct {

	// Configuration information for altering your document metadata and content
	// during the document ingestion process when you use the BatchPutDocument API.
	//
	// For more information on how to create, modify and delete document metadata,
	// or make other content alterations when you ingest documents into Amazon Kendra,
	// see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
	CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"`

	// One or more documents to add to the index.
	//
	// Documents have the following file size limits.
	//
	//    * 50 MB total size for any file
	//
	//    * 5 MB extracted text for any file
	//
	// For more information, see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	//
	// Documents is a required field
	Documents []*Document `min:"1" type:"list" required:"true"`

	// The identifier of the index to add the documents to. You need to create the
	// index first using the CreateIndex API.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role with permission to access your
	// S3 bucket. For more information, see IAM access roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (BatchPutDocumentInput) GoString 

func (s BatchPutDocumentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutDocumentInput) SetCustomDocumentEnrichmentConfiguration added in v1.42.17 

func (s *BatchPutDocumentInput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *BatchPutDocumentInput

SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value.

func (*BatchPutDocumentInput) SetDocuments 

func (s *BatchPutDocumentInput) SetDocuments(v []*Document) *BatchPutDocumentInput

SetDocuments sets the Documents field's value.

func (*BatchPutDocumentInput) SetIndexId 

func (s *BatchPutDocumentInput) SetIndexId(v string) *BatchPutDocumentInput

SetIndexId sets the IndexId field's value.

func (*BatchPutDocumentInput) SetRoleArn 

func (s *BatchPutDocumentInput) SetRoleArn(v string) *BatchPutDocumentInput

SetRoleArn sets the RoleArn field's value.

func (BatchPutDocumentInput) String 

func (s BatchPutDocumentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutDocumentInput) Validate 

func (s *BatchPutDocumentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchPutDocumentOutput 

type BatchPutDocumentOutput struct {

	// A list of documents that were not added to the index because the document
	// failed a validation check. Each document contains an error message that indicates
	// why the document couldn't be added to the index.
	//
	// If there was an error adding a document to an index the error is reported
	// in your Amazon Web Services CloudWatch log. For more information, see Monitoring
	// Amazon Kendra with Amazon CloudWatch logs (https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html).
	FailedDocuments []*BatchPutDocumentResponseFailedDocument `type:"list"`
	// contains filtered or unexported fields
}

func (BatchPutDocumentOutput) GoString 

func (s BatchPutDocumentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutDocumentOutput) SetFailedDocuments 

func (s *BatchPutDocumentOutput) SetFailedDocuments(v []*BatchPutDocumentResponseFailedDocument) *BatchPutDocumentOutput

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchPutDocumentOutput) String 

func (s BatchPutDocumentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutDocumentResponseFailedDocument 

type BatchPutDocumentResponseFailedDocument struct {

	// The type of error that caused the document to fail to be indexed.
	ErrorCode *string `type:"string" enum:"ErrorCode"`

	// A description of the reason why the document could not be indexed.
	ErrorMessage *string `min:"1" type:"string"`

	// The identifier of the document.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about a document that could not be indexed.

func (BatchPutDocumentResponseFailedDocument) GoString 

func (s BatchPutDocumentResponseFailedDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutDocumentResponseFailedDocument) SetErrorCode 

func (s *BatchPutDocumentResponseFailedDocument) SetErrorCode(v string) *BatchPutDocumentResponseFailedDocument

SetErrorCode sets the ErrorCode field's value.

func (*BatchPutDocumentResponseFailedDocument) SetErrorMessage 

func (s *BatchPutDocumentResponseFailedDocument) SetErrorMessage(v string) *BatchPutDocumentResponseFailedDocument

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchPutDocumentResponseFailedDocument) SetId 

func (s *BatchPutDocumentResponseFailedDocument) SetId(v string) *BatchPutDocumentResponseFailedDocument

SetId sets the Id field's value.

func (BatchPutDocumentResponseFailedDocument) String 

func (s BatchPutDocumentResponseFailedDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BoxConfiguration added in v1.43.34 

type BoxConfiguration struct {

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Box comments to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Box fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Box field names must exist in your Box custom metadata.
	CommentFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// TRUE to index comments.
	CrawlComments *bool `type:"boolean"`

	// TRUE to index the contents of tasks.
	CrawlTasks *bool `type:"boolean"`

	// TRUE to index web links.
	CrawlWebLinks *bool `type:"boolean"`

	// The identifier of the Box Enterprise platform. You can find the enterprise
	// ID in the Box Developer Console settings or when you create an app in Box
	// and download your authentication credentials. For example, 801234567.
	//
	// EnterpriseId is a required field
	EnterpriseId *string `min:"1" type:"string" required:"true"`

	// A list of regular expression patterns to exclude certain files and folders
	// from your Box platform. Files and folders that match the patterns are excluded
	// from the index.Files and folders that don't match the patterns are included
	// in the index. If a file or folder matches both an inclusion and exclusion
	// pattern, the exclusion pattern takes precedence and the file or folder isn't
	// included in the index.
	ExclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Box files to Amazon Kendra index field names. To create custom fields,
	// use the UpdateIndex API before you map to Box fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Box field names must exist in your Box custom metadata.
	FileFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain files and folders
	// in your Box platform. Files and folders that match the patterns are included
	// in the index. Files and folders that don't match the patterns are excluded
	// from the index. If a file or folder matches both an inclusion and exclusion
	// pattern, the exclusion pattern takes precedence and the file or folder isn't
	// included in the index.
	InclusionPatterns []*string `type:"list"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the key-value pairs required to connect to your Box platform. The secret
	// must contain a JSON structure with the following keys:
	//
	//    * clientID—The identifier of the client OAuth 2.0 authentication application
	//    created in Box.
	//
	//    * clientSecret—A set of characters known only to the OAuth 2.0 authentication
	//    application created in Box.
	//
	//    * publicKeyId—The identifier of the public key contained within an identity
	//    certificate.
	//
	//    * privateKey—A set of characters that make up an encryption key.
	//
	//    * passphrase—A set of characters that act like a password.
	//
	// You create an application in Box to generate the keys or credentials required
	// for the secret. For more information, see Using a Box data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Box tasks to Amazon Kendra index field names. To create custom fields,
	// use the UpdateIndex API before you map to Box fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Box field names must exist in your Box custom metadata.
	TaskFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// TRUE to use the Slack change log to determine which documents require updating
	// in the index. Depending on the data source change log's size, it may take
	// longer for Amazon Kendra to use the change log than to scan all of your documents.
	UseChangeLog *bool `type:"boolean"`

	// Configuration information for an Amazon VPC to connect to your Box. For more
	// information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Box web links to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Box fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Box field names must exist in your Box custom metadata.
	WebLinkFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Box as your data source.

func (BoxConfiguration) GoString added in v1.43.34 

func (s BoxConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BoxConfiguration) SetCommentFieldMappings added in v1.43.34 

func (s *BoxConfiguration) SetCommentFieldMappings(v []*DataSourceToIndexFieldMapping) *BoxConfiguration

SetCommentFieldMappings sets the CommentFieldMappings field's value.

func (*BoxConfiguration) SetCrawlComments added in v1.43.34 

func (s *BoxConfiguration) SetCrawlComments(v bool) *BoxConfiguration

SetCrawlComments sets the CrawlComments field's value.

func (*BoxConfiguration) SetCrawlTasks added in v1.43.34 

func (s *BoxConfiguration) SetCrawlTasks(v bool) *BoxConfiguration

SetCrawlTasks sets the CrawlTasks field's value. 

func (s *BoxConfiguration) SetCrawlWebLinks(v bool) *BoxConfiguration

SetCrawlWebLinks sets the CrawlWebLinks field's value.

func (*BoxConfiguration) SetEnterpriseId added in v1.43.34 

func (s *BoxConfiguration) SetEnterpriseId(v string) *BoxConfiguration

SetEnterpriseId sets the EnterpriseId field's value.

func (*BoxConfiguration) SetExclusionPatterns added in v1.43.34 

func (s *BoxConfiguration) SetExclusionPatterns(v []*string) *BoxConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*BoxConfiguration) SetFileFieldMappings added in v1.43.34 

func (s *BoxConfiguration) SetFileFieldMappings(v []*DataSourceToIndexFieldMapping) *BoxConfiguration

SetFileFieldMappings sets the FileFieldMappings field's value.

func (*BoxConfiguration) SetInclusionPatterns added in v1.43.34 

func (s *BoxConfiguration) SetInclusionPatterns(v []*string) *BoxConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*BoxConfiguration) SetSecretArn added in v1.43.34 

func (s *BoxConfiguration) SetSecretArn(v string) *BoxConfiguration

SetSecretArn sets the SecretArn field's value.

func (*BoxConfiguration) SetTaskFieldMappings added in v1.43.34 

func (s *BoxConfiguration) SetTaskFieldMappings(v []*DataSourceToIndexFieldMapping) *BoxConfiguration

SetTaskFieldMappings sets the TaskFieldMappings field's value.

func (*BoxConfiguration) SetUseChangeLog added in v1.43.34 

func (s *BoxConfiguration) SetUseChangeLog(v bool) *BoxConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (*BoxConfiguration) SetVpcConfiguration added in v1.43.34 

func (s *BoxConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *BoxConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*BoxConfiguration) SetWebLinkFieldMappings added in v1.43.34 

func (s *BoxConfiguration) SetWebLinkFieldMappings(v []*DataSourceToIndexFieldMapping) *BoxConfiguration

SetWebLinkFieldMappings sets the WebLinkFieldMappings field's value.

func (BoxConfiguration) String added in v1.43.34 

func (s BoxConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BoxConfiguration) Validate added in v1.43.34 

func (s *BoxConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CapacityUnitsConfiguration added in v1.30.25 

type CapacityUnitsConfiguration struct {

	// The amount of extra query capacity for an index and GetQuerySuggestions (https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html)
	// capacity.
	//
	// A single extra capacity unit for an index provides 0.1 queries per second
	// or approximately 8,000 queries per day. You can add up to 100 extra capacity
	// units.
	//
	// GetQuerySuggestions capacity is five times the provisioned query capacity
	// for an index, or the base capacity of 2.5 calls per second, whichever is
	// higher. For example, the base capacity for an index is 0.1 queries per second,
	// and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you
	// add another 0.1 queries per second to total 0.2 queries per second for an
	// index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than
	// five times 0.2 queries per second).
	//
	// QueryCapacityUnits is a required field
	QueryCapacityUnits *int64 `type:"integer" required:"true"`

	// The 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. You can add up to 100 extra capacity units.
	//
	// StorageCapacityUnits is a required field
	StorageCapacityUnits *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Specifies additional capacity units configured for your Enterprise Edition index. You can add and remove capacity units to fit your usage requirements.

func (CapacityUnitsConfiguration) GoString added in v1.30.25 

func (s CapacityUnitsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityUnitsConfiguration) SetQueryCapacityUnits added in v1.30.25 

func (s *CapacityUnitsConfiguration) SetQueryCapacityUnits(v int64) *CapacityUnitsConfiguration

SetQueryCapacityUnits sets the QueryCapacityUnits field's value.

func (*CapacityUnitsConfiguration) SetStorageCapacityUnits added in v1.30.25 

func (s *CapacityUnitsConfiguration) SetStorageCapacityUnits(v int64) *CapacityUnitsConfiguration

SetStorageCapacityUnits sets the StorageCapacityUnits field's value.

func (CapacityUnitsConfiguration) String added in v1.30.25 

func (s CapacityUnitsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityUnitsConfiguration) Validate added in v1.30.25 

func (s *CapacityUnitsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ClearQuerySuggestionsInput added in v1.38.50 

type ClearQuerySuggestionsInput struct {

	// The identifier of the index you want to clear query suggestions from.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ClearQuerySuggestionsInput) GoString added in v1.38.50 

func (s ClearQuerySuggestionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClearQuerySuggestionsInput) SetIndexId added in v1.38.50 

func (s *ClearQuerySuggestionsInput) SetIndexId(v string) *ClearQuerySuggestionsInput

SetIndexId sets the IndexId field's value.

func (ClearQuerySuggestionsInput) String added in v1.38.50 

func (s ClearQuerySuggestionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClearQuerySuggestionsInput) Validate added in v1.38.50 

func (s *ClearQuerySuggestionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ClearQuerySuggestionsOutput added in v1.38.50 

type ClearQuerySuggestionsOutput struct {
	// contains filtered or unexported fields
}

func (ClearQuerySuggestionsOutput) GoString added in v1.38.50 

func (s ClearQuerySuggestionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ClearQuerySuggestionsOutput) String added in v1.38.50 

func (s ClearQuerySuggestionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClickFeedback 

type ClickFeedback struct {

	// The Unix timestamp when the result was clicked.
	//
	// ClickTime is a required field
	ClickTime *time.Time `type:"timestamp" required:"true"`

	// The identifier of the search result that was clicked.
	//
	// ResultId is a required field
	ResultId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback API to provide click information.

func (ClickFeedback) GoString 

func (s ClickFeedback) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClickFeedback) SetClickTime 

func (s *ClickFeedback) SetClickTime(v time.Time) *ClickFeedback

SetClickTime sets the ClickTime field's value.

func (*ClickFeedback) SetResultId 

func (s *ClickFeedback) SetResultId(v string) *ClickFeedback

SetResultId sets the ResultId field's value.

func (ClickFeedback) String 

func (s ClickFeedback) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClickFeedback) Validate 

func (s *ClickFeedback) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CollapseConfiguration added in v1.45.28 

type CollapseConfiguration struct {

	// The document attribute used to group search results. You can use any attribute
	// that has the Sortable flag set to true. You can also sort by any of the following
	// built-in attributes:"_category","_created_at", "_last_updated_at", "_version",
	// "_view_count".
	//
	// DocumentAttributeKey is a required field
	DocumentAttributeKey *string `min:"1" type:"string" required:"true"`

	// Specifies whether to expand the collapsed results.
	Expand *bool `type:"boolean"`

	// Provides configuration information to customize expansion options for a collapsed
	// group.
	ExpandConfiguration *ExpandConfiguration `type:"structure"`

	// Specifies the behavior for documents without a value for the collapse attribute.
	//
	// Amazon Kendra offers three customization options:
	//
	//    * Choose to COLLAPSE all documents with null or missing values in one
	//    group. This is the default configuration.
	//
	//    * Choose to IGNORE documents with null or missing values. Ignored documents
	//    will not appear in query results.
	//
	//    * Choose to EXPAND each document with a null or missing value into a group
	//    of its own.
	MissingAttributeKeyStrategy *string `type:"string" enum:"MissingAttributeKeyStrategy"`

	// A prioritized list of document attributes/fields that determine the primary
	// document among those in a collapsed group.
	SortingConfigurations []*SortingConfiguration `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.

func (CollapseConfiguration) GoString added in v1.45.28 

func (s CollapseConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CollapseConfiguration) SetDocumentAttributeKey added in v1.45.28 

func (s *CollapseConfiguration) SetDocumentAttributeKey(v string) *CollapseConfiguration

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*CollapseConfiguration) SetExpand added in v1.45.28 

func (s *CollapseConfiguration) SetExpand(v bool) *CollapseConfiguration

SetExpand sets the Expand field's value.

func (*CollapseConfiguration) SetExpandConfiguration added in v1.45.28 

func (s *CollapseConfiguration) SetExpandConfiguration(v *ExpandConfiguration) *CollapseConfiguration

SetExpandConfiguration sets the ExpandConfiguration field's value.

func (*CollapseConfiguration) SetMissingAttributeKeyStrategy added in v1.45.28 

func (s *CollapseConfiguration) SetMissingAttributeKeyStrategy(v string) *CollapseConfiguration

SetMissingAttributeKeyStrategy sets the MissingAttributeKeyStrategy field's value.

func (*CollapseConfiguration) SetSortingConfigurations added in v1.45.28 

func (s *CollapseConfiguration) SetSortingConfigurations(v []*SortingConfiguration) *CollapseConfiguration

SetSortingConfigurations sets the SortingConfigurations field's value.

func (CollapseConfiguration) String added in v1.45.28 

func (s CollapseConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CollapseConfiguration) Validate added in v1.45.28 

func (s *CollapseConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CollapsedResultDetail added in v1.45.28 

type CollapsedResultDetail struct {

	// The value of the document attribute that results are collapsed on.
	//
	// DocumentAttribute is a required field
	DocumentAttribute *DocumentAttribute `type:"structure" required:"true"`

	// A list of results in the collapsed group.
	ExpandedResults []*ExpandedResultItem `type:"list"`
	// contains filtered or unexported fields
}

Provides details about a collapsed group of search results.

func (CollapsedResultDetail) GoString added in v1.45.28 

func (s CollapsedResultDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CollapsedResultDetail) SetDocumentAttribute added in v1.45.28 

func (s *CollapsedResultDetail) SetDocumentAttribute(v *DocumentAttribute) *CollapsedResultDetail

SetDocumentAttribute sets the DocumentAttribute field's value.

func (*CollapsedResultDetail) SetExpandedResults added in v1.45.28 

func (s *CollapsedResultDetail) SetExpandedResults(v []*ExpandedResultItem) *CollapsedResultDetail

SetExpandedResults sets the ExpandedResults field's value.

func (CollapsedResultDetail) String added in v1.45.28 

func (s CollapsedResultDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ColumnConfiguration 

type ColumnConfiguration struct {

	// One to five columns that indicate when a document in the database has changed.
	//
	// ChangeDetectingColumns is a required field
	ChangeDetectingColumns []*string `min:"1" type:"list" required:"true"`

	// The column that contains the contents of the document.
	//
	// DocumentDataColumnName is a required field
	DocumentDataColumnName *string `min:"1" type:"string" required:"true"`

	// The column that provides the document's identifier.
	//
	// DocumentIdColumnName is a required field
	DocumentIdColumnName *string `min:"1" type:"string" required:"true"`

	// The column that contains the title of the document.
	DocumentTitleColumnName *string `min:"1" type:"string"`

	// An array of objects that map database column names to the corresponding fields
	// in an index. You must first create the fields in the index using the UpdateIndex
	// API.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides information about how Amazon Kendra should use the columns of a database in an index.

func (ColumnConfiguration) GoString 

func (s ColumnConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnConfiguration) SetChangeDetectingColumns 

func (s *ColumnConfiguration) SetChangeDetectingColumns(v []*string) *ColumnConfiguration

SetChangeDetectingColumns sets the ChangeDetectingColumns field's value.

func (*ColumnConfiguration) SetDocumentDataColumnName 

func (s *ColumnConfiguration) SetDocumentDataColumnName(v string) *ColumnConfiguration

SetDocumentDataColumnName sets the DocumentDataColumnName field's value.

func (*ColumnConfiguration) SetDocumentIdColumnName 

func (s *ColumnConfiguration) SetDocumentIdColumnName(v string) *ColumnConfiguration

SetDocumentIdColumnName sets the DocumentIdColumnName field's value.

func (*ColumnConfiguration) SetDocumentTitleColumnName 

func (s *ColumnConfiguration) SetDocumentTitleColumnName(v string) *ColumnConfiguration

SetDocumentTitleColumnName sets the DocumentTitleColumnName field's value.

func (*ColumnConfiguration) SetFieldMappings 

func (s *ColumnConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *ColumnConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (ColumnConfiguration) String 

func (s ColumnConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnConfiguration) Validate 

func (s *ColumnConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException added in v1.28.0 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

func (*ConflictException) Code added in v1.28.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.28.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String added in v1.28.0 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictingItem added in v1.44.233 

type ConflictingItem struct {

	// The text of the conflicting query.
	QueryText *string `type:"string"`

	// The identifier of the set of featured results that the conflicting query
	// belongs to.
	SetId *string `min:"1" type:"string"`

	// The name for the set of featured results that the conflicting query belongs
	// to.
	SetName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about a conflicting query used across different sets of featured results. When you create a featured results set, you must check that the queries are unique per featured results set for each index.

func (ConflictingItem) GoString added in v1.44.233 

func (s ConflictingItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictingItem) SetQueryText added in v1.44.233 

func (s *ConflictingItem) SetQueryText(v string) *ConflictingItem

SetQueryText sets the QueryText field's value.

func (*ConflictingItem) SetSetId added in v1.44.233 

func (s *ConflictingItem) SetSetId(v string) *ConflictingItem

SetSetId sets the SetId field's value.

func (*ConflictingItem) SetSetName added in v1.44.233 

func (s *ConflictingItem) SetSetName(v string) *ConflictingItem

SetSetName sets the SetName field's value.

func (ConflictingItem) String added in v1.44.233 

func (s ConflictingItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfluenceAttachmentConfiguration added in v1.35.15 

type ConfluenceAttachmentConfiguration struct {

	// Maps attributes or field names of Confluence attachments to Amazon Kendra
	// index field names. To create custom fields, use the UpdateIndex API before
	// you map to Confluence fields. For more information, see Mapping data source
	// fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Confluence data source field names must exist in your Confluence custom
	// metadata.
	//
	// If you specify the AttachentFieldMappings parameter, you must specify at
	// least one field mapping.
	AttachmentFieldMappings []*ConfluenceAttachmentToIndexFieldMapping `min:"1" type:"list"`

	// TRUE to index attachments of pages and blogs in Confluence.
	CrawlAttachments *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

func (ConfluenceAttachmentConfiguration) GoString added in v1.35.15 

func (s ConfluenceAttachmentConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceAttachmentConfiguration) SetAttachmentFieldMappings added in v1.35.15 

func (s *ConfluenceAttachmentConfiguration) SetAttachmentFieldMappings(v []*ConfluenceAttachmentToIndexFieldMapping) *ConfluenceAttachmentConfiguration

SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value.

func (*ConfluenceAttachmentConfiguration) SetCrawlAttachments added in v1.35.15 

func (s *ConfluenceAttachmentConfiguration) SetCrawlAttachments(v bool) *ConfluenceAttachmentConfiguration

SetCrawlAttachments sets the CrawlAttachments field's value.

func (ConfluenceAttachmentConfiguration) String added in v1.35.15 

func (s ConfluenceAttachmentConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceAttachmentConfiguration) Validate added in v1.35.15 

func (s *ConfluenceAttachmentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluenceAttachmentToIndexFieldMapping added in v1.35.15 

type ConfluenceAttachmentToIndexFieldMapping struct {

	// The name of the field in the data source.
	//
	// You must first create the index field using the UpdateIndex API.
	DataSourceFieldName *string `type:"string" enum:"ConfluenceAttachmentFieldName"`

	// The format for date fields in the data source. If the field specified in
	// DataSourceFieldName is a date field you must specify the date format. If
	// the field is not a date field, an exception is thrown.
	DateFieldFormat *string `min:"4" type:"string"`

	// The name of the index field to map to the Confluence data source field. The
	// index field type must match the Confluence field type.
	IndexFieldName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confuence data source field names must exist in your Confluence custom metadata.

func (ConfluenceAttachmentToIndexFieldMapping) GoString added in v1.35.15 

func (s ConfluenceAttachmentToIndexFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceAttachmentToIndexFieldMapping) SetDataSourceFieldName added in v1.35.15 

func (s *ConfluenceAttachmentToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceAttachmentToIndexFieldMapping

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetDateFieldFormat added in v1.35.15 

func (s *ConfluenceAttachmentToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceAttachmentToIndexFieldMapping

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetIndexFieldName added in v1.35.15 

func (s *ConfluenceAttachmentToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceAttachmentToIndexFieldMapping

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceAttachmentToIndexFieldMapping) String added in v1.35.15 

func (s ConfluenceAttachmentToIndexFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceAttachmentToIndexFieldMapping) Validate added in v1.35.15 

func (s *ConfluenceAttachmentToIndexFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluenceBlogConfiguration added in v1.35.15 

type ConfluenceBlogConfiguration struct {

	// Maps attributes or field names of Confluence blogs to Amazon Kendra index
	// field names. To create custom fields, use the UpdateIndex API before you
	// map to Confluence fields. For more information, see Mapping data source fields
	// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence
	// data source field names must exist in your Confluence custom metadata.
	//
	// If you specify the BlogFieldMappings parameter, you must specify at least
	// one field mapping.
	BlogFieldMappings []*ConfluenceBlogToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.

func (ConfluenceBlogConfiguration) GoString added in v1.35.15 

func (s ConfluenceBlogConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceBlogConfiguration) SetBlogFieldMappings added in v1.35.15 

func (s *ConfluenceBlogConfiguration) SetBlogFieldMappings(v []*ConfluenceBlogToIndexFieldMapping) *ConfluenceBlogConfiguration

SetBlogFieldMappings sets the BlogFieldMappings field's value.

func (ConfluenceBlogConfiguration) String added in v1.35.15 

func (s ConfluenceBlogConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceBlogConfiguration) Validate added in v1.35.15 

func (s *ConfluenceBlogConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluenceBlogToIndexFieldMapping added in v1.35.15 

type ConfluenceBlogToIndexFieldMapping struct {

	// The name of the field in the data source.
	DataSourceFieldName *string `type:"string" enum:"ConfluenceBlogFieldName"`

	// The format for date fields in the data source. If the field specified in
	// DataSourceFieldName is a date field you must specify the date format. If
	// the field is not a date field, an exception is thrown.
	DateFieldFormat *string `min:"4" type:"string"`

	// The name of the index field to map to the Confluence data source field. The
	// index field type must match the Confluence field type.
	IndexFieldName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Maps attributes or field names of Confluence blog to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.

func (ConfluenceBlogToIndexFieldMapping) GoString added in v1.35.15 

func (s ConfluenceBlogToIndexFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceBlogToIndexFieldMapping) SetDataSourceFieldName added in v1.35.15 

func (s *ConfluenceBlogToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceBlogToIndexFieldMapping

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetDateFieldFormat added in v1.35.15 

func (s *ConfluenceBlogToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceBlogToIndexFieldMapping

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetIndexFieldName added in v1.35.15 

func (s *ConfluenceBlogToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceBlogToIndexFieldMapping

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceBlogToIndexFieldMapping) String added in v1.35.15 

func (s ConfluenceBlogToIndexFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceBlogToIndexFieldMapping) Validate added in v1.35.15 

func (s *ConfluenceBlogToIndexFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluenceConfiguration added in v1.35.15 

type ConfluenceConfiguration struct {

	// Configuration information for indexing attachments to Confluence blogs and
	// pages.
	AttachmentConfiguration *ConfluenceAttachmentConfiguration `type:"structure"`

	// Whether you want to connect to Confluence using basic authentication of user
	// name and password, or a personal access token. You can use a personal access
	// token for Confluence Server.
	AuthenticationType *string `type:"string" enum:"ConfluenceAuthenticationType"`

	// Configuration information for indexing Confluence blogs.
	BlogConfiguration *ConfluenceBlogConfiguration `type:"structure"`

	// A list of regular expression patterns to exclude certain blog posts, pages,
	// spaces, or attachments in your Confluence. Content that matches the patterns
	// are excluded from the index. Content that doesn't match the patterns is included
	// in the index. If content matches both an inclusion and exclusion pattern,
	// the exclusion pattern takes precedence and the content isn't included in
	// the index.
	ExclusionPatterns []*string `type:"list"`

	// A list of regular expression patterns to include certain blog posts, pages,
	// spaces, or attachments in your Confluence. Content that matches the patterns
	// are included in the index. Content that doesn't match the patterns is excluded
	// from the index. If content matches both an inclusion and exclusion pattern,
	// the exclusion pattern takes precedence and the content isn't included in
	// the index.
	InclusionPatterns []*string `type:"list"`

	// Configuration information for indexing Confluence pages.
	PageConfiguration *ConfluencePageConfiguration `type:"structure"`

	// Configuration information to connect to your Confluence URL instance via
	// a web proxy. You can use this option for Confluence Server.
	//
	// You must provide the website host name and port number. For example, the
	// host name of https://a.example.com/page1.html is "a.example.com" and the
	// port is 443, the standard port for HTTPS.
	//
	// Web proxy credentials are optional and you can use them to connect to a web
	// proxy server that requires basic authentication of user name and password.
	// To store web proxy credentials, you use a secret in Secrets Manager.
	//
	// It is recommended that you follow best security practices when configuring
	// your web proxy. This includes setting up throttling, setting up logging and
	// monitoring, and applying security patches on a regular basis. If you use
	// your web proxy with multiple data sources, sync jobs that occur at the same
	// time could strain the load on your proxy. It is recommended you prepare your
	// proxy beforehand for any security and load requirements.
	ProxyConfiguration *ProxyConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the user name and password required to connect to the Confluence instance.
	// If you use Confluence Cloud, you use a generated API token as the password.
	//
	// You can also provide authentication credentials in the form of a personal
	// access token. For more information, see Using a Confluence data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The URL of your Confluence instance. Use the full URL of the server. For
	// example, https://server.example.com:port/. You can also use an IP address,
	// for example, https://192.168.1.113/.
	//
	// ServerUrl is a required field
	ServerUrl *string `min:"1" type:"string" required:"true"`

	// Configuration information for indexing Confluence spaces.
	SpaceConfiguration *ConfluenceSpaceConfiguration `type:"structure"`

	// The version or the type of Confluence installation to connect to.
	//
	// Version is a required field
	Version *string `type:"string" required:"true" enum:"ConfluenceVersion"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your Confluence. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Confluence as your data source.

func (ConfluenceConfiguration) GoString added in v1.35.15 

func (s ConfluenceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceConfiguration) SetAttachmentConfiguration added in v1.35.15 

func (s *ConfluenceConfiguration) SetAttachmentConfiguration(v *ConfluenceAttachmentConfiguration) *ConfluenceConfiguration

SetAttachmentConfiguration sets the AttachmentConfiguration field's value.

func (*ConfluenceConfiguration) SetAuthenticationType added in v1.44.81 

func (s *ConfluenceConfiguration) SetAuthenticationType(v string) *ConfluenceConfiguration

SetAuthenticationType sets the AuthenticationType field's value.

func (*ConfluenceConfiguration) SetBlogConfiguration added in v1.35.15 

func (s *ConfluenceConfiguration) SetBlogConfiguration(v *ConfluenceBlogConfiguration) *ConfluenceConfiguration

SetBlogConfiguration sets the BlogConfiguration field's value.

func (*ConfluenceConfiguration) SetExclusionPatterns added in v1.35.15 

func (s *ConfluenceConfiguration) SetExclusionPatterns(v []*string) *ConfluenceConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*ConfluenceConfiguration) SetInclusionPatterns added in v1.35.15 

func (s *ConfluenceConfiguration) SetInclusionPatterns(v []*string) *ConfluenceConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*ConfluenceConfiguration) SetPageConfiguration added in v1.35.15 

func (s *ConfluenceConfiguration) SetPageConfiguration(v *ConfluencePageConfiguration) *ConfluenceConfiguration

SetPageConfiguration sets the PageConfiguration field's value.

func (*ConfluenceConfiguration) SetProxyConfiguration added in v1.44.79 

func (s *ConfluenceConfiguration) SetProxyConfiguration(v *ProxyConfiguration) *ConfluenceConfiguration

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*ConfluenceConfiguration) SetSecretArn added in v1.35.15 

func (s *ConfluenceConfiguration) SetSecretArn(v string) *ConfluenceConfiguration

SetSecretArn sets the SecretArn field's value.

func (*ConfluenceConfiguration) SetServerUrl added in v1.35.15 

func (s *ConfluenceConfiguration) SetServerUrl(v string) *ConfluenceConfiguration

SetServerUrl sets the ServerUrl field's value.

func (*ConfluenceConfiguration) SetSpaceConfiguration added in v1.35.15 

func (s *ConfluenceConfiguration) SetSpaceConfiguration(v *ConfluenceSpaceConfiguration) *ConfluenceConfiguration

SetSpaceConfiguration sets the SpaceConfiguration field's value.

func (*ConfluenceConfiguration) SetVersion added in v1.35.15 

func (s *ConfluenceConfiguration) SetVersion(v string) *ConfluenceConfiguration

SetVersion sets the Version field's value.

func (*ConfluenceConfiguration) SetVpcConfiguration added in v1.35.15 

func (s *ConfluenceConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *ConfluenceConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (ConfluenceConfiguration) String added in v1.35.15 

func (s ConfluenceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceConfiguration) Validate added in v1.35.15 

func (s *ConfluenceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluencePageConfiguration added in v1.35.15 

type ConfluencePageConfiguration struct {

	// Maps attributes or field names of Confluence pages to Amazon Kendra index
	// field names. To create custom fields, use the UpdateIndex API before you
	// map to Confluence fields. For more information, see Mapping data source fields
	// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence
	// data source field names must exist in your Confluence custom metadata.
	//
	// If you specify the PageFieldMappings parameter, you must specify at least
	// one field mapping.
	PageFieldMappings []*ConfluencePageToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Configuration of the page settings for the Confluence data source.

func (ConfluencePageConfiguration) GoString added in v1.35.15 

func (s ConfluencePageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluencePageConfiguration) SetPageFieldMappings added in v1.35.15 

func (s *ConfluencePageConfiguration) SetPageFieldMappings(v []*ConfluencePageToIndexFieldMapping) *ConfluencePageConfiguration

SetPageFieldMappings sets the PageFieldMappings field's value.

func (ConfluencePageConfiguration) String added in v1.35.15 

func (s ConfluencePageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluencePageConfiguration) Validate added in v1.35.15 

func (s *ConfluencePageConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluencePageToIndexFieldMapping added in v1.35.15 

type ConfluencePageToIndexFieldMapping struct {

	// The name of the field in the data source.
	DataSourceFieldName *string `type:"string" enum:"ConfluencePageFieldName"`

	// The format for date fields in the data source. If the field specified in
	// DataSourceFieldName is a date field you must specify the date format. If
	// the field is not a date field, an exception is thrown.
	DateFieldFormat *string `min:"4" type:"string"`

	// The name of the index field to map to the Confluence data source field. The
	// index field type must match the Confluence field type.
	IndexFieldName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.

func (ConfluencePageToIndexFieldMapping) GoString added in v1.35.15 

func (s ConfluencePageToIndexFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluencePageToIndexFieldMapping) SetDataSourceFieldName added in v1.35.15 

func (s *ConfluencePageToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluencePageToIndexFieldMapping

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluencePageToIndexFieldMapping) SetDateFieldFormat added in v1.35.15 

func (s *ConfluencePageToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluencePageToIndexFieldMapping

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluencePageToIndexFieldMapping) SetIndexFieldName added in v1.35.15 

func (s *ConfluencePageToIndexFieldMapping) SetIndexFieldName(v string) *ConfluencePageToIndexFieldMapping

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluencePageToIndexFieldMapping) String added in v1.35.15 

func (s ConfluencePageToIndexFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluencePageToIndexFieldMapping) Validate added in v1.35.15 

func (s *ConfluencePageToIndexFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluenceSpaceConfiguration added in v1.35.15 

type ConfluenceSpaceConfiguration struct {

	// TRUE to index archived spaces.
	CrawlArchivedSpaces *bool `type:"boolean"`

	// TRUE to index personal spaces. You can add restrictions to items in personal
	// spaces. If personal spaces are indexed, queries without user context information
	// may return restricted items from a personal space in their results. For more
	// information, see Filtering on user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).
	CrawlPersonalSpaces *bool `type:"boolean"`

	// A list of space keys of Confluence spaces. If you include a key, the blogs,
	// documents, and attachments in the space are not indexed. If a space is in
	// both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.
	ExcludeSpaces []*string `min:"1" type:"list"`

	// A list of space keys for Confluence spaces. If you include a key, the blogs,
	// documents, and attachments in the space are indexed. Spaces that aren't in
	// the list aren't indexed. A space in the list must exist. Otherwise, Amazon
	// Kendra logs an error when the data source is synchronized. If a space is
	// in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.
	IncludeSpaces []*string `min:"1" type:"list"`

	// Maps attributes or field names of Confluence spaces to Amazon Kendra index
	// field names. To create custom fields, use the UpdateIndex API before you
	// map to Confluence fields. For more information, see Mapping data source fields
	// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence
	// data source field names must exist in your Confluence custom metadata.
	//
	// If you specify the SpaceFieldMappings parameter, you must specify at least
	// one field mapping.
	SpaceFieldMappings []*ConfluenceSpaceToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Configuration information for indexing Confluence spaces.

func (ConfluenceSpaceConfiguration) GoString added in v1.35.15 

func (s ConfluenceSpaceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceSpaceConfiguration) SetCrawlArchivedSpaces added in v1.35.15 

func (s *ConfluenceSpaceConfiguration) SetCrawlArchivedSpaces(v bool) *ConfluenceSpaceConfiguration

SetCrawlArchivedSpaces sets the CrawlArchivedSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetCrawlPersonalSpaces added in v1.35.15 

func (s *ConfluenceSpaceConfiguration) SetCrawlPersonalSpaces(v bool) *ConfluenceSpaceConfiguration

SetCrawlPersonalSpaces sets the CrawlPersonalSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetExcludeSpaces added in v1.35.15 

func (s *ConfluenceSpaceConfiguration) SetExcludeSpaces(v []*string) *ConfluenceSpaceConfiguration

SetExcludeSpaces sets the ExcludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetIncludeSpaces added in v1.35.15 

func (s *ConfluenceSpaceConfiguration) SetIncludeSpaces(v []*string) *ConfluenceSpaceConfiguration

SetIncludeSpaces sets the IncludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetSpaceFieldMappings added in v1.35.15 

func (s *ConfluenceSpaceConfiguration) SetSpaceFieldMappings(v []*ConfluenceSpaceToIndexFieldMapping) *ConfluenceSpaceConfiguration

SetSpaceFieldMappings sets the SpaceFieldMappings field's value.

func (ConfluenceSpaceConfiguration) String added in v1.35.15 

func (s ConfluenceSpaceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceSpaceConfiguration) Validate added in v1.35.15 

func (s *ConfluenceSpaceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfluenceSpaceToIndexFieldMapping added in v1.35.15 

type ConfluenceSpaceToIndexFieldMapping struct {

	// The name of the field in the data source.
	DataSourceFieldName *string `type:"string" enum:"ConfluenceSpaceFieldName"`

	// The format for date fields in the data source. If the field specified in
	// DataSourceFieldName is a date field you must specify the date format. If
	// the field is not a date field, an exception is thrown.
	DateFieldFormat *string `min:"4" type:"string"`

	// The name of the index field to map to the Confluence data source field. The
	// index field type must match the Confluence field type.
	IndexFieldName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Confluence data source field names must exist in your Confluence custom metadata.

func (ConfluenceSpaceToIndexFieldMapping) GoString added in v1.35.15 

func (s ConfluenceSpaceToIndexFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceSpaceToIndexFieldMapping) SetDataSourceFieldName added in v1.35.15 

func (s *ConfluenceSpaceToIndexFieldMapping) SetDataSourceFieldName(v string) *ConfluenceSpaceToIndexFieldMapping

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetDateFieldFormat added in v1.35.15 

func (s *ConfluenceSpaceToIndexFieldMapping) SetDateFieldFormat(v string) *ConfluenceSpaceToIndexFieldMapping

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetIndexFieldName added in v1.35.15 

func (s *ConfluenceSpaceToIndexFieldMapping) SetIndexFieldName(v string) *ConfluenceSpaceToIndexFieldMapping

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceSpaceToIndexFieldMapping) String added in v1.35.15 

func (s ConfluenceSpaceToIndexFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfluenceSpaceToIndexFieldMapping) Validate added in v1.35.15 

func (s *ConfluenceSpaceToIndexFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConnectionConfiguration 

type ConnectionConfiguration struct {

	// The name of the host for the database. Can be either a string (host.subdomain.domain.tld)
	// or an IPv4 or IPv6 address.
	//
	// DatabaseHost is a required field
	DatabaseHost *string `min:"1" type:"string" required:"true"`

	// The name of the database containing the document data.
	//
	// DatabaseName is a required field
	DatabaseName *string `min:"1" type:"string" required:"true"`

	// The port that the database uses for connections.
	//
	// DatabasePort is a required field
	DatabasePort *int64 `min:"1" type:"integer" required:"true"`

	// The Amazon Resource Name (ARN) of credentials stored in Secrets Manager.
	// The credentials should be a user/password pair. For more information, see
	// Using a Database Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html).
	// For more information about Secrets Manager, see What Is Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
	// in the Secrets Manager user guide.
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The name of the table that contains the document data.
	//
	// TableName is a required field
	TableName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information that's required to connect to a database.

func (ConnectionConfiguration) GoString 

func (s ConnectionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionConfiguration) SetDatabaseHost 

func (s *ConnectionConfiguration) SetDatabaseHost(v string) *ConnectionConfiguration

SetDatabaseHost sets the DatabaseHost field's value.

func (*ConnectionConfiguration) SetDatabaseName 

func (s *ConnectionConfiguration) SetDatabaseName(v string) *ConnectionConfiguration

SetDatabaseName sets the DatabaseName field's value.

func (*ConnectionConfiguration) SetDatabasePort 

func (s *ConnectionConfiguration) SetDatabasePort(v int64) *ConnectionConfiguration

SetDatabasePort sets the DatabasePort field's value.

func (*ConnectionConfiguration) SetSecretArn 

func (s *ConnectionConfiguration) SetSecretArn(v string) *ConnectionConfiguration

SetSecretArn sets the SecretArn field's value.

func (*ConnectionConfiguration) SetTableName 

func (s *ConnectionConfiguration) SetTableName(v string) *ConnectionConfiguration

SetTableName sets the TableName field's value.

func (ConnectionConfiguration) String 

func (s ConnectionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionConfiguration) Validate 

func (s *ConnectionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContentSourceConfiguration added in v1.42.17 

type ContentSourceConfiguration struct {

	// The identifier of the data sources you want to use for your Amazon Kendra
	// experience.
	DataSourceIds []*string `min:"1" type:"list"`

	// TRUE to use documents you indexed directly using the BatchPutDocument API.
	DirectPutContent *bool `type:"boolean"`

	// The identifier of the FAQs that you want to use for your Amazon Kendra experience.
	FaqIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information for your content sources, such as data sources, FAQs, and content indexed directly via BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html).

func (ContentSourceConfiguration) GoString added in v1.42.17 

func (s ContentSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentSourceConfiguration) SetDataSourceIds added in v1.42.17 

func (s *ContentSourceConfiguration) SetDataSourceIds(v []*string) *ContentSourceConfiguration

SetDataSourceIds sets the DataSourceIds field's value.

func (*ContentSourceConfiguration) SetDirectPutContent added in v1.42.17 

func (s *ContentSourceConfiguration) SetDirectPutContent(v bool) *ContentSourceConfiguration

SetDirectPutContent sets the DirectPutContent field's value.

func (*ContentSourceConfiguration) SetFaqIds added in v1.42.17 

func (s *ContentSourceConfiguration) SetFaqIds(v []*string) *ContentSourceConfiguration

SetFaqIds sets the FaqIds field's value.

func (ContentSourceConfiguration) String added in v1.42.17 

func (s ContentSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContentSourceConfiguration) Validate added in v1.42.17 

func (s *ContentSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Correction added in v1.43.11 

type Correction struct {

	// The zero-based location in the response string or text where the corrected
	// word starts.
	BeginOffset *int64 `type:"integer"`

	// The string or text of a corrected misspelled word in a query.
	CorrectedTerm *string `min:"1" type:"string"`

	// The zero-based location in the response string or text where the corrected
	// word ends.
	EndOffset *int64 `type:"integer"`

	// The string or text of a misspelled word in a query.
	Term *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A corrected misspelled word in a query.

func (Correction) GoString added in v1.43.11 

func (s Correction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Correction) SetBeginOffset added in v1.43.11 

func (s *Correction) SetBeginOffset(v int64) *Correction

SetBeginOffset sets the BeginOffset field's value.

func (*Correction) SetCorrectedTerm added in v1.43.11 

func (s *Correction) SetCorrectedTerm(v string) *Correction

SetCorrectedTerm sets the CorrectedTerm field's value.

func (*Correction) SetEndOffset added in v1.43.11 

func (s *Correction) SetEndOffset(v int64) *Correction

SetEndOffset sets the EndOffset field's value.

func (*Correction) SetTerm added in v1.43.11 

func (s *Correction) SetTerm(v string) *Correction

SetTerm sets the Term field's value.

func (Correction) String added in v1.43.11 

func (s Correction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAccessControlConfigurationInput added in v1.44.55 

type CreateAccessControlConfigurationInput struct {

	// Information on principals (users and/or groups) and which documents they
	// should have access to. This is useful for user context filtering, where search
	// results are filtered based on the user or their group access to documents.
	AccessControlList []*Principal `type:"list"`

	// A token that you provide to identify the request to create an access control
	// configuration. Multiple calls to the CreateAccessControlConfiguration API
	// with the same client token will create only one access control configuration.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description for the access control configuration.
	Description *string `type:"string"`

	// The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html)
	// lists that define the hierarchy for which documents users should have access
	// to.
	HierarchicalAccessControlList []*HierarchicalPrincipal `min:"1" type:"list"`

	// The identifier of the index to create an access control configuration for
	// your documents.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A name for the access control configuration.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAccessControlConfigurationInput) GoString added in v1.44.55 

func (s CreateAccessControlConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessControlConfigurationInput) SetAccessControlList added in v1.44.55 

func (s *CreateAccessControlConfigurationInput) SetAccessControlList(v []*Principal) *CreateAccessControlConfigurationInput

SetAccessControlList sets the AccessControlList field's value.

func (*CreateAccessControlConfigurationInput) SetClientToken added in v1.44.55 

func (s *CreateAccessControlConfigurationInput) SetClientToken(v string) *CreateAccessControlConfigurationInput

SetClientToken sets the ClientToken field's value.

func (*CreateAccessControlConfigurationInput) SetDescription added in v1.44.55 

func (s *CreateAccessControlConfigurationInput) SetDescription(v string) *CreateAccessControlConfigurationInput

SetDescription sets the Description field's value.

func (*CreateAccessControlConfigurationInput) SetHierarchicalAccessControlList added in v1.44.55 

func (s *CreateAccessControlConfigurationInput) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *CreateAccessControlConfigurationInput

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*CreateAccessControlConfigurationInput) SetIndexId added in v1.44.55 

func (s *CreateAccessControlConfigurationInput) SetIndexId(v string) *CreateAccessControlConfigurationInput

SetIndexId sets the IndexId field's value.

func (*CreateAccessControlConfigurationInput) SetName added in v1.44.55 

func (s *CreateAccessControlConfigurationInput) SetName(v string) *CreateAccessControlConfigurationInput

SetName sets the Name field's value.

func (CreateAccessControlConfigurationInput) String added in v1.44.55 

func (s CreateAccessControlConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessControlConfigurationInput) Validate added in v1.44.55 

func (s *CreateAccessControlConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAccessControlConfigurationOutput added in v1.44.55 

type CreateAccessControlConfigurationOutput struct {

	// The identifier of the access control configuration for your documents in
	// an index.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAccessControlConfigurationOutput) GoString added in v1.44.55 

func (s CreateAccessControlConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessControlConfigurationOutput) SetId added in v1.44.55 

func (s *CreateAccessControlConfigurationOutput) SetId(v string) *CreateAccessControlConfigurationOutput

SetId sets the Id field's value.

func (CreateAccessControlConfigurationOutput) String added in v1.44.55 

func (s CreateAccessControlConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDataSourceInput 

type CreateDataSourceInput struct {

	// A token that you provide to identify the request to create a data source
	// connector. Multiple calls to the CreateDataSource API with the same client
	// token will create only one data source connector.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Configuration information to connect to your data source repository.
	//
	// You can't specify the Configuration parameter when the Type parameter is
	// set to CUSTOM. If you do, you receive a ValidationException exception.
	//
	// The Configuration parameter is required for all other data sources.
	Configuration *DataSourceConfiguration `type:"structure"`

	// Configuration information for altering document metadata and content during
	// the document ingestion process.
	//
	// For more information on how to create, modify and delete document metadata,
	// or make other content alterations when you ingest documents into Amazon Kendra,
	// see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
	CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"`

	// A description for the data source connector.
	Description *string `type:"string"`

	// The identifier of the index you want to use with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The code for a language. This allows you to support a language for all documents
	// when creating the data source connector. English is supported by default.
	// For more information on supported languages, including their codes, see Adding
	// documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
	LanguageCode *string `min:"2" type:"string"`

	// A name for the data source connector.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role with permission to access the
	// data source and required resources. For more information, see IAM access
	// roles for Amazon Kendra. (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// You can't specify the RoleArn parameter when the Type parameter is set to
	// CUSTOM. If you do, you receive a ValidationException exception.
	//
	// The RoleArn parameter is required for all other data sources.
	RoleArn *string `type:"string"`

	// Sets the frequency for Amazon Kendra to check the documents in your data
	// source repository and update the index. If you don't set a schedule Amazon
	// Kendra will not periodically update the index. You can call the StartDataSourceSyncJob
	// API to update the index.
	//
	// Specify a cron- format schedule string or an empty string to indicate that
	// the index is updated on demand.
	//
	// You can't specify the Schedule parameter when the Type parameter is set to
	// CUSTOM. If you do, you receive a ValidationException exception.
	Schedule *string `type:"string"`

	// A list of key-value pairs that identify or categorize the data source connector.
	// You can also use tags to help control access to the data source connector.
	// Tag keys and values can consist of Unicode letters, digits, white space,
	// and any of the following symbols: _ . : / = + - @.
	Tags []*Tag `type:"list"`

	// The type of data source repository. For example, SHAREPOINT.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DataSourceType"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDataSourceInput) GoString 

func (s CreateDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataSourceInput) SetClientToken added in v1.35.12 

func (s *CreateDataSourceInput) SetClientToken(v string) *CreateDataSourceInput

SetClientToken sets the ClientToken field's value.

func (*CreateDataSourceInput) SetConfiguration 

func (s *CreateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *CreateDataSourceInput

SetConfiguration sets the Configuration field's value.

func (*CreateDataSourceInput) SetCustomDocumentEnrichmentConfiguration added in v1.42.17 

func (s *CreateDataSourceInput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *CreateDataSourceInput

SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value.

func (*CreateDataSourceInput) SetDescription 

func (s *CreateDataSourceInput) SetDescription(v string) *CreateDataSourceInput

SetDescription sets the Description field's value.

func (*CreateDataSourceInput) SetIndexId 

func (s *CreateDataSourceInput) SetIndexId(v string) *CreateDataSourceInput

SetIndexId sets the IndexId field's value.

func (*CreateDataSourceInput) SetLanguageCode added in v1.40.58 

func (s *CreateDataSourceInput) SetLanguageCode(v string) *CreateDataSourceInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateDataSourceInput) SetName 

func (s *CreateDataSourceInput) SetName(v string) *CreateDataSourceInput

SetName sets the Name field's value.

func (*CreateDataSourceInput) SetRoleArn 

func (s *CreateDataSourceInput) SetRoleArn(v string) *CreateDataSourceInput

SetRoleArn sets the RoleArn field's value.

func (*CreateDataSourceInput) SetSchedule 

func (s *CreateDataSourceInput) SetSchedule(v string) *CreateDataSourceInput

SetSchedule sets the Schedule field's value.

func (*CreateDataSourceInput) SetTags added in v1.30.25 

func (s *CreateDataSourceInput) SetTags(v []*Tag) *CreateDataSourceInput

SetTags sets the Tags field's value.

func (*CreateDataSourceInput) SetType 

func (s *CreateDataSourceInput) SetType(v string) *CreateDataSourceInput

SetType sets the Type field's value.

func (*CreateDataSourceInput) SetVpcConfiguration added in v1.44.79 

func (s *CreateDataSourceInput) SetVpcConfiguration(v *DataSourceVpcConfiguration) *CreateDataSourceInput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (CreateDataSourceInput) String 

func (s CreateDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataSourceInput) Validate 

func (s *CreateDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDataSourceOutput 

type CreateDataSourceOutput struct {

	// The identifier of the data source connector.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDataSourceOutput) GoString 

func (s CreateDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataSourceOutput) SetId 

func (s *CreateDataSourceOutput) SetId(v string) *CreateDataSourceOutput

SetId sets the Id field's value.

func (CreateDataSourceOutput) String 

func (s CreateDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateExperienceInput added in v1.42.17 

type CreateExperienceInput struct {

	// A token that you provide to identify the request to create your Amazon Kendra
	// experience. Multiple calls to the CreateExperience API with the same client
	// token creates only one Amazon Kendra experience.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Configuration information for your Amazon Kendra experience. This includes
	// ContentSourceConfiguration, which specifies the data source IDs and/or FAQ
	// IDs, and UserIdentityConfiguration, which specifies the user or group information
	// to grant access to your Amazon Kendra experience.
	Configuration *ExperienceConfiguration `type:"structure"`

	// A description for your Amazon Kendra experience.
	Description *string `type:"string"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A name for your Amazon Kendra experience.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role with permission to access Query
	// API, GetQuerySuggestions API, and other required APIs. The role also must
	// include permission to access IAM Identity Center that stores your user and
	// group information. For more information, see IAM access roles for Amazon
	// Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateExperienceInput) GoString added in v1.42.17 

func (s CreateExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExperienceInput) SetClientToken added in v1.42.17 

func (s *CreateExperienceInput) SetClientToken(v string) *CreateExperienceInput

SetClientToken sets the ClientToken field's value.

func (*CreateExperienceInput) SetConfiguration added in v1.42.17 

func (s *CreateExperienceInput) SetConfiguration(v *ExperienceConfiguration) *CreateExperienceInput

SetConfiguration sets the Configuration field's value.

func (*CreateExperienceInput) SetDescription added in v1.42.17 

func (s *CreateExperienceInput) SetDescription(v string) *CreateExperienceInput

SetDescription sets the Description field's value.

func (*CreateExperienceInput) SetIndexId added in v1.42.17 

func (s *CreateExperienceInput) SetIndexId(v string) *CreateExperienceInput

SetIndexId sets the IndexId field's value.

func (*CreateExperienceInput) SetName added in v1.42.17 

func (s *CreateExperienceInput) SetName(v string) *CreateExperienceInput

SetName sets the Name field's value.

func (*CreateExperienceInput) SetRoleArn added in v1.42.17 

func (s *CreateExperienceInput) SetRoleArn(v string) *CreateExperienceInput

SetRoleArn sets the RoleArn field's value.

func (CreateExperienceInput) String added in v1.42.17 

func (s CreateExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExperienceInput) Validate added in v1.42.17 

func (s *CreateExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateExperienceOutput added in v1.42.17 

type CreateExperienceOutput struct {

	// The identifier of your Amazon Kendra experience.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateExperienceOutput) GoString added in v1.42.17 

func (s CreateExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateExperienceOutput) SetId added in v1.42.17 

func (s *CreateExperienceOutput) SetId(v string) *CreateExperienceOutput

SetId sets the Id field's value.

func (CreateExperienceOutput) String added in v1.42.17 

func (s CreateExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFaqInput 

type CreateFaqInput struct {

	// A token that you provide to identify the request to create a FAQ. Multiple
	// calls to the CreateFaqRequest API with the same client token will create
	// only one FAQ.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description for the FAQ.
	Description *string `type:"string"`

	// The format of the FAQ input file. You can choose between a basic CSV format,
	// a CSV format that includes customs attributes in a header, and a JSON format
	// that includes custom attributes.
	//
	// The default format is CSV.
	//
	// The format must match the format of the file stored in the S3 bucket identified
	// in the S3Path parameter.
	//
	// For more information, see Adding questions and answers (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).
	FileFormat *string `type:"string" enum:"FaqFileFormat"`

	// The identifier of the index for the FAQ.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The code for a language. This allows you to support a language for the FAQ
	// document. English is supported by default. For more information on supported
	// languages, including their codes, see Adding documents in languages other
	// than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
	LanguageCode *string `min:"2" type:"string"`

	// A name for the FAQ.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role with permission to access the
	// S3 bucket that contains the FAQs. For more information, see IAM access roles
	// for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The path to the FAQ file in S3.
	//
	// S3Path is a required field
	S3Path *S3Path `type:"structure" required:"true"`

	// A list of key-value pairs that identify the FAQ. You can use the tags to
	// identify and organize your resources and to control access to resources.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFaqInput) GoString 

func (s CreateFaqInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFaqInput) SetClientToken added in v1.35.12 

func (s *CreateFaqInput) SetClientToken(v string) *CreateFaqInput

SetClientToken sets the ClientToken field's value.

func (*CreateFaqInput) SetDescription 

func (s *CreateFaqInput) SetDescription(v string) *CreateFaqInput

SetDescription sets the Description field's value.

func (*CreateFaqInput) SetFileFormat added in v1.34.26 

func (s *CreateFaqInput) SetFileFormat(v string) *CreateFaqInput

SetFileFormat sets the FileFormat field's value.

func (*CreateFaqInput) SetIndexId 

func (s *CreateFaqInput) SetIndexId(v string) *CreateFaqInput

SetIndexId sets the IndexId field's value.

func (*CreateFaqInput) SetLanguageCode added in v1.40.58 

func (s *CreateFaqInput) SetLanguageCode(v string) *CreateFaqInput

SetLanguageCode sets the LanguageCode field's value.

func (*CreateFaqInput) SetName 

func (s *CreateFaqInput) SetName(v string) *CreateFaqInput

SetName sets the Name field's value.

func (*CreateFaqInput) SetRoleArn 

func (s *CreateFaqInput) SetRoleArn(v string) *CreateFaqInput

SetRoleArn sets the RoleArn field's value.

func (*CreateFaqInput) SetS3Path 

func (s *CreateFaqInput) SetS3Path(v *S3Path) *CreateFaqInput

SetS3Path sets the S3Path field's value.

func (*CreateFaqInput) SetTags added in v1.30.25 

func (s *CreateFaqInput) SetTags(v []*Tag) *CreateFaqInput

SetTags sets the Tags field's value.

func (CreateFaqInput) String 

func (s CreateFaqInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFaqInput) Validate 

func (s *CreateFaqInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFaqOutput 

type CreateFaqOutput struct {

	// The identifier of the FAQ.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateFaqOutput) GoString 

func (s CreateFaqOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFaqOutput) SetId 

func (s *CreateFaqOutput) SetId(v string) *CreateFaqOutput

SetId sets the Id field's value.

func (CreateFaqOutput) String 

func (s CreateFaqOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFeaturedResultsSetInput added in v1.44.233 

type CreateFeaturedResultsSetInput struct {

	// A token that you provide to identify the request to create a set of featured
	// results. Multiple calls to the CreateFeaturedResultsSet API with the same
	// client token will create only one featured results set.
	ClientToken *string `min:"1" type:"string"`

	// A description for the set of featured results.
	Description *string `type:"string"`

	// A list of document IDs for the documents you want to feature at the top of
	// the search results page. For more information on the list of documents, see
	// FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
	FeaturedDocuments []*FeaturedDocument `type:"list"`

	// A name for the set of featured results.
	//
	// FeaturedResultsSetName is a required field
	FeaturedResultsSetName *string `min:"1" type:"string" required:"true"`

	// The identifier of the index that you want to use for featuring results.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A list of queries for featuring results. For more information on the list
	// of queries, see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
	QueryTexts []*string `type:"list"`

	// The current status of the set of featured results. When the value is ACTIVE,
	// featured results are ready for use. You can still configure your settings
	// before setting the status to ACTIVE. You can set the status to ACTIVE or
	// INACTIVE using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html)
	// API. The queries you specify for featured results must be unique per featured
	// results set for each index, whether the status is ACTIVE or INACTIVE.
	Status *string `type:"string" enum:"FeaturedResultsSetStatus"`

	// A list of key-value pairs that identify or categorize the featured results
	// set. You can also use tags to help control access to the featured results
	// set. Tag keys and values can consist of Unicode letters, digits, white space,
	// and any of the following symbols:_ . : / = + - @.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateFeaturedResultsSetInput) GoString added in v1.44.233 

func (s CreateFeaturedResultsSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFeaturedResultsSetInput) SetClientToken added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetClientToken(v string) *CreateFeaturedResultsSetInput

SetClientToken sets the ClientToken field's value.

func (*CreateFeaturedResultsSetInput) SetDescription added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetDescription(v string) *CreateFeaturedResultsSetInput

SetDescription sets the Description field's value.

func (*CreateFeaturedResultsSetInput) SetFeaturedDocuments added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetFeaturedDocuments(v []*FeaturedDocument) *CreateFeaturedResultsSetInput

SetFeaturedDocuments sets the FeaturedDocuments field's value.

func (*CreateFeaturedResultsSetInput) SetFeaturedResultsSetName added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetFeaturedResultsSetName(v string) *CreateFeaturedResultsSetInput

SetFeaturedResultsSetName sets the FeaturedResultsSetName field's value.

func (*CreateFeaturedResultsSetInput) SetIndexId added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetIndexId(v string) *CreateFeaturedResultsSetInput

SetIndexId sets the IndexId field's value.

func (*CreateFeaturedResultsSetInput) SetQueryTexts added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetQueryTexts(v []*string) *CreateFeaturedResultsSetInput

SetQueryTexts sets the QueryTexts field's value.

func (*CreateFeaturedResultsSetInput) SetStatus added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetStatus(v string) *CreateFeaturedResultsSetInput

SetStatus sets the Status field's value.

func (*CreateFeaturedResultsSetInput) SetTags added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) SetTags(v []*Tag) *CreateFeaturedResultsSetInput

SetTags sets the Tags field's value.

func (CreateFeaturedResultsSetInput) String added in v1.44.233 

func (s CreateFeaturedResultsSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFeaturedResultsSetInput) Validate added in v1.44.233 

func (s *CreateFeaturedResultsSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFeaturedResultsSetOutput added in v1.44.233 

type CreateFeaturedResultsSetOutput struct {

	// Information on the set of featured results. This includes the identifier
	// of the featured results set, whether the featured results set is active or
	// inactive, when the featured results set was created, and more.
	FeaturedResultsSet *FeaturedResultsSet `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateFeaturedResultsSetOutput) GoString added in v1.44.233 

func (s CreateFeaturedResultsSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFeaturedResultsSetOutput) SetFeaturedResultsSet added in v1.44.233 

func (s *CreateFeaturedResultsSetOutput) SetFeaturedResultsSet(v *FeaturedResultsSet) *CreateFeaturedResultsSetOutput

SetFeaturedResultsSet sets the FeaturedResultsSet field's value.

func (CreateFeaturedResultsSetOutput) String added in v1.44.233 

func (s CreateFeaturedResultsSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateIndexInput 

type CreateIndexInput struct {

	// A token that you provide to identify the request to create an index. Multiple
	// calls to the CreateIndex API with the same client token will create only
	// one index.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description for the index.
	Description *string `type:"string"`

	// The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION
	// for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION
	// for production. Once you set the edition for an index, it can't be changed.
	//
	// The Edition parameter is optional. If you don't supply a value, the default
	// is ENTERPRISE_EDITION.
	//
	// For more information on quota limits for Enterprise and Developer editions,
	// see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	Edition *string `type:"string" enum:"IndexEdition"`

	// A name for the index.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role with permission to access your
	// Amazon CloudWatch logs and metrics. For more information, see IAM access
	// roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The identifier of the KMS customer managed key (CMK) that's used to encrypt
	// data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

	// A list of key-value pairs that identify or categorize the index. You can
	// also use tags to help control access to the index. Tag keys and values can
	// consist of Unicode letters, digits, white space, and any of the following
	// symbols: _ . : / = + - @.
	Tags []*Tag `type:"list"`

	// The user context policy.
	//
	// ATTRIBUTE_FILTER
	//
	// All indexed content is searchable and displayable for all users. If you want
	// to filter search results on user context, you can use the attribute filters
	// of _user_id and _group_ids or you can provide user and group information
	// in UserContext.
	//
	// USER_TOKEN
	//
	// Enables token-based user access control to filter search results on user
	// context. All documents with no access control and all documents accessible
	// to the user will be searchable and displayable.
	UserContextPolicy *string `type:"string" enum:"UserContextPolicy"`

	// Gets users and groups from IAM Identity Center identity source. To configure
	// this, see UserGroupResolutionConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html).
	// This is useful for user context filtering, where search results are filtered
	// based on the user or their group access to documents.
	UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"`

	// The user token configuration.
	UserTokenConfigurations []*UserTokenConfiguration `type:"list"`
	// contains filtered or unexported fields
}

func (CreateIndexInput) GoString 

func (s CreateIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIndexInput) SetClientToken added in v1.29.34 

func (s *CreateIndexInput) SetClientToken(v string) *CreateIndexInput

SetClientToken sets the ClientToken field's value.

func (*CreateIndexInput) SetDescription 

func (s *CreateIndexInput) SetDescription(v string) *CreateIndexInput

SetDescription sets the Description field's value.

func (*CreateIndexInput) SetEdition added in v1.30.25 

func (s *CreateIndexInput) SetEdition(v string) *CreateIndexInput

SetEdition sets the Edition field's value.

func (*CreateIndexInput) SetName 

func (s *CreateIndexInput) SetName(v string) *CreateIndexInput

SetName sets the Name field's value.

func (*CreateIndexInput) SetRoleArn 

func (s *CreateIndexInput) SetRoleArn(v string) *CreateIndexInput

SetRoleArn sets the RoleArn field's value.

func (*CreateIndexInput) SetServerSideEncryptionConfiguration 

func (s *CreateIndexInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateIndexInput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*CreateIndexInput) SetTags added in v1.30.25 

func (s *CreateIndexInput) SetTags(v []*Tag) *CreateIndexInput

SetTags sets the Tags field's value.

func (*CreateIndexInput) SetUserContextPolicy added in v1.35.22 

func (s *CreateIndexInput) SetUserContextPolicy(v string) *CreateIndexInput

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*CreateIndexInput) SetUserGroupResolutionConfiguration added in v1.40.57 

func (s *CreateIndexInput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *CreateIndexInput

SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value.

func (*CreateIndexInput) SetUserTokenConfigurations added in v1.35.22 

func (s *CreateIndexInput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *CreateIndexInput

SetUserTokenConfigurations sets the UserTokenConfigurations field's value.

func (CreateIndexInput) String 

func (s CreateIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIndexInput) Validate 

func (s *CreateIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateIndexOutput 

type CreateIndexOutput struct {

	// The identifier of the index. Use this identifier when you query an index,
	// set up a data source, or index a document.
	Id *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateIndexOutput) GoString 

func (s CreateIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIndexOutput) SetId 

func (s *CreateIndexOutput) SetId(v string) *CreateIndexOutput

SetId sets the Id field's value.

func (CreateIndexOutput) String 

func (s CreateIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateQuerySuggestionsBlockListInput added in v1.38.50 

type CreateQuerySuggestionsBlockListInput struct {

	// A token that you provide to identify the request to create a query suggestions
	// block list.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description for the block list.
	//
	// For example, the description "List of all offensive words that can appear
	// in user queries and need to be blocked from suggestions."
	Description *string `type:"string"`

	// The identifier of the index you want to create a query suggestions block
	// list for.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A name for the block list.
	//
	// For example, the name 'offensive-words', which includes all offensive words
	// that could appear in user queries and need to be blocked from suggestions.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role with permission to access your
	// S3 bucket that contains the block list text file. For more information, see
	// IAM access roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The S3 path to your block list text file in your S3 bucket.
	//
	// Each block word or phrase should be on a separate line in a text file.
	//
	// For information on the current quota limits for block lists, see Quotas for
	// Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	//
	// SourceS3Path is a required field
	SourceS3Path *S3Path `type:"structure" required:"true"`

	// A list of key-value pairs that identify or categorize the block list. Tag
	// keys and values can consist of Unicode letters, digits, white space, and
	// any of the following symbols: _ . : / = + - @.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateQuerySuggestionsBlockListInput) GoString added in v1.38.50 

func (s CreateQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQuerySuggestionsBlockListInput) SetClientToken added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) SetClientToken(v string) *CreateQuerySuggestionsBlockListInput

SetClientToken sets the ClientToken field's value.

func (*CreateQuerySuggestionsBlockListInput) SetDescription added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) SetDescription(v string) *CreateQuerySuggestionsBlockListInput

SetDescription sets the Description field's value.

func (*CreateQuerySuggestionsBlockListInput) SetIndexId added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) SetIndexId(v string) *CreateQuerySuggestionsBlockListInput

SetIndexId sets the IndexId field's value.

func (*CreateQuerySuggestionsBlockListInput) SetName added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) SetName(v string) *CreateQuerySuggestionsBlockListInput

SetName sets the Name field's value.

func (*CreateQuerySuggestionsBlockListInput) SetRoleArn added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) SetRoleArn(v string) *CreateQuerySuggestionsBlockListInput

SetRoleArn sets the RoleArn field's value.

func (*CreateQuerySuggestionsBlockListInput) SetSourceS3Path added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) SetSourceS3Path(v *S3Path) *CreateQuerySuggestionsBlockListInput

SetSourceS3Path sets the SourceS3Path field's value.

func (*CreateQuerySuggestionsBlockListInput) SetTags added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) SetTags(v []*Tag) *CreateQuerySuggestionsBlockListInput

SetTags sets the Tags field's value.

func (CreateQuerySuggestionsBlockListInput) String added in v1.38.50 

func (s CreateQuerySuggestionsBlockListInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQuerySuggestionsBlockListInput) Validate added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateQuerySuggestionsBlockListOutput added in v1.38.50 

type CreateQuerySuggestionsBlockListOutput struct {

	// The identifier of the block list.
	Id *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateQuerySuggestionsBlockListOutput) GoString added in v1.38.50 

func (s CreateQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQuerySuggestionsBlockListOutput) SetId added in v1.38.50 

func (s *CreateQuerySuggestionsBlockListOutput) SetId(v string) *CreateQuerySuggestionsBlockListOutput

SetId sets the Id field's value.

func (CreateQuerySuggestionsBlockListOutput) String added in v1.38.50 

func (s CreateQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateThesaurusInput added in v1.36.6 

type CreateThesaurusInput struct {

	// A token that you provide to identify the request to create a thesaurus. Multiple
	// calls to the CreateThesaurus API with the same client token will create only
	// one thesaurus.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description for the thesaurus.
	Description *string `type:"string"`

	// The identifier of the index for the thesaurus.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A name for the thesaurus.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of an IAM role with permission to access your
	// S3 bucket that contains the thesaurus file. For more information, see IAM
	// access roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// RoleArn is a required field
	RoleArn *string `type:"string" required:"true"`

	// The path to the thesaurus file in S3.
	//
	// SourceS3Path is a required field
	SourceS3Path *S3Path `type:"structure" required:"true"`

	// A list of key-value pairs that identify or categorize the thesaurus. You
	// can also use tags to help control access to the thesaurus. Tag keys and values
	// can consist of Unicode letters, digits, white space, and any of the following
	// symbols: _ . : / = + - @.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateThesaurusInput) GoString added in v1.36.6 

func (s CreateThesaurusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThesaurusInput) SetClientToken added in v1.36.6 

func (s *CreateThesaurusInput) SetClientToken(v string) *CreateThesaurusInput

SetClientToken sets the ClientToken field's value.

func (*CreateThesaurusInput) SetDescription added in v1.36.6 

func (s *CreateThesaurusInput) SetDescription(v string) *CreateThesaurusInput

SetDescription sets the Description field's value.

func (*CreateThesaurusInput) SetIndexId added in v1.36.6 

func (s *CreateThesaurusInput) SetIndexId(v string) *CreateThesaurusInput

SetIndexId sets the IndexId field's value.

func (*CreateThesaurusInput) SetName added in v1.36.6 

func (s *CreateThesaurusInput) SetName(v string) *CreateThesaurusInput

SetName sets the Name field's value.

func (*CreateThesaurusInput) SetRoleArn added in v1.36.6 

func (s *CreateThesaurusInput) SetRoleArn(v string) *CreateThesaurusInput

SetRoleArn sets the RoleArn field's value.

func (*CreateThesaurusInput) SetSourceS3Path added in v1.36.6 

func (s *CreateThesaurusInput) SetSourceS3Path(v *S3Path) *CreateThesaurusInput

SetSourceS3Path sets the SourceS3Path field's value.

func (*CreateThesaurusInput) SetTags added in v1.36.6 

func (s *CreateThesaurusInput) SetTags(v []*Tag) *CreateThesaurusInput

SetTags sets the Tags field's value.

func (CreateThesaurusInput) String added in v1.36.6 

func (s CreateThesaurusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThesaurusInput) Validate added in v1.36.6 

func (s *CreateThesaurusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateThesaurusOutput added in v1.36.6 

type CreateThesaurusOutput struct {

	// The identifier of the thesaurus.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateThesaurusOutput) GoString added in v1.36.6 

func (s CreateThesaurusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateThesaurusOutput) SetId added in v1.36.6 

func (s *CreateThesaurusOutput) SetId(v string) *CreateThesaurusOutput

SetId sets the Id field's value.

func (CreateThesaurusOutput) String added in v1.36.6 

func (s CreateThesaurusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomDocumentEnrichmentConfiguration added in v1.42.17 

type CustomDocumentEnrichmentConfiguration struct {

	// Configuration information to alter document attributes or metadata fields
	// and content when ingesting documents into Amazon Kendra.
	InlineConfigurations []*InlineCustomDocumentEnrichmentConfiguration `type:"list"`

	// Configuration information for invoking a Lambda function in Lambda on the
	// structured documents with their metadata and text extracted. You can use
	// a Lambda function to apply advanced logic for creating, modifying, or deleting
	// document metadata and content. For more information, see Advanced data manipulation
	// (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).
	PostExtractionHookConfiguration *HookConfiguration `type:"structure"`

	// Configuration information for invoking a Lambda function in Lambda on the
	// original or raw documents before extracting their metadata and text. You
	// can use a Lambda function to apply advanced logic for creating, modifying,
	// or deleting document metadata and content. For more information, see Advanced
	// data manipulation (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).
	PreExtractionHookConfiguration *HookConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration
	// and PostExtractionHookConfiguration for altering document metadata and content
	// during the document ingestion process. For more information, see IAM roles
	// for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).

func (CustomDocumentEnrichmentConfiguration) GoString added in v1.42.17 

func (s CustomDocumentEnrichmentConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDocumentEnrichmentConfiguration) SetInlineConfigurations added in v1.42.17 

func (s *CustomDocumentEnrichmentConfiguration) SetInlineConfigurations(v []*InlineCustomDocumentEnrichmentConfiguration) *CustomDocumentEnrichmentConfiguration

SetInlineConfigurations sets the InlineConfigurations field's value.

func (*CustomDocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration added in v1.42.17 

func (s *CustomDocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration(v *HookConfiguration) *CustomDocumentEnrichmentConfiguration

SetPostExtractionHookConfiguration sets the PostExtractionHookConfiguration field's value.

func (*CustomDocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration added in v1.42.17 

func (s *CustomDocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration(v *HookConfiguration) *CustomDocumentEnrichmentConfiguration

SetPreExtractionHookConfiguration sets the PreExtractionHookConfiguration field's value.

func (*CustomDocumentEnrichmentConfiguration) SetRoleArn added in v1.42.17 

func (s *CustomDocumentEnrichmentConfiguration) SetRoleArn(v string) *CustomDocumentEnrichmentConfiguration

SetRoleArn sets the RoleArn field's value.

func (CustomDocumentEnrichmentConfiguration) String added in v1.42.17 

func (s CustomDocumentEnrichmentConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomDocumentEnrichmentConfiguration) Validate added in v1.42.17 

func (s *CustomDocumentEnrichmentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceConfiguration 

type DataSourceConfiguration struct {

	// Provides the configuration information to connect to Alfresco as your data
	// source.
	//
	// Support for AlfrescoConfiguration ended May 2023. We recommend migrating
	// to or using the Alfresco data source template schema / TemplateConfiguration
	// (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)
	// API.
	//
	// Deprecated: Deprecated AlfrescoConfiguration in favor of TemplateConfiguration
	AlfrescoConfiguration *AlfrescoConfiguration `deprecated:"true" type:"structure"`

	// Provides the configuration information to connect to Box as your data source.
	BoxConfiguration *BoxConfiguration `type:"structure"`

	// Provides the configuration information to connect to Confluence as your data
	// source.
	ConfluenceConfiguration *ConfluenceConfiguration `type:"structure"`

	// Provides the configuration information to connect to a database as your data
	// source.
	DatabaseConfiguration *DatabaseConfiguration `type:"structure"`

	// Provides the configuration information to connect to Amazon FSx as your data
	// source.
	//
	// Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
	//
	// You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)
	// object instead of the FsxConfiguration object to configure your connector.
	//
	// Connectors configured using the older console and API architecture will continue
	// to function as configured. However, you won't be able to edit or update them.
	// If you want to edit or update your connector configuration, you must create
	// a new connector.
	//
	// We recommended migrating your connector workflow to the upgraded version.
	// Support for connectors configured using the older architecture is scheduled
	// to end by June 2024.
	FsxConfiguration *FsxConfiguration `type:"structure"`

	// Provides the configuration information to connect to GitHub as your data
	// source.
	//
	// Amazon Kendra now supports an upgraded GitHub connector.
	//
	// You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)
	// object instead of the GitHubConfiguration object to configure your connector.
	//
	// Connectors configured using the older console and API architecture will continue
	// to function as configured. However, you won’t be able to edit or update
	// them. If you want to edit or update your connector configuration, you must
	// create a new connector.
	//
	// We recommended migrating your connector workflow to the upgraded version.
	// Support for connectors configured using the older architecture is scheduled
	// to end by June 2024.
	GitHubConfiguration *GitHubConfiguration `type:"structure"`

	// Provides the configuration information to connect to Google Drive as your
	// data source.
	GoogleDriveConfiguration *GoogleDriveConfiguration `type:"structure"`

	// Provides the configuration information to connect to Jira as your data source.
	JiraConfiguration *JiraConfiguration `type:"structure"`

	// Provides the configuration information to connect to Microsoft OneDrive as
	// your data source.
	OneDriveConfiguration *OneDriveConfiguration `type:"structure"`

	// Provides the configuration information to connect to Quip as your data source.
	QuipConfiguration *QuipConfiguration `type:"structure"`

	// Provides the configuration information to connect to an Amazon S3 bucket
	// as your data source.
	//
	// Amazon Kendra now supports an upgraded Amazon S3 connector.
	//
	// You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)
	// object instead of the S3DataSourceConfiguration object to configure your
	// connector.
	//
	// Connectors configured using the older console and API architecture will continue
	// to function as configured. However, you won't be able to edit or update them.
	// If you want to edit or update your connector configuration, you must create
	// a new connector.
	//
	// We recommended migrating your connector workflow to the upgraded version.
	// Support for connectors configured using the older architecture is scheduled
	// to end by June 2024.
	S3Configuration *S3DataSourceConfiguration `type:"structure"`

	// Provides the configuration information to connect to Salesforce as your data
	// source.
	SalesforceConfiguration *SalesforceConfiguration `type:"structure"`

	// Provides the configuration information to connect to ServiceNow as your data
	// source.
	ServiceNowConfiguration *ServiceNowConfiguration `type:"structure"`

	// Provides the configuration information to connect to Microsoft SharePoint
	// as your data source.
	SharePointConfiguration *SharePointConfiguration `type:"structure"`

	// Provides the configuration information to connect to Slack as your data source.
	//
	// Amazon Kendra now supports an upgraded Slack connector.
	//
	// You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html)
	// object instead of the SlackConfiguration object to configure your connector.
	//
	// Connectors configured using the older console and API architecture will continue
	// to function as configured. However, you won't be able to edit or update them.
	// If you want to edit or update your connector configuration, you must create
	// a new connector.
	//
	// We recommended migrating your connector workflow to the upgraded version.
	// Support for connectors configured using the older architecture is scheduled
	// to end by June 2024.
	SlackConfiguration *SlackConfiguration `type:"structure"`

	// Provides a template for the configuration information to connect to your
	// data source.
	TemplateConfiguration *TemplateConfiguration `type:"structure"`

	// Provides the configuration information required for Amazon Kendra Web Crawler.
	WebCrawlerConfiguration *WebCrawlerConfiguration `type:"structure"`

	// Provides the configuration information to connect to Amazon WorkDocs as your
	// data source.
	WorkDocsConfiguration *WorkDocsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for an Amazon Kendra data source.

func (DataSourceConfiguration) GoString 

func (s DataSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceConfiguration) SetAlfrescoConfiguration added in v1.44.46 

func (s *DataSourceConfiguration) SetAlfrescoConfiguration(v *AlfrescoConfiguration) *DataSourceConfiguration

SetAlfrescoConfiguration sets the AlfrescoConfiguration field's value.

func (*DataSourceConfiguration) SetBoxConfiguration added in v1.43.34 

func (s *DataSourceConfiguration) SetBoxConfiguration(v *BoxConfiguration) *DataSourceConfiguration

SetBoxConfiguration sets the BoxConfiguration field's value.

func (*DataSourceConfiguration) SetConfluenceConfiguration added in v1.35.15 

func (s *DataSourceConfiguration) SetConfluenceConfiguration(v *ConfluenceConfiguration) *DataSourceConfiguration

SetConfluenceConfiguration sets the ConfluenceConfiguration field's value.

func (*DataSourceConfiguration) SetDatabaseConfiguration 

func (s *DataSourceConfiguration) SetDatabaseConfiguration(v *DatabaseConfiguration) *DataSourceConfiguration

SetDatabaseConfiguration sets the DatabaseConfiguration field's value.

func (*DataSourceConfiguration) SetFsxConfiguration added in v1.42.49 

func (s *DataSourceConfiguration) SetFsxConfiguration(v *FsxConfiguration) *DataSourceConfiguration

SetFsxConfiguration sets the FsxConfiguration field's value.

func (*DataSourceConfiguration) SetGitHubConfiguration added in v1.44.27 

func (s *DataSourceConfiguration) SetGitHubConfiguration(v *GitHubConfiguration) *DataSourceConfiguration

SetGitHubConfiguration sets the GitHubConfiguration field's value.

func (*DataSourceConfiguration) SetGoogleDriveConfiguration added in v1.36.4 

func (s *DataSourceConfiguration) SetGoogleDriveConfiguration(v *GoogleDriveConfiguration) *DataSourceConfiguration

SetGoogleDriveConfiguration sets the GoogleDriveConfiguration field's value.

func (*DataSourceConfiguration) SetJiraConfiguration added in v1.44.13 

func (s *DataSourceConfiguration) SetJiraConfiguration(v *JiraConfiguration) *DataSourceConfiguration

SetJiraConfiguration sets the JiraConfiguration field's value.

func (*DataSourceConfiguration) SetOneDriveConfiguration added in v1.30.25 

func (s *DataSourceConfiguration) SetOneDriveConfiguration(v *OneDriveConfiguration) *DataSourceConfiguration

SetOneDriveConfiguration sets the OneDriveConfiguration field's value.

func (*DataSourceConfiguration) SetQuipConfiguration added in v1.43.42 

func (s *DataSourceConfiguration) SetQuipConfiguration(v *QuipConfiguration) *DataSourceConfiguration

SetQuipConfiguration sets the QuipConfiguration field's value.

func (*DataSourceConfiguration) SetS3Configuration 

func (s *DataSourceConfiguration) SetS3Configuration(v *S3DataSourceConfiguration) *DataSourceConfiguration

SetS3Configuration sets the S3Configuration field's value.

func (*DataSourceConfiguration) SetSalesforceConfiguration added in v1.30.25 

func (s *DataSourceConfiguration) SetSalesforceConfiguration(v *SalesforceConfiguration) *DataSourceConfiguration

SetSalesforceConfiguration sets the SalesforceConfiguration field's value.

func (*DataSourceConfiguration) SetServiceNowConfiguration added in v1.30.25 

func (s *DataSourceConfiguration) SetServiceNowConfiguration(v *ServiceNowConfiguration) *DataSourceConfiguration

SetServiceNowConfiguration sets the ServiceNowConfiguration field's value.

func (*DataSourceConfiguration) SetSharePointConfiguration 

func (s *DataSourceConfiguration) SetSharePointConfiguration(v *SharePointConfiguration) *DataSourceConfiguration

SetSharePointConfiguration sets the SharePointConfiguration field's value.

func (*DataSourceConfiguration) SetSlackConfiguration added in v1.43.18 

func (s *DataSourceConfiguration) SetSlackConfiguration(v *SlackConfiguration) *DataSourceConfiguration

SetSlackConfiguration sets the SlackConfiguration field's value.

func (*DataSourceConfiguration) SetTemplateConfiguration added in v1.44.79 

func (s *DataSourceConfiguration) SetTemplateConfiguration(v *TemplateConfiguration) *DataSourceConfiguration

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*DataSourceConfiguration) SetWebCrawlerConfiguration added in v1.38.64 

func (s *DataSourceConfiguration) SetWebCrawlerConfiguration(v *WebCrawlerConfiguration) *DataSourceConfiguration

SetWebCrawlerConfiguration sets the WebCrawlerConfiguration field's value.

func (*DataSourceConfiguration) SetWorkDocsConfiguration added in v1.40.5 

func (s *DataSourceConfiguration) SetWorkDocsConfiguration(v *WorkDocsConfiguration) *DataSourceConfiguration

SetWorkDocsConfiguration sets the WorkDocsConfiguration field's value.

func (DataSourceConfiguration) String 

func (s DataSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceConfiguration) Validate 

func (s *DataSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceGroup added in v1.39.5 

type DataSourceGroup struct {

	// The identifier of the data source group you want to add to your list of data
	// source groups. This is for filtering search results based on the groups'
	// access to documents in that data source.
	//
	// DataSourceId is a required field
	DataSourceId *string `min:"1" type:"string" required:"true"`

	// The identifier of the group you want to add to your list of groups. This
	// is for filtering search results based on the groups' access to documents.
	//
	// GroupId is a required field
	GroupId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Data source information for user context filtering.

func (DataSourceGroup) GoString added in v1.39.5 

func (s DataSourceGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceGroup) SetDataSourceId added in v1.39.5 

func (s *DataSourceGroup) SetDataSourceId(v string) *DataSourceGroup

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceGroup) SetGroupId added in v1.39.5 

func (s *DataSourceGroup) SetGroupId(v string) *DataSourceGroup

SetGroupId sets the GroupId field's value.

func (DataSourceGroup) String added in v1.39.5 

func (s DataSourceGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceGroup) Validate added in v1.39.5 

func (s *DataSourceGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceSummary 

type DataSourceSummary struct {

	// The Unix timestamp when the data source connector was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier for the data source.
	Id *string `min:"1" type:"string"`

	// The code for a language. This shows a supported language for all documents
	// in the data source. English is supported by default. For more information
	// on supported languages, including their codes, see Adding documents in languages
	// other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
	LanguageCode *string `min:"2" type:"string"`

	// The name of the data source.
	Name *string `min:"1" type:"string"`

	// The status of the data source. When the status is ACTIVE the data source
	// is ready to use.
	Status *string `type:"string" enum:"DataSourceStatus"`

	// The type of the data source.
	Type *string `type:"string" enum:"DataSourceType"`

	// The Unix timestamp when the data source connector was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Summary information for a Amazon Kendra data source.

func (DataSourceSummary) GoString 

func (s DataSourceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceSummary) SetCreatedAt 

func (s *DataSourceSummary) SetCreatedAt(v time.Time) *DataSourceSummary

SetCreatedAt sets the CreatedAt field's value.

func (*DataSourceSummary) SetId 

func (s *DataSourceSummary) SetId(v string) *DataSourceSummary

SetId sets the Id field's value.

func (*DataSourceSummary) SetLanguageCode added in v1.40.58 

func (s *DataSourceSummary) SetLanguageCode(v string) *DataSourceSummary

SetLanguageCode sets the LanguageCode field's value.

func (*DataSourceSummary) SetName 

func (s *DataSourceSummary) SetName(v string) *DataSourceSummary

SetName sets the Name field's value.

func (*DataSourceSummary) SetStatus 

func (s *DataSourceSummary) SetStatus(v string) *DataSourceSummary

SetStatus sets the Status field's value.

func (*DataSourceSummary) SetType 

func (s *DataSourceSummary) SetType(v string) *DataSourceSummary

SetType sets the Type field's value.

func (*DataSourceSummary) SetUpdatedAt 

func (s *DataSourceSummary) SetUpdatedAt(v time.Time) *DataSourceSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (DataSourceSummary) String 

func (s DataSourceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSourceSyncJob 

type DataSourceSyncJob struct {

	// If the reason that the synchronization failed is due to an error with the
	// underlying data source, this field contains a code that identifies the error.
	DataSourceErrorCode *string `min:"1" type:"string"`

	// The Unix timestamp when the synchronization job completed.
	EndTime *time.Time `type:"timestamp"`

	// If the Status field is set to FAILED, the ErrorCode field indicates the reason
	// the synchronization failed.
	ErrorCode *string `type:"string" enum:"ErrorCode"`

	// If the Status field is set to ERROR, the ErrorMessage field contains a description
	// of the error that caused the synchronization to fail.
	ErrorMessage *string `min:"1" type:"string"`

	// A identifier for the synchronization job.
	ExecutionId *string `min:"1" type:"string"`

	// Maps a batch delete document request to a specific data source sync job.
	// This is optional and should only be supplied when documents are deleted by
	// a data source connector.
	Metrics *DataSourceSyncJobMetrics `type:"structure"`

	// The Unix timestamp when the synchronization job started.
	StartTime *time.Time `type:"timestamp"`

	// The execution status of the synchronization job. When the Status field is
	// set to SUCCEEDED, the synchronization job is done. If the status code is
	// set to FAILED, the ErrorCode and ErrorMessage fields give you the reason
	// for the failure.
	Status *string `type:"string" enum:"DataSourceSyncJobStatus"`
	// contains filtered or unexported fields
}

Provides information about a data source synchronization job.

func (DataSourceSyncJob) GoString 

func (s DataSourceSyncJob) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceSyncJob) SetDataSourceErrorCode 

func (s *DataSourceSyncJob) SetDataSourceErrorCode(v string) *DataSourceSyncJob

SetDataSourceErrorCode sets the DataSourceErrorCode field's value.

func (*DataSourceSyncJob) SetEndTime 

func (s *DataSourceSyncJob) SetEndTime(v time.Time) *DataSourceSyncJob

SetEndTime sets the EndTime field's value.

func (*DataSourceSyncJob) SetErrorCode 

func (s *DataSourceSyncJob) SetErrorCode(v string) *DataSourceSyncJob

SetErrorCode sets the ErrorCode field's value.

func (*DataSourceSyncJob) SetErrorMessage 

func (s *DataSourceSyncJob) SetErrorMessage(v string) *DataSourceSyncJob

SetErrorMessage sets the ErrorMessage field's value.

func (*DataSourceSyncJob) SetExecutionId 

func (s *DataSourceSyncJob) SetExecutionId(v string) *DataSourceSyncJob

SetExecutionId sets the ExecutionId field's value.

func (*DataSourceSyncJob) SetMetrics added in v1.30.25 

func (s *DataSourceSyncJob) SetMetrics(v *DataSourceSyncJobMetrics) *DataSourceSyncJob

SetMetrics sets the Metrics field's value.

func (*DataSourceSyncJob) SetStartTime 

func (s *DataSourceSyncJob) SetStartTime(v time.Time) *DataSourceSyncJob

SetStartTime sets the StartTime field's value.

func (*DataSourceSyncJob) SetStatus 

func (s *DataSourceSyncJob) SetStatus(v string) *DataSourceSyncJob

SetStatus sets the Status field's value.

func (DataSourceSyncJob) String 

func (s DataSourceSyncJob) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSourceSyncJobMetricTarget added in v1.30.25 

type DataSourceSyncJobMetricTarget struct {

	// The ID of the data source that is running the sync job.
	//
	// DataSourceId is a required field
	DataSourceId *string `min:"1" type:"string" required:"true"`

	// The ID of the sync job that is running on the data source.
	//
	// If the ID of a sync job is not provided and there is a sync job running,
	// then the ID of this sync job is used and metrics are generated for this sync
	// job.
	//
	// If the ID of a sync job is not provided and there is no sync job running,
	// then no metrics are generated and documents are indexed/deleted at the index
	// level without sync job metrics included.
	DataSourceSyncJobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Maps a particular data source sync job to a particular data source.

func (DataSourceSyncJobMetricTarget) GoString added in v1.30.25 

func (s DataSourceSyncJobMetricTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceSyncJobMetricTarget) SetDataSourceId added in v1.30.25 

func (s *DataSourceSyncJobMetricTarget) SetDataSourceId(v string) *DataSourceSyncJobMetricTarget

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId added in v1.30.25 

func (s *DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId(v string) *DataSourceSyncJobMetricTarget

SetDataSourceSyncJobId sets the DataSourceSyncJobId field's value.

func (DataSourceSyncJobMetricTarget) String added in v1.30.25 

func (s DataSourceSyncJobMetricTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceSyncJobMetricTarget) Validate added in v1.30.25 

func (s *DataSourceSyncJobMetricTarget) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceSyncJobMetrics added in v1.30.25 

type DataSourceSyncJobMetrics struct {

	// The number of documents added from the data source up to now in the data
	// source sync.
	DocumentsAdded *string `type:"string"`

	// The number of documents deleted from the data source up to now in the data
	// source sync run.
	DocumentsDeleted *string `type:"string"`

	// The number of documents that failed to sync from the data source up to now
	// in the data source sync run.
	DocumentsFailed *string `type:"string"`

	// The number of documents modified in the data source up to now in the data
	// source sync run.
	DocumentsModified *string `type:"string"`

	// The current number of documents crawled by the current sync job in the data
	// source.
	DocumentsScanned *string `type:"string"`
	// contains filtered or unexported fields
}

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

func (DataSourceSyncJobMetrics) GoString added in v1.30.25 

func (s DataSourceSyncJobMetrics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceSyncJobMetrics) SetDocumentsAdded added in v1.30.25 

func (s *DataSourceSyncJobMetrics) SetDocumentsAdded(v string) *DataSourceSyncJobMetrics

SetDocumentsAdded sets the DocumentsAdded field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsDeleted added in v1.30.25 

func (s *DataSourceSyncJobMetrics) SetDocumentsDeleted(v string) *DataSourceSyncJobMetrics

SetDocumentsDeleted sets the DocumentsDeleted field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsFailed added in v1.30.25 

func (s *DataSourceSyncJobMetrics) SetDocumentsFailed(v string) *DataSourceSyncJobMetrics

SetDocumentsFailed sets the DocumentsFailed field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsModified added in v1.30.25 

func (s *DataSourceSyncJobMetrics) SetDocumentsModified(v string) *DataSourceSyncJobMetrics

SetDocumentsModified sets the DocumentsModified field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsScanned added in v1.30.25 

func (s *DataSourceSyncJobMetrics) SetDocumentsScanned(v string) *DataSourceSyncJobMetrics

SetDocumentsScanned sets the DocumentsScanned field's value.

func (DataSourceSyncJobMetrics) String added in v1.30.25 

func (s DataSourceSyncJobMetrics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSourceToIndexFieldMapping 

type DataSourceToIndexFieldMapping struct {

	// The name of the field in the data source. You must first create the index
	// field using the UpdateIndex API.
	//
	// DataSourceFieldName is a required field
	DataSourceFieldName *string `min:"1" type:"string" required:"true"`

	// The format for date fields in the data source. If the field specified in
	// DataSourceFieldName is a date field, you must specify the date format. If
	// the field is not a date field, an exception is thrown.
	DateFieldFormat *string `min:"4" type:"string"`

	// The name of the index field to map to the data source field. The index field
	// type must match the data source field type.
	//
	// IndexFieldName is a required field
	IndexFieldName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Maps attributes or field names of the documents synced from the data source to Amazon Kendra index field names. You can set up field mappings for each data source when calling CreateDataSource (https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) or UpdateDataSource (https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html) API. To create custom fields, use the UpdateIndex API to first create an index field and then map to the data source field. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).

func (DataSourceToIndexFieldMapping) GoString 

func (s DataSourceToIndexFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceToIndexFieldMapping) SetDataSourceFieldName 

func (s *DataSourceToIndexFieldMapping) SetDataSourceFieldName(v string) *DataSourceToIndexFieldMapping

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*DataSourceToIndexFieldMapping) SetDateFieldFormat 

func (s *DataSourceToIndexFieldMapping) SetDateFieldFormat(v string) *DataSourceToIndexFieldMapping

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*DataSourceToIndexFieldMapping) SetIndexFieldName 

func (s *DataSourceToIndexFieldMapping) SetIndexFieldName(v string) *DataSourceToIndexFieldMapping

SetIndexFieldName sets the IndexFieldName field's value.

func (DataSourceToIndexFieldMapping) String 

func (s DataSourceToIndexFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceToIndexFieldMapping) Validate 

func (s *DataSourceToIndexFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceVpcConfiguration 

type DataSourceVpcConfiguration struct {

	// A list of identifiers of security groups within your Amazon VPC. The security
	// groups should enable Amazon Kendra to connect to the data source.
	//
	// SecurityGroupIds is a required field
	SecurityGroupIds []*string `min:"1" type:"list" required:"true"`

	// A list of identifiers for subnets within your Amazon VPC. The subnets should
	// be able to connect to each other in the VPC, and they should have outgoing
	// access to the Internet through a NAT device.
	//
	// SubnetIds is a required field
	SubnetIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to an Amazon VPC.

func (DataSourceVpcConfiguration) GoString 

func (s DataSourceVpcConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceVpcConfiguration) SetSecurityGroupIds 

func (s *DataSourceVpcConfiguration) SetSecurityGroupIds(v []*string) *DataSourceVpcConfiguration

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*DataSourceVpcConfiguration) SetSubnetIds 

func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcConfiguration

SetSubnetIds sets the SubnetIds field's value.

func (DataSourceVpcConfiguration) String 

func (s DataSourceVpcConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceVpcConfiguration) Validate 

func (s *DataSourceVpcConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatabaseConfiguration 

type DatabaseConfiguration struct {

	// Information about the database column that provides information for user
	// context filtering.
	AclConfiguration *AclConfiguration `type:"structure"`

	// Information about where the index should get the document information from
	// the database.
	//
	// ColumnConfiguration is a required field
	ColumnConfiguration *ColumnConfiguration `type:"structure" required:"true"`

	// Configuration information that's required to connect to a database.
	//
	// ConnectionConfiguration is a required field
	ConnectionConfiguration *ConnectionConfiguration `type:"structure" required:"true"`

	// The type of database engine that runs the database.
	//
	// DatabaseEngineType is a required field
	DatabaseEngineType *string `type:"string" required:"true" enum:"DatabaseEngineType"`

	// Provides information about how Amazon Kendra uses quote marks around SQL
	// identifiers when querying a database data source.
	SqlConfiguration *SqlConfiguration `type:"structure"`

	// Provides the configuration information to connect to an Amazon VPC.
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information to an Amazon Kendra supported database (https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html).

func (DatabaseConfiguration) GoString 

func (s DatabaseConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatabaseConfiguration) SetAclConfiguration 

func (s *DatabaseConfiguration) SetAclConfiguration(v *AclConfiguration) *DatabaseConfiguration

SetAclConfiguration sets the AclConfiguration field's value.

func (*DatabaseConfiguration) SetColumnConfiguration 

func (s *DatabaseConfiguration) SetColumnConfiguration(v *ColumnConfiguration) *DatabaseConfiguration

SetColumnConfiguration sets the ColumnConfiguration field's value.

func (*DatabaseConfiguration) SetConnectionConfiguration 

func (s *DatabaseConfiguration) SetConnectionConfiguration(v *ConnectionConfiguration) *DatabaseConfiguration

SetConnectionConfiguration sets the ConnectionConfiguration field's value.

func (*DatabaseConfiguration) SetDatabaseEngineType 

func (s *DatabaseConfiguration) SetDatabaseEngineType(v string) *DatabaseConfiguration

SetDatabaseEngineType sets the DatabaseEngineType field's value.

func (*DatabaseConfiguration) SetSqlConfiguration added in v1.33.12 

func (s *DatabaseConfiguration) SetSqlConfiguration(v *SqlConfiguration) *DatabaseConfiguration

SetSqlConfiguration sets the SqlConfiguration field's value.

func (*DatabaseConfiguration) SetVpcConfiguration 

func (s *DatabaseConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *DatabaseConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (DatabaseConfiguration) String 

func (s DatabaseConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatabaseConfiguration) Validate 

func (s *DatabaseConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessControlConfigurationInput added in v1.44.55 

type DeleteAccessControlConfigurationInput struct {

	// The identifier of the access control configuration you want to delete.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for an access control configuration.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccessControlConfigurationInput) GoString added in v1.44.55 

func (s DeleteAccessControlConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessControlConfigurationInput) SetId added in v1.44.55 

func (s *DeleteAccessControlConfigurationInput) SetId(v string) *DeleteAccessControlConfigurationInput

SetId sets the Id field's value.

func (*DeleteAccessControlConfigurationInput) SetIndexId added in v1.44.55 

func (s *DeleteAccessControlConfigurationInput) SetIndexId(v string) *DeleteAccessControlConfigurationInput

SetIndexId sets the IndexId field's value.

func (DeleteAccessControlConfigurationInput) String added in v1.44.55 

func (s DeleteAccessControlConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessControlConfigurationInput) Validate added in v1.44.55 

func (s *DeleteAccessControlConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessControlConfigurationOutput added in v1.44.55 

type DeleteAccessControlConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAccessControlConfigurationOutput) GoString added in v1.44.55 

func (s DeleteAccessControlConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAccessControlConfigurationOutput) String added in v1.44.55 

func (s DeleteAccessControlConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDataSourceInput added in v1.30.25 

type DeleteDataSourceInput struct {

	// The identifier of the data source connector you want to delete.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDataSourceInput) GoString added in v1.30.25 

func (s DeleteDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceInput) SetId added in v1.30.25 

func (s *DeleteDataSourceInput) SetId(v string) *DeleteDataSourceInput

SetId sets the Id field's value.

func (*DeleteDataSourceInput) SetIndexId added in v1.30.25 

func (s *DeleteDataSourceInput) SetIndexId(v string) *DeleteDataSourceInput

SetIndexId sets the IndexId field's value.

func (DeleteDataSourceInput) String added in v1.30.25 

func (s DeleteDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceInput) Validate added in v1.30.25 

func (s *DeleteDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDataSourceOutput added in v1.30.25 

type DeleteDataSourceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDataSourceOutput) GoString added in v1.30.25 

func (s DeleteDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDataSourceOutput) String added in v1.30.25 

func (s DeleteDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteExperienceInput added in v1.42.17 

type DeleteExperienceInput struct {

	// The identifier of your Amazon Kendra experience you want to delete.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteExperienceInput) GoString added in v1.42.17 

func (s DeleteExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteExperienceInput) SetId added in v1.42.17 

func (s *DeleteExperienceInput) SetId(v string) *DeleteExperienceInput

SetId sets the Id field's value.

func (*DeleteExperienceInput) SetIndexId added in v1.42.17 

func (s *DeleteExperienceInput) SetIndexId(v string) *DeleteExperienceInput

SetIndexId sets the IndexId field's value.

func (DeleteExperienceInput) String added in v1.42.17 

func (s DeleteExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteExperienceInput) Validate added in v1.42.17 

func (s *DeleteExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteExperienceOutput added in v1.42.17 

type DeleteExperienceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteExperienceOutput) GoString added in v1.42.17 

func (s DeleteExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteExperienceOutput) String added in v1.42.17 

func (s DeleteExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFaqInput 

type DeleteFaqInput struct {

	// The identifier of the FAQ you want to remove.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for the FAQ.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFaqInput) GoString 

func (s DeleteFaqInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFaqInput) SetId 

func (s *DeleteFaqInput) SetId(v string) *DeleteFaqInput

SetId sets the Id field's value.

func (*DeleteFaqInput) SetIndexId 

func (s *DeleteFaqInput) SetIndexId(v string) *DeleteFaqInput

SetIndexId sets the IndexId field's value.

func (DeleteFaqInput) String 

func (s DeleteFaqInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFaqInput) Validate 

func (s *DeleteFaqInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFaqOutput 

type DeleteFaqOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFaqOutput) GoString 

func (s DeleteFaqOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFaqOutput) String 

func (s DeleteFaqOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteIndexInput 

type DeleteIndexInput struct {

	// The identifier of the index you want to delete.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteIndexInput) GoString 

func (s DeleteIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIndexInput) SetId 

func (s *DeleteIndexInput) SetId(v string) *DeleteIndexInput

SetId sets the Id field's value.

func (DeleteIndexInput) String 

func (s DeleteIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIndexInput) Validate 

func (s *DeleteIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteIndexOutput 

type DeleteIndexOutput struct {
	// contains filtered or unexported fields
}

func (DeleteIndexOutput) GoString 

func (s DeleteIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteIndexOutput) String 

func (s DeleteIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePrincipalMappingInput added in v1.39.5 

type DeletePrincipalMappingInput struct {

	// The identifier of the data source you want to delete a group from.
	//
	// A group can be tied to multiple data sources. You can delete a group from
	// accessing documents in a certain data source. For example, the groups "Research",
	// "Engineering", and "Sales and Marketing" are all tied to the company's documents
	// stored in the data sources Confluence and Salesforce. You want to delete
	// "Research" and "Engineering" groups from Salesforce, so that these groups
	// cannot access customer-related documents stored in Salesforce. Only "Sales
	// and Marketing" should access documents in the Salesforce data source.
	DataSourceId *string `min:"1" type:"string"`

	// The identifier of the group you want to delete.
	//
	// GroupId is a required field
	GroupId *string `min:"1" type:"string" required:"true"`

	// The identifier of the index you want to delete a group from.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The timestamp identifier you specify to ensure Amazon Kendra does not override
	// the latest DELETE action with previous actions. The highest number ID, which
	// is the ordering ID, is the latest action you want to process and apply on
	// top of other actions with lower number IDs. This prevents previous actions
	// with lower number IDs from possibly overriding the latest action.
	//
	// The ordering ID can be the Unix time of the last update you made to a group
	// members list. You would then provide this list when calling PutPrincipalMapping.
	// This ensures your DELETE action for that updated group with the latest members
	// list doesn't get overwritten by earlier DELETE actions for the same group
	// which are yet to be processed.
	//
	// The default ordering ID is the current Unix time in milliseconds that the
	// action was received by Amazon Kendra.
	OrderingId *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (DeletePrincipalMappingInput) GoString added in v1.39.5 

func (s DeletePrincipalMappingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePrincipalMappingInput) SetDataSourceId added in v1.39.5 

func (s *DeletePrincipalMappingInput) SetDataSourceId(v string) *DeletePrincipalMappingInput

SetDataSourceId sets the DataSourceId field's value.

func (*DeletePrincipalMappingInput) SetGroupId added in v1.39.5 

func (s *DeletePrincipalMappingInput) SetGroupId(v string) *DeletePrincipalMappingInput

SetGroupId sets the GroupId field's value.

func (*DeletePrincipalMappingInput) SetIndexId added in v1.39.5 

func (s *DeletePrincipalMappingInput) SetIndexId(v string) *DeletePrincipalMappingInput

SetIndexId sets the IndexId field's value.

func (*DeletePrincipalMappingInput) SetOrderingId added in v1.39.5 

func (s *DeletePrincipalMappingInput) SetOrderingId(v int64) *DeletePrincipalMappingInput

SetOrderingId sets the OrderingId field's value.

func (DeletePrincipalMappingInput) String added in v1.39.5 

func (s DeletePrincipalMappingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePrincipalMappingInput) Validate added in v1.39.5 

func (s *DeletePrincipalMappingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePrincipalMappingOutput added in v1.39.5 

type DeletePrincipalMappingOutput struct {
	// contains filtered or unexported fields
}

func (DeletePrincipalMappingOutput) GoString added in v1.39.5 

func (s DeletePrincipalMappingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePrincipalMappingOutput) String added in v1.39.5 

func (s DeletePrincipalMappingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteQuerySuggestionsBlockListInput added in v1.38.50 

type DeleteQuerySuggestionsBlockListInput struct {

	// The identifier of the block list you want to delete.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`

	// The identifier of the index for the block list.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteQuerySuggestionsBlockListInput) GoString added in v1.38.50 

func (s DeleteQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQuerySuggestionsBlockListInput) SetId added in v1.38.50 

func (s *DeleteQuerySuggestionsBlockListInput) SetId(v string) *DeleteQuerySuggestionsBlockListInput

SetId sets the Id field's value.

func (*DeleteQuerySuggestionsBlockListInput) SetIndexId added in v1.38.50 

func (s *DeleteQuerySuggestionsBlockListInput) SetIndexId(v string) *DeleteQuerySuggestionsBlockListInput

SetIndexId sets the IndexId field's value.

func (DeleteQuerySuggestionsBlockListInput) String added in v1.38.50 

func (s DeleteQuerySuggestionsBlockListInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQuerySuggestionsBlockListInput) Validate added in v1.38.50 

func (s *DeleteQuerySuggestionsBlockListInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteQuerySuggestionsBlockListOutput added in v1.38.50 

type DeleteQuerySuggestionsBlockListOutput struct {
	// contains filtered or unexported fields
}

func (DeleteQuerySuggestionsBlockListOutput) GoString added in v1.38.50 

func (s DeleteQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteQuerySuggestionsBlockListOutput) String added in v1.38.50 

func (s DeleteQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteThesaurusInput added in v1.36.6 

type DeleteThesaurusInput struct {

	// The identifier of the thesaurus you want to delete.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for the thesaurus.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteThesaurusInput) GoString added in v1.36.6 

func (s DeleteThesaurusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThesaurusInput) SetId added in v1.36.6 

func (s *DeleteThesaurusInput) SetId(v string) *DeleteThesaurusInput

SetId sets the Id field's value.

func (*DeleteThesaurusInput) SetIndexId added in v1.36.6 

func (s *DeleteThesaurusInput) SetIndexId(v string) *DeleteThesaurusInput

SetIndexId sets the IndexId field's value.

func (DeleteThesaurusInput) String added in v1.36.6 

func (s DeleteThesaurusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThesaurusInput) Validate added in v1.36.6 

func (s *DeleteThesaurusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteThesaurusOutput added in v1.36.6 

type DeleteThesaurusOutput struct {
	// contains filtered or unexported fields
}

func (DeleteThesaurusOutput) GoString added in v1.36.6 

func (s DeleteThesaurusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteThesaurusOutput) String added in v1.36.6 

func (s DeleteThesaurusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccessControlConfigurationInput added in v1.44.55 

type DescribeAccessControlConfigurationInput struct {

	// The identifier of the access control configuration you want to get information
	// on.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for an access control configuration.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAccessControlConfigurationInput) GoString added in v1.44.55 

func (s DescribeAccessControlConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessControlConfigurationInput) SetId added in v1.44.55 

func (s *DescribeAccessControlConfigurationInput) SetId(v string) *DescribeAccessControlConfigurationInput

SetId sets the Id field's value.

func (*DescribeAccessControlConfigurationInput) SetIndexId added in v1.44.55 

func (s *DescribeAccessControlConfigurationInput) SetIndexId(v string) *DescribeAccessControlConfigurationInput

SetIndexId sets the IndexId field's value.

func (DescribeAccessControlConfigurationInput) String added in v1.44.55 

func (s DescribeAccessControlConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessControlConfigurationInput) Validate added in v1.44.55 

func (s *DescribeAccessControlConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccessControlConfigurationOutput added in v1.44.55 

type DescribeAccessControlConfigurationOutput struct {

	// Information on principals (users and/or groups) and which documents they
	// should have access to. This is useful for user context filtering, where search
	// results are filtered based on the user or their group access to documents.
	AccessControlList []*Principal `type:"list"`

	// The description for the access control configuration.
	Description *string `type:"string"`

	// The error message containing details if there are issues processing the access
	// control configuration.
	ErrorMessage *string `min:"1" type:"string"`

	// The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html)
	// lists that define the hierarchy for which documents users should have access
	// to.
	HierarchicalAccessControlList []*HierarchicalPrincipal `min:"1" type:"list"`

	// The name for the access control configuration.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAccessControlConfigurationOutput) GoString added in v1.44.55 

func (s DescribeAccessControlConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessControlConfigurationOutput) SetAccessControlList added in v1.44.55 

func (s *DescribeAccessControlConfigurationOutput) SetAccessControlList(v []*Principal) *DescribeAccessControlConfigurationOutput

SetAccessControlList sets the AccessControlList field's value.

func (*DescribeAccessControlConfigurationOutput) SetDescription added in v1.44.55 

func (s *DescribeAccessControlConfigurationOutput) SetDescription(v string) *DescribeAccessControlConfigurationOutput

SetDescription sets the Description field's value.

func (*DescribeAccessControlConfigurationOutput) SetErrorMessage added in v1.44.55 

func (s *DescribeAccessControlConfigurationOutput) SetErrorMessage(v string) *DescribeAccessControlConfigurationOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeAccessControlConfigurationOutput) SetHierarchicalAccessControlList added in v1.44.55 

func (s *DescribeAccessControlConfigurationOutput) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *DescribeAccessControlConfigurationOutput

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*DescribeAccessControlConfigurationOutput) SetName added in v1.44.55 

func (s *DescribeAccessControlConfigurationOutput) SetName(v string) *DescribeAccessControlConfigurationOutput

SetName sets the Name field's value.

func (DescribeAccessControlConfigurationOutput) String added in v1.44.55 

func (s DescribeAccessControlConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDataSourceInput 

type DescribeDataSourceInput struct {

	// The identifier of the data source connector.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDataSourceInput) GoString 

func (s DescribeDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataSourceInput) SetId 

func (s *DescribeDataSourceInput) SetId(v string) *DescribeDataSourceInput

SetId sets the Id field's value.

func (*DescribeDataSourceInput) SetIndexId 

func (s *DescribeDataSourceInput) SetIndexId(v string) *DescribeDataSourceInput

SetIndexId sets the IndexId field's value.

func (DescribeDataSourceInput) String 

func (s DescribeDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataSourceInput) Validate 

func (s *DescribeDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDataSourceOutput 

type DescribeDataSourceOutput struct {

	// Configuration details for the data source connector. This shows how the data
	// source is configured. The configuration options for a data source depend
	// on the data source provider.
	Configuration *DataSourceConfiguration `type:"structure"`

	// The Unix timestamp when the data source connector was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Configuration information for altering document metadata and content during
	// the document ingestion process when you describe a data source.
	//
	// For more information on how to create, modify and delete document metadata,
	// or make other content alterations when you ingest documents into Amazon Kendra,
	// see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
	CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"`

	// The description for the data source connector.
	Description *string `type:"string"`

	// When the Status field value is FAILED, the ErrorMessage field contains a
	// description of the error that caused the data source to fail.
	ErrorMessage *string `min:"1" type:"string"`

	// The identifier of the data source connector.
	Id *string `min:"1" type:"string"`

	// The identifier of the index used with the data source connector.
	IndexId *string `min:"36" type:"string"`

	// The code for a language. This shows a supported language for all documents
	// in the data source. English is supported by default. For more information
	// on supported languages, including their codes, see Adding documents in languages
	// other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
	LanguageCode *string `min:"2" type:"string"`

	// The name for the data source connector.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the role with permission to access the
	// data source and required resources.
	RoleArn *string `type:"string"`

	// The schedule for Amazon Kendra to update the index.
	Schedule *string `type:"string"`

	// The current status of the data source connector. When the status is ACTIVE
	// the data source is ready to use. When the status is FAILED, the ErrorMessage
	// field contains the reason that the data source failed.
	Status *string `type:"string" enum:"DataSourceStatus"`

	// The type of the data source. For example, SHAREPOINT.
	Type *string `type:"string" enum:"DataSourceType"`

	// The Unix timestamp when the data source connector was last updated.
	UpdatedAt *time.Time `type:"timestamp"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDataSourceOutput) GoString 

func (s DescribeDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataSourceOutput) SetConfiguration 

func (s *DescribeDataSourceOutput) SetConfiguration(v *DataSourceConfiguration) *DescribeDataSourceOutput

SetConfiguration sets the Configuration field's value.

func (*DescribeDataSourceOutput) SetCreatedAt 

func (s *DescribeDataSourceOutput) SetCreatedAt(v time.Time) *DescribeDataSourceOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeDataSourceOutput) SetCustomDocumentEnrichmentConfiguration added in v1.42.17 

func (s *DescribeDataSourceOutput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *DescribeDataSourceOutput

SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value.

func (*DescribeDataSourceOutput) SetDescription 

func (s *DescribeDataSourceOutput) SetDescription(v string) *DescribeDataSourceOutput

SetDescription sets the Description field's value.

func (*DescribeDataSourceOutput) SetErrorMessage 

func (s *DescribeDataSourceOutput) SetErrorMessage(v string) *DescribeDataSourceOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeDataSourceOutput) SetId 

func (s *DescribeDataSourceOutput) SetId(v string) *DescribeDataSourceOutput

SetId sets the Id field's value.

func (*DescribeDataSourceOutput) SetIndexId 

func (s *DescribeDataSourceOutput) SetIndexId(v string) *DescribeDataSourceOutput

SetIndexId sets the IndexId field's value.

func (*DescribeDataSourceOutput) SetLanguageCode added in v1.40.58 

func (s *DescribeDataSourceOutput) SetLanguageCode(v string) *DescribeDataSourceOutput

SetLanguageCode sets the LanguageCode field's value.

func (*DescribeDataSourceOutput) SetName 

func (s *DescribeDataSourceOutput) SetName(v string) *DescribeDataSourceOutput

SetName sets the Name field's value.

func (*DescribeDataSourceOutput) SetRoleArn 

func (s *DescribeDataSourceOutput) SetRoleArn(v string) *DescribeDataSourceOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeDataSourceOutput) SetSchedule 

func (s *DescribeDataSourceOutput) SetSchedule(v string) *DescribeDataSourceOutput

SetSchedule sets the Schedule field's value.

func (*DescribeDataSourceOutput) SetStatus 

func (s *DescribeDataSourceOutput) SetStatus(v string) *DescribeDataSourceOutput

SetStatus sets the Status field's value.

func (*DescribeDataSourceOutput) SetType 

func (s *DescribeDataSourceOutput) SetType(v string) *DescribeDataSourceOutput

SetType sets the Type field's value.

func (*DescribeDataSourceOutput) SetUpdatedAt 

func (s *DescribeDataSourceOutput) SetUpdatedAt(v time.Time) *DescribeDataSourceOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (*DescribeDataSourceOutput) SetVpcConfiguration added in v1.44.79 

func (s *DescribeDataSourceOutput) SetVpcConfiguration(v *DataSourceVpcConfiguration) *DescribeDataSourceOutput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (DescribeDataSourceOutput) String 

func (s DescribeDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExperienceInput added in v1.42.17 

type DescribeExperienceInput struct {

	// The identifier of your Amazon Kendra experience you want to get information
	// on.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeExperienceInput) GoString added in v1.42.17 

func (s DescribeExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExperienceInput) SetId added in v1.42.17 

func (s *DescribeExperienceInput) SetId(v string) *DescribeExperienceInput

SetId sets the Id field's value.

func (*DescribeExperienceInput) SetIndexId added in v1.42.17 

func (s *DescribeExperienceInput) SetIndexId(v string) *DescribeExperienceInput

SetIndexId sets the IndexId field's value.

func (DescribeExperienceInput) String added in v1.42.17 

func (s DescribeExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExperienceInput) Validate added in v1.42.17 

func (s *DescribeExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeExperienceOutput added in v1.42.17 

type DescribeExperienceOutput struct {

	// Shows the configuration information for your Amazon Kendra experience. This
	// includes ContentSourceConfiguration, which specifies the data source IDs
	// and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or
	// group information to grant access to your Amazon Kendra experience.
	Configuration *ExperienceConfiguration `type:"structure"`

	// The Unix timestamp when your Amazon Kendra experience was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Shows the description for your Amazon Kendra experience.
	Description *string `type:"string"`

	// Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are
	// unique and fully hosted by Amazon Web Services.
	Endpoints []*ExperienceEndpoint `min:"1" type:"list"`

	// The reason your Amazon Kendra experience could not properly process.
	ErrorMessage *string `min:"1" type:"string"`

	// Shows the identifier of your Amazon Kendra experience.
	Id *string `min:"1" type:"string"`

	// Shows the identifier of the index for your Amazon Kendra experience.
	IndexId *string `min:"36" type:"string"`

	// Shows the name of your Amazon Kendra experience.
	Name *string `min:"1" type:"string"`

	// Shows the Amazon Resource Name (ARN) of a role with permission to access
	// Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center
	// that stores your user and group information.
	RoleArn *string `type:"string"`

	// The current processing status of your Amazon Kendra experience. When the
	// status is ACTIVE, your Amazon Kendra experience is ready to use. When the
	// status is FAILED, the ErrorMessage field contains the reason that this failed.
	Status *string `type:"string" enum:"ExperienceStatus"`

	// The Unix timestamp when your Amazon Kendra experience was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeExperienceOutput) GoString added in v1.42.17 

func (s DescribeExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExperienceOutput) SetConfiguration added in v1.42.17 

func (s *DescribeExperienceOutput) SetConfiguration(v *ExperienceConfiguration) *DescribeExperienceOutput

SetConfiguration sets the Configuration field's value.

func (*DescribeExperienceOutput) SetCreatedAt added in v1.42.17 

func (s *DescribeExperienceOutput) SetCreatedAt(v time.Time) *DescribeExperienceOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeExperienceOutput) SetDescription added in v1.42.17 

func (s *DescribeExperienceOutput) SetDescription(v string) *DescribeExperienceOutput

SetDescription sets the Description field's value.

func (*DescribeExperienceOutput) SetEndpoints added in v1.42.17 

func (s *DescribeExperienceOutput) SetEndpoints(v []*ExperienceEndpoint) *DescribeExperienceOutput

SetEndpoints sets the Endpoints field's value.

func (*DescribeExperienceOutput) SetErrorMessage added in v1.42.17 

func (s *DescribeExperienceOutput) SetErrorMessage(v string) *DescribeExperienceOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeExperienceOutput) SetId added in v1.42.17 

func (s *DescribeExperienceOutput) SetId(v string) *DescribeExperienceOutput

SetId sets the Id field's value.

func (*DescribeExperienceOutput) SetIndexId added in v1.42.17 

func (s *DescribeExperienceOutput) SetIndexId(v string) *DescribeExperienceOutput

SetIndexId sets the IndexId field's value.

func (*DescribeExperienceOutput) SetName added in v1.42.17 

func (s *DescribeExperienceOutput) SetName(v string) *DescribeExperienceOutput

SetName sets the Name field's value.

func (*DescribeExperienceOutput) SetRoleArn added in v1.42.17 

func (s *DescribeExperienceOutput) SetRoleArn(v string) *DescribeExperienceOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeExperienceOutput) SetStatus added in v1.42.17 

func (s *DescribeExperienceOutput) SetStatus(v string) *DescribeExperienceOutput

SetStatus sets the Status field's value.

func (*DescribeExperienceOutput) SetUpdatedAt added in v1.42.17 

func (s *DescribeExperienceOutput) SetUpdatedAt(v time.Time) *DescribeExperienceOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeExperienceOutput) String added in v1.42.17 

func (s DescribeExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFaqInput 

type DescribeFaqInput struct {

	// The identifier of the FAQ you want to get information on.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for the FAQ.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFaqInput) GoString 

func (s DescribeFaqInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFaqInput) SetId 

func (s *DescribeFaqInput) SetId(v string) *DescribeFaqInput

SetId sets the Id field's value.

func (*DescribeFaqInput) SetIndexId 

func (s *DescribeFaqInput) SetIndexId(v string) *DescribeFaqInput

SetIndexId sets the IndexId field's value.

func (DescribeFaqInput) String 

func (s DescribeFaqInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFaqInput) Validate 

func (s *DescribeFaqInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFaqOutput 

type DescribeFaqOutput struct {

	// The Unix timestamp when the FAQ was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The description of the FAQ that you provided when it was created.
	Description *string `type:"string"`

	// If the Status field is FAILED, the ErrorMessage field contains the reason
	// why the FAQ failed.
	ErrorMessage *string `min:"1" type:"string"`

	// The file format used by the input files for the FAQ.
	FileFormat *string `type:"string" enum:"FaqFileFormat"`

	// The identifier of the FAQ.
	Id *string `min:"1" type:"string"`

	// The identifier of the index for the FAQ.
	IndexId *string `min:"36" type:"string"`

	// The code for a language. This shows a supported language for the FAQ document.
	// English is supported by default. For more information on supported languages,
	// including their codes, see Adding documents in languages other than English
	// (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
	LanguageCode *string `min:"2" type:"string"`

	// The name that you gave the FAQ when it was created.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the role that provides access to the S3
	// bucket containing the input files for the FAQ.
	RoleArn *string `type:"string"`

	// Information required to find a specific file in an Amazon S3 bucket.
	S3Path *S3Path `type:"structure"`

	// The status of the FAQ. It is ready to use when the status is ACTIVE.
	Status *string `type:"string" enum:"FaqStatus"`

	// The Unix timestamp when the FAQ was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeFaqOutput) GoString 

func (s DescribeFaqOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFaqOutput) SetCreatedAt 

func (s *DescribeFaqOutput) SetCreatedAt(v time.Time) *DescribeFaqOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeFaqOutput) SetDescription 

func (s *DescribeFaqOutput) SetDescription(v string) *DescribeFaqOutput

SetDescription sets the Description field's value.

func (*DescribeFaqOutput) SetErrorMessage 

func (s *DescribeFaqOutput) SetErrorMessage(v string) *DescribeFaqOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeFaqOutput) SetFileFormat added in v1.34.26 

func (s *DescribeFaqOutput) SetFileFormat(v string) *DescribeFaqOutput

SetFileFormat sets the FileFormat field's value.

func (*DescribeFaqOutput) SetId 

func (s *DescribeFaqOutput) SetId(v string) *DescribeFaqOutput

SetId sets the Id field's value.

func (*DescribeFaqOutput) SetIndexId 

func (s *DescribeFaqOutput) SetIndexId(v string) *DescribeFaqOutput

SetIndexId sets the IndexId field's value.

func (*DescribeFaqOutput) SetLanguageCode added in v1.40.58 

func (s *DescribeFaqOutput) SetLanguageCode(v string) *DescribeFaqOutput

SetLanguageCode sets the LanguageCode field's value.

func (*DescribeFaqOutput) SetName 

func (s *DescribeFaqOutput) SetName(v string) *DescribeFaqOutput

SetName sets the Name field's value.

func (*DescribeFaqOutput) SetRoleArn 

func (s *DescribeFaqOutput) SetRoleArn(v string) *DescribeFaqOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeFaqOutput) SetS3Path 

func (s *DescribeFaqOutput) SetS3Path(v *S3Path) *DescribeFaqOutput

SetS3Path sets the S3Path field's value.

func (*DescribeFaqOutput) SetStatus 

func (s *DescribeFaqOutput) SetStatus(v string) *DescribeFaqOutput

SetStatus sets the Status field's value.

func (*DescribeFaqOutput) SetUpdatedAt 

func (s *DescribeFaqOutput) SetUpdatedAt(v time.Time) *DescribeFaqOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeFaqOutput) String 

func (s DescribeFaqOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFeaturedResultsSetInput added in v1.44.233 

type DescribeFeaturedResultsSetInput struct {

	// The identifier of the set of featured results that you want to get information
	// on.
	//
	// FeaturedResultsSetId is a required field
	FeaturedResultsSetId *string `min:"36" type:"string" required:"true"`

	// The identifier of the index used for featuring results.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFeaturedResultsSetInput) GoString added in v1.44.233 

func (s DescribeFeaturedResultsSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFeaturedResultsSetInput) SetFeaturedResultsSetId added in v1.44.233 

func (s *DescribeFeaturedResultsSetInput) SetFeaturedResultsSetId(v string) *DescribeFeaturedResultsSetInput

SetFeaturedResultsSetId sets the FeaturedResultsSetId field's value.

func (*DescribeFeaturedResultsSetInput) SetIndexId added in v1.44.233 

func (s *DescribeFeaturedResultsSetInput) SetIndexId(v string) *DescribeFeaturedResultsSetInput

SetIndexId sets the IndexId field's value.

func (DescribeFeaturedResultsSetInput) String added in v1.44.233 

func (s DescribeFeaturedResultsSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFeaturedResultsSetInput) Validate added in v1.44.233 

func (s *DescribeFeaturedResultsSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFeaturedResultsSetOutput added in v1.44.233 

type DescribeFeaturedResultsSetOutput struct {

	// The Unix timestamp when the set of the featured results was created.
	CreationTimestamp *int64 `type:"long"`

	// The description for the set of featured results.
	Description *string `type:"string"`

	// The list of document IDs that don't exist but you have specified as featured
	// documents. Amazon Kendra cannot feature these documents if they don't exist
	// in the index. You can check the status of a document and its ID or check
	// for documents with status errors using the BatchGetDocumentStatus (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html)
	// API.
	FeaturedDocumentsMissing []*FeaturedDocumentMissing `type:"list"`

	// The list of document IDs for the documents you want to feature with their
	// metadata information. For more information on the list of featured documents,
	// see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
	FeaturedDocumentsWithMetadata []*FeaturedDocumentWithMetadata `type:"list"`

	// The identifier of the set of featured results.
	FeaturedResultsSetId *string `min:"36" type:"string"`

	// The name for the set of featured results.
	FeaturedResultsSetName *string `min:"1" type:"string"`

	// The timestamp when the set of featured results was last updated.
	LastUpdatedTimestamp *int64 `type:"long"`

	// The list of queries for featuring results. For more information on the list
	// of queries, see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
	QueryTexts []*string `type:"list"`

	// The current status of the set of featured results. When the value is ACTIVE,
	// featured results are ready for use. You can still configure your settings
	// before setting the status to ACTIVE. You can set the status to ACTIVE or
	// INACTIVE using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html)
	// API. The queries you specify for featured results must be unique per featured
	// results set for each index, whether the status is ACTIVE or INACTIVE.
	Status *string `type:"string" enum:"FeaturedResultsSetStatus"`
	// contains filtered or unexported fields
}

func (DescribeFeaturedResultsSetOutput) GoString added in v1.44.233 

func (s DescribeFeaturedResultsSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFeaturedResultsSetOutput) SetCreationTimestamp added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetCreationTimestamp(v int64) *DescribeFeaturedResultsSetOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*DescribeFeaturedResultsSetOutput) SetDescription added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetDescription(v string) *DescribeFeaturedResultsSetOutput

SetDescription sets the Description field's value.

func (*DescribeFeaturedResultsSetOutput) SetFeaturedDocumentsMissing added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetFeaturedDocumentsMissing(v []*FeaturedDocumentMissing) *DescribeFeaturedResultsSetOutput

SetFeaturedDocumentsMissing sets the FeaturedDocumentsMissing field's value.

func (*DescribeFeaturedResultsSetOutput) SetFeaturedDocumentsWithMetadata added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetFeaturedDocumentsWithMetadata(v []*FeaturedDocumentWithMetadata) *DescribeFeaturedResultsSetOutput

SetFeaturedDocumentsWithMetadata sets the FeaturedDocumentsWithMetadata field's value.

func (*DescribeFeaturedResultsSetOutput) SetFeaturedResultsSetId added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetFeaturedResultsSetId(v string) *DescribeFeaturedResultsSetOutput

SetFeaturedResultsSetId sets the FeaturedResultsSetId field's value.

func (*DescribeFeaturedResultsSetOutput) SetFeaturedResultsSetName added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetFeaturedResultsSetName(v string) *DescribeFeaturedResultsSetOutput

SetFeaturedResultsSetName sets the FeaturedResultsSetName field's value.

func (*DescribeFeaturedResultsSetOutput) SetLastUpdatedTimestamp added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetLastUpdatedTimestamp(v int64) *DescribeFeaturedResultsSetOutput

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*DescribeFeaturedResultsSetOutput) SetQueryTexts added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetQueryTexts(v []*string) *DescribeFeaturedResultsSetOutput

SetQueryTexts sets the QueryTexts field's value.

func (*DescribeFeaturedResultsSetOutput) SetStatus added in v1.44.233 

func (s *DescribeFeaturedResultsSetOutput) SetStatus(v string) *DescribeFeaturedResultsSetOutput

SetStatus sets the Status field's value.

func (DescribeFeaturedResultsSetOutput) String added in v1.44.233 

func (s DescribeFeaturedResultsSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeIndexInput 

type DescribeIndexInput struct {

	// The identifier of the index you want to get information on.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeIndexInput) GoString 

func (s DescribeIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIndexInput) SetId 

func (s *DescribeIndexInput) SetId(v string) *DescribeIndexInput

SetId sets the Id field's value.

func (DescribeIndexInput) String 

func (s DescribeIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIndexInput) Validate 

func (s *DescribeIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeIndexOutput 

type DescribeIndexOutput struct {

	// 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 query or document storage capacity of zero indicates that
	// the index is using the default capacity. For more information on the default
	// capacity for an index and adjusting this, see Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
	CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

	// The Unix timestamp when the index was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The description for the index.
	Description *string `type:"string"`

	// Configuration information for document metadata or fields. Document metadata
	// are fields or attributes associated with your documents. For example, the
	// company department name associated with each document.
	DocumentMetadataConfigurations []*DocumentMetadataConfiguration `type:"list"`

	// The Amazon Kendra edition used for the index. You decide the edition when
	// you create the index.
	Edition *string `type:"string" enum:"IndexEdition"`

	// When the Status field value is FAILED, the ErrorMessage field contains a
	// message that explains why.
	ErrorMessage *string `min:"1" type:"string"`

	// The identifier of the index.
	Id *string `min:"36" type:"string"`

	// Provides information about the number of FAQ questions and answers and the
	// number of text documents indexed.
	IndexStatistics *IndexStatistics `type:"structure"`

	// The name of the index.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission
	// to write to your Amazon CloudWatch logs.
	RoleArn *string `type:"string"`

	// The identifier of the KMS customer master key (CMK) that is used to encrypt
	// your data. Amazon Kendra doesn't support asymmetric CMKs.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

	// 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.
	Status *string `type:"string" enum:"IndexStatus"`

	// The Unix timestamp when the index was last updated.
	UpdatedAt *time.Time `type:"timestamp"`

	// The user context policy for the Amazon Kendra index.
	UserContextPolicy *string `type:"string" enum:"UserContextPolicy"`

	// Whether you have enabled IAM Identity Center identity source for your users
	// and groups. This is useful for user context filtering, where search results
	// are filtered based on the user or their group access to documents.
	UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"`

	// The user token configuration for the Amazon Kendra index.
	UserTokenConfigurations []*UserTokenConfiguration `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeIndexOutput) GoString 

func (s DescribeIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIndexOutput) SetCapacityUnits added in v1.30.25 

func (s *DescribeIndexOutput) SetCapacityUnits(v *CapacityUnitsConfiguration) *DescribeIndexOutput

SetCapacityUnits sets the CapacityUnits field's value.

func (*DescribeIndexOutput) SetCreatedAt 

func (s *DescribeIndexOutput) SetCreatedAt(v time.Time) *DescribeIndexOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeIndexOutput) SetDescription 

func (s *DescribeIndexOutput) SetDescription(v string) *DescribeIndexOutput

SetDescription sets the Description field's value.

func (*DescribeIndexOutput) SetDocumentMetadataConfigurations 

func (s *DescribeIndexOutput) SetDocumentMetadataConfigurations(v []*DocumentMetadataConfiguration) *DescribeIndexOutput

SetDocumentMetadataConfigurations sets the DocumentMetadataConfigurations field's value.

func (*DescribeIndexOutput) SetEdition added in v1.30.25 

func (s *DescribeIndexOutput) SetEdition(v string) *DescribeIndexOutput

SetEdition sets the Edition field's value.

func (*DescribeIndexOutput) SetErrorMessage 

func (s *DescribeIndexOutput) SetErrorMessage(v string) *DescribeIndexOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeIndexOutput) SetId 

func (s *DescribeIndexOutput) SetId(v string) *DescribeIndexOutput

SetId sets the Id field's value.

func (*DescribeIndexOutput) SetIndexStatistics 

func (s *DescribeIndexOutput) SetIndexStatistics(v *IndexStatistics) *DescribeIndexOutput

SetIndexStatistics sets the IndexStatistics field's value.

func (*DescribeIndexOutput) SetName 

func (s *DescribeIndexOutput) SetName(v string) *DescribeIndexOutput

SetName sets the Name field's value.

func (*DescribeIndexOutput) SetRoleArn 

func (s *DescribeIndexOutput) SetRoleArn(v string) *DescribeIndexOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeIndexOutput) SetServerSideEncryptionConfiguration 

func (s *DescribeIndexOutput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DescribeIndexOutput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*DescribeIndexOutput) SetStatus 

func (s *DescribeIndexOutput) SetStatus(v string) *DescribeIndexOutput

SetStatus sets the Status field's value.

func (*DescribeIndexOutput) SetUpdatedAt 

func (s *DescribeIndexOutput) SetUpdatedAt(v time.Time) *DescribeIndexOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (*DescribeIndexOutput) SetUserContextPolicy added in v1.35.22 

func (s *DescribeIndexOutput) SetUserContextPolicy(v string) *DescribeIndexOutput

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*DescribeIndexOutput) SetUserGroupResolutionConfiguration added in v1.40.57 

func (s *DescribeIndexOutput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *DescribeIndexOutput

SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value.

func (*DescribeIndexOutput) SetUserTokenConfigurations added in v1.35.22 

func (s *DescribeIndexOutput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *DescribeIndexOutput

SetUserTokenConfigurations sets the UserTokenConfigurations field's value.

func (DescribeIndexOutput) String 

func (s DescribeIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePrincipalMappingInput added in v1.39.5 

type DescribePrincipalMappingInput struct {

	// The identifier of the data source to check the processing of PUT and DELETE
	// actions for mapping users to their groups.
	DataSourceId *string `min:"1" type:"string"`

	// The identifier of the group required to check the processing of PUT and DELETE
	// actions for mapping users to their groups.
	//
	// GroupId is a required field
	GroupId *string `min:"1" type:"string" required:"true"`

	// The identifier of the index required to check the processing of PUT and DELETE
	// actions for mapping users to their groups.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePrincipalMappingInput) GoString added in v1.39.5 

func (s DescribePrincipalMappingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePrincipalMappingInput) SetDataSourceId added in v1.39.5 

func (s *DescribePrincipalMappingInput) SetDataSourceId(v string) *DescribePrincipalMappingInput

SetDataSourceId sets the DataSourceId field's value.

func (*DescribePrincipalMappingInput) SetGroupId added in v1.39.5 

func (s *DescribePrincipalMappingInput) SetGroupId(v string) *DescribePrincipalMappingInput

SetGroupId sets the GroupId field's value.

func (*DescribePrincipalMappingInput) SetIndexId added in v1.39.5 

func (s *DescribePrincipalMappingInput) SetIndexId(v string) *DescribePrincipalMappingInput

SetIndexId sets the IndexId field's value.

func (DescribePrincipalMappingInput) String added in v1.39.5 

func (s DescribePrincipalMappingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePrincipalMappingInput) Validate added in v1.39.5 

func (s *DescribePrincipalMappingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePrincipalMappingOutput added in v1.39.5 

type DescribePrincipalMappingOutput struct {

	// Shows the identifier of the data source to see information on the processing
	// of PUT and DELETE actions for mapping users to their groups.
	DataSourceId *string `min:"1" type:"string"`

	// Shows the identifier of the group to see information on the processing of
	// PUT and DELETE actions for mapping users to their groups.
	GroupId *string `min:"1" type:"string"`

	// Shows the following information on the processing of PUT and DELETE actions
	// for mapping users to their groups:
	//
	//    * Status—the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED,
	//    or FAILED.
	//
	//    * Last updated—the last date-time an action was updated.
	//
	//    * Received—the last date-time an action was received or submitted.
	//
	//    * Ordering ID—the latest action that should process and apply after
	//    other actions.
	//
	//    * Failure reason—the reason an action could not be processed.
	GroupOrderingIdSummaries []*GroupOrderingIdSummary `type:"list"`

	// Shows the identifier of the index to see information on the processing of
	// PUT and DELETE actions for mapping users to their groups.
	IndexId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (DescribePrincipalMappingOutput) GoString added in v1.39.5 

func (s DescribePrincipalMappingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePrincipalMappingOutput) SetDataSourceId added in v1.39.5 

func (s *DescribePrincipalMappingOutput) SetDataSourceId(v string) *DescribePrincipalMappingOutput

SetDataSourceId sets the DataSourceId field's value.

func (*DescribePrincipalMappingOutput) SetGroupId added in v1.39.5 

func (s *DescribePrincipalMappingOutput) SetGroupId(v string) *DescribePrincipalMappingOutput

SetGroupId sets the GroupId field's value.

func (*DescribePrincipalMappingOutput) SetGroupOrderingIdSummaries added in v1.39.5 

func (s *DescribePrincipalMappingOutput) SetGroupOrderingIdSummaries(v []*GroupOrderingIdSummary) *DescribePrincipalMappingOutput

SetGroupOrderingIdSummaries sets the GroupOrderingIdSummaries field's value.

func (*DescribePrincipalMappingOutput) SetIndexId added in v1.39.5 

func (s *DescribePrincipalMappingOutput) SetIndexId(v string) *DescribePrincipalMappingOutput

SetIndexId sets the IndexId field's value.

func (DescribePrincipalMappingOutput) String added in v1.39.5 

func (s DescribePrincipalMappingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeQuerySuggestionsBlockListInput added in v1.38.50 

type DescribeQuerySuggestionsBlockListInput struct {

	// The identifier of the block list you want to get information on.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`

	// The identifier of the index for the block list.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeQuerySuggestionsBlockListInput) GoString added in v1.38.50 

func (s DescribeQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQuerySuggestionsBlockListInput) SetId added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListInput) SetId(v string) *DescribeQuerySuggestionsBlockListInput

SetId sets the Id field's value.

func (*DescribeQuerySuggestionsBlockListInput) SetIndexId added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListInput) SetIndexId(v string) *DescribeQuerySuggestionsBlockListInput

SetIndexId sets the IndexId field's value.

func (DescribeQuerySuggestionsBlockListInput) String added in v1.38.50 

func (s DescribeQuerySuggestionsBlockListInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQuerySuggestionsBlockListInput) Validate added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeQuerySuggestionsBlockListOutput added in v1.38.50 

type DescribeQuerySuggestionsBlockListOutput struct {

	// The Unix timestamp when a block list for query suggestions was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The description for the block list.
	Description *string `type:"string"`

	// The error message containing details if there are issues processing the block
	// list.
	ErrorMessage *string `min:"1" type:"string"`

	// The current size of the block list text file in S3.
	FileSizeBytes *int64 `type:"long"`

	// The identifier of the block list.
	Id *string `min:"36" type:"string"`

	// The identifier of the index for the block list.
	IndexId *string `min:"36" type:"string"`

	// The current number of valid, non-empty words or phrases in the block list
	// text file.
	ItemCount *int64 `type:"integer"`

	// The name of the block list.
	Name *string `min:"1" type:"string"`

	// The IAM (Identity and Access Management) role used by Amazon Kendra to access
	// the block list text file in S3.
	//
	// The role needs S3 read permissions to your file in S3 and needs to give STS
	// (Security Token Service) assume role permissions to Amazon Kendra.
	RoleArn *string `type:"string"`

	// Shows the current S3 path to your block list text file in your S3 bucket.
	//
	// Each block word or phrase should be on a separate line in a text file.
	//
	// For information on the current quota limits for block lists, see Quotas for
	// Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	SourceS3Path *S3Path `type:"structure"`

	// The current status of the block list. When the value is ACTIVE, the block
	// list is ready for use.
	Status *string `type:"string" enum:"QuerySuggestionsBlockListStatus"`

	// The Unix timestamp when a block list for query suggestions was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeQuerySuggestionsBlockListOutput) GoString added in v1.38.50 

func (s DescribeQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQuerySuggestionsBlockListOutput) SetCreatedAt added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetCreatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetDescription added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetDescription(v string) *DescribeQuerySuggestionsBlockListOutput

SetDescription sets the Description field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetErrorMessage added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetErrorMessage(v string) *DescribeQuerySuggestionsBlockListOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetFileSizeBytes added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetFileSizeBytes(v int64) *DescribeQuerySuggestionsBlockListOutput

SetFileSizeBytes sets the FileSizeBytes field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetId added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetId(v string) *DescribeQuerySuggestionsBlockListOutput

SetId sets the Id field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetIndexId added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetIndexId(v string) *DescribeQuerySuggestionsBlockListOutput

SetIndexId sets the IndexId field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetItemCount added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetItemCount(v int64) *DescribeQuerySuggestionsBlockListOutput

SetItemCount sets the ItemCount field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetName added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetName(v string) *DescribeQuerySuggestionsBlockListOutput

SetName sets the Name field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetRoleArn added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetRoleArn(v string) *DescribeQuerySuggestionsBlockListOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetSourceS3Path added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetSourceS3Path(v *S3Path) *DescribeQuerySuggestionsBlockListOutput

SetSourceS3Path sets the SourceS3Path field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetStatus added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetStatus(v string) *DescribeQuerySuggestionsBlockListOutput

SetStatus sets the Status field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetUpdatedAt added in v1.38.50 

func (s *DescribeQuerySuggestionsBlockListOutput) SetUpdatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeQuerySuggestionsBlockListOutput) String added in v1.38.50 

func (s DescribeQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeQuerySuggestionsConfigInput added in v1.38.50 

type DescribeQuerySuggestionsConfigInput struct {

	// The identifier of the index with query suggestions that you want to get information
	// on.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeQuerySuggestionsConfigInput) GoString added in v1.38.50 

func (s DescribeQuerySuggestionsConfigInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQuerySuggestionsConfigInput) SetIndexId added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigInput) SetIndexId(v string) *DescribeQuerySuggestionsConfigInput

SetIndexId sets the IndexId field's value.

func (DescribeQuerySuggestionsConfigInput) String added in v1.38.50 

func (s DescribeQuerySuggestionsConfigInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQuerySuggestionsConfigInput) Validate added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeQuerySuggestionsConfigOutput added in v1.38.50 

type DescribeQuerySuggestionsConfigOutput struct {

	// Configuration information for the document fields/attributes that you want
	// to base query suggestions on.
	AttributeSuggestionsConfig *AttributeSuggestionsDescribeConfig `type:"structure"`

	// TRUE to use all queries, otherwise use only queries that include user information
	// to generate the query suggestions.
	IncludeQueriesWithoutUserInformation *bool `type:"boolean"`

	// The Unix timestamp when query suggestions for an index was last cleared.
	//
	// After you clear suggestions, Amazon Kendra learns new suggestions based on
	// new queries added to the query log from the time you cleared suggestions.
	// Amazon Kendra only considers re-occurences of a query from the time you cleared
	// suggestions.
	LastClearTime *time.Time `type:"timestamp"`

	// The Unix timestamp when query suggestions for an index was last updated.
	//
	// Amazon Kendra automatically updates suggestions every 24 hours, after you
	// change a setting or after you apply a block list (https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist).
	LastSuggestionsBuildTime *time.Time `type:"timestamp"`

	// The minimum number of unique users who must search a query in order for the
	// query to be eligible to suggest to your users.
	MinimumNumberOfQueryingUsers *int64 `min:"1" type:"integer"`

	// The minimum number of times a query must be searched in order for the query
	// to be eligible to suggest to your users.
	MinimumQueryCount *int64 `min:"1" type:"integer"`

	// Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
	//
	// By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off
	// query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig
	// (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html)
	// API.
	Mode *string `type:"string" enum:"Mode"`

	// How recent your queries are in your query log time window (in days).
	QueryLogLookBackWindowInDays *int64 `type:"integer"`

	// Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
	//
	// Active means the current settings apply and Updating means your changed settings
	// are in the process of applying.
	Status *string `type:"string" enum:"QuerySuggestionsStatus"`

	// The current total count of query suggestions for an index.
	//
	// This count can change when you update your query suggestions settings, if
	// you filter out certain queries from suggestions using a block list, and as
	// the query log accumulates more queries for Amazon Kendra to learn from.
	//
	// If the count is much lower than you expected, it could be because Amazon
	// Kendra needs more queries in the query history to learn from or your current
	// query suggestions settings are too strict.
	TotalSuggestionsCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeQuerySuggestionsConfigOutput) GoString added in v1.38.50 

func (s DescribeQuerySuggestionsConfigOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeQuerySuggestionsConfigOutput) SetAttributeSuggestionsConfig added in v1.44.255 

func (s *DescribeQuerySuggestionsConfigOutput) SetAttributeSuggestionsConfig(v *AttributeSuggestionsDescribeConfig) *DescribeQuerySuggestionsConfigOutput

SetAttributeSuggestionsConfig sets the AttributeSuggestionsConfig field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetIncludeQueriesWithoutUserInformation added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetIncludeQueriesWithoutUserInformation(v bool) *DescribeQuerySuggestionsConfigOutput

SetIncludeQueriesWithoutUserInformation sets the IncludeQueriesWithoutUserInformation field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetLastClearTime added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetLastClearTime(v time.Time) *DescribeQuerySuggestionsConfigOutput

SetLastClearTime sets the LastClearTime field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetLastSuggestionsBuildTime added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetLastSuggestionsBuildTime(v time.Time) *DescribeQuerySuggestionsConfigOutput

SetLastSuggestionsBuildTime sets the LastSuggestionsBuildTime field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMinimumNumberOfQueryingUsers added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumNumberOfQueryingUsers(v int64) *DescribeQuerySuggestionsConfigOutput

SetMinimumNumberOfQueryingUsers sets the MinimumNumberOfQueryingUsers field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMinimumQueryCount added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumQueryCount(v int64) *DescribeQuerySuggestionsConfigOutput

SetMinimumQueryCount sets the MinimumQueryCount field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMode added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetMode(v string) *DescribeQuerySuggestionsConfigOutput

SetMode sets the Mode field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetQueryLogLookBackWindowInDays added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetQueryLogLookBackWindowInDays(v int64) *DescribeQuerySuggestionsConfigOutput

SetQueryLogLookBackWindowInDays sets the QueryLogLookBackWindowInDays field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetStatus added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetStatus(v string) *DescribeQuerySuggestionsConfigOutput

SetStatus sets the Status field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetTotalSuggestionsCount added in v1.38.50 

func (s *DescribeQuerySuggestionsConfigOutput) SetTotalSuggestionsCount(v int64) *DescribeQuerySuggestionsConfigOutput

SetTotalSuggestionsCount sets the TotalSuggestionsCount field's value.

func (DescribeQuerySuggestionsConfigOutput) String added in v1.38.50 

func (s DescribeQuerySuggestionsConfigOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeThesaurusInput added in v1.36.6 

type DescribeThesaurusInput struct {

	// The identifier of the thesaurus you want to get information on.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for the thesaurus.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeThesaurusInput) GoString added in v1.36.6 

func (s DescribeThesaurusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThesaurusInput) SetId added in v1.36.6 

func (s *DescribeThesaurusInput) SetId(v string) *DescribeThesaurusInput

SetId sets the Id field's value.

func (*DescribeThesaurusInput) SetIndexId added in v1.36.6 

func (s *DescribeThesaurusInput) SetIndexId(v string) *DescribeThesaurusInput

SetIndexId sets the IndexId field's value.

func (DescribeThesaurusInput) String added in v1.36.6 

func (s DescribeThesaurusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThesaurusInput) Validate added in v1.36.6 

func (s *DescribeThesaurusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeThesaurusOutput added in v1.36.6 

type DescribeThesaurusOutput struct {

	// The Unix timestamp when the thesaurus was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The thesaurus description.
	Description *string `type:"string"`

	// When the Status field value is FAILED, the ErrorMessage field provides more
	// information.
	ErrorMessage *string `min:"1" type:"string"`

	// The size of the thesaurus file in bytes.
	FileSizeBytes *int64 `type:"long"`

	// The identifier of the thesaurus.
	Id *string `min:"1" type:"string"`

	// The identifier of the index for the thesaurus.
	IndexId *string `min:"36" type:"string"`

	// The thesaurus name.
	Name *string `min:"1" type:"string"`

	// An IAM role that gives Amazon Kendra permissions to access thesaurus file
	// specified in SourceS3Path.
	RoleArn *string `type:"string"`

	// Information required to find a specific file in an Amazon S3 bucket.
	SourceS3Path *S3Path `type:"structure"`

	// The current status of the thesaurus. When the value is ACTIVE, queries are
	// able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage
	// field provides more information.
	//
	// If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could
	// not ingest the new thesaurus file. The old thesaurus file is still active.
	Status *string `type:"string" enum:"ThesaurusStatus"`

	// The number of synonym rules in the thesaurus file.
	SynonymRuleCount *int64 `type:"long"`

	// The number of unique terms in the thesaurus file. For example, the synonyms
	// a,b,c and a=>d, the term count would be 4.
	TermCount *int64 `type:"long"`

	// The Unix timestamp when the thesaurus was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeThesaurusOutput) GoString added in v1.36.6 

func (s DescribeThesaurusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeThesaurusOutput) SetCreatedAt added in v1.36.6 

func (s *DescribeThesaurusOutput) SetCreatedAt(v time.Time) *DescribeThesaurusOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeThesaurusOutput) SetDescription added in v1.36.6 

func (s *DescribeThesaurusOutput) SetDescription(v string) *DescribeThesaurusOutput

SetDescription sets the Description field's value.

func (*DescribeThesaurusOutput) SetErrorMessage added in v1.36.6 

func (s *DescribeThesaurusOutput) SetErrorMessage(v string) *DescribeThesaurusOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeThesaurusOutput) SetFileSizeBytes added in v1.36.6 

func (s *DescribeThesaurusOutput) SetFileSizeBytes(v int64) *DescribeThesaurusOutput

SetFileSizeBytes sets the FileSizeBytes field's value.

func (*DescribeThesaurusOutput) SetId added in v1.36.6 

func (s *DescribeThesaurusOutput) SetId(v string) *DescribeThesaurusOutput

SetId sets the Id field's value.

func (*DescribeThesaurusOutput) SetIndexId added in v1.36.6 

func (s *DescribeThesaurusOutput) SetIndexId(v string) *DescribeThesaurusOutput

SetIndexId sets the IndexId field's value.

func (*DescribeThesaurusOutput) SetName added in v1.36.6 

func (s *DescribeThesaurusOutput) SetName(v string) *DescribeThesaurusOutput

SetName sets the Name field's value.

func (*DescribeThesaurusOutput) SetRoleArn added in v1.36.6 

func (s *DescribeThesaurusOutput) SetRoleArn(v string) *DescribeThesaurusOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeThesaurusOutput) SetSourceS3Path added in v1.36.6 

func (s *DescribeThesaurusOutput) SetSourceS3Path(v *S3Path) *DescribeThesaurusOutput

SetSourceS3Path sets the SourceS3Path field's value.

func (*DescribeThesaurusOutput) SetStatus added in v1.36.6 

func (s *DescribeThesaurusOutput) SetStatus(v string) *DescribeThesaurusOutput

SetStatus sets the Status field's value.

func (*DescribeThesaurusOutput) SetSynonymRuleCount added in v1.36.6 

func (s *DescribeThesaurusOutput) SetSynonymRuleCount(v int64) *DescribeThesaurusOutput

SetSynonymRuleCount sets the SynonymRuleCount field's value.

func (*DescribeThesaurusOutput) SetTermCount added in v1.36.6 

func (s *DescribeThesaurusOutput) SetTermCount(v int64) *DescribeThesaurusOutput

SetTermCount sets the TermCount field's value.

func (*DescribeThesaurusOutput) SetUpdatedAt added in v1.36.6 

func (s *DescribeThesaurusOutput) SetUpdatedAt(v time.Time) *DescribeThesaurusOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeThesaurusOutput) String added in v1.36.6 

func (s DescribeThesaurusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateEntitiesFromExperienceInput added in v1.42.17 

type DisassociateEntitiesFromExperienceInput struct {

	// Lists users or groups in your IAM Identity Center identity source.
	//
	// EntityList is a required field
	EntityList []*EntityConfiguration `min:"1" type:"list" required:"true"`

	// The identifier of your Amazon Kendra experience.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateEntitiesFromExperienceInput) GoString added in v1.42.17 

func (s DisassociateEntitiesFromExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateEntitiesFromExperienceInput) SetEntityList added in v1.42.17 

func (s *DisassociateEntitiesFromExperienceInput) SetEntityList(v []*EntityConfiguration) *DisassociateEntitiesFromExperienceInput

SetEntityList sets the EntityList field's value.

func (*DisassociateEntitiesFromExperienceInput) SetId added in v1.42.17 

func (s *DisassociateEntitiesFromExperienceInput) SetId(v string) *DisassociateEntitiesFromExperienceInput

SetId sets the Id field's value.

func (*DisassociateEntitiesFromExperienceInput) SetIndexId added in v1.42.17 

func (s *DisassociateEntitiesFromExperienceInput) SetIndexId(v string) *DisassociateEntitiesFromExperienceInput

SetIndexId sets the IndexId field's value.

func (DisassociateEntitiesFromExperienceInput) String added in v1.42.17 

func (s DisassociateEntitiesFromExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateEntitiesFromExperienceInput) Validate added in v1.42.17 

func (s *DisassociateEntitiesFromExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateEntitiesFromExperienceOutput added in v1.42.17 

type DisassociateEntitiesFromExperienceOutput struct {

	// Lists the users or groups in your IAM Identity Center identity source that
	// failed to properly remove access to your Amazon Kendra experience.
	FailedEntityList []*FailedEntity `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DisassociateEntitiesFromExperienceOutput) GoString added in v1.42.17 

func (s DisassociateEntitiesFromExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateEntitiesFromExperienceOutput) SetFailedEntityList added in v1.42.17 

func (s *DisassociateEntitiesFromExperienceOutput) SetFailedEntityList(v []*FailedEntity) *DisassociateEntitiesFromExperienceOutput

SetFailedEntityList sets the FailedEntityList field's value.

func (DisassociateEntitiesFromExperienceOutput) String added in v1.42.17 

func (s DisassociateEntitiesFromExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociatePersonasFromEntitiesInput added in v1.42.17 

type DisassociatePersonasFromEntitiesInput struct {

	// The identifiers of users or groups in your IAM Identity Center identity source.
	// For example, user IDs could be user emails.
	//
	// EntityIds is a required field
	EntityIds []*string `min:"1" type:"list" required:"true"`

	// The identifier of your Amazon Kendra experience.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociatePersonasFromEntitiesInput) GoString added in v1.42.17 

func (s DisassociatePersonasFromEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociatePersonasFromEntitiesInput) SetEntityIds added in v1.42.17 

func (s *DisassociatePersonasFromEntitiesInput) SetEntityIds(v []*string) *DisassociatePersonasFromEntitiesInput

SetEntityIds sets the EntityIds field's value.

func (*DisassociatePersonasFromEntitiesInput) SetId added in v1.42.17 

func (s *DisassociatePersonasFromEntitiesInput) SetId(v string) *DisassociatePersonasFromEntitiesInput

SetId sets the Id field's value.

func (*DisassociatePersonasFromEntitiesInput) SetIndexId added in v1.42.17 

func (s *DisassociatePersonasFromEntitiesInput) SetIndexId(v string) *DisassociatePersonasFromEntitiesInput

SetIndexId sets the IndexId field's value.

func (DisassociatePersonasFromEntitiesInput) String added in v1.42.17 

func (s DisassociatePersonasFromEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociatePersonasFromEntitiesInput) Validate added in v1.42.17 

func (s *DisassociatePersonasFromEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociatePersonasFromEntitiesOutput added in v1.42.17 

type DisassociatePersonasFromEntitiesOutput struct {

	// Lists the users or groups in your IAM Identity Center identity source that
	// failed to properly remove access to your Amazon Kendra experience.
	FailedEntityList []*FailedEntity `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DisassociatePersonasFromEntitiesOutput) GoString added in v1.42.17 

func (s DisassociatePersonasFromEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociatePersonasFromEntitiesOutput) SetFailedEntityList added in v1.42.17 

func (s *DisassociatePersonasFromEntitiesOutput) SetFailedEntityList(v []*FailedEntity) *DisassociatePersonasFromEntitiesOutput

SetFailedEntityList sets the FailedEntityList field's value.

func (DisassociatePersonasFromEntitiesOutput) String added in v1.42.17 

func (s DisassociatePersonasFromEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Document 

type Document struct {

	// The identifier of the access control configuration that you want to apply
	// to the document.
	AccessControlConfigurationId *string `min:"1" type:"string"`

	// Information on principals (users and/or groups) and which documents they
	// should have access to. This is useful for user context filtering, where search
	// results are filtered based on the user or their group access to documents.
	AccessControlList []*Principal `type:"list"`

	// Custom attributes to apply to the document. Use the custom attributes to
	// provide additional information for searching, to provide facets for refining
	// searches, and to provide additional information in the query response.
	//
	// For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
	// that provide information on the synchronization of documents running on a
	// data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute
	// as Amazon Kendra will use the ID of a running sync job.
	Attributes []*DocumentAttribute `type:"list"`

	// The contents of the document.
	//
	// Documents passed to the Blob parameter must be base64 encoded. Your code
	// might not need to encode the document file bytes if you're using an Amazon
	// Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon
	// Kendra endpoint directly using REST, you must base64 encode the contents
	// before sending.
	// Blob is automatically base64 encoded/decoded by the SDK.
	Blob []byte `type:"blob"`

	// The file type of the document in the Blob field.
	//
	// If you want to index snippets or subsets of HTML documents instead of the
	// entirety of the HTML documents, you must add the HTML start and closing tags
	// (<HTML>content</HTML>) around the content.
	ContentType *string `type:"string" enum:"ContentType"`

	// The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html)
	// lists that define the hierarchy for which documents users should have access
	// to.
	HierarchicalAccessControlList []*HierarchicalPrincipal `min:"1" type:"list"`

	// A identifier of the document in the index.
	//
	// Note, each document ID must be unique per index. You cannot create a data
	// source to index your documents with their unique IDs and then use the BatchPutDocument
	// API to index the same documents, or vice versa. You can delete a data source
	// and then use the BatchPutDocument API to index the same documents, or vice
	// versa.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// Information required to find a specific file in an Amazon S3 bucket.
	S3Path *S3Path `type:"structure"`

	// The title of the document.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

A document in an index.

func (Document) GoString 

func (s Document) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Document) SetAccessControlConfigurationId added in v1.44.55 

func (s *Document) SetAccessControlConfigurationId(v string) *Document

SetAccessControlConfigurationId sets the AccessControlConfigurationId field's value.

func (*Document) SetAccessControlList 

func (s *Document) SetAccessControlList(v []*Principal) *Document

SetAccessControlList sets the AccessControlList field's value.

func (*Document) SetAttributes 

func (s *Document) SetAttributes(v []*DocumentAttribute) *Document

SetAttributes sets the Attributes field's value.

func (*Document) SetBlob 

func (s *Document) SetBlob(v []byte) *Document

SetBlob sets the Blob field's value.

func (*Document) SetContentType 

func (s *Document) SetContentType(v string) *Document

SetContentType sets the ContentType field's value.

func (*Document) SetHierarchicalAccessControlList added in v1.39.5 

func (s *Document) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *Document

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*Document) SetId 

func (s *Document) SetId(v string) *Document

SetId sets the Id field's value.

func (*Document) SetS3Path 

func (s *Document) SetS3Path(v *S3Path) *Document

SetS3Path sets the S3Path field's value.

func (*Document) SetTitle 

func (s *Document) SetTitle(v string) *Document

SetTitle sets the Title field's value.

func (Document) String 

func (s Document) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Document) Validate 

func (s *Document) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttribute 

type DocumentAttribute struct {

	// The identifier for the attribute.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the attribute.
	//
	// Value is a required field
	Value *DocumentAttributeValue `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A document attribute or metadata field. To create custom document attributes, see Custom attributes (https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html).

func (DocumentAttribute) GoString 

func (s DocumentAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttribute) SetKey 

func (s *DocumentAttribute) SetKey(v string) *DocumentAttribute

SetKey sets the Key field's value.

func (*DocumentAttribute) SetValue 

func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute

SetValue sets the Value field's value.

func (DocumentAttribute) String 

func (s DocumentAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttribute) Validate 

func (s *DocumentAttribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeCondition added in v1.42.17 

type DocumentAttributeCondition struct {

	// The identifier of the document attribute used for the condition.
	//
	// For example, 'Source_URI' could be an identifier for the attribute or metadata
	// field that contains source URIs associated with the documents.
	//
	// Amazon Kendra currently does not support _document_body as an attribute key
	// used for the condition.
	//
	// ConditionDocumentAttributeKey is a required field
	ConditionDocumentAttributeKey *string `min:"1" type:"string" required:"true"`

	// The value used by the operator.
	//
	// For example, you can specify the value 'financial' for strings in the 'Source_URI'
	// field that partially match or contain this value.
	ConditionOnValue *DocumentAttributeValue `type:"structure"`

	// The condition operator.
	//
	// For example, you can use 'Contains' to partially match a string.
	//
	// Operator is a required field
	Operator *string `type:"string" required:"true" enum:"ConditionOperator"`
	// contains filtered or unexported fields
}

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html).

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

func (DocumentAttributeCondition) GoString added in v1.42.17 

func (s DocumentAttributeCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeCondition) SetConditionDocumentAttributeKey added in v1.42.17 

func (s *DocumentAttributeCondition) SetConditionDocumentAttributeKey(v string) *DocumentAttributeCondition

SetConditionDocumentAttributeKey sets the ConditionDocumentAttributeKey field's value.

func (*DocumentAttributeCondition) SetConditionOnValue added in v1.42.17 

func (s *DocumentAttributeCondition) SetConditionOnValue(v *DocumentAttributeValue) *DocumentAttributeCondition

SetConditionOnValue sets the ConditionOnValue field's value.

func (*DocumentAttributeCondition) SetOperator added in v1.42.17 

func (s *DocumentAttributeCondition) SetOperator(v string) *DocumentAttributeCondition

SetOperator sets the Operator field's value.

func (DocumentAttributeCondition) String added in v1.42.17 

func (s DocumentAttributeCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeCondition) Validate added in v1.42.17 

func (s *DocumentAttributeCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeTarget added in v1.42.17 

type DocumentAttributeTarget struct {

	// The identifier of the target document attribute or metadata field.
	//
	// For example, 'Department' could be an identifier for the target attribute
	// or metadata field that includes the department names associated with the
	// documents.
	TargetDocumentAttributeKey *string `min:"1" type:"string"`

	// The target value you want to create for the target attribute.
	//
	// For example, 'Finance' could be the target value for the target attribute
	// key 'Department'.
	TargetDocumentAttributeValue *DocumentAttributeValue `type:"structure"`

	// TRUE to delete the existing target value for your specified target attribute
	// key. You cannot create a target value and set this to TRUE. To create a target
	// value (TargetDocumentAttributeValue), set this to FALSE.
	TargetDocumentAttributeValueDeletion *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html).

func (DocumentAttributeTarget) GoString added in v1.42.17 

func (s DocumentAttributeTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeTarget) SetTargetDocumentAttributeKey added in v1.42.17 

func (s *DocumentAttributeTarget) SetTargetDocumentAttributeKey(v string) *DocumentAttributeTarget

SetTargetDocumentAttributeKey sets the TargetDocumentAttributeKey field's value.

func (*DocumentAttributeTarget) SetTargetDocumentAttributeValue added in v1.42.17 

func (s *DocumentAttributeTarget) SetTargetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeTarget

SetTargetDocumentAttributeValue sets the TargetDocumentAttributeValue field's value.

func (*DocumentAttributeTarget) SetTargetDocumentAttributeValueDeletion added in v1.42.17 

func (s *DocumentAttributeTarget) SetTargetDocumentAttributeValueDeletion(v bool) *DocumentAttributeTarget

SetTargetDocumentAttributeValueDeletion sets the TargetDocumentAttributeValueDeletion field's value.

func (DocumentAttributeTarget) String added in v1.42.17 

func (s DocumentAttributeTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeTarget) Validate added in v1.42.17 

func (s *DocumentAttributeTarget) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeValue 

type DocumentAttributeValue struct {

	// A date expressed as an ISO 8601 string.
	//
	// It is important for the time zone to be included in the ISO 8601 date-time
	// format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time
	// format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European
	// Time.
	DateValue *time.Time `type:"timestamp"`

	// A long integer value.
	LongValue *int64 `type:"long"`

	// A list of strings. The default maximum length or number of strings is 10.
	StringListValue []*string `type:"list"`

	// A string, such as "department".
	StringValue *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The value of a document attribute. You can only provide one value for a document attribute.

func (DocumentAttributeValue) GoString 

func (s DocumentAttributeValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeValue) SetDateValue 

func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue

SetDateValue sets the DateValue field's value.

func (*DocumentAttributeValue) SetLongValue 

func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue

SetLongValue sets the LongValue field's value.

func (*DocumentAttributeValue) SetStringListValue 

func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue

SetStringListValue sets the StringListValue field's value.

func (*DocumentAttributeValue) SetStringValue 

func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue

SetStringValue sets the StringValue field's value.

func (DocumentAttributeValue) String 

func (s DocumentAttributeValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeValue) Validate 

func (s *DocumentAttributeValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeValueCountPair 

type DocumentAttributeValueCountPair struct {

	// The number of documents in the response that have the attribute/field value
	// for the key.
	Count *int64 `type:"integer"`

	// The value of the attribute/field. For example, "HR".
	DocumentAttributeValue *DocumentAttributeValue `type:"structure"`

	// Contains the results of a document attribute/field that is a nested facet.
	// A FacetResult contains the counts for each facet nested within a facet.
	//
	// For example, the document attribute or facet "Department" includes a value
	// called "Engineering". In addition, the document attribute or facet "SubDepartment"
	// includes the values "Frontend" and "Backend" for documents assigned to "Engineering".
	// You can display nested facets in the search results so that documents can
	// be searched not only by department but also by a sub department within a
	// department. The counts for documents that belong to "Frontend" and "Backend"
	// within "Engineering" are returned for a query.
	FacetResults []*FacetResult `type:"list"`
	// contains filtered or unexported fields
}

Provides the count of documents that match a particular document attribute or field when doing a faceted search.

func (DocumentAttributeValueCountPair) GoString 

func (s DocumentAttributeValueCountPair) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeValueCountPair) SetCount 

func (s *DocumentAttributeValueCountPair) SetCount(v int64) *DocumentAttributeValueCountPair

SetCount sets the Count field's value.

func (*DocumentAttributeValueCountPair) SetDocumentAttributeValue 

func (s *DocumentAttributeValueCountPair) SetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeValueCountPair

SetDocumentAttributeValue sets the DocumentAttributeValue field's value.

func (*DocumentAttributeValueCountPair) SetFacetResults added in v1.44.8 

func (s *DocumentAttributeValueCountPair) SetFacetResults(v []*FacetResult) *DocumentAttributeValueCountPair

SetFacetResults sets the FacetResults field's value.

func (DocumentAttributeValueCountPair) String 

func (s DocumentAttributeValueCountPair) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentInfo added in v1.38.58 

type DocumentInfo struct {

	// Attributes that identify a specific version of a document to check.
	//
	// The only valid attributes are:
	//
	//    * version
	//
	//    * datasourceId
	//
	//    * jobExecutionId
	//
	// The attributes follow these rules:
	//
	//    * dataSourceId and jobExecutionId must be used together.
	//
	//    * version is ignored if dataSourceId and jobExecutionId are not provided.
	//
	//    * If dataSourceId and jobExecutionId are provided, but version is not,
	//    the version defaults to "0".
	Attributes []*DocumentAttribute `type:"list"`

	// The identifier of the document.
	//
	// DocumentId is a required field
	DocumentId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies a document for which to retrieve status information

func (DocumentInfo) GoString added in v1.38.58 

func (s DocumentInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentInfo) SetAttributes added in v1.38.58 

func (s *DocumentInfo) SetAttributes(v []*DocumentAttribute) *DocumentInfo

SetAttributes sets the Attributes field's value.

func (*DocumentInfo) SetDocumentId added in v1.38.58 

func (s *DocumentInfo) SetDocumentId(v string) *DocumentInfo

SetDocumentId sets the DocumentId field's value.

func (DocumentInfo) String added in v1.38.58 

func (s DocumentInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentInfo) Validate added in v1.38.58 

func (s *DocumentInfo) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentMetadataConfiguration 

type DocumentMetadataConfiguration struct {

	// The name of the index field.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Provides tuning parameters to determine how the field affects the search
	// results.
	Relevance *Relevance `type:"structure"`

	// Provides information about how the field is used during a search.
	Search *Search `type:"structure"`

	// The data type of the index field.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"DocumentAttributeValueType"`
	// contains filtered or unexported fields
}

Specifies the properties, such as relevance tuning and searchability, of an index field.

func (DocumentMetadataConfiguration) GoString 

func (s DocumentMetadataConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentMetadataConfiguration) SetName 

func (s *DocumentMetadataConfiguration) SetName(v string) *DocumentMetadataConfiguration

SetName sets the Name field's value.

func (*DocumentMetadataConfiguration) SetRelevance 

func (s *DocumentMetadataConfiguration) SetRelevance(v *Relevance) *DocumentMetadataConfiguration

SetRelevance sets the Relevance field's value.

func (*DocumentMetadataConfiguration) SetSearch 

func (s *DocumentMetadataConfiguration) SetSearch(v *Search) *DocumentMetadataConfiguration

SetSearch sets the Search field's value.

func (*DocumentMetadataConfiguration) SetType 

func (s *DocumentMetadataConfiguration) SetType(v string) *DocumentMetadataConfiguration

SetType sets the Type field's value.

func (DocumentMetadataConfiguration) String 

func (s DocumentMetadataConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentMetadataConfiguration) Validate 

func (s *DocumentMetadataConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentRelevanceConfiguration added in v1.38.23 

type DocumentRelevanceConfiguration struct {

	// The name of the index field.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Provides information for tuning the relevance of a field in a search. When
	// a query includes terms that match the field, the results are given a boost
	// in the response based on these tuning parameters.
	//
	// Relevance is a required field
	Relevance *Relevance `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Overrides the document relevance properties of a custom index field.

func (DocumentRelevanceConfiguration) GoString added in v1.38.23 

func (s DocumentRelevanceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentRelevanceConfiguration) SetName added in v1.38.23 

func (s *DocumentRelevanceConfiguration) SetName(v string) *DocumentRelevanceConfiguration

SetName sets the Name field's value.

func (*DocumentRelevanceConfiguration) SetRelevance added in v1.38.23 

func (s *DocumentRelevanceConfiguration) SetRelevance(v *Relevance) *DocumentRelevanceConfiguration

SetRelevance sets the Relevance field's value.

func (DocumentRelevanceConfiguration) String added in v1.38.23 

func (s DocumentRelevanceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentRelevanceConfiguration) Validate added in v1.38.23 

func (s *DocumentRelevanceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentsMetadataConfiguration 

type DocumentsMetadataConfiguration struct {

	// A prefix used to filter metadata configuration files in the Amazon Web Services
	// S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix
	// to include only the desired metadata files.
	S3Prefix *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

func (DocumentsMetadataConfiguration) GoString 

func (s DocumentsMetadataConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentsMetadataConfiguration) SetS3Prefix 

func (s *DocumentsMetadataConfiguration) SetS3Prefix(v string) *DocumentsMetadataConfiguration

SetS3Prefix sets the S3Prefix field's value.

func (DocumentsMetadataConfiguration) String 

func (s DocumentsMetadataConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentsMetadataConfiguration) Validate 

func (s *DocumentsMetadataConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityConfiguration added in v1.42.17 

type EntityConfiguration struct {

	// The identifier of a user or group in your IAM Identity Center identity source.
	// For example, a user ID could be an email.
	//
	// EntityId is a required field
	EntityId *string `min:"1" type:"string" required:"true"`

	// Specifies whether you are configuring a User or a Group.
	//
	// EntityType is a required field
	EntityType *string `type:"string" required:"true" enum:"EntityType"`
	// contains filtered or unexported fields
}

Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.

func (EntityConfiguration) GoString added in v1.42.17 

func (s EntityConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityConfiguration) SetEntityId added in v1.42.17 

func (s *EntityConfiguration) SetEntityId(v string) *EntityConfiguration

SetEntityId sets the EntityId field's value.

func (*EntityConfiguration) SetEntityType added in v1.42.17 

func (s *EntityConfiguration) SetEntityType(v string) *EntityConfiguration

SetEntityType sets the EntityType field's value.

func (EntityConfiguration) String added in v1.42.17 

func (s EntityConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityConfiguration) Validate added in v1.42.17 

func (s *EntityConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityDisplayData added in v1.42.17 

type EntityDisplayData struct {

	// The first name of the user.
	//
	// FirstName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EntityDisplayData's
	// String and GoString methods.
	FirstName *string `min:"1" type:"string" sensitive:"true"`

	// The name of the group.
	//
	// GroupName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EntityDisplayData's
	// String and GoString methods.
	GroupName *string `min:"1" type:"string" sensitive:"true"`

	// The user name of the user.
	//
	// IdentifiedUserName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EntityDisplayData's
	// String and GoString methods.
	IdentifiedUserName *string `min:"1" type:"string" sensitive:"true"`

	// The last name of the user.
	//
	// LastName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EntityDisplayData's
	// String and GoString methods.
	LastName *string `min:"1" type:"string" sensitive:"true"`

	// The name of the user.
	//
	// UserName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by EntityDisplayData's
	// String and GoString methods.
	UserName *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Information about the user entity.

func (EntityDisplayData) GoString added in v1.42.17 

func (s EntityDisplayData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityDisplayData) SetFirstName added in v1.42.17 

func (s *EntityDisplayData) SetFirstName(v string) *EntityDisplayData

SetFirstName sets the FirstName field's value.

func (*EntityDisplayData) SetGroupName added in v1.42.17 

func (s *EntityDisplayData) SetGroupName(v string) *EntityDisplayData

SetGroupName sets the GroupName field's value.

func (*EntityDisplayData) SetIdentifiedUserName added in v1.42.17 

func (s *EntityDisplayData) SetIdentifiedUserName(v string) *EntityDisplayData

SetIdentifiedUserName sets the IdentifiedUserName field's value.

func (*EntityDisplayData) SetLastName added in v1.42.17 

func (s *EntityDisplayData) SetLastName(v string) *EntityDisplayData

SetLastName sets the LastName field's value.

func (*EntityDisplayData) SetUserName added in v1.42.17 

func (s *EntityDisplayData) SetUserName(v string) *EntityDisplayData

SetUserName sets the UserName field's value.

func (EntityDisplayData) String added in v1.42.17 

func (s EntityDisplayData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EntityPersonaConfiguration added in v1.42.17 

type EntityPersonaConfiguration struct {

	// The identifier of a user or group in your IAM Identity Center identity source.
	// For example, a user ID could be an email.
	//
	// EntityId is a required field
	EntityId *string `min:"1" type:"string" required:"true"`

	// The persona that defines the specific permissions of the user or group in
	// your IAM Identity Center identity source. The available personas or access
	// roles are Owner and Viewer. For more information on these personas, see Providing
	// access to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience).
	//
	// Persona is a required field
	Persona *string `type:"string" required:"true" enum:"Persona"`
	// contains filtered or unexported fields
}

Provides the configuration information for users or groups in your IAM Identity Center identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.

func (EntityPersonaConfiguration) GoString added in v1.42.17 

func (s EntityPersonaConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityPersonaConfiguration) SetEntityId added in v1.42.17 

func (s *EntityPersonaConfiguration) SetEntityId(v string) *EntityPersonaConfiguration

SetEntityId sets the EntityId field's value.

func (*EntityPersonaConfiguration) SetPersona added in v1.42.17 

func (s *EntityPersonaConfiguration) SetPersona(v string) *EntityPersonaConfiguration

SetPersona sets the Persona field's value.

func (EntityPersonaConfiguration) String added in v1.42.17 

func (s EntityPersonaConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityPersonaConfiguration) Validate added in v1.42.17 

func (s *EntityPersonaConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExpandConfiguration added in v1.45.28 

type ExpandConfiguration struct {

	// The number of expanded results to show per collapsed primary document. For
	// instance, if you set this value to 3, then at most 3 results per collapsed
	// group will be displayed.
	MaxExpandedResultsPerItem *int64 `type:"integer"`

	// The number of collapsed search result groups to expand. If you set this value
	// to 10, for example, only the first 10 out of 100 result groups will have
	// expand functionality.
	MaxResultItemsToExpand *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Specifies the configuration information needed to customize how collapsed search result groups expand.

func (ExpandConfiguration) GoString added in v1.45.28 

func (s ExpandConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpandConfiguration) SetMaxExpandedResultsPerItem added in v1.45.28 

func (s *ExpandConfiguration) SetMaxExpandedResultsPerItem(v int64) *ExpandConfiguration

SetMaxExpandedResultsPerItem sets the MaxExpandedResultsPerItem field's value.

func (*ExpandConfiguration) SetMaxResultItemsToExpand added in v1.45.28 

func (s *ExpandConfiguration) SetMaxResultItemsToExpand(v int64) *ExpandConfiguration

SetMaxResultItemsToExpand sets the MaxResultItemsToExpand field's value.

func (ExpandConfiguration) String added in v1.45.28 

func (s ExpandConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpandedResultItem added in v1.45.28 

type ExpandedResultItem struct {

	// An array of document attributes assigned to a document in the search results.
	// For example, the document author ("_author") or the source URI ("_source_uri")
	// of the document.
	DocumentAttributes []*DocumentAttribute `type:"list"`

	// Provides text and information about where to highlight the text.
	DocumentExcerpt *TextWithHighlights `type:"structure"`

	// The idenitifier of the document.
	DocumentId *string `min:"1" type:"string"`

	// Provides text and information about where to highlight the text.
	DocumentTitle *TextWithHighlights `type:"structure"`

	// The URI of the original location of the document.
	DocumentURI *string `min:"1" type:"string"`

	// The identifier for the expanded result.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A single expanded result in a collapsed group of search results.

An expanded result item contains information about an expanded result document within a collapsed group of search results. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

func (ExpandedResultItem) GoString added in v1.45.28 

func (s ExpandedResultItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpandedResultItem) SetDocumentAttributes added in v1.45.28 

func (s *ExpandedResultItem) SetDocumentAttributes(v []*DocumentAttribute) *ExpandedResultItem

SetDocumentAttributes sets the DocumentAttributes field's value.

func (*ExpandedResultItem) SetDocumentExcerpt added in v1.45.28 

func (s *ExpandedResultItem) SetDocumentExcerpt(v *TextWithHighlights) *ExpandedResultItem

SetDocumentExcerpt sets the DocumentExcerpt field's value.

func (*ExpandedResultItem) SetDocumentId added in v1.45.28 

func (s *ExpandedResultItem) SetDocumentId(v string) *ExpandedResultItem

SetDocumentId sets the DocumentId field's value.

func (*ExpandedResultItem) SetDocumentTitle added in v1.45.28 

func (s *ExpandedResultItem) SetDocumentTitle(v *TextWithHighlights) *ExpandedResultItem

SetDocumentTitle sets the DocumentTitle field's value.

func (*ExpandedResultItem) SetDocumentURI added in v1.45.28 

func (s *ExpandedResultItem) SetDocumentURI(v string) *ExpandedResultItem

SetDocumentURI sets the DocumentURI field's value.

func (*ExpandedResultItem) SetId added in v1.45.28 

func (s *ExpandedResultItem) SetId(v string) *ExpandedResultItem

SetId sets the Id field's value.

func (ExpandedResultItem) String added in v1.45.28 

func (s ExpandedResultItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExperienceConfiguration added in v1.42.17 

type ExperienceConfiguration struct {

	// The identifiers of your data sources and FAQs. Or, you can specify that you
	// want to use documents indexed via the BatchPutDocument API. This is the content
	// you want to use for your Amazon Kendra experience.
	ContentSourceConfiguration *ContentSourceConfiguration `type:"structure"`

	// The IAM Identity Center field name that contains the identifiers of your
	// users, such as their emails.
	UserIdentityConfiguration *UserIdentityConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.

func (ExperienceConfiguration) GoString added in v1.42.17 

func (s ExperienceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceConfiguration) SetContentSourceConfiguration added in v1.42.17 

func (s *ExperienceConfiguration) SetContentSourceConfiguration(v *ContentSourceConfiguration) *ExperienceConfiguration

SetContentSourceConfiguration sets the ContentSourceConfiguration field's value.

func (*ExperienceConfiguration) SetUserIdentityConfiguration added in v1.42.17 

func (s *ExperienceConfiguration) SetUserIdentityConfiguration(v *UserIdentityConfiguration) *ExperienceConfiguration

SetUserIdentityConfiguration sets the UserIdentityConfiguration field's value.

func (ExperienceConfiguration) String added in v1.42.17 

func (s ExperienceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceConfiguration) Validate added in v1.42.17 

func (s *ExperienceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExperienceEndpoint added in v1.42.17 

type ExperienceEndpoint struct {

	// The endpoint of your Amazon Kendra experience.
	Endpoint *string `min:"1" type:"string"`

	// The type of endpoint for your Amazon Kendra experience. The type currently
	// available is HOME, which is a unique and fully hosted URL to the home page
	// of your Amazon Kendra experience.
	EndpointType *string `type:"string" enum:"EndpointType"`
	// contains filtered or unexported fields
}

Provides the configuration information for the endpoint for your Amazon Kendra experience.

func (ExperienceEndpoint) GoString added in v1.42.17 

func (s ExperienceEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceEndpoint) SetEndpoint added in v1.42.17 

func (s *ExperienceEndpoint) SetEndpoint(v string) *ExperienceEndpoint

SetEndpoint sets the Endpoint field's value.

func (*ExperienceEndpoint) SetEndpointType added in v1.42.17 

func (s *ExperienceEndpoint) SetEndpointType(v string) *ExperienceEndpoint

SetEndpointType sets the EndpointType field's value.

func (ExperienceEndpoint) String added in v1.42.17 

func (s ExperienceEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExperienceEntitiesSummary added in v1.42.17 

type ExperienceEntitiesSummary struct {

	// Information about the user entity.
	DisplayData *EntityDisplayData `type:"structure"`

	// The identifier of a user or group in your IAM Identity Center identity source.
	// For example, a user ID could be an email.
	EntityId *string `min:"1" type:"string"`

	// Shows the type as User or Group.
	EntityType *string `type:"string" enum:"EntityType"`
	// contains filtered or unexported fields
}

Summary information for users or groups in your IAM Identity Center identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

func (ExperienceEntitiesSummary) GoString added in v1.42.17 

func (s ExperienceEntitiesSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceEntitiesSummary) SetDisplayData added in v1.42.17 

func (s *ExperienceEntitiesSummary) SetDisplayData(v *EntityDisplayData) *ExperienceEntitiesSummary

SetDisplayData sets the DisplayData field's value.

func (*ExperienceEntitiesSummary) SetEntityId added in v1.42.17 

func (s *ExperienceEntitiesSummary) SetEntityId(v string) *ExperienceEntitiesSummary

SetEntityId sets the EntityId field's value.

func (*ExperienceEntitiesSummary) SetEntityType added in v1.42.17 

func (s *ExperienceEntitiesSummary) SetEntityType(v string) *ExperienceEntitiesSummary

SetEntityType sets the EntityType field's value.

func (ExperienceEntitiesSummary) String added in v1.42.17 

func (s ExperienceEntitiesSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExperiencesSummary added in v1.42.17 

type ExperiencesSummary struct {

	// The Unix timestamp when your Amazon Kendra experience was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The endpoint URLs for your Amazon Kendra experiences. The URLs are unique
	// and fully hosted by Amazon Web Services.
	Endpoints []*ExperienceEndpoint `min:"1" type:"list"`

	// The identifier of your Amazon Kendra experience.
	Id *string `min:"1" type:"string"`

	// The name of your Amazon Kendra experience.
	Name *string `min:"1" type:"string"`

	// The processing status of your Amazon Kendra experience.
	Status *string `type:"string" enum:"ExperienceStatus"`
	// contains filtered or unexported fields
}

Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

func (ExperiencesSummary) GoString added in v1.42.17 

func (s ExperiencesSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperiencesSummary) SetCreatedAt added in v1.42.17 

func (s *ExperiencesSummary) SetCreatedAt(v time.Time) *ExperiencesSummary

SetCreatedAt sets the CreatedAt field's value.

func (*ExperiencesSummary) SetEndpoints added in v1.42.17 

func (s *ExperiencesSummary) SetEndpoints(v []*ExperienceEndpoint) *ExperiencesSummary

SetEndpoints sets the Endpoints field's value.

func (*ExperiencesSummary) SetId added in v1.42.17 

func (s *ExperiencesSummary) SetId(v string) *ExperiencesSummary

SetId sets the Id field's value.

func (*ExperiencesSummary) SetName added in v1.42.17 

func (s *ExperiencesSummary) SetName(v string) *ExperiencesSummary

SetName sets the Name field's value.

func (*ExperiencesSummary) SetStatus added in v1.42.17 

func (s *ExperiencesSummary) SetStatus(v string) *ExperiencesSummary

SetStatus sets the Status field's value.

func (ExperiencesSummary) String added in v1.42.17 

func (s ExperiencesSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Facet 

type Facet struct {

	// The unique key for the document attribute.
	DocumentAttributeKey *string `min:"1" type:"string"`

	// An array of document attributes that are nested facets within a facet.
	//
	// For example, the document attribute or facet "Department" includes a value
	// called "Engineering". In addition, the document attribute or facet "SubDepartment"
	// includes the values "Frontend" and "Backend" for documents assigned to "Engineering".
	// You can display nested facets in the search results so that documents can
	// be searched not only by department but also by a sub department within a
	// department. This helps your users further narrow their search.
	//
	// You can only have one nested facet within a facet. If you want to increase
	// this limit, contact Support (http://aws.amazon.com/contact-us/).
	Facets []*Facet `type:"list"`

	// Maximum number of facet values per facet. The default is 10. You can use
	// this to limit the number of facet values to less than 10. If you want to
	// increase the default, contact Support (http://aws.amazon.com/contact-us/).
	MaxResults *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about a document attribute or field. You can use document attributes as facets.

For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.

You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support (http://aws.amazon.com/contact-us/).

func (Facet) GoString 

func (s Facet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Facet) SetDocumentAttributeKey 

func (s *Facet) SetDocumentAttributeKey(v string) *Facet

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*Facet) SetFacets added in v1.44.8 

func (s *Facet) SetFacets(v []*Facet) *Facet

SetFacets sets the Facets field's value.

func (*Facet) SetMaxResults added in v1.44.8 

func (s *Facet) SetMaxResults(v int64) *Facet

SetMaxResults sets the MaxResults field's value.

func (Facet) String 

func (s Facet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Facet) Validate 

func (s *Facet) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FacetResult 

type FacetResult struct {

	// The key for the facet values. This is the same as the DocumentAttributeKey
	// provided in the query.
	DocumentAttributeKey *string `min:"1" type:"string"`

	// An array of key/value pairs, where the key is the value of the attribute
	// and the count is the number of documents that share the key value.
	DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair `type:"list"`

	// The data type of the facet value. This is the same as the type defined for
	// the index field when it was created.
	DocumentAttributeValueType *string `type:"string" enum:"DocumentAttributeValueType"`
	// contains filtered or unexported fields
}

The facet values for the documents in the response.

func (FacetResult) GoString 

func (s FacetResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FacetResult) SetDocumentAttributeKey 

func (s *FacetResult) SetDocumentAttributeKey(v string) *FacetResult

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*FacetResult) SetDocumentAttributeValueCountPairs 

func (s *FacetResult) SetDocumentAttributeValueCountPairs(v []*DocumentAttributeValueCountPair) *FacetResult

SetDocumentAttributeValueCountPairs sets the DocumentAttributeValueCountPairs field's value.

func (*FacetResult) SetDocumentAttributeValueType added in v1.34.24 

func (s *FacetResult) SetDocumentAttributeValueType(v string) *FacetResult

SetDocumentAttributeValueType sets the DocumentAttributeValueType field's value.

func (FacetResult) String 

func (s FacetResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedEntity added in v1.42.17 

type FailedEntity struct {

	// The identifier of the user or group in your IAM Identity Center identity
	// source. For example, a user ID could be an email.
	EntityId *string `min:"1" type:"string"`

	// The reason the user or group in your IAM Identity Center identity source
	// failed to properly configure with your Amazon Kendra experience.
	ErrorMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information on the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

func (FailedEntity) GoString added in v1.42.17 

func (s FailedEntity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedEntity) SetEntityId added in v1.42.17 

func (s *FailedEntity) SetEntityId(v string) *FailedEntity

SetEntityId sets the EntityId field's value.

func (*FailedEntity) SetErrorMessage added in v1.42.17 

func (s *FailedEntity) SetErrorMessage(v string) *FailedEntity

SetErrorMessage sets the ErrorMessage field's value.

func (FailedEntity) String added in v1.42.17 

func (s FailedEntity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FaqStatistics 

type FaqStatistics struct {

	// The total number of FAQ questions and answers contained in the index.
	//
	// IndexedQuestionAnswersCount is a required field
	IndexedQuestionAnswersCount *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Provides statistical information about the FAQ questions and answers contained in an index.

func (FaqStatistics) GoString 

func (s FaqStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FaqStatistics) SetIndexedQuestionAnswersCount 

func (s *FaqStatistics) SetIndexedQuestionAnswersCount(v int64) *FaqStatistics

SetIndexedQuestionAnswersCount sets the IndexedQuestionAnswersCount field's value.

func (FaqStatistics) String 

func (s FaqStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FaqSummary 

type FaqSummary struct {

	// The Unix timestamp when the FAQ was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The file type used to create the FAQ.
	FileFormat *string `type:"string" enum:"FaqFileFormat"`

	// The identifier of the FAQ.
	Id *string `min:"1" type:"string"`

	// The code for a language. This shows a supported language for the FAQ document
	// as part of the summary information for FAQs. English is supported by default.
	// For more information on supported languages, including their codes, see Adding
	// documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
	LanguageCode *string `min:"2" type:"string"`

	// The name that you assigned the FAQ when you created or updated the FAQ.
	Name *string `min:"1" type:"string"`

	// The current status of the FAQ. When the status is ACTIVE the FAQ is ready
	// for use.
	Status *string `type:"string" enum:"FaqStatus"`

	// The Unix timestamp when the FAQ was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Summary information for frequently asked questions and answers included in an index.

func (FaqSummary) GoString 

func (s FaqSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FaqSummary) SetCreatedAt 

func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary

SetCreatedAt sets the CreatedAt field's value.

func (*FaqSummary) SetFileFormat added in v1.34.26 

func (s *FaqSummary) SetFileFormat(v string) *FaqSummary

SetFileFormat sets the FileFormat field's value.

func (*FaqSummary) SetId 

func (s *FaqSummary) SetId(v string) *FaqSummary

SetId sets the Id field's value.

func (*FaqSummary) SetLanguageCode added in v1.40.58 

func (s *FaqSummary) SetLanguageCode(v string) *FaqSummary

SetLanguageCode sets the LanguageCode field's value.

func (*FaqSummary) SetName 

func (s *FaqSummary) SetName(v string) *FaqSummary

SetName sets the Name field's value.

func (*FaqSummary) SetStatus 

func (s *FaqSummary) SetStatus(v string) *FaqSummary

SetStatus sets the Status field's value.

func (*FaqSummary) SetUpdatedAt 

func (s *FaqSummary) SetUpdatedAt(v time.Time) *FaqSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (FaqSummary) String 

func (s FaqSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeaturedDocument added in v1.44.233 

type FeaturedDocument struct {

	// The identifier of the document to feature in the search results. You can
	// use the Query (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html)
	// API to search for specific documents with their document IDs included in
	// the result items, or you can use the console.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A featured document. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.

func (FeaturedDocument) GoString added in v1.44.233 

func (s FeaturedDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedDocument) SetId added in v1.44.233 

func (s *FeaturedDocument) SetId(v string) *FeaturedDocument

SetId sets the Id field's value.

func (FeaturedDocument) String added in v1.44.233 

func (s FeaturedDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedDocument) Validate added in v1.44.233 

func (s *FeaturedDocument) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FeaturedDocumentMissing added in v1.44.233 

type FeaturedDocumentMissing struct {

	// The identifier of the document that doesn't exist but you have specified
	// as a featured document.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A document ID doesn't exist but you have specified as a featured document. Amazon Kendra cannot feature the document if it doesn't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) API.

func (FeaturedDocumentMissing) GoString added in v1.44.233 

func (s FeaturedDocumentMissing) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedDocumentMissing) SetId added in v1.44.233 

func (s *FeaturedDocumentMissing) SetId(v string) *FeaturedDocumentMissing

SetId sets the Id field's value.

func (FeaturedDocumentMissing) String added in v1.44.233 

func (s FeaturedDocumentMissing) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeaturedDocumentWithMetadata added in v1.44.233 

type FeaturedDocumentWithMetadata struct {

	// The identifier of the featured document with its metadata. You can use the
	// Query (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html) API to
	// search for specific documents with their document IDs included in the result
	// items, or you can use the console.
	Id *string `min:"1" type:"string"`

	// The main title of the featured document.
	Title *string `min:"1" type:"string"`

	// The source URI location of the featured document.
	URI *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A featured document with its metadata information. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.

func (FeaturedDocumentWithMetadata) GoString added in v1.44.233 

func (s FeaturedDocumentWithMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedDocumentWithMetadata) SetId added in v1.44.233 

func (s *FeaturedDocumentWithMetadata) SetId(v string) *FeaturedDocumentWithMetadata

SetId sets the Id field's value.

func (*FeaturedDocumentWithMetadata) SetTitle added in v1.44.233 

func (s *FeaturedDocumentWithMetadata) SetTitle(v string) *FeaturedDocumentWithMetadata

SetTitle sets the Title field's value.

func (*FeaturedDocumentWithMetadata) SetURI added in v1.44.233 

func (s *FeaturedDocumentWithMetadata) SetURI(v string) *FeaturedDocumentWithMetadata

SetURI sets the URI field's value.

func (FeaturedDocumentWithMetadata) String added in v1.44.233 

func (s FeaturedDocumentWithMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeaturedResultsConflictException added in v1.44.233 

type FeaturedResultsConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A list of the conflicting queries, including the query text, the name for
	// the featured results set, and the identifier of the featured results set.
	ConflictingItems []*ConflictingItem `type:"list"`

	// An explanation for the conflicting queries.
	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.

func (*FeaturedResultsConflictException) Code added in v1.44.233 

func (s *FeaturedResultsConflictException) Code() string

Code returns the exception type name.

func (*FeaturedResultsConflictException) Error added in v1.44.233 

func (s *FeaturedResultsConflictException) Error() string

func (FeaturedResultsConflictException) GoString added in v1.44.233 

func (s FeaturedResultsConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedResultsConflictException) Message added in v1.44.233 

func (s *FeaturedResultsConflictException) Message() string

Message returns the exception's message.

func (*FeaturedResultsConflictException) OrigErr added in v1.44.233 

func (s *FeaturedResultsConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*FeaturedResultsConflictException) RequestID added in v1.44.233 

func (s *FeaturedResultsConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*FeaturedResultsConflictException) StatusCode added in v1.44.233 

func (s *FeaturedResultsConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (FeaturedResultsConflictException) String added in v1.44.233 

func (s FeaturedResultsConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeaturedResultsItem added in v1.44.233 

type FeaturedResultsItem struct {

	// One or more additional attributes associated with the featured result.
	AdditionalAttributes []*AdditionalResultAttribute `type:"list"`

	// An array of document attributes assigned to a featured document in the search
	// results. For example, the document author (_author) or the source URI (_source_uri)
	// of the document.
	DocumentAttributes []*DocumentAttribute `type:"list"`

	// Provides text and information about where to highlight the text.
	DocumentExcerpt *TextWithHighlights `type:"structure"`

	// The identifier of the featured document.
	DocumentId *string `min:"1" type:"string"`

	// Provides text and information about where to highlight the text.
	DocumentTitle *TextWithHighlights `type:"structure"`

	// The source URI location of the featured document.
	DocumentURI *string `min:"1" type:"string"`

	// A token that identifies a particular featured result from a particular query.
	// Use this token to provide click-through feedback for the result. For more
	// information, see Submitting feedback (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html).
	FeedbackToken *string `min:"1" type:"string"`

	// The identifier of the featured result.
	Id *string `min:"1" type:"string"`

	// The type of document within the featured result response. For example, a
	// response could include a question-answer type that's relevant to the query.
	Type *string `type:"string" enum:"QueryResultType"`
	// contains filtered or unexported fields
}

A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

func (FeaturedResultsItem) GoString added in v1.44.233 

func (s FeaturedResultsItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedResultsItem) SetAdditionalAttributes added in v1.44.233 

func (s *FeaturedResultsItem) SetAdditionalAttributes(v []*AdditionalResultAttribute) *FeaturedResultsItem

SetAdditionalAttributes sets the AdditionalAttributes field's value.

func (*FeaturedResultsItem) SetDocumentAttributes added in v1.44.233 

func (s *FeaturedResultsItem) SetDocumentAttributes(v []*DocumentAttribute) *FeaturedResultsItem

SetDocumentAttributes sets the DocumentAttributes field's value.

func (*FeaturedResultsItem) SetDocumentExcerpt added in v1.44.233 

func (s *FeaturedResultsItem) SetDocumentExcerpt(v *TextWithHighlights) *FeaturedResultsItem

SetDocumentExcerpt sets the DocumentExcerpt field's value.

func (*FeaturedResultsItem) SetDocumentId added in v1.44.233 

func (s *FeaturedResultsItem) SetDocumentId(v string) *FeaturedResultsItem

SetDocumentId sets the DocumentId field's value.

func (*FeaturedResultsItem) SetDocumentTitle added in v1.44.233 

func (s *FeaturedResultsItem) SetDocumentTitle(v *TextWithHighlights) *FeaturedResultsItem

SetDocumentTitle sets the DocumentTitle field's value.

func (*FeaturedResultsItem) SetDocumentURI added in v1.44.233 

func (s *FeaturedResultsItem) SetDocumentURI(v string) *FeaturedResultsItem

SetDocumentURI sets the DocumentURI field's value.

func (*FeaturedResultsItem) SetFeedbackToken added in v1.44.233 

func (s *FeaturedResultsItem) SetFeedbackToken(v string) *FeaturedResultsItem

SetFeedbackToken sets the FeedbackToken field's value.

func (*FeaturedResultsItem) SetId added in v1.44.233 

func (s *FeaturedResultsItem) SetId(v string) *FeaturedResultsItem

SetId sets the Id field's value.

func (*FeaturedResultsItem) SetType added in v1.44.233 

func (s *FeaturedResultsItem) SetType(v string) *FeaturedResultsItem

SetType sets the Type field's value.

func (FeaturedResultsItem) String added in v1.44.233 

func (s FeaturedResultsItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeaturedResultsSet added in v1.44.233 

type FeaturedResultsSet struct {

	// The Unix timestamp when the set of featured results was created.
	CreationTimestamp *int64 `type:"long"`

	// The description for the set of featured results.
	Description *string `type:"string"`

	// The list of document IDs for the documents you want to feature at the top
	// of the search results page. You can use the Query (https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html)
	// API to search for specific documents with their document IDs included in
	// the result items, or you can use the console.
	//
	// You can add up to four featured documents. You can request to increase this
	// limit by contacting Support (http://aws.amazon.com/contact-us/).
	//
	// Specific queries are mapped to specific documents for featuring in the results.
	// If a query contains an exact match, then one or more specific documents are
	// featured in the results. The exact match applies to the full query. For example,
	// if you only specify 'Kendra', queries such as 'How does kendra semantically
	// rank results?' will not render the featured results. Featured results are
	// designed for specific queries, rather than queries that are too broad in
	// scope.
	FeaturedDocuments []*FeaturedDocument `type:"list"`

	// The identifier of the set of featured results.
	FeaturedResultsSetId *string `min:"36" type:"string"`

	// The name for the set of featured results.
	FeaturedResultsSetName *string `min:"1" type:"string"`

	// The Unix timestamp when the set of featured results was last updated.
	LastUpdatedTimestamp *int64 `type:"long"`

	// The list of queries for featuring results.
	//
	// Specific queries are mapped to specific documents for featuring in the results.
	// If a query contains an exact match, then one or more specific documents are
	// featured in the results. The exact match applies to the full query. For example,
	// if you only specify 'Kendra', queries such as 'How does kendra semantically
	// rank results?' will not render the featured results. Featured results are
	// designed for specific queries, rather than queries that are too broad in
	// scope.
	QueryTexts []*string `type:"list"`

	// The current status of the set of featured results. When the value is ACTIVE,
	// featured results are ready for use. You can still configure your settings
	// before setting the status to ACTIVE. You can set the status to ACTIVE or
	// INACTIVE using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html)
	// API. The queries you specify for featured results must be unique per featured
	// results set for each index, whether the status is ACTIVE or INACTIVE.
	Status *string `type:"string" enum:"FeaturedResultsSetStatus"`
	// contains filtered or unexported fields
}

A set of featured results that are displayed at the top of your search results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

func (FeaturedResultsSet) GoString added in v1.44.233 

func (s FeaturedResultsSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedResultsSet) SetCreationTimestamp added in v1.44.233 

func (s *FeaturedResultsSet) SetCreationTimestamp(v int64) *FeaturedResultsSet

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*FeaturedResultsSet) SetDescription added in v1.44.233 

func (s *FeaturedResultsSet) SetDescription(v string) *FeaturedResultsSet

SetDescription sets the Description field's value.

func (*FeaturedResultsSet) SetFeaturedDocuments added in v1.44.233 

func (s *FeaturedResultsSet) SetFeaturedDocuments(v []*FeaturedDocument) *FeaturedResultsSet

SetFeaturedDocuments sets the FeaturedDocuments field's value.

func (*FeaturedResultsSet) SetFeaturedResultsSetId added in v1.44.233 

func (s *FeaturedResultsSet) SetFeaturedResultsSetId(v string) *FeaturedResultsSet

SetFeaturedResultsSetId sets the FeaturedResultsSetId field's value.

func (*FeaturedResultsSet) SetFeaturedResultsSetName added in v1.44.233 

func (s *FeaturedResultsSet) SetFeaturedResultsSetName(v string) *FeaturedResultsSet

SetFeaturedResultsSetName sets the FeaturedResultsSetName field's value.

func (*FeaturedResultsSet) SetLastUpdatedTimestamp added in v1.44.233 

func (s *FeaturedResultsSet) SetLastUpdatedTimestamp(v int64) *FeaturedResultsSet

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*FeaturedResultsSet) SetQueryTexts added in v1.44.233 

func (s *FeaturedResultsSet) SetQueryTexts(v []*string) *FeaturedResultsSet

SetQueryTexts sets the QueryTexts field's value.

func (*FeaturedResultsSet) SetStatus added in v1.44.233 

func (s *FeaturedResultsSet) SetStatus(v string) *FeaturedResultsSet

SetStatus sets the Status field's value.

func (FeaturedResultsSet) String added in v1.44.233 

func (s FeaturedResultsSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeaturedResultsSetSummary added in v1.44.233 

type FeaturedResultsSetSummary struct {

	// The Unix timestamp when the set of featured results was created.
	CreationTimestamp *int64 `type:"long"`

	// The identifier of the set of featured results.
	FeaturedResultsSetId *string `min:"36" type:"string"`

	// The name for the set of featured results.
	FeaturedResultsSetName *string `min:"1" type:"string"`

	// The Unix timestamp when the set of featured results was last updated.
	LastUpdatedTimestamp *int64 `type:"long"`

	// The current status of the set of featured results. When the value is ACTIVE,
	// featured results are ready for use. You can still configure your settings
	// before setting the status to ACTIVE. You can set the status to ACTIVE or
	// INACTIVE using the UpdateFeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html)
	// API. The queries you specify for featured results must be unique per featured
	// results set for each index, whether the status is ACTIVE or INACTIVE.
	Status *string `type:"string" enum:"FeaturedResultsSetStatus"`
	// contains filtered or unexported fields
}

Summary information for a set of featured results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

func (FeaturedResultsSetSummary) GoString added in v1.44.233 

func (s FeaturedResultsSetSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeaturedResultsSetSummary) SetCreationTimestamp added in v1.44.233 

func (s *FeaturedResultsSetSummary) SetCreationTimestamp(v int64) *FeaturedResultsSetSummary

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*FeaturedResultsSetSummary) SetFeaturedResultsSetId added in v1.44.233 

func (s *FeaturedResultsSetSummary) SetFeaturedResultsSetId(v string) *FeaturedResultsSetSummary

SetFeaturedResultsSetId sets the FeaturedResultsSetId field's value.

func (*FeaturedResultsSetSummary) SetFeaturedResultsSetName added in v1.44.233 

func (s *FeaturedResultsSetSummary) SetFeaturedResultsSetName(v string) *FeaturedResultsSetSummary

SetFeaturedResultsSetName sets the FeaturedResultsSetName field's value.

func (*FeaturedResultsSetSummary) SetLastUpdatedTimestamp added in v1.44.233 

func (s *FeaturedResultsSetSummary) SetLastUpdatedTimestamp(v int64) *FeaturedResultsSetSummary

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*FeaturedResultsSetSummary) SetStatus added in v1.44.233 

func (s *FeaturedResultsSetSummary) SetStatus(v string) *FeaturedResultsSetSummary

SetStatus sets the Status field's value.

func (FeaturedResultsSetSummary) String added in v1.44.233 

func (s FeaturedResultsSetSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FsxConfiguration added in v1.42.49 

type FsxConfiguration struct {

	// A list of regular expression patterns to exclude certain files in your Amazon
	// FSx file system. Files that match the patterns are excluded from the index.
	// Files that don't match the patterns are included in the index. If a file
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the file isn't included in the index.
	ExclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data
	// source attributes or field names to Amazon Kendra index field names. To create
	// custom fields, use the UpdateIndex API before you map to Amazon FSx fields.
	// For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Amazon FSx data source field names must exist in your Amazon FSx custom
	// metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// The identifier of the Amazon FSx file system.
	//
	// You can find your file system ID on the file system dashboard in the Amazon
	// FSx console. For information on how to create a file system in Amazon FSx
	// console, using Windows File Server as an example, see Amazon FSx Getting
	// started guide (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html).
	//
	// FileSystemId is a required field
	FileSystemId *string `min:"11" type:"string" required:"true"`

	// The Amazon FSx file system type. Windows is currently the only supported
	// type.
	//
	// FileSystemType is a required field
	FileSystemType *string `type:"string" required:"true" enum:"FsxFileSystemType"`

	// A list of regular expression patterns to include certain files in your Amazon
	// FSx file system. Files that match the patterns are included in the index.
	// Files that don't match the patterns are excluded from the index. If a file
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the file isn't included in the index.
	InclusionPatterns []*string `type:"list"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the key-value pairs required to connect to your Amazon FSx file system. Windows
	// is currently the only supported type. The secret must contain a JSON structure
	// with the following keys:
	//
	//    * username—The Active Directory user name, along with the Domain Name
	//    System (DNS) domain name. For example, user@corp.example.com. The Active
	//    Directory user account must have read and mounting access to the Amazon
	//    FSx file system for Windows.
	//
	//    * password—The password of the Active Directory user account with read
	//    and mounting access to the Amazon FSx Windows file system.
	SecretArn *string `min:"1" type:"string"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
	//
	// VpcConfiguration is a required field
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Amazon FSx as your data source.

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the FsxConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

func (FsxConfiguration) GoString added in v1.42.49 

func (s FsxConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FsxConfiguration) SetExclusionPatterns added in v1.42.49 

func (s *FsxConfiguration) SetExclusionPatterns(v []*string) *FsxConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*FsxConfiguration) SetFieldMappings added in v1.42.49 

func (s *FsxConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *FsxConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*FsxConfiguration) SetFileSystemId added in v1.42.49 

func (s *FsxConfiguration) SetFileSystemId(v string) *FsxConfiguration

SetFileSystemId sets the FileSystemId field's value.

func (*FsxConfiguration) SetFileSystemType added in v1.42.49 

func (s *FsxConfiguration) SetFileSystemType(v string) *FsxConfiguration

SetFileSystemType sets the FileSystemType field's value.

func (*FsxConfiguration) SetInclusionPatterns added in v1.42.49 

func (s *FsxConfiguration) SetInclusionPatterns(v []*string) *FsxConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*FsxConfiguration) SetSecretArn added in v1.42.49 

func (s *FsxConfiguration) SetSecretArn(v string) *FsxConfiguration

SetSecretArn sets the SecretArn field's value.

func (*FsxConfiguration) SetVpcConfiguration added in v1.42.49 

func (s *FsxConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *FsxConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (FsxConfiguration) String added in v1.42.49 

func (s FsxConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FsxConfiguration) Validate added in v1.42.49 

func (s *FsxConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQuerySuggestionsInput added in v1.38.50 

type GetQuerySuggestionsInput struct {

	// Configuration information for the document fields/attributes that you want
	// to base query suggestions on.
	AttributeSuggestionsConfig *AttributeSuggestionsGetConfig `type:"structure"`

	// The identifier of the index you want to get query suggestions from.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of query suggestions you want to show to your users.
	MaxSuggestionsCount *int64 `type:"integer"`

	// The text of a user's query to generate query suggestions.
	//
	// A query is suggested if the query prefix matches what a user starts to type
	// as their query.
	//
	// Amazon Kendra does not show any suggestions if a user types fewer than two
	// characters or more than 60 characters. A query must also have at least one
	// search result and contain at least one word of more than four characters.
	//
	// QueryText is a required field
	QueryText *string `type:"string" required:"true"`

	// The suggestions type to base query suggestions on. The suggestion types are
	// query history or document fields/attributes. You can set one type or the
	// other.
	//
	// If you set query history as your suggestions type, Amazon Kendra suggests
	// queries relevant to your users based on popular queries in the query history.
	//
	// If you set document fields/attributes as your suggestions type, Amazon Kendra
	// suggests queries relevant to your users based on the contents of document
	// fields.
	SuggestionTypes []*string `type:"list" enum:"SuggestionType"`
	// contains filtered or unexported fields
}

func (GetQuerySuggestionsInput) GoString added in v1.38.50 

func (s GetQuerySuggestionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuerySuggestionsInput) SetAttributeSuggestionsConfig added in v1.44.255 

func (s *GetQuerySuggestionsInput) SetAttributeSuggestionsConfig(v *AttributeSuggestionsGetConfig) *GetQuerySuggestionsInput

SetAttributeSuggestionsConfig sets the AttributeSuggestionsConfig field's value.

func (*GetQuerySuggestionsInput) SetIndexId added in v1.38.50 

func (s *GetQuerySuggestionsInput) SetIndexId(v string) *GetQuerySuggestionsInput

SetIndexId sets the IndexId field's value.

func (*GetQuerySuggestionsInput) SetMaxSuggestionsCount added in v1.38.50 

func (s *GetQuerySuggestionsInput) SetMaxSuggestionsCount(v int64) *GetQuerySuggestionsInput

SetMaxSuggestionsCount sets the MaxSuggestionsCount field's value.

func (*GetQuerySuggestionsInput) SetQueryText added in v1.38.50 

func (s *GetQuerySuggestionsInput) SetQueryText(v string) *GetQuerySuggestionsInput

SetQueryText sets the QueryText field's value.

func (*GetQuerySuggestionsInput) SetSuggestionTypes added in v1.44.255 

func (s *GetQuerySuggestionsInput) SetSuggestionTypes(v []*string) *GetQuerySuggestionsInput

SetSuggestionTypes sets the SuggestionTypes field's value.

func (GetQuerySuggestionsInput) String added in v1.38.50 

func (s GetQuerySuggestionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuerySuggestionsInput) Validate added in v1.38.50 

func (s *GetQuerySuggestionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQuerySuggestionsOutput added in v1.38.50 

type GetQuerySuggestionsOutput struct {

	// The identifier for a list of query suggestions for an index.
	QuerySuggestionsId *string `min:"1" type:"string"`

	// A list of query suggestions for an index.
	Suggestions []*Suggestion `type:"list"`
	// contains filtered or unexported fields
}

func (GetQuerySuggestionsOutput) GoString added in v1.38.50 

func (s GetQuerySuggestionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuerySuggestionsOutput) SetQuerySuggestionsId added in v1.38.50 

func (s *GetQuerySuggestionsOutput) SetQuerySuggestionsId(v string) *GetQuerySuggestionsOutput

SetQuerySuggestionsId sets the QuerySuggestionsId field's value.

func (*GetQuerySuggestionsOutput) SetSuggestions added in v1.38.50 

func (s *GetQuerySuggestionsOutput) SetSuggestions(v []*Suggestion) *GetQuerySuggestionsOutput

SetSuggestions sets the Suggestions field's value.

func (GetQuerySuggestionsOutput) String added in v1.38.50 

func (s GetQuerySuggestionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSnapshotsInput added in v1.42.17 

type GetSnapshotsInput struct {

	// The identifier of the index to get search metrics data.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The time interval or time window to get search metrics data. The time interval
	// uses the time zone of your index. You can view data in the following time
	// windows:
	//
	//    * THIS_WEEK: The current week, starting on the Sunday and ending on the
	//    day before the current date.
	//
	//    * ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on
	//    the following Saturday.
	//
	//    * TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday
	//    and ending on the following Saturday.
	//
	//    * THIS_MONTH: The current month, starting on the first day of the month
	//    and ending on the day before the current date.
	//
	//    * ONE_MONTH_AGO: The previous month, starting on the first day of the
	//    month and ending on the last day of the month.
	//
	//    * TWO_MONTHS_AGO: The month before the previous month, starting on the
	//    first day of the month and ending on last day of the month.
	//
	// Interval is a required field
	Interval *string `type:"string" required:"true" enum:"Interval"`

	// The maximum number of returned data for the metric.
	MaxResults *int64 `type:"integer"`

	// The metric you want to retrieve. You can specify only one metric per call.
	//
	// For more information about the metrics you can view, see Gaining insights
	// with search analytics (https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html).
	//
	// MetricType is a required field
	MetricType *string `type:"string" required:"true" enum:"MetricType"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of search metrics data.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetSnapshotsInput) GoString added in v1.42.17 

func (s GetSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotsInput) SetIndexId added in v1.42.17 

func (s *GetSnapshotsInput) SetIndexId(v string) *GetSnapshotsInput

SetIndexId sets the IndexId field's value.

func (*GetSnapshotsInput) SetInterval added in v1.42.17 

func (s *GetSnapshotsInput) SetInterval(v string) *GetSnapshotsInput

SetInterval sets the Interval field's value.

func (*GetSnapshotsInput) SetMaxResults added in v1.42.17 

func (s *GetSnapshotsInput) SetMaxResults(v int64) *GetSnapshotsInput

SetMaxResults sets the MaxResults field's value.

func (*GetSnapshotsInput) SetMetricType added in v1.42.17 

func (s *GetSnapshotsInput) SetMetricType(v string) *GetSnapshotsInput

SetMetricType sets the MetricType field's value.

func (*GetSnapshotsInput) SetNextToken added in v1.42.17 

func (s *GetSnapshotsInput) SetNextToken(v string) *GetSnapshotsInput

SetNextToken sets the NextToken field's value.

func (GetSnapshotsInput) String added in v1.42.17 

func (s GetSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotsInput) Validate added in v1.42.17 

func (s *GetSnapshotsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSnapshotsOutput added in v1.42.17 

type GetSnapshotsOutput struct {

	// If the response is truncated, Amazon Kendra returns this token, which you
	// can use in a later request to retrieve the next set of search metrics data.
	NextToken *string `min:"1" type:"string"`

	// The Unix timestamp for the beginning and end of the time window for the search
	// metrics data.
	SnapShotTimeFilter *TimeRange `type:"structure"`

	// The search metrics data. The data returned depends on the metric type you
	// requested.
	SnapshotsData [][]*string `type:"list"`

	// The column headers for the search metrics data.
	SnapshotsDataHeader []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetSnapshotsOutput) GoString added in v1.42.17 

func (s GetSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotsOutput) SetNextToken added in v1.42.17 

func (s *GetSnapshotsOutput) SetNextToken(v string) *GetSnapshotsOutput

SetNextToken sets the NextToken field's value.

func (*GetSnapshotsOutput) SetSnapShotTimeFilter added in v1.42.17 

func (s *GetSnapshotsOutput) SetSnapShotTimeFilter(v *TimeRange) *GetSnapshotsOutput

SetSnapShotTimeFilter sets the SnapShotTimeFilter field's value.

func (*GetSnapshotsOutput) SetSnapshotsData added in v1.42.17 

func (s *GetSnapshotsOutput) SetSnapshotsData(v [][]*string) *GetSnapshotsOutput

SetSnapshotsData sets the SnapshotsData field's value.

func (*GetSnapshotsOutput) SetSnapshotsDataHeader added in v1.42.17 

func (s *GetSnapshotsOutput) SetSnapshotsDataHeader(v []*string) *GetSnapshotsOutput

SetSnapshotsDataHeader sets the SnapshotsDataHeader field's value.

func (GetSnapshotsOutput) String added in v1.42.17 

func (s GetSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GitHubConfiguration added in v1.44.27 

type GitHubConfiguration struct {

	// A list of regular expression patterns to exclude certain file names in your
	// GitHub repository or repositories. File names that match the patterns are
	// excluded from the index. File names that don't match the patterns are included
	// in the index. If a file matches both an exclusion and inclusion pattern,
	// the exclusion pattern takes precedence and the file isn't included in the
	// index.
	ExclusionFileNamePatterns []*string `type:"list"`

	// A list of regular expression patterns to exclude certain file types in your
	// GitHub repository or repositories. File types that match the patterns are
	// excluded from the index. File types that don't match the patterns are included
	// in the index. If a file matches both an exclusion and inclusion pattern,
	// the exclusion pattern takes precedence and the file isn't included in the
	// index.
	ExclusionFileTypePatterns []*string `type:"list"`

	// A list of regular expression patterns to exclude certain folder names in
	// your GitHub repository or repositories. Folder names that match the patterns
	// are excluded from the index. Folder names that don't match the patterns are
	// included in the index. If a folder matches both an exclusion and inclusion
	// pattern, the exclusion pattern takes precedence and the folder isn't included
	// in the index.
	ExclusionFolderNamePatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of GitHub commits to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to GitHub fields. For more
	// information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubCommitConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// Configuration information to include certain types of GitHub content. You
	// can configure to index repository files only, or also include issues and
	// pull requests, comments, and comment attachments.
	GitHubDocumentCrawlProperties *GitHubDocumentCrawlProperties `type:"structure"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of GitHub issue attachments to Amazon Kendra index field names. To
	// create custom fields, use the UpdateIndex API before you map to GitHub fields.
	// For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubIssueAttachmentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of GitHub issue comments to Amazon Kendra index field names. To create
	// custom fields, use the UpdateIndex API before you map to GitHub fields. For
	// more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubIssueCommentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of GitHub issues to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to GitHub fields. For more
	// information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubIssueDocumentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of GitHub pull request comments to Amazon Kendra index field names.
	// To create custom fields, use the UpdateIndex API before you map to GitHub
	// fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubPullRequestCommentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of GitHub pull request attachments to Amazon Kendra index field names.
	// To create custom fields, use the UpdateIndex API before you map to GitHub
	// fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubPullRequestDocumentAttachmentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of GitHub pull requests to Amazon Kendra index field names. To create
	// custom fields, use the UpdateIndex API before you map to GitHub fields. For
	// more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubPullRequestDocumentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map GitHub repository
	// attributes or field names to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to GitHub fields. For more
	// information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The GitHub data source field names must exist in your GitHub custom metadata.
	GitHubRepositoryConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain file names in your
	// GitHub repository or repositories. File names that match the patterns are
	// included in the index. File names that don't match the patterns are excluded
	// from the index. If a file matches both an inclusion and exclusion pattern,
	// the exclusion pattern takes precedence and the file isn't included in the
	// index.
	InclusionFileNamePatterns []*string `type:"list"`

	// A list of regular expression patterns to include certain file types in your
	// GitHub repository or repositories. File types that match the patterns are
	// included in the index. File types that don't match the patterns are excluded
	// from the index. If a file matches both an inclusion and exclusion pattern,
	// the exclusion pattern takes precedence and the file isn't included in the
	// index.
	InclusionFileTypePatterns []*string `type:"list"`

	// A list of regular expression patterns to include certain folder names in
	// your GitHub repository or repositories. Folder names that match the patterns
	// are included in the index. Folder names that don't match the patterns are
	// excluded from the index. If a folder matches both an inclusion and exclusion
	// pattern, the exclusion pattern takes precedence and the folder isn't included
	// in the index.
	InclusionFolderNamePatterns []*string `type:"list"`

	// Configuration information to connect to GitHub Enterprise Server (on premises).
	OnPremiseConfiguration *OnPremiseConfiguration `type:"structure"`

	// A list of names of the specific repositories you want to index.
	RepositoryFilter []*string `type:"list"`

	// Configuration information to connect to GitHub Enterprise Cloud (SaaS).
	SaaSConfiguration *SaaSConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the key-value pairs required to connect to your GitHub. The secret must contain
	// a JSON structure with the following keys:
	//
	//    * personalToken—The access token created in GitHub. For more information
	//    on creating a token in GitHub, see Using a GitHub data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The type of GitHub service you want to connect to—GitHub Enterprise Cloud
	// (SaaS) or GitHub Enterprise Server (on premises).
	Type *string `type:"string" enum:"Type"`

	// TRUE to use the GitHub change log to determine which documents require updating
	// in the index. Depending on the GitHub change log's size, it may take longer
	// for Amazon Kendra to use the change log than to scan all of your documents
	// in GitHub.
	UseChangeLog *bool `type:"boolean"`

	// Configuration information of an Amazon Virtual Private Cloud to connect to
	// your GitHub. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to GitHub as your data source.

Amazon Kendra now supports an upgraded GitHub connector.

You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the GitHubConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

func (GitHubConfiguration) GoString added in v1.44.27 

func (s GitHubConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GitHubConfiguration) SetExclusionFileNamePatterns added in v1.44.27 

func (s *GitHubConfiguration) SetExclusionFileNamePatterns(v []*string) *GitHubConfiguration

SetExclusionFileNamePatterns sets the ExclusionFileNamePatterns field's value.

func (*GitHubConfiguration) SetExclusionFileTypePatterns added in v1.44.27 

func (s *GitHubConfiguration) SetExclusionFileTypePatterns(v []*string) *GitHubConfiguration

SetExclusionFileTypePatterns sets the ExclusionFileTypePatterns field's value.

func (*GitHubConfiguration) SetExclusionFolderNamePatterns added in v1.44.27 

func (s *GitHubConfiguration) SetExclusionFolderNamePatterns(v []*string) *GitHubConfiguration

SetExclusionFolderNamePatterns sets the ExclusionFolderNamePatterns field's value.

func (*GitHubConfiguration) SetGitHubCommitConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubCommitConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubCommitConfigurationFieldMappings sets the GitHubCommitConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubDocumentCrawlProperties added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubDocumentCrawlProperties(v *GitHubDocumentCrawlProperties) *GitHubConfiguration

SetGitHubDocumentCrawlProperties sets the GitHubDocumentCrawlProperties field's value.

func (*GitHubConfiguration) SetGitHubIssueAttachmentConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubIssueAttachmentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubIssueAttachmentConfigurationFieldMappings sets the GitHubIssueAttachmentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubIssueCommentConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubIssueCommentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubIssueCommentConfigurationFieldMappings sets the GitHubIssueCommentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubIssueDocumentConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubIssueDocumentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubIssueDocumentConfigurationFieldMappings sets the GitHubIssueDocumentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubPullRequestCommentConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubPullRequestCommentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubPullRequestCommentConfigurationFieldMappings sets the GitHubPullRequestCommentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubPullRequestDocumentAttachmentConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubPullRequestDocumentAttachmentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubPullRequestDocumentAttachmentConfigurationFieldMappings sets the GitHubPullRequestDocumentAttachmentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubPullRequestDocumentConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubPullRequestDocumentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubPullRequestDocumentConfigurationFieldMappings sets the GitHubPullRequestDocumentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubRepositoryConfigurationFieldMappings added in v1.44.27 

func (s *GitHubConfiguration) SetGitHubRepositoryConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubRepositoryConfigurationFieldMappings sets the GitHubRepositoryConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetInclusionFileNamePatterns added in v1.44.27 

func (s *GitHubConfiguration) SetInclusionFileNamePatterns(v []*string) *GitHubConfiguration

SetInclusionFileNamePatterns sets the InclusionFileNamePatterns field's value.

func (*GitHubConfiguration) SetInclusionFileTypePatterns added in v1.44.27 

func (s *GitHubConfiguration) SetInclusionFileTypePatterns(v []*string) *GitHubConfiguration

SetInclusionFileTypePatterns sets the InclusionFileTypePatterns field's value.

func (*GitHubConfiguration) SetInclusionFolderNamePatterns added in v1.44.27 

func (s *GitHubConfiguration) SetInclusionFolderNamePatterns(v []*string) *GitHubConfiguration

SetInclusionFolderNamePatterns sets the InclusionFolderNamePatterns field's value.

func (*GitHubConfiguration) SetOnPremiseConfiguration added in v1.44.27 

func (s *GitHubConfiguration) SetOnPremiseConfiguration(v *OnPremiseConfiguration) *GitHubConfiguration

SetOnPremiseConfiguration sets the OnPremiseConfiguration field's value.

func (*GitHubConfiguration) SetRepositoryFilter added in v1.44.27 

func (s *GitHubConfiguration) SetRepositoryFilter(v []*string) *GitHubConfiguration

SetRepositoryFilter sets the RepositoryFilter field's value.

func (*GitHubConfiguration) SetSaaSConfiguration added in v1.44.27 

func (s *GitHubConfiguration) SetSaaSConfiguration(v *SaaSConfiguration) *GitHubConfiguration

SetSaaSConfiguration sets the SaaSConfiguration field's value.

func (*GitHubConfiguration) SetSecretArn added in v1.44.27 

func (s *GitHubConfiguration) SetSecretArn(v string) *GitHubConfiguration

SetSecretArn sets the SecretArn field's value.

func (*GitHubConfiguration) SetType added in v1.44.27 

func (s *GitHubConfiguration) SetType(v string) *GitHubConfiguration

SetType sets the Type field's value.

func (*GitHubConfiguration) SetUseChangeLog added in v1.44.27 

func (s *GitHubConfiguration) SetUseChangeLog(v bool) *GitHubConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (*GitHubConfiguration) SetVpcConfiguration added in v1.44.27 

func (s *GitHubConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *GitHubConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (GitHubConfiguration) String added in v1.44.27 

func (s GitHubConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GitHubConfiguration) Validate added in v1.44.27 

func (s *GitHubConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GitHubDocumentCrawlProperties added in v1.44.27 

type GitHubDocumentCrawlProperties struct {

	// TRUE to index all issues within a repository.
	CrawlIssue *bool `type:"boolean"`

	// TRUE to index all comments on issues.
	CrawlIssueComment *bool `type:"boolean"`

	// TRUE to include all comment attachments for issues.
	CrawlIssueCommentAttachment *bool `type:"boolean"`

	// TRUE to index all pull requests within a repository.
	CrawlPullRequest *bool `type:"boolean"`

	// TRUE to index all comments on pull requests.
	CrawlPullRequestComment *bool `type:"boolean"`

	// TRUE to include all comment attachments for pull requests.
	CrawlPullRequestCommentAttachment *bool `type:"boolean"`

	// TRUE to index all files with a repository.
	CrawlRepositoryDocuments *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

func (GitHubDocumentCrawlProperties) GoString added in v1.44.27 

func (s GitHubDocumentCrawlProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GitHubDocumentCrawlProperties) SetCrawlIssue added in v1.44.27 

func (s *GitHubDocumentCrawlProperties) SetCrawlIssue(v bool) *GitHubDocumentCrawlProperties

SetCrawlIssue sets the CrawlIssue field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlIssueComment added in v1.44.27 

func (s *GitHubDocumentCrawlProperties) SetCrawlIssueComment(v bool) *GitHubDocumentCrawlProperties

SetCrawlIssueComment sets the CrawlIssueComment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlIssueCommentAttachment added in v1.44.27 

func (s *GitHubDocumentCrawlProperties) SetCrawlIssueCommentAttachment(v bool) *GitHubDocumentCrawlProperties

SetCrawlIssueCommentAttachment sets the CrawlIssueCommentAttachment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlPullRequest added in v1.44.27 

func (s *GitHubDocumentCrawlProperties) SetCrawlPullRequest(v bool) *GitHubDocumentCrawlProperties

SetCrawlPullRequest sets the CrawlPullRequest field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlPullRequestComment added in v1.44.27 

func (s *GitHubDocumentCrawlProperties) SetCrawlPullRequestComment(v bool) *GitHubDocumentCrawlProperties

SetCrawlPullRequestComment sets the CrawlPullRequestComment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlPullRequestCommentAttachment added in v1.44.27 

func (s *GitHubDocumentCrawlProperties) SetCrawlPullRequestCommentAttachment(v bool) *GitHubDocumentCrawlProperties

SetCrawlPullRequestCommentAttachment sets the CrawlPullRequestCommentAttachment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlRepositoryDocuments added in v1.44.27 

func (s *GitHubDocumentCrawlProperties) SetCrawlRepositoryDocuments(v bool) *GitHubDocumentCrawlProperties

SetCrawlRepositoryDocuments sets the CrawlRepositoryDocuments field's value.

func (GitHubDocumentCrawlProperties) String added in v1.44.27 

func (s GitHubDocumentCrawlProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GoogleDriveConfiguration added in v1.36.4 

type GoogleDriveConfiguration struct {

	// A list of MIME types to exclude from the index. All documents matching the
	// specified MIME type are excluded.
	//
	// For a list of MIME types, see Using a Google Workspace Drive data source
	// (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
	ExcludeMimeTypes []*string `type:"list"`

	// A list of identifiers or shared drives to exclude from the index. All files
	// and folders stored on the shared drive are excluded.
	ExcludeSharedDrives []*string `type:"list"`

	// A list of email addresses of the users. Documents owned by these users are
	// excluded from the index. Documents shared with excluded users are indexed
	// unless they are excluded in another way.
	ExcludeUserAccounts []*string `type:"list"`

	// A list of regular expression patterns to exclude certain items in your Google
	// Drive, including shared drives and users' My Drives. Items that match the
	// patterns are excluded from the index. Items that don't match the patterns
	// are included in the index. If an item matches both an inclusion and exclusion
	// pattern, the exclusion pattern takes precedence and the item isn't included
	// in the index.
	ExclusionPatterns []*string `type:"list"`

	// Maps Google Drive data source attributes or field names to Amazon Kendra
	// index field names. To create custom fields, use the UpdateIndex API before
	// you map to Google Drive fields. For more information, see Mapping data source
	// fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Google Drive data source field names must exist in your Google Drive
	// custom metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain items in your Google
	// Drive, including shared drives and users' My Drives. Items that match the
	// patterns are included in the index. Items that don't match the patterns are
	// excluded from the index. If an item matches both an inclusion and exclusion
	// pattern, the exclusion pattern takes precedence and the item isn't included
	// in the index.
	InclusionPatterns []*string `type:"list"`

	// The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the
	// credentials required to connect to Google Drive. For more information, see
	// Using a Google Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Google Drive as your data source.

func (GoogleDriveConfiguration) GoString added in v1.36.4 

func (s GoogleDriveConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GoogleDriveConfiguration) SetExcludeMimeTypes added in v1.36.4 

func (s *GoogleDriveConfiguration) SetExcludeMimeTypes(v []*string) *GoogleDriveConfiguration

SetExcludeMimeTypes sets the ExcludeMimeTypes field's value.

func (*GoogleDriveConfiguration) SetExcludeSharedDrives added in v1.36.4 

func (s *GoogleDriveConfiguration) SetExcludeSharedDrives(v []*string) *GoogleDriveConfiguration

SetExcludeSharedDrives sets the ExcludeSharedDrives field's value.

func (*GoogleDriveConfiguration) SetExcludeUserAccounts added in v1.36.4 

func (s *GoogleDriveConfiguration) SetExcludeUserAccounts(v []*string) *GoogleDriveConfiguration

SetExcludeUserAccounts sets the ExcludeUserAccounts field's value.

func (*GoogleDriveConfiguration) SetExclusionPatterns added in v1.36.4 

func (s *GoogleDriveConfiguration) SetExclusionPatterns(v []*string) *GoogleDriveConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*GoogleDriveConfiguration) SetFieldMappings added in v1.36.4 

func (s *GoogleDriveConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *GoogleDriveConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*GoogleDriveConfiguration) SetInclusionPatterns added in v1.36.4 

func (s *GoogleDriveConfiguration) SetInclusionPatterns(v []*string) *GoogleDriveConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*GoogleDriveConfiguration) SetSecretArn added in v1.36.4 

func (s *GoogleDriveConfiguration) SetSecretArn(v string) *GoogleDriveConfiguration

SetSecretArn sets the SecretArn field's value.

func (GoogleDriveConfiguration) String added in v1.36.4 

func (s GoogleDriveConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GoogleDriveConfiguration) Validate added in v1.36.4 

func (s *GoogleDriveConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GroupMembers added in v1.39.5 

type GroupMembers struct {

	// A list of sub groups that belong to a group. For example, the sub groups
	// "Research", "Engineering", and "Sales and Marketing" all belong to the group
	// "Company".
	MemberGroups []*MemberGroup `min:"1" type:"list"`

	// A list of users that belong to a group. For example, a list of interns all
	// belong to the "Interns" group.
	MemberUsers []*MemberUser `min:"1" type:"list"`

	// If you have more than 1000 users and/or sub groups for a single group, you
	// need to provide the path to the S3 file that lists your users and sub groups
	// for a group. Your sub groups can contain more than 1000 users, but the list
	// of sub groups that belong to a group (and/or users) must be no more than
	// 1000.
	//
	// You can download this example S3 file (https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip)
	// that uses the correct format for listing group members. Note, dataSourceId
	// is optional. The value of type for a group is always GROUP and for a user
	// it is always USER.
	S3PathforGroupMembers *S3Path `type:"structure"`
	// contains filtered or unexported fields
}

A list of users or sub groups that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

func (GroupMembers) GoString added in v1.39.5 

func (s GroupMembers) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupMembers) SetMemberGroups added in v1.39.5 

func (s *GroupMembers) SetMemberGroups(v []*MemberGroup) *GroupMembers

SetMemberGroups sets the MemberGroups field's value.

func (*GroupMembers) SetMemberUsers added in v1.39.5 

func (s *GroupMembers) SetMemberUsers(v []*MemberUser) *GroupMembers

SetMemberUsers sets the MemberUsers field's value.

func (*GroupMembers) SetS3PathforGroupMembers added in v1.39.5 

func (s *GroupMembers) SetS3PathforGroupMembers(v *S3Path) *GroupMembers

SetS3PathforGroupMembers sets the S3PathforGroupMembers field's value.

func (GroupMembers) String added in v1.39.5 

func (s GroupMembers) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupMembers) Validate added in v1.39.5 

func (s *GroupMembers) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GroupOrderingIdSummary added in v1.39.5 

type GroupOrderingIdSummary struct {

	// The reason an action could not be processed. An action can be a PUT or DELETE
	// action for mapping users to their groups.
	FailureReason *string `min:"1" type:"string"`

	// The Unix timestamp when an action was last updated. An action can be a PUT
	// or DELETE action for mapping users to their groups.
	LastUpdatedAt *time.Time `type:"timestamp"`

	// The order in which actions should complete processing. An action can be a
	// PUT or DELETE action for mapping users to their groups.
	OrderingId *int64 `type:"long"`

	// The Unix timestamp when an action was received by Amazon Kendra. An action
	// can be a PUT or DELETE action for mapping users to their groups.
	ReceivedAt *time.Time `type:"timestamp"`

	// The current processing status of actions for mapping users to their groups.
	// The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.
	Status *string `type:"string" enum:"PrincipalMappingStatus"`
	// contains filtered or unexported fields
}

Summary information on the processing of PUT and DELETE actions for mapping users to their groups.

func (GroupOrderingIdSummary) GoString added in v1.39.5 

func (s GroupOrderingIdSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupOrderingIdSummary) SetFailureReason added in v1.39.5 

func (s *GroupOrderingIdSummary) SetFailureReason(v string) *GroupOrderingIdSummary

SetFailureReason sets the FailureReason field's value.

func (*GroupOrderingIdSummary) SetLastUpdatedAt added in v1.39.5 

func (s *GroupOrderingIdSummary) SetLastUpdatedAt(v time.Time) *GroupOrderingIdSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*GroupOrderingIdSummary) SetOrderingId added in v1.39.5 

func (s *GroupOrderingIdSummary) SetOrderingId(v int64) *GroupOrderingIdSummary

SetOrderingId sets the OrderingId field's value.

func (*GroupOrderingIdSummary) SetReceivedAt added in v1.39.5 

func (s *GroupOrderingIdSummary) SetReceivedAt(v time.Time) *GroupOrderingIdSummary

SetReceivedAt sets the ReceivedAt field's value.

func (*GroupOrderingIdSummary) SetStatus added in v1.39.5 

func (s *GroupOrderingIdSummary) SetStatus(v string) *GroupOrderingIdSummary

SetStatus sets the Status field's value.

func (GroupOrderingIdSummary) String added in v1.39.5 

func (s GroupOrderingIdSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GroupSummary added in v1.39.5 

type GroupSummary struct {

	// The identifier of the group you want group summary information on.
	GroupId *string `min:"1" type:"string"`

	// The timestamp identifier used for the latest PUT or DELETE action.
	OrderingId *int64 `type:"long"`
	// contains filtered or unexported fields
}

Summary information for groups.

func (GroupSummary) GoString added in v1.39.5 

func (s GroupSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupSummary) SetGroupId added in v1.39.5 

func (s *GroupSummary) SetGroupId(v string) *GroupSummary

SetGroupId sets the GroupId field's value.

func (*GroupSummary) SetOrderingId added in v1.39.5 

func (s *GroupSummary) SetOrderingId(v int64) *GroupSummary

SetOrderingId sets the OrderingId field's value.

func (GroupSummary) String added in v1.39.5 

func (s GroupSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HierarchicalPrincipal added in v1.39.5 

type HierarchicalPrincipal struct {

	// A list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html)
	// lists that define the hierarchy for which documents users should have access
	// to. Each hierarchical list specifies which user or group has allow or deny
	// access for each document.
	//
	// PrincipalList is a required field
	PrincipalList []*Principal `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information to define the hierarchy for which documents users should have access to.

func (HierarchicalPrincipal) GoString added in v1.39.5 

func (s HierarchicalPrincipal) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HierarchicalPrincipal) SetPrincipalList added in v1.39.5 

func (s *HierarchicalPrincipal) SetPrincipalList(v []*Principal) *HierarchicalPrincipal

SetPrincipalList sets the PrincipalList field's value.

func (HierarchicalPrincipal) String added in v1.39.5 

func (s HierarchicalPrincipal) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HierarchicalPrincipal) Validate added in v1.39.5 

func (s *HierarchicalPrincipal) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Highlight 

type Highlight struct {

	// The zero-based location in the response string where the highlight starts.
	//
	// BeginOffset is a required field
	BeginOffset *int64 `type:"integer" required:"true"`

	// The zero-based location in the response string where the highlight ends.
	//
	// EndOffset is a required field
	EndOffset *int64 `type:"integer" required:"true"`

	// Indicates whether the response is the best response. True if this is the
	// best response; otherwise, false.
	TopAnswer *bool `type:"boolean"`

	// The highlight type.
	Type *string `type:"string" enum:"HighlightType"`
	// contains filtered or unexported fields
}

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

func (Highlight) GoString 

func (s Highlight) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Highlight) SetBeginOffset 

func (s *Highlight) SetBeginOffset(v int64) *Highlight

SetBeginOffset sets the BeginOffset field's value.

func (*Highlight) SetEndOffset 

func (s *Highlight) SetEndOffset(v int64) *Highlight

SetEndOffset sets the EndOffset field's value.

func (*Highlight) SetTopAnswer 

func (s *Highlight) SetTopAnswer(v bool) *Highlight

SetTopAnswer sets the TopAnswer field's value.

func (*Highlight) SetType added in v1.36.6 

func (s *Highlight) SetType(v string) *Highlight

SetType sets the Type field's value.

func (Highlight) String 

func (s Highlight) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HookConfiguration added in v1.42.17 

type HookConfiguration struct {

	// The condition used for when a Lambda function should be invoked.
	//
	// For example, you can specify a condition that if there are empty date-time
	// values, then Amazon Kendra should invoke a function that inserts the current
	// date-time.
	InvocationCondition *DocumentAttributeCondition `type:"structure"`

	// The Amazon Resource Name (ARN) of a role with permission to run a Lambda
	// function during ingestion. For more information, see IAM roles for Amazon
	// Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	//
	// LambdaArn is a required field
	LambdaArn *string `min:"1" type:"string" required:"true"`

	// Stores the original, raw documents or the structured, parsed documents before
	// and after altering them. For more information, see Data contracts for Lambda
	// functions (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda).
	//
	// S3Bucket is a required field
	S3Bucket *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html). You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).

func (HookConfiguration) GoString added in v1.42.17 

func (s HookConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HookConfiguration) SetInvocationCondition added in v1.42.17 

func (s *HookConfiguration) SetInvocationCondition(v *DocumentAttributeCondition) *HookConfiguration

SetInvocationCondition sets the InvocationCondition field's value.

func (*HookConfiguration) SetLambdaArn added in v1.42.17 

func (s *HookConfiguration) SetLambdaArn(v string) *HookConfiguration

SetLambdaArn sets the LambdaArn field's value.

func (*HookConfiguration) SetS3Bucket added in v1.42.17 

func (s *HookConfiguration) SetS3Bucket(v string) *HookConfiguration

SetS3Bucket sets the S3Bucket field's value.

func (HookConfiguration) String added in v1.42.17 

func (s HookConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HookConfiguration) Validate added in v1.42.17 

func (s *HookConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IndexConfigurationSummary 

type IndexConfigurationSummary struct {

	// The Unix timestamp when the index was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `type:"timestamp" required:"true"`

	// Indicates whether the index is a Enterprise Edition index or a Developer
	// Edition index.
	Edition *string `type:"string" enum:"IndexEdition"`

	// A identifier for the index. Use this to identify the index when you are using
	// APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
	Id *string `min:"36" type:"string"`

	// The name of the index.
	Name *string `min:"1" type:"string"`

	// The current status of the index. When the status is ACTIVE, the index is
	// ready to search.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"IndexStatus"`

	// The Unix timestamp when the index was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Summary information on the configuration of an index.

func (IndexConfigurationSummary) GoString 

func (s IndexConfigurationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IndexConfigurationSummary) SetCreatedAt 

func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary

SetCreatedAt sets the CreatedAt field's value.

func (*IndexConfigurationSummary) SetEdition added in v1.30.25 

func (s *IndexConfigurationSummary) SetEdition(v string) *IndexConfigurationSummary

SetEdition sets the Edition field's value.

func (*IndexConfigurationSummary) SetId 

func (s *IndexConfigurationSummary) SetId(v string) *IndexConfigurationSummary

SetId sets the Id field's value.

func (*IndexConfigurationSummary) SetName 

func (s *IndexConfigurationSummary) SetName(v string) *IndexConfigurationSummary

SetName sets the Name field's value.

func (*IndexConfigurationSummary) SetStatus 

func (s *IndexConfigurationSummary) SetStatus(v string) *IndexConfigurationSummary

SetStatus sets the Status field's value.

func (*IndexConfigurationSummary) SetUpdatedAt 

func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (IndexConfigurationSummary) String 

func (s IndexConfigurationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IndexStatistics 

type IndexStatistics struct {

	// The number of question and answer topics in the index.
	//
	// FaqStatistics is a required field
	FaqStatistics *FaqStatistics `type:"structure" required:"true"`

	// The number of text documents indexed.
	//
	// TextDocumentStatistics is a required field
	TextDocumentStatistics *TextDocumentStatistics `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the number of documents and the number of questions and answers in an index.

func (IndexStatistics) GoString 

func (s IndexStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IndexStatistics) SetFaqStatistics 

func (s *IndexStatistics) SetFaqStatistics(v *FaqStatistics) *IndexStatistics

SetFaqStatistics sets the FaqStatistics field's value.

func (*IndexStatistics) SetTextDocumentStatistics 

func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics

SetTextDocumentStatistics sets the TextDocumentStatistics field's value.

func (IndexStatistics) String 

func (s IndexStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InlineCustomDocumentEnrichmentConfiguration added in v1.42.17 

type InlineCustomDocumentEnrichmentConfiguration struct {

	// Configuration of the condition used for the target document attribute or
	// metadata field when ingesting documents into Amazon Kendra.
	Condition *DocumentAttributeCondition `type:"structure"`

	// TRUE to delete content if the condition used for the target attribute is
	// met.
	DocumentContentDeletion *bool `type:"boolean"`

	// Configuration of the target document attribute or metadata field when ingesting
	// documents into Amazon Kendra. You can also include a value.
	Target *DocumentAttributeTarget `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html).

For more information, see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).

func (InlineCustomDocumentEnrichmentConfiguration) GoString added in v1.42.17 

func (s InlineCustomDocumentEnrichmentConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InlineCustomDocumentEnrichmentConfiguration) SetCondition added in v1.42.17 

func (s *InlineCustomDocumentEnrichmentConfiguration) SetCondition(v *DocumentAttributeCondition) *InlineCustomDocumentEnrichmentConfiguration

SetCondition sets the Condition field's value.

func (*InlineCustomDocumentEnrichmentConfiguration) SetDocumentContentDeletion added in v1.42.17 

func (s *InlineCustomDocumentEnrichmentConfiguration) SetDocumentContentDeletion(v bool) *InlineCustomDocumentEnrichmentConfiguration

SetDocumentContentDeletion sets the DocumentContentDeletion field's value.

func (*InlineCustomDocumentEnrichmentConfiguration) SetTarget added in v1.42.17 

func (s *InlineCustomDocumentEnrichmentConfiguration) SetTarget(v *DocumentAttributeTarget) *InlineCustomDocumentEnrichmentConfiguration

SetTarget sets the Target field's value.

func (InlineCustomDocumentEnrichmentConfiguration) String added in v1.42.17 

func (s InlineCustomDocumentEnrichmentConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InlineCustomDocumentEnrichmentConfiguration) Validate added in v1.42.17 

func (s *InlineCustomDocumentEnrichmentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServerException added in v1.28.0 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

func (*InternalServerException) Code added in v1.28.0 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message added in v1.28.0 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.28.0 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.42.17 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input to the request is not valid. Please provide the correct input and try again.

func (*InvalidRequestException) Code added in v1.42.17 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.42.17 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.42.17 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.42.17 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.42.17 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.42.17 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.42.17 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.42.17 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JiraConfiguration added in v1.44.13 

type JiraConfiguration struct {

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Jira attachments to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Jira fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Jira data source field names must exist in your Jira custom metadata.
	AttachmentFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Jira comments to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Jira fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Jira data source field names must exist in your Jira custom metadata.
	CommentFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to exclude certain file paths, file
	// names, and file types in your Jira data source. Files that match the patterns
	// are excluded from the index. Files that don’t match the patterns are included
	// in the index. If a file matches both an inclusion pattern and an exclusion
	// pattern, the exclusion pattern takes precedence and the file isn't included
	// in the index.
	ExclusionPatterns []*string `type:"list"`

	// A list of regular expression patterns to include certain file paths, file
	// names, and file types in your Jira data source. Files that match the patterns
	// are included in the index. Files that don't match the patterns are excluded
	// from the index. If a file matches both an inclusion pattern and an exclusion
	// pattern, the exclusion pattern takes precedence and the file isn't included
	// in the index.
	InclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Jira issues to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Jira fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Jira data source field names must exist in your Jira custom metadata.
	IssueFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// Specify whether to crawl comments, attachments, and work logs. You can specify
	// one or more of these options.
	IssueSubEntityFilter []*string `type:"list" enum:"IssueSubEntity"`

	// Specify which issue types to crawl in your Jira data source. You can specify
	// one or more of these options to crawl.
	IssueType []*string `type:"list"`

	// The URL of the Jira account. For example, company.atlassian.net.
	//
	// JiraAccountUrl is a required field
	JiraAccountUrl *string `min:"1" type:"string" required:"true"`

	// Specify which projects to crawl in your Jira data source. You can specify
	// one or more Jira project IDs.
	Project []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Jira projects to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Jira fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Jira data source field names must exist in your Jira custom metadata.
	ProjectFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the
	// key-value pairs required to connect to your Jira data source. The secret
	// must contain a JSON structure with the following keys:
	//
	//    * jiraId—The Jira user name or email.
	//
	//    * jiraCredentials—The Jira API token. For more information, see Using
	//    a Jira data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// Specify which statuses to crawl in your Jira data source. You can specify
	// one or more of these options to crawl.
	Status []*string `type:"list"`

	// TRUE to use the Jira change log to determine which documents require updating
	// in the index. Depending on the change log's size, it may take longer for
	// Amazon Kendra to use the change log than to scan all of your documents in
	// Jira.
	UseChangeLog *bool `type:"boolean"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your Jira. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Jira work logs to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Jira fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Jira data source field names must exist in your Jira custom metadata.
	WorkLogFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Jira as your data source.

func (JiraConfiguration) GoString added in v1.44.13 

func (s JiraConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JiraConfiguration) SetAttachmentFieldMappings added in v1.44.13 

func (s *JiraConfiguration) SetAttachmentFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value.

func (*JiraConfiguration) SetCommentFieldMappings added in v1.44.13 

func (s *JiraConfiguration) SetCommentFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetCommentFieldMappings sets the CommentFieldMappings field's value.

func (*JiraConfiguration) SetExclusionPatterns added in v1.44.13 

func (s *JiraConfiguration) SetExclusionPatterns(v []*string) *JiraConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*JiraConfiguration) SetInclusionPatterns added in v1.44.13 

func (s *JiraConfiguration) SetInclusionPatterns(v []*string) *JiraConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*JiraConfiguration) SetIssueFieldMappings added in v1.44.13 

func (s *JiraConfiguration) SetIssueFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetIssueFieldMappings sets the IssueFieldMappings field's value.

func (*JiraConfiguration) SetIssueSubEntityFilter added in v1.44.13 

func (s *JiraConfiguration) SetIssueSubEntityFilter(v []*string) *JiraConfiguration

SetIssueSubEntityFilter sets the IssueSubEntityFilter field's value.

func (*JiraConfiguration) SetIssueType added in v1.44.13 

func (s *JiraConfiguration) SetIssueType(v []*string) *JiraConfiguration

SetIssueType sets the IssueType field's value.

func (*JiraConfiguration) SetJiraAccountUrl added in v1.44.13 

func (s *JiraConfiguration) SetJiraAccountUrl(v string) *JiraConfiguration

SetJiraAccountUrl sets the JiraAccountUrl field's value.

func (*JiraConfiguration) SetProject added in v1.44.13 

func (s *JiraConfiguration) SetProject(v []*string) *JiraConfiguration

SetProject sets the Project field's value.

func (*JiraConfiguration) SetProjectFieldMappings added in v1.44.13 

func (s *JiraConfiguration) SetProjectFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetProjectFieldMappings sets the ProjectFieldMappings field's value.

func (*JiraConfiguration) SetSecretArn added in v1.44.13 

func (s *JiraConfiguration) SetSecretArn(v string) *JiraConfiguration

SetSecretArn sets the SecretArn field's value.

func (*JiraConfiguration) SetStatus added in v1.44.13 

func (s *JiraConfiguration) SetStatus(v []*string) *JiraConfiguration

SetStatus sets the Status field's value.

func (*JiraConfiguration) SetUseChangeLog added in v1.44.13 

func (s *JiraConfiguration) SetUseChangeLog(v bool) *JiraConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (*JiraConfiguration) SetVpcConfiguration added in v1.44.13 

func (s *JiraConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *JiraConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*JiraConfiguration) SetWorkLogFieldMappings added in v1.44.13 

func (s *JiraConfiguration) SetWorkLogFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetWorkLogFieldMappings sets the WorkLogFieldMappings field's value.

func (JiraConfiguration) String added in v1.44.13 

func (s JiraConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JiraConfiguration) Validate added in v1.44.13 

func (s *JiraConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JsonTokenTypeConfiguration added in v1.35.22 

type JsonTokenTypeConfiguration struct {

	// The group attribute field.
	//
	// GroupAttributeField is a required field
	GroupAttributeField *string `min:"1" type:"string" required:"true"`

	// The user name attribute field.
	//
	// UserNameAttributeField is a required field
	UserNameAttributeField *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information for the JSON token type.

func (JsonTokenTypeConfiguration) GoString added in v1.35.22 

func (s JsonTokenTypeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JsonTokenTypeConfiguration) SetGroupAttributeField added in v1.35.22 

func (s *JsonTokenTypeConfiguration) SetGroupAttributeField(v string) *JsonTokenTypeConfiguration

SetGroupAttributeField sets the GroupAttributeField field's value.

func (*JsonTokenTypeConfiguration) SetUserNameAttributeField added in v1.35.22 

func (s *JsonTokenTypeConfiguration) SetUserNameAttributeField(v string) *JsonTokenTypeConfiguration

SetUserNameAttributeField sets the UserNameAttributeField field's value.

func (JsonTokenTypeConfiguration) String added in v1.35.22 

func (s JsonTokenTypeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JsonTokenTypeConfiguration) Validate added in v1.35.22 

func (s *JsonTokenTypeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JwtTokenTypeConfiguration added in v1.35.22 

type JwtTokenTypeConfiguration struct {

	// The regular expression that identifies the claim.
	ClaimRegex *string `min:"1" type:"string"`

	// The group attribute field.
	GroupAttributeField *string `min:"1" type:"string"`

	// The issuer of the token.
	Issuer *string `min:"1" type:"string"`

	// The location of the key.
	//
	// KeyLocation is a required field
	KeyLocation *string `type:"string" required:"true" enum:"KeyLocation"`

	// The Amazon Resource Name (arn) of the secret.
	SecretManagerArn *string `type:"string"`

	// The signing key URL.
	URL *string `min:"1" type:"string"`

	// The user name attribute field.
	UserNameAttributeField *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides the configuration information for the JWT token type.

func (JwtTokenTypeConfiguration) GoString added in v1.35.22 

func (s JwtTokenTypeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JwtTokenTypeConfiguration) SetClaimRegex added in v1.35.22 

func (s *JwtTokenTypeConfiguration) SetClaimRegex(v string) *JwtTokenTypeConfiguration

SetClaimRegex sets the ClaimRegex field's value.

func (*JwtTokenTypeConfiguration) SetGroupAttributeField added in v1.35.22 

func (s *JwtTokenTypeConfiguration) SetGroupAttributeField(v string) *JwtTokenTypeConfiguration

SetGroupAttributeField sets the GroupAttributeField field's value.

func (*JwtTokenTypeConfiguration) SetIssuer added in v1.35.22 

func (s *JwtTokenTypeConfiguration) SetIssuer(v string) *JwtTokenTypeConfiguration

SetIssuer sets the Issuer field's value.

func (*JwtTokenTypeConfiguration) SetKeyLocation added in v1.35.22 

func (s *JwtTokenTypeConfiguration) SetKeyLocation(v string) *JwtTokenTypeConfiguration

SetKeyLocation sets the KeyLocation field's value.

func (*JwtTokenTypeConfiguration) SetSecretManagerArn added in v1.35.22 

func (s *JwtTokenTypeConfiguration) SetSecretManagerArn(v string) *JwtTokenTypeConfiguration

SetSecretManagerArn sets the SecretManagerArn field's value.

func (*JwtTokenTypeConfiguration) SetURL added in v1.35.22 

func (s *JwtTokenTypeConfiguration) SetURL(v string) *JwtTokenTypeConfiguration

SetURL sets the URL field's value.

func (*JwtTokenTypeConfiguration) SetUserNameAttributeField added in v1.35.22 

func (s *JwtTokenTypeConfiguration) SetUserNameAttributeField(v string) *JwtTokenTypeConfiguration

SetUserNameAttributeField sets the UserNameAttributeField field's value.

func (JwtTokenTypeConfiguration) String added in v1.35.22 

func (s JwtTokenTypeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JwtTokenTypeConfiguration) Validate added in v1.35.22 

func (s *JwtTokenTypeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Kendra 

type Kendra struct {
	*client.Client
}

Kendra provides the API operation methods for making requests to AWSKendraFrontendService. See this package's package overview docs for details on the service.

Kendra methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Kendra

New creates a new instance of the Kendra client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a Kendra client from just a session.
svc := kendra.New(mySession)

// Create a Kendra client with additional configuration
svc := kendra.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Kendra) AssociateEntitiesToExperience added in v1.42.17 

func (c *Kendra) AssociateEntitiesToExperience(input *AssociateEntitiesToExperienceInput) (*AssociateEntitiesToExperienceOutput, error)

AssociateEntitiesToExperience API operation for AWSKendraFrontendService.

Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation AssociateEntitiesToExperience for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperience

func (*Kendra) AssociateEntitiesToExperienceRequest added in v1.42.17 

func (c *Kendra) AssociateEntitiesToExperienceRequest(input *AssociateEntitiesToExperienceInput) (req *request.Request, output *AssociateEntitiesToExperienceOutput)

AssociateEntitiesToExperienceRequest generates a "aws/request.Request" representing the client's request for the AssociateEntitiesToExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateEntitiesToExperience for more information on using the AssociateEntitiesToExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateEntitiesToExperienceRequest method.
req, resp := client.AssociateEntitiesToExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperience

func (*Kendra) AssociateEntitiesToExperienceWithContext added in v1.42.17 

func (c *Kendra) AssociateEntitiesToExperienceWithContext(ctx aws.Context, input *AssociateEntitiesToExperienceInput, opts ...request.Option) (*AssociateEntitiesToExperienceOutput, error)

AssociateEntitiesToExperienceWithContext is the same as AssociateEntitiesToExperience with the addition of the ability to pass a context and additional request options.

See AssociateEntitiesToExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) AssociatePersonasToEntities added in v1.42.17 

func (c *Kendra) AssociatePersonasToEntities(input *AssociatePersonasToEntitiesInput) (*AssociatePersonasToEntitiesOutput, error)

AssociatePersonasToEntities API operation for AWSKendraFrontendService.

Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation AssociatePersonasToEntities for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntities

func (*Kendra) AssociatePersonasToEntitiesRequest added in v1.42.17 

func (c *Kendra) AssociatePersonasToEntitiesRequest(input *AssociatePersonasToEntitiesInput) (req *request.Request, output *AssociatePersonasToEntitiesOutput)

AssociatePersonasToEntitiesRequest generates a "aws/request.Request" representing the client's request for the AssociatePersonasToEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociatePersonasToEntities for more information on using the AssociatePersonasToEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociatePersonasToEntitiesRequest method.
req, resp := client.AssociatePersonasToEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntities

func (*Kendra) AssociatePersonasToEntitiesWithContext added in v1.42.17 

func (c *Kendra) AssociatePersonasToEntitiesWithContext(ctx aws.Context, input *AssociatePersonasToEntitiesInput, opts ...request.Option) (*AssociatePersonasToEntitiesOutput, error)

AssociatePersonasToEntitiesWithContext is the same as AssociatePersonasToEntities with the addition of the ability to pass a context and additional request options.

See AssociatePersonasToEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchDeleteDocument 

func (c *Kendra) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocument API operation for AWSKendraFrontendService.

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.

Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchDeleteDocument for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument

func (*Kendra) BatchDeleteDocumentRequest 

func (c *Kendra) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) (req *request.Request, output *BatchDeleteDocumentOutput)

BatchDeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteDocument for more information on using the BatchDeleteDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchDeleteDocumentRequest method.
req, resp := client.BatchDeleteDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument

func (*Kendra) BatchDeleteDocumentWithContext 

func (c *Kendra) BatchDeleteDocumentWithContext(ctx aws.Context, input *BatchDeleteDocumentInput, opts ...request.Option) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocumentWithContext is the same as BatchDeleteDocument with the addition of the ability to pass a context and additional request options.

See BatchDeleteDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchDeleteFeaturedResultsSet added in v1.44.233 

func (c *Kendra) BatchDeleteFeaturedResultsSet(input *BatchDeleteFeaturedResultsSetInput) (*BatchDeleteFeaturedResultsSetOutput, error)

BatchDeleteFeaturedResultsSet API operation for AWSKendraFrontendService.

Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchDeleteFeaturedResultsSet for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSet

func (*Kendra) BatchDeleteFeaturedResultsSetRequest added in v1.44.233 

func (c *Kendra) BatchDeleteFeaturedResultsSetRequest(input *BatchDeleteFeaturedResultsSetInput) (req *request.Request, output *BatchDeleteFeaturedResultsSetOutput)

BatchDeleteFeaturedResultsSetRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteFeaturedResultsSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteFeaturedResultsSet for more information on using the BatchDeleteFeaturedResultsSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchDeleteFeaturedResultsSetRequest method.
req, resp := client.BatchDeleteFeaturedResultsSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSet

func (*Kendra) BatchDeleteFeaturedResultsSetWithContext added in v1.44.233 

func (c *Kendra) BatchDeleteFeaturedResultsSetWithContext(ctx aws.Context, input *BatchDeleteFeaturedResultsSetInput, opts ...request.Option) (*BatchDeleteFeaturedResultsSetOutput, error)

BatchDeleteFeaturedResultsSetWithContext is the same as BatchDeleteFeaturedResultsSet with the addition of the ability to pass a context and additional request options.

See BatchDeleteFeaturedResultsSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchGetDocumentStatus added in v1.38.58 

func (c *Kendra) BatchGetDocumentStatus(input *BatchGetDocumentStatusInput) (*BatchGetDocumentStatusOutput, error)

BatchGetDocumentStatus API operation for AWSKendraFrontendService.

Returns the indexing status for one or more documents submitted with the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API.

When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchGetDocumentStatus for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus

func (*Kendra) BatchGetDocumentStatusRequest added in v1.38.58 

func (c *Kendra) BatchGetDocumentStatusRequest(input *BatchGetDocumentStatusInput) (req *request.Request, output *BatchGetDocumentStatusOutput)

BatchGetDocumentStatusRequest generates a "aws/request.Request" representing the client's request for the BatchGetDocumentStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetDocumentStatus for more information on using the BatchGetDocumentStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchGetDocumentStatusRequest method.
req, resp := client.BatchGetDocumentStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus

func (*Kendra) BatchGetDocumentStatusWithContext added in v1.38.58 

func (c *Kendra) BatchGetDocumentStatusWithContext(ctx aws.Context, input *BatchGetDocumentStatusInput, opts ...request.Option) (*BatchGetDocumentStatusOutput, error)

BatchGetDocumentStatusWithContext is the same as BatchGetDocumentStatus with the addition of the ability to pass a context and additional request options.

See BatchGetDocumentStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchPutDocument 

func (c *Kendra) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error)

BatchPutDocument API operation for AWSKendraFrontendService.

Adds one or more documents to an index.

The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of indexing your documents.

For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchPutDocument for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument

func (*Kendra) BatchPutDocumentRequest 

func (c *Kendra) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req *request.Request, output *BatchPutDocumentOutput)

BatchPutDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchPutDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutDocument for more information on using the BatchPutDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchPutDocumentRequest method.
req, resp := client.BatchPutDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument

func (*Kendra) BatchPutDocumentWithContext 

func (c *Kendra) BatchPutDocumentWithContext(ctx aws.Context, input *BatchPutDocumentInput, opts ...request.Option) (*BatchPutDocumentOutput, error)

BatchPutDocumentWithContext is the same as BatchPutDocument with the addition of the ability to pass a context and additional request options.

See BatchPutDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ClearQuerySuggestions added in v1.38.50 

func (c *Kendra) ClearQuerySuggestions(input *ClearQuerySuggestionsInput) (*ClearQuerySuggestionsOutput, error)

ClearQuerySuggestions API operation for AWSKendraFrontendService.

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ClearQuerySuggestions for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions

func (*Kendra) ClearQuerySuggestionsRequest added in v1.38.50 

func (c *Kendra) ClearQuerySuggestionsRequest(input *ClearQuerySuggestionsInput) (req *request.Request, output *ClearQuerySuggestionsOutput)

ClearQuerySuggestionsRequest generates a "aws/request.Request" representing the client's request for the ClearQuerySuggestions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ClearQuerySuggestions for more information on using the ClearQuerySuggestions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ClearQuerySuggestionsRequest method.
req, resp := client.ClearQuerySuggestionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions

func (*Kendra) ClearQuerySuggestionsWithContext added in v1.38.50 

func (c *Kendra) ClearQuerySuggestionsWithContext(ctx aws.Context, input *ClearQuerySuggestionsInput, opts ...request.Option) (*ClearQuerySuggestionsOutput, error)

ClearQuerySuggestionsWithContext is the same as ClearQuerySuggestions with the addition of the ability to pass a context and additional request options.

See ClearQuerySuggestions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateAccessControlConfiguration added in v1.44.55 

func (c *Kendra) CreateAccessControlConfiguration(input *CreateAccessControlConfigurationInput) (*CreateAccessControlConfigurationOutput, error)

CreateAccessControlConfiguration API operation for AWSKendraFrontendService.

Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.

To apply your access control configuration to certain documents, you call the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API with the AccessControlConfigurationId included in the Document (https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateAccessControlConfiguration for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfiguration

func (*Kendra) CreateAccessControlConfigurationRequest added in v1.44.55 

func (c *Kendra) CreateAccessControlConfigurationRequest(input *CreateAccessControlConfigurationInput) (req *request.Request, output *CreateAccessControlConfigurationOutput)

CreateAccessControlConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateAccessControlConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAccessControlConfiguration for more information on using the CreateAccessControlConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAccessControlConfigurationRequest method.
req, resp := client.CreateAccessControlConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfiguration

func (*Kendra) CreateAccessControlConfigurationWithContext added in v1.44.55 

func (c *Kendra) CreateAccessControlConfigurationWithContext(ctx aws.Context, input *CreateAccessControlConfigurationInput, opts ...request.Option) (*CreateAccessControlConfigurationOutput, error)

CreateAccessControlConfigurationWithContext is the same as CreateAccessControlConfiguration with the addition of the ability to pass a context and additional request options.

See CreateAccessControlConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateDataSource 

func (c *Kendra) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)

CreateDataSource API operation for AWSKendraFrontendService.

Creates a data source connector that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateDataSource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource

func (*Kendra) CreateDataSourceRequest 

func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *request.Request, output *CreateDataSourceOutput)

CreateDataSourceRequest generates a "aws/request.Request" representing the client's request for the CreateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDataSource for more information on using the CreateDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDataSourceRequest method.
req, resp := client.CreateDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource

func (*Kendra) CreateDataSourceWithContext 

func (c *Kendra) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataSourceInput, opts ...request.Option) (*CreateDataSourceOutput, error)

CreateDataSourceWithContext is the same as CreateDataSource with the addition of the ability to pass a context and additional request options.

See CreateDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateExperience added in v1.42.17 

func (c *Kendra) CreateExperience(input *CreateExperienceInput) (*CreateExperienceOutput, error)

CreateExperience API operation for AWSKendraFrontendService.

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateExperience for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperience

func (*Kendra) CreateExperienceRequest added in v1.42.17 

func (c *Kendra) CreateExperienceRequest(input *CreateExperienceInput) (req *request.Request, output *CreateExperienceOutput)

CreateExperienceRequest generates a "aws/request.Request" representing the client's request for the CreateExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateExperience for more information on using the CreateExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateExperienceRequest method.
req, resp := client.CreateExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperience

func (*Kendra) CreateExperienceWithContext added in v1.42.17 

func (c *Kendra) CreateExperienceWithContext(ctx aws.Context, input *CreateExperienceInput, opts ...request.Option) (*CreateExperienceOutput, error)

CreateExperienceWithContext is the same as CreateExperience with the addition of the ability to pass a context and additional request options.

See CreateExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateFaq 

func (c *Kendra) CreateFaq(input *CreateFaqInput) (*CreateFaqOutput, error)

CreateFaq API operation for AWSKendraFrontendService.

Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.

Adding FAQs to an index is an asynchronous operation.

For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateFaq for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq

func (*Kendra) CreateFaqRequest 

func (c *Kendra) CreateFaqRequest(input *CreateFaqInput) (req *request.Request, output *CreateFaqOutput)

CreateFaqRequest generates a "aws/request.Request" representing the client's request for the CreateFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFaq for more information on using the CreateFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateFaqRequest method.
req, resp := client.CreateFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq

func (*Kendra) CreateFaqWithContext 

func (c *Kendra) CreateFaqWithContext(ctx aws.Context, input *CreateFaqInput, opts ...request.Option) (*CreateFaqOutput, error)

CreateFaqWithContext is the same as CreateFaq with the addition of the ability to pass a context and additional request options.

See CreateFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateFeaturedResultsSet added in v1.44.233 

func (c *Kendra) CreateFeaturedResultsSet(input *CreateFeaturedResultsSetInput) (*CreateFeaturedResultsSetOutput, error)

CreateFeaturedResultsSet API operation for AWSKendraFrontendService.

Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.

You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support (http://aws.amazon.com/contact-us/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateFeaturedResultsSet for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • FeaturedResultsConflictException An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFeaturedResultsSet

func (*Kendra) CreateFeaturedResultsSetRequest added in v1.44.233 

func (c *Kendra) CreateFeaturedResultsSetRequest(input *CreateFeaturedResultsSetInput) (req *request.Request, output *CreateFeaturedResultsSetOutput)

CreateFeaturedResultsSetRequest generates a "aws/request.Request" representing the client's request for the CreateFeaturedResultsSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFeaturedResultsSet for more information on using the CreateFeaturedResultsSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateFeaturedResultsSetRequest method.
req, resp := client.CreateFeaturedResultsSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFeaturedResultsSet

func (*Kendra) CreateFeaturedResultsSetWithContext added in v1.44.233 

func (c *Kendra) CreateFeaturedResultsSetWithContext(ctx aws.Context, input *CreateFeaturedResultsSetInput, opts ...request.Option) (*CreateFeaturedResultsSetOutput, error)

CreateFeaturedResultsSetWithContext is the same as CreateFeaturedResultsSet with the addition of the ability to pass a context and additional request options.

See CreateFeaturedResultsSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateIndex 

func (c *Kendra) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)

CreateIndex API operation for AWSKendraFrontendService.

Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or using one of the supported data sources (https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html).

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateIndex for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex

func (*Kendra) CreateIndexRequest 

func (c *Kendra) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)

CreateIndexRequest generates a "aws/request.Request" representing the client's request for the CreateIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateIndex for more information on using the CreateIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateIndexRequest method.
req, resp := client.CreateIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex

func (*Kendra) CreateIndexWithContext 

func (c *Kendra) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)

CreateIndexWithContext is the same as CreateIndex with the addition of the ability to pass a context and additional request options.

See CreateIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateQuerySuggestionsBlockList added in v1.38.50 

func (c *Kendra) CreateQuerySuggestionsBlockList(input *CreateQuerySuggestionsBlockListInput) (*CreateQuerySuggestionsBlockListOutput, error)

CreateQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list (https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList

func (*Kendra) CreateQuerySuggestionsBlockListRequest added in v1.38.50 

func (c *Kendra) CreateQuerySuggestionsBlockListRequest(input *CreateQuerySuggestionsBlockListInput) (req *request.Request, output *CreateQuerySuggestionsBlockListOutput)

CreateQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the CreateQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateQuerySuggestionsBlockList for more information on using the CreateQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateQuerySuggestionsBlockListRequest method.
req, resp := client.CreateQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList

func (*Kendra) CreateQuerySuggestionsBlockListWithContext added in v1.38.50 

func (c *Kendra) CreateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *CreateQuerySuggestionsBlockListInput, opts ...request.Option) (*CreateQuerySuggestionsBlockListOutput, error)

CreateQuerySuggestionsBlockListWithContext is the same as CreateQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See CreateQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateThesaurus added in v1.36.6 

func (c *Kendra) CreateThesaurus(input *CreateThesaurusInput) (*CreateThesaurusOutput, error)

CreateThesaurus API operation for AWSKendraFrontendService.

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index (https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateThesaurus for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus

func (*Kendra) CreateThesaurusRequest added in v1.36.6 

func (c *Kendra) CreateThesaurusRequest(input *CreateThesaurusInput) (req *request.Request, output *CreateThesaurusOutput)

CreateThesaurusRequest generates a "aws/request.Request" representing the client's request for the CreateThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateThesaurus for more information on using the CreateThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateThesaurusRequest method.
req, resp := client.CreateThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus

func (*Kendra) CreateThesaurusWithContext added in v1.36.6 

func (c *Kendra) CreateThesaurusWithContext(ctx aws.Context, input *CreateThesaurusInput, opts ...request.Option) (*CreateThesaurusOutput, error)

CreateThesaurusWithContext is the same as CreateThesaurus with the addition of the ability to pass a context and additional request options.

See CreateThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteAccessControlConfiguration added in v1.44.55 

func (c *Kendra) DeleteAccessControlConfiguration(input *DeleteAccessControlConfigurationInput) (*DeleteAccessControlConfigurationOutput, error)

DeleteAccessControlConfiguration API operation for AWSKendraFrontendService.

Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteAccessControlConfiguration for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfiguration

func (*Kendra) DeleteAccessControlConfigurationRequest added in v1.44.55 

func (c *Kendra) DeleteAccessControlConfigurationRequest(input *DeleteAccessControlConfigurationInput) (req *request.Request, output *DeleteAccessControlConfigurationOutput)

DeleteAccessControlConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteAccessControlConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAccessControlConfiguration for more information on using the DeleteAccessControlConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAccessControlConfigurationRequest method.
req, resp := client.DeleteAccessControlConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfiguration

func (*Kendra) DeleteAccessControlConfigurationWithContext added in v1.44.55 

func (c *Kendra) DeleteAccessControlConfigurationWithContext(ctx aws.Context, input *DeleteAccessControlConfigurationInput, opts ...request.Option) (*DeleteAccessControlConfigurationOutput, error)

DeleteAccessControlConfigurationWithContext is the same as DeleteAccessControlConfiguration with the addition of the ability to pass a context and additional request options.

See DeleteAccessControlConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteDataSource added in v1.30.25 

func (c *Kendra) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)

DeleteDataSource API operation for AWSKendraFrontendService.

Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html).

Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteDataSource for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource

func (*Kendra) DeleteDataSourceRequest added in v1.30.25 

func (c *Kendra) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)

DeleteDataSourceRequest generates a "aws/request.Request" representing the client's request for the DeleteDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDataSource for more information on using the DeleteDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDataSourceRequest method.
req, resp := client.DeleteDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource

func (*Kendra) DeleteDataSourceWithContext added in v1.30.25 

func (c *Kendra) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)

DeleteDataSourceWithContext is the same as DeleteDataSource with the addition of the ability to pass a context and additional request options.

See DeleteDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteExperience added in v1.42.17 

func (c *Kendra) DeleteExperience(input *DeleteExperienceInput) (*DeleteExperienceOutput, error)

DeleteExperience API operation for AWSKendraFrontendService.

Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteExperience for usage and error information.

Returned Error Types:

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperience

func (*Kendra) DeleteExperienceRequest added in v1.42.17 

func (c *Kendra) DeleteExperienceRequest(input *DeleteExperienceInput) (req *request.Request, output *DeleteExperienceOutput)

DeleteExperienceRequest generates a "aws/request.Request" representing the client's request for the DeleteExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteExperience for more information on using the DeleteExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteExperienceRequest method.
req, resp := client.DeleteExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperience

func (*Kendra) DeleteExperienceWithContext added in v1.42.17 

func (c *Kendra) DeleteExperienceWithContext(ctx aws.Context, input *DeleteExperienceInput, opts ...request.Option) (*DeleteExperienceOutput, error)

DeleteExperienceWithContext is the same as DeleteExperience with the addition of the ability to pass a context and additional request options.

See DeleteExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteFaq 

func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error)

DeleteFaq API operation for AWSKendraFrontendService.

Removes an FAQ from an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteFaq for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq

func (*Kendra) DeleteFaqRequest 

func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput)

DeleteFaqRequest generates a "aws/request.Request" representing the client's request for the DeleteFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFaq for more information on using the DeleteFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteFaqRequest method.
req, resp := client.DeleteFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq

func (*Kendra) DeleteFaqWithContext 

func (c *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error)

DeleteFaqWithContext is the same as DeleteFaq with the addition of the ability to pass a context and additional request options.

See DeleteFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteIndex 

func (c *Kendra) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)

DeleteIndex API operation for AWSKendraFrontendService.

Deletes an Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteIndex for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex

func (*Kendra) DeleteIndexRequest 

func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)

DeleteIndexRequest generates a "aws/request.Request" representing the client's request for the DeleteIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIndex for more information on using the DeleteIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteIndexRequest method.
req, resp := client.DeleteIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex

func (*Kendra) DeleteIndexWithContext 

func (c *Kendra) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)

DeleteIndexWithContext is the same as DeleteIndex with the addition of the ability to pass a context and additional request options.

See DeleteIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeletePrincipalMapping added in v1.39.5 

func (c *Kendra) DeletePrincipalMapping(input *DeletePrincipalMappingInput) (*DeletePrincipalMappingOutput, error)

DeletePrincipalMapping API operation for AWSKendraFrontendService.

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeletePrincipalMapping for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMapping

func (*Kendra) DeletePrincipalMappingRequest added in v1.39.5 

func (c *Kendra) DeletePrincipalMappingRequest(input *DeletePrincipalMappingInput) (req *request.Request, output *DeletePrincipalMappingOutput)

DeletePrincipalMappingRequest generates a "aws/request.Request" representing the client's request for the DeletePrincipalMapping operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePrincipalMapping for more information on using the DeletePrincipalMapping API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePrincipalMappingRequest method.
req, resp := client.DeletePrincipalMappingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMapping

func (*Kendra) DeletePrincipalMappingWithContext added in v1.39.5 

func (c *Kendra) DeletePrincipalMappingWithContext(ctx aws.Context, input *DeletePrincipalMappingInput, opts ...request.Option) (*DeletePrincipalMappingOutput, error)

DeletePrincipalMappingWithContext is the same as DeletePrincipalMapping with the addition of the ability to pass a context and additional request options.

See DeletePrincipalMapping for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteQuerySuggestionsBlockList added in v1.38.50 

func (c *Kendra) DeleteQuerySuggestionsBlockList(input *DeleteQuerySuggestionsBlockListInput) (*DeleteQuerySuggestionsBlockListOutput, error)

DeleteQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList

func (*Kendra) DeleteQuerySuggestionsBlockListRequest added in v1.38.50 

func (c *Kendra) DeleteQuerySuggestionsBlockListRequest(input *DeleteQuerySuggestionsBlockListInput) (req *request.Request, output *DeleteQuerySuggestionsBlockListOutput)

DeleteQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the DeleteQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteQuerySuggestionsBlockList for more information on using the DeleteQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteQuerySuggestionsBlockListRequest method.
req, resp := client.DeleteQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList

func (*Kendra) DeleteQuerySuggestionsBlockListWithContext added in v1.38.50 

func (c *Kendra) DeleteQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DeleteQuerySuggestionsBlockListInput, opts ...request.Option) (*DeleteQuerySuggestionsBlockListOutput, error)

DeleteQuerySuggestionsBlockListWithContext is the same as DeleteQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See DeleteQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteThesaurus added in v1.36.6 

func (c *Kendra) DeleteThesaurus(input *DeleteThesaurusInput) (*DeleteThesaurusOutput, error)

DeleteThesaurus API operation for AWSKendraFrontendService.

Deletes an Amazon Kendra thesaurus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteThesaurus for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus

func (*Kendra) DeleteThesaurusRequest added in v1.36.6 

func (c *Kendra) DeleteThesaurusRequest(input *DeleteThesaurusInput) (req *request.Request, output *DeleteThesaurusOutput)

DeleteThesaurusRequest generates a "aws/request.Request" representing the client's request for the DeleteThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteThesaurus for more information on using the DeleteThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteThesaurusRequest method.
req, resp := client.DeleteThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus

func (*Kendra) DeleteThesaurusWithContext added in v1.36.6 

func (c *Kendra) DeleteThesaurusWithContext(ctx aws.Context, input *DeleteThesaurusInput, opts ...request.Option) (*DeleteThesaurusOutput, error)

DeleteThesaurusWithContext is the same as DeleteThesaurus with the addition of the ability to pass a context and additional request options.

See DeleteThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeAccessControlConfiguration added in v1.44.55 

func (c *Kendra) DescribeAccessControlConfiguration(input *DescribeAccessControlConfigurationInput) (*DescribeAccessControlConfigurationOutput, error)

DescribeAccessControlConfiguration API operation for AWSKendraFrontendService.

Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeAccessControlConfiguration for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfiguration

func (*Kendra) DescribeAccessControlConfigurationRequest added in v1.44.55 

func (c *Kendra) DescribeAccessControlConfigurationRequest(input *DescribeAccessControlConfigurationInput) (req *request.Request, output *DescribeAccessControlConfigurationOutput)

DescribeAccessControlConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeAccessControlConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccessControlConfiguration for more information on using the DescribeAccessControlConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAccessControlConfigurationRequest method.
req, resp := client.DescribeAccessControlConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfiguration

func (*Kendra) DescribeAccessControlConfigurationWithContext added in v1.44.55 

func (c *Kendra) DescribeAccessControlConfigurationWithContext(ctx aws.Context, input *DescribeAccessControlConfigurationInput, opts ...request.Option) (*DescribeAccessControlConfigurationOutput, error)

DescribeAccessControlConfigurationWithContext is the same as DescribeAccessControlConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeAccessControlConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeDataSource 

func (c *Kendra) DescribeDataSource(input *DescribeDataSourceInput) (*DescribeDataSourceOutput, error)

DescribeDataSource API operation for AWSKendraFrontendService.

Gets information about an Amazon Kendra data source connector.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeDataSource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource

func (*Kendra) DescribeDataSourceRequest 

func (c *Kendra) DescribeDataSourceRequest(input *DescribeDataSourceInput) (req *request.Request, output *DescribeDataSourceOutput)

DescribeDataSourceRequest generates a "aws/request.Request" representing the client's request for the DescribeDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDataSource for more information on using the DescribeDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDataSourceRequest method.
req, resp := client.DescribeDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource

func (*Kendra) DescribeDataSourceWithContext 

func (c *Kendra) DescribeDataSourceWithContext(ctx aws.Context, input *DescribeDataSourceInput, opts ...request.Option) (*DescribeDataSourceOutput, error)

DescribeDataSourceWithContext is the same as DescribeDataSource with the addition of the ability to pass a context and additional request options.

See DescribeDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeExperience added in v1.42.17 

func (c *Kendra) DescribeExperience(input *DescribeExperienceInput) (*DescribeExperienceOutput, error)

DescribeExperience API operation for AWSKendraFrontendService.

Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeExperience for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperience

func (*Kendra) DescribeExperienceRequest added in v1.42.17 

func (c *Kendra) DescribeExperienceRequest(input *DescribeExperienceInput) (req *request.Request, output *DescribeExperienceOutput)

DescribeExperienceRequest generates a "aws/request.Request" representing the client's request for the DescribeExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExperience for more information on using the DescribeExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeExperienceRequest method.
req, resp := client.DescribeExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperience

func (*Kendra) DescribeExperienceWithContext added in v1.42.17 

func (c *Kendra) DescribeExperienceWithContext(ctx aws.Context, input *DescribeExperienceInput, opts ...request.Option) (*DescribeExperienceOutput, error)

DescribeExperienceWithContext is the same as DescribeExperience with the addition of the ability to pass a context and additional request options.

See DescribeExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeFaq 

func (c *Kendra) DescribeFaq(input *DescribeFaqInput) (*DescribeFaqOutput, error)

DescribeFaq API operation for AWSKendraFrontendService.

Gets information about an FAQ list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeFaq for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq

func (*Kendra) DescribeFaqRequest 

func (c *Kendra) DescribeFaqRequest(input *DescribeFaqInput) (req *request.Request, output *DescribeFaqOutput)

DescribeFaqRequest generates a "aws/request.Request" representing the client's request for the DescribeFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFaq for more information on using the DescribeFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFaqRequest method.
req, resp := client.DescribeFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq

func (*Kendra) DescribeFaqWithContext 

func (c *Kendra) DescribeFaqWithContext(ctx aws.Context, input *DescribeFaqInput, opts ...request.Option) (*DescribeFaqOutput, error)

DescribeFaqWithContext is the same as DescribeFaq with the addition of the ability to pass a context and additional request options.

See DescribeFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeFeaturedResultsSet added in v1.44.233 

func (c *Kendra) DescribeFeaturedResultsSet(input *DescribeFeaturedResultsSetInput) (*DescribeFeaturedResultsSetOutput, error)

DescribeFeaturedResultsSet API operation for AWSKendraFrontendService.

Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeFeaturedResultsSet for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFeaturedResultsSet

func (*Kendra) DescribeFeaturedResultsSetRequest added in v1.44.233 

func (c *Kendra) DescribeFeaturedResultsSetRequest(input *DescribeFeaturedResultsSetInput) (req *request.Request, output *DescribeFeaturedResultsSetOutput)

DescribeFeaturedResultsSetRequest generates a "aws/request.Request" representing the client's request for the DescribeFeaturedResultsSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFeaturedResultsSet for more information on using the DescribeFeaturedResultsSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeFeaturedResultsSetRequest method.
req, resp := client.DescribeFeaturedResultsSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFeaturedResultsSet

func (*Kendra) DescribeFeaturedResultsSetWithContext added in v1.44.233 

func (c *Kendra) DescribeFeaturedResultsSetWithContext(ctx aws.Context, input *DescribeFeaturedResultsSetInput, opts ...request.Option) (*DescribeFeaturedResultsSetOutput, error)

DescribeFeaturedResultsSetWithContext is the same as DescribeFeaturedResultsSet with the addition of the ability to pass a context and additional request options.

See DescribeFeaturedResultsSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeIndex 

func (c *Kendra) DescribeIndex(input *DescribeIndexInput) (*DescribeIndexOutput, error)

DescribeIndex API operation for AWSKendraFrontendService.

Gets information about an Amazon Kendra index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeIndex for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex

func (*Kendra) DescribeIndexRequest 

func (c *Kendra) DescribeIndexRequest(input *DescribeIndexInput) (req *request.Request, output *DescribeIndexOutput)

DescribeIndexRequest generates a "aws/request.Request" representing the client's request for the DescribeIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIndex for more information on using the DescribeIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeIndexRequest method.
req, resp := client.DescribeIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex

func (*Kendra) DescribeIndexWithContext 

func (c *Kendra) DescribeIndexWithContext(ctx aws.Context, input *DescribeIndexInput, opts ...request.Option) (*DescribeIndexOutput, error)

DescribeIndexWithContext is the same as DescribeIndex with the addition of the ability to pass a context and additional request options.

See DescribeIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribePrincipalMapping added in v1.39.5 

func (c *Kendra) DescribePrincipalMapping(input *DescribePrincipalMappingInput) (*DescribePrincipalMappingOutput, error)

DescribePrincipalMapping API operation for AWSKendraFrontendService.

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribePrincipalMapping for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMapping

func (*Kendra) DescribePrincipalMappingRequest added in v1.39.5 

func (c *Kendra) DescribePrincipalMappingRequest(input *DescribePrincipalMappingInput) (req *request.Request, output *DescribePrincipalMappingOutput)

DescribePrincipalMappingRequest generates a "aws/request.Request" representing the client's request for the DescribePrincipalMapping operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePrincipalMapping for more information on using the DescribePrincipalMapping API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribePrincipalMappingRequest method.
req, resp := client.DescribePrincipalMappingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMapping

func (*Kendra) DescribePrincipalMappingWithContext added in v1.39.5 

func (c *Kendra) DescribePrincipalMappingWithContext(ctx aws.Context, input *DescribePrincipalMappingInput, opts ...request.Option) (*DescribePrincipalMappingOutput, error)

DescribePrincipalMappingWithContext is the same as DescribePrincipalMapping with the addition of the ability to pass a context and additional request options.

See DescribePrincipalMapping for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeQuerySuggestionsBlockList added in v1.38.50 

func (c *Kendra) DescribeQuerySuggestionsBlockList(input *DescribeQuerySuggestionsBlockListInput) (*DescribeQuerySuggestionsBlockListOutput, error)

DescribeQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Gets information about a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

DescribeQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList

func (*Kendra) DescribeQuerySuggestionsBlockListRequest added in v1.38.50 

func (c *Kendra) DescribeQuerySuggestionsBlockListRequest(input *DescribeQuerySuggestionsBlockListInput) (req *request.Request, output *DescribeQuerySuggestionsBlockListOutput)

DescribeQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the DescribeQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQuerySuggestionsBlockList for more information on using the DescribeQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeQuerySuggestionsBlockListRequest method.
req, resp := client.DescribeQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList

func (*Kendra) DescribeQuerySuggestionsBlockListWithContext added in v1.38.50 

func (c *Kendra) DescribeQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DescribeQuerySuggestionsBlockListInput, opts ...request.Option) (*DescribeQuerySuggestionsBlockListOutput, error)

DescribeQuerySuggestionsBlockListWithContext is the same as DescribeQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See DescribeQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeQuerySuggestionsConfig added in v1.38.50 

func (c *Kendra) DescribeQuerySuggestionsConfig(input *DescribeQuerySuggestionsConfigInput) (*DescribeQuerySuggestionsConfigOutput, error)

DescribeQuerySuggestionsConfig API operation for AWSKendraFrontendService.

Gets information on the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeQuerySuggestionsConfig for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig

func (*Kendra) DescribeQuerySuggestionsConfigRequest added in v1.38.50 

func (c *Kendra) DescribeQuerySuggestionsConfigRequest(input *DescribeQuerySuggestionsConfigInput) (req *request.Request, output *DescribeQuerySuggestionsConfigOutput)

DescribeQuerySuggestionsConfigRequest generates a "aws/request.Request" representing the client's request for the DescribeQuerySuggestionsConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQuerySuggestionsConfig for more information on using the DescribeQuerySuggestionsConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeQuerySuggestionsConfigRequest method.
req, resp := client.DescribeQuerySuggestionsConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig

func (*Kendra) DescribeQuerySuggestionsConfigWithContext added in v1.38.50 

func (c *Kendra) DescribeQuerySuggestionsConfigWithContext(ctx aws.Context, input *DescribeQuerySuggestionsConfigInput, opts ...request.Option) (*DescribeQuerySuggestionsConfigOutput, error)

DescribeQuerySuggestionsConfigWithContext is the same as DescribeQuerySuggestionsConfig with the addition of the ability to pass a context and additional request options.

See DescribeQuerySuggestionsConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeThesaurus added in v1.36.6 

func (c *Kendra) DescribeThesaurus(input *DescribeThesaurusInput) (*DescribeThesaurusOutput, error)

DescribeThesaurus API operation for AWSKendraFrontendService.

Gets information about an Amazon Kendra thesaurus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeThesaurus for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus

func (*Kendra) DescribeThesaurusRequest added in v1.36.6 

func (c *Kendra) DescribeThesaurusRequest(input *DescribeThesaurusInput) (req *request.Request, output *DescribeThesaurusOutput)

DescribeThesaurusRequest generates a "aws/request.Request" representing the client's request for the DescribeThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeThesaurus for more information on using the DescribeThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeThesaurusRequest method.
req, resp := client.DescribeThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus

func (*Kendra) DescribeThesaurusWithContext added in v1.36.6 

func (c *Kendra) DescribeThesaurusWithContext(ctx aws.Context, input *DescribeThesaurusInput, opts ...request.Option) (*DescribeThesaurusOutput, error)

DescribeThesaurusWithContext is the same as DescribeThesaurus with the addition of the ability to pass a context and additional request options.

See DescribeThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DisassociateEntitiesFromExperience added in v1.42.17 

func (c *Kendra) DisassociateEntitiesFromExperience(input *DisassociateEntitiesFromExperienceInput) (*DisassociateEntitiesFromExperienceOutput, error)

DisassociateEntitiesFromExperience API operation for AWSKendraFrontendService.

Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DisassociateEntitiesFromExperience for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperience

func (*Kendra) DisassociateEntitiesFromExperienceRequest added in v1.42.17 

func (c *Kendra) DisassociateEntitiesFromExperienceRequest(input *DisassociateEntitiesFromExperienceInput) (req *request.Request, output *DisassociateEntitiesFromExperienceOutput)

DisassociateEntitiesFromExperienceRequest generates a "aws/request.Request" representing the client's request for the DisassociateEntitiesFromExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateEntitiesFromExperience for more information on using the DisassociateEntitiesFromExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateEntitiesFromExperienceRequest method.
req, resp := client.DisassociateEntitiesFromExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperience

func (*Kendra) DisassociateEntitiesFromExperienceWithContext added in v1.42.17 

func (c *Kendra) DisassociateEntitiesFromExperienceWithContext(ctx aws.Context, input *DisassociateEntitiesFromExperienceInput, opts ...request.Option) (*DisassociateEntitiesFromExperienceOutput, error)

DisassociateEntitiesFromExperienceWithContext is the same as DisassociateEntitiesFromExperience with the addition of the ability to pass a context and additional request options.

See DisassociateEntitiesFromExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DisassociatePersonasFromEntities added in v1.42.17 

func (c *Kendra) DisassociatePersonasFromEntities(input *DisassociatePersonasFromEntitiesInput) (*DisassociatePersonasFromEntitiesOutput, error)

DisassociatePersonasFromEntities API operation for AWSKendraFrontendService.

Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DisassociatePersonasFromEntities for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntities

func (*Kendra) DisassociatePersonasFromEntitiesRequest added in v1.42.17 

func (c *Kendra) DisassociatePersonasFromEntitiesRequest(input *DisassociatePersonasFromEntitiesInput) (req *request.Request, output *DisassociatePersonasFromEntitiesOutput)

DisassociatePersonasFromEntitiesRequest generates a "aws/request.Request" representing the client's request for the DisassociatePersonasFromEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociatePersonasFromEntities for more information on using the DisassociatePersonasFromEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociatePersonasFromEntitiesRequest method.
req, resp := client.DisassociatePersonasFromEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntities

func (*Kendra) DisassociatePersonasFromEntitiesWithContext added in v1.42.17 

func (c *Kendra) DisassociatePersonasFromEntitiesWithContext(ctx aws.Context, input *DisassociatePersonasFromEntitiesInput, opts ...request.Option) (*DisassociatePersonasFromEntitiesOutput, error)

DisassociatePersonasFromEntitiesWithContext is the same as DisassociatePersonasFromEntities with the addition of the ability to pass a context and additional request options.

See DisassociatePersonasFromEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) GetQuerySuggestions added in v1.38.50 

func (c *Kendra) GetQuerySuggestions(input *GetQuerySuggestionsInput) (*GetQuerySuggestionsOutput, error)

GetQuerySuggestions API operation for AWSKendraFrontendService.

Fetches the queries that are suggested to your users.

GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation GetQuerySuggestions for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions

func (*Kendra) GetQuerySuggestionsRequest added in v1.38.50 

func (c *Kendra) GetQuerySuggestionsRequest(input *GetQuerySuggestionsInput) (req *request.Request, output *GetQuerySuggestionsOutput)

GetQuerySuggestionsRequest generates a "aws/request.Request" representing the client's request for the GetQuerySuggestions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQuerySuggestions for more information on using the GetQuerySuggestions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetQuerySuggestionsRequest method.
req, resp := client.GetQuerySuggestionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions

func (*Kendra) GetQuerySuggestionsWithContext added in v1.38.50 

func (c *Kendra) GetQuerySuggestionsWithContext(ctx aws.Context, input *GetQuerySuggestionsInput, opts ...request.Option) (*GetQuerySuggestionsOutput, error)

GetQuerySuggestionsWithContext is the same as GetQuerySuggestions with the addition of the ability to pass a context and additional request options.

See GetQuerySuggestions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) GetSnapshots added in v1.42.17 

func (c *Kendra) GetSnapshots(input *GetSnapshotsInput) (*GetSnapshotsOutput, error)

GetSnapshots API operation for AWSKendraFrontendService.

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation GetSnapshots for usage and error information.

Returned Error Types:

  • InvalidRequestException The input to the request is not valid. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshots

func (*Kendra) GetSnapshotsPages added in v1.42.32 

func (c *Kendra) GetSnapshotsPages(input *GetSnapshotsInput, fn func(*GetSnapshotsOutput, bool) bool) error

GetSnapshotsPages iterates over the pages of a GetSnapshots operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetSnapshots method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetSnapshots operation.
pageNum := 0
err := client.GetSnapshotsPages(params,
    func(page *kendra.GetSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) GetSnapshotsPagesWithContext added in v1.42.32 

func (c *Kendra) GetSnapshotsPagesWithContext(ctx aws.Context, input *GetSnapshotsInput, fn func(*GetSnapshotsOutput, bool) bool, opts ...request.Option) error

GetSnapshotsPagesWithContext same as GetSnapshotsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) GetSnapshotsRequest added in v1.42.17 

func (c *Kendra) GetSnapshotsRequest(input *GetSnapshotsInput) (req *request.Request, output *GetSnapshotsOutput)

GetSnapshotsRequest generates a "aws/request.Request" representing the client's request for the GetSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSnapshots for more information on using the GetSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetSnapshotsRequest method.
req, resp := client.GetSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshots

func (*Kendra) GetSnapshotsWithContext added in v1.42.17 

func (c *Kendra) GetSnapshotsWithContext(ctx aws.Context, input *GetSnapshotsInput, opts ...request.Option) (*GetSnapshotsOutput, error)

GetSnapshotsWithContext is the same as GetSnapshots with the addition of the ability to pass a context and additional request options.

See GetSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListAccessControlConfigurations added in v1.44.55 

func (c *Kendra) ListAccessControlConfigurations(input *ListAccessControlConfigurationsInput) (*ListAccessControlConfigurationsOutput, error)

ListAccessControlConfigurations API operation for AWSKendraFrontendService.

Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListAccessControlConfigurations for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurations

func (*Kendra) ListAccessControlConfigurationsPages added in v1.44.55 

func (c *Kendra) ListAccessControlConfigurationsPages(input *ListAccessControlConfigurationsInput, fn func(*ListAccessControlConfigurationsOutput, bool) bool) error

ListAccessControlConfigurationsPages iterates over the pages of a ListAccessControlConfigurations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAccessControlConfigurations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAccessControlConfigurations operation.
pageNum := 0
err := client.ListAccessControlConfigurationsPages(params,
    func(page *kendra.ListAccessControlConfigurationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListAccessControlConfigurationsPagesWithContext added in v1.44.55 

func (c *Kendra) ListAccessControlConfigurationsPagesWithContext(ctx aws.Context, input *ListAccessControlConfigurationsInput, fn func(*ListAccessControlConfigurationsOutput, bool) bool, opts ...request.Option) error

ListAccessControlConfigurationsPagesWithContext same as ListAccessControlConfigurationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListAccessControlConfigurationsRequest added in v1.44.55 

func (c *Kendra) ListAccessControlConfigurationsRequest(input *ListAccessControlConfigurationsInput) (req *request.Request, output *ListAccessControlConfigurationsOutput)

ListAccessControlConfigurationsRequest generates a "aws/request.Request" representing the client's request for the ListAccessControlConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAccessControlConfigurations for more information on using the ListAccessControlConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAccessControlConfigurationsRequest method.
req, resp := client.ListAccessControlConfigurationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurations

func (*Kendra) ListAccessControlConfigurationsWithContext added in v1.44.55 

func (c *Kendra) ListAccessControlConfigurationsWithContext(ctx aws.Context, input *ListAccessControlConfigurationsInput, opts ...request.Option) (*ListAccessControlConfigurationsOutput, error)

ListAccessControlConfigurationsWithContext is the same as ListAccessControlConfigurations with the addition of the ability to pass a context and additional request options.

See ListAccessControlConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourceSyncJobs 

func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobs API operation for AWSKendraFrontendService.

Gets statistics about synchronizing a data source connector.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSourceSyncJobs for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs

func (*Kendra) ListDataSourceSyncJobsPages 

func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error

ListDataSourceSyncJobsPages iterates over the pages of a ListDataSourceSyncJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSourceSyncJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDataSourceSyncJobs operation.
pageNum := 0
err := client.ListDataSourceSyncJobsPages(params,
    func(page *kendra.ListDataSourceSyncJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListDataSourceSyncJobsPagesWithContext 

func (c *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error

ListDataSourceSyncJobsPagesWithContext same as ListDataSourceSyncJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourceSyncJobsRequest 

func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput)

ListDataSourceSyncJobsRequest generates a "aws/request.Request" representing the client's request for the ListDataSourceSyncJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDataSourceSyncJobs for more information on using the ListDataSourceSyncJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDataSourceSyncJobsRequest method.
req, resp := client.ListDataSourceSyncJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs

func (*Kendra) ListDataSourceSyncJobsWithContext 

func (c *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobsWithContext is the same as ListDataSourceSyncJobs with the addition of the ability to pass a context and additional request options.

See ListDataSourceSyncJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSources 

func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)

ListDataSources API operation for AWSKendraFrontendService.

Lists the data source connectors that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSources for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources

func (*Kendra) ListDataSourcesPages 

func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error

ListDataSourcesPages iterates over the pages of a ListDataSources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDataSources operation.
pageNum := 0
err := client.ListDataSourcesPages(params,
    func(page *kendra.ListDataSourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListDataSourcesPagesWithContext 

func (c *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error

ListDataSourcesPagesWithContext same as ListDataSourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourcesRequest 

func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)

ListDataSourcesRequest generates a "aws/request.Request" representing the client's request for the ListDataSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDataSources for more information on using the ListDataSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDataSourcesRequest method.
req, resp := client.ListDataSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources

func (*Kendra) ListDataSourcesWithContext 

func (c *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)

ListDataSourcesWithContext is the same as ListDataSources with the addition of the ability to pass a context and additional request options.

See ListDataSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListEntityPersonas added in v1.42.17 

func (c *Kendra) ListEntityPersonas(input *ListEntityPersonasInput) (*ListEntityPersonasOutput, error)

ListEntityPersonas API operation for AWSKendraFrontendService.

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListEntityPersonas for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonas

func (*Kendra) ListEntityPersonasPages added in v1.42.17 

func (c *Kendra) ListEntityPersonasPages(input *ListEntityPersonasInput, fn func(*ListEntityPersonasOutput, bool) bool) error

ListEntityPersonasPages iterates over the pages of a ListEntityPersonas operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEntityPersonas method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListEntityPersonas operation.
pageNum := 0
err := client.ListEntityPersonasPages(params,
    func(page *kendra.ListEntityPersonasOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListEntityPersonasPagesWithContext added in v1.42.17 

func (c *Kendra) ListEntityPersonasPagesWithContext(ctx aws.Context, input *ListEntityPersonasInput, fn func(*ListEntityPersonasOutput, bool) bool, opts ...request.Option) error

ListEntityPersonasPagesWithContext same as ListEntityPersonasPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListEntityPersonasRequest added in v1.42.17 

func (c *Kendra) ListEntityPersonasRequest(input *ListEntityPersonasInput) (req *request.Request, output *ListEntityPersonasOutput)

ListEntityPersonasRequest generates a "aws/request.Request" representing the client's request for the ListEntityPersonas operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEntityPersonas for more information on using the ListEntityPersonas API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEntityPersonasRequest method.
req, resp := client.ListEntityPersonasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonas

func (*Kendra) ListEntityPersonasWithContext added in v1.42.17 

func (c *Kendra) ListEntityPersonasWithContext(ctx aws.Context, input *ListEntityPersonasInput, opts ...request.Option) (*ListEntityPersonasOutput, error)

ListEntityPersonasWithContext is the same as ListEntityPersonas with the addition of the ability to pass a context and additional request options.

See ListEntityPersonas for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListExperienceEntities added in v1.42.17 

func (c *Kendra) ListExperienceEntities(input *ListExperienceEntitiesInput) (*ListExperienceEntitiesOutput, error)

ListExperienceEntities API operation for AWSKendraFrontendService.

Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListExperienceEntities for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntities

func (*Kendra) ListExperienceEntitiesPages added in v1.42.17 

func (c *Kendra) ListExperienceEntitiesPages(input *ListExperienceEntitiesInput, fn func(*ListExperienceEntitiesOutput, bool) bool) error

ListExperienceEntitiesPages iterates over the pages of a ListExperienceEntities operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExperienceEntities method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListExperienceEntities operation.
pageNum := 0
err := client.ListExperienceEntitiesPages(params,
    func(page *kendra.ListExperienceEntitiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListExperienceEntitiesPagesWithContext added in v1.42.17 

func (c *Kendra) ListExperienceEntitiesPagesWithContext(ctx aws.Context, input *ListExperienceEntitiesInput, fn func(*ListExperienceEntitiesOutput, bool) bool, opts ...request.Option) error

ListExperienceEntitiesPagesWithContext same as ListExperienceEntitiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListExperienceEntitiesRequest added in v1.42.17 

func (c *Kendra) ListExperienceEntitiesRequest(input *ListExperienceEntitiesInput) (req *request.Request, output *ListExperienceEntitiesOutput)

ListExperienceEntitiesRequest generates a "aws/request.Request" representing the client's request for the ListExperienceEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExperienceEntities for more information on using the ListExperienceEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListExperienceEntitiesRequest method.
req, resp := client.ListExperienceEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntities

func (*Kendra) ListExperienceEntitiesWithContext added in v1.42.17 

func (c *Kendra) ListExperienceEntitiesWithContext(ctx aws.Context, input *ListExperienceEntitiesInput, opts ...request.Option) (*ListExperienceEntitiesOutput, error)

ListExperienceEntitiesWithContext is the same as ListExperienceEntities with the addition of the ability to pass a context and additional request options.

See ListExperienceEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListExperiences added in v1.42.17 

func (c *Kendra) ListExperiences(input *ListExperiencesInput) (*ListExperiencesOutput, error)

ListExperiences API operation for AWSKendraFrontendService.

Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListExperiences for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiences

func (*Kendra) ListExperiencesPages added in v1.42.17 

func (c *Kendra) ListExperiencesPages(input *ListExperiencesInput, fn func(*ListExperiencesOutput, bool) bool) error

ListExperiencesPages iterates over the pages of a ListExperiences operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExperiences method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListExperiences operation.
pageNum := 0
err := client.ListExperiencesPages(params,
    func(page *kendra.ListExperiencesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListExperiencesPagesWithContext added in v1.42.17 

func (c *Kendra) ListExperiencesPagesWithContext(ctx aws.Context, input *ListExperiencesInput, fn func(*ListExperiencesOutput, bool) bool, opts ...request.Option) error

ListExperiencesPagesWithContext same as ListExperiencesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListExperiencesRequest added in v1.42.17 

func (c *Kendra) ListExperiencesRequest(input *ListExperiencesInput) (req *request.Request, output *ListExperiencesOutput)

ListExperiencesRequest generates a "aws/request.Request" representing the client's request for the ListExperiences operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExperiences for more information on using the ListExperiences API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListExperiencesRequest method.
req, resp := client.ListExperiencesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiences

func (*Kendra) ListExperiencesWithContext added in v1.42.17 

func (c *Kendra) ListExperiencesWithContext(ctx aws.Context, input *ListExperiencesInput, opts ...request.Option) (*ListExperiencesOutput, error)

ListExperiencesWithContext is the same as ListExperiences with the addition of the ability to pass a context and additional request options.

See ListExperiences for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListFaqs 

func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error)

ListFaqs API operation for AWSKendraFrontendService.

Gets a list of FAQ lists associated with an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListFaqs for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs

func (*Kendra) ListFaqsPages added in v1.44.8 

func (c *Kendra) ListFaqsPages(input *ListFaqsInput, fn func(*ListFaqsOutput, bool) bool) error

ListFaqsPages iterates over the pages of a ListFaqs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFaqs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListFaqs operation.
pageNum := 0
err := client.ListFaqsPages(params,
    func(page *kendra.ListFaqsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListFaqsPagesWithContext added in v1.44.8 

func (c *Kendra) ListFaqsPagesWithContext(ctx aws.Context, input *ListFaqsInput, fn func(*ListFaqsOutput, bool) bool, opts ...request.Option) error

ListFaqsPagesWithContext same as ListFaqsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListFaqsRequest 

func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput)

ListFaqsRequest generates a "aws/request.Request" representing the client's request for the ListFaqs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFaqs for more information on using the ListFaqs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFaqsRequest method.
req, resp := client.ListFaqsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs

func (*Kendra) ListFaqsWithContext 

func (c *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error)

ListFaqsWithContext is the same as ListFaqs with the addition of the ability to pass a context and additional request options.

See ListFaqs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListFeaturedResultsSets added in v1.44.233 

func (c *Kendra) ListFeaturedResultsSets(input *ListFeaturedResultsSetsInput) (*ListFeaturedResultsSetsOutput, error)

ListFeaturedResultsSets API operation for AWSKendraFrontendService.

Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListFeaturedResultsSets for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFeaturedResultsSets

func (*Kendra) ListFeaturedResultsSetsRequest added in v1.44.233 

func (c *Kendra) ListFeaturedResultsSetsRequest(input *ListFeaturedResultsSetsInput) (req *request.Request, output *ListFeaturedResultsSetsOutput)

ListFeaturedResultsSetsRequest generates a "aws/request.Request" representing the client's request for the ListFeaturedResultsSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFeaturedResultsSets for more information on using the ListFeaturedResultsSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListFeaturedResultsSetsRequest method.
req, resp := client.ListFeaturedResultsSetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFeaturedResultsSets

func (*Kendra) ListFeaturedResultsSetsWithContext added in v1.44.233 

func (c *Kendra) ListFeaturedResultsSetsWithContext(ctx aws.Context, input *ListFeaturedResultsSetsInput, opts ...request.Option) (*ListFeaturedResultsSetsOutput, error)

ListFeaturedResultsSetsWithContext is the same as ListFeaturedResultsSets with the addition of the ability to pass a context and additional request options.

See ListFeaturedResultsSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListGroupsOlderThanOrderingId added in v1.39.5 

func (c *Kendra) ListGroupsOlderThanOrderingId(input *ListGroupsOlderThanOrderingIdInput) (*ListGroupsOlderThanOrderingIdOutput, error)

ListGroupsOlderThanOrderingId API operation for AWSKendraFrontendService.

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListGroupsOlderThanOrderingId for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId

func (*Kendra) ListGroupsOlderThanOrderingIdPages added in v1.44.8 

func (c *Kendra) ListGroupsOlderThanOrderingIdPages(input *ListGroupsOlderThanOrderingIdInput, fn func(*ListGroupsOlderThanOrderingIdOutput, bool) bool) error

ListGroupsOlderThanOrderingIdPages iterates over the pages of a ListGroupsOlderThanOrderingId operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGroupsOlderThanOrderingId method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGroupsOlderThanOrderingId operation.
pageNum := 0
err := client.ListGroupsOlderThanOrderingIdPages(params,
    func(page *kendra.ListGroupsOlderThanOrderingIdOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListGroupsOlderThanOrderingIdPagesWithContext added in v1.44.8 

func (c *Kendra) ListGroupsOlderThanOrderingIdPagesWithContext(ctx aws.Context, input *ListGroupsOlderThanOrderingIdInput, fn func(*ListGroupsOlderThanOrderingIdOutput, bool) bool, opts ...request.Option) error

ListGroupsOlderThanOrderingIdPagesWithContext same as ListGroupsOlderThanOrderingIdPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListGroupsOlderThanOrderingIdRequest added in v1.39.5 

func (c *Kendra) ListGroupsOlderThanOrderingIdRequest(input *ListGroupsOlderThanOrderingIdInput) (req *request.Request, output *ListGroupsOlderThanOrderingIdOutput)

ListGroupsOlderThanOrderingIdRequest generates a "aws/request.Request" representing the client's request for the ListGroupsOlderThanOrderingId operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGroupsOlderThanOrderingId for more information on using the ListGroupsOlderThanOrderingId API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGroupsOlderThanOrderingIdRequest method.
req, resp := client.ListGroupsOlderThanOrderingIdRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId

func (*Kendra) ListGroupsOlderThanOrderingIdWithContext added in v1.39.5 

func (c *Kendra) ListGroupsOlderThanOrderingIdWithContext(ctx aws.Context, input *ListGroupsOlderThanOrderingIdInput, opts ...request.Option) (*ListGroupsOlderThanOrderingIdOutput, error)

ListGroupsOlderThanOrderingIdWithContext is the same as ListGroupsOlderThanOrderingId with the addition of the ability to pass a context and additional request options.

See ListGroupsOlderThanOrderingId for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListIndices 

func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)

ListIndices API operation for AWSKendraFrontendService.

Lists the Amazon Kendra indexes that you created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListIndices for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices

func (*Kendra) ListIndicesPages 

func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error

ListIndicesPages iterates over the pages of a ListIndices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListIndices operation.
pageNum := 0
err := client.ListIndicesPages(params,
    func(page *kendra.ListIndicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListIndicesPagesWithContext 

func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error

ListIndicesPagesWithContext same as ListIndicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListIndicesRequest 

func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)

ListIndicesRequest generates a "aws/request.Request" representing the client's request for the ListIndices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIndices for more information on using the ListIndices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListIndicesRequest method.
req, resp := client.ListIndicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices

func (*Kendra) ListIndicesWithContext 

func (c *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)

ListIndicesWithContext is the same as ListIndices with the addition of the ability to pass a context and additional request options.

See ListIndices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListQuerySuggestionsBlockLists added in v1.38.50 

func (c *Kendra) ListQuerySuggestionsBlockLists(input *ListQuerySuggestionsBlockListsInput) (*ListQuerySuggestionsBlockListsOutput, error)

ListQuerySuggestionsBlockLists API operation for AWSKendraFrontendService.

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

ListQuerySuggestionsBlockLists is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListQuerySuggestionsBlockLists for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists

func (*Kendra) ListQuerySuggestionsBlockListsPages added in v1.44.8 

func (c *Kendra) ListQuerySuggestionsBlockListsPages(input *ListQuerySuggestionsBlockListsInput, fn func(*ListQuerySuggestionsBlockListsOutput, bool) bool) error

ListQuerySuggestionsBlockListsPages iterates over the pages of a ListQuerySuggestionsBlockLists operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListQuerySuggestionsBlockLists method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListQuerySuggestionsBlockLists operation.
pageNum := 0
err := client.ListQuerySuggestionsBlockListsPages(params,
    func(page *kendra.ListQuerySuggestionsBlockListsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListQuerySuggestionsBlockListsPagesWithContext added in v1.44.8 

func (c *Kendra) ListQuerySuggestionsBlockListsPagesWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, fn func(*ListQuerySuggestionsBlockListsOutput, bool) bool, opts ...request.Option) error

ListQuerySuggestionsBlockListsPagesWithContext same as ListQuerySuggestionsBlockListsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListQuerySuggestionsBlockListsRequest added in v1.38.50 

func (c *Kendra) ListQuerySuggestionsBlockListsRequest(input *ListQuerySuggestionsBlockListsInput) (req *request.Request, output *ListQuerySuggestionsBlockListsOutput)

ListQuerySuggestionsBlockListsRequest generates a "aws/request.Request" representing the client's request for the ListQuerySuggestionsBlockLists operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListQuerySuggestionsBlockLists for more information on using the ListQuerySuggestionsBlockLists API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListQuerySuggestionsBlockListsRequest method.
req, resp := client.ListQuerySuggestionsBlockListsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists

func (*Kendra) ListQuerySuggestionsBlockListsWithContext added in v1.38.50 

func (c *Kendra) ListQuerySuggestionsBlockListsWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, opts ...request.Option) (*ListQuerySuggestionsBlockListsOutput, error)

ListQuerySuggestionsBlockListsWithContext is the same as ListQuerySuggestionsBlockLists with the addition of the ability to pass a context and additional request options.

See ListQuerySuggestionsBlockLists for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListTagsForResource added in v1.30.25 

func (c *Kendra) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWSKendraFrontendService.

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource

func (*Kendra) ListTagsForResourceRequest added in v1.30.25 

func (c *Kendra) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource

func (*Kendra) ListTagsForResourceWithContext added in v1.30.25 

func (c *Kendra) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListThesauri added in v1.36.6 

func (c *Kendra) ListThesauri(input *ListThesauriInput) (*ListThesauriOutput, error)

ListThesauri API operation for AWSKendraFrontendService.

Lists the thesauri for an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListThesauri for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri

func (*Kendra) ListThesauriPages added in v1.44.8 

func (c *Kendra) ListThesauriPages(input *ListThesauriInput, fn func(*ListThesauriOutput, bool) bool) error

ListThesauriPages iterates over the pages of a ListThesauri operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListThesauri method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListThesauri operation.
pageNum := 0
err := client.ListThesauriPages(params,
    func(page *kendra.ListThesauriOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListThesauriPagesWithContext added in v1.44.8 

func (c *Kendra) ListThesauriPagesWithContext(ctx aws.Context, input *ListThesauriInput, fn func(*ListThesauriOutput, bool) bool, opts ...request.Option) error

ListThesauriPagesWithContext same as ListThesauriPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListThesauriRequest added in v1.36.6 

func (c *Kendra) ListThesauriRequest(input *ListThesauriInput) (req *request.Request, output *ListThesauriOutput)

ListThesauriRequest generates a "aws/request.Request" representing the client's request for the ListThesauri operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThesauri for more information on using the ListThesauri API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListThesauriRequest method.
req, resp := client.ListThesauriRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri

func (*Kendra) ListThesauriWithContext added in v1.36.6 

func (c *Kendra) ListThesauriWithContext(ctx aws.Context, input *ListThesauriInput, opts ...request.Option) (*ListThesauriOutput, error)

ListThesauriWithContext is the same as ListThesauri with the addition of the ability to pass a context and additional request options.

See ListThesauri for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) PutPrincipalMapping added in v1.39.5 

func (c *Kendra) PutPrincipalMapping(input *PutPrincipalMappingInput) (*PutPrincipalMappingOutput, error)

PutPrincipalMapping API operation for AWSKendraFrontendService.

Maps users to their groups so that you only need to provide the user ID when you issue the query.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.

This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation PutPrincipalMapping for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping

func (*Kendra) PutPrincipalMappingRequest added in v1.39.5 

func (c *Kendra) PutPrincipalMappingRequest(input *PutPrincipalMappingInput) (req *request.Request, output *PutPrincipalMappingOutput)

PutPrincipalMappingRequest generates a "aws/request.Request" representing the client's request for the PutPrincipalMapping operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPrincipalMapping for more information on using the PutPrincipalMapping API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutPrincipalMappingRequest method.
req, resp := client.PutPrincipalMappingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping

func (*Kendra) PutPrincipalMappingWithContext added in v1.39.5 

func (c *Kendra) PutPrincipalMappingWithContext(ctx aws.Context, input *PutPrincipalMappingInput, opts ...request.Option) (*PutPrincipalMappingOutput, error)

PutPrincipalMappingWithContext is the same as PutPrincipalMapping with the addition of the ability to pass a context and additional request options.

See PutPrincipalMapping for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) Query 

func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error)

Query API operation for AWSKendraFrontendService.

Searches an index given an input query.

If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's Retrieve (https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html) API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length.

You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.

A query response contains three types of results.

  • Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.

  • Matching FAQs or questions-answer from your FAQ file.

  • Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.

You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation Query for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query

func (*Kendra) QueryRequest 

func (c *Kendra) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput)

QueryRequest generates a "aws/request.Request" representing the client's request for the Query operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Query for more information on using the Query API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the QueryRequest method.
req, resp := client.QueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query

func (*Kendra) QueryWithContext 

func (c *Kendra) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error)

QueryWithContext is the same as Query with the addition of the ability to pass a context and additional request options.

See Query for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) Retrieve added in v1.44.288 

func (c *Kendra) Retrieve(input *RetrieveInput) (*RetrieveOutput, error)

Retrieve API operation for AWSKendraFrontendService.

Retrieves relevant passages or text excerpts given an input query.

This API is similar to the Query (https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html) API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses.

You can also do the following:

  • Override boosting at the index level

  • Filter based on document fields or attributes

  • Filter based on the user or their group access to documents

  • View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query. Confidence score buckets are currently available only for English.

You can also include certain fields in the response that might provide useful additional information.

The Retrieve API shares the number of query capacity units (https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html) that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation Retrieve for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Retrieve

func (*Kendra) RetrieveRequest added in v1.44.288 

func (c *Kendra) RetrieveRequest(input *RetrieveInput) (req *request.Request, output *RetrieveOutput)

RetrieveRequest generates a "aws/request.Request" representing the client's request for the Retrieve operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Retrieve for more information on using the Retrieve API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RetrieveRequest method.
req, resp := client.RetrieveRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Retrieve

func (*Kendra) RetrieveWithContext added in v1.44.288 

func (c *Kendra) RetrieveWithContext(ctx aws.Context, input *RetrieveInput, opts ...request.Option) (*RetrieveOutput, error)

RetrieveWithContext is the same as Retrieve with the addition of the ability to pass a context and additional request options.

See Retrieve for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) StartDataSourceSyncJob 

func (c *Kendra) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error)

StartDataSourceSyncJob API operation for AWSKendraFrontendService.

Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation StartDataSourceSyncJob for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ResourceInUseException The resource you want to use is currently in use. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob

func (*Kendra) StartDataSourceSyncJobRequest 

func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput)

StartDataSourceSyncJobRequest generates a "aws/request.Request" representing the client's request for the StartDataSourceSyncJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartDataSourceSyncJob for more information on using the StartDataSourceSyncJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartDataSourceSyncJobRequest method.
req, resp := client.StartDataSourceSyncJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJob

func (*Kendra) StartDataSourceSyncJobWithContext 

func (c *Kendra) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error)

StartDataSourceSyncJobWithContext is the same as StartDataSourceSyncJob with the addition of the ability to pass a context and additional request options.

See StartDataSourceSyncJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) StopDataSourceSyncJob 

func (c *Kendra) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error)

StopDataSourceSyncJob API operation for AWSKendraFrontendService.

Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation StopDataSourceSyncJob for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob

func (*Kendra) StopDataSourceSyncJobRequest 

func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput)

StopDataSourceSyncJobRequest generates a "aws/request.Request" representing the client's request for the StopDataSourceSyncJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopDataSourceSyncJob for more information on using the StopDataSourceSyncJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopDataSourceSyncJobRequest method.
req, resp := client.StopDataSourceSyncJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJob

func (*Kendra) StopDataSourceSyncJobWithContext 

func (c *Kendra) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error)

StopDataSourceSyncJobWithContext is the same as StopDataSourceSyncJob with the addition of the ability to pass a context and additional request options.

See StopDataSourceSyncJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) SubmitFeedback 

func (c *Kendra) SubmitFeedback(input *SubmitFeedbackInput) (*SubmitFeedbackOutput, error)

SubmitFeedback API operation for AWSKendraFrontendService.

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation SubmitFeedback for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback

func (*Kendra) SubmitFeedbackRequest 

func (c *Kendra) SubmitFeedbackRequest(input *SubmitFeedbackInput) (req *request.Request, output *SubmitFeedbackOutput)

SubmitFeedbackRequest generates a "aws/request.Request" representing the client's request for the SubmitFeedback operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SubmitFeedback for more information on using the SubmitFeedback API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SubmitFeedbackRequest method.
req, resp := client.SubmitFeedbackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SubmitFeedback

func (*Kendra) SubmitFeedbackWithContext 

func (c *Kendra) SubmitFeedbackWithContext(ctx aws.Context, input *SubmitFeedbackInput, opts ...request.Option) (*SubmitFeedbackOutput, error)

SubmitFeedbackWithContext is the same as SubmitFeedback with the addition of the ability to pass a context and additional request options.

See SubmitFeedback for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) TagResource added in v1.30.25 

func (c *Kendra) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWSKendraFrontendService.

Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation TagResource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource

func (*Kendra) TagResourceRequest added in v1.30.25 

func (c *Kendra) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource

func (*Kendra) TagResourceWithContext added in v1.30.25 

func (c *Kendra) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UntagResource added in v1.30.25 

func (c *Kendra) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWSKendraFrontendService.

Removes a tag from an index, FAQ, or a data source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceUnavailableException The resource you want to use isn't available. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource

func (*Kendra) UntagResourceRequest added in v1.30.25 

func (c *Kendra) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource

func (*Kendra) UntagResourceWithContext added in v1.30.25 

func (c *Kendra) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateAccessControlConfiguration added in v1.44.55 

func (c *Kendra) UpdateAccessControlConfiguration(input *UpdateAccessControlConfigurationInput) (*UpdateAccessControlConfigurationOutput, error)

UpdateAccessControlConfiguration API operation for AWSKendraFrontendService.

Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.

You call the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document (https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateAccessControlConfiguration for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfiguration

func (*Kendra) UpdateAccessControlConfigurationRequest added in v1.44.55 

func (c *Kendra) UpdateAccessControlConfigurationRequest(input *UpdateAccessControlConfigurationInput) (req *request.Request, output *UpdateAccessControlConfigurationOutput)

UpdateAccessControlConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateAccessControlConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAccessControlConfiguration for more information on using the UpdateAccessControlConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAccessControlConfigurationRequest method.
req, resp := client.UpdateAccessControlConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfiguration

func (*Kendra) UpdateAccessControlConfigurationWithContext added in v1.44.55 

func (c *Kendra) UpdateAccessControlConfigurationWithContext(ctx aws.Context, input *UpdateAccessControlConfigurationInput, opts ...request.Option) (*UpdateAccessControlConfigurationOutput, error)

UpdateAccessControlConfigurationWithContext is the same as UpdateAccessControlConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateAccessControlConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateDataSource 

func (c *Kendra) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)

UpdateDataSource API operation for AWSKendraFrontendService.

Updates an Amazon Kendra data source connector.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateDataSource for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource

func (*Kendra) UpdateDataSourceRequest 

func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)

UpdateDataSourceRequest generates a "aws/request.Request" representing the client's request for the UpdateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDataSource for more information on using the UpdateDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDataSourceRequest method.
req, resp := client.UpdateDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource

func (*Kendra) UpdateDataSourceWithContext 

func (c *Kendra) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)

UpdateDataSourceWithContext is the same as UpdateDataSource with the addition of the ability to pass a context and additional request options.

See UpdateDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateExperience added in v1.42.17 

func (c *Kendra) UpdateExperience(input *UpdateExperienceInput) (*UpdateExperienceOutput, error)

UpdateExperience API operation for AWSKendraFrontendService.

Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateExperience for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperience

func (*Kendra) UpdateExperienceRequest added in v1.42.17 

func (c *Kendra) UpdateExperienceRequest(input *UpdateExperienceInput) (req *request.Request, output *UpdateExperienceOutput)

UpdateExperienceRequest generates a "aws/request.Request" representing the client's request for the UpdateExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateExperience for more information on using the UpdateExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateExperienceRequest method.
req, resp := client.UpdateExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperience

func (*Kendra) UpdateExperienceWithContext added in v1.42.17 

func (c *Kendra) UpdateExperienceWithContext(ctx aws.Context, input *UpdateExperienceInput, opts ...request.Option) (*UpdateExperienceOutput, error)

UpdateExperienceWithContext is the same as UpdateExperience with the addition of the ability to pass a context and additional request options.

See UpdateExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateFeaturedResultsSet added in v1.44.233 

func (c *Kendra) UpdateFeaturedResultsSet(input *UpdateFeaturedResultsSetInput) (*UpdateFeaturedResultsSetOutput, error)

UpdateFeaturedResultsSet API operation for AWSKendraFrontendService.

Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateFeaturedResultsSet for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • FeaturedResultsConflictException An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateFeaturedResultsSet

func (*Kendra) UpdateFeaturedResultsSetRequest added in v1.44.233 

func (c *Kendra) UpdateFeaturedResultsSetRequest(input *UpdateFeaturedResultsSetInput) (req *request.Request, output *UpdateFeaturedResultsSetOutput)

UpdateFeaturedResultsSetRequest generates a "aws/request.Request" representing the client's request for the UpdateFeaturedResultsSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFeaturedResultsSet for more information on using the UpdateFeaturedResultsSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateFeaturedResultsSetRequest method.
req, resp := client.UpdateFeaturedResultsSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateFeaturedResultsSet

func (*Kendra) UpdateFeaturedResultsSetWithContext added in v1.44.233 

func (c *Kendra) UpdateFeaturedResultsSetWithContext(ctx aws.Context, input *UpdateFeaturedResultsSetInput, opts ...request.Option) (*UpdateFeaturedResultsSetOutput, error)

UpdateFeaturedResultsSetWithContext is the same as UpdateFeaturedResultsSet with the addition of the ability to pass a context and additional request options.

See UpdateFeaturedResultsSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateIndex 

func (c *Kendra) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error)

UpdateIndex API operation for AWSKendraFrontendService.

Updates an Amazon Kendra index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateIndex for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex

func (*Kendra) UpdateIndexRequest 

func (c *Kendra) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput)

UpdateIndexRequest generates a "aws/request.Request" representing the client's request for the UpdateIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateIndex for more information on using the UpdateIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateIndexRequest method.
req, resp := client.UpdateIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex

func (*Kendra) UpdateIndexWithContext 

func (c *Kendra) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error)

UpdateIndexWithContext is the same as UpdateIndex with the addition of the ability to pass a context and additional request options.

See UpdateIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateQuerySuggestionsBlockList added in v1.38.50 

func (c *Kendra) UpdateQuerySuggestionsBlockList(input *UpdateQuerySuggestionsBlockListInput) (*UpdateQuerySuggestionsBlockListOutput, error)

UpdateQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Updates a block list used for query suggestions for an index.

Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

If a block list is updating, then you need to wait for the first update to finish before submitting another update.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList

func (*Kendra) UpdateQuerySuggestionsBlockListRequest added in v1.38.50 

func (c *Kendra) UpdateQuerySuggestionsBlockListRequest(input *UpdateQuerySuggestionsBlockListInput) (req *request.Request, output *UpdateQuerySuggestionsBlockListOutput)

UpdateQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the UpdateQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateQuerySuggestionsBlockList for more information on using the UpdateQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateQuerySuggestionsBlockListRequest method.
req, resp := client.UpdateQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList

func (*Kendra) UpdateQuerySuggestionsBlockListWithContext added in v1.38.50 

func (c *Kendra) UpdateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *UpdateQuerySuggestionsBlockListInput, opts ...request.Option) (*UpdateQuerySuggestionsBlockListOutput, error)

UpdateQuerySuggestionsBlockListWithContext is the same as UpdateQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See UpdateQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateQuerySuggestionsConfig added in v1.38.50 

func (c *Kendra) UpdateQuerySuggestionsConfig(input *UpdateQuerySuggestionsConfigInput) (*UpdateQuerySuggestionsConfigOutput, error)

UpdateQuerySuggestionsConfig API operation for AWSKendraFrontendService.

Updates the settings of query suggestions for an index.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

If an update is currently processing, you need to wait for the update to finish before making another update.

Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

You can still enable/disable query suggestions at any time.

UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateQuerySuggestionsConfig for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig

func (*Kendra) UpdateQuerySuggestionsConfigRequest added in v1.38.50 

func (c *Kendra) UpdateQuerySuggestionsConfigRequest(input *UpdateQuerySuggestionsConfigInput) (req *request.Request, output *UpdateQuerySuggestionsConfigOutput)

UpdateQuerySuggestionsConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateQuerySuggestionsConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateQuerySuggestionsConfig for more information on using the UpdateQuerySuggestionsConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateQuerySuggestionsConfigRequest method.
req, resp := client.UpdateQuerySuggestionsConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig

func (*Kendra) UpdateQuerySuggestionsConfigWithContext added in v1.38.50 

func (c *Kendra) UpdateQuerySuggestionsConfigWithContext(ctx aws.Context, input *UpdateQuerySuggestionsConfigInput, opts ...request.Option) (*UpdateQuerySuggestionsConfigOutput, error)

UpdateQuerySuggestionsConfigWithContext is the same as UpdateQuerySuggestionsConfig with the addition of the ability to pass a context and additional request options.

See UpdateQuerySuggestionsConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateThesaurus added in v1.36.6 

func (c *Kendra) UpdateThesaurus(input *UpdateThesaurusInput) (*UpdateThesaurusOutput, error)

UpdateThesaurus API operation for AWSKendraFrontendService.

Updates a thesaurus for an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateThesaurus for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • ResourceNotFoundException The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.

  • AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

  • InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) for help.

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus

func (*Kendra) UpdateThesaurusRequest added in v1.36.6 

func (c *Kendra) UpdateThesaurusRequest(input *UpdateThesaurusInput) (req *request.Request, output *UpdateThesaurusOutput)

UpdateThesaurusRequest generates a "aws/request.Request" representing the client's request for the UpdateThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateThesaurus for more information on using the UpdateThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateThesaurusRequest method.
req, resp := client.UpdateThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus

func (*Kendra) UpdateThesaurusWithContext added in v1.36.6 

func (c *Kendra) UpdateThesaurusWithContext(ctx aws.Context, input *UpdateThesaurusInput, opts ...request.Option) (*UpdateThesaurusOutput, error)

UpdateThesaurusWithContext is the same as UpdateThesaurus with the addition of the ability to pass a context and additional request options.

See UpdateThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListAccessControlConfigurationsInput added in v1.44.55 

type ListAccessControlConfigurationsInput struct {

	// The identifier of the index for the access control configuration.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of access control configurations to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there's more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of access control configurations.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAccessControlConfigurationsInput) GoString added in v1.44.55 

func (s ListAccessControlConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessControlConfigurationsInput) SetIndexId added in v1.44.55 

func (s *ListAccessControlConfigurationsInput) SetIndexId(v string) *ListAccessControlConfigurationsInput

SetIndexId sets the IndexId field's value.

func (*ListAccessControlConfigurationsInput) SetMaxResults added in v1.44.55 

func (s *ListAccessControlConfigurationsInput) SetMaxResults(v int64) *ListAccessControlConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAccessControlConfigurationsInput) SetNextToken added in v1.44.55 

func (s *ListAccessControlConfigurationsInput) SetNextToken(v string) *ListAccessControlConfigurationsInput

SetNextToken sets the NextToken field's value.

func (ListAccessControlConfigurationsInput) String added in v1.44.55 

func (s ListAccessControlConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessControlConfigurationsInput) Validate added in v1.44.55 

func (s *ListAccessControlConfigurationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAccessControlConfigurationsOutput added in v1.44.55 

type ListAccessControlConfigurationsOutput struct {

	// The details of your access control configurations.
	//
	// AccessControlConfigurations is a required field
	AccessControlConfigurations []*AccessControlConfigurationSummary `type:"list" required:"true"`

	// If the response is truncated, Amazon Kendra returns this token, which you
	// can use in the subsequent request to retrieve the next set of access control
	// configurations.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAccessControlConfigurationsOutput) GoString added in v1.44.55 

func (s ListAccessControlConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessControlConfigurationsOutput) SetAccessControlConfigurations added in v1.44.55 

func (s *ListAccessControlConfigurationsOutput) SetAccessControlConfigurations(v []*AccessControlConfigurationSummary) *ListAccessControlConfigurationsOutput

SetAccessControlConfigurations sets the AccessControlConfigurations field's value.

func (*ListAccessControlConfigurationsOutput) SetNextToken added in v1.44.55 

func (s *ListAccessControlConfigurationsOutput) SetNextToken(v string) *ListAccessControlConfigurationsOutput

SetNextToken sets the NextToken field's value.

func (ListAccessControlConfigurationsOutput) String added in v1.44.55 

func (s ListAccessControlConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDataSourceSyncJobsInput 

type ListDataSourceSyncJobsInput struct {

	// The identifier of the data source connector.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of synchronization jobs to return in the response. If
	// there are fewer results in the list, this response contains only the actual
	// results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of jobs.
	NextToken *string `min:"1" type:"string"`

	// When specified, the synchronization jobs returned in the list are limited
	// to jobs between the specified dates.
	StartTimeFilter *TimeRange `type:"structure"`

	// Only returns synchronization jobs with the Status field equal to the specified
	// status.
	StatusFilter *string `type:"string" enum:"DataSourceSyncJobStatus"`
	// contains filtered or unexported fields
}

func (ListDataSourceSyncJobsInput) GoString 

func (s ListDataSourceSyncJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourceSyncJobsInput) SetId 

func (s *ListDataSourceSyncJobsInput) SetId(v string) *ListDataSourceSyncJobsInput

SetId sets the Id field's value.

func (*ListDataSourceSyncJobsInput) SetIndexId 

func (s *ListDataSourceSyncJobsInput) SetIndexId(v string) *ListDataSourceSyncJobsInput

SetIndexId sets the IndexId field's value.

func (*ListDataSourceSyncJobsInput) SetMaxResults 

func (s *ListDataSourceSyncJobsInput) SetMaxResults(v int64) *ListDataSourceSyncJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourceSyncJobsInput) SetNextToken 

func (s *ListDataSourceSyncJobsInput) SetNextToken(v string) *ListDataSourceSyncJobsInput

SetNextToken sets the NextToken field's value.

func (*ListDataSourceSyncJobsInput) SetStartTimeFilter 

func (s *ListDataSourceSyncJobsInput) SetStartTimeFilter(v *TimeRange) *ListDataSourceSyncJobsInput

SetStartTimeFilter sets the StartTimeFilter field's value.

func (*ListDataSourceSyncJobsInput) SetStatusFilter 

func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput

SetStatusFilter sets the StatusFilter field's value.

func (ListDataSourceSyncJobsInput) String 

func (s ListDataSourceSyncJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourceSyncJobsInput) Validate 

func (s *ListDataSourceSyncJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDataSourceSyncJobsOutput 

type ListDataSourceSyncJobsOutput struct {

	// A history of synchronization jobs for the data source connector.
	History []*DataSourceSyncJob `type:"list"`

	// If the response is truncated, Amazon Kendra returns this token that you can
	// use in the subsequent request to retrieve the next set of jobs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataSourceSyncJobsOutput) GoString 

func (s ListDataSourceSyncJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourceSyncJobsOutput) SetHistory 

func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput

SetHistory sets the History field's value.

func (*ListDataSourceSyncJobsOutput) SetNextToken 

func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyncJobsOutput

SetNextToken sets the NextToken field's value.

func (ListDataSourceSyncJobsOutput) String 

func (s ListDataSourceSyncJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDataSourcesInput 

type ListDataSourcesInput struct {

	// The identifier of the index used with one or more data source connectors.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of data source connectors to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of data source connectors.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataSourcesInput) GoString 

func (s ListDataSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) SetIndexId 

func (s *ListDataSourcesInput) SetIndexId(v string) *ListDataSourcesInput

SetIndexId sets the IndexId field's value.

func (*ListDataSourcesInput) SetMaxResults 

func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourcesInput) SetNextToken 

func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput

SetNextToken sets the NextToken field's value.

func (ListDataSourcesInput) String 

func (s ListDataSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) Validate 

func (s *ListDataSourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDataSourcesOutput 

type ListDataSourcesOutput struct {

	// If the response is truncated, Amazon Kendra returns this token that you can
	// use in the subsequent request to retrieve the next set of data source connectors.
	NextToken *string `min:"1" type:"string"`

	// An array of summary information for one or more data source connector.
	SummaryItems []*DataSourceSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListDataSourcesOutput) GoString 

func (s ListDataSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesOutput) SetNextToken 

func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListDataSourcesOutput) SetSummaryItems 

func (s *ListDataSourcesOutput) SetSummaryItems(v []*DataSourceSummary) *ListDataSourcesOutput

SetSummaryItems sets the SummaryItems field's value.

func (ListDataSourcesOutput) String 

func (s ListDataSourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEntityPersonasInput added in v1.42.17 

type ListEntityPersonasInput struct {

	// The identifier of your Amazon Kendra experience.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of returned users or groups.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of users or groups.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntityPersonasInput) GoString added in v1.42.17 

func (s ListEntityPersonasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntityPersonasInput) SetId added in v1.42.17 

func (s *ListEntityPersonasInput) SetId(v string) *ListEntityPersonasInput

SetId sets the Id field's value.

func (*ListEntityPersonasInput) SetIndexId added in v1.42.17 

func (s *ListEntityPersonasInput) SetIndexId(v string) *ListEntityPersonasInput

SetIndexId sets the IndexId field's value.

func (*ListEntityPersonasInput) SetMaxResults added in v1.42.17 

func (s *ListEntityPersonasInput) SetMaxResults(v int64) *ListEntityPersonasInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntityPersonasInput) SetNextToken added in v1.42.17 

func (s *ListEntityPersonasInput) SetNextToken(v string) *ListEntityPersonasInput

SetNextToken sets the NextToken field's value.

func (ListEntityPersonasInput) String added in v1.42.17 

func (s ListEntityPersonasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntityPersonasInput) Validate added in v1.42.17 

func (s *ListEntityPersonasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEntityPersonasOutput added in v1.42.17 

type ListEntityPersonasOutput struct {

	// If the response is truncated, Amazon Kendra returns this token, which you
	// can use in a later request to retrieve the next set of users or groups.
	NextToken *string `min:"1" type:"string"`

	// An array of summary information for one or more users or groups.
	SummaryItems []*PersonasSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListEntityPersonasOutput) GoString added in v1.42.17 

func (s ListEntityPersonasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntityPersonasOutput) SetNextToken added in v1.42.17 

func (s *ListEntityPersonasOutput) SetNextToken(v string) *ListEntityPersonasOutput

SetNextToken sets the NextToken field's value.

func (*ListEntityPersonasOutput) SetSummaryItems added in v1.42.17 

func (s *ListEntityPersonasOutput) SetSummaryItems(v []*PersonasSummary) *ListEntityPersonasOutput

SetSummaryItems sets the SummaryItems field's value.

func (ListEntityPersonasOutput) String added in v1.42.17 

func (s ListEntityPersonasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExperienceEntitiesInput added in v1.42.17 

type ListExperienceEntitiesInput struct {

	// The identifier of your Amazon Kendra experience.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of users or groups.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExperienceEntitiesInput) GoString added in v1.42.17 

func (s ListExperienceEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExperienceEntitiesInput) SetId added in v1.42.17 

func (s *ListExperienceEntitiesInput) SetId(v string) *ListExperienceEntitiesInput

SetId sets the Id field's value.

func (*ListExperienceEntitiesInput) SetIndexId added in v1.42.17 

func (s *ListExperienceEntitiesInput) SetIndexId(v string) *ListExperienceEntitiesInput

SetIndexId sets the IndexId field's value.

func (*ListExperienceEntitiesInput) SetNextToken added in v1.42.17 

func (s *ListExperienceEntitiesInput) SetNextToken(v string) *ListExperienceEntitiesInput

SetNextToken sets the NextToken field's value.

func (ListExperienceEntitiesInput) String added in v1.42.17 

func (s ListExperienceEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExperienceEntitiesInput) Validate added in v1.42.17 

func (s *ListExperienceEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListExperienceEntitiesOutput added in v1.42.17 

type ListExperienceEntitiesOutput struct {

	// If the response is truncated, Amazon Kendra returns this token, which you
	// can use in a later request to retrieve the next set of users or groups.
	NextToken *string `min:"1" type:"string"`

	// An array of summary information for one or more users or groups.
	SummaryItems []*ExperienceEntitiesSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListExperienceEntitiesOutput) GoString added in v1.42.17 

func (s ListExperienceEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExperienceEntitiesOutput) SetNextToken added in v1.42.17 

func (s *ListExperienceEntitiesOutput) SetNextToken(v string) *ListExperienceEntitiesOutput

SetNextToken sets the NextToken field's value.

func (*ListExperienceEntitiesOutput) SetSummaryItems added in v1.42.17 

func (s *ListExperienceEntitiesOutput) SetSummaryItems(v []*ExperienceEntitiesSummary) *ListExperienceEntitiesOutput

SetSummaryItems sets the SummaryItems field's value.

func (ListExperienceEntitiesOutput) String added in v1.42.17 

func (s ListExperienceEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExperiencesInput added in v1.42.17 

type ListExperiencesInput struct {

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of returned Amazon Kendra experiences.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of Amazon Kendra experiences.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExperiencesInput) GoString added in v1.42.17 

func (s ListExperiencesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExperiencesInput) SetIndexId added in v1.42.17 

func (s *ListExperiencesInput) SetIndexId(v string) *ListExperiencesInput

SetIndexId sets the IndexId field's value.

func (*ListExperiencesInput) SetMaxResults added in v1.42.17 

func (s *ListExperiencesInput) SetMaxResults(v int64) *ListExperiencesInput

SetMaxResults sets the MaxResults field's value.

func (*ListExperiencesInput) SetNextToken added in v1.42.17 

func (s *ListExperiencesInput) SetNextToken(v string) *ListExperiencesInput

SetNextToken sets the NextToken field's value.

func (ListExperiencesInput) String added in v1.42.17 

func (s ListExperiencesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExperiencesInput) Validate added in v1.42.17 

func (s *ListExperiencesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListExperiencesOutput added in v1.42.17 

type ListExperiencesOutput struct {

	// If the response is truncated, Amazon Kendra returns this token, which you
	// can use in a later request to retrieve the next set of Amazon Kendra experiences.
	NextToken *string `min:"1" type:"string"`

	// An array of summary information for one or more Amazon Kendra experiences.
	SummaryItems []*ExperiencesSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListExperiencesOutput) GoString added in v1.42.17 

func (s ListExperiencesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExperiencesOutput) SetNextToken added in v1.42.17 

func (s *ListExperiencesOutput) SetNextToken(v string) *ListExperiencesOutput

SetNextToken sets the NextToken field's value.

func (*ListExperiencesOutput) SetSummaryItems added in v1.42.17 

func (s *ListExperiencesOutput) SetSummaryItems(v []*ExperiencesSummary) *ListExperiencesOutput

SetSummaryItems sets the SummaryItems field's value.

func (ListExperiencesOutput) String added in v1.42.17 

func (s ListExperiencesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFaqsInput 

type ListFaqsInput struct {

	// The index that contains the FAQ lists.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of FAQs to return in the response. If there are fewer
	// results in the list, this response contains only the actual results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of FAQs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFaqsInput) GoString 

func (s ListFaqsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFaqsInput) SetIndexId 

func (s *ListFaqsInput) SetIndexId(v string) *ListFaqsInput

SetIndexId sets the IndexId field's value.

func (*ListFaqsInput) SetMaxResults 

func (s *ListFaqsInput) SetMaxResults(v int64) *ListFaqsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFaqsInput) SetNextToken 

func (s *ListFaqsInput) SetNextToken(v string) *ListFaqsInput

SetNextToken sets the NextToken field's value.

func (ListFaqsInput) String 

func (s ListFaqsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFaqsInput) Validate 

func (s *ListFaqsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFaqsOutput 

type ListFaqsOutput struct {

	// information about the FAQs associated with the specified index.
	FaqSummaryItems []*FaqSummary `type:"list"`

	// If the response is truncated, Amazon Kendra returns this token that you can
	// use in the subsequent request to retrieve the next set of FAQs.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFaqsOutput) GoString 

func (s ListFaqsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFaqsOutput) SetFaqSummaryItems 

func (s *ListFaqsOutput) SetFaqSummaryItems(v []*FaqSummary) *ListFaqsOutput

SetFaqSummaryItems sets the FaqSummaryItems field's value.

func (*ListFaqsOutput) SetNextToken 

func (s *ListFaqsOutput) SetNextToken(v string) *ListFaqsOutput

SetNextToken sets the NextToken field's value.

func (ListFaqsOutput) String 

func (s ListFaqsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFeaturedResultsSetsInput added in v1.44.233 

type ListFeaturedResultsSetsInput struct {

	// The identifier of the index used for featuring results.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of featured results sets to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the response is truncated, Amazon Kendra returns a pagination token in
	// the response. You can use this pagination token to retrieve the next set
	// of featured results sets.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFeaturedResultsSetsInput) GoString added in v1.44.233 

func (s ListFeaturedResultsSetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFeaturedResultsSetsInput) SetIndexId added in v1.44.233 

func (s *ListFeaturedResultsSetsInput) SetIndexId(v string) *ListFeaturedResultsSetsInput

SetIndexId sets the IndexId field's value.

func (*ListFeaturedResultsSetsInput) SetMaxResults added in v1.44.233 

func (s *ListFeaturedResultsSetsInput) SetMaxResults(v int64) *ListFeaturedResultsSetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFeaturedResultsSetsInput) SetNextToken added in v1.44.233 

func (s *ListFeaturedResultsSetsInput) SetNextToken(v string) *ListFeaturedResultsSetsInput

SetNextToken sets the NextToken field's value.

func (ListFeaturedResultsSetsInput) String added in v1.44.233 

func (s ListFeaturedResultsSetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFeaturedResultsSetsInput) Validate added in v1.44.233 

func (s *ListFeaturedResultsSetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFeaturedResultsSetsOutput added in v1.44.233 

type ListFeaturedResultsSetsOutput struct {

	// An array of summary information for one or more featured results sets.
	FeaturedResultsSetSummaryItems []*FeaturedResultsSetSummary `type:"list"`

	// If the response is truncated, Amazon Kendra returns a pagination token in
	// the response.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFeaturedResultsSetsOutput) GoString added in v1.44.233 

func (s ListFeaturedResultsSetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFeaturedResultsSetsOutput) SetFeaturedResultsSetSummaryItems added in v1.44.233 

func (s *ListFeaturedResultsSetsOutput) SetFeaturedResultsSetSummaryItems(v []*FeaturedResultsSetSummary) *ListFeaturedResultsSetsOutput

SetFeaturedResultsSetSummaryItems sets the FeaturedResultsSetSummaryItems field's value.

func (*ListFeaturedResultsSetsOutput) SetNextToken added in v1.44.233 

func (s *ListFeaturedResultsSetsOutput) SetNextToken(v string) *ListFeaturedResultsSetsOutput

SetNextToken sets the NextToken field's value.

func (ListFeaturedResultsSetsOutput) String added in v1.44.233 

func (s ListFeaturedResultsSetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGroupsOlderThanOrderingIdInput added in v1.39.5 

type ListGroupsOlderThanOrderingIdInput struct {

	// The identifier of the data source for getting a list of groups mapped to
	// users before a given ordering timestamp identifier.
	DataSourceId *string `min:"1" type:"string"`

	// The identifier of the index for getting a list of groups mapped to users
	// before a given ordering or timestamp identifier.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of returned groups that are mapped to users before a given
	// ordering or timestamp identifier.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of groups that are mapped to users
	// before a given ordering or timestamp identifier.
	NextToken *string `min:"1" type:"string"`

	// The timestamp identifier used for the latest PUT or DELETE action for mapping
	// users to their groups.
	//
	// OrderingId is a required field
	OrderingId *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (ListGroupsOlderThanOrderingIdInput) GoString added in v1.39.5 

func (s ListGroupsOlderThanOrderingIdInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGroupsOlderThanOrderingIdInput) SetDataSourceId added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdInput) SetDataSourceId(v string) *ListGroupsOlderThanOrderingIdInput

SetDataSourceId sets the DataSourceId field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetIndexId added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdInput) SetIndexId(v string) *ListGroupsOlderThanOrderingIdInput

SetIndexId sets the IndexId field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetMaxResults added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdInput) SetMaxResults(v int64) *ListGroupsOlderThanOrderingIdInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetNextToken added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdInput) SetNextToken(v string) *ListGroupsOlderThanOrderingIdInput

SetNextToken sets the NextToken field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetOrderingId added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdInput) SetOrderingId(v int64) *ListGroupsOlderThanOrderingIdInput

SetOrderingId sets the OrderingId field's value.

func (ListGroupsOlderThanOrderingIdInput) String added in v1.39.5 

func (s ListGroupsOlderThanOrderingIdInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGroupsOlderThanOrderingIdInput) Validate added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGroupsOlderThanOrderingIdOutput added in v1.39.5 

type ListGroupsOlderThanOrderingIdOutput struct {

	// Summary information for list of groups that are mapped to users before a
	// given ordering or timestamp identifier.
	GroupsSummaries []*GroupSummary `type:"list"`

	// If the response is truncated, Amazon Kendra returns this token that you can
	// use in the subsequent request to retrieve the next set of groups that are
	// mapped to users before a given ordering or timestamp identifier.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupsOlderThanOrderingIdOutput) GoString added in v1.39.5 

func (s ListGroupsOlderThanOrderingIdOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGroupsOlderThanOrderingIdOutput) SetGroupsSummaries added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdOutput) SetGroupsSummaries(v []*GroupSummary) *ListGroupsOlderThanOrderingIdOutput

SetGroupsSummaries sets the GroupsSummaries field's value.

func (*ListGroupsOlderThanOrderingIdOutput) SetNextToken added in v1.39.5 

func (s *ListGroupsOlderThanOrderingIdOutput) SetNextToken(v string) *ListGroupsOlderThanOrderingIdOutput

SetNextToken sets the NextToken field's value.

func (ListGroupsOlderThanOrderingIdOutput) String added in v1.39.5 

func (s ListGroupsOlderThanOrderingIdOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListIndicesInput 

type ListIndicesInput struct {

	// The maximum number of indices to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of indexes.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListIndicesInput) GoString 

func (s ListIndicesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndicesInput) SetMaxResults 

func (s *ListIndicesInput) SetMaxResults(v int64) *ListIndicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListIndicesInput) SetNextToken 

func (s *ListIndicesInput) SetNextToken(v string) *ListIndicesInput

SetNextToken sets the NextToken field's value.

func (ListIndicesInput) String 

func (s ListIndicesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndicesInput) Validate 

func (s *ListIndicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIndicesOutput 

type ListIndicesOutput struct {

	// An array of summary information on the configuration of one or more indexes.
	IndexConfigurationSummaryItems []*IndexConfigurationSummary `type:"list"`

	// If the response is truncated, Amazon Kendra returns this token that you can
	// use in the subsequent request to retrieve the next set of indexes.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListIndicesOutput) GoString 

func (s ListIndicesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndicesOutput) SetIndexConfigurationSummaryItems 

func (s *ListIndicesOutput) SetIndexConfigurationSummaryItems(v []*IndexConfigurationSummary) *ListIndicesOutput

SetIndexConfigurationSummaryItems sets the IndexConfigurationSummaryItems field's value.

func (*ListIndicesOutput) SetNextToken 

func (s *ListIndicesOutput) SetNextToken(v string) *ListIndicesOutput

SetNextToken sets the NextToken field's value.

func (ListIndicesOutput) String 

func (s ListIndicesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListQuerySuggestionsBlockListsInput added in v1.38.50 

type ListQuerySuggestionsBlockListsInput struct {

	// The identifier of the index for a list of all block lists that exist for
	// that index.
	//
	// For information on the current quota limits for block lists, see Quotas for
	// Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of block lists to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of block lists (BlockListSummaryItems).
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListQuerySuggestionsBlockListsInput) GoString added in v1.38.50 

func (s ListQuerySuggestionsBlockListsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuerySuggestionsBlockListsInput) SetIndexId added in v1.38.50 

func (s *ListQuerySuggestionsBlockListsInput) SetIndexId(v string) *ListQuerySuggestionsBlockListsInput

SetIndexId sets the IndexId field's value.

func (*ListQuerySuggestionsBlockListsInput) SetMaxResults added in v1.38.50 

func (s *ListQuerySuggestionsBlockListsInput) SetMaxResults(v int64) *ListQuerySuggestionsBlockListsInput

SetMaxResults sets the MaxResults field's value.

func (*ListQuerySuggestionsBlockListsInput) SetNextToken added in v1.38.50 

func (s *ListQuerySuggestionsBlockListsInput) SetNextToken(v string) *ListQuerySuggestionsBlockListsInput

SetNextToken sets the NextToken field's value.

func (ListQuerySuggestionsBlockListsInput) String added in v1.38.50 

func (s ListQuerySuggestionsBlockListsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuerySuggestionsBlockListsInput) Validate added in v1.38.50 

func (s *ListQuerySuggestionsBlockListsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListQuerySuggestionsBlockListsOutput added in v1.38.50 

type ListQuerySuggestionsBlockListsOutput struct {

	// Summary items for a block list.
	//
	// This includes summary items on the block list ID, block list name, when the
	// block list was created, when the block list was last updated, and the count
	// of block words/phrases in the block list.
	//
	// For information on the current quota limits for block lists, see Quotas for
	// Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	BlockListSummaryItems []*QuerySuggestionsBlockListSummary `type:"list"`

	// If the response is truncated, Amazon Kendra returns this token that you can
	// use in the subsequent request to retrieve the next set of block lists.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListQuerySuggestionsBlockListsOutput) GoString added in v1.38.50 

func (s ListQuerySuggestionsBlockListsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuerySuggestionsBlockListsOutput) SetBlockListSummaryItems added in v1.38.50 

func (s *ListQuerySuggestionsBlockListsOutput) SetBlockListSummaryItems(v []*QuerySuggestionsBlockListSummary) *ListQuerySuggestionsBlockListsOutput

SetBlockListSummaryItems sets the BlockListSummaryItems field's value.

func (*ListQuerySuggestionsBlockListsOutput) SetNextToken added in v1.38.50 

func (s *ListQuerySuggestionsBlockListsOutput) SetNextToken(v string) *ListQuerySuggestionsBlockListsOutput

SetNextToken sets the NextToken field's value.

func (ListQuerySuggestionsBlockListsOutput) String added in v1.38.50 

func (s ListQuerySuggestionsBlockListsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.30.25 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a
	// list of tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.30.25 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN added in v1.30.25 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.30.25 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.30.25 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.30.25 

type ListTagsForResourceOutput struct {

	// A list of tags associated with the index, FAQ, or data source.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.30.25 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.30.25 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.30.25 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListThesauriInput added in v1.36.6 

type ListThesauriInput struct {

	// The identifier of the index with one or more thesauri.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The maximum number of thesauri to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous response was incomplete (because there is more data to retrieve),
	// Amazon Kendra returns a pagination token in the response. You can use this
	// pagination token to retrieve the next set of thesauri (ThesaurusSummaryItems).
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListThesauriInput) GoString added in v1.36.6 

func (s ListThesauriInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThesauriInput) SetIndexId added in v1.36.6 

func (s *ListThesauriInput) SetIndexId(v string) *ListThesauriInput

SetIndexId sets the IndexId field's value.

func (*ListThesauriInput) SetMaxResults added in v1.36.6 

func (s *ListThesauriInput) SetMaxResults(v int64) *ListThesauriInput

SetMaxResults sets the MaxResults field's value.

func (*ListThesauriInput) SetNextToken added in v1.36.6 

func (s *ListThesauriInput) SetNextToken(v string) *ListThesauriInput

SetNextToken sets the NextToken field's value.

func (ListThesauriInput) String added in v1.36.6 

func (s ListThesauriInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThesauriInput) Validate added in v1.36.6 

func (s *ListThesauriInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListThesauriOutput added in v1.36.6 

type ListThesauriOutput struct {

	// If the response is truncated, Amazon Kendra returns this token that you can
	// use in the subsequent request to retrieve the next set of thesauri.
	NextToken *string `min:"1" type:"string"`

	// An array of summary information for a thesaurus or multiple thesauri.
	ThesaurusSummaryItems []*ThesaurusSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListThesauriOutput) GoString added in v1.36.6 

func (s ListThesauriOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThesauriOutput) SetNextToken added in v1.36.6 

func (s *ListThesauriOutput) SetNextToken(v string) *ListThesauriOutput

SetNextToken sets the NextToken field's value.

func (*ListThesauriOutput) SetThesaurusSummaryItems added in v1.36.6 

func (s *ListThesauriOutput) SetThesaurusSummaryItems(v []*ThesaurusSummary) *ListThesauriOutput

SetThesaurusSummaryItems sets the ThesaurusSummaryItems field's value.

func (ListThesauriOutput) String added in v1.36.6 

func (s ListThesauriOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MemberGroup added in v1.39.5 

type MemberGroup struct {

	// The identifier of the data source for the sub group you want to map to a
	// group.
	DataSourceId *string `min:"1" type:"string"`

	// The identifier of the sub group you want to map to a group.
	//
	// GroupId is a required field
	GroupId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The sub groups that belong to a group.

func (MemberGroup) GoString added in v1.39.5 

func (s MemberGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberGroup) SetDataSourceId added in v1.39.5 

func (s *MemberGroup) SetDataSourceId(v string) *MemberGroup

SetDataSourceId sets the DataSourceId field's value.

func (*MemberGroup) SetGroupId added in v1.39.5 

func (s *MemberGroup) SetGroupId(v string) *MemberGroup

SetGroupId sets the GroupId field's value.

func (MemberGroup) String added in v1.39.5 

func (s MemberGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberGroup) Validate added in v1.39.5 

func (s *MemberGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MemberUser added in v1.39.5 

type MemberUser struct {

	// The identifier of the user you want to map to a group.
	//
	// UserId is a required field
	UserId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The users that belong to a group.

func (MemberUser) GoString added in v1.39.5 

func (s MemberUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberUser) SetUserId added in v1.39.5 

func (s *MemberUser) SetUserId(v string) *MemberUser

SetUserId sets the UserId field's value.

func (MemberUser) String added in v1.39.5 

func (s MemberUser) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberUser) Validate added in v1.39.5 

func (s *MemberUser) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OnPremiseConfiguration added in v1.44.27 

type OnPremiseConfiguration struct {

	// The GitHub host URL or API endpoint URL. For example, https://on-prem-host-url/api/v3/
	//
	// HostUrl is a required field
	HostUrl *string `min:"1" type:"string" required:"true"`

	// The name of the organization of the GitHub Enterprise Server (on-premises)
	// account you want to connect to. You can find your organization name by logging
	// into GitHub desktop and selecting Your organizations under your profile picture
	// dropdown.
	//
	// OrganizationName is a required field
	OrganizationName *string `min:"1" type:"string" required:"true"`

	// The path to the SSL certificate stored in an Amazon S3 bucket. You use this
	// to connect to GitHub if you require a secure SSL connection.
	//
	// You can simply generate a self-signed X509 certificate on any computer using
	// OpenSSL. For an example of using OpenSSL to create an X509 certificate, see
	// Create and sign an X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html).
	//
	// SslCertificateS3Path is a required field
	SslCertificateS3Path *S3Path `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to GitHub Enterprise Server (on premises).

func (OnPremiseConfiguration) GoString added in v1.44.27 

func (s OnPremiseConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OnPremiseConfiguration) SetHostUrl added in v1.44.27 

func (s *OnPremiseConfiguration) SetHostUrl(v string) *OnPremiseConfiguration

SetHostUrl sets the HostUrl field's value.

func (*OnPremiseConfiguration) SetOrganizationName added in v1.44.27 

func (s *OnPremiseConfiguration) SetOrganizationName(v string) *OnPremiseConfiguration

SetOrganizationName sets the OrganizationName field's value.

func (*OnPremiseConfiguration) SetSslCertificateS3Path added in v1.44.27 

func (s *OnPremiseConfiguration) SetSslCertificateS3Path(v *S3Path) *OnPremiseConfiguration

SetSslCertificateS3Path sets the SslCertificateS3Path field's value.

func (OnPremiseConfiguration) String added in v1.44.27 

func (s OnPremiseConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OnPremiseConfiguration) Validate added in v1.44.27 

func (s *OnPremiseConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OneDriveConfiguration added in v1.30.25 

type OneDriveConfiguration struct {

	// TRUE to disable local groups information.
	DisableLocalGroups *bool `type:"boolean"`

	// A list of regular expression patterns to exclude certain documents in your
	// OneDrive. Documents that match the patterns are excluded from the index.
	// Documents that don't match the patterns are included in the index. If a document
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the document isn't included in the index.
	//
	// The pattern is applied to the file name.
	ExclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map OneDrive data source
	// attributes or field names to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to OneDrive fields. For more
	// information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The OneDrive data source field names must exist in your OneDrive custom metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain documents in your
	// OneDrive. Documents that match the patterns are included in the index. Documents
	// that don't match the patterns are excluded from the index. If a document
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the document isn't included in the index.
	//
	// The pattern is applied to the file name.
	InclusionPatterns []*string `type:"list"`

	// A list of user accounts whose documents should be indexed.
	//
	// OneDriveUsers is a required field
	OneDriveUsers *OneDriveUsers `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of an Secrets Managersecret that contains
	// the user name and password to connect to OneDrive. The user name should be
	// the application ID for the OneDrive application, and the password is the
	// application key for the OneDrive application.
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The Azure Active Directory domain of the organization.
	//
	// TenantDomain is a required field
	TenantDomain *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to OneDrive as your data source.

func (OneDriveConfiguration) GoString added in v1.30.25 

func (s OneDriveConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveConfiguration) SetDisableLocalGroups added in v1.35.22 

func (s *OneDriveConfiguration) SetDisableLocalGroups(v bool) *OneDriveConfiguration

SetDisableLocalGroups sets the DisableLocalGroups field's value.

func (*OneDriveConfiguration) SetExclusionPatterns added in v1.30.25 

func (s *OneDriveConfiguration) SetExclusionPatterns(v []*string) *OneDriveConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*OneDriveConfiguration) SetFieldMappings added in v1.30.25 

func (s *OneDriveConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *OneDriveConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*OneDriveConfiguration) SetInclusionPatterns added in v1.30.25 

func (s *OneDriveConfiguration) SetInclusionPatterns(v []*string) *OneDriveConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*OneDriveConfiguration) SetOneDriveUsers added in v1.30.25 

func (s *OneDriveConfiguration) SetOneDriveUsers(v *OneDriveUsers) *OneDriveConfiguration

SetOneDriveUsers sets the OneDriveUsers field's value.

func (*OneDriveConfiguration) SetSecretArn added in v1.30.25 

func (s *OneDriveConfiguration) SetSecretArn(v string) *OneDriveConfiguration

SetSecretArn sets the SecretArn field's value.

func (*OneDriveConfiguration) SetTenantDomain added in v1.30.25 

func (s *OneDriveConfiguration) SetTenantDomain(v string) *OneDriveConfiguration

SetTenantDomain sets the TenantDomain field's value.

func (OneDriveConfiguration) String added in v1.30.25 

func (s OneDriveConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveConfiguration) Validate added in v1.30.25 

func (s *OneDriveConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OneDriveUsers added in v1.30.25 

type OneDriveUsers struct {

	// A list of users whose documents should be indexed. Specify the user names
	// in email format, for example, username@tenantdomain. If you need to index
	// the documents of more than 100 users, use the OneDriveUserS3Path field to
	// specify the location of a file containing a list of users.
	OneDriveUserList []*string `min:"1" type:"list"`

	// The S3 bucket location of a file containing a list of users whose documents
	// should be indexed.
	OneDriveUserS3Path *S3Path `type:"structure"`
	// contains filtered or unexported fields
}

User accounts whose documents should be indexed.

func (OneDriveUsers) GoString added in v1.30.25 

func (s OneDriveUsers) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveUsers) SetOneDriveUserList added in v1.30.25 

func (s *OneDriveUsers) SetOneDriveUserList(v []*string) *OneDriveUsers

SetOneDriveUserList sets the OneDriveUserList field's value.

func (*OneDriveUsers) SetOneDriveUserS3Path added in v1.30.25 

func (s *OneDriveUsers) SetOneDriveUserS3Path(v *S3Path) *OneDriveUsers

SetOneDriveUserS3Path sets the OneDriveUserS3Path field's value.

func (OneDriveUsers) String added in v1.30.25 

func (s OneDriveUsers) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveUsers) Validate added in v1.30.25 

func (s *OneDriveUsers) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PersonasSummary added in v1.42.17 

type PersonasSummary struct {

	// The Unix timestamp when the summary information was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of a user or group in your IAM Identity Center identity source.
	// For example, a user ID could be an email.
	EntityId *string `min:"1" type:"string"`

	// The persona that defines the specific permissions of the user or group in
	// your IAM Identity Center identity source. The available personas or access
	// roles are Owner and Viewer. For more information on these personas, see Providing
	// access to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience).
	Persona *string `type:"string" enum:"Persona"`

	// The Unix timestamp when the summary information was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Summary information for users or groups in your IAM Identity Center identity source. This applies to users and groups with specific permissions that define their level of access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

func (PersonasSummary) GoString added in v1.42.17 

func (s PersonasSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PersonasSummary) SetCreatedAt added in v1.42.17 

func (s *PersonasSummary) SetCreatedAt(v time.Time) *PersonasSummary

SetCreatedAt sets the CreatedAt field's value.

func (*PersonasSummary) SetEntityId added in v1.42.17 

func (s *PersonasSummary) SetEntityId(v string) *PersonasSummary

SetEntityId sets the EntityId field's value.

func (*PersonasSummary) SetPersona added in v1.42.17 

func (s *PersonasSummary) SetPersona(v string) *PersonasSummary

SetPersona sets the Persona field's value.

func (*PersonasSummary) SetUpdatedAt added in v1.42.17 

func (s *PersonasSummary) SetUpdatedAt(v time.Time) *PersonasSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (PersonasSummary) String added in v1.42.17 

func (s PersonasSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Principal 

type Principal struct {

	// Whether to allow or deny document access to the principal.
	//
	// Access is a required field
	Access *string `type:"string" required:"true" enum:"ReadAccessType"`

	// The identifier of the data source the principal should access documents from.
	DataSourceId *string `min:"1" type:"string"`

	// The name of the user or group.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The type of principal.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"PrincipalType"`
	// contains filtered or unexported fields
}

Provides user and group information for user context filtering (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).

func (Principal) GoString 

func (s Principal) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Principal) SetAccess 

func (s *Principal) SetAccess(v string) *Principal

SetAccess sets the Access field's value.

func (*Principal) SetDataSourceId added in v1.39.5 

func (s *Principal) SetDataSourceId(v string) *Principal

SetDataSourceId sets the DataSourceId field's value.

func (*Principal) SetName 

func (s *Principal) SetName(v string) *Principal

SetName sets the Name field's value.

func (*Principal) SetType 

func (s *Principal) SetType(v string) *Principal

SetType sets the Type field's value.

func (Principal) String 

func (s Principal) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Principal) Validate 

func (s *Principal) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ProxyConfiguration added in v1.38.64 

type ProxyConfiguration struct {

	// Your secret ARN, which you can create in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
	//
	// The credentials are optional. You use a secret if web proxy credentials are
	// required to connect to a website host. Amazon Kendra currently support basic
	// authentication to connect to a web proxy server. The secret stores your credentials.
	Credentials *string `min:"1" type:"string"`

	// The name of the website host you want to connect to via a web proxy server.
	//
	// For example, the host name of https://a.example.com/page1.html is "a.example.com".
	//
	// Host is a required field
	Host *string `min:"1" type:"string" required:"true"`

	// The port number of the website host you want to connect to via a web proxy
	// server.
	//
	// For example, the port for https://a.example.com/page1.html is 443, the standard
	// port for HTTPS.
	//
	// Port is a required field
	Port *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information for a web proxy to connect to website hosts.

func (ProxyConfiguration) GoString added in v1.38.64 

func (s ProxyConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProxyConfiguration) SetCredentials added in v1.38.64 

func (s *ProxyConfiguration) SetCredentials(v string) *ProxyConfiguration

SetCredentials sets the Credentials field's value.

func (*ProxyConfiguration) SetHost added in v1.38.64 

func (s *ProxyConfiguration) SetHost(v string) *ProxyConfiguration

SetHost sets the Host field's value.

func (*ProxyConfiguration) SetPort added in v1.38.64 

func (s *ProxyConfiguration) SetPort(v int64) *ProxyConfiguration

SetPort sets the Port field's value.

func (ProxyConfiguration) String added in v1.38.64 

func (s ProxyConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProxyConfiguration) Validate added in v1.38.64 

func (s *ProxyConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPrincipalMappingInput added in v1.39.5 

type PutPrincipalMappingInput struct {

	// The identifier of the data source you want to map users to their groups.
	//
	// This is useful if a group is tied to multiple data sources, but you only
	// want the group to access documents of a certain data source. For example,
	// the groups "Research", "Engineering", and "Sales and Marketing" are all tied
	// to the company's documents stored in the data sources Confluence and Salesforce.
	// However, "Sales and Marketing" team only needs access to customer-related
	// documents stored in Salesforce.
	DataSourceId *string `min:"1" type:"string"`

	// The identifier of the group you want to map its users to.
	//
	// GroupId is a required field
	GroupId *string `min:"1" type:"string" required:"true"`

	// The list that contains your users or sub groups that belong the same group.
	//
	// For example, the group "Company" includes the user "CEO" and the sub groups
	// "Research", "Engineering", and "Sales and Marketing".
	//
	// If you have more than 1000 users and/or sub groups for a single group, you
	// need to provide the path to the S3 file that lists your users and sub groups
	// for a group. Your sub groups can contain more than 1000 users, but the list
	// of sub groups that belong to a group (and/or users) must be no more than
	// 1000.
	//
	// GroupMembers is a required field
	GroupMembers *GroupMembers `type:"structure" required:"true"`

	// The identifier of the index you want to map users to their groups.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The timestamp identifier you specify to ensure Amazon Kendra does not override
	// the latest PUT action with previous actions. The highest number ID, which
	// is the ordering ID, is the latest action you want to process and apply on
	// top of other actions with lower number IDs. This prevents previous actions
	// with lower number IDs from possibly overriding the latest action.
	//
	// The ordering ID can be the Unix time of the last update you made to a group
	// members list. You would then provide this list when calling PutPrincipalMapping.
	// This ensures your PUT action for that updated group with the latest members
	// list doesn't get overwritten by earlier PUT actions for the same group which
	// are yet to be processed.
	//
	// The default ordering ID is the current Unix time in milliseconds that the
	// action was received by Amazon Kendra.
	OrderingId *int64 `type:"long"`

	// The Amazon Resource Name (ARN) of a role that has access to the S3 file that
	// contains your list of users or sub groups that belong to a group.
	//
	// For more information, see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutPrincipalMappingInput) GoString added in v1.39.5 

func (s PutPrincipalMappingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPrincipalMappingInput) SetDataSourceId added in v1.39.5 

func (s *PutPrincipalMappingInput) SetDataSourceId(v string) *PutPrincipalMappingInput

SetDataSourceId sets the DataSourceId field's value.

func (*PutPrincipalMappingInput) SetGroupId added in v1.39.5 

func (s *PutPrincipalMappingInput) SetGroupId(v string) *PutPrincipalMappingInput

SetGroupId sets the GroupId field's value.

func (*PutPrincipalMappingInput) SetGroupMembers added in v1.39.5 

func (s *PutPrincipalMappingInput) SetGroupMembers(v *GroupMembers) *PutPrincipalMappingInput

SetGroupMembers sets the GroupMembers field's value.

func (*PutPrincipalMappingInput) SetIndexId added in v1.39.5 

func (s *PutPrincipalMappingInput) SetIndexId(v string) *PutPrincipalMappingInput

SetIndexId sets the IndexId field's value.

func (*PutPrincipalMappingInput) SetOrderingId added in v1.39.5 

func (s *PutPrincipalMappingInput) SetOrderingId(v int64) *PutPrincipalMappingInput

SetOrderingId sets the OrderingId field's value.

func (*PutPrincipalMappingInput) SetRoleArn added in v1.39.5 

func (s *PutPrincipalMappingInput) SetRoleArn(v string) *PutPrincipalMappingInput

SetRoleArn sets the RoleArn field's value.

func (PutPrincipalMappingInput) String added in v1.39.5 

func (s PutPrincipalMappingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPrincipalMappingInput) Validate added in v1.39.5 

func (s *PutPrincipalMappingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPrincipalMappingOutput added in v1.39.5 

type PutPrincipalMappingOutput struct {
	// contains filtered or unexported fields
}

func (PutPrincipalMappingOutput) GoString added in v1.39.5 

func (s PutPrincipalMappingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutPrincipalMappingOutput) String added in v1.39.5 

func (s PutPrincipalMappingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryInput 

type QueryInput struct {

	// Filters search results by document fields/attributes. You can only provide
	// one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters
	// parameters contain a list of other filters.
	//
	// The AttributeFilter parameter means you can create a set of filtering rules
	// that a document must satisfy to be included in the query results.
	AttributeFilter *AttributeFilter `type:"structure"`

	// Provides configuration to determine how to group results by document attribute
	// value, and how to display them (collapsed or expanded) under a designated
	// primary document for each group.
	CollapseConfiguration *CollapseConfiguration `type:"structure"`

	// Overrides relevance tuning configurations of fields/attributes set at the
	// index level.
	//
	// If you use this API to override the relevance tuning configured at the index
	// level, but there is no relevance tuning configured at the index level, then
	// Amazon Kendra does not apply any relevance tuning.
	//
	// If there is relevance tuning configured for fields at the index level, and
	// you use this API to override only some of these fields, then for the fields
	// you did not override, the importance is set to 1.
	DocumentRelevanceOverrideConfigurations []*DocumentRelevanceConfiguration `type:"list"`

	// An array of documents fields/attributes for faceted search. Amazon Kendra
	// returns a count for each field key specified. This helps your users narrow
	// their search.
	Facets []*Facet `type:"list"`

	// The identifier of the index for the search.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// Query results are returned in pages the size of the PageSize parameter. By
	// default, Amazon Kendra returns the first page of results. Use this parameter
	// to get result pages after the first one.
	PageNumber *int64 `type:"integer"`

	// Sets the number of results that are returned in each page of results. The
	// default page size is 10. The maximum number of results returned is 100. If
	// you ask for more than 100 results, only 100 are returned.
	PageSize *int64 `type:"integer"`

	// Sets the type of query result or response. Only results for the specified
	// type are returned.
	QueryResultTypeFilter *string `type:"string" enum:"QueryResultType"`

	// The input query text for the search. Amazon Kendra truncates queries at 30
	// token words, which excludes punctuation and stop words. Truncation still
	// applies if you use Boolean or more advanced, complex queries. For example,
	// Timeoff AND October AND Category:HR is counted as 3 tokens: timeoff, october,
	// hr. For more information, see Searching with advanced query syntax (https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax)
	// in the Amazon Kendra Developer Guide.
	QueryText *string `type:"string"`

	// An array of document fields/attributes to include in the response. You can
	// limit the response to include certain document fields. By default, all document
	// attributes are included in the response.
	RequestedDocumentAttributes []*string `min:"1" type:"list"`

	// Provides information that determines how the results of the query are sorted.
	// You can set the field that Amazon Kendra should sort the results on, and
	// specify whether the results should be sorted in ascending or descending order.
	// In the case of ties in sorting the results, the results are sorted by relevance.
	//
	// If you don't provide sorting configuration, the results are sorted by the
	// relevance that Amazon Kendra determines for the result.
	SortingConfiguration *SortingConfiguration `type:"structure"`

	// Provides configuration information to determine how the results of a query
	// are sorted.
	//
	// You can set upto 3 fields that Amazon Kendra should sort the results on,
	// and specify whether the results should be sorted in ascending or descending
	// order. The sort field quota can be increased.
	//
	// If you don't provide a sorting configuration, the results are sorted by the
	// relevance that Amazon Kendra determines for the result. In the case of ties
	// in sorting the results, the results are sorted by relevance.
	SortingConfigurations []*SortingConfiguration `min:"1" type:"list"`

	// Enables suggested spell corrections for queries.
	SpellCorrectionConfiguration *SpellCorrectionConfiguration `type:"structure"`

	// The user context token or user and group information.
	UserContext *UserContext `type:"structure"`

	// Provides an identifier for a specific user. The VisitorId should be a unique
	// identifier, such as a GUID. Don't use personally identifiable information,
	// such as the user's email address, as the VisitorId.
	VisitorId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (QueryInput) GoString 

func (s QueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryInput) SetAttributeFilter 

func (s *QueryInput) SetAttributeFilter(v *AttributeFilter) *QueryInput

SetAttributeFilter sets the AttributeFilter field's value.

func (*QueryInput) SetCollapseConfiguration added in v1.45.28 

func (s *QueryInput) SetCollapseConfiguration(v *CollapseConfiguration) *QueryInput

SetCollapseConfiguration sets the CollapseConfiguration field's value.

func (*QueryInput) SetDocumentRelevanceOverrideConfigurations added in v1.38.23 

func (s *QueryInput) SetDocumentRelevanceOverrideConfigurations(v []*DocumentRelevanceConfiguration) *QueryInput

SetDocumentRelevanceOverrideConfigurations sets the DocumentRelevanceOverrideConfigurations field's value.

func (*QueryInput) SetFacets 

func (s *QueryInput) SetFacets(v []*Facet) *QueryInput

SetFacets sets the Facets field's value.

func (*QueryInput) SetIndexId 

func (s *QueryInput) SetIndexId(v string) *QueryInput

SetIndexId sets the IndexId field's value.

func (*QueryInput) SetPageNumber 

func (s *QueryInput) SetPageNumber(v int64) *QueryInput

SetPageNumber sets the PageNumber field's value.

func (*QueryInput) SetPageSize 

func (s *QueryInput) SetPageSize(v int64) *QueryInput

SetPageSize sets the PageSize field's value.

func (*QueryInput) SetQueryResultTypeFilter 

func (s *QueryInput) SetQueryResultTypeFilter(v string) *QueryInput

SetQueryResultTypeFilter sets the QueryResultTypeFilter field's value.

func (*QueryInput) SetQueryText 

func (s *QueryInput) SetQueryText(v string) *QueryInput

SetQueryText sets the QueryText field's value.

func (*QueryInput) SetRequestedDocumentAttributes 

func (s *QueryInput) SetRequestedDocumentAttributes(v []*string) *QueryInput

SetRequestedDocumentAttributes sets the RequestedDocumentAttributes field's value.

func (*QueryInput) SetSortingConfiguration added in v1.33.12 

func (s *QueryInput) SetSortingConfiguration(v *SortingConfiguration) *QueryInput

SetSortingConfiguration sets the SortingConfiguration field's value.

func (*QueryInput) SetSortingConfigurations added in v1.45.28 

func (s *QueryInput) SetSortingConfigurations(v []*SortingConfiguration) *QueryInput

SetSortingConfigurations sets the SortingConfigurations field's value.

func (*QueryInput) SetSpellCorrectionConfiguration added in v1.43.11 

func (s *QueryInput) SetSpellCorrectionConfiguration(v *SpellCorrectionConfiguration) *QueryInput

SetSpellCorrectionConfiguration sets the SpellCorrectionConfiguration field's value.

func (*QueryInput) SetUserContext added in v1.35.22 

func (s *QueryInput) SetUserContext(v *UserContext) *QueryInput

SetUserContext sets the UserContext field's value.

func (*QueryInput) SetVisitorId added in v1.36.4 

func (s *QueryInput) SetVisitorId(v string) *QueryInput

SetVisitorId sets the VisitorId field's value.

func (QueryInput) String 

func (s QueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryInput) Validate 

func (s *QueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueryOutput 

type QueryOutput struct {

	// Contains the facet results. A FacetResult contains the counts for each field/attribute
	// key that was specified in the Facets input parameter.
	FacetResults []*FacetResult `type:"list"`

	// The list of featured result items. Featured results are displayed at the
	// top of the search results page, placed above all other results for certain
	// queries. If there's an exact match of a query, then certain documents are
	// featured in the search results.
	FeaturedResultsItems []*FeaturedResultsItem `type:"list"`

	// The identifier for the search. You also use QueryId to identify the search
	// when using the SubmitFeedback (https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html)
	// API.
	QueryId *string `min:"1" type:"string"`

	// The results of the search.
	ResultItems []*QueryResultItem `type:"list"`

	// A list of information related to suggested spell corrections for a query.
	SpellCorrectedQueries []*SpellCorrectedQuery `type:"list"`

	// The total number of items found by the search. However, you can only retrieve
	// up to 100 items. For example, if the search found 192 items, you can only
	// retrieve the first 100 of the items.
	TotalNumberOfResults *int64 `type:"integer"`

	// A list of warning codes and their messages on problems with your query.
	//
	// Amazon Kendra currently only supports one type of warning, which is a warning
	// on invalid syntax used in the query. For examples of invalid query syntax,
	// see Searching with advanced query syntax (https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax).
	Warnings []*Warning `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (QueryOutput) GoString 

func (s QueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryOutput) SetFacetResults 

func (s *QueryOutput) SetFacetResults(v []*FacetResult) *QueryOutput

SetFacetResults sets the FacetResults field's value.

func (*QueryOutput) SetFeaturedResultsItems added in v1.44.233 

func (s *QueryOutput) SetFeaturedResultsItems(v []*FeaturedResultsItem) *QueryOutput

SetFeaturedResultsItems sets the FeaturedResultsItems field's value.

func (*QueryOutput) SetQueryId 

func (s *QueryOutput) SetQueryId(v string) *QueryOutput

SetQueryId sets the QueryId field's value.

func (*QueryOutput) SetResultItems 

func (s *QueryOutput) SetResultItems(v []*QueryResultItem) *QueryOutput

SetResultItems sets the ResultItems field's value.

func (*QueryOutput) SetSpellCorrectedQueries added in v1.43.11 

func (s *QueryOutput) SetSpellCorrectedQueries(v []*SpellCorrectedQuery) *QueryOutput

SetSpellCorrectedQueries sets the SpellCorrectedQueries field's value.

func (*QueryOutput) SetTotalNumberOfResults 

func (s *QueryOutput) SetTotalNumberOfResults(v int64) *QueryOutput

SetTotalNumberOfResults sets the TotalNumberOfResults field's value.

func (*QueryOutput) SetWarnings added in v1.42.32 

func (s *QueryOutput) SetWarnings(v []*Warning) *QueryOutput

SetWarnings sets the Warnings field's value.

func (QueryOutput) String 

func (s QueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryResultItem 

type QueryResultItem struct {

	// One or more additional fields/attributes associated with the query result.
	AdditionalAttributes []*AdditionalResultAttribute `type:"list"`

	// Provides details about a collapsed group of search results.
	CollapsedResultDetail *CollapsedResultDetail `type:"structure"`

	// An array of document fields/attributes assigned to a document in the search
	// results. For example, the document author (_author) or the source URI (_source_uri)
	// of the document.
	DocumentAttributes []*DocumentAttribute `type:"list"`

	// An extract of the text in the document. Contains information about highlighting
	// the relevant terms in the excerpt.
	DocumentExcerpt *TextWithHighlights `type:"structure"`

	// The identifier for the document.
	DocumentId *string `min:"1" type:"string"`

	// The title of the document. Contains the text of the title and information
	// for highlighting the relevant terms in the title.
	DocumentTitle *TextWithHighlights `type:"structure"`

	// The URI of the original location of the document.
	DocumentURI *string `min:"1" type:"string"`

	// A token that identifies a particular result from a particular query. Use
	// this token to provide click-through feedback for the result. For more information,
	// see Submitting feedback (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html).
	FeedbackToken *string `min:"1" type:"string"`

	// If the Type of document within the response is ANSWER, then it is either
	// a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is
	// returned in TableExcerpt. If it's a text answer, a text excerpt is returned
	// in DocumentExcerpt.
	Format *string `type:"string" enum:"QueryResultFormat"`

	// The unique identifier for the query result item id (Id) and the query result
	// item document id (DocumentId) combined. The value of this field changes with
	// every request, even when you have the same documents.
	Id *string `min:"1" type:"string"`

	// Indicates the confidence level of Amazon Kendra providing a relevant result
	// for the query. Each result is placed into a bin that indicates the confidence,
	// VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a
	// response meets the confidence needed for your application.
	//
	// The field is only set to LOW when the Type field is set to DOCUMENT and Amazon
	// Kendra is not confident that the result is relevant to the query.
	ScoreAttributes *ScoreAttributes `type:"structure"`

	// An excerpt from a table within a document.
	TableExcerpt *TableExcerpt `type:"structure"`

	// The type of document within the response. For example, a response could include
	// a question-answer that's relevant to the query.
	Type *string `type:"string" enum:"QueryResultType"`
	// contains filtered or unexported fields
}

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

func (QueryResultItem) GoString 

func (s QueryResultItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryResultItem) SetAdditionalAttributes 

func (s *QueryResultItem) SetAdditionalAttributes(v []*AdditionalResultAttribute) *QueryResultItem

SetAdditionalAttributes sets the AdditionalAttributes field's value.

func (*QueryResultItem) SetCollapsedResultDetail added in v1.45.28 

func (s *QueryResultItem) SetCollapsedResultDetail(v *CollapsedResultDetail) *QueryResultItem

SetCollapsedResultDetail sets the CollapsedResultDetail field's value.

func (*QueryResultItem) SetDocumentAttributes 

func (s *QueryResultItem) SetDocumentAttributes(v []*DocumentAttribute) *QueryResultItem

SetDocumentAttributes sets the DocumentAttributes field's value.

func (*QueryResultItem) SetDocumentExcerpt 

func (s *QueryResultItem) SetDocumentExcerpt(v *TextWithHighlights) *QueryResultItem

SetDocumentExcerpt sets the DocumentExcerpt field's value.

func (*QueryResultItem) SetDocumentId 

func (s *QueryResultItem) SetDocumentId(v string) *QueryResultItem

SetDocumentId sets the DocumentId field's value.

func (*QueryResultItem) SetDocumentTitle 

func (s *QueryResultItem) SetDocumentTitle(v *TextWithHighlights) *QueryResultItem

SetDocumentTitle sets the DocumentTitle field's value.

func (*QueryResultItem) SetDocumentURI 

func (s *QueryResultItem) SetDocumentURI(v string) *QueryResultItem

SetDocumentURI sets the DocumentURI field's value.

func (*QueryResultItem) SetFeedbackToken added in v1.36.4 

func (s *QueryResultItem) SetFeedbackToken(v string) *QueryResultItem

SetFeedbackToken sets the FeedbackToken field's value.

func (*QueryResultItem) SetFormat added in v1.44.146 

func (s *QueryResultItem) SetFormat(v string) *QueryResultItem

SetFormat sets the Format field's value.

func (*QueryResultItem) SetId 

func (s *QueryResultItem) SetId(v string) *QueryResultItem

SetId sets the Id field's value.

func (*QueryResultItem) SetScoreAttributes added in v1.34.17 

func (s *QueryResultItem) SetScoreAttributes(v *ScoreAttributes) *QueryResultItem

SetScoreAttributes sets the ScoreAttributes field's value.

func (*QueryResultItem) SetTableExcerpt added in v1.44.146 

func (s *QueryResultItem) SetTableExcerpt(v *TableExcerpt) *QueryResultItem

SetTableExcerpt sets the TableExcerpt field's value.

func (*QueryResultItem) SetType 

func (s *QueryResultItem) SetType(v string) *QueryResultItem

SetType sets the Type field's value.

func (QueryResultItem) String 

func (s QueryResultItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuerySuggestionsBlockListSummary added in v1.38.50 

type QuerySuggestionsBlockListSummary struct {

	// The Unix timestamp when the block list was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of a block list.
	Id *string `min:"36" type:"string"`

	// The number of items in the block list file.
	ItemCount *int64 `type:"integer"`

	// The name of the block list.
	Name *string `min:"1" type:"string"`

	// The status of the block list.
	Status *string `type:"string" enum:"QuerySuggestionsBlockListStatus"`

	// The Unix timestamp when the block list was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Summary information on a query suggestions block list.

This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

func (QuerySuggestionsBlockListSummary) GoString added in v1.38.50 

func (s QuerySuggestionsBlockListSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuerySuggestionsBlockListSummary) SetCreatedAt added in v1.38.50 

func (s *QuerySuggestionsBlockListSummary) SetCreatedAt(v time.Time) *QuerySuggestionsBlockListSummary

SetCreatedAt sets the CreatedAt field's value.

func (*QuerySuggestionsBlockListSummary) SetId added in v1.38.50 

func (s *QuerySuggestionsBlockListSummary) SetId(v string) *QuerySuggestionsBlockListSummary

SetId sets the Id field's value.

func (*QuerySuggestionsBlockListSummary) SetItemCount added in v1.38.50 

func (s *QuerySuggestionsBlockListSummary) SetItemCount(v int64) *QuerySuggestionsBlockListSummary

SetItemCount sets the ItemCount field's value.

func (*QuerySuggestionsBlockListSummary) SetName added in v1.38.50 

func (s *QuerySuggestionsBlockListSummary) SetName(v string) *QuerySuggestionsBlockListSummary

SetName sets the Name field's value.

func (*QuerySuggestionsBlockListSummary) SetStatus added in v1.38.50 

func (s *QuerySuggestionsBlockListSummary) SetStatus(v string) *QuerySuggestionsBlockListSummary

SetStatus sets the Status field's value.

func (*QuerySuggestionsBlockListSummary) SetUpdatedAt added in v1.38.50 

func (s *QuerySuggestionsBlockListSummary) SetUpdatedAt(v time.Time) *QuerySuggestionsBlockListSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (QuerySuggestionsBlockListSummary) String added in v1.38.50 

func (s QuerySuggestionsBlockListSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuipConfiguration added in v1.43.42 

type QuipConfiguration struct {

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Quip attachments to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Quip fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Quip field names must exist in your Quip custom metadata.
	AttachmentFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// TRUE to index attachments.
	CrawlAttachments *bool `type:"boolean"`

	// TRUE to index the contents of chat rooms.
	CrawlChatRooms *bool `type:"boolean"`

	// TRUE to index file comments.
	CrawlFileComments *bool `type:"boolean"`

	// The Quip site domain. For example, https://quip-company.quipdomain.com/browse.
	// The domain in this example is "quipdomain".
	//
	// Domain is a required field
	Domain *string `min:"1" type:"string" required:"true"`

	// A list of regular expression patterns to exclude certain files in your Quip
	// file system. Files that match the patterns are excluded from the index. Files
	// that don’t match the patterns are included in the index. If a file matches
	// both an inclusion pattern and an exclusion pattern, the exclusion pattern
	// takes precedence, and the file isn't included in the index.
	ExclusionPatterns []*string `type:"list"`

	// The identifiers of the Quip folders you want to index. You can find the folder
	// ID in your browser URL when you access your folder in Quip. For example,
	// https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder
	// ID in this example is "zlLuOVNSarTL".
	FolderIds []*string `type:"list"`

	// A list of regular expression patterns to include certain files in your Quip
	// file system. Files that match the patterns are included in the index. Files
	// that don't match the patterns are excluded from the index. If a file matches
	// both an inclusion pattern and an exclusion pattern, the exclusion pattern
	// takes precedence, and the file isn't included in the index.
	InclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Quip messages to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Quip fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Quip field names must exist in your Quip custom metadata.
	MessageFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the key-value pairs that are required to connect to your Quip. The secret
	// must contain a JSON structure with the following keys:
	//
	//    * accessToken—The token created in Quip. For more information, see Using
	//    a Quip data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// A list of DataSourceToIndexFieldMapping objects that map attributes or field
	// names of Quip threads to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Quip fields. For more information,
	// see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Quip field names must exist in your Quip custom metadata.
	ThreadFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// Configuration information for an Amazon Virtual Private Cloud (VPC) to connect
	// to your Quip. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Quip as your data source.

func (QuipConfiguration) GoString added in v1.43.42 

func (s QuipConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuipConfiguration) SetAttachmentFieldMappings added in v1.43.42 

func (s *QuipConfiguration) SetAttachmentFieldMappings(v []*DataSourceToIndexFieldMapping) *QuipConfiguration

SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value.

func (*QuipConfiguration) SetCrawlAttachments added in v1.43.42 

func (s *QuipConfiguration) SetCrawlAttachments(v bool) *QuipConfiguration

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*QuipConfiguration) SetCrawlChatRooms added in v1.43.42 

func (s *QuipConfiguration) SetCrawlChatRooms(v bool) *QuipConfiguration

SetCrawlChatRooms sets the CrawlChatRooms field's value.

func (*QuipConfiguration) SetCrawlFileComments added in v1.43.42 

func (s *QuipConfiguration) SetCrawlFileComments(v bool) *QuipConfiguration

SetCrawlFileComments sets the CrawlFileComments field's value.

func (*QuipConfiguration) SetDomain added in v1.43.42 

func (s *QuipConfiguration) SetDomain(v string) *QuipConfiguration

SetDomain sets the Domain field's value.

func (*QuipConfiguration) SetExclusionPatterns added in v1.43.42 

func (s *QuipConfiguration) SetExclusionPatterns(v []*string) *QuipConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*QuipConfiguration) SetFolderIds added in v1.43.42 

func (s *QuipConfiguration) SetFolderIds(v []*string) *QuipConfiguration

SetFolderIds sets the FolderIds field's value.

func (*QuipConfiguration) SetInclusionPatterns added in v1.43.42 

func (s *QuipConfiguration) SetInclusionPatterns(v []*string) *QuipConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*QuipConfiguration) SetMessageFieldMappings added in v1.43.42 

func (s *QuipConfiguration) SetMessageFieldMappings(v []*DataSourceToIndexFieldMapping) *QuipConfiguration

SetMessageFieldMappings sets the MessageFieldMappings field's value.

func (*QuipConfiguration) SetSecretArn added in v1.43.42 

func (s *QuipConfiguration) SetSecretArn(v string) *QuipConfiguration

SetSecretArn sets the SecretArn field's value.

func (*QuipConfiguration) SetThreadFieldMappings added in v1.43.42 

func (s *QuipConfiguration) SetThreadFieldMappings(v []*DataSourceToIndexFieldMapping) *QuipConfiguration

SetThreadFieldMappings sets the ThreadFieldMappings field's value.

func (*QuipConfiguration) SetVpcConfiguration added in v1.43.42 

func (s *QuipConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *QuipConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (QuipConfiguration) String added in v1.43.42 

func (s QuipConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuipConfiguration) Validate added in v1.43.42 

func (s *QuipConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Relevance 

type Relevance struct {

	// Specifies the time period that the boost applies to. For example, to make
	// the boost apply to documents with the field value within the last month,
	// you would use "2628000s". Once the field value is beyond the specified range,
	// the effect of the boost drops off. The higher the importance, the faster
	// the effect drops off. If you don't specify a value, the default is 3 months.
	// The value of the field is a numeric string followed by the character "s",
	// for example "86400s" for one day, or "604800s" for one week.
	//
	// Only applies to DATE fields.
	Duration *string `min:"1" type:"string"`

	// Indicates that this field determines how "fresh" a document is. For example,
	// if document 1 was created on November 5, and document 2 was created on October
	// 31, document 1 is "fresher" than document 2. Only applies to DATE fields.
	Freshness *bool `type:"boolean"`

	// The relative importance of the field in the search. Larger numbers provide
	// more of a boost than smaller numbers.
	Importance *int64 `min:"1" type:"integer"`

	// Determines how values should be interpreted.
	//
	// When the RankOrder field is ASCENDING, higher numbers are better. For example,
	// a document with a rating score of 10 is higher ranking than a document with
	// a rating score of 1.
	//
	// When the RankOrder field is DESCENDING, lower numbers are better. For example,
	// in a task tracking application, a priority 1 task is more important than
	// a priority 5 task.
	//
	// Only applies to LONG fields.
	RankOrder *string `type:"string" enum:"Order"`

	// A list of values that should be given a different boost when they appear
	// in the result list. For example, if you are boosting a field called "department",
	// query terms that match the department field are boosted in the result. However,
	// you can add entries from the department field to boost documents with those
	// values higher.
	//
	// For example, you can add entries to the map with names of departments. If
	// you add "HR",5 and "Legal",3 those departments are given special attention
	// when they appear in the metadata of a document. When those terms appear they
	// are given the specified importance instead of the regular importance for
	// the boost.
	ValueImportanceMap map[string]*int64 `type:"map"`
	// contains filtered or unexported fields
}

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

func (Relevance) GoString 

func (s Relevance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Relevance) SetDuration 

func (s *Relevance) SetDuration(v string) *Relevance

SetDuration sets the Duration field's value.

func (*Relevance) SetFreshness 

func (s *Relevance) SetFreshness(v bool) *Relevance

SetFreshness sets the Freshness field's value.

func (*Relevance) SetImportance 

func (s *Relevance) SetImportance(v int64) *Relevance

SetImportance sets the Importance field's value.

func (*Relevance) SetRankOrder 

func (s *Relevance) SetRankOrder(v string) *Relevance

SetRankOrder sets the RankOrder field's value.

func (*Relevance) SetValueImportanceMap 

func (s *Relevance) SetValueImportanceMap(v map[string]*int64) *Relevance

SetValueImportanceMap sets the ValueImportanceMap field's value.

func (Relevance) String 

func (s Relevance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Relevance) Validate 

func (s *Relevance) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RelevanceFeedback 

type RelevanceFeedback struct {

	// Whether the document was relevant or not relevant to the search.
	//
	// RelevanceValue is a required field
	RelevanceValue *string `type:"string" required:"true" enum:"RelevanceType"`

	// The identifier of the search result that the user provided relevance feedback
	// for.
	//
	// ResultId is a required field
	ResultId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.

func (RelevanceFeedback) GoString 

func (s RelevanceFeedback) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelevanceFeedback) SetRelevanceValue 

func (s *RelevanceFeedback) SetRelevanceValue(v string) *RelevanceFeedback

SetRelevanceValue sets the RelevanceValue field's value.

func (*RelevanceFeedback) SetResultId 

func (s *RelevanceFeedback) SetResultId(v string) *RelevanceFeedback

SetResultId sets the ResultId field's value.

func (RelevanceFeedback) String 

func (s RelevanceFeedback) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelevanceFeedback) Validate 

func (s *RelevanceFeedback) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceAlreadyExistException added in v1.28.0 

type ResourceAlreadyExistException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource you want to use already exists. Please check you have provided the correct resource and try again.

func (*ResourceAlreadyExistException) Code added in v1.28.0 

func (s *ResourceAlreadyExistException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistException) Error added in v1.28.0 

func (s *ResourceAlreadyExistException) Error() string

func (ResourceAlreadyExistException) GoString added in v1.28.0 

func (s ResourceAlreadyExistException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistException) Message added in v1.28.0 

func (s *ResourceAlreadyExistException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyExistException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistException) RequestID added in v1.28.0 

func (s *ResourceAlreadyExistException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyExistException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistException) String added in v1.28.0 

func (s ResourceAlreadyExistException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException added in v1.28.0 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource you want to use is currently in use. Please check you have provided the correct resource and try again.

func (*ResourceInUseException) Code added in v1.28.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message added in v1.28.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.28.0 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceUnavailableException added in v1.28.0 

type ResourceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource you want to use isn't available. Please check you have provided the correct resource and try again.

func (*ResourceUnavailableException) Code added in v1.28.0 

func (s *ResourceUnavailableException) Code() string

Code returns the exception type name.

func (*ResourceUnavailableException) Error added in v1.28.0 

func (s *ResourceUnavailableException) Error() string

func (ResourceUnavailableException) GoString added in v1.28.0 

func (s ResourceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceUnavailableException) Message added in v1.28.0 

func (s *ResourceUnavailableException) Message() string

Message returns the exception's message.

func (*ResourceUnavailableException) OrigErr added in v1.28.0 

func (s *ResourceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceUnavailableException) RequestID added in v1.28.0 

func (s *ResourceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceUnavailableException) StatusCode added in v1.28.0 

func (s *ResourceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceUnavailableException) String added in v1.28.0 

func (s ResourceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrieveInput added in v1.44.288 

type RetrieveInput struct {

	// Filters search results by document fields/attributes. You can only provide
	// one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters
	// parameters contain a list of other filters.
	//
	// The AttributeFilter parameter means you can create a set of filtering rules
	// that a document must satisfy to be included in the query results.
	AttributeFilter *AttributeFilter `type:"structure"`

	// Overrides relevance tuning configurations of fields/attributes set at the
	// index level.
	//
	// If you use this API to override the relevance tuning configured at the index
	// level, but there is no relevance tuning configured at the index level, then
	// Amazon Kendra does not apply any relevance tuning.
	//
	// If there is relevance tuning configured for fields at the index level, and
	// you use this API to override only some of these fields, then for the fields
	// you did not override, the importance is set to 1.
	DocumentRelevanceOverrideConfigurations []*DocumentRelevanceConfiguration `type:"list"`

	// The identifier of the index to retrieve relevant passages for the search.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// Retrieved relevant passages are returned in pages the size of the PageSize
	// parameter. By default, Amazon Kendra returns the first page of results. Use
	// this parameter to get result pages after the first one.
	PageNumber *int64 `type:"integer"`

	// Sets the number of retrieved relevant passages that are returned in each
	// page of results. The default page size is 10. The maximum number of results
	// returned is 100. If you ask for more than 100 results, only 100 are returned.
	PageSize *int64 `type:"integer"`

	// The input query text to retrieve relevant passages for the search. Amazon
	// Kendra truncates queries at 30 token words, which excludes punctuation and
	// stop words. Truncation still applies if you use Boolean or more advanced,
	// complex queries. For example, Timeoff AND October AND Category:HR is counted
	// as 3 tokens: timeoff, october, hr. For more information, see Searching with
	// advanced query syntax (https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax)
	// in the Amazon Kendra Developer Guide.
	//
	// QueryText is a required field
	QueryText *string `type:"string" required:"true"`

	// A list of document fields/attributes to include in the response. You can
	// limit the response to include certain document fields. By default, all document
	// fields are included in the response.
	RequestedDocumentAttributes []*string `min:"1" type:"list"`

	// The user context token or user and group information.
	UserContext *UserContext `type:"structure"`
	// contains filtered or unexported fields
}

func (RetrieveInput) GoString added in v1.44.288 

func (s RetrieveInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveInput) SetAttributeFilter added in v1.44.288 

func (s *RetrieveInput) SetAttributeFilter(v *AttributeFilter) *RetrieveInput

SetAttributeFilter sets the AttributeFilter field's value.

func (*RetrieveInput) SetDocumentRelevanceOverrideConfigurations added in v1.44.288 

func (s *RetrieveInput) SetDocumentRelevanceOverrideConfigurations(v []*DocumentRelevanceConfiguration) *RetrieveInput

SetDocumentRelevanceOverrideConfigurations sets the DocumentRelevanceOverrideConfigurations field's value.

func (*RetrieveInput) SetIndexId added in v1.44.288 

func (s *RetrieveInput) SetIndexId(v string) *RetrieveInput

SetIndexId sets the IndexId field's value.

func (*RetrieveInput) SetPageNumber added in v1.44.288 

func (s *RetrieveInput) SetPageNumber(v int64) *RetrieveInput

SetPageNumber sets the PageNumber field's value.

func (*RetrieveInput) SetPageSize added in v1.44.288 

func (s *RetrieveInput) SetPageSize(v int64) *RetrieveInput

SetPageSize sets the PageSize field's value.

func (*RetrieveInput) SetQueryText added in v1.44.288 

func (s *RetrieveInput) SetQueryText(v string) *RetrieveInput

SetQueryText sets the QueryText field's value.

func (*RetrieveInput) SetRequestedDocumentAttributes added in v1.44.288 

func (s *RetrieveInput) SetRequestedDocumentAttributes(v []*string) *RetrieveInput

SetRequestedDocumentAttributes sets the RequestedDocumentAttributes field's value.

func (*RetrieveInput) SetUserContext added in v1.44.288 

func (s *RetrieveInput) SetUserContext(v *UserContext) *RetrieveInput

SetUserContext sets the UserContext field's value.

func (RetrieveInput) String added in v1.44.288 

func (s RetrieveInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveInput) Validate added in v1.44.288 

func (s *RetrieveInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetrieveOutput added in v1.44.288 

type RetrieveOutput struct {

	// The identifier of query used for the search. You also use QueryId to identify
	// the search when using the Submitfeedback (https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html)
	// API.
	QueryId *string `min:"1" type:"string"`

	// The results of the retrieved relevant passages for the search.
	ResultItems []*RetrieveResultItem `type:"list"`
	// contains filtered or unexported fields
}

func (RetrieveOutput) GoString added in v1.44.288 

func (s RetrieveOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveOutput) SetQueryId added in v1.44.288 

func (s *RetrieveOutput) SetQueryId(v string) *RetrieveOutput

SetQueryId sets the QueryId field's value.

func (*RetrieveOutput) SetResultItems added in v1.44.288 

func (s *RetrieveOutput) SetResultItems(v []*RetrieveResultItem) *RetrieveOutput

SetResultItems sets the ResultItems field's value.

func (RetrieveOutput) String added in v1.44.288 

func (s RetrieveOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetrieveResultItem added in v1.44.288 

type RetrieveResultItem struct {

	// The contents of the relevant passage.
	Content *string `type:"string"`

	// An array of document fields/attributes assigned to a document in the search
	// results. For example, the document author (_author) or the source URI (_source_uri)
	// of the document.
	DocumentAttributes []*DocumentAttribute `type:"list"`

	// The identifier of the document.
	DocumentId *string `min:"1" type:"string"`

	// The title of the document.
	DocumentTitle *string `type:"string"`

	// The URI of the original location of the document.
	DocumentURI *string `min:"1" type:"string"`

	// The identifier of the relevant passage result.
	Id *string `min:"1" type:"string"`

	// The confidence score bucket for a retrieved passage result. The confidence
	// bucket provides a relative ranking that indicates how confident Amazon Kendra
	// is that the response is relevant to the query.
	ScoreAttributes *ScoreAttributes `type:"structure"`
	// contains filtered or unexported fields
}

A single retrieved relevant passage result.

func (RetrieveResultItem) GoString added in v1.44.288 

func (s RetrieveResultItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetrieveResultItem) SetContent added in v1.44.288 

func (s *RetrieveResultItem) SetContent(v string) *RetrieveResultItem

SetContent sets the Content field's value.

func (*RetrieveResultItem) SetDocumentAttributes added in v1.44.288 

func (s *RetrieveResultItem) SetDocumentAttributes(v []*DocumentAttribute) *RetrieveResultItem

SetDocumentAttributes sets the DocumentAttributes field's value.

func (*RetrieveResultItem) SetDocumentId added in v1.44.288 

func (s *RetrieveResultItem) SetDocumentId(v string) *RetrieveResultItem

SetDocumentId sets the DocumentId field's value.

func (*RetrieveResultItem) SetDocumentTitle added in v1.44.288 

func (s *RetrieveResultItem) SetDocumentTitle(v string) *RetrieveResultItem

SetDocumentTitle sets the DocumentTitle field's value.

func (*RetrieveResultItem) SetDocumentURI added in v1.44.288 

func (s *RetrieveResultItem) SetDocumentURI(v string) *RetrieveResultItem

SetDocumentURI sets the DocumentURI field's value.

func (*RetrieveResultItem) SetId added in v1.44.288 

func (s *RetrieveResultItem) SetId(v string) *RetrieveResultItem

SetId sets the Id field's value.

func (*RetrieveResultItem) SetScoreAttributes added in v1.45.8 

func (s *RetrieveResultItem) SetScoreAttributes(v *ScoreAttributes) *RetrieveResultItem

SetScoreAttributes sets the ScoreAttributes field's value.

func (RetrieveResultItem) String added in v1.44.288 

func (s RetrieveResultItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3DataSourceConfiguration 

type S3DataSourceConfiguration struct {

	// Provides the path to the S3 bucket that contains the user context filtering
	// files for the data source. For the format of the file, see Access control
	// for S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html).
	AccessControlListConfiguration *AccessControlListConfiguration `type:"structure"`

	// The name of the bucket that contains the documents.
	//
	// BucketName is a required field
	BucketName *string `min:"3" type:"string" required:"true"`

	// Document metadata files that contain information such as the document access
	// control information, source URI, document author, and custom attributes.
	// Each metadata file contains metadata about a single document.
	DocumentsMetadataConfiguration *DocumentsMetadataConfiguration `type:"structure"`

	// A list of glob patterns (patterns that can expand a wildcard pattern into
	// a list of path names that match the given pattern) for certain file names
	// and file types to exclude from your index. If a document matches both an
	// inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence
	// and the document is not indexed. Examples of glob patterns include:
	//
	//    * /myapp/config/*—All files inside config directory.
	//
	//    * **/*.png—All .png files in all directories.
	//
	//    * **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
	//
	//    * /myapp/src/**/*.ts—All .ts files inside src directory (and all its
	//    subdirectories).
	//
	//    * **/!(*.module).ts—All .ts files but not .module.ts
	//
	//    * *.png , *.jpg—All PNG and JPEG image files in a directory (files with
	//    the extensions .png and .jpg).
	//
	//    * *internal*—All files in a directory that contain 'internal' in the
	//    file name, such as 'internal', 'internal_only', 'company_internal'.
	//
	//    * **/*internal*—All internal-related files in a directory and its subdirectories.
	//
	// For more examples, see Use of Exclude and Include Filters (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters)
	// in the Amazon Web Services CLI Command Reference.
	ExclusionPatterns []*string `type:"list"`

	// A list of glob patterns (patterns that can expand a wildcard pattern into
	// a list of path names that match the given pattern) for certain file names
	// and file types to include in your index. If a document matches both an inclusion
	// and exclusion prefix or pattern, the exclusion prefix takes precendence and
	// the document is not indexed. Examples of glob patterns include:
	//
	//    * /myapp/config/*—All files inside config directory.
	//
	//    * **/*.png—All .png files in all directories.
	//
	//    * **/*.{png, ico, md}—All .png, .ico or .md files in all directories.
	//
	//    * /myapp/src/**/*.ts—All .ts files inside src directory (and all its
	//    subdirectories).
	//
	//    * **/!(*.module).ts—All .ts files but not .module.ts
	//
	//    * *.png , *.jpg—All PNG and JPEG image files in a directory (files with
	//    the extensions .png and .jpg).
	//
	//    * *internal*—All files in a directory that contain 'internal' in the
	//    file name, such as 'internal', 'internal_only', 'company_internal'.
	//
	//    * **/*internal*—All internal-related files in a directory and its subdirectories.
	//
	// For more examples, see Use of Exclude and Include Filters (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters)
	// in the Amazon Web Services CLI Command Reference.
	InclusionPatterns []*string `type:"list"`

	// A list of S3 prefixes for the documents that should be included in the index.
	InclusionPrefixes []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to an Amazon S3 bucket.

Amazon Kendra now supports an upgraded Amazon S3 connector.

You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the S3DataSourceConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

func (S3DataSourceConfiguration) GoString 

func (s S3DataSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSourceConfiguration) SetAccessControlListConfiguration 

func (s *S3DataSourceConfiguration) SetAccessControlListConfiguration(v *AccessControlListConfiguration) *S3DataSourceConfiguration

SetAccessControlListConfiguration sets the AccessControlListConfiguration field's value.

func (*S3DataSourceConfiguration) SetBucketName 

func (s *S3DataSourceConfiguration) SetBucketName(v string) *S3DataSourceConfiguration

SetBucketName sets the BucketName field's value.

func (*S3DataSourceConfiguration) SetDocumentsMetadataConfiguration 

func (s *S3DataSourceConfiguration) SetDocumentsMetadataConfiguration(v *DocumentsMetadataConfiguration) *S3DataSourceConfiguration

SetDocumentsMetadataConfiguration sets the DocumentsMetadataConfiguration field's value.

func (*S3DataSourceConfiguration) SetExclusionPatterns 

func (s *S3DataSourceConfiguration) SetExclusionPatterns(v []*string) *S3DataSourceConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*S3DataSourceConfiguration) SetInclusionPatterns added in v1.35.12 

func (s *S3DataSourceConfiguration) SetInclusionPatterns(v []*string) *S3DataSourceConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*S3DataSourceConfiguration) SetInclusionPrefixes 

func (s *S3DataSourceConfiguration) SetInclusionPrefixes(v []*string) *S3DataSourceConfiguration

SetInclusionPrefixes sets the InclusionPrefixes field's value.

func (S3DataSourceConfiguration) String 

func (s S3DataSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSourceConfiguration) Validate 

func (s *S3DataSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Path 

type S3Path struct {

	// The name of the S3 bucket that contains the file.
	//
	// Bucket is a required field
	Bucket *string `min:"3" type:"string" required:"true"`

	// The name of the file.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information required to find a specific file in an Amazon S3 bucket.

func (S3Path) GoString 

func (s S3Path) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Path) SetBucket 

func (s *S3Path) SetBucket(v string) *S3Path

SetBucket sets the Bucket field's value.

func (*S3Path) SetKey 

func (s *S3Path) SetKey(v string) *S3Path

SetKey sets the Key field's value.

func (S3Path) String 

func (s S3Path) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Path) Validate 

func (s *S3Path) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SaaSConfiguration added in v1.44.27 

type SaaSConfiguration struct {

	// The GitHub host URL or API endpoint URL. For example, https://api.github.com.
	//
	// HostUrl is a required field
	HostUrl *string `min:"1" type:"string" required:"true"`

	// The name of the organization of the GitHub Enterprise Cloud (SaaS) account
	// you want to connect to. You can find your organization name by logging into
	// GitHub desktop and selecting Your organizations under your profile picture
	// dropdown.
	//
	// OrganizationName is a required field
	OrganizationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).

func (SaaSConfiguration) GoString added in v1.44.27 

func (s SaaSConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SaaSConfiguration) SetHostUrl added in v1.44.27 

func (s *SaaSConfiguration) SetHostUrl(v string) *SaaSConfiguration

SetHostUrl sets the HostUrl field's value.

func (*SaaSConfiguration) SetOrganizationName added in v1.44.27 

func (s *SaaSConfiguration) SetOrganizationName(v string) *SaaSConfiguration

SetOrganizationName sets the OrganizationName field's value.

func (SaaSConfiguration) String added in v1.44.27 

func (s SaaSConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SaaSConfiguration) Validate added in v1.44.27 

func (s *SaaSConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SalesforceChatterFeedConfiguration added in v1.30.25 

type SalesforceChatterFeedConfiguration struct {

	// The name of the column in the Salesforce FeedItem table that contains the
	// content to index. Typically this is the Body column.
	//
	// DocumentDataFieldName is a required field
	DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

	// The name of the column in the Salesforce FeedItem table that contains the
	// title of the document. This is typically the Title column.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// Filters the documents in the feed based on status of the user. When you specify
	// ACTIVE_USERS only documents from users who have an active account are indexed.
	// When you specify STANDARD_USER only documents for Salesforce standard users
	// are documented. You can specify both.
	IncludeFilterTypes []*string `min:"1" type:"list" enum:"SalesforceChatterFeedIncludeFilterType"`
	// contains filtered or unexported fields
}

The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.

func (SalesforceChatterFeedConfiguration) GoString added in v1.30.25 

func (s SalesforceChatterFeedConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceChatterFeedConfiguration) SetDocumentDataFieldName added in v1.30.25 

func (s *SalesforceChatterFeedConfiguration) SetDocumentDataFieldName(v string) *SalesforceChatterFeedConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceChatterFeedConfiguration) SetDocumentTitleFieldName added in v1.30.25 

func (s *SalesforceChatterFeedConfiguration) SetDocumentTitleFieldName(v string) *SalesforceChatterFeedConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceChatterFeedConfiguration) SetFieldMappings added in v1.30.25 

func (s *SalesforceChatterFeedConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SalesforceChatterFeedConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*SalesforceChatterFeedConfiguration) SetIncludeFilterTypes added in v1.30.25 

func (s *SalesforceChatterFeedConfiguration) SetIncludeFilterTypes(v []*string) *SalesforceChatterFeedConfiguration

SetIncludeFilterTypes sets the IncludeFilterTypes field's value.

func (SalesforceChatterFeedConfiguration) String added in v1.30.25 

func (s SalesforceChatterFeedConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceChatterFeedConfiguration) Validate added in v1.30.25 

func (s *SalesforceChatterFeedConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SalesforceConfiguration added in v1.30.25 

type SalesforceConfiguration struct {

	// Configuration information for Salesforce chatter feeds.
	ChatterFeedConfiguration *SalesforceChatterFeedConfiguration `type:"structure"`

	// Indicates whether Amazon Kendra should index attachments to Salesforce objects.
	CrawlAttachments *bool `type:"boolean"`

	// A list of regular expression patterns to exclude certain documents in your
	// Salesforce. Documents that match the patterns are excluded from the index.
	// Documents that don't match the patterns are included in the index. If a document
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the document isn't included in the index.
	//
	// The pattern is applied to the name of the attached file.
	ExcludeAttachmentFilePatterns []*string `type:"list"`

	// A list of regular expression patterns to include certain documents in your
	// Salesforce. Documents that match the patterns are included in the index.
	// Documents that don't match the patterns are excluded from the index. If a
	// document matches both an inclusion and exclusion pattern, the exclusion pattern
	// takes precedence and the document isn't included in the index.
	//
	// The pattern is applied to the name of the attached file.
	IncludeAttachmentFilePatterns []*string `type:"list"`

	// Configuration information for the knowledge article types that Amazon Kendra
	// indexes. Amazon Kendra indexes standard knowledge articles and the standard
	// fields of knowledge articles, or the custom fields of custom knowledge articles,
	// but not both.
	KnowledgeArticleConfiguration *SalesforceKnowledgeArticleConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of an Secrets Managersecret that contains
	// the key/value pairs required to connect to your Salesforce instance. The
	// secret must contain a JSON structure with the following keys:
	//
	//    * authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to
	//    get an OAUTH token.
	//
	//    * consumerKey - The application public key generated when you created
	//    your Salesforce application.
	//
	//    * consumerSecret - The application private key generated when you created
	//    your Salesforce application.
	//
	//    * password - The password associated with the user logging in to the Salesforce
	//    instance.
	//
	//    * securityToken - The token associated with the user logging in to the
	//    Salesforce instance.
	//
	//    * username - The user name of the user logging in to the Salesforce instance.
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The instance URL for the Salesforce site that you want to index.
	//
	// ServerUrl is a required field
	ServerUrl *string `min:"1" type:"string" required:"true"`

	// Configuration information for processing attachments to Salesforce standard
	// objects.
	StandardObjectAttachmentConfiguration *SalesforceStandardObjectAttachmentConfiguration `type:"structure"`

	// Configuration of the Salesforce standard objects that Amazon Kendra indexes.
	StandardObjectConfigurations []*SalesforceStandardObjectConfiguration `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Salesforce as your data source.

func (SalesforceConfiguration) GoString added in v1.30.25 

func (s SalesforceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceConfiguration) SetChatterFeedConfiguration added in v1.30.25 

func (s *SalesforceConfiguration) SetChatterFeedConfiguration(v *SalesforceChatterFeedConfiguration) *SalesforceConfiguration

SetChatterFeedConfiguration sets the ChatterFeedConfiguration field's value.

func (*SalesforceConfiguration) SetCrawlAttachments added in v1.30.25 

func (s *SalesforceConfiguration) SetCrawlAttachments(v bool) *SalesforceConfiguration

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*SalesforceConfiguration) SetExcludeAttachmentFilePatterns added in v1.30.25 

func (s *SalesforceConfiguration) SetExcludeAttachmentFilePatterns(v []*string) *SalesforceConfiguration

SetExcludeAttachmentFilePatterns sets the ExcludeAttachmentFilePatterns field's value.

func (*SalesforceConfiguration) SetIncludeAttachmentFilePatterns added in v1.30.25 

func (s *SalesforceConfiguration) SetIncludeAttachmentFilePatterns(v []*string) *SalesforceConfiguration

SetIncludeAttachmentFilePatterns sets the IncludeAttachmentFilePatterns field's value.

func (*SalesforceConfiguration) SetKnowledgeArticleConfiguration added in v1.30.25 

func (s *SalesforceConfiguration) SetKnowledgeArticleConfiguration(v *SalesforceKnowledgeArticleConfiguration) *SalesforceConfiguration

SetKnowledgeArticleConfiguration sets the KnowledgeArticleConfiguration field's value.

func (*SalesforceConfiguration) SetSecretArn added in v1.30.25 

func (s *SalesforceConfiguration) SetSecretArn(v string) *SalesforceConfiguration

SetSecretArn sets the SecretArn field's value.

func (*SalesforceConfiguration) SetServerUrl added in v1.30.25 

func (s *SalesforceConfiguration) SetServerUrl(v string) *SalesforceConfiguration

SetServerUrl sets the ServerUrl field's value.

func (*SalesforceConfiguration) SetStandardObjectAttachmentConfiguration added in v1.30.25 

func (s *SalesforceConfiguration) SetStandardObjectAttachmentConfiguration(v *SalesforceStandardObjectAttachmentConfiguration) *SalesforceConfiguration

SetStandardObjectAttachmentConfiguration sets the StandardObjectAttachmentConfiguration field's value.

func (*SalesforceConfiguration) SetStandardObjectConfigurations added in v1.30.25 

func (s *SalesforceConfiguration) SetStandardObjectConfigurations(v []*SalesforceStandardObjectConfiguration) *SalesforceConfiguration

SetStandardObjectConfigurations sets the StandardObjectConfigurations field's value.

func (SalesforceConfiguration) String added in v1.30.25 

func (s SalesforceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceConfiguration) Validate added in v1.30.25 

func (s *SalesforceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SalesforceCustomKnowledgeArticleTypeConfiguration added in v1.30.25 

type SalesforceCustomKnowledgeArticleTypeConfiguration struct {

	// The name of the field in the custom knowledge article that contains the document
	// data to index.
	//
	// DocumentDataFieldName is a required field
	DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

	// The name of the field in the custom knowledge article that contains the document
	// title.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// Maps attributes or field names of the custom knowledge article to Amazon
	// Kendra index field names. To create custom fields, use the UpdateIndex API
	// before you map to Salesforce fields. For more information, see Mapping data
	// source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Salesforce data source field names must exist in your Salesforce custom
	// metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// The name of the configuration.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information for indexing Salesforce custom articles.

func (SalesforceCustomKnowledgeArticleTypeConfiguration) GoString added in v1.30.25 

func (s SalesforceCustomKnowledgeArticleTypeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName added in v1.30.25 

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName(v string) *SalesforceCustomKnowledgeArticleTypeConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName added in v1.30.25 

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName(v string) *SalesforceCustomKnowledgeArticleTypeConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetFieldMappings added in v1.30.25 

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SalesforceCustomKnowledgeArticleTypeConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetName added in v1.30.25 

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) SetName(v string) *SalesforceCustomKnowledgeArticleTypeConfiguration

SetName sets the Name field's value.

func (SalesforceCustomKnowledgeArticleTypeConfiguration) String added in v1.30.25 

func (s SalesforceCustomKnowledgeArticleTypeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) Validate added in v1.30.25 

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SalesforceKnowledgeArticleConfiguration added in v1.30.25 

type SalesforceKnowledgeArticleConfiguration struct {

	// Configuration information for custom Salesforce knowledge articles.
	CustomKnowledgeArticleTypeConfigurations []*SalesforceCustomKnowledgeArticleTypeConfiguration `min:"1" type:"list"`

	// Specifies the document states that should be included when Amazon Kendra
	// indexes knowledge articles. You must specify at least one state.
	//
	// IncludedStates is a required field
	IncludedStates []*string `min:"1" type:"list" required:"true" enum:"SalesforceKnowledgeArticleState"`

	// Configuration information for standard Salesforce knowledge articles.
	StandardKnowledgeArticleTypeConfiguration *SalesforceStandardKnowledgeArticleTypeConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

func (SalesforceKnowledgeArticleConfiguration) GoString added in v1.30.25 

func (s SalesforceKnowledgeArticleConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceKnowledgeArticleConfiguration) SetCustomKnowledgeArticleTypeConfigurations added in v1.30.25 

func (s *SalesforceKnowledgeArticleConfiguration) SetCustomKnowledgeArticleTypeConfigurations(v []*SalesforceCustomKnowledgeArticleTypeConfiguration) *SalesforceKnowledgeArticleConfiguration

SetCustomKnowledgeArticleTypeConfigurations sets the CustomKnowledgeArticleTypeConfigurations field's value.

func (*SalesforceKnowledgeArticleConfiguration) SetIncludedStates added in v1.30.25 

func (s *SalesforceKnowledgeArticleConfiguration) SetIncludedStates(v []*string) *SalesforceKnowledgeArticleConfiguration

SetIncludedStates sets the IncludedStates field's value.

func (*SalesforceKnowledgeArticleConfiguration) SetStandardKnowledgeArticleTypeConfiguration added in v1.30.25 

func (s *SalesforceKnowledgeArticleConfiguration) SetStandardKnowledgeArticleTypeConfiguration(v *SalesforceStandardKnowledgeArticleTypeConfiguration) *SalesforceKnowledgeArticleConfiguration

SetStandardKnowledgeArticleTypeConfiguration sets the StandardKnowledgeArticleTypeConfiguration field's value.

func (SalesforceKnowledgeArticleConfiguration) String added in v1.30.25 

func (s SalesforceKnowledgeArticleConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceKnowledgeArticleConfiguration) Validate added in v1.30.25 

func (s *SalesforceKnowledgeArticleConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SalesforceStandardKnowledgeArticleTypeConfiguration added in v1.30.25 

type SalesforceStandardKnowledgeArticleTypeConfiguration struct {

	// The name of the field that contains the document data to index.
	//
	// DocumentDataFieldName is a required field
	DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

	// The name of the field that contains the document title.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// Maps attributes or field names of the knowledge article to Amazon Kendra
	// index field names. To create custom fields, use the UpdateIndex API before
	// you map to Salesforce fields. For more information, see Mapping data source
	// fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Salesforce data source field names must exist in your Salesforce custom
	// metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information for standard Salesforce knowledge articles.

func (SalesforceStandardKnowledgeArticleTypeConfiguration) GoString added in v1.30.25 

func (s SalesforceStandardKnowledgeArticleTypeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName added in v1.30.25 

func (s *SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName(v string) *SalesforceStandardKnowledgeArticleTypeConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName added in v1.30.25 

func (s *SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName(v string) *SalesforceStandardKnowledgeArticleTypeConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) SetFieldMappings added in v1.30.25 

func (s *SalesforceStandardKnowledgeArticleTypeConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SalesforceStandardKnowledgeArticleTypeConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (SalesforceStandardKnowledgeArticleTypeConfiguration) String added in v1.30.25 

func (s SalesforceStandardKnowledgeArticleTypeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) Validate added in v1.30.25 

func (s *SalesforceStandardKnowledgeArticleTypeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SalesforceStandardObjectAttachmentConfiguration added in v1.30.25 

type SalesforceStandardObjectAttachmentConfiguration struct {

	// The name of the field used for the document title.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// One or more objects that map fields in attachments to Amazon Kendra index
	// fields.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information for processing attachments to Salesforce standard objects.

func (SalesforceStandardObjectAttachmentConfiguration) GoString added in v1.30.25 

func (s SalesforceStandardObjectAttachmentConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceStandardObjectAttachmentConfiguration) SetDocumentTitleFieldName added in v1.30.25 

func (s *SalesforceStandardObjectAttachmentConfiguration) SetDocumentTitleFieldName(v string) *SalesforceStandardObjectAttachmentConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceStandardObjectAttachmentConfiguration) SetFieldMappings added in v1.30.25 

func (s *SalesforceStandardObjectAttachmentConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SalesforceStandardObjectAttachmentConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (SalesforceStandardObjectAttachmentConfiguration) String added in v1.30.25 

func (s SalesforceStandardObjectAttachmentConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceStandardObjectAttachmentConfiguration) Validate added in v1.30.25 

func (s *SalesforceStandardObjectAttachmentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SalesforceStandardObjectConfiguration added in v1.30.25 

type SalesforceStandardObjectConfiguration struct {

	// The name of the field in the standard object table that contains the document
	// contents.
	//
	// DocumentDataFieldName is a required field
	DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

	// The name of the field in the standard object table that contains the document
	// title.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// Maps attributes or field names of the standard object to Amazon Kendra index
	// field names. To create custom fields, use the UpdateIndex API before you
	// map to Salesforce fields. For more information, see Mapping data source fields
	// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The Salesforce
	// data source field names must exist in your Salesforce custom metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// The name of the standard object.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"SalesforceStandardObjectName"`
	// contains filtered or unexported fields
}

Provides the configuration information for indexing a single standard object.

func (SalesforceStandardObjectConfiguration) GoString added in v1.30.25 

func (s SalesforceStandardObjectConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceStandardObjectConfiguration) SetDocumentDataFieldName added in v1.30.25 

func (s *SalesforceStandardObjectConfiguration) SetDocumentDataFieldName(v string) *SalesforceStandardObjectConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceStandardObjectConfiguration) SetDocumentTitleFieldName added in v1.30.25 

func (s *SalesforceStandardObjectConfiguration) SetDocumentTitleFieldName(v string) *SalesforceStandardObjectConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceStandardObjectConfiguration) SetFieldMappings added in v1.30.25 

func (s *SalesforceStandardObjectConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SalesforceStandardObjectConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*SalesforceStandardObjectConfiguration) SetName added in v1.30.25 

func (s *SalesforceStandardObjectConfiguration) SetName(v string) *SalesforceStandardObjectConfiguration

SetName sets the Name field's value.

func (SalesforceStandardObjectConfiguration) String added in v1.30.25 

func (s SalesforceStandardObjectConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceStandardObjectConfiguration) Validate added in v1.30.25 

func (s *SalesforceStandardObjectConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ScoreAttributes added in v1.34.17 

type ScoreAttributes struct {

	// A relative ranking for how relevant the response is to the query.
	ScoreConfidence *string `type:"string" enum:"ScoreConfidence"`
	// contains filtered or unexported fields
}

Provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

func (ScoreAttributes) GoString added in v1.34.17 

func (s ScoreAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScoreAttributes) SetScoreConfidence added in v1.34.17 

func (s *ScoreAttributes) SetScoreConfidence(v string) *ScoreAttributes

SetScoreConfidence sets the ScoreConfidence field's value.

func (ScoreAttributes) String added in v1.34.17 

func (s ScoreAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive". 

type Search struct {

	// Determines whether the field is returned in the query response. The default
	// is true.
	Displayable *bool `type:"boolean"`

	// Indicates that the field can be used to create search facets, a count of
	// results for each value in the field. The default is false .
	Facetable *bool `type:"boolean"`

	// Determines 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.
	Searchable *bool `type:"boolean"`

	// Determines 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.
	Sortable *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides information about how a custom index field is used during a search.

func (Search) GoString 

func (s Search) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Search) SetDisplayable 

func (s *Search) SetDisplayable(v bool) *Search

SetDisplayable sets the Displayable field's value.

func (*Search) SetFacetable 

func (s *Search) SetFacetable(v bool) *Search

SetFacetable sets the Facetable field's value.

func (*Search) SetSearchable 

func (s *Search) SetSearchable(v bool) *Search

SetSearchable sets the Searchable field's value.

func (*Search) SetSortable added in v1.33.12 

func (s *Search) SetSortable(v bool) *Search

SetSortable sets the Sortable field's value.

func (Search) String 

func (s Search) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SeedUrlConfiguration added in v1.38.64 

type SeedUrlConfiguration struct {

	// The list of seed or starting point URLs of the websites you want to crawl.
	//
	// The list can include a maximum of 100 seed URLs.
	//
	// SeedUrls is a required field
	SeedUrls []*string `type:"list" required:"true"`

	// You can choose one of the following modes:
	//
	//    * HOST_ONLY—crawl only the website host names. For example, if the seed
	//    URL is "abc.example.com", then only URLs with host name "abc.example.com"
	//    are crawled.
	//
	//    * SUBDOMAINS—crawl the website host names with subdomains. For example,
	//    if the seed URL is "abc.example.com", then "a.abc.example.com" and "b.abc.example.com"
	//    are also crawled.
	//
	//    * EVERYTHING—crawl the website host names with subdomains and other
	//    domains that the web pages link to.
	//
	// The default mode is set to HOST_ONLY.
	WebCrawlerMode *string `type:"string" enum:"WebCrawlerMode"`
	// contains filtered or unexported fields
}

Provides the configuration information for the seed or starting point URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.

func (SeedUrlConfiguration) GoString added in v1.38.64 

func (s SeedUrlConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SeedUrlConfiguration) SetSeedUrls added in v1.38.64 

func (s *SeedUrlConfiguration) SetSeedUrls(v []*string) *SeedUrlConfiguration

SetSeedUrls sets the SeedUrls field's value.

func (*SeedUrlConfiguration) SetWebCrawlerMode added in v1.38.64 

func (s *SeedUrlConfiguration) SetWebCrawlerMode(v string) *SeedUrlConfiguration

SetWebCrawlerMode sets the WebCrawlerMode field's value.

func (SeedUrlConfiguration) String added in v1.38.64 

func (s SeedUrlConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SeedUrlConfiguration) Validate added in v1.38.64 

func (s *SeedUrlConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServerSideEncryptionConfiguration 

type ServerSideEncryptionConfiguration struct {

	// The identifier of the KMS key. Amazon Kendra doesn't support asymmetric keys.
	//
	// KmsKeyId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ServerSideEncryptionConfiguration's
	// String and GoString methods.
	KmsKeyId *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric keys.

func (ServerSideEncryptionConfiguration) GoString 

func (s ServerSideEncryptionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) SetKmsKeyId 

func (s *ServerSideEncryptionConfiguration) SetKmsKeyId(v string) *ServerSideEncryptionConfiguration

SetKmsKeyId sets the KmsKeyId field's value.

func (ServerSideEncryptionConfiguration) String 

func (s ServerSideEncryptionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) Validate 

func (s *ServerSideEncryptionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceNowConfiguration added in v1.30.25 

type ServiceNowConfiguration struct {

	// The type of authentication used to connect to the ServiceNow instance. If
	// you choose HTTP_BASIC, Amazon Kendra is authenticated using the user name
	// and password provided in the Secrets Manager secret in the SecretArn field.
	// If you choose OAUTH2, Amazon Kendra is authenticated using the credentials
	// of client ID, client secret, user name and password.
	//
	// When you use OAUTH2 authentication, you must generate a token and a client
	// secret using the ServiceNow console. For more information, see Using a ServiceNow
	// data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html).
	AuthenticationType *string `type:"string" enum:"ServiceNowAuthenticationType"`

	// The ServiceNow instance that the data source connects to. The host endpoint
	// should look like the following: {instance}.service-now.com.
	//
	// HostUrl is a required field
	HostUrl *string `min:"1" type:"string" required:"true"`

	// Configuration information for crawling knowledge articles in the ServiceNow
	// site.
	KnowledgeArticleConfiguration *ServiceNowKnowledgeArticleConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of the Secrets Manager secret that contains
	// the user name and password required to connect to the ServiceNow instance.
	// You can also provide OAuth authentication credentials of user name, password,
	// client ID, and client secret. For more information, see Using a ServiceNow
	// data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// Configuration information for crawling service catalogs in the ServiceNow
	// site.
	ServiceCatalogConfiguration *ServiceNowServiceCatalogConfiguration `type:"structure"`

	// The identifier of the release that the ServiceNow host is running. If the
	// host is not running the LONDON release, use OTHERS.
	//
	// ServiceNowBuildVersion is a required field
	ServiceNowBuildVersion *string `type:"string" required:"true" enum:"ServiceNowBuildVersionType"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to ServiceNow as your data source.

func (ServiceNowConfiguration) GoString added in v1.30.25 

func (s ServiceNowConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNowConfiguration) SetAuthenticationType added in v1.38.11 

func (s *ServiceNowConfiguration) SetAuthenticationType(v string) *ServiceNowConfiguration

SetAuthenticationType sets the AuthenticationType field's value.

func (*ServiceNowConfiguration) SetHostUrl added in v1.30.25 

func (s *ServiceNowConfiguration) SetHostUrl(v string) *ServiceNowConfiguration

SetHostUrl sets the HostUrl field's value.

func (*ServiceNowConfiguration) SetKnowledgeArticleConfiguration added in v1.30.25 

func (s *ServiceNowConfiguration) SetKnowledgeArticleConfiguration(v *ServiceNowKnowledgeArticleConfiguration) *ServiceNowConfiguration

SetKnowledgeArticleConfiguration sets the KnowledgeArticleConfiguration field's value.

func (*ServiceNowConfiguration) SetSecretArn added in v1.30.25 

func (s *ServiceNowConfiguration) SetSecretArn(v string) *ServiceNowConfiguration

SetSecretArn sets the SecretArn field's value.

func (*ServiceNowConfiguration) SetServiceCatalogConfiguration added in v1.30.25 

func (s *ServiceNowConfiguration) SetServiceCatalogConfiguration(v *ServiceNowServiceCatalogConfiguration) *ServiceNowConfiguration

SetServiceCatalogConfiguration sets the ServiceCatalogConfiguration field's value.

func (*ServiceNowConfiguration) SetServiceNowBuildVersion added in v1.30.25 

func (s *ServiceNowConfiguration) SetServiceNowBuildVersion(v string) *ServiceNowConfiguration

SetServiceNowBuildVersion sets the ServiceNowBuildVersion field's value.

func (ServiceNowConfiguration) String added in v1.30.25 

func (s ServiceNowConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNowConfiguration) Validate added in v1.30.25 

func (s *ServiceNowConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceNowKnowledgeArticleConfiguration added in v1.30.25 

type ServiceNowKnowledgeArticleConfiguration struct {

	// TRUE to index attachments to knowledge articles.
	CrawlAttachments *bool `type:"boolean"`

	// The name of the ServiceNow field that is mapped to the index document contents
	// field in the Amazon Kendra index.
	//
	// DocumentDataFieldName is a required field
	DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

	// The name of the ServiceNow field that is mapped to the index document title
	// field.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// A list of regular expression patterns applied to exclude certain knowledge
	// article attachments. Attachments that match the patterns are excluded from
	// the index. Items that don't match the patterns are included in the index.
	// If an item matches both an inclusion and exclusion pattern, the exclusion
	// pattern takes precedence and the item isn't included in the index.
	ExcludeAttachmentFilePatterns []*string `type:"list"`

	// Maps attributes or field names of knoweldge articles to Amazon Kendra index
	// field names. To create custom fields, use the UpdateIndex API before you
	// map to ServiceNow fields. For more information, see Mapping data source fields
	// (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). The ServiceNow
	// data source field names must exist in your ServiceNow custom metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A query that selects the knowledge articles to index. The query can return
	// articles from multiple knowledge bases, and the knowledge bases can be public
	// or private.
	//
	// The query string must be one generated by the ServiceNow console. For more
	// information, see Specifying documents to index with a query (https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html).
	FilterQuery *string `min:"1" type:"string"`

	// A list of regular expression patterns applied to include knowledge article
	// attachments. Attachments that match the patterns are included in the index.
	// Items that don't match the patterns are excluded from the index. If an item
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the item isn't included in the index.
	IncludeAttachmentFilePatterns []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

func (ServiceNowKnowledgeArticleConfiguration) GoString added in v1.30.25 

func (s ServiceNowKnowledgeArticleConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNowKnowledgeArticleConfiguration) SetCrawlAttachments added in v1.30.25 

func (s *ServiceNowKnowledgeArticleConfiguration) SetCrawlAttachments(v bool) *ServiceNowKnowledgeArticleConfiguration

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetDocumentDataFieldName added in v1.30.25 

func (s *ServiceNowKnowledgeArticleConfiguration) SetDocumentDataFieldName(v string) *ServiceNowKnowledgeArticleConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetDocumentTitleFieldName added in v1.30.25 

func (s *ServiceNowKnowledgeArticleConfiguration) SetDocumentTitleFieldName(v string) *ServiceNowKnowledgeArticleConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetExcludeAttachmentFilePatterns added in v1.30.25 

func (s *ServiceNowKnowledgeArticleConfiguration) SetExcludeAttachmentFilePatterns(v []*string) *ServiceNowKnowledgeArticleConfiguration

SetExcludeAttachmentFilePatterns sets the ExcludeAttachmentFilePatterns field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetFieldMappings added in v1.30.25 

func (s *ServiceNowKnowledgeArticleConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *ServiceNowKnowledgeArticleConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetFilterQuery added in v1.38.11 

func (s *ServiceNowKnowledgeArticleConfiguration) SetFilterQuery(v string) *ServiceNowKnowledgeArticleConfiguration

SetFilterQuery sets the FilterQuery field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetIncludeAttachmentFilePatterns added in v1.30.25 

func (s *ServiceNowKnowledgeArticleConfiguration) SetIncludeAttachmentFilePatterns(v []*string) *ServiceNowKnowledgeArticleConfiguration

SetIncludeAttachmentFilePatterns sets the IncludeAttachmentFilePatterns field's value.

func (ServiceNowKnowledgeArticleConfiguration) String added in v1.30.25 

func (s ServiceNowKnowledgeArticleConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNowKnowledgeArticleConfiguration) Validate added in v1.30.25 

func (s *ServiceNowKnowledgeArticleConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceNowServiceCatalogConfiguration added in v1.30.25 

type ServiceNowServiceCatalogConfiguration struct {

	// TRUE to index attachments to service catalog items.
	CrawlAttachments *bool `type:"boolean"`

	// The name of the ServiceNow field that is mapped to the index document contents
	// field in the Amazon Kendra index.
	//
	// DocumentDataFieldName is a required field
	DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

	// The name of the ServiceNow field that is mapped to the index document title
	// field.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// A list of regular expression patterns to exclude certain attachments of catalogs
	// in your ServiceNow. Item that match the patterns are excluded from the index.
	// Items that don't match the patterns are included in the index. If an item
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the item isn't included in the index.
	//
	// The regex is applied to the file name of the attachment.
	ExcludeAttachmentFilePatterns []*string `type:"list"`

	// Maps attributes or field names of catalogs to Amazon Kendra index field names.
	// To create custom fields, use the UpdateIndex API before you map to ServiceNow
	// fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The ServiceNow data source field names must exist in your ServiceNow custom
	// metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain attachments of catalogs
	// in your ServiceNow. Item that match the patterns are included in the index.
	// Items that don't match the patterns are excluded from the index. If an item
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the item isn't included in the index.
	//
	// The regex is applied to the file name of the attachment.
	IncludeAttachmentFilePatterns []*string `type:"list"`
	// contains filtered or unexported fields
}

Provides the configuration information for crawling service catalog items in the ServiceNow site

func (ServiceNowServiceCatalogConfiguration) GoString added in v1.30.25 

func (s ServiceNowServiceCatalogConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNowServiceCatalogConfiguration) SetCrawlAttachments added in v1.30.25 

func (s *ServiceNowServiceCatalogConfiguration) SetCrawlAttachments(v bool) *ServiceNowServiceCatalogConfiguration

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*ServiceNowServiceCatalogConfiguration) SetDocumentDataFieldName added in v1.30.25 

func (s *ServiceNowServiceCatalogConfiguration) SetDocumentDataFieldName(v string) *ServiceNowServiceCatalogConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*ServiceNowServiceCatalogConfiguration) SetDocumentTitleFieldName added in v1.30.25 

func (s *ServiceNowServiceCatalogConfiguration) SetDocumentTitleFieldName(v string) *ServiceNowServiceCatalogConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*ServiceNowServiceCatalogConfiguration) SetExcludeAttachmentFilePatterns added in v1.30.25 

func (s *ServiceNowServiceCatalogConfiguration) SetExcludeAttachmentFilePatterns(v []*string) *ServiceNowServiceCatalogConfiguration

SetExcludeAttachmentFilePatterns sets the ExcludeAttachmentFilePatterns field's value.

func (*ServiceNowServiceCatalogConfiguration) SetFieldMappings added in v1.30.25 

func (s *ServiceNowServiceCatalogConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *ServiceNowServiceCatalogConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*ServiceNowServiceCatalogConfiguration) SetIncludeAttachmentFilePatterns added in v1.30.25 

func (s *ServiceNowServiceCatalogConfiguration) SetIncludeAttachmentFilePatterns(v []*string) *ServiceNowServiceCatalogConfiguration

SetIncludeAttachmentFilePatterns sets the IncludeAttachmentFilePatterns field's value.

func (ServiceNowServiceCatalogConfiguration) String added in v1.30.25 

func (s ServiceNowServiceCatalogConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceNowServiceCatalogConfiguration) Validate added in v1.30.25 

func (s *ServiceNowServiceCatalogConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException added in v1.28.0 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

You have exceeded the set limits for your Amazon Kendra service. Please see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html) for more information, or contact Support (http://aws.amazon.com/contact-us/) to inquire about an increase of limits.

func (*ServiceQuotaExceededException) Code added in v1.28.0 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error added in v1.28.0 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString added in v1.28.0 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message added in v1.28.0 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr added in v1.28.0 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID added in v1.28.0 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode added in v1.28.0 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String added in v1.28.0 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SharePointConfiguration 

type SharePointConfiguration struct {

	// Whether you want to connect to SharePoint Online using basic authentication
	// of user name and password, or OAuth authentication of user name, password,
	// client ID, and client secret, or AD App-only authentication of client secret.
	AuthenticationType *string `type:"string" enum:"SharePointOnlineAuthenticationType"`

	// TRUE to index document attachments.
	CrawlAttachments *bool `type:"boolean"`

	// TRUE to disable local groups information.
	DisableLocalGroups *bool `type:"boolean"`

	// The Microsoft SharePoint attribute field that contains the title of the document.
	DocumentTitleFieldName *string `min:"1" type:"string"`

	// A list of regular expression patterns to exclude certain documents in your
	// SharePoint. Documents that match the patterns are excluded from the index.
	// Documents that don't match the patterns are included in the index. If a document
	// matches both an inclusion and exclusion pattern, the exclusion pattern takes
	// precedence and the document isn't included in the index.
	//
	// The regex applies to the display URL of the SharePoint document.
	ExclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map SharePoint data
	// source attributes or field names to Amazon Kendra index field names. To create
	// custom fields, use the UpdateIndex API before you map to SharePoint fields.
	// For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The SharePoint data source field names must exist in your SharePoint custom
	// metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain documents in your
	// SharePoint. Documents that match the patterns are included in the index.
	// Documents that don't match the patterns are excluded from the index. If a
	// document matches both an inclusion and exclusion pattern, the exclusion pattern
	// takes precedence and the document isn't included in the index.
	//
	// The regex applies to the display URL of the SharePoint document.
	InclusionPatterns []*string `type:"list"`

	// Configuration information to connect to your Microsoft SharePoint site URLs
	// via instance via a web proxy. You can use this option for SharePoint Server.
	//
	// You must provide the website host name and port number. For example, the
	// host name of https://a.example.com/page1.html is "a.example.com" and the
	// port is 443, the standard port for HTTPS.
	//
	// Web proxy credentials are optional and you can use them to connect to a web
	// proxy server that requires basic authentication of user name and password.
	// To store web proxy credentials, you use a secret in Secrets Manager.
	//
	// It is recommended that you follow best security practices when configuring
	// your web proxy. This includes setting up throttling, setting up logging and
	// monitoring, and applying security patches on a regular basis. If you use
	// your web proxy with multiple data sources, sync jobs that occur at the same
	// time could strain the load on your proxy. It is recommended you prepare your
	// proxy beforehand for any security and load requirements.
	ProxyConfiguration *ProxyConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the user name and password required to connect to the SharePoint instance.
	// For more information, see Microsoft SharePoint (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The version of Microsoft SharePoint that you use.
	//
	// SharePointVersion is a required field
	SharePointVersion *string `type:"string" required:"true" enum:"SharePointVersion"`

	// The path to the SSL certificate stored in an Amazon S3 bucket. You use this
	// to connect to SharePoint Server if you require a secure SSL connection.
	//
	// You can generate a self-signed X509 certificate on any computer using OpenSSL.
	// For an example of using OpenSSL to create an X509 certificate, see Create
	// and sign an X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html).
	SslCertificateS3Path *S3Path `type:"structure"`

	// The Microsoft SharePoint site URLs for the documents you want to index.
	//
	// Urls is a required field
	Urls []*string `min:"1" type:"list" required:"true"`

	// TRUE to use the SharePoint change log to determine which documents require
	// updating in the index. Depending on the change log's size, it may take longer
	// for Amazon Kendra to use the change log than to scan all of your documents
	// in SharePoint.
	UseChangeLog *bool `type:"boolean"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your Microsoft SharePoint. For more information, see Configuring a VPC
	// (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Microsoft SharePoint as your data source.

func (SharePointConfiguration) GoString 

func (s SharePointConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SharePointConfiguration) SetAuthenticationType added in v1.44.60 

func (s *SharePointConfiguration) SetAuthenticationType(v string) *SharePointConfiguration

SetAuthenticationType sets the AuthenticationType field's value.

func (*SharePointConfiguration) SetCrawlAttachments 

func (s *SharePointConfiguration) SetCrawlAttachments(v bool) *SharePointConfiguration

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*SharePointConfiguration) SetDisableLocalGroups added in v1.35.22 

func (s *SharePointConfiguration) SetDisableLocalGroups(v bool) *SharePointConfiguration

SetDisableLocalGroups sets the DisableLocalGroups field's value.

func (*SharePointConfiguration) SetDocumentTitleFieldName added in v1.25.50 

func (s *SharePointConfiguration) SetDocumentTitleFieldName(v string) *SharePointConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SharePointConfiguration) SetExclusionPatterns added in v1.29.34 

func (s *SharePointConfiguration) SetExclusionPatterns(v []*string) *SharePointConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*SharePointConfiguration) SetFieldMappings 

func (s *SharePointConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SharePointConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*SharePointConfiguration) SetInclusionPatterns added in v1.29.34 

func (s *SharePointConfiguration) SetInclusionPatterns(v []*string) *SharePointConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*SharePointConfiguration) SetProxyConfiguration added in v1.44.79 

func (s *SharePointConfiguration) SetProxyConfiguration(v *ProxyConfiguration) *SharePointConfiguration

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*SharePointConfiguration) SetSecretArn 

func (s *SharePointConfiguration) SetSecretArn(v string) *SharePointConfiguration

SetSecretArn sets the SecretArn field's value.

func (*SharePointConfiguration) SetSharePointVersion 

func (s *SharePointConfiguration) SetSharePointVersion(v string) *SharePointConfiguration

SetSharePointVersion sets the SharePointVersion field's value.

func (*SharePointConfiguration) SetSslCertificateS3Path added in v1.38.67 

func (s *SharePointConfiguration) SetSslCertificateS3Path(v *S3Path) *SharePointConfiguration

SetSslCertificateS3Path sets the SslCertificateS3Path field's value.

func (*SharePointConfiguration) SetUrls 

func (s *SharePointConfiguration) SetUrls(v []*string) *SharePointConfiguration

SetUrls sets the Urls field's value.

func (*SharePointConfiguration) SetUseChangeLog added in v1.29.34 

func (s *SharePointConfiguration) SetUseChangeLog(v bool) *SharePointConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (*SharePointConfiguration) SetVpcConfiguration 

func (s *SharePointConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *SharePointConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (SharePointConfiguration) String 

func (s SharePointConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SharePointConfiguration) Validate 

func (s *SharePointConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SiteMapsConfiguration added in v1.38.64 

type SiteMapsConfiguration struct {

	// The list of sitemap URLs of the websites you want to crawl.
	//
	// The list can include a maximum of three sitemap URLs.
	//
	// SiteMaps is a required field
	SiteMaps []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information for the sitemap URLs to crawl.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.

func (SiteMapsConfiguration) GoString added in v1.38.64 

func (s SiteMapsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SiteMapsConfiguration) SetSiteMaps added in v1.38.64 

func (s *SiteMapsConfiguration) SetSiteMaps(v []*string) *SiteMapsConfiguration

SetSiteMaps sets the SiteMaps field's value.

func (SiteMapsConfiguration) String added in v1.38.64 

func (s SiteMapsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SiteMapsConfiguration) Validate added in v1.38.64 

func (s *SiteMapsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SlackConfiguration added in v1.43.18 

type SlackConfiguration struct {

	// TRUE to index bot messages from your Slack workspace team.
	CrawlBotMessage *bool `type:"boolean"`

	// TRUE to exclude archived messages to index from your Slack workspace team.
	ExcludeArchived *bool `type:"boolean"`

	// A list of regular expression patterns to exclude certain attached files in
	// your Slack workspace team. Files that match the patterns are excluded from
	// the index. Files that don’t match the patterns are included in the index.
	// If a file matches both an inclusion and exclusion pattern, the exclusion
	// pattern takes precedence and the file isn't included in the index.
	ExclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map Slack data source
	// attributes or field names to Amazon Kendra index field names. To create custom
	// fields, use the UpdateIndex API before you map to Slack fields. For more
	// information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Slack data source field names must exist in your Slack custom metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain attached files in
	// your Slack workspace team. Files that match the patterns are included in
	// the index. Files that don't match the patterns are excluded from the index.
	// If a file matches both an inclusion and exclusion pattern, the exclusion
	// pattern takes precedence and the file isn't included in the index.
	InclusionPatterns []*string `type:"list"`

	// The number of hours for change log to look back from when you last synchronized
	// your data. You can look back up to 7 days or 168 hours.
	//
	// Change log updates your index only if new content was added since you last
	// synced your data. Updated or deleted content from before you last synced
	// does not get updated in your index. To capture updated or deleted content
	// before you last synced, set the LookBackPeriod to the number of hours you
	// want change log to look back.
	LookBackPeriod *int64 `type:"integer"`

	// The list of private channel names from your Slack workspace team. You use
	// this if you want to index specific private channels, not all private channels.
	// You can also use regular expression patterns to filter private channels.
	PrivateChannelFilter []*string `type:"list"`

	// The list of public channel names to index from your Slack workspace team.
	// You use this if you want to index specific public channels, not all public
	// channels. You can also use regular expression patterns to filter public channels.
	PublicChannelFilter []*string `type:"list"`

	// The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
	// the key-value pairs required to connect to your Slack workspace team. The
	// secret must contain a JSON structure with the following keys:
	//
	//    * slackToken—The user or bot token created in Slack. For more information
	//    on creating a token in Slack, see Authentication for a Slack data source
	//    (https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication).
	//
	// SecretArn is a required field
	SecretArn *string `min:"1" type:"string" required:"true"`

	// The date to start crawling your data from your Slack workspace team. The
	// date must follow this format: yyyy-mm-dd.
	//
	// SinceCrawlDate is a required field
	SinceCrawlDate *string `min:"10" type:"string" required:"true"`

	// Specify whether to index public channels, private channels, group messages,
	// and direct messages. You can specify one or more of these options.
	//
	// SlackEntityList is a required field
	SlackEntityList []*string `min:"1" type:"list" required:"true" enum:"SlackEntity"`

	// The identifier of the team in the Slack workspace. For example, T0123456789.
	//
	// You can find your team ID in the URL of the main page of your Slack workspace.
	// When you log in to Slack via a browser, you are directed to the URL of the
	// main page. For example, https://app.slack.com/client/T0123456789/....
	//
	// TeamId is a required field
	TeamId *string `min:"1" type:"string" required:"true"`

	// TRUE to use the Slack change log to determine which documents require updating
	// in the index. Depending on the Slack change log's size, it may take longer
	// for Amazon Kendra to use the change log than to scan all of your documents
	// in Slack.
	UseChangeLog *bool `type:"boolean"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your Slack. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Slack as your data source.

Amazon Kendra now supports an upgraded Slack connector.

You must now use the TemplateConfiguration (https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) object instead of the SlackConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

func (SlackConfiguration) GoString added in v1.43.18 

func (s SlackConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SlackConfiguration) SetCrawlBotMessage added in v1.43.18 

func (s *SlackConfiguration) SetCrawlBotMessage(v bool) *SlackConfiguration

SetCrawlBotMessage sets the CrawlBotMessage field's value.

func (*SlackConfiguration) SetExcludeArchived added in v1.43.18 

func (s *SlackConfiguration) SetExcludeArchived(v bool) *SlackConfiguration

SetExcludeArchived sets the ExcludeArchived field's value.

func (*SlackConfiguration) SetExclusionPatterns added in v1.43.18 

func (s *SlackConfiguration) SetExclusionPatterns(v []*string) *SlackConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*SlackConfiguration) SetFieldMappings added in v1.43.18 

func (s *SlackConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *SlackConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*SlackConfiguration) SetInclusionPatterns added in v1.43.18 

func (s *SlackConfiguration) SetInclusionPatterns(v []*string) *SlackConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*SlackConfiguration) SetLookBackPeriod added in v1.43.18 

func (s *SlackConfiguration) SetLookBackPeriod(v int64) *SlackConfiguration

SetLookBackPeriod sets the LookBackPeriod field's value.

func (*SlackConfiguration) SetPrivateChannelFilter added in v1.43.18 

func (s *SlackConfiguration) SetPrivateChannelFilter(v []*string) *SlackConfiguration

SetPrivateChannelFilter sets the PrivateChannelFilter field's value.

func (*SlackConfiguration) SetPublicChannelFilter added in v1.43.18 

func (s *SlackConfiguration) SetPublicChannelFilter(v []*string) *SlackConfiguration

SetPublicChannelFilter sets the PublicChannelFilter field's value.

func (*SlackConfiguration) SetSecretArn added in v1.43.18 

func (s *SlackConfiguration) SetSecretArn(v string) *SlackConfiguration

SetSecretArn sets the SecretArn field's value.

func (*SlackConfiguration) SetSinceCrawlDate added in v1.43.18 

func (s *SlackConfiguration) SetSinceCrawlDate(v string) *SlackConfiguration

SetSinceCrawlDate sets the SinceCrawlDate field's value.

func (*SlackConfiguration) SetSlackEntityList added in v1.43.18 

func (s *SlackConfiguration) SetSlackEntityList(v []*string) *SlackConfiguration

SetSlackEntityList sets the SlackEntityList field's value.

func (*SlackConfiguration) SetTeamId added in v1.43.18 

func (s *SlackConfiguration) SetTeamId(v string) *SlackConfiguration

SetTeamId sets the TeamId field's value.

func (*SlackConfiguration) SetUseChangeLog added in v1.43.18 

func (s *SlackConfiguration) SetUseChangeLog(v bool) *SlackConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (*SlackConfiguration) SetVpcConfiguration added in v1.43.18 

func (s *SlackConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *SlackConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (SlackConfiguration) String added in v1.43.18 

func (s SlackConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SlackConfiguration) Validate added in v1.43.18 

func (s *SlackConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SortingConfiguration added in v1.33.12 

type SortingConfiguration struct {

	// The name of the document attribute used to sort the response. You can use
	// any field that has the Sortable flag set to true.
	//
	// You can also sort by any of the following built-in attributes:
	//
	//    * _category
	//
	//    * _created_at
	//
	//    * _last_updated_at
	//
	//    * _version
	//
	//    * _view_count
	//
	// DocumentAttributeKey is a required field
	DocumentAttributeKey *string `min:"1" type:"string" required:"true"`

	// The order that the results should be returned in. In case of ties, the relevance
	// assigned to the result by Amazon Kendra is used as the tie-breaker.
	//
	// SortOrder is a required field
	SortOrder *string `type:"string" required:"true" enum:"SortOrder"`
	// contains filtered or unexported fields
}

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.

You can sort attributes of the following types.

  • Date value

  • Long value

  • String value

You can't sort attributes of the following type.

  • String list value

func (SortingConfiguration) GoString added in v1.33.12 

func (s SortingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SortingConfiguration) SetDocumentAttributeKey added in v1.33.12 

func (s *SortingConfiguration) SetDocumentAttributeKey(v string) *SortingConfiguration

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*SortingConfiguration) SetSortOrder added in v1.33.12 

func (s *SortingConfiguration) SetSortOrder(v string) *SortingConfiguration

SetSortOrder sets the SortOrder field's value.

func (SortingConfiguration) String added in v1.33.12 

func (s SortingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SortingConfiguration) Validate added in v1.33.12 

func (s *SortingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SourceDocument added in v1.44.255 

type SourceDocument struct {

	// The additional fields/attributes to include in the response. You can use
	// additional fields to provide extra information in the response. Additional
	// fields are not used to based suggestions on.
	AdditionalAttributes []*DocumentAttribute `type:"list"`

	// The identifier of the document used for a query suggestion.
	DocumentId *string `min:"1" type:"string"`

	// The document fields/attributes used for a query suggestion.
	SuggestionAttributes []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

The document ID and its fields/attributes that are used for a query suggestion, if document fields set to use for query suggestions.

func (SourceDocument) GoString added in v1.44.255 

func (s SourceDocument) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceDocument) SetAdditionalAttributes added in v1.44.255 

func (s *SourceDocument) SetAdditionalAttributes(v []*DocumentAttribute) *SourceDocument

SetAdditionalAttributes sets the AdditionalAttributes field's value.

func (*SourceDocument) SetDocumentId added in v1.44.255 

func (s *SourceDocument) SetDocumentId(v string) *SourceDocument

SetDocumentId sets the DocumentId field's value.

func (*SourceDocument) SetSuggestionAttributes added in v1.44.255 

func (s *SourceDocument) SetSuggestionAttributes(v []*string) *SourceDocument

SetSuggestionAttributes sets the SuggestionAttributes field's value.

func (SourceDocument) String added in v1.44.255 

func (s SourceDocument) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SpellCorrectedQuery added in v1.43.11 

type SpellCorrectedQuery struct {

	// The corrected misspelled word or words in a query.
	Corrections []*Correction `type:"list"`

	// The query with the suggested spell corrections.
	SuggestedQueryText *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A query with suggested spell corrections.

func (SpellCorrectedQuery) GoString added in v1.43.11 

func (s SpellCorrectedQuery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SpellCorrectedQuery) SetCorrections added in v1.43.11 

func (s *SpellCorrectedQuery) SetCorrections(v []*Correction) *SpellCorrectedQuery

SetCorrections sets the Corrections field's value.

func (*SpellCorrectedQuery) SetSuggestedQueryText added in v1.43.11 

func (s *SpellCorrectedQuery) SetSuggestedQueryText(v string) *SpellCorrectedQuery

SetSuggestedQueryText sets the SuggestedQueryText field's value.

func (SpellCorrectedQuery) String added in v1.43.11 

func (s SpellCorrectedQuery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SpellCorrectionConfiguration added in v1.43.11 

type SpellCorrectionConfiguration struct {

	// TRUE to suggest spell corrections for queries.
	//
	// IncludeQuerySpellCheckSuggestions is a required field
	IncludeQuerySpellCheckSuggestions *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information for suggested query spell corrections.

Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.

This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the Spell Checker documentation (https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html).

func (SpellCorrectionConfiguration) GoString added in v1.43.11 

func (s SpellCorrectionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SpellCorrectionConfiguration) SetIncludeQuerySpellCheckSuggestions added in v1.43.11 

func (s *SpellCorrectionConfiguration) SetIncludeQuerySpellCheckSuggestions(v bool) *SpellCorrectionConfiguration

SetIncludeQuerySpellCheckSuggestions sets the IncludeQuerySpellCheckSuggestions field's value.

func (SpellCorrectionConfiguration) String added in v1.43.11 

func (s SpellCorrectionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SpellCorrectionConfiguration) Validate added in v1.43.11 

func (s *SpellCorrectionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SqlConfiguration added in v1.33.12 

type SqlConfiguration struct {

	// Determines whether Amazon Kendra encloses SQL identifiers for tables and
	// column names in double quotes (") when making a database query.
	//
	// By default, Amazon Kendra passes SQL identifiers the way that they are entered
	// into the data source configuration. It does not change the case of identifiers
	// or enclose them in quotes.
	//
	// PostgreSQL internally converts uppercase characters to lower case characters
	// in identifiers unless they are quoted. Choosing this option encloses identifiers
	// in quotes so that PostgreSQL does not convert the character's case.
	//
	// For MySQL databases, you must enable the ansi_quotes option when you set
	// this field to DOUBLE_QUOTES.
	QueryIdentifiersEnclosingOption *string `type:"string" enum:"QueryIdentifiersEnclosingOption"`
	// contains filtered or unexported fields
}

Provides the configuration information to use a SQL database.

func (SqlConfiguration) GoString added in v1.33.12 

func (s SqlConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SqlConfiguration) SetQueryIdentifiersEnclosingOption added in v1.33.12 

func (s *SqlConfiguration) SetQueryIdentifiersEnclosingOption(v string) *SqlConfiguration

SetQueryIdentifiersEnclosingOption sets the QueryIdentifiersEnclosingOption field's value.

func (SqlConfiguration) String added in v1.33.12 

func (s SqlConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartDataSourceSyncJobInput 

type StartDataSourceSyncJobInput struct {

	// The identifier of the data source connector to synchronize.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartDataSourceSyncJobInput) GoString 

func (s StartDataSourceSyncJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDataSourceSyncJobInput) SetId 

func (s *StartDataSourceSyncJobInput) SetId(v string) *StartDataSourceSyncJobInput

SetId sets the Id field's value.

func (*StartDataSourceSyncJobInput) SetIndexId 

func (s *StartDataSourceSyncJobInput) SetIndexId(v string) *StartDataSourceSyncJobInput

SetIndexId sets the IndexId field's value.

func (StartDataSourceSyncJobInput) String 

func (s StartDataSourceSyncJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDataSourceSyncJobInput) Validate 

func (s *StartDataSourceSyncJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartDataSourceSyncJobOutput 

type StartDataSourceSyncJobOutput struct {

	// Identifies a particular synchronization job.
	ExecutionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartDataSourceSyncJobOutput) GoString 

func (s StartDataSourceSyncJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartDataSourceSyncJobOutput) SetExecutionId 

func (s *StartDataSourceSyncJobOutput) SetExecutionId(v string) *StartDataSourceSyncJobOutput

SetExecutionId sets the ExecutionId field's value.

func (StartDataSourceSyncJobOutput) String 

func (s StartDataSourceSyncJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Status added in v1.38.58 

type Status struct {

	// The identifier of the document.
	DocumentId *string `min:"1" type:"string"`

	// The current status of a document.
	//
	// If the document was submitted for deletion, the status is NOT_FOUND after
	// the document is deleted.
	DocumentStatus *string `type:"string" enum:"DocumentStatus"`

	// Indicates the source of the error.
	FailureCode *string `min:"1" type:"string"`

	// Provides detailed information about why the document couldn't be indexed.
	// Use this information to correct the error before you resubmit the document
	// for indexing.
	FailureReason *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about the status of documents submitted for indexing.

func (Status) GoString added in v1.38.58 

func (s Status) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Status) SetDocumentId added in v1.38.58 

func (s *Status) SetDocumentId(v string) *Status

SetDocumentId sets the DocumentId field's value.

func (*Status) SetDocumentStatus added in v1.38.58 

func (s *Status) SetDocumentStatus(v string) *Status

SetDocumentStatus sets the DocumentStatus field's value.

func (*Status) SetFailureCode added in v1.38.58 

func (s *Status) SetFailureCode(v string) *Status

SetFailureCode sets the FailureCode field's value.

func (*Status) SetFailureReason added in v1.38.58 

func (s *Status) SetFailureReason(v string) *Status

SetFailureReason sets the FailureReason field's value.

func (Status) String added in v1.38.58 

func (s Status) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopDataSourceSyncJobInput 

type StopDataSourceSyncJobInput struct {

	// The identifier of the data source connector for which to stop the synchronization
	// jobs.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopDataSourceSyncJobInput) GoString 

func (s StopDataSourceSyncJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDataSourceSyncJobInput) SetId 

func (s *StopDataSourceSyncJobInput) SetId(v string) *StopDataSourceSyncJobInput

SetId sets the Id field's value.

func (*StopDataSourceSyncJobInput) SetIndexId 

func (s *StopDataSourceSyncJobInput) SetIndexId(v string) *StopDataSourceSyncJobInput

SetIndexId sets the IndexId field's value.

func (StopDataSourceSyncJobInput) String 

func (s StopDataSourceSyncJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopDataSourceSyncJobInput) Validate 

func (s *StopDataSourceSyncJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopDataSourceSyncJobOutput 

type StopDataSourceSyncJobOutput struct {
	// contains filtered or unexported fields
}

func (StopDataSourceSyncJobOutput) GoString 

func (s StopDataSourceSyncJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopDataSourceSyncJobOutput) String 

func (s StopDataSourceSyncJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SubmitFeedbackInput 

type SubmitFeedbackInput struct {

	// Tells Amazon Kendra that a particular search result link was chosen by the
	// user.
	ClickFeedbackItems []*ClickFeedback `type:"list"`

	// The identifier of the index that was queried.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The identifier of the specific query for which you are submitting feedback.
	// The query ID is returned in the response to the Query API.
	//
	// QueryId is a required field
	QueryId *string `min:"1" type:"string" required:"true"`

	// Provides Amazon Kendra with relevant or not relevant feedback for whether
	// a particular item was relevant to the search.
	RelevanceFeedbackItems []*RelevanceFeedback `type:"list"`
	// contains filtered or unexported fields
}

func (SubmitFeedbackInput) GoString 

func (s SubmitFeedbackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubmitFeedbackInput) SetClickFeedbackItems 

func (s *SubmitFeedbackInput) SetClickFeedbackItems(v []*ClickFeedback) *SubmitFeedbackInput

SetClickFeedbackItems sets the ClickFeedbackItems field's value.

func (*SubmitFeedbackInput) SetIndexId 

func (s *SubmitFeedbackInput) SetIndexId(v string) *SubmitFeedbackInput

SetIndexId sets the IndexId field's value.

func (*SubmitFeedbackInput) SetQueryId 

func (s *SubmitFeedbackInput) SetQueryId(v string) *SubmitFeedbackInput

SetQueryId sets the QueryId field's value.

func (*SubmitFeedbackInput) SetRelevanceFeedbackItems 

func (s *SubmitFeedbackInput) SetRelevanceFeedbackItems(v []*RelevanceFeedback) *SubmitFeedbackInput

SetRelevanceFeedbackItems sets the RelevanceFeedbackItems field's value.

func (SubmitFeedbackInput) String 

func (s SubmitFeedbackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubmitFeedbackInput) Validate 

func (s *SubmitFeedbackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SubmitFeedbackOutput 

type SubmitFeedbackOutput struct {
	// contains filtered or unexported fields
}

func (SubmitFeedbackOutput) GoString 

func (s SubmitFeedbackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SubmitFeedbackOutput) String 

func (s SubmitFeedbackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuggestableConfig added in v1.44.255 

type SuggestableConfig struct {

	// The name of the document field/attribute.
	AttributeName *string `min:"1" type:"string"`

	// TRUE means the document field/attribute is suggestible, so the contents within
	// the field can be used for query suggestions.
	Suggestable *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides the configuration information for a document field/attribute that you want to base query suggestions on.

func (SuggestableConfig) GoString added in v1.44.255 

func (s SuggestableConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuggestableConfig) SetAttributeName added in v1.44.255 

func (s *SuggestableConfig) SetAttributeName(v string) *SuggestableConfig

SetAttributeName sets the AttributeName field's value.

func (*SuggestableConfig) SetSuggestable added in v1.44.255 

func (s *SuggestableConfig) SetSuggestable(v bool) *SuggestableConfig

SetSuggestable sets the Suggestable field's value.

func (SuggestableConfig) String added in v1.44.255 

func (s SuggestableConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuggestableConfig) Validate added in v1.44.255 

func (s *SuggestableConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Suggestion added in v1.38.50 

type Suggestion struct {

	// The UUID (universally unique identifier) of a single query suggestion.
	Id *string `min:"1" type:"string"`

	// The list of document IDs and their fields/attributes that are used for a
	// single query suggestion, if document fields set to use for query suggestions.
	SourceDocuments []*SourceDocument `type:"list"`

	// The value for the UUID (universally unique identifier) of a single query
	// suggestion.
	//
	// The value is the text string of a suggestion.
	Value *SuggestionValue `type:"structure"`
	// contains filtered or unexported fields
}

A single query suggestion.

func (Suggestion) GoString added in v1.38.50 

func (s Suggestion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Suggestion) SetId added in v1.38.50 

func (s *Suggestion) SetId(v string) *Suggestion

SetId sets the Id field's value.

func (*Suggestion) SetSourceDocuments added in v1.44.255 

func (s *Suggestion) SetSourceDocuments(v []*SourceDocument) *Suggestion

SetSourceDocuments sets the SourceDocuments field's value.

func (*Suggestion) SetValue added in v1.38.50 

func (s *Suggestion) SetValue(v *SuggestionValue) *Suggestion

SetValue sets the Value field's value.

func (Suggestion) String added in v1.38.50 

func (s Suggestion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuggestionHighlight added in v1.38.50 

type SuggestionHighlight struct {

	// The zero-based location in the response string where the highlight starts.
	BeginOffset *int64 `type:"integer"`

	// The zero-based location in the response string where the highlight ends.
	EndOffset *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The text highlights for a single query suggestion.

func (SuggestionHighlight) GoString added in v1.38.50 

func (s SuggestionHighlight) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuggestionHighlight) SetBeginOffset added in v1.38.50 

func (s *SuggestionHighlight) SetBeginOffset(v int64) *SuggestionHighlight

SetBeginOffset sets the BeginOffset field's value.

func (*SuggestionHighlight) SetEndOffset added in v1.38.50 

func (s *SuggestionHighlight) SetEndOffset(v int64) *SuggestionHighlight

SetEndOffset sets the EndOffset field's value.

func (SuggestionHighlight) String added in v1.38.50 

func (s SuggestionHighlight) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuggestionTextWithHighlights added in v1.38.50 

type SuggestionTextWithHighlights struct {

	// The beginning and end of the query suggestion text that should be highlighted.
	Highlights []*SuggestionHighlight `type:"list"`

	// The query suggestion text to display to the user.
	Text *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides text and information about where to highlight the query suggestion text.

func (SuggestionTextWithHighlights) GoString added in v1.38.50 

func (s SuggestionTextWithHighlights) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuggestionTextWithHighlights) SetHighlights added in v1.38.50 

func (s *SuggestionTextWithHighlights) SetHighlights(v []*SuggestionHighlight) *SuggestionTextWithHighlights

SetHighlights sets the Highlights field's value.

func (*SuggestionTextWithHighlights) SetText added in v1.38.50 

func (s *SuggestionTextWithHighlights) SetText(v string) *SuggestionTextWithHighlights

SetText sets the Text field's value.

func (SuggestionTextWithHighlights) String added in v1.38.50 

func (s SuggestionTextWithHighlights) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuggestionValue added in v1.38.50 

type SuggestionValue struct {

	// The SuggestionTextWithHighlights structure that contains the query suggestion
	// text and highlights.
	Text *SuggestionTextWithHighlights `type:"structure"`
	// contains filtered or unexported fields
}

The SuggestionTextWithHighlights structure information.

func (SuggestionValue) GoString added in v1.38.50 

func (s SuggestionValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuggestionValue) SetText added in v1.38.50 

func (s *SuggestionValue) SetText(v *SuggestionTextWithHighlights) *SuggestionValue

SetText sets the Text field's value.

func (SuggestionValue) String added in v1.38.50 

func (s SuggestionValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TableCell added in v1.44.146 

type TableCell struct {

	// TRUE means that the table cell should be treated as a header.
	Header *bool `type:"boolean"`

	// TRUE means that the table cell has a high enough confidence and is relevant
	// to the query, so the value or content should be highlighted.
	Highlighted *bool `type:"boolean"`

	// TRUE if the response of the table cell is the top answer. This is the cell
	// value or content with the highest confidence score or is the most relevant
	// to the query.
	TopAnswer *bool `type:"boolean"`

	// The actual value or content within a table cell. A table cell could contain
	// a date value of a year, or a string value of text, for example.
	Value *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about a table cell in a table excerpt.

func (TableCell) GoString added in v1.44.146 

func (s TableCell) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TableCell) SetHeader added in v1.44.146 

func (s *TableCell) SetHeader(v bool) *TableCell

SetHeader sets the Header field's value.

func (*TableCell) SetHighlighted added in v1.44.146 

func (s *TableCell) SetHighlighted(v bool) *TableCell

SetHighlighted sets the Highlighted field's value.

func (*TableCell) SetTopAnswer added in v1.44.146 

func (s *TableCell) SetTopAnswer(v bool) *TableCell

SetTopAnswer sets the TopAnswer field's value.

func (*TableCell) SetValue added in v1.44.146 

func (s *TableCell) SetValue(v string) *TableCell

SetValue sets the Value field's value.

func (TableCell) String added in v1.44.146 

func (s TableCell) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TableExcerpt added in v1.44.146 

type TableExcerpt struct {

	// A list of rows in the table excerpt.
	Rows []*TableRow `type:"list"`

	// A count of the number of rows in the original table within the document.
	TotalNumberOfRows *int64 `type:"integer"`
	// contains filtered or unexported fields
}

An excerpt from a table within a document. The table excerpt displays up to five columns and three rows, depending on how many table cells are relevant to the query and how many columns are available in the original table. The top most relevant cell is displayed in the table excerpt, along with the next most relevant cells.

func (TableExcerpt) GoString added in v1.44.146 

func (s TableExcerpt) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TableExcerpt) SetRows added in v1.44.146 

func (s *TableExcerpt) SetRows(v []*TableRow) *TableExcerpt

SetRows sets the Rows field's value.

func (*TableExcerpt) SetTotalNumberOfRows added in v1.44.146 

func (s *TableExcerpt) SetTotalNumberOfRows(v int64) *TableExcerpt

SetTotalNumberOfRows sets the TotalNumberOfRows field's value.

func (TableExcerpt) String added in v1.44.146 

func (s TableExcerpt) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TableRow added in v1.44.146 

type TableRow struct {

	// A list of table cells in a row.
	Cells []*TableCell `type:"list"`
	// contains filtered or unexported fields
}

Information about a row in a table excerpt.

func (TableRow) GoString added in v1.44.146 

func (s TableRow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TableRow) SetCells added in v1.44.146 

func (s *TableRow) SetCells(v []*TableCell) *TableRow

SetCells sets the Cells field's value.

func (TableRow) String added in v1.44.146 

func (s TableRow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.30.25 

type Tag struct {

	// The key for the tag. Keys are not case sensitive and must be unique for the
	// index, FAQ, or data source.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value associated with the tag. The value may be an empty string but it
	// can't be null.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

func (Tag) GoString added in v1.30.25 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.30.25 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.30.25 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.30.25 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.30.25 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.30.25 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of tag keys to add to the index, FAQ, or data source. If a tag already
	// exists, the existing value is replaced with the new value.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.30.25 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.30.25 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.30.25 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.30.25 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.30.25 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.30.25 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.30.25 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.30.25 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateConfiguration added in v1.44.79 

type TemplateConfiguration struct {
	// contains filtered or unexported fields
}

Provides a template for the configuration information to connect to your data source.

func (TemplateConfiguration) GoString added in v1.44.79 

func (s TemplateConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TemplateConfiguration) String added in v1.44.79 

func (s TemplateConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TextDocumentStatistics 

type TextDocumentStatistics struct {

	// The total size, in bytes, of the indexed documents.
	//
	// IndexedTextBytes is a required field
	IndexedTextBytes *int64 `type:"long" required:"true"`

	// The number of text documents indexed.
	//
	// IndexedTextDocumentsCount is a required field
	IndexedTextDocumentsCount *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Provides information about text documents indexed in an index.

func (TextDocumentStatistics) GoString 

func (s TextDocumentStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextDocumentStatistics) SetIndexedTextBytes added in v1.30.25 

func (s *TextDocumentStatistics) SetIndexedTextBytes(v int64) *TextDocumentStatistics

SetIndexedTextBytes sets the IndexedTextBytes field's value.

func (*TextDocumentStatistics) SetIndexedTextDocumentsCount 

func (s *TextDocumentStatistics) SetIndexedTextDocumentsCount(v int64) *TextDocumentStatistics

SetIndexedTextDocumentsCount sets the IndexedTextDocumentsCount field's value.

func (TextDocumentStatistics) String 

func (s TextDocumentStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TextWithHighlights 

type TextWithHighlights struct {

	// The beginning and end of the text that should be highlighted.
	Highlights []*Highlight `type:"list"`

	// The text to display to the user.
	Text *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides text and information about where to highlight the text.

func (TextWithHighlights) GoString 

func (s TextWithHighlights) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextWithHighlights) SetHighlights 

func (s *TextWithHighlights) SetHighlights(v []*Highlight) *TextWithHighlights

SetHighlights sets the Highlights field's value.

func (*TextWithHighlights) SetText 

func (s *TextWithHighlights) SetText(v string) *TextWithHighlights

SetText sets the Text field's value.

func (TextWithHighlights) String 

func (s TextWithHighlights) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThesaurusSummary added in v1.36.6 

type ThesaurusSummary struct {

	// The Unix timestamp when the thesaurus was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The identifier of the thesaurus.
	Id *string `min:"1" type:"string"`

	// The name of the thesaurus.
	Name *string `min:"1" type:"string"`

	// The status of the thesaurus.
	Status *string `type:"string" enum:"ThesaurusStatus"`

	// The Unix timestamp when the thesaurus was last updated.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

An array of summary information for a thesaurus or multiple thesauri.

func (ThesaurusSummary) GoString added in v1.36.6 

func (s ThesaurusSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThesaurusSummary) SetCreatedAt added in v1.36.6 

func (s *ThesaurusSummary) SetCreatedAt(v time.Time) *ThesaurusSummary

SetCreatedAt sets the CreatedAt field's value.

func (*ThesaurusSummary) SetId added in v1.36.6 

func (s *ThesaurusSummary) SetId(v string) *ThesaurusSummary

SetId sets the Id field's value.

func (*ThesaurusSummary) SetName added in v1.36.6 

func (s *ThesaurusSummary) SetName(v string) *ThesaurusSummary

SetName sets the Name field's value.

func (*ThesaurusSummary) SetStatus added in v1.36.6 

func (s *ThesaurusSummary) SetStatus(v string) *ThesaurusSummary

SetStatus sets the Status field's value.

func (*ThesaurusSummary) SetUpdatedAt added in v1.36.6 

func (s *ThesaurusSummary) SetUpdatedAt(v time.Time) *ThesaurusSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (ThesaurusSummary) String added in v1.36.6 

func (s ThesaurusSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.28.0 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling. Please reduce the number of requests and try again.

func (*ThrottlingException) Code added in v1.28.0 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.28.0 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.28.0 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.28.0 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.28.0 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.28.0 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.28.0 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.28.0 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeRange 

type TimeRange struct {

	// The Unix timestamp for the end of the time range.
	EndTime *time.Time `type:"timestamp"`

	// The Unix timestamp for the beginning of the time range.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides a range of time.

func (TimeRange) GoString 

func (s TimeRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeRange) SetEndTime 

func (s *TimeRange) SetEndTime(v time.Time) *TimeRange

SetEndTime sets the EndTime field's value.

func (*TimeRange) SetStartTime 

func (s *TimeRange) SetStartTime(v time.Time) *TimeRange

SetStartTime sets the StartTime field's value.

func (TimeRange) String 

func (s TimeRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.30.25 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove
	// the tag from.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of tag keys to remove from the index, FAQ, or data source. If a tag
	// key does not exist on the resource, it is ignored.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.30.25 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.30.25 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.30.25 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.30.25 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.30.25 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.30.25 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.30.25 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.30.25 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAccessControlConfigurationInput added in v1.44.55 

type UpdateAccessControlConfigurationInput struct {

	// Information you want to update on principals (users and/or groups) and which
	// documents they should have access to. This is useful for user context filtering,
	// where search results are filtered based on the user or their group access
	// to documents.
	AccessControlList []*Principal `type:"list"`

	// A new description for the access control configuration.
	Description *string `type:"string"`

	// The updated list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html)
	// lists that define the hierarchy for which documents users should have access
	// to.
	HierarchicalAccessControlList []*HierarchicalPrincipal `min:"1" type:"list"`

	// The identifier of the access control configuration you want to update.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for an access control configuration.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A new name for the access control configuration.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAccessControlConfigurationInput) GoString added in v1.44.55 

func (s UpdateAccessControlConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessControlConfigurationInput) SetAccessControlList added in v1.44.55 

func (s *UpdateAccessControlConfigurationInput) SetAccessControlList(v []*Principal) *UpdateAccessControlConfigurationInput

SetAccessControlList sets the AccessControlList field's value.

func (*UpdateAccessControlConfigurationInput) SetDescription added in v1.44.55 

func (s *UpdateAccessControlConfigurationInput) SetDescription(v string) *UpdateAccessControlConfigurationInput

SetDescription sets the Description field's value.

func (*UpdateAccessControlConfigurationInput) SetHierarchicalAccessControlList added in v1.44.55 

func (s *UpdateAccessControlConfigurationInput) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *UpdateAccessControlConfigurationInput

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*UpdateAccessControlConfigurationInput) SetId added in v1.44.55 

func (s *UpdateAccessControlConfigurationInput) SetId(v string) *UpdateAccessControlConfigurationInput

SetId sets the Id field's value.

func (*UpdateAccessControlConfigurationInput) SetIndexId added in v1.44.55 

func (s *UpdateAccessControlConfigurationInput) SetIndexId(v string) *UpdateAccessControlConfigurationInput

SetIndexId sets the IndexId field's value.

func (*UpdateAccessControlConfigurationInput) SetName added in v1.44.55 

func (s *UpdateAccessControlConfigurationInput) SetName(v string) *UpdateAccessControlConfigurationInput

SetName sets the Name field's value.

func (UpdateAccessControlConfigurationInput) String added in v1.44.55 

func (s UpdateAccessControlConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessControlConfigurationInput) Validate added in v1.44.55 

func (s *UpdateAccessControlConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAccessControlConfigurationOutput added in v1.44.55 

type UpdateAccessControlConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAccessControlConfigurationOutput) GoString added in v1.44.55 

func (s UpdateAccessControlConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAccessControlConfigurationOutput) String added in v1.44.55 

func (s UpdateAccessControlConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDataSourceInput 

type UpdateDataSourceInput struct {

	// Configuration information you want to update for the data source connector.
	Configuration *DataSourceConfiguration `type:"structure"`

	// Configuration information you want to update for altering document metadata
	// and content during the document ingestion process.
	//
	// For more information on how to create, modify and delete document metadata,
	// or make other content alterations when you ingest documents into Amazon Kendra,
	// see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
	CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"`

	// A new description for the data source connector.
	Description *string `type:"string"`

	// The identifier of the data source connector you want to update.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index used with the data source connector.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The code for a language you want to update for the data source connector.
	// This allows you to support a language for all documents when updating the
	// data source. English is supported by default. For more information on supported
	// languages, including their codes, see Adding documents in languages other
	// than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
	LanguageCode *string `min:"2" type:"string"`

	// A new name for the data source connector.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of a role with permission to access the data
	// source and required resources. For more information, see IAM roles for Amazon
	// Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	RoleArn *string `type:"string"`

	// The sync schedule you want to update for the data source connector.
	Schedule *string `type:"string"`

	// Configuration information for an Amazon Virtual Private Cloud to connect
	// to your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
	VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDataSourceInput) GoString 

func (s UpdateDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataSourceInput) SetConfiguration 

func (s *UpdateDataSourceInput) SetConfiguration(v *DataSourceConfiguration) *UpdateDataSourceInput

SetConfiguration sets the Configuration field's value.

func (*UpdateDataSourceInput) SetCustomDocumentEnrichmentConfiguration added in v1.42.17 

func (s *UpdateDataSourceInput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *UpdateDataSourceInput

SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value.

func (*UpdateDataSourceInput) SetDescription 

func (s *UpdateDataSourceInput) SetDescription(v string) *UpdateDataSourceInput

SetDescription sets the Description field's value.

func (*UpdateDataSourceInput) SetId 

func (s *UpdateDataSourceInput) SetId(v string) *UpdateDataSourceInput

SetId sets the Id field's value.

func (*UpdateDataSourceInput) SetIndexId 

func (s *UpdateDataSourceInput) SetIndexId(v string) *UpdateDataSourceInput

SetIndexId sets the IndexId field's value.

func (*UpdateDataSourceInput) SetLanguageCode added in v1.40.58 

func (s *UpdateDataSourceInput) SetLanguageCode(v string) *UpdateDataSourceInput

SetLanguageCode sets the LanguageCode field's value.

func (*UpdateDataSourceInput) SetName 

func (s *UpdateDataSourceInput) SetName(v string) *UpdateDataSourceInput

SetName sets the Name field's value.

func (*UpdateDataSourceInput) SetRoleArn 

func (s *UpdateDataSourceInput) SetRoleArn(v string) *UpdateDataSourceInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateDataSourceInput) SetSchedule 

func (s *UpdateDataSourceInput) SetSchedule(v string) *UpdateDataSourceInput

SetSchedule sets the Schedule field's value.

func (*UpdateDataSourceInput) SetVpcConfiguration added in v1.44.79 

func (s *UpdateDataSourceInput) SetVpcConfiguration(v *DataSourceVpcConfiguration) *UpdateDataSourceInput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (UpdateDataSourceInput) String 

func (s UpdateDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataSourceInput) Validate 

func (s *UpdateDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDataSourceOutput 

type UpdateDataSourceOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDataSourceOutput) GoString 

func (s UpdateDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDataSourceOutput) String 

func (s UpdateDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateExperienceInput added in v1.42.17 

type UpdateExperienceInput struct {

	// Configuration information you want to update for your Amazon Kendra experience.
	Configuration *ExperienceConfiguration `type:"structure"`

	// A new description for your Amazon Kendra experience.
	Description *string `type:"string"`

	// The identifier of your Amazon Kendra experience you want to update.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for your Amazon Kendra experience.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A new name for your Amazon Kendra experience.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of a role with permission to access Query
	// API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that
	// stores your user and group information. For more information, see IAM roles
	// for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
	RoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateExperienceInput) GoString added in v1.42.17 

func (s UpdateExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateExperienceInput) SetConfiguration added in v1.42.17 

func (s *UpdateExperienceInput) SetConfiguration(v *ExperienceConfiguration) *UpdateExperienceInput

SetConfiguration sets the Configuration field's value.

func (*UpdateExperienceInput) SetDescription added in v1.42.17 

func (s *UpdateExperienceInput) SetDescription(v string) *UpdateExperienceInput

SetDescription sets the Description field's value.

func (*UpdateExperienceInput) SetId added in v1.42.17 

func (s *UpdateExperienceInput) SetId(v string) *UpdateExperienceInput

SetId sets the Id field's value.

func (*UpdateExperienceInput) SetIndexId added in v1.42.17 

func (s *UpdateExperienceInput) SetIndexId(v string) *UpdateExperienceInput

SetIndexId sets the IndexId field's value.

func (*UpdateExperienceInput) SetName added in v1.42.17 

func (s *UpdateExperienceInput) SetName(v string) *UpdateExperienceInput

SetName sets the Name field's value.

func (*UpdateExperienceInput) SetRoleArn added in v1.42.17 

func (s *UpdateExperienceInput) SetRoleArn(v string) *UpdateExperienceInput

SetRoleArn sets the RoleArn field's value.

func (UpdateExperienceInput) String added in v1.42.17 

func (s UpdateExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateExperienceInput) Validate added in v1.42.17 

func (s *UpdateExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateExperienceOutput added in v1.42.17 

type UpdateExperienceOutput struct {
	// contains filtered or unexported fields
}

func (UpdateExperienceOutput) GoString added in v1.42.17 

func (s UpdateExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateExperienceOutput) String added in v1.42.17 

func (s UpdateExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFeaturedResultsSetInput added in v1.44.233 

type UpdateFeaturedResultsSetInput struct {

	// A new description for the set of featured results.
	Description *string `type:"string"`

	// A list of document IDs for the documents you want to feature at the top of
	// the search results page. For more information on the list of featured documents,
	// see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
	FeaturedDocuments []*FeaturedDocument `type:"list"`

	// The identifier of the set of featured results that you want to update.
	//
	// FeaturedResultsSetId is a required field
	FeaturedResultsSetId *string `min:"36" type:"string" required:"true"`

	// A new name for the set of featured results.
	FeaturedResultsSetName *string `min:"1" type:"string"`

	// The identifier of the index used for featuring results.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A list of queries for featuring results. For more information on the list
	// of queries, see FeaturedResultsSet (https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
	QueryTexts []*string `type:"list"`

	// You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured
	// results are ready for use. You can still configure your settings before setting
	// the status to ACTIVE. The queries you specify for featured results must be
	// unique per featured results set for each index, whether the status is ACTIVE
	// or INACTIVE.
	Status *string `type:"string" enum:"FeaturedResultsSetStatus"`
	// contains filtered or unexported fields
}

func (UpdateFeaturedResultsSetInput) GoString added in v1.44.233 

func (s UpdateFeaturedResultsSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFeaturedResultsSetInput) SetDescription added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) SetDescription(v string) *UpdateFeaturedResultsSetInput

SetDescription sets the Description field's value.

func (*UpdateFeaturedResultsSetInput) SetFeaturedDocuments added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) SetFeaturedDocuments(v []*FeaturedDocument) *UpdateFeaturedResultsSetInput

SetFeaturedDocuments sets the FeaturedDocuments field's value.

func (*UpdateFeaturedResultsSetInput) SetFeaturedResultsSetId added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) SetFeaturedResultsSetId(v string) *UpdateFeaturedResultsSetInput

SetFeaturedResultsSetId sets the FeaturedResultsSetId field's value.

func (*UpdateFeaturedResultsSetInput) SetFeaturedResultsSetName added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) SetFeaturedResultsSetName(v string) *UpdateFeaturedResultsSetInput

SetFeaturedResultsSetName sets the FeaturedResultsSetName field's value.

func (*UpdateFeaturedResultsSetInput) SetIndexId added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) SetIndexId(v string) *UpdateFeaturedResultsSetInput

SetIndexId sets the IndexId field's value.

func (*UpdateFeaturedResultsSetInput) SetQueryTexts added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) SetQueryTexts(v []*string) *UpdateFeaturedResultsSetInput

SetQueryTexts sets the QueryTexts field's value.

func (*UpdateFeaturedResultsSetInput) SetStatus added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) SetStatus(v string) *UpdateFeaturedResultsSetInput

SetStatus sets the Status field's value.

func (UpdateFeaturedResultsSetInput) String added in v1.44.233 

func (s UpdateFeaturedResultsSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFeaturedResultsSetInput) Validate added in v1.44.233 

func (s *UpdateFeaturedResultsSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFeaturedResultsSetOutput added in v1.44.233 

type UpdateFeaturedResultsSetOutput struct {

	// Information on the set of featured results. This includes the identifier
	// of the featured results set, whether the featured results set is active or
	// inactive, when the featured results set was last updated, and more.
	FeaturedResultsSet *FeaturedResultsSet `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateFeaturedResultsSetOutput) GoString added in v1.44.233 

func (s UpdateFeaturedResultsSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFeaturedResultsSetOutput) SetFeaturedResultsSet added in v1.44.233 

func (s *UpdateFeaturedResultsSetOutput) SetFeaturedResultsSet(v *FeaturedResultsSet) *UpdateFeaturedResultsSetOutput

SetFeaturedResultsSet sets the FeaturedResultsSet field's value.

func (UpdateFeaturedResultsSetOutput) String added in v1.44.233 

func (s UpdateFeaturedResultsSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateIndexInput 

type UpdateIndexInput struct {

	// Sets the number of additional document storage and query capacity units that
	// should be used by the index. You can change the capacity of the index up
	// to 5 times per day, or make 5 API calls.
	//
	// If you are using extra storage units, you can't reduce the storage capacity
	// below what is required to meet the storage needs for your index.
	CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

	// A new description for the index.
	Description *string `type:"string"`

	// The document metadata configuration you want to update for the index. Document
	// metadata are fields or attributes associated with your documents. For example,
	// the company department name associated with each document.
	DocumentMetadataConfigurationUpdates []*DocumentMetadataConfiguration `type:"list"`

	// The identifier of the index you want to update.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`

	// A new name for the index.
	Name *string `min:"1" type:"string"`

	// An Identity and Access Management (IAM) role that gives Amazon Kendra permission
	// to access Amazon CloudWatch logs and metrics.
	RoleArn *string `type:"string"`

	// The user context policy.
	UserContextPolicy *string `type:"string" enum:"UserContextPolicy"`

	// Gets users and groups from IAM Identity Center identity source. To configure
	// this, see UserGroupResolutionConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html).
	// This is useful for user context filtering, where search results are filtered
	// based on the user or their group access to documents.
	UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"`

	// The user token configuration.
	UserTokenConfigurations []*UserTokenConfiguration `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateIndexInput) GoString 

func (s UpdateIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateIndexInput) SetCapacityUnits added in v1.30.25 

func (s *UpdateIndexInput) SetCapacityUnits(v *CapacityUnitsConfiguration) *UpdateIndexInput

SetCapacityUnits sets the CapacityUnits field's value.

func (*UpdateIndexInput) SetDescription 

func (s *UpdateIndexInput) SetDescription(v string) *UpdateIndexInput

SetDescription sets the Description field's value.

func (*UpdateIndexInput) SetDocumentMetadataConfigurationUpdates 

func (s *UpdateIndexInput) SetDocumentMetadataConfigurationUpdates(v []*DocumentMetadataConfiguration) *UpdateIndexInput

SetDocumentMetadataConfigurationUpdates sets the DocumentMetadataConfigurationUpdates field's value.

func (*UpdateIndexInput) SetId 

func (s *UpdateIndexInput) SetId(v string) *UpdateIndexInput

SetId sets the Id field's value.

func (*UpdateIndexInput) SetName 

func (s *UpdateIndexInput) SetName(v string) *UpdateIndexInput

SetName sets the Name field's value.

func (*UpdateIndexInput) SetRoleArn 

func (s *UpdateIndexInput) SetRoleArn(v string) *UpdateIndexInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateIndexInput) SetUserContextPolicy added in v1.35.22 

func (s *UpdateIndexInput) SetUserContextPolicy(v string) *UpdateIndexInput

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*UpdateIndexInput) SetUserGroupResolutionConfiguration added in v1.40.57 

func (s *UpdateIndexInput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *UpdateIndexInput

SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value.

func (*UpdateIndexInput) SetUserTokenConfigurations added in v1.35.22 

func (s *UpdateIndexInput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *UpdateIndexInput

SetUserTokenConfigurations sets the UserTokenConfigurations field's value.

func (UpdateIndexInput) String 

func (s UpdateIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateIndexInput) Validate 

func (s *UpdateIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateIndexOutput 

type UpdateIndexOutput struct {
	// contains filtered or unexported fields
}

func (UpdateIndexOutput) GoString 

func (s UpdateIndexOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateIndexOutput) String 

func (s UpdateIndexOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateQuerySuggestionsBlockListInput added in v1.38.50 

type UpdateQuerySuggestionsBlockListInput struct {

	// A new description for the block list.
	Description *string `type:"string"`

	// The identifier of the block list you want to update.
	//
	// Id is a required field
	Id *string `min:"36" type:"string" required:"true"`

	// The identifier of the index for the block list.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A new name for the block list.
	Name *string `min:"1" type:"string"`

	// The IAM (Identity and Access Management) role used to access the block list
	// text file in S3.
	RoleArn *string `type:"string"`

	// The S3 path where your block list text file sits in S3.
	//
	// If you update your block list and provide the same path to the block list
	// text file in S3, then Amazon Kendra reloads the file to refresh the block
	// list. Amazon Kendra does not automatically refresh your block list. You need
	// to call the UpdateQuerySuggestionsBlockList API to refresh you block list.
	//
	// If you update your block list, then Amazon Kendra asynchronously refreshes
	// all query suggestions with the latest content in the S3 file. This means
	// changes might not take effect immediately.
	SourceS3Path *S3Path `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateQuerySuggestionsBlockListInput) GoString added in v1.38.50 

func (s UpdateQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateQuerySuggestionsBlockListInput) SetDescription added in v1.38.50 

func (s *UpdateQuerySuggestionsBlockListInput) SetDescription(v string) *UpdateQuerySuggestionsBlockListInput

SetDescription sets the Description field's value.

func (*UpdateQuerySuggestionsBlockListInput) SetId added in v1.38.50 

func (s *UpdateQuerySuggestionsBlockListInput) SetId(v string) *UpdateQuerySuggestionsBlockListInput

SetId sets the Id field's value.

func (*UpdateQuerySuggestionsBlockListInput) SetIndexId added in v1.38.50 

func (s *UpdateQuerySuggestionsBlockListInput) SetIndexId(v string) *UpdateQuerySuggestionsBlockListInput

SetIndexId sets the IndexId field's value.

func (*UpdateQuerySuggestionsBlockListInput) SetName added in v1.38.50 

func (s *UpdateQuerySuggestionsBlockListInput) SetName(v string) *UpdateQuerySuggestionsBlockListInput

SetName sets the Name field's value.

func (*UpdateQuerySuggestionsBlockListInput) SetRoleArn added in v1.38.50 

func (s *UpdateQuerySuggestionsBlockListInput) SetRoleArn(v string) *UpdateQuerySuggestionsBlockListInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateQuerySuggestionsBlockListInput) SetSourceS3Path added in v1.38.50 

func (s *UpdateQuerySuggestionsBlockListInput) SetSourceS3Path(v *S3Path) *UpdateQuerySuggestionsBlockListInput

SetSourceS3Path sets the SourceS3Path field's value.

func (UpdateQuerySuggestionsBlockListInput) String added in v1.38.50 

func (s UpdateQuerySuggestionsBlockListInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateQuerySuggestionsBlockListInput) Validate added in v1.38.50 

func (s *UpdateQuerySuggestionsBlockListInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateQuerySuggestionsBlockListOutput added in v1.38.50 

type UpdateQuerySuggestionsBlockListOutput struct {
	// contains filtered or unexported fields
}

func (UpdateQuerySuggestionsBlockListOutput) GoString added in v1.38.50 

func (s UpdateQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateQuerySuggestionsBlockListOutput) String added in v1.38.50 

func (s UpdateQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateQuerySuggestionsConfigInput added in v1.38.50 

type UpdateQuerySuggestionsConfigInput struct {

	// Configuration information for the document fields/attributes that you want
	// to base query suggestions on.
	AttributeSuggestionsConfig *AttributeSuggestionsUpdateConfig `type:"structure"`

	// TRUE to include queries without user information (i.e. all queries, irrespective
	// of the user), otherwise FALSE to only include queries with user information.
	//
	// If you pass user information to Amazon Kendra along with the queries, you
	// can set this flag to FALSE and instruct Amazon Kendra to only consider queries
	// with user information.
	//
	// If you set to FALSE, Amazon Kendra only considers queries searched at least
	// MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users
	// for suggestions.
	//
	// If you set to TRUE, Amazon Kendra ignores all user information and learns
	// from all queries.
	IncludeQueriesWithoutUserInformation *bool `type:"boolean"`

	// The identifier of the index with query suggestions you want to update.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// The minimum number of unique users who must search a query in order for the
	// query to be eligible to suggest to your users.
	//
	// Increasing this number might decrease the number of suggestions. However,
	// this ensures a query is searched by many users and is truly popular to suggest
	// to users.
	//
	// How you tune this setting depends on your specific needs.
	MinimumNumberOfQueryingUsers *int64 `min:"1" type:"integer"`

	// The the minimum number of times a query must be searched in order to be eligible
	// to suggest to your users.
	//
	// Decreasing this number increases the number of suggestions. However, this
	// affects the quality of suggestions as it sets a low bar for a query to be
	// considered popular to suggest to users.
	//
	// How you tune this setting depends on your specific needs.
	MinimumQueryCount *int64 `min:"1" type:"integer"`

	// Set the mode to ENABLED or LEARN_ONLY.
	//
	// By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows
	// you to turn off query suggestions. You can to update this at any time.
	//
	// In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to
	// keep suggestions up to date for when you are ready to switch to ENABLED mode
	// again.
	Mode *string `type:"string" enum:"Mode"`

	// How recent your queries are in your query log time window.
	//
	// The time window is the number of days from current day to past days.
	//
	// By default, Amazon Kendra sets this to 180.
	QueryLogLookBackWindowInDays *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateQuerySuggestionsConfigInput) GoString added in v1.38.50 

func (s UpdateQuerySuggestionsConfigInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateQuerySuggestionsConfigInput) SetAttributeSuggestionsConfig added in v1.44.255 

func (s *UpdateQuerySuggestionsConfigInput) SetAttributeSuggestionsConfig(v *AttributeSuggestionsUpdateConfig) *UpdateQuerySuggestionsConfigInput

SetAttributeSuggestionsConfig sets the AttributeSuggestionsConfig field's value.

func (*UpdateQuerySuggestionsConfigInput) SetIncludeQueriesWithoutUserInformation added in v1.38.50 

func (s *UpdateQuerySuggestionsConfigInput) SetIncludeQueriesWithoutUserInformation(v bool) *UpdateQuerySuggestionsConfigInput

SetIncludeQueriesWithoutUserInformation sets the IncludeQueriesWithoutUserInformation field's value.

func (*UpdateQuerySuggestionsConfigInput) SetIndexId added in v1.38.50 

func (s *UpdateQuerySuggestionsConfigInput) SetIndexId(v string) *UpdateQuerySuggestionsConfigInput

SetIndexId sets the IndexId field's value.

func (*UpdateQuerySuggestionsConfigInput) SetMinimumNumberOfQueryingUsers added in v1.38.50 

func (s *UpdateQuerySuggestionsConfigInput) SetMinimumNumberOfQueryingUsers(v int64) *UpdateQuerySuggestionsConfigInput

SetMinimumNumberOfQueryingUsers sets the MinimumNumberOfQueryingUsers field's value.

func (*UpdateQuerySuggestionsConfigInput) SetMinimumQueryCount added in v1.38.50 

func (s *UpdateQuerySuggestionsConfigInput) SetMinimumQueryCount(v int64) *UpdateQuerySuggestionsConfigInput

SetMinimumQueryCount sets the MinimumQueryCount field's value.

func (*UpdateQuerySuggestionsConfigInput) SetMode added in v1.38.50 

func (s *UpdateQuerySuggestionsConfigInput) SetMode(v string) *UpdateQuerySuggestionsConfigInput

SetMode sets the Mode field's value.

func (*UpdateQuerySuggestionsConfigInput) SetQueryLogLookBackWindowInDays added in v1.38.50 

func (s *UpdateQuerySuggestionsConfigInput) SetQueryLogLookBackWindowInDays(v int64) *UpdateQuerySuggestionsConfigInput

SetQueryLogLookBackWindowInDays sets the QueryLogLookBackWindowInDays field's value.

func (UpdateQuerySuggestionsConfigInput) String added in v1.38.50 

func (s UpdateQuerySuggestionsConfigInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateQuerySuggestionsConfigInput) Validate added in v1.38.50 

func (s *UpdateQuerySuggestionsConfigInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateQuerySuggestionsConfigOutput added in v1.38.50 

type UpdateQuerySuggestionsConfigOutput struct {
	// contains filtered or unexported fields
}

func (UpdateQuerySuggestionsConfigOutput) GoString added in v1.38.50 

func (s UpdateQuerySuggestionsConfigOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateQuerySuggestionsConfigOutput) String added in v1.38.50 

func (s UpdateQuerySuggestionsConfigOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateThesaurusInput added in v1.36.6 

type UpdateThesaurusInput struct {

	// A new description for the thesaurus.
	Description *string `type:"string"`

	// The identifier of the thesaurus you want to update.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// The identifier of the index for the thesaurus.
	//
	// IndexId is a required field
	IndexId *string `min:"36" type:"string" required:"true"`

	// A new name for the thesaurus.
	Name *string `min:"1" type:"string"`

	// An IAM role that gives Amazon Kendra permissions to access thesaurus file
	// specified in SourceS3Path.
	RoleArn *string `type:"string"`

	// Information required to find a specific file in an Amazon S3 bucket.
	SourceS3Path *S3Path `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateThesaurusInput) GoString added in v1.36.6 

func (s UpdateThesaurusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThesaurusInput) SetDescription added in v1.36.6 

func (s *UpdateThesaurusInput) SetDescription(v string) *UpdateThesaurusInput

SetDescription sets the Description field's value.

func (*UpdateThesaurusInput) SetId added in v1.36.6 

func (s *UpdateThesaurusInput) SetId(v string) *UpdateThesaurusInput

SetId sets the Id field's value.

func (*UpdateThesaurusInput) SetIndexId added in v1.36.6 

func (s *UpdateThesaurusInput) SetIndexId(v string) *UpdateThesaurusInput

SetIndexId sets the IndexId field's value.

func (*UpdateThesaurusInput) SetName added in v1.36.6 

func (s *UpdateThesaurusInput) SetName(v string) *UpdateThesaurusInput

SetName sets the Name field's value.

func (*UpdateThesaurusInput) SetRoleArn added in v1.36.6 

func (s *UpdateThesaurusInput) SetRoleArn(v string) *UpdateThesaurusInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateThesaurusInput) SetSourceS3Path added in v1.36.6 

func (s *UpdateThesaurusInput) SetSourceS3Path(v *S3Path) *UpdateThesaurusInput

SetSourceS3Path sets the SourceS3Path field's value.

func (UpdateThesaurusInput) String added in v1.36.6 

func (s UpdateThesaurusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateThesaurusInput) Validate added in v1.36.6 

func (s *UpdateThesaurusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateThesaurusOutput added in v1.36.6 

type UpdateThesaurusOutput struct {
	// contains filtered or unexported fields
}

func (UpdateThesaurusOutput) GoString added in v1.36.6 

func (s UpdateThesaurusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateThesaurusOutput) String added in v1.36.6 

func (s UpdateThesaurusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Urls added in v1.38.64 

type Urls struct {

	// Configuration of the seed or starting point URLs of the websites you want
	// to crawl.
	//
	// You can choose to crawl only the website host names, or the website host
	// names with subdomains, or the website host names with subdomains and other
	// domains that the web pages link to.
	//
	// You can list up to 100 seed URLs.
	SeedUrlConfiguration *SeedUrlConfiguration `type:"structure"`

	// Configuration of the sitemap URLs of the websites you want to crawl.
	//
	// Only URLs belonging to the same website host names are crawled. You can list
	// up to three sitemap URLs.
	SiteMapsConfiguration *SiteMapsConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information of the URLs to crawl.

You can only crawl websites that use the secure communication protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive an error when crawling a website, it could be that the website is blocked from crawling.

When selecting websites to index, you must adhere to the Amazon Acceptable Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember that you must only use Amazon Kendra Web Crawler to index your own web pages, or web pages that you have authorization to index.

func (Urls) GoString added in v1.38.64 

func (s Urls) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Urls) SetSeedUrlConfiguration added in v1.38.64 

func (s *Urls) SetSeedUrlConfiguration(v *SeedUrlConfiguration) *Urls

SetSeedUrlConfiguration sets the SeedUrlConfiguration field's value.

func (*Urls) SetSiteMapsConfiguration added in v1.38.64 

func (s *Urls) SetSiteMapsConfiguration(v *SiteMapsConfiguration) *Urls

SetSiteMapsConfiguration sets the SiteMapsConfiguration field's value.

func (Urls) String added in v1.38.64 

func (s Urls) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Urls) Validate added in v1.38.64 

func (s *Urls) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UserContext added in v1.35.22 

type UserContext struct {

	// The list of data source groups you want to filter search results based on
	// groups' access to documents in that data source.
	DataSourceGroups []*DataSourceGroup `min:"1" type:"list"`

	// The list of groups you want to filter search results based on the groups'
	// access to documents.
	Groups []*string `min:"1" type:"list"`

	// The user context token for filtering search results for a user. It must be
	// a JWT or a JSON token.
	Token *string `min:"1" type:"string"`

	// The identifier of the user you want to filter search results based on their
	// access to documents.
	UserId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides information about the user context for an Amazon Kendra index.

User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.

You provide one of the following:

  • User token

  • User ID, the groups the user belongs to, and any data sources the groups can access.

If you provide both, an exception is thrown.

func (UserContext) GoString added in v1.35.22 

func (s UserContext) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserContext) SetDataSourceGroups added in v1.39.5 

func (s *UserContext) SetDataSourceGroups(v []*DataSourceGroup) *UserContext

SetDataSourceGroups sets the DataSourceGroups field's value.

func (*UserContext) SetGroups added in v1.39.5 

func (s *UserContext) SetGroups(v []*string) *UserContext

SetGroups sets the Groups field's value.

func (*UserContext) SetToken added in v1.35.22 

func (s *UserContext) SetToken(v string) *UserContext

SetToken sets the Token field's value.

func (*UserContext) SetUserId added in v1.39.5 

func (s *UserContext) SetUserId(v string) *UserContext

SetUserId sets the UserId field's value.

func (UserContext) String added in v1.35.22 

func (s UserContext) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserContext) Validate added in v1.35.22 

func (s *UserContext) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UserGroupResolutionConfiguration added in v1.40.57 

type UserGroupResolutionConfiguration struct {

	// The identity store provider (mode) you want to use to get users and groups.
	// IAM Identity Center is currently the only available mode. Your users and
	// groups must exist in an IAM Identity Center identity source in order to use
	// this mode.
	//
	// UserGroupResolutionMode is a required field
	UserGroupResolutionMode *string `type:"string" required:"true" enum:"UserGroupResolutionMode"`
	// contains filtered or unexported fields
}

Provides the configuration information to get users and groups from an IAM Identity Center identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the PutPrincipalMapping (https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API to map users to their groups so that you only need to provide the user ID when you issue the query.

To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see Getting started with an IAM Identity Center identity source (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html). You must also grant the required permissions to use IAM Identity Center with Amazon Kendra. For more information, see IAM roles for IAM Identity Center (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso).

Amazon Kendra currently does not support using UserGroupResolutionConfiguration with an Amazon Web Services organization member account for your IAM Identity Center identify source. You must create your index in the management account for the organization in order to use UserGroupResolutionConfiguration.

func (UserGroupResolutionConfiguration) GoString added in v1.40.57 

func (s UserGroupResolutionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserGroupResolutionConfiguration) SetUserGroupResolutionMode added in v1.40.57 

func (s *UserGroupResolutionConfiguration) SetUserGroupResolutionMode(v string) *UserGroupResolutionConfiguration

SetUserGroupResolutionMode sets the UserGroupResolutionMode field's value.

func (UserGroupResolutionConfiguration) String added in v1.40.57 

func (s UserGroupResolutionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserGroupResolutionConfiguration) Validate added in v1.40.57 

func (s *UserGroupResolutionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UserIdentityConfiguration added in v1.42.17 

type UserIdentityConfiguration struct {

	// The IAM Identity Center field name that contains the identifiers of your
	// users, such as their emails. This is used for user context filtering (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)
	// and for granting access to your Amazon Kendra experience. You must set up
	// IAM Identity Center with Amazon Kendra. You must include your users and groups
	// in your Access Control List when you ingest documents into your index. For
	// more information, see Getting started with an IAM Identity Center identity
	// source (https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html).
	IdentityAttributeName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Provides the configuration information for the identifiers of your users.

func (UserIdentityConfiguration) GoString added in v1.42.17 

func (s UserIdentityConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserIdentityConfiguration) SetIdentityAttributeName added in v1.42.17 

func (s *UserIdentityConfiguration) SetIdentityAttributeName(v string) *UserIdentityConfiguration

SetIdentityAttributeName sets the IdentityAttributeName field's value.

func (UserIdentityConfiguration) String added in v1.42.17 

func (s UserIdentityConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserIdentityConfiguration) Validate added in v1.42.17 

func (s *UserIdentityConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UserTokenConfiguration added in v1.35.22 

type UserTokenConfiguration struct {

	// Information about the JSON token type configuration.
	JsonTokenTypeConfiguration *JsonTokenTypeConfiguration `type:"structure"`

	// Information about the JWT token type configuration.
	JwtTokenTypeConfiguration *JwtTokenTypeConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Provides the configuration information for a token.

func (UserTokenConfiguration) GoString added in v1.35.22 

func (s UserTokenConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserTokenConfiguration) SetJsonTokenTypeConfiguration added in v1.35.22 

func (s *UserTokenConfiguration) SetJsonTokenTypeConfiguration(v *JsonTokenTypeConfiguration) *UserTokenConfiguration

SetJsonTokenTypeConfiguration sets the JsonTokenTypeConfiguration field's value.

func (*UserTokenConfiguration) SetJwtTokenTypeConfiguration added in v1.35.22 

func (s *UserTokenConfiguration) SetJwtTokenTypeConfiguration(v *JwtTokenTypeConfiguration) *UserTokenConfiguration

SetJwtTokenTypeConfiguration sets the JwtTokenTypeConfiguration field's value.

func (UserTokenConfiguration) String added in v1.35.22 

func (s UserTokenConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserTokenConfiguration) Validate added in v1.35.22 

func (s *UserTokenConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ValidationException added in v1.28.0 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

func (*ValidationException) Code added in v1.28.0 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.28.0 

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.28.0 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.28.0 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.28.0 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.28.0 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.28.0 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.28.0 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Warning added in v1.42.32 

type Warning struct {

	// The code used to show the type of warning for the query.
	Code *string `type:"string" enum:"WarningCode"`

	// The message that explains the problem with the query.
	Message *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The warning code and message that explains a problem with a query.

func (Warning) GoString added in v1.42.32 

func (s Warning) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Warning) SetCode added in v1.42.32 

func (s *Warning) SetCode(v string) *Warning

SetCode sets the Code field's value.

func (*Warning) SetMessage added in v1.42.32 

func (s *Warning) SetMessage(v string) *Warning

SetMessage sets the Message field's value.

func (Warning) String added in v1.42.32 

func (s Warning) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WebCrawlerConfiguration added in v1.38.64 

type WebCrawlerConfiguration struct {

	// Configuration information required to connect to websites using authentication.
	//
	// You can connect to websites using basic authentication of user name and password.
	// You use a secret in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
	// to store your authentication credentials.
	//
	// You must provide the website host name and port number. For example, the
	// host name of https://a.example.com/page1.html is "a.example.com" and the
	// port is 443, the standard port for HTTPS.
	AuthenticationConfiguration *AuthenticationConfiguration `type:"structure"`

	// The 'depth' or number of levels from the seed level to crawl. For example,
	// the seed URL page is depth 1 and any hyperlinks on this page that are also
	// crawled are depth 2.
	CrawlDepth *int64 `type:"integer"`

	// The maximum size (in MB) of a web page or attachment to crawl.
	//
	// Files larger than this size (in MB) are skipped/not crawled.
	//
	// The default maximum size of a web page or attachment is set to 50 MB.
	MaxContentSizePerPageInMegaBytes *float64 `min:"1e-06" type:"float"`

	// The maximum number of URLs on a web page to include when crawling a website.
	// This number is per web page.
	//
	// As a website’s web pages are crawled, any URLs the web pages link to are
	// also crawled. URLs on a web page are crawled in order of appearance.
	//
	// The default maximum links per page is 100.
	MaxLinksPerPage *int64 `min:"1" type:"integer"`

	// The maximum number of URLs crawled per website host per minute.
	//
	// A minimum of one URL is required.
	//
	// The default maximum number of URLs crawled per website host per minute is
	// 300.
	MaxUrlsPerMinuteCrawlRate *int64 `min:"1" type:"integer"`

	// Configuration information required to connect to your internal websites via
	// a web proxy.
	//
	// You must provide the website host name and port number. For example, the
	// host name of https://a.example.com/page1.html is "a.example.com" and the
	// port is 443, the standard port for HTTPS.
	//
	// Web proxy credentials are optional and you can use them to connect to a web
	// proxy server that requires basic authentication. To store web proxy credentials,
	// you use a secret in Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html).
	ProxyConfiguration *ProxyConfiguration `type:"structure"`

	// A list of regular expression patterns to exclude certain URLs to crawl. URLs
	// that match the patterns are excluded from the index. URLs that don't match
	// the patterns are included in the index. If a URL matches both an inclusion
	// and exclusion pattern, the exclusion pattern takes precedence and the URL
	// file isn't included in the index.
	UrlExclusionPatterns []*string `type:"list"`

	// A list of regular expression patterns to include certain URLs to crawl. URLs
	// that match the patterns are included in the index. URLs that don't match
	// the patterns are excluded from the index. If a URL matches both an inclusion
	// and exclusion pattern, the exclusion pattern takes precedence and the URL
	// file isn't included in the index.
	UrlInclusionPatterns []*string `type:"list"`

	// Specifies the seed or starting point URLs of the websites or the sitemap
	// URLs of the websites you want to crawl.
	//
	// You can include website subdomains. You can list up to 100 seed URLs and
	// up to three sitemap URLs.
	//
	// You can only crawl websites that use the secure communication protocol, Hypertext
	// Transfer Protocol Secure (HTTPS). If you receive an error when crawling a
	// website, it could be that the website is blocked from crawling.
	//
	// When selecting websites to index, you must adhere to the Amazon Acceptable
	// Use Policy (https://aws.amazon.com/aup/) and all other Amazon terms. Remember
	// that you must only use Amazon Kendra Web Crawler to index your own web pages,
	// or web pages that you have authorization to index.
	//
	// Urls is a required field
	Urls *Urls `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the configuration information required for Amazon Kendra Web Crawler.

func (WebCrawlerConfiguration) GoString added in v1.38.64 

func (s WebCrawlerConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WebCrawlerConfiguration) SetAuthenticationConfiguration added in v1.38.64 

func (s *WebCrawlerConfiguration) SetAuthenticationConfiguration(v *AuthenticationConfiguration) *WebCrawlerConfiguration

SetAuthenticationConfiguration sets the AuthenticationConfiguration field's value.

func (*WebCrawlerConfiguration) SetCrawlDepth added in v1.38.64 

func (s *WebCrawlerConfiguration) SetCrawlDepth(v int64) *WebCrawlerConfiguration

SetCrawlDepth sets the CrawlDepth field's value.

func (*WebCrawlerConfiguration) SetMaxContentSizePerPageInMegaBytes added in v1.38.64 

func (s *WebCrawlerConfiguration) SetMaxContentSizePerPageInMegaBytes(v float64) *WebCrawlerConfiguration

SetMaxContentSizePerPageInMegaBytes sets the MaxContentSizePerPageInMegaBytes field's value.

func (*WebCrawlerConfiguration) SetMaxLinksPerPage added in v1.38.64 

func (s *WebCrawlerConfiguration) SetMaxLinksPerPage(v int64) *WebCrawlerConfiguration

SetMaxLinksPerPage sets the MaxLinksPerPage field's value.

func (*WebCrawlerConfiguration) SetMaxUrlsPerMinuteCrawlRate added in v1.38.64 

func (s *WebCrawlerConfiguration) SetMaxUrlsPerMinuteCrawlRate(v int64) *WebCrawlerConfiguration

SetMaxUrlsPerMinuteCrawlRate sets the MaxUrlsPerMinuteCrawlRate field's value.

func (*WebCrawlerConfiguration) SetProxyConfiguration added in v1.38.64 

func (s *WebCrawlerConfiguration) SetProxyConfiguration(v *ProxyConfiguration) *WebCrawlerConfiguration

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*WebCrawlerConfiguration) SetUrlExclusionPatterns added in v1.38.64 

func (s *WebCrawlerConfiguration) SetUrlExclusionPatterns(v []*string) *WebCrawlerConfiguration

SetUrlExclusionPatterns sets the UrlExclusionPatterns field's value.

func (*WebCrawlerConfiguration) SetUrlInclusionPatterns added in v1.38.64 

func (s *WebCrawlerConfiguration) SetUrlInclusionPatterns(v []*string) *WebCrawlerConfiguration

SetUrlInclusionPatterns sets the UrlInclusionPatterns field's value.

func (*WebCrawlerConfiguration) SetUrls added in v1.38.64 

func (s *WebCrawlerConfiguration) SetUrls(v *Urls) *WebCrawlerConfiguration

SetUrls sets the Urls field's value.

func (WebCrawlerConfiguration) String added in v1.38.64 

func (s WebCrawlerConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WebCrawlerConfiguration) Validate added in v1.38.64 

func (s *WebCrawlerConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type WorkDocsConfiguration added in v1.40.5 

type WorkDocsConfiguration struct {

	// TRUE to include comments on documents in your index. Including comments in
	// your index means each comment is a document that can be searched on.
	//
	// The default is set to FALSE.
	CrawlComments *bool `type:"boolean"`

	// A list of regular expression patterns to exclude certain files in your Amazon
	// WorkDocs site repository. Files that match the patterns are excluded from
	// the index. Files that don’t match the patterns are included in the index.
	// If a file matches both an inclusion and exclusion pattern, the exclusion
	// pattern takes precedence and the file isn't included in the index.
	ExclusionPatterns []*string `type:"list"`

	// A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs
	// data source attributes or field names to Amazon Kendra index field names.
	// To create custom fields, use the UpdateIndex API before you map to Amazon
	// WorkDocs fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
	// The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs
	// custom metadata.
	FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

	// A list of regular expression patterns to include certain files in your Amazon
	// WorkDocs site repository. Files that match the patterns are included in the
	// index. Files that don't match the patterns are excluded from the index. If
	// a file matches both an inclusion and exclusion pattern, the exclusion pattern
	// takes precedence and the file isn't included in the index.
	InclusionPatterns []*string `type:"list"`

	// The identifier of the directory corresponding to your Amazon WorkDocs site
	// repository.
	//
	// You can find the organization ID in the Directory Service (https://console.aws.amazon.com/directoryservicev2/)
	// by going to Active Directory, then Directories. Your Amazon WorkDocs site
	// directory has an ID, which is the organization ID. You can also set up a
	// new Amazon WorkDocs directory in the Directory Service console and enable
	// a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
	//
	// OrganizationId is a required field
	OrganizationId *string `min:"12" type:"string" required:"true"`

	// TRUE to use the Amazon WorkDocs change log to determine which documents require
	// updating in the index. Depending on the change log's size, it may take longer
	// for Amazon Kendra to use the change log than to scan all of your documents
	// in Amazon WorkDocs.
	UseChangeLog *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Provides the configuration information to connect to Amazon WorkDocs as your data source.

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

func (WorkDocsConfiguration) GoString added in v1.40.5 

func (s WorkDocsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkDocsConfiguration) SetCrawlComments added in v1.40.5 

func (s *WorkDocsConfiguration) SetCrawlComments(v bool) *WorkDocsConfiguration

SetCrawlComments sets the CrawlComments field's value.

func (*WorkDocsConfiguration) SetExclusionPatterns added in v1.40.5 

func (s *WorkDocsConfiguration) SetExclusionPatterns(v []*string) *WorkDocsConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*WorkDocsConfiguration) SetFieldMappings added in v1.40.5 

func (s *WorkDocsConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *WorkDocsConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*WorkDocsConfiguration) SetInclusionPatterns added in v1.40.5 

func (s *WorkDocsConfiguration) SetInclusionPatterns(v []*string) *WorkDocsConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*WorkDocsConfiguration) SetOrganizationId added in v1.40.5 

func (s *WorkDocsConfiguration) SetOrganizationId(v string) *WorkDocsConfiguration

SetOrganizationId sets the OrganizationId field's value.

func (*WorkDocsConfiguration) SetUseChangeLog added in v1.40.5 

func (s *WorkDocsConfiguration) SetUseChangeLog(v bool) *WorkDocsConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (WorkDocsConfiguration) String added in v1.40.5 

func (s WorkDocsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkDocsConfiguration) Validate added in v1.40.5 

func (s *WorkDocsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package kendraiface provides an interface to enable mocking the AWSKendraFrontendService service client for testing your code.
 Package kendraiface provides an interface to enable mocking the AWSKendraFrontendService service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.