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"
)

const (
    // AttributeSuggestionsModeActive is a AttributeSuggestionsMode enum value
    AttributeSuggestionsModeActive = "ACTIVE"

    // AttributeSuggestionsModeInactive is a AttributeSuggestionsMode enum value
    AttributeSuggestionsModeInactive = "INACTIVE"
)

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"
)

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"
)

const (
    // ConfluenceAuthenticationTypeHttpBasic is a ConfluenceAuthenticationType enum value
    ConfluenceAuthenticationTypeHttpBasic = "HTTP_BASIC"

    // ConfluenceAuthenticationTypePat is a ConfluenceAuthenticationType enum value
    ConfluenceAuthenticationTypePat = "PAT"
)

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"
)

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"
)

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"
)

const (
    // ConfluenceVersionCloud is a ConfluenceVersion enum value
    ConfluenceVersionCloud = "CLOUD"

    // ConfluenceVersionServer is a ConfluenceVersion enum value
    ConfluenceVersionServer = "SERVER"
)

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"
)

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"
)

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"
)

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"
)

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"
)

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"
)

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"
)

const (
    // EntityTypeUser is a EntityType enum value
    EntityTypeUser = "USER"

    // EntityTypeGroup is a EntityType enum value
    EntityTypeGroup = "GROUP"
)

const (
    // ErrorCodeInternalError is a ErrorCode enum value
    ErrorCodeInternalError = "InternalError"

    // ErrorCodeInvalidRequest is a ErrorCode enum value
    ErrorCodeInvalidRequest = "InvalidRequest"
)

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"
)

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"
)

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"
)

const (
    // FeaturedResultsSetStatusActive is a FeaturedResultsSetStatus enum value
    FeaturedResultsSetStatusActive = "ACTIVE"

    // FeaturedResultsSetStatusInactive is a FeaturedResultsSetStatus enum value
    FeaturedResultsSetStatusInactive = "INACTIVE"
)

const (
    // HighlightTypeStandard is a HighlightType enum value
    HighlightTypeStandard = "STANDARD"

    // HighlightTypeThesaurusSynonym is a HighlightType enum value
    HighlightTypeThesaurusSynonym = "THESAURUS_SYNONYM"
)

const (
    // IndexEditionDeveloperEdition is a IndexEdition enum value
    IndexEditionDeveloperEdition = "DEVELOPER_EDITION"

    // IndexEditionEnterpriseEdition is a IndexEdition enum value
    IndexEditionEnterpriseEdition = "ENTERPRISE_EDITION"
)

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"
)

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"
)

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"
)

const (
    // KeyLocationUrl is a KeyLocation enum value
    KeyLocationUrl = "URL"

    // KeyLocationSecretManager is a KeyLocation enum value
    KeyLocationSecretManager = "SECRET_MANAGER"
)

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"
)

const (
    // ModeEnabled is a Mode enum value
    ModeEnabled = "ENABLED"

    // ModeLearnOnly is a Mode enum value
    ModeLearnOnly = "LEARN_ONLY"
)

const (
    // OrderAscending is a Order enum value
    OrderAscending = "ASCENDING"

    // OrderDescending is a Order enum value
    OrderDescending = "DESCENDING"
)

const (
    // PersonaOwner is a Persona enum value
    PersonaOwner = "OWNER"

    // PersonaViewer is a Persona enum value
    PersonaViewer = "VIEWER"
)

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"
)

const (
    // PrincipalTypeUser is a PrincipalType enum value
    PrincipalTypeUser = "USER"

    // PrincipalTypeGroup is a PrincipalType enum value
    PrincipalTypeGroup = "GROUP"
)

const (
    // QueryIdentifiersEnclosingOptionDoubleQuotes is a QueryIdentifiersEnclosingOption enum value
    QueryIdentifiersEnclosingOptionDoubleQuotes = "DOUBLE_QUOTES"

    // QueryIdentifiersEnclosingOptionNone is a QueryIdentifiersEnclosingOption enum value
    QueryIdentifiersEnclosingOptionNone = "NONE"
)

const (
    // QueryResultFormatTable is a QueryResultFormat enum value
    QueryResultFormatTable = "TABLE"

    // QueryResultFormatText is a QueryResultFormat enum value
    QueryResultFormatText = "TEXT"
)

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"
)

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"
)

const (
    // QuerySuggestionsStatusActive is a QuerySuggestionsStatus enum value
    QuerySuggestionsStatusActive = "ACTIVE"

    // QuerySuggestionsStatusUpdating is a QuerySuggestionsStatus enum value
    QuerySuggestionsStatusUpdating = "UPDATING"
)

const (
    // ReadAccessTypeAllow is a ReadAccessType enum value
    ReadAccessTypeAllow = "ALLOW"

    // ReadAccessTypeDeny is a ReadAccessType enum value
    ReadAccessTypeDeny = "DENY"
)

const (
    // RelevanceTypeRelevant is a RelevanceType enum value
    RelevanceTypeRelevant = "RELEVANT"

    // RelevanceTypeNotRelevant is a RelevanceType enum value
    RelevanceTypeNotRelevant = "NOT_RELEVANT"
)

const (
    // SalesforceChatterFeedIncludeFilterTypeActiveUser is a SalesforceChatterFeedIncludeFilterType enum value
    SalesforceChatterFeedIncludeFilterTypeActiveUser = "ACTIVE_USER"

    // SalesforceChatterFeedIncludeFilterTypeStandardUser is a SalesforceChatterFeedIncludeFilterType enum value
    SalesforceChatterFeedIncludeFilterTypeStandardUser = "STANDARD_USER"
)

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"
)

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"
)

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"
)

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

    // ServiceNowAuthenticationTypeOauth2 is a ServiceNowAuthenticationType enum value
    ServiceNowAuthenticationTypeOauth2 = "OAUTH2"
)

const (
    // ServiceNowBuildVersionTypeLondon is a ServiceNowBuildVersionType enum value
    ServiceNowBuildVersionTypeLondon = "LONDON"

    // ServiceNowBuildVersionTypeOthers is a ServiceNowBuildVersionType enum value
    ServiceNowBuildVersionTypeOthers = "OTHERS"
)

const (
    // SharePointOnlineAuthenticationTypeHttpBasic is a SharePointOnlineAuthenticationType enum value
    SharePointOnlineAuthenticationTypeHttpBasic = "HTTP_BASIC"

    // SharePointOnlineAuthenticationTypeOauth2 is a SharePointOnlineAuthenticationType enum value
    SharePointOnlineAuthenticationTypeOauth2 = "OAUTH2"
)

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"
)

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"
)

const (
    // SortOrderDesc is a SortOrder enum value
    SortOrderDesc = "DESC"

    // SortOrderAsc is a SortOrder enum value
    SortOrderAsc = "ASC"
)

const (
    // SuggestionTypeQuery is a SuggestionType enum value
    SuggestionTypeQuery = "QUERY"

    // SuggestionTypeDocumentAttributes is a SuggestionType enum value
    SuggestionTypeDocumentAttributes = "DOCUMENT_ATTRIBUTES"
)

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"
)

const (
    // TypeSaas is a Type enum value
    TypeSaas = "SAAS"

    // TypeOnPremise is a Type enum value
    TypeOnPremise = "ON_PREMISE"
)

const (
    // UserContextPolicyAttributeFilter is a UserContextPolicy enum value
    UserContextPolicyAttributeFilter = "ATTRIBUTE_FILTER"

    // UserContextPolicyUserToken is a UserContextPolicy enum value
    UserContextPolicyUserToken = "USER_TOKEN"
)

const (
    // UserGroupResolutionModeAwsSso is a UserGroupResolutionMode enum value
    UserGroupResolutionModeAwsSso = "AWS_SSO"

    // UserGroupResolutionModeNone is a UserGroupResolutionMode enum value
    UserGroupResolutionModeNone = "NONE"
)

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"
)

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"
)

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.
)

const (
    // AdditionalResultAttributeValueTypeTextWithHighlightsValue is a AdditionalResultAttributeValueType enum value
    AdditionalResultAttributeValueTypeTextWithHighlightsValue = "TEXT_WITH_HIGHLIGHTS_VALUE"
)

const (
    // EndpointTypeHome is a EndpointType enum value
    EndpointTypeHome = "HOME"
)

const (
    // FsxFileSystemTypeWindows is a FsxFileSystemType enum value
    FsxFileSystemTypeWindows = "WINDOWS"
)

const (
    // WarningCodeQueryLanguageInvalidSyntax is a WarningCode enum value
    WarningCodeQueryLanguageInvalidSyntax = "QUERY_LANGUAGE_INVALID_SYNTAX"
)

func AdditionalResultAttributeValueType_Values ¶

func AdditionalResultAttributeValueType_Values() []string

AdditionalResultAttributeValueType_Values returns all elements of the AdditionalResultAttributeValueType enum

func AlfrescoEntity_Values ¶

func AlfrescoEntity_Values() []string

AlfrescoEntity_Values returns all elements of the AlfrescoEntity enum

func AttributeSuggestionsMode_Values ¶

func AttributeSuggestionsMode_Values() []string

AttributeSuggestionsMode_Values returns all elements of the AttributeSuggestionsMode enum

func ConditionOperator_Values ¶

func ConditionOperator_Values() []string

ConditionOperator_Values returns all elements of the ConditionOperator enum

func ConfluenceAttachmentFieldName_Values ¶

func ConfluenceAttachmentFieldName_Values() []string

ConfluenceAttachmentFieldName_Values returns all elements of the ConfluenceAttachmentFieldName enum

func ConfluenceAuthenticationType_Values ¶

func ConfluenceAuthenticationType_Values() []string

ConfluenceAuthenticationType_Values returns all elements of the ConfluenceAuthenticationType enum

func ConfluenceBlogFieldName_Values ¶

func ConfluenceBlogFieldName_Values() []string

ConfluenceBlogFieldName_Values returns all elements of the ConfluenceBlogFieldName enum

func ConfluencePageFieldName_Values ¶

func ConfluencePageFieldName_Values() []string

ConfluencePageFieldName_Values returns all elements of the ConfluencePageFieldName enum

func ConfluenceSpaceFieldName_Values ¶

func ConfluenceSpaceFieldName_Values() []string

ConfluenceSpaceFieldName_Values returns all elements of the ConfluenceSpaceFieldName enum

func ConfluenceVersion_Values ¶

func ConfluenceVersion_Values() []string

ConfluenceVersion_Values returns all elements of the ConfluenceVersion enum

func ContentType_Values ¶

func ContentType_Values() []string

ContentType_Values returns all elements of the ContentType enum

func DataSourceStatus_Values ¶

func DataSourceStatus_Values() []string

DataSourceStatus_Values returns all elements of the DataSourceStatus enum

func DataSourceSyncJobStatus_Values ¶

func DataSourceSyncJobStatus_Values() []string

DataSourceSyncJobStatus_Values returns all elements of the DataSourceSyncJobStatus enum

func DataSourceType_Values ¶

func DataSourceType_Values() []string

DataSourceType_Values returns all elements of the DataSourceType enum

func DatabaseEngineType_Values ¶

func DatabaseEngineType_Values() []string

DatabaseEngineType_Values returns all elements of the DatabaseEngineType enum

func DocumentAttributeValueType_Values ¶

func DocumentAttributeValueType_Values() []string

DocumentAttributeValueType_Values returns all elements of the DocumentAttributeValueType enum

func DocumentStatus_Values ¶

func DocumentStatus_Values() []string

DocumentStatus_Values returns all elements of the DocumentStatus enum

func EndpointType_Values ¶

func EndpointType_Values() []string

EndpointType_Values returns all elements of the EndpointType enum

func EntityType_Values ¶

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func ErrorCode_Values ¶

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func ExperienceStatus_Values ¶

func ExperienceStatus_Values() []string

ExperienceStatus_Values returns all elements of the ExperienceStatus enum

func FaqFileFormat_Values ¶

func FaqFileFormat_Values() []string

FaqFileFormat_Values returns all elements of the FaqFileFormat enum

func FaqStatus_Values ¶

func FaqStatus_Values() []string

FaqStatus_Values returns all elements of the FaqStatus enum

func FeaturedResultsSetStatus_Values ¶

func FeaturedResultsSetStatus_Values() []string

FeaturedResultsSetStatus_Values returns all elements of the FeaturedResultsSetStatus enum

func FsxFileSystemType_Values ¶

func FsxFileSystemType_Values() []string

FsxFileSystemType_Values returns all elements of the FsxFileSystemType enum

func HighlightType_Values ¶

func HighlightType_Values() []string

HighlightType_Values returns all elements of the HighlightType enum

func IndexEdition_Values ¶

func IndexEdition_Values() []string

IndexEdition_Values returns all elements of the IndexEdition enum

func IndexStatus_Values ¶

func IndexStatus_Values() []string

IndexStatus_Values returns all elements of the IndexStatus enum

func Interval_Values ¶

func Interval_Values() []string

Interval_Values returns all elements of the Interval enum

func IssueSubEntity_Values ¶

func IssueSubEntity_Values() []string

IssueSubEntity_Values returns all elements of the IssueSubEntity enum

func KeyLocation_Values ¶

func KeyLocation_Values() []string

KeyLocation_Values returns all elements of the KeyLocation enum

func MetricType_Values ¶

func MetricType_Values() []string

MetricType_Values returns all elements of the MetricType enum

func Mode_Values ¶

func Mode_Values() []string

Mode_Values returns all elements of the Mode enum

func Order_Values ¶

func Order_Values() []string

Order_Values returns all elements of the Order enum

func Persona_Values ¶

func Persona_Values() []string

Persona_Values returns all elements of the Persona enum

func PrincipalMappingStatus_Values ¶

func PrincipalMappingStatus_Values() []string

PrincipalMappingStatus_Values returns all elements of the PrincipalMappingStatus enum

func PrincipalType_Values ¶

func PrincipalType_Values() []string

PrincipalType_Values returns all elements of the PrincipalType enum

func QueryIdentifiersEnclosingOption_Values ¶

func QueryIdentifiersEnclosingOption_Values() []string

QueryIdentifiersEnclosingOption_Values returns all elements of the QueryIdentifiersEnclosingOption enum

func QueryResultFormat_Values ¶

func QueryResultFormat_Values() []string

QueryResultFormat_Values returns all elements of the QueryResultFormat enum

func QueryResultType_Values ¶

func QueryResultType_Values() []string

QueryResultType_Values returns all elements of the QueryResultType enum

func QuerySuggestionsBlockListStatus_Values ¶

func QuerySuggestionsBlockListStatus_Values() []string

QuerySuggestionsBlockListStatus_Values returns all elements of the QuerySuggestionsBlockListStatus enum

func QuerySuggestionsStatus_Values ¶

func QuerySuggestionsStatus_Values() []string

QuerySuggestionsStatus_Values returns all elements of the QuerySuggestionsStatus enum

func ReadAccessType_Values ¶

func ReadAccessType_Values() []string

ReadAccessType_Values returns all elements of the ReadAccessType enum

func RelevanceType_Values ¶

func RelevanceType_Values() []string

RelevanceType_Values returns all elements of the RelevanceType enum

func SalesforceChatterFeedIncludeFilterType_Values ¶

func SalesforceChatterFeedIncludeFilterType_Values() []string

SalesforceChatterFeedIncludeFilterType_Values returns all elements of the SalesforceChatterFeedIncludeFilterType enum

func SalesforceKnowledgeArticleState_Values ¶

func SalesforceKnowledgeArticleState_Values() []string

SalesforceKnowledgeArticleState_Values returns all elements of the SalesforceKnowledgeArticleState enum

func SalesforceStandardObjectName_Values ¶

func SalesforceStandardObjectName_Values() []string

SalesforceStandardObjectName_Values returns all elements of the SalesforceStandardObjectName enum

func ScoreConfidence_Values ¶

func ScoreConfidence_Values() []string

ScoreConfidence_Values returns all elements of the ScoreConfidence enum

func ServiceNowAuthenticationType_Values ¶

func ServiceNowAuthenticationType_Values() []string

ServiceNowAuthenticationType_Values returns all elements of the ServiceNowAuthenticationType enum

func ServiceNowBuildVersionType_Values ¶

func ServiceNowBuildVersionType_Values() []string

ServiceNowBuildVersionType_Values returns all elements of the ServiceNowBuildVersionType enum

func SharePointOnlineAuthenticationType_Values ¶

func SharePointOnlineAuthenticationType_Values() []string

SharePointOnlineAuthenticationType_Values returns all elements of the SharePointOnlineAuthenticationType enum

func SharePointVersion_Values ¶

func SharePointVersion_Values() []string

SharePointVersion_Values returns all elements of the SharePointVersion enum

func SlackEntity_Values ¶

func SlackEntity_Values() []string

SlackEntity_Values returns all elements of the SlackEntity enum

func SortOrder_Values ¶

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func SuggestionType_Values ¶

func SuggestionType_Values() []string

SuggestionType_Values returns all elements of the SuggestionType enum

func ThesaurusStatus_Values ¶

func ThesaurusStatus_Values() []string

ThesaurusStatus_Values returns all elements of the ThesaurusStatus enum

func Type_Values ¶

func Type_Values() []string

Type_Values returns all elements of the Type enum

func UserContextPolicy_Values ¶

func UserContextPolicy_Values() []string

UserContextPolicy_Values returns all elements of the UserContextPolicy enum

func UserGroupResolutionMode_Values ¶

func UserGroupResolutionMode_Values() []string

UserGroupResolutionMode_Values returns all elements of the UserGroupResolutionMode enum

func WarningCode_Values ¶

func WarningCode_Values() []string

WarningCode_Values returns all elements of the WarningCode enum

func WebCrawlerMode_Values ¶

func WebCrawlerMode_Values() []string

WebCrawlerMode_Values returns all elements of the WebCrawlerMode enum

type AccessControlConfigurationSummary ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (AccessControlConfigurationSummary) String ¶

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 ¶

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 ¶

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error ¶

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString ¶

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 ¶

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr ¶

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID ¶

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode ¶

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String ¶

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 ¶

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.

Alfresco data source connector is currently in preview mode. Basic authentication is currently supported. If you would like to use Alfresco connector in production, contact Support (http://aws.amazon.com/contact-us/).

func (AlfrescoConfiguration) GoString ¶

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 ¶

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

SetBlogFieldMappings sets the BlogFieldMappings field's value.

func (*AlfrescoConfiguration) SetCrawlComments ¶

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

SetCrawlComments sets the CrawlComments field's value.

func (*AlfrescoConfiguration) SetCrawlSystemFolders ¶

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

SetCrawlSystemFolders sets the CrawlSystemFolders field's value.

func (*AlfrescoConfiguration) SetDocumentLibraryFieldMappings ¶

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

SetDocumentLibraryFieldMappings sets the DocumentLibraryFieldMappings field's value.

func (*AlfrescoConfiguration) SetEntityFilter ¶

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

SetEntityFilter sets the EntityFilter field's value.

func (*AlfrescoConfiguration) SetExclusionPatterns ¶

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*AlfrescoConfiguration) SetInclusionPatterns ¶

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*AlfrescoConfiguration) SetSecretArn ¶

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

SetSecretArn sets the SecretArn field's value.

func (*AlfrescoConfiguration) SetSiteId ¶

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

SetSiteId sets the SiteId field's value.

func (*AlfrescoConfiguration) SetSiteUrl ¶

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

SetSiteUrl sets the SiteUrl field's value.

func (*AlfrescoConfiguration) SetSslCertificateS3Path ¶

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

SetSslCertificateS3Path sets the SslCertificateS3Path field's value.

func (*AlfrescoConfiguration) SetVpcConfiguration ¶

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*AlfrescoConfiguration) SetWikiFieldMappings ¶

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

SetWikiFieldMappings sets the WikiFieldMappings field's value.

func (AlfrescoConfiguration) String ¶

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 ¶

func (s *AlfrescoConfiguration) Validate() error

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

type AssociateEntitiesToExperienceInput ¶

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 ¶

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 ¶

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

SetEntityList sets the EntityList field's value.

func (*AssociateEntitiesToExperienceInput) SetId ¶

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

SetId sets the Id field's value.

func (*AssociateEntitiesToExperienceInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (AssociateEntitiesToExperienceInput) String ¶

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 ¶

func (s *AssociateEntitiesToExperienceInput) Validate() error

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

type AssociateEntitiesToExperienceOutput ¶

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 ¶

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 ¶

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

SetFailedEntityList sets the FailedEntityList field's value.

func (AssociateEntitiesToExperienceOutput) String ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*AssociatePersonasToEntitiesInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*AssociatePersonasToEntitiesInput) SetPersonas ¶

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

SetPersonas sets the Personas field's value.

func (AssociatePersonasToEntitiesInput) String ¶

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 ¶

func (s *AssociatePersonasToEntitiesInput) Validate() error

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

type AssociatePersonasToEntitiesOutput ¶

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 ¶

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 ¶

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

SetFailedEntityList sets the FailedEntityList field's value.

func (AssociatePersonasToEntitiesOutput) String ¶

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 supplied filters.
    AndAllFilters []*AttributeFilter `type:"list"`

    // Returns true when a document contains all of the specified document attributes
    // or metadata fields. This filter is only applicable to StringListValue metadata.
    ContainsAll *DocumentAttribute `type:"structure"`

    // Returns true when a document contains any of the specified document attributes
    // or metadata fields. This filter is only applicable to StringListValue metadata.
    ContainsAny *DocumentAttribute `type:"structure"`

    // Performs an equals operation on two document attributes or metadata fields.
    EqualsTo *DocumentAttribute `type:"structure"`

    // Performs a greater than operation on two document attributes or metadata
    // fields. Use with a document attribute of type Date or Long.
    GreaterThan *DocumentAttribute `type:"structure"`

    // Performs a greater or equals than operation on two document attributes or
    // metadata fields. Use with a document attribute of type Date or Long.
    GreaterThanOrEquals *DocumentAttribute `type:"structure"`

    // Performs a less than operation on two document attributes or metadata fields.
    // Use with a document attribute of type Date or Long.
    LessThan *DocumentAttribute `type:"structure"`

    // Performs a less than or equals operation on two document attributes or metadata
    // fields. Use with a document attribute of type Date or Long.
    LessThanOrEquals *DocumentAttribute `type:"structure"`

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

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

Provides filtering the query results based on document attributes or metadata fields.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>

<OrAllFilters>

<EqualsTo>

If you use more than 2 layers, you receive a ValidationException exception with the message "AttributeFilter cannot have a depth of more than 2."

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".

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 ¶

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 ¶

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 ¶

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

SetAttributeSuggestionsMode sets the AttributeSuggestionsMode field's value.

func (*AttributeSuggestionsDescribeConfig) SetSuggestableConfigList ¶

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

SetSuggestableConfigList sets the SuggestableConfigList field's value.

func (AttributeSuggestionsDescribeConfig) String ¶

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 ¶

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 ¶

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 ¶

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

SetAdditionalResponseAttributes sets the AdditionalResponseAttributes field's value.

func (*AttributeSuggestionsGetConfig) SetAttributeFilter ¶

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

SetAttributeFilter sets the AttributeFilter field's value.

func (*AttributeSuggestionsGetConfig) SetSuggestionAttributes ¶

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

SetSuggestionAttributes sets the SuggestionAttributes field's value.

func (*AttributeSuggestionsGetConfig) SetUserContext ¶

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

SetUserContext sets the UserContext field's value.

func (AttributeSuggestionsGetConfig) String ¶

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 ¶

func (s *AttributeSuggestionsGetConfig) Validate() error

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

type AttributeSuggestionsUpdateConfig ¶

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 ¶

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 ¶

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

SetAttributeSuggestionsMode sets the AttributeSuggestionsMode field's value.

func (*AttributeSuggestionsUpdateConfig) SetSuggestableConfigList ¶

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

SetSuggestableConfigList sets the SuggestableConfigList field's value.

func (AttributeSuggestionsUpdateConfig) String ¶

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 ¶

func (s *AttributeSuggestionsUpdateConfig) Validate() error

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

type AuthenticationConfiguration ¶

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 ¶

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 ¶

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

SetBasicAuthentication sets the BasicAuthentication field's value.

func (AuthenticationConfiguration) String ¶

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 ¶

func (s *AuthenticationConfiguration) Validate() error

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

type BasicAuthenticationConfiguration ¶

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 ¶

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 ¶

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

SetCredentials sets the Credentials field's value.

func (*BasicAuthenticationConfiguration) SetHost ¶

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

SetHost sets the Host field's value.

func (*BasicAuthenticationConfiguration) SetPort ¶

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

SetPort sets the Port field's value.

func (BasicAuthenticationConfiguration) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchDeleteFeaturedResultsSetError) SetErrorMessage ¶

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchDeleteFeaturedResultsSetError) SetId ¶

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

SetId sets the Id field's value.

func (BatchDeleteFeaturedResultsSetError) String ¶

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 ¶

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 ¶

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 ¶

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

SetFeaturedResultsSetIds sets the FeaturedResultsSetIds field's value.

func (*BatchDeleteFeaturedResultsSetInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (BatchDeleteFeaturedResultsSetInput) String ¶

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 ¶

func (s *BatchDeleteFeaturedResultsSetInput) Validate() error

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

type BatchDeleteFeaturedResultsSetOutput ¶

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 ¶

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 ¶

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

SetErrors sets the Errors field's value.

func (BatchDeleteFeaturedResultsSetOutput) String ¶

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 ¶

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 ¶

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 ¶

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

SetDocumentInfoList sets the DocumentInfoList field's value.

func (*BatchGetDocumentStatusInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (BatchGetDocumentStatusInput) String ¶

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 ¶

func (s *BatchGetDocumentStatusInput) Validate() error

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

type BatchGetDocumentStatusOutput ¶

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 ¶

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 ¶

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

SetDocumentStatusList sets the DocumentStatusList field's value.

func (*BatchGetDocumentStatusOutput) SetErrors ¶

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

SetErrors sets the Errors field's value.

func (BatchGetDocumentStatusOutput) String ¶

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 ¶

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 ¶

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 ¶

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

SetDocumentId sets the DocumentId field's value.

func (*BatchGetDocumentStatusResponseError) SetErrorCode ¶

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetDocumentStatusResponseError) SetErrorMessage ¶

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

SetErrorMessage sets the ErrorMessage field's value.

func (BatchGetDocumentStatusResponseError) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetCommentFieldMappings sets the CommentFieldMappings field's value.

func (*BoxConfiguration) SetCrawlComments ¶

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

SetCrawlComments sets the CrawlComments field's value.

func (*BoxConfiguration) SetCrawlTasks ¶

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

SetCrawlTasks sets the CrawlTasks field's value.

func (*BoxConfiguration) SetCrawlWebLinks ¶

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

SetCrawlWebLinks sets the CrawlWebLinks field's value.

func (*BoxConfiguration) SetEnterpriseId ¶

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

SetEnterpriseId sets the EnterpriseId field's value.

func (*BoxConfiguration) SetExclusionPatterns ¶

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*BoxConfiguration) SetFileFieldMappings ¶

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

SetFileFieldMappings sets the FileFieldMappings field's value.

func (*BoxConfiguration) SetInclusionPatterns ¶

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*BoxConfiguration) SetSecretArn ¶

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

SetSecretArn sets the SecretArn field's value.

func (*BoxConfiguration) SetTaskFieldMappings ¶

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

SetTaskFieldMappings sets the TaskFieldMappings field's value.

func (*BoxConfiguration) SetUseChangeLog ¶

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

SetUseChangeLog sets the UseChangeLog field's value.

func (*BoxConfiguration) SetVpcConfiguration ¶

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*BoxConfiguration) SetWebLinkFieldMappings ¶

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

SetWebLinkFieldMappings sets the WebLinkFieldMappings field's value.

func (BoxConfiguration) String ¶

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 ¶

func (s *BoxConfiguration) Validate() error

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

type CapacityUnitsConfiguration ¶

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 ¶

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 ¶

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

SetQueryCapacityUnits sets the QueryCapacityUnits field's value.

func (*CapacityUnitsConfiguration) SetStorageCapacityUnits ¶

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

SetStorageCapacityUnits sets the StorageCapacityUnits field's value.

func (CapacityUnitsConfiguration) String ¶

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 ¶

func (s *CapacityUnitsConfiguration) Validate() error

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

type ClearQuerySuggestionsInput ¶

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 ¶

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 ¶

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

SetIndexId sets the IndexId field's value.

func (ClearQuerySuggestionsInput) String ¶

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 ¶

func (s *ClearQuerySuggestionsInput) Validate() error

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

type ClearQuerySuggestionsOutput ¶

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

func (ClearQuerySuggestionsOutput) GoString ¶

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 ¶

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 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 ¶

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 ¶

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error ¶

func (s *ConflictException) Error() string

func (ConflictException) GoString ¶

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 ¶

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr ¶

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID ¶

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode ¶

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String ¶

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 ¶

type ConflictingItem struct {

    // The text of the conflicting query.
    QueryText *string `min:"1" 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 ¶

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 ¶

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

SetQueryText sets the QueryText field's value.

func (*ConflictingItem) SetSetId ¶

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

SetSetId sets the SetId field's value.

func (*ConflictingItem) SetSetName ¶

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

SetSetName sets the SetName field's value.

func (ConflictingItem) String ¶

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 ¶

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 ¶

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 ¶

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

SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value.

func (*ConfluenceAttachmentConfiguration) SetCrawlAttachments ¶

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

SetCrawlAttachments sets the CrawlAttachments field's value.

func (ConfluenceAttachmentConfiguration) String ¶

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 ¶

func (s *ConfluenceAttachmentConfiguration) Validate() error

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

type ConfluenceAttachmentToIndexFieldMapping ¶

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 ¶

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 ¶

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetDateFieldFormat ¶

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetIndexFieldName ¶

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceAttachmentToIndexFieldMapping) String ¶

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 ¶

func (s *ConfluenceAttachmentToIndexFieldMapping) Validate() error

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

type ConfluenceBlogConfiguration ¶

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 ¶

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 ¶

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

SetBlogFieldMappings sets the BlogFieldMappings field's value.

func (ConfluenceBlogConfiguration) String ¶

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 ¶

func (s *ConfluenceBlogConfiguration) Validate() error

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

type ConfluenceBlogToIndexFieldMapping ¶

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 ¶

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 ¶

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetDateFieldFormat ¶

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetIndexFieldName ¶

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceBlogToIndexFieldMapping) String ¶

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 ¶

func (s *ConfluenceBlogToIndexFieldMapping) Validate() error

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

type ConfluenceConfiguration ¶

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 ¶

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 ¶

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

SetAttachmentConfiguration sets the AttachmentConfiguration field's value.

func (*ConfluenceConfiguration) SetAuthenticationType ¶

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

SetAuthenticationType sets the AuthenticationType field's value.

func (*ConfluenceConfiguration) SetBlogConfiguration ¶

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

SetBlogConfiguration sets the BlogConfiguration field's value.

func (*ConfluenceConfiguration) SetExclusionPatterns ¶

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*ConfluenceConfiguration) SetInclusionPatterns ¶

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*ConfluenceConfiguration) SetPageConfiguration ¶

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

SetPageConfiguration sets the PageConfiguration field's value.

func (*ConfluenceConfiguration) SetProxyConfiguration ¶

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

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*ConfluenceConfiguration) SetSecretArn ¶

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

SetSecretArn sets the SecretArn field's value.

func (*ConfluenceConfiguration) SetServerUrl ¶

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

SetServerUrl sets the ServerUrl field's value.

func (*ConfluenceConfiguration) SetSpaceConfiguration ¶

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

SetSpaceConfiguration sets the SpaceConfiguration field's value.

func (*ConfluenceConfiguration) SetVersion ¶

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

SetVersion sets the Version field's value.

func (*ConfluenceConfiguration) SetVpcConfiguration ¶

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (ConfluenceConfiguration) String ¶

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 ¶

func (s *ConfluenceConfiguration) Validate() error

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

type ConfluencePageConfiguration ¶

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 ¶

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 ¶

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

SetPageFieldMappings sets the PageFieldMappings field's value.

func (ConfluencePageConfiguration) String ¶

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 ¶

func (s *ConfluencePageConfiguration) Validate() error

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

type ConfluencePageToIndexFieldMapping ¶

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 ¶

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 ¶

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluencePageToIndexFieldMapping) SetDateFieldFormat ¶

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluencePageToIndexFieldMapping) SetIndexFieldName ¶

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluencePageToIndexFieldMapping) String ¶

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 ¶

func (s *ConfluencePageToIndexFieldMapping) Validate() error

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

type ConfluenceSpaceConfiguration ¶

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 ¶

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 ¶

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

SetCrawlArchivedSpaces sets the CrawlArchivedSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetCrawlPersonalSpaces ¶

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

SetCrawlPersonalSpaces sets the CrawlPersonalSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetExcludeSpaces ¶

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

SetExcludeSpaces sets the ExcludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetIncludeSpaces ¶

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

SetIncludeSpaces sets the IncludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetSpaceFieldMappings ¶

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

SetSpaceFieldMappings sets the SpaceFieldMappings field's value.

func (ConfluenceSpaceConfiguration) String ¶

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 ¶

func (s *ConfluenceSpaceConfiguration) Validate() error

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

type ConfluenceSpaceToIndexFieldMapping ¶

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 ¶

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 ¶

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetDateFieldFormat ¶

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetIndexFieldName ¶

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceSpaceToIndexFieldMapping) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetDataSourceIds sets the DataSourceIds field's value.

func (*ContentSourceConfiguration) SetDirectPutContent ¶

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

SetDirectPutContent sets the DirectPutContent field's value.

func (*ContentSourceConfiguration) SetFaqIds ¶

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

SetFaqIds sets the FaqIds field's value.

func (ContentSourceConfiguration) String ¶

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 ¶

func (s *ContentSourceConfiguration) Validate() error

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

type Correction ¶

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 ¶

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 ¶

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

SetBeginOffset sets the BeginOffset field's value.

func (*Correction) SetCorrectedTerm ¶

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

SetCorrectedTerm sets the CorrectedTerm field's value.

func (*Correction) SetEndOffset ¶

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

SetEndOffset sets the EndOffset field's value.

func (*Correction) SetTerm ¶

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

SetTerm sets the Term field's value.

func (Correction) String ¶

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 ¶

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 ¶

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 ¶

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

SetAccessControlList sets the AccessControlList field's value.

func (*CreateAccessControlConfigurationInput) SetClientToken ¶

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

SetClientToken sets the ClientToken field's value.

func (*CreateAccessControlConfigurationInput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*CreateAccessControlConfigurationInput) SetHierarchicalAccessControlList ¶

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

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*CreateAccessControlConfigurationInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*CreateAccessControlConfigurationInput) SetName ¶

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

SetName sets the Name field's value.

func (CreateAccessControlConfigurationInput) String ¶

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 ¶

func (s *CreateAccessControlConfigurationInput) Validate() error

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

type CreateAccessControlConfigurationOutput ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (CreateAccessControlConfigurationOutput) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 (successor to Single Sign-On)
    // 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 ¶

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 ¶

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

SetClientToken sets the ClientToken field's value.

func (*CreateExperienceInput) SetConfiguration ¶

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

SetConfiguration sets the Configuration field's value.

func (*CreateExperienceInput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*CreateExperienceInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*CreateExperienceInput) SetName ¶

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

SetName sets the Name field's value.

func (*CreateExperienceInput) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (CreateExperienceInput) String ¶

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 ¶

func (s *CreateExperienceInput) Validate() error

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

type CreateExperienceOutput ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (CreateExperienceOutput) String ¶

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 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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetClientToken sets the ClientToken field's value.

func (*CreateFeaturedResultsSetInput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*CreateFeaturedResultsSetInput) SetFeaturedDocuments ¶

func (s *CreateFeaturedResultsSetInput) SetFeaturedDocuments(v []*FeaturedDocument) *CreateFeaturedResultsSetInput

SetFeaturedDocuments sets the FeaturedDocuments field's value.

func (*CreateFeaturedResultsSetInput) SetFeaturedResultsSetName ¶

func (s *CreateFeaturedResultsSetInput) SetFeaturedResultsSetName(v string) *CreateFeaturedResultsSetInput

SetFeaturedResultsSetName sets the FeaturedResultsSetName field's value.

func (*CreateFeaturedResultsSetInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*CreateFeaturedResultsSetInput) SetQueryTexts ¶

func (s *CreateFeaturedResultsSetInput) SetQueryTexts(v []*string) *CreateFeaturedResultsSetInput

SetQueryTexts sets the QueryTexts field's value.

func (*CreateFeaturedResultsSetInput) SetStatus ¶

func (s *CreateFeaturedResultsSetInput) SetStatus(v string) *CreateFeaturedResultsSetInput

SetStatus sets the Status field's value.

func (*CreateFeaturedResultsSetInput) SetTags ¶

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

SetTags sets the Tags field's value.

func (CreateFeaturedResultsSetInput) String ¶

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 ¶

func (s *CreateFeaturedResultsSetInput) Validate() error

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

type CreateFeaturedResultsSetOutput ¶

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 ¶

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 ¶

func (s *CreateFeaturedResultsSetOutput) SetFeaturedResultsSet(v *FeaturedResultsSet) *CreateFeaturedResultsSetOutput

SetFeaturedResultsSet sets the FeaturedResultsSet field's value.

func (CreateFeaturedResultsSetOutput) String ¶

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 (successor to Single Sign-On)
    // identity source. To configure this, see UserGroupResolutionConfiguration
    // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html).
    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 ¶

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 ¶

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 ¶

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

SetTags sets the Tags field's value.

func (*CreateIndexInput) SetUserContextPolicy ¶

func (s *CreateIndexInput) SetUserContextPolicy(v string) *CreateIndexInput

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*CreateIndexInput) SetUserGroupResolutionConfiguration ¶

func (s *CreateIndexInput) SetUserGroupResolutionConfiguration(v *UserGroupResolutionConfiguration) *CreateIndexInput

SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value.

func (*CreateIndexInput) SetUserTokenConfigurations ¶

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 ¶

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 ¶

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 ¶

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

SetClientToken sets the ClientToken field's value.

func (*CreateQuerySuggestionsBlockListInput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*CreateQuerySuggestionsBlockListInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*CreateQuerySuggestionsBlockListInput) SetName ¶

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

SetName sets the Name field's value.

func (*CreateQuerySuggestionsBlockListInput) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (*CreateQuerySuggestionsBlockListInput) SetSourceS3Path ¶

func (s *CreateQuerySuggestionsBlockListInput) SetSourceS3Path(v *S3Path) *CreateQuerySuggestionsBlockListInput

SetSourceS3Path sets the SourceS3Path field's value.

func (*CreateQuerySuggestionsBlockListInput) SetTags ¶

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

SetTags sets the Tags field's value.

func (CreateQuerySuggestionsBlockListInput) String ¶

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 ¶

func (s *CreateQuerySuggestionsBlockListInput) Validate() error

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

type CreateQuerySuggestionsBlockListOutput ¶

type CreateQuerySuggestionsBlockListOutput struct {

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

func (CreateQuerySuggestionsBlockListOutput) GoString ¶

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 ¶

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

SetId sets the Id field's value.

func (CreateQuerySuggestionsBlockListOutput) String ¶

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 ¶

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 ¶

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 ¶

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

SetClientToken sets the ClientToken field's value.

func (*CreateThesaurusInput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*CreateThesaurusInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*CreateThesaurusInput) SetName ¶

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

SetName sets the Name field's value.

func (*CreateThesaurusInput) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (*CreateThesaurusInput) SetSourceS3Path ¶

func (s *CreateThesaurusInput) SetSourceS3Path(v *S3Path) *CreateThesaurusInput

SetSourceS3Path sets the SourceS3Path field's value.

func (*CreateThesaurusInput) SetTags ¶

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

SetTags sets the Tags field's value.

func (CreateThesaurusInput) String ¶

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 ¶

func (s *CreateThesaurusInput) Validate() error

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

type CreateThesaurusOutput ¶

type CreateThesaurusOutput struct {

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

func (CreateThesaurusOutput) GoString ¶

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 ¶

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

SetId sets the Id field's value.

func (CreateThesaurusOutput) String ¶

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 ¶

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 ¶

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 ¶

func (s *CustomDocumentEnrichmentConfiguration) SetInlineConfigurations(v []*InlineCustomDocumentEnrichmentConfiguration) *CustomDocumentEnrichmentConfiguration

SetInlineConfigurations sets the InlineConfigurations field's value.

func (*CustomDocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration ¶

func (s *CustomDocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration(v *HookConfiguration) *CustomDocumentEnrichmentConfiguration

SetPostExtractionHookConfiguration sets the PostExtractionHookConfiguration field's value.

func (*CustomDocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration ¶

func (s *CustomDocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration(v *HookConfiguration) *CustomDocumentEnrichmentConfiguration

SetPreExtractionHookConfiguration sets the PreExtractionHookConfiguration field's value.

func (*CustomDocumentEnrichmentConfiguration) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (CustomDocumentEnrichmentConfiguration) String ¶

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 ¶

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.
    AlfrescoConfiguration *AlfrescoConfiguration `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.
    FsxConfiguration *FsxConfiguration `type:"structure"`

    // Provides the configuration information to connect to GitHub as your data
    // source.
    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.
    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.
    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 ¶

func (s *DataSourceConfiguration) SetAlfrescoConfiguration(v *AlfrescoConfiguration) *DataSourceConfiguration

SetAlfrescoConfiguration sets the AlfrescoConfiguration field's value.

func (*DataSourceConfiguration) SetBoxConfiguration ¶

func (s *DataSourceConfiguration) SetBoxConfiguration(v *BoxConfiguration) *DataSourceConfiguration

SetBoxConfiguration sets the BoxConfiguration field's value.

func (*DataSourceConfiguration) SetConfluenceConfiguration ¶

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 ¶

func (s *DataSourceConfiguration) SetFsxConfiguration(v *FsxConfiguration) *DataSourceConfiguration

SetFsxConfiguration sets the FsxConfiguration field's value.

func (*DataSourceConfiguration) SetGitHubConfiguration ¶

func (s *DataSourceConfiguration) SetGitHubConfiguration(v *GitHubConfiguration) *DataSourceConfiguration

SetGitHubConfiguration sets the GitHubConfiguration field's value.

func (*DataSourceConfiguration) SetGoogleDriveConfiguration ¶

func (s *DataSourceConfiguration) SetGoogleDriveConfiguration(v *GoogleDriveConfiguration) *DataSourceConfiguration

SetGoogleDriveConfiguration sets the GoogleDriveConfiguration field's value.

func (*DataSourceConfiguration) SetJiraConfiguration ¶

func (s *DataSourceConfiguration) SetJiraConfiguration(v *JiraConfiguration) *DataSourceConfiguration

SetJiraConfiguration sets the JiraConfiguration field's value.

func (*DataSourceConfiguration) SetOneDriveConfiguration ¶

func (s *DataSourceConfiguration) SetOneDriveConfiguration(v *OneDriveConfiguration) *DataSourceConfiguration

SetOneDriveConfiguration sets the OneDriveConfiguration field's value.

func (*DataSourceConfiguration) SetQuipConfiguration ¶

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 ¶

func (s *DataSourceConfiguration) SetSalesforceConfiguration(v *SalesforceConfiguration) *DataSourceConfiguration

SetSalesforceConfiguration sets the SalesforceConfiguration field's value.

func (*DataSourceConfiguration) SetServiceNowConfiguration ¶

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 ¶

func (s *DataSourceConfiguration) SetSlackConfiguration(v *SlackConfiguration) *DataSourceConfiguration

SetSlackConfiguration sets the SlackConfiguration field's value.

func (*DataSourceConfiguration) SetTemplateConfiguration ¶

func (s *DataSourceConfiguration) SetTemplateConfiguration(v *TemplateConfiguration) *DataSourceConfiguration

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*DataSourceConfiguration) SetWebCrawlerConfiguration ¶

func (s *DataSourceConfiguration) SetWebCrawlerConfiguration(v *WebCrawlerConfiguration) *DataSourceConfiguration

SetWebCrawlerConfiguration sets the WebCrawlerConfiguration field's value.

func (*DataSourceConfiguration) SetWorkDocsConfiguration ¶

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 ¶

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 ¶

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 ¶

func (s *DataSourceGroup) SetDataSourceId(v string) *DataSourceGroup

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceGroup) SetGroupId ¶

func (s *DataSourceGroup) SetGroupId(v string) *DataSourceGroup

SetGroupId sets the GroupId field's value.

func (DataSourceGroup) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

func (s *DataSourceSyncJobMetricTarget) SetDataSourceId(v string) *DataSourceSyncJobMetricTarget

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId ¶

func (s *DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId(v string) *DataSourceSyncJobMetricTarget

SetDataSourceSyncJobId sets the DataSourceSyncJobId field's value.

func (DataSourceSyncJobMetricTarget) String ¶

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 ¶

func (s *DataSourceSyncJobMetricTarget) Validate() error

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

type DataSourceSyncJobMetrics ¶

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 ¶

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 ¶

func (s *DataSourceSyncJobMetrics) SetDocumentsAdded(v string) *DataSourceSyncJobMetrics

SetDocumentsAdded sets the DocumentsAdded field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsDeleted ¶

func (s *DataSourceSyncJobMetrics) SetDocumentsDeleted(v string) *DataSourceSyncJobMetrics

SetDocumentsDeleted sets the DocumentsDeleted field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsFailed ¶

func (s *DataSourceSyncJobMetrics) SetDocumentsFailed(v string) *DataSourceSyncJobMetrics

SetDocumentsFailed sets the DocumentsFailed field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsModified ¶

func (s *DataSourceSyncJobMetrics) SetDocumentsModified(v string) *DataSourceSyncJobMetrics

SetDocumentsModified sets the DocumentsModified field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsScanned ¶

func (s *DataSourceSyncJobMetrics) SetDocumentsScanned(v string) *DataSourceSyncJobMetrics

SetDocumentsScanned sets the DocumentsScanned field's value.

func (DataSourceSyncJobMetrics) String ¶

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 column or attribute in the data source.
    //
    // DataSourceFieldName is a required field
    DataSourceFieldName *string `min:"1" type:"string" required:"true"`

    // The type of data stored in the column or attribute.
    DateFieldFormat *string `min:"4" type:"string"`

    // The name of the field in the index.
    //
    // IndexFieldName is a required field
    IndexFieldName *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex API.

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 connect to a index.

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 ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*DeleteAccessControlConfigurationInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DeleteAccessControlConfigurationInput) String ¶

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 ¶

func (s *DeleteAccessControlConfigurationInput) Validate() error

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

type DeleteAccessControlConfigurationOutput ¶

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

func (DeleteAccessControlConfigurationOutput) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*DeleteDataSourceInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DeleteDataSourceInput) String ¶

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 ¶

func (s *DeleteDataSourceInput) Validate() error

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

type DeleteDataSourceOutput ¶

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

func (DeleteDataSourceOutput) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*DeleteExperienceInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DeleteExperienceInput) String ¶

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 ¶

func (s *DeleteExperienceInput) Validate() error

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

type DeleteExperienceOutput ¶

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

func (DeleteExperienceOutput) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

func (s *DeletePrincipalMappingInput) SetDataSourceId(v string) *DeletePrincipalMappingInput

SetDataSourceId sets the DataSourceId field's value.

func (*DeletePrincipalMappingInput) SetGroupId ¶

func (s *DeletePrincipalMappingInput) SetGroupId(v string) *DeletePrincipalMappingInput

SetGroupId sets the GroupId field's value.

func (*DeletePrincipalMappingInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*DeletePrincipalMappingInput) SetOrderingId ¶

func (s *DeletePrincipalMappingInput) SetOrderingId(v int64) *DeletePrincipalMappingInput

SetOrderingId sets the OrderingId field's value.

func (DeletePrincipalMappingInput) String ¶

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 ¶

func (s *DeletePrincipalMappingInput) Validate() error

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

type DeletePrincipalMappingOutput ¶

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

func (DeletePrincipalMappingOutput) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*DeleteQuerySuggestionsBlockListInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DeleteQuerySuggestionsBlockListInput) String ¶

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 ¶

func (s *DeleteQuerySuggestionsBlockListInput) Validate() error

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

type DeleteQuerySuggestionsBlockListOutput ¶

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

func (DeleteQuerySuggestionsBlockListOutput) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*DeleteThesaurusInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DeleteThesaurusInput) String ¶

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 ¶

func (s *DeleteThesaurusInput) Validate() error

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

type DeleteThesaurusOutput ¶

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

func (DeleteThesaurusOutput) GoString ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*DescribeAccessControlConfigurationInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DescribeAccessControlConfigurationInput) String ¶

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 ¶

func (s *DescribeAccessControlConfigurationInput) Validate() error

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

type DescribeAccessControlConfigurationOutput ¶

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 ¶

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 ¶

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

SetAccessControlList sets the AccessControlList field's value.

func (*DescribeAccessControlConfigurationOutput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*DescribeAccessControlConfigurationOutput) SetErrorMessage ¶

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeAccessControlConfigurationOutput) SetHierarchicalAccessControlList ¶

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

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*DescribeAccessControlConfigurationOutput) SetName ¶

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

SetName sets the Name field's value.

func (DescribeAccessControlConfigurationOutput) String ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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 ¶

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

SetId sets the Id field's value.

func (*DescribeExperienceInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DescribeExperienceInput) String ¶

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 ¶

func (s *DescribeExperienceInput) Validate() error

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

type DescribeExperienceOutput ¶