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

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

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 (
    // ErrorCodeInternalError is a ErrorCode enum value
    ErrorCodeInternalError = "InternalError"

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

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 (
    // 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 (
    // KeyLocationUrl is a KeyLocation enum value
    KeyLocationUrl = "URL"

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

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

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 (
    // SortOrderDesc is a SortOrder enum value
    SortOrderDesc = "DESC"

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

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 (
    // UserContextPolicyAttributeFilter is a UserContextPolicy enum value
    UserContextPolicyAttributeFilter = "ATTRIBUTE_FILTER"

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

const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    ErrCodeConflictException = "ConflictException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeResourceAlreadyExistException for service response error code
    // "ResourceAlreadyExistException".
    ErrCodeResourceAlreadyExistException = "ResourceAlreadyExistException"

    // ErrCodeResourceInUseException for service response error code
    // "ResourceInUseException".
    ErrCodeResourceInUseException = "ResourceInUseException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeResourceUnavailableException for service response error code
    // "ResourceUnavailableException".
    ErrCodeResourceUnavailableException = "ResourceUnavailableException"

    // ErrCodeServiceQuotaExceededException for service response error code
    // "ServiceQuotaExceededException".
    ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

    // ErrCodeThrottlingException for service response error code
    // "ThrottlingException".
    ErrCodeThrottlingException = "ThrottlingException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    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 (
    // SharePointVersionSharepointOnline is a SharePointVersion enum value
    SharePointVersionSharepointOnline = "SHAREPOINT_ONLINE"
)

func AdditionalResultAttributeValueType_Values ¶

func AdditionalResultAttributeValueType_Values() []string

AdditionalResultAttributeValueType_Values returns all elements of the AdditionalResultAttributeValueType enum

func ConfluenceAttachmentFieldName_Values ¶

func ConfluenceAttachmentFieldName_Values() []string

ConfluenceAttachmentFieldName_Values returns all elements of the ConfluenceAttachmentFieldName 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 ErrorCode_Values ¶

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode 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 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 KeyLocation_Values ¶

func KeyLocation_Values() []string

KeyLocation_Values returns all elements of the KeyLocation 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 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 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 SharePointVersion_Values ¶

func SharePointVersion_Values() []string

SharePointVersion_Values returns all elements of the SharePointVersion enum

func SortOrder_Values ¶

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func ThesaurusStatus_Values ¶

func ThesaurusStatus_Values() []string

ThesaurusStatus_Values returns all elements of the ThesaurusStatus enum

func UserContextPolicy_Values ¶

func UserContextPolicy_Values() []string

UserContextPolicy_Values returns all elements of the UserContextPolicy enum

type AccessControlListConfiguration ¶

type AccessControlListConfiguration struct {

    // Path to the AWS 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

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

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
}

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

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

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 operation.
    //
    // 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

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

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

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

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

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

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.
    // This filter is only applicable to StringListValue metadata.
    ContainsAll *DocumentAttribute `type:"structure"`

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

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

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

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

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

    // Performs a less than or equals operation on two document attributes. Use
    // with a document attribute of type Integer 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.

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>

<EqualTo>

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

func (AttributeFilter) GoString ¶

func (s AttributeFilter) GoString() string

GoString returns the string representation

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

func (*AttributeFilter) Validate ¶

func (s *AttributeFilter) 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

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

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

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

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

func (BatchDeleteDocumentResponseFailedDocument) GoString ¶

func (s BatchDeleteDocumentResponseFailedDocument) GoString() string

GoString returns the string representation

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

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

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

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

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

type BatchGetDocumentStatusResponseError ¶

type BatchGetDocumentStatusResponseError struct {

    // The unique 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

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

type BatchPutDocumentInput ¶

type BatchPutDocumentInput struct {

    // One or more documents to add to the index.
    //
    // Documents can include custom attributes. For example, 'DataSourceId' and
    // 'DataSourceSyncJobId' are custom attributes that provide information on the
    // synchronization of documents running on a data source. Note, 'DataSourceSyncJobId'
    // could be an optional custom attribute as Amazon Kendra will use the ID of
    // a running sync job.
    //
    // Documents have the following file size limits.
    //
    //    * 5 MB total size for inline documents
    //
    //    * 50 MB total size for files from an S3 bucket
    //
    //    * 5 MB extracted text for any file
    //
    // For more information about file size and transaction per second quotas, 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 operation.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument
    // operation. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
    RoleArn *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (BatchPutDocumentInput) GoString ¶

func (s BatchPutDocumentInput) GoString() string

GoString returns the string representation

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

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

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

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

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

type CapacityUnitsConfiguration ¶

type CapacityUnitsConfiguration struct {

    // The amount of extra query capacity for an index. Each capacity unit provides
    // 0.5 queries per second and 40,000 queries per day.
    //
    // QueryCapacityUnits is a required field
    QueryCapacityUnits *int64 `type:"integer" required:"true"`

    // The amount of extra storage capacity for an index. Each capacity unit provides
    // 150 Gb of storage space or 500,000 documents, whichever is reached first.
    //
    // StorageCapacityUnits is a required field
    StorageCapacityUnits *int64 `type:"integer" required:"true"`
    // contains filtered or unexported fields
}

Specifies capacity units configured for your index. You can add and remove capacity units to tune an index to your requirements.

func (CapacityUnitsConfiguration) GoString ¶

func (s CapacityUnitsConfiguration) GoString() string

GoString returns the string representation

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

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

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

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

func (ClearQuerySuggestionsOutput) String ¶

func (s ClearQuerySuggestionsOutput) String() string

String returns the string representation

type ClickFeedback ¶

type ClickFeedback struct {

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

    // The unique 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 operation to provide click information.

func (ClickFeedback) GoString ¶

func (s ClickFeedback) GoString() string

GoString returns the string representation

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

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 unique 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
    // operation.
    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

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

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
}

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

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

type ConfluenceAttachmentConfiguration ¶

type ConfluenceAttachmentConfiguration struct {

    // Defines how attachment metadata fields should be mapped to index fields.
    // Before you can map a field, you must first create an index field with a matching
    // type using the console or the UpdateIndex operation.
    //
    // If you specify the AttachentFieldMappings parameter, you must specify at
    // least one field mapping.
    AttachmentFieldMappings []*ConfluenceAttachmentToIndexFieldMapping `min:"1" type:"list"`

    // Indicates whether Amazon Kendra indexes attachments to the pages and blogs
    // in the Confluence data source.
    CrawlAttachments *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Specifies the 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

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

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 operation.
    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
}

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

func (ConfluenceAttachmentToIndexFieldMapping) GoString ¶

func (s ConfluenceAttachmentToIndexFieldMapping) GoString() string

GoString returns the string representation

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

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 {

    // Defines how blog metadata fields should be mapped to index fields. Before
    // you can map a field, you must first create an index field with a matching
    // type using the console or the UpdateIndex operation.
    //
    // 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
}

Specifies the 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 type.

func (ConfluenceBlogConfiguration) GoString ¶

func (s ConfluenceBlogConfiguration) GoString() string

GoString returns the string representation

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

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
}

Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

func (ConfluenceBlogToIndexFieldMapping) GoString ¶

func (s ConfluenceBlogToIndexFieldMapping) GoString() string

GoString returns the string representation

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

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 {

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

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

    // A list of regular expression patterns that apply to a URL on the Confluence
    // server. An exclusion pattern can apply to a blog post, a page, a space, or
    // an attachment. Items that match the pattern are excluded from the index.
    // Items that don't match the pattern are included in the index. If a item matches
    // both an exclusion pattern and an inclusion pattern, the item isn't included
    // in the index.
    ExclusionPatterns []*string `type:"list"`

    // A list of regular expression patterns that apply to a URL on the Confluence
    // server. An inclusion pattern can apply to a blog post, a page, a space, or
    // an attachment. Items that match the patterns are included in the index. Items
    // that don't match the pattern are excluded from the index. If an item matches
    // both an inclusion pattern and an exclusion pattern, the item isn't included
    // in the index.
    InclusionPatterns []*string `type:"list"`

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

    // The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
    // the key/value pairs required to connect to your Confluence server. The secret
    // must contain a JSON structure with the following keys:
    //
    //    * username - The user name or email address of a user with administrative
    //    privileges for the Confluence server.
    //
    //    * password - The password associated with the user logging in to the Confluence
    //    server.
    //
    // 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"`

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

    // Specifies the version of the Confluence installation that you are connecting
    // to.
    //
    // Version is a required field
    Version *string `type:"string" required:"true" enum:"ConfluenceVersion"`

    // Specifies the information for connecting to an Amazon VPC.
    VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

Provides configuration information for data sources that connect to Confluence.

func (ConfluenceConfiguration) GoString ¶

func (s ConfluenceConfiguration) GoString() string

GoString returns the string representation

func (*ConfluenceConfiguration) SetAttachmentConfiguration ¶

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

SetAttachmentConfiguration sets the AttachmentConfiguration 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) 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

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 {

    // Defines how page metadata fields should be mapped to index fields. Before
    // you can map a field, you must first create an index field with a matching
    // type using the console or the UpdateIndex operation.
    //
    // 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
}

Specifies the page settings for the Confluence data source.

func (ConfluencePageConfiguration) GoString ¶

func (s ConfluencePageConfiguration) GoString() string

GoString returns the string representation

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

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
}

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

func (ConfluencePageToIndexFieldMapping) GoString ¶

func (s ConfluencePageToIndexFieldMapping) GoString() string

GoString returns the string representation

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

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 {

    // Specifies whether Amazon Kendra should index archived spaces.
    CrawlArchivedSpaces *bool `type:"boolean"`

    // Specifies whether Amazon Kendra should index personal spaces. Users 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"`

    // Defines how space metadata fields should be mapped to index fields. Before
    // you can map a field, you must first create an index field with a matching
    // type using the console or the UpdateIndex operation.
    //
    // 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
}

Specifies the configuration for indexing Confluence spaces.

func (ConfluenceSpaceConfiguration) GoString ¶

func (s ConfluenceSpaceConfiguration) GoString() string

GoString returns the string representation

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

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
}

Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field.

You must first create the index field using the UpdateIndex operation.

func (ConfluenceSpaceToIndexFieldMapping) GoString ¶

func (s ConfluenceSpaceToIndexFieldMapping) GoString() string

GoString returns the string representation

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

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 AWS 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 AWS Secrets Manager, see What Is AWS Secrets Manager
    // (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
    // in the AWS 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 information necessary to connect to a database.

func (ConnectionConfiguration) GoString ¶

func (s ConnectionConfiguration) GoString() string

GoString returns the string representation

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

func (*ConnectionConfiguration) Validate ¶

func (s *ConnectionConfiguration) Validate() error

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

type CreateDataSourceInput ¶

type CreateDataSourceInput struct {

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

    // The connector configuration information that is required to access the 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"`

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

    // The identifier of the index that should be associated with this data source.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // A unique name for the data source. A data source name can't be changed without
    // deleting and recreating the data source.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The Amazon Resource Name (ARN) of a role with permission to access the data
    // source. For more information, see IAM 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 `min:"1" type:"string"`

    // Sets the frequency that Amazon Kendra will check the documents in your 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 operation
    // to update the index.
    //
    // 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 the data source. You can use the
    // tags to identify and organize your resources and to control access to resources.
    Tags []*Tag `type:"list"`

    // The type of repository that contains the data source.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"DataSourceType"`
    // contains filtered or unexported fields
}

func (CreateDataSourceInput) GoString ¶

func (s CreateDataSourceInput) GoString() string

GoString returns the string representation

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

func (s CreateDataSourceInput) String() string

String returns the string representation

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 {

    // A unique identifier for the data source.
    //
    // 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

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

type CreateFaqInput ¶

type CreateFaqInput struct {

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

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

    // The format of the 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 that contains the FAQ.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The name that should be associated with the FAQ.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

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

    // The S3 location of the FAQ input data.
    //
    // 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

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

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

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

type CreateIndexInput ¶

type CreateIndexInput struct {

    // A token that you provide to identify the request to create an index. Multiple
    // calls to the CreateIndex operation 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 your production databases. 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.
    Edition *string `type:"string" enum:"IndexEdition"`

    // The name for the new index.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // An AWS Identity and Access Management (IAM) role that gives Amazon Kendra
    // permissions to access your Amazon CloudWatch logs and metrics. This is also
    // the role used when you use the BatchPutDocument operation to index documents
    // from an Amazon S3 bucket.
    //
    // RoleArn is a required field
    RoleArn *string `min:"1" type:"string" required:"true"`

    // The identifier of the AWS KMS customer managed key (CMK) to use 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 the index. You can use the tags to
    // identify and organize your resources and to control access to resources.
    Tags []*Tag `type:"list"`

    // The user context policy.
    //
    // ATTRIBUTE_FILTER
    //
    // All indexed content is searchable and displayable for all users. If there
    // is an access control list, it is ignored. You can filter on user and group
    // attributes.
    //
    // USER_TOKEN
    //
    // Enables SSO and token-based user access control. All documents with no access
    // control and all documents accessible to the user will be searchable and displayable.
    UserContextPolicy *string `type:"string" enum:"UserContextPolicy"`

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

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

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

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

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 user-friendly 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 user friendly name for the block list.
    //
    // For example, the block list named 'offensive-words' 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 IAM (Identity and Access Management) role used by Amazon Kendra to access
    // the block list text file in your S3 bucket.
    //
    // You need permissions to the role ARN (Amazon Resource Name). The role needs
    // S3 read permissions to your file in S3 and needs to give STS (Security Token
    // Service) assume role permissions to Amazon Kendra.
    //
    // RoleArn is a required field
    RoleArn *string `min:"1" 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 tag that you can assign to a block list that categorizes the block list.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateQuerySuggestionsBlockListInput) GoString ¶

func (s CreateQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation

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

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 unique identifier of the created 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

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

type CreateThesaurusInput ¶

type CreateThesaurusInput struct {

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

    // The description for the new thesaurus.
    Description *string `type:"string"`

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

    // The name for the new thesaurus.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // An AWS Identity and Access Management (IAM) role that gives Amazon Kendra
    // permissions to access thesaurus file specified in SourceS3Path.
    //
    // RoleArn is a required field
    RoleArn *string `min:"1" type:"string" required:"true"`

    // The thesaurus file Amazon S3 source path.
    //
    // SourceS3Path is a required field
    SourceS3Path *S3Path `type:"structure" required:"true"`

    // A list of key-value pairs that identify the thesaurus. 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 (CreateThesaurusInput) GoString ¶

func (s CreateThesaurusInput) GoString() string

GoString returns the string representation

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

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

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

type DataSourceConfiguration ¶

type DataSourceConfiguration struct {

    // Provides configuration information for connecting to a Confluence data source.
    ConfluenceConfiguration *ConfluenceConfiguration `type:"structure"`

    // Provides information necessary to create a data source connector for a database.
    DatabaseConfiguration *DatabaseConfiguration `type:"structure"`

    // Provides configuration for data sources that connect to Google Drive.
    GoogleDriveConfiguration *GoogleDriveConfiguration `type:"structure"`

    // Provides configuration for data sources that connect to Microsoft OneDrive.
    OneDriveConfiguration *OneDriveConfiguration `type:"structure"`

    // Provides information to create a data source connector for a document repository
    // in an Amazon S3 bucket.
    S3Configuration *S3DataSourceConfiguration `type:"structure"`

    // Provides configuration information for data sources that connect to a Salesforce
    // site.
    SalesforceConfiguration *SalesforceConfiguration `type:"structure"`

    // Provides configuration for data sources that connect to ServiceNow instances.
    ServiceNowConfiguration *ServiceNowConfiguration `type:"structure"`

    // Provides information necessary to create a data source connector for a Microsoft
    // SharePoint site.
    SharePointConfiguration *SharePointConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

Configuration information for a Amazon Kendra data source.

func (DataSourceConfiguration) GoString ¶

func (s DataSourceConfiguration) GoString() string

GoString returns the string representation

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

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

SetGoogleDriveConfiguration sets the GoogleDriveConfiguration field's value.

func (*DataSourceConfiguration) SetOneDriveConfiguration ¶

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

SetOneDriveConfiguration sets the OneDriveConfiguration 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) String ¶

func (s DataSourceConfiguration) String() string

String returns the string representation

func (*DataSourceConfiguration) Validate ¶

func (s *DataSourceConfiguration) Validate() error

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

type DataSourceSummary ¶

type DataSourceSummary struct {

    // The UNIX datetime that the data source was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The unique identifier for the data source.
    Id *string `min:"1" 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 datetime that the data source was lasted updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Summary information for a Amazon Kendra data source. Returned in a call to the DescribeDataSource operation.

func (DataSourceSummary) GoString ¶

func (s DataSourceSummary) GoString() string

GoString returns the string representation

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

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 datetime that the synchronization job was completed.
    EndTime *time.Time `type:"timestamp"`

    // If the Status field is set to FAILED, the ErrorCode field contains a the
    // reason that 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 unique 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 datetime that the synchronization job was 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 synchronization job.

func (DataSourceSyncJob) GoString ¶

func (s DataSourceSyncJob) GoString() string

GoString returns the string representation

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

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

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

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

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

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

func (DataSourceToIndexFieldMapping) GoString ¶

func (s DataSourceToIndexFieldMapping) GoString() string

GoString returns the string representation

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

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 information for connecting to an Amazon VPC.

func (DataSourceVpcConfiguration) GoString ¶

func (s DataSourceVpcConfiguration) GoString() string

GoString returns the string representation

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

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

    // The information necessary 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 information for connecting to an Amazon VPC.
    VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

Provides the information necessary to connect a database to an index.

func (DatabaseConfiguration) GoString ¶

func (s DatabaseConfiguration) GoString() string

GoString returns the string representation

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

func (*DatabaseConfiguration) Validate ¶

func (s *DatabaseConfiguration) Validate() error

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

type DeleteDataSourceInput ¶

type DeleteDataSourceInput struct {

    // The unique identifier of the data source to delete.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The unique identifier of the index associated with the data source.
    //
    // 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

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

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

func (DeleteDataSourceOutput) String ¶

func (s DeleteDataSourceOutput) String() string

String returns the string representation

type DeleteFaqInput ¶

type DeleteFaqInput struct {

    // The identifier of the FAQ to remove.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The index to remove the FAQ from.
    //
    // 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

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

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

func (DeleteFaqOutput) String ¶

func (s DeleteFaqOutput) String() string

String returns the string representation

type DeleteIndexInput ¶

type DeleteIndexInput struct {

    // The identifier of the index 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

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

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

func (DeleteIndexOutput) String ¶

func (s DeleteIndexOutput) String() string

String returns the string representation

type DeleteQuerySuggestionsBlockListInput ¶

type DeleteQuerySuggestionsBlockListInput struct {

    // The unique identifier of the block list that needs to be deleted.
    //
    // Id is a required field
    Id *string `min:"36" type:"string" required:"true"`

    // The identifier of the you want to delete a block list from.
    //
    // 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

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

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

func (DeleteQuerySuggestionsBlockListOutput) String ¶

func (s DeleteQuerySuggestionsBlockListOutput) String() string

String returns the string representation

type DeleteThesaurusInput ¶

type DeleteThesaurusInput struct {

    // The identifier of the thesaurus to delete.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index associated with the thesaurus to delete.
    //
    // 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

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

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

func (DeleteThesaurusOutput) String ¶

func (s DeleteThesaurusOutput) String() string

String returns the string representation

type DescribeDataSourceInput ¶

type DescribeDataSourceInput struct {

    // The unique identifier of the data source to describe.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index that contains the data source.
    //
    // 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

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

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 {

    // Information that describes where the data source is located and how the data
    // source is configured. The specific information in the description depends
    // on the data source provider.
    Configuration *DataSourceConfiguration `type:"structure"`

    // The Unix timestamp of when the data source was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The description of the data source.
    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.
    Id *string `min:"1" type:"string"`

    // The identifier of the index that contains the data source.
    IndexId *string `min:"36" type:"string"`

    // The name that you gave the data source when it was created.
    Name *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the role that enables the data source to
    // access its resources.
    RoleArn *string `min:"1" type:"string"`

    // The schedule that Amazon Kendra will update the data source.
    Schedule *string `type:"string"`

    // The current status of the data source. 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.
    Type *string `type:"string" enum:"DataSourceType"`

    // The Unix timestamp of when the data source was last updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

func (DescribeDataSourceOutput) GoString ¶

func (s DescribeDataSourceOutput) GoString() string

GoString returns the string representation

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

func (s DescribeDataSourceOutput) String() string

String returns the string representation

type DescribeFaqInput ¶

type DescribeFaqInput struct {

    // The unique identifier of the FAQ.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

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

func (DescribeFaqInput) GoString ¶

func (s DescribeFaqInput) GoString() string

GoString returns the string representation

func (*DescribeFaqInput) SetId ¶

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

SetId sets the Id field's value.

func (*DescribeFaqInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DescribeFaqInput) String ¶

func (s DescribeFaqInput) String() string

String returns the string representation

func (*DescribeFaqInput) Validate ¶

func (s *DescribeFaqInput) Validate() error

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

type DescribeFaqOutput ¶

type DescribeFaqOutput struct {

    // The date and time that the FAQ was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The description of the FAQ that you provided when it was created.
    Description *string `type:"string"`

    // If the Status field is FAILED, the ErrorMessage field contains the reason
    // why the FAQ failed.
    ErrorMessage *string `min:"1" type:"string"`

    // The file format used by the input files for the FAQ.
    FileFormat *string `type:"string" enum:"FaqFileFormat"`

    // The identifier of the FAQ.
    Id *string `min:"1" type:"string"`

    // The identifier of the index that contains the FAQ.
    IndexId *string `min:"36" type:"string"`

    // The name that you gave the FAQ when it was created.
    Name *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the role that provides access to the S3
    // bucket containing the input files for the FAQ.
    RoleArn *string `min:"1" type:"string"`

    // Information required to find a specific file in an Amazon S3 bucket.
    S3Path *S3Path `type:"structure"`

    // The status of the FAQ. It is ready to use when the status is ACTIVE.
    Status *string `type:"string" enum:"FaqStatus"`

    // The date and time that the FAQ was last updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

func (DescribeFaqOutput) GoString ¶

func (s DescribeFaqOutput) GoString() string

GoString returns the string representation

func (*DescribeFaqOutput) SetCreatedAt ¶

func (s *DescribeFaqOutput) SetCreatedAt(v time.Time) *DescribeFaqOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeFaqOutput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*DescribeFaqOutput) SetErrorMessage ¶

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeFaqOutput) SetFileFormat ¶

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

SetFileFormat sets the FileFormat field's value.

func (*DescribeFaqOutput) SetId ¶

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

SetId sets the Id field's value.

func (*DescribeFaqOutput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*DescribeFaqOutput) SetName ¶

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

SetName sets the Name field's value.

func (*DescribeFaqOutput) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeFaqOutput) SetS3Path ¶

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

SetS3Path sets the S3Path field's value.

func (*DescribeFaqOutput) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*DescribeFaqOutput) SetUpdatedAt ¶

func (s *DescribeFaqOutput) SetUpdatedAt(v time.Time) *DescribeFaqOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeFaqOutput) String ¶

func (s DescribeFaqOutput) String() string

String returns the string representation

type DescribeIndexInput ¶

type DescribeIndexInput struct {

    // The name of the index to describe.
    //
    // Id is a required field
    Id *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeIndexInput) GoString ¶

func (s DescribeIndexInput) GoString() string

GoString returns the string representation

func (*DescribeIndexInput) SetId ¶

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

SetId sets the Id field's value.

func (DescribeIndexInput) String ¶

func (s DescribeIndexInput) String() string

String returns the string representation

func (*DescribeIndexInput) Validate ¶

func (s *DescribeIndexInput) Validate() error

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

type DescribeIndexOutput ¶

type DescribeIndexOutput struct {

    // For Enterprise edition indexes, you can choose to use additional capacity
    // to meet the needs of your application. This contains the capacity units used
    // for the index. A 0 for the query capacity or the storage capacity indicates
    // that the index is using the default capacity for the index.
    CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

    // The Unix datetime that the index was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The description of the index.
    Description *string `type:"string"`

    // Configuration settings for any metadata applied to the documents in the index.
    DocumentMetadataConfigurations []*DocumentMetadataConfiguration `type:"list"`

    // The Amazon Kendra edition used for the index. You decide the edition when
    // you create the index.
    Edition *string `type:"string" enum:"IndexEdition"`

    // When th eStatus field value is FAILED, the ErrorMessage field contains a
    // message that explains why.
    ErrorMessage *string `min:"1" type:"string"`

    // The name of the index.
    Id *string `min:"36" type:"string"`

    // Provides information about the number of FAQ questions and answers and the
    // number of text documents indexed.
    IndexStatistics *IndexStatistics `type:"structure"`

    // The name of the index.
    Name *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission
    // to write to your Amazon Cloudwatch logs.
    RoleArn *string `min:"1" type:"string"`

    // The identifier of the AWS KMS customer master key (CMK) used to encrypt your
    // data. Amazon Kendra doesn't support asymmetric CMKs.
    ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

    // The current status of the index. When the value is ACTIVE, the index is ready
    // for use. If the Status field value is FAILED, the ErrorMessage field contains
    // a message that explains why.
    Status *string `type:"string" enum:"IndexStatus"`

    // The Unix datetime that the index was last updated.
    UpdatedAt *time.Time `type:"timestamp"`

    // The user context policy for the Amazon Kendra index.
    UserContextPolicy *string `type:"string" enum:"UserContextPolicy"`

    // The user token configuration for the Amazon Kendra index.
    UserTokenConfigurations []*UserTokenConfiguration `type:"list"`
    // contains filtered or unexported fields
}

func (DescribeIndexOutput) GoString ¶

func (s DescribeIndexOutput) GoString() string

GoString returns the string representation

func (*DescribeIndexOutput) SetCapacityUnits ¶

func (s *DescribeIndexOutput) SetCapacityUnits(v *CapacityUnitsConfiguration) *DescribeIndexOutput

SetCapacityUnits sets the CapacityUnits field's value.

func (*DescribeIndexOutput) SetCreatedAt ¶

func (s *DescribeIndexOutput) SetCreatedAt(v time.Time) *DescribeIndexOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeIndexOutput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*DescribeIndexOutput) SetDocumentMetadataConfigurations ¶

func (s *DescribeIndexOutput) SetDocumentMetadataConfigurations(v []*DocumentMetadataConfiguration) *DescribeIndexOutput

SetDocumentMetadataConfigurations sets the DocumentMetadataConfigurations field's value.

func (*DescribeIndexOutput) SetEdition ¶

func (s *DescribeIndexOutput) SetEdition(v string) *DescribeIndexOutput

SetEdition sets the Edition field's value.

func (*DescribeIndexOutput) SetErrorMessage ¶

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeIndexOutput) SetId ¶

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

SetId sets the Id field's value.

func (*DescribeIndexOutput) SetIndexStatistics ¶

func (s *DescribeIndexOutput) SetIndexStatistics(v *IndexStatistics) *DescribeIndexOutput

SetIndexStatistics sets the IndexStatistics field's value.

func (*DescribeIndexOutput) SetName ¶

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

SetName sets the Name field's value.

func (*DescribeIndexOutput) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeIndexOutput) SetServerSideEncryptionConfiguration ¶

func (s *DescribeIndexOutput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DescribeIndexOutput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*DescribeIndexOutput) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*DescribeIndexOutput) SetUpdatedAt ¶

func (s *DescribeIndexOutput) SetUpdatedAt(v time.Time) *DescribeIndexOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (*DescribeIndexOutput) SetUserContextPolicy ¶

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

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*DescribeIndexOutput) SetUserTokenConfigurations ¶

func (s *DescribeIndexOutput) SetUserTokenConfigurations(v []*UserTokenConfiguration) *DescribeIndexOutput

SetUserTokenConfigurations sets the UserTokenConfigurations field's value.

func (DescribeIndexOutput) String ¶

func (s DescribeIndexOutput) String() string

String returns the string representation

type DescribeQuerySuggestionsBlockListInput ¶

type DescribeQuerySuggestionsBlockListInput struct {

    // The unique identifier of the block list.
    //
    // Id is a required field
    Id *string `min:"36" type:"string" required:"true"`

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

func (DescribeQuerySuggestionsBlockListInput) GoString ¶

func (s DescribeQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation

func (*DescribeQuerySuggestionsBlockListInput) SetId ¶

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

SetId sets the Id field's value.

func (*DescribeQuerySuggestionsBlockListInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DescribeQuerySuggestionsBlockListInput) String ¶

func (s DescribeQuerySuggestionsBlockListInput) String() string

String returns the string representation

func (*DescribeQuerySuggestionsBlockListInput) Validate ¶

func (s *DescribeQuerySuggestionsBlockListInput) Validate() error

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

type DescribeQuerySuggestionsBlockListOutput ¶

type DescribeQuerySuggestionsBlockListOutput struct {

    // Shows the date-time a block list for query suggestions was last created.
    CreatedAt *time.Time `type:"timestamp"`

    // Shows the description for the block list.
    Description *string `type:"string"`

    // Shows the error message with details when there are issues in processing
    // the block list.
    ErrorMessage *string `min:"1" type:"string"`

    // Shows the current size of the block list text file in S3.
    FileSizeBytes *int64 `type:"long"`

    // Shows the unique identifier of the block list.
    Id *string `min:"36" type:"string"`

    // Shows the identifier of the index for the block list.
    IndexId *string `min:"36" type:"string"`

    // Shows the current number of valid, non-empty words or phrases in the block
    // list text file.
    ItemCount *int64 `type:"integer"`

    // Shows the name of the block list.
    Name *string `min:"1" type:"string"`

    // Shows the current IAM (Identity and Access Management) role used by Amazon
    // Kendra to access the block list text file in S3.
    //
    // The role needs S3 read permissions to your file in S3 and needs to give STS
    // (Security Token Service) assume role permissions to Amazon Kendra.
    RoleArn *string `min:"1" type:"string"`

    // Shows the current S3 path to your block list text file in your S3 bucket.
    //
    // Each block word or phrase should be on a separate line in a text file.
    //
    // For information on the current quota limits for block lists, see Quotas for
    // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
    SourceS3Path *S3Path `type:"structure"`

    // Shows whether the current status of the block list is ACTIVE or INACTIVE.
    Status *string `type:"string" enum:"QuerySuggestionsBlockListStatus"`

    // Shows the date-time a block list for query suggestions was last updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

func (DescribeQuerySuggestionsBlockListOutput) GoString ¶

func (s DescribeQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation

func (*DescribeQuerySuggestionsBlockListOutput) SetCreatedAt ¶

func (s *DescribeQuerySuggestionsBlockListOutput) SetCreatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetErrorMessage ¶

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetFileSizeBytes ¶

func (s *DescribeQuerySuggestionsBlockListOutput) SetFileSizeBytes(v int64) *DescribeQuerySuggestionsBlockListOutput

SetFileSizeBytes sets the FileSizeBytes field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetId ¶

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

SetId sets the Id field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetItemCount ¶

func (s *DescribeQuerySuggestionsBlockListOutput) SetItemCount(v int64) *DescribeQuerySuggestionsBlockListOutput

SetItemCount sets the ItemCount field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetName ¶

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

SetName sets the Name field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetSourceS3Path ¶

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

SetSourceS3Path sets the SourceS3Path field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetUpdatedAt ¶

func (s *DescribeQuerySuggestionsBlockListOutput) SetUpdatedAt(v time.Time) *DescribeQuerySuggestionsBlockListOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeQuerySuggestionsBlockListOutput) String ¶

func (s DescribeQuerySuggestionsBlockListOutput) String() string

String returns the string representation

type DescribeQuerySuggestionsConfigInput ¶

type DescribeQuerySuggestionsConfigInput struct {

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

func (DescribeQuerySuggestionsConfigInput) GoString ¶

func (s DescribeQuerySuggestionsConfigInput) GoString() string

GoString returns the string representation

func (*DescribeQuerySuggestionsConfigInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DescribeQuerySuggestionsConfigInput) String ¶

func (s DescribeQuerySuggestionsConfigInput) String() string

String returns the string representation

func (*DescribeQuerySuggestionsConfigInput) Validate ¶

func (s *DescribeQuerySuggestionsConfigInput) Validate() error

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

type DescribeQuerySuggestionsConfigOutput ¶

type DescribeQuerySuggestionsConfigOutput struct {

    // Shows whether Amazon Kendra uses all queries or only uses queries that include
    // user information to generate query suggestions.
    IncludeQueriesWithoutUserInformation *bool `type:"boolean"`

    // Shows the date-time query suggestions for an index was last cleared.
    //
    // After you clear suggestions, Amazon Kendra learns new suggestions based on
    // new queries added to the query log from the time you cleared suggestions.
    // Amazon Kendra only considers re-occurences of a query from the time you cleared
    // suggestions.
    LastClearTime *time.Time `type:"timestamp"`

    // Shows the date-time query suggestions for an index was last updated.
    LastSuggestionsBuildTime *time.Time `type:"timestamp"`

    // Shows the minimum number of unique users who must search a query in order
    // for the query to be eligible to suggest to your users.
    MinimumNumberOfQueryingUsers *int64 `min:"1" type:"integer"`

    // Shows the minimum number of times a query must be searched in order for the
    // query to be eligible to suggest to your users.
    MinimumQueryCount *int64 `min:"1" type:"integer"`

    // Shows whether query suggestions are currently in ENABLED mode or LEARN_ONLY
    // mode.
    //
    // By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off
    // query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig
    // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html)
    // operation.
    Mode *string `type:"string" enum:"Mode"`

    // Shows how recent your queries are in your query log time window (in days).
    QueryLogLookBackWindowInDays *int64 `type:"integer"`

    // Shows whether the status of query suggestions settings is currently Active
    // or Updating.
    //
    // Active means the current settings apply and Updating means your changed settings
    // are in the process of applying.
    Status *string `type:"string" enum:"QuerySuggestionsStatus"`

    // Shows the current total count of query suggestions for an index.
    //
    // This count can change when you update your query suggestions settings, if
    // you filter out certain queries from suggestions using a block list, and as
    // the query log accumulates more queries for Amazon Kendra to learn from.
    TotalSuggestionsCount *int64 `type:"integer"`
    // contains filtered or unexported fields
}

func (DescribeQuerySuggestionsConfigOutput) GoString ¶

func (s DescribeQuerySuggestionsConfigOutput) GoString() string

GoString returns the string representation

func (*DescribeQuerySuggestionsConfigOutput) SetIncludeQueriesWithoutUserInformation ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetIncludeQueriesWithoutUserInformation(v bool) *DescribeQuerySuggestionsConfigOutput

SetIncludeQueriesWithoutUserInformation sets the IncludeQueriesWithoutUserInformation field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetLastClearTime ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetLastClearTime(v time.Time) *DescribeQuerySuggestionsConfigOutput

SetLastClearTime sets the LastClearTime field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetLastSuggestionsBuildTime ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetLastSuggestionsBuildTime(v time.Time) *DescribeQuerySuggestionsConfigOutput

SetLastSuggestionsBuildTime sets the LastSuggestionsBuildTime field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMinimumNumberOfQueryingUsers ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumNumberOfQueryingUsers(v int64) *DescribeQuerySuggestionsConfigOutput

SetMinimumNumberOfQueryingUsers sets the MinimumNumberOfQueryingUsers field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMinimumQueryCount ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetMinimumQueryCount(v int64) *DescribeQuerySuggestionsConfigOutput

SetMinimumQueryCount sets the MinimumQueryCount field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMode ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetMode(v string) *DescribeQuerySuggestionsConfigOutput

SetMode sets the Mode field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetQueryLogLookBackWindowInDays ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetQueryLogLookBackWindowInDays(v int64) *DescribeQuerySuggestionsConfigOutput

SetQueryLogLookBackWindowInDays sets the QueryLogLookBackWindowInDays field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetTotalSuggestionsCount ¶

func (s *DescribeQuerySuggestionsConfigOutput) SetTotalSuggestionsCount(v int64) *DescribeQuerySuggestionsConfigOutput

SetTotalSuggestionsCount sets the TotalSuggestionsCount field's value.

func (DescribeQuerySuggestionsConfigOutput) String ¶

func (s DescribeQuerySuggestionsConfigOutput) String() string

String returns the string representation

type DescribeThesaurusInput ¶

type DescribeThesaurusInput struct {

    // The identifier of the thesaurus to describe.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

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

func (DescribeThesaurusInput) GoString ¶

func (s DescribeThesaurusInput) GoString() string

GoString returns the string representation

func (*DescribeThesaurusInput) SetId ¶

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

SetId sets the Id field's value.

func (*DescribeThesaurusInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (DescribeThesaurusInput) String ¶

func (s DescribeThesaurusInput) String() string

String returns the string representation

func (*DescribeThesaurusInput) Validate ¶

func (s *DescribeThesaurusInput) Validate() error

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

type DescribeThesaurusOutput ¶

type DescribeThesaurusOutput struct {

    // The Unix datetime that the thesaurus was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The thesaurus description.
    Description *string `type:"string"`

    // When the Status field value is FAILED, the ErrorMessage field provides more
    // information.
    ErrorMessage *string `min:"1" type:"string"`

    // The size of the thesaurus file in bytes.
    FileSizeBytes *int64 `type:"long"`

    // The identifier of the thesaurus.
    Id *string `min:"1" type:"string"`

    // The identifier of the index associated with the thesaurus to describe.
    IndexId *string `min:"36" type:"string"`

    // The thesaurus name.
    Name *string `min:"1" type:"string"`

    // An AWS Identity and Access Management (IAM) role that gives Amazon Kendra
    // permissions to access thesaurus file specified in SourceS3Path.
    RoleArn *string `min:"1" type:"string"`

    // Information required to find a specific file in an Amazon S3 bucket.
    SourceS3Path *S3Path `type:"structure"`

    // The current status of the thesaurus. When the value is ACTIVE, queries are
    // able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage
    // field provides more information.
    //
    // If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could
    // not ingest the new thesaurus file. The old thesaurus file is still active.
    Status *string `type:"string" enum:"ThesaurusStatus"`

    // The number of synonym rules in the thesaurus file.
    SynonymRuleCount *int64 `type:"long"`

    // The number of unique terms in the thesaurus file. For example, the synonyms
    // a,b,c and a=>d, the term count would be 4.
    TermCount *int64 `type:"long"`

    // The Unix datetime that the thesaurus was last updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

func (DescribeThesaurusOutput) GoString ¶

func (s DescribeThesaurusOutput) GoString() string

GoString returns the string representation

func (*DescribeThesaurusOutput) SetCreatedAt ¶

func (s *DescribeThesaurusOutput) SetCreatedAt(v time.Time) *DescribeThesaurusOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeThesaurusOutput) SetDescription ¶

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

SetDescription sets the Description field's value.

func (*DescribeThesaurusOutput) SetErrorMessage ¶

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeThesaurusOutput) SetFileSizeBytes ¶

func (s *DescribeThesaurusOutput) SetFileSizeBytes(v int64) *DescribeThesaurusOutput

SetFileSizeBytes sets the FileSizeBytes field's value.

func (*DescribeThesaurusOutput) SetId ¶

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

SetId sets the Id field's value.

func (*DescribeThesaurusOutput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*DescribeThesaurusOutput) SetName ¶

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

SetName sets the Name field's value.

func (*DescribeThesaurusOutput) SetRoleArn ¶

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeThesaurusOutput) SetSourceS3Path ¶

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

SetSourceS3Path sets the SourceS3Path field's value.

func (*DescribeThesaurusOutput) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*DescribeThesaurusOutput) SetSynonymRuleCount ¶

func (s *DescribeThesaurusOutput) SetSynonymRuleCount(v int64) *DescribeThesaurusOutput

SetSynonymRuleCount sets the SynonymRuleCount field's value.

func (*DescribeThesaurusOutput) SetTermCount ¶

func (s *DescribeThesaurusOutput) SetTermCount(v int64) *DescribeThesaurusOutput

SetTermCount sets the TermCount field's value.

func (*DescribeThesaurusOutput) SetUpdatedAt ¶

func (s *DescribeThesaurusOutput) SetUpdatedAt(v time.Time) *DescribeThesaurusOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeThesaurusOutput) String ¶

func (s DescribeThesaurusOutput) String() string

String returns the string representation

type Document ¶

type Document struct {

    // Information to use for user context filtering.
    AccessControlList []*Principal `type:"list"`

    // Custom attributes to apply to the document. Use the custom attributes to
    // provide additional information for searching, to provide facets for refining
    // searches, and to provide additional information in the query response.
    Attributes []*DocumentAttribute `type:"list"`

    // The contents of the document.
    //
    // Documents passed to the Blob parameter must be base64 encoded. Your code
    // might not need to encode the document file bytes if you're using an AWS SDK
    // to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint
    // directly using REST, you must base64 encode the contents before sending.
    //
    // Blob is automatically base64 encoded/decoded by the SDK.
    Blob []byte `type:"blob"`

    // The file type of the document in the Blob field.
    ContentType *string `type:"string" enum:"ContentType"`

    // A unique identifier of the document in the index.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // Information required to find a specific file in an Amazon S3 bucket.
    S3Path *S3Path `type:"structure"`

    // The title of the document.
    Title *string `type:"string"`
    // contains filtered or unexported fields
}

A document in an index.

func (Document) GoString ¶

func (s Document) GoString() string

GoString returns the string representation

func (*Document) SetAccessControlList ¶

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

SetAccessControlList sets the AccessControlList field's value.

func (*Document) SetAttributes ¶

func (s *Document) SetAttributes(v []*DocumentAttribute) *Document

SetAttributes sets the Attributes field's value.

func (*Document) SetBlob ¶

func (s *Document) SetBlob(v []byte) *Document

SetBlob sets the Blob field's value.

func (*Document) SetContentType ¶

func (s *Document) SetContentType(v string) *Document

SetContentType sets the ContentType field's value.

func (*Document) SetId ¶

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

SetId sets the Id field's value.

func (*Document) SetS3Path ¶

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

SetS3Path sets the S3Path field's value.

func (*Document) SetTitle ¶

func (s *Document) SetTitle(v string) *Document

SetTitle sets the Title field's value.

func (Document) String ¶

func (s Document) String() string

String returns the string representation

func (*Document) Validate ¶

func (s *Document) Validate() error

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

type DocumentAttribute ¶

type DocumentAttribute struct {

    // The identifier for the attribute.
    //
    // Key is a required field
    Key *string `min:"1" type:"string" required:"true"`

    // The value of the attribute.
    //
    // Value is a required field
    Value *DocumentAttributeValue `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

A custom attribute value assigned to a document.

func (DocumentAttribute) GoString ¶

func (s DocumentAttribute) GoString() string

GoString returns the string representation

func (*DocumentAttribute) SetKey ¶

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

SetKey sets the Key field's value.

func (*DocumentAttribute) SetValue ¶

func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute

SetValue sets the Value field's value.

func (DocumentAttribute) String ¶

func (s DocumentAttribute) String() string

String returns the string representation

func (*DocumentAttribute) Validate ¶

func (s *DocumentAttribute) Validate() error

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

type DocumentAttributeValue ¶

type DocumentAttributeValue struct {

    // A date expressed as an ISO 8601 string.
    //
    // It is important for the time zone to be included in the ISO 8601 date-time
    // format. For example, 20120325T123010+01:00 is the ISO 8601 date-time format
    // for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
    DateValue *time.Time `type:"timestamp"`

    // A long integer value.
    LongValue *int64 `type:"long"`

    // A list of strings.
    StringListValue []*string `type:"list"`

    // A string, such as "department".
    StringValue *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

The value of a custom document attribute. You can only provide one value for a custom attribute.

func (DocumentAttributeValue) GoString ¶

func (s DocumentAttributeValue) GoString() string

GoString returns the string representation

func (*DocumentAttributeValue) SetDateValue ¶

func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue

SetDateValue sets the DateValue field's value.

func (*DocumentAttributeValue) SetLongValue ¶

func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue

SetLongValue sets the LongValue field's value.

func (*DocumentAttributeValue) SetStringListValue ¶

func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue

SetStringListValue sets the StringListValue field's value.

func (*DocumentAttributeValue) SetStringValue ¶

func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue

SetStringValue sets the StringValue field's value.

func (DocumentAttributeValue) String ¶

func (s DocumentAttributeValue) String() string

String returns the string representation

func (*DocumentAttributeValue) Validate ¶

func (s *DocumentAttributeValue) Validate() error

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

type DocumentAttributeValueCountPair ¶

type DocumentAttributeValueCountPair struct {

    // The number of documents in the response that have the attribute value for
    // the key.
    Count *int64 `type:"integer"`

    // The value of the attribute. For example, "HR."
    DocumentAttributeValue *DocumentAttributeValue `type:"structure"`
    // contains filtered or unexported fields
}

Provides the count of documents that match a particular attribute when doing a faceted search.

func (DocumentAttributeValueCountPair) GoString ¶

func (s DocumentAttributeValueCountPair) GoString() string

GoString returns the string representation

func (*DocumentAttributeValueCountPair) SetCount ¶

func (s *DocumentAttributeValueCountPair) SetCount(v int64) *DocumentAttributeValueCountPair

SetCount sets the Count field's value.

func (*DocumentAttributeValueCountPair) SetDocumentAttributeValue ¶

func (s *DocumentAttributeValueCountPair) SetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeValueCountPair

SetDocumentAttributeValue sets the DocumentAttributeValue field's value.

func (DocumentAttributeValueCountPair) String ¶

func (s DocumentAttributeValueCountPair) String() string

String returns the string representation

type DocumentInfo ¶

type DocumentInfo struct {

    // Attributes that identify a specific version of a document to check.
    //
    // The only valid attributes are:
    //
    //    * version
    //
    //    * datasourceId
    //
    //    * jobExecutionId
    //
    // The attributes follow these rules:
    //
    //    * dataSourceId and jobExecutionId must be used together.
    //
    //    * version is ignored if dataSourceId and jobExecutionId are not provided.
    //
    //    * If dataSourceId and jobExecutionId are provided, but version is not,
    //    the version defaults to "0".
    Attributes []*DocumentAttribute `type:"list"`

    // The unique identifier of the document.
    //
    // DocumentId is a required field
    DocumentId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Identifies a document for which to retrieve status information

func (DocumentInfo) GoString ¶

func (s DocumentInfo) GoString() string

GoString returns the string representation

func (*DocumentInfo) SetAttributes ¶

func (s *DocumentInfo) SetAttributes(v []*DocumentAttribute) *DocumentInfo

SetAttributes sets the Attributes field's value.

func (*DocumentInfo) SetDocumentId ¶

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

SetDocumentId sets the DocumentId field's value.

func (DocumentInfo) String ¶

func (s DocumentInfo) String() string

String returns the string representation

func (*DocumentInfo) Validate ¶

func (s *DocumentInfo) Validate() error

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

type DocumentMetadataConfiguration ¶

type DocumentMetadataConfiguration struct {

    // The name of the index field.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // Provides manual tuning parameters to determine how the field affects the
    // search results.
    Relevance *Relevance `type:"structure"`

    // Provides information about how the field is used during a search.
    Search *Search `type:"structure"`

    // The data type of the index field.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"DocumentAttributeValueType"`
    // contains filtered or unexported fields
}

Specifies the properties of a custom index field.

func (DocumentMetadataConfiguration) GoString ¶

func (s DocumentMetadataConfiguration) GoString() string

GoString returns the string representation

func (*DocumentMetadataConfiguration) SetName ¶

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

SetName sets the Name field's value.

func (*DocumentMetadataConfiguration) SetRelevance ¶

func (s *DocumentMetadataConfiguration) SetRelevance(v *Relevance) *DocumentMetadataConfiguration

SetRelevance sets the Relevance field's value.

func (*DocumentMetadataConfiguration) SetSearch ¶

func (s *DocumentMetadataConfiguration) SetSearch(v *Search) *DocumentMetadataConfiguration

SetSearch sets the Search field's value.

func (*DocumentMetadataConfiguration) SetType ¶

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

SetType sets the Type field's value.

func (DocumentMetadataConfiguration) String ¶

func (s DocumentMetadataConfiguration) String() string

String returns the string representation

func (*DocumentMetadataConfiguration) Validate ¶

func (s *DocumentMetadataConfiguration) Validate() error

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

type DocumentRelevanceConfiguration ¶

type DocumentRelevanceConfiguration struct {

    // The name of the tuning configuration to override document relevance at the
    // index level.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // Provides information for manually tuning the relevance of a field in a search.
    // When a query includes terms that match the field, the results are given a
    // boost in the response based on these tuning parameters.
    //
    // Relevance is a required field
    Relevance *Relevance `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Overrides the document relevance properties of a custom index field.

func (DocumentRelevanceConfiguration) GoString ¶

func (s DocumentRelevanceConfiguration) GoString() string

GoString returns the string representation

func (*DocumentRelevanceConfiguration) SetName ¶

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

SetName sets the Name field's value.

func (*DocumentRelevanceConfiguration) SetRelevance ¶

func (s *DocumentRelevanceConfiguration) SetRelevance(v *Relevance) *DocumentRelevanceConfiguration

SetRelevance sets the Relevance field's value.

func (DocumentRelevanceConfiguration) String ¶

func (s DocumentRelevanceConfiguration) String() string

String returns the string representation

func (*DocumentRelevanceConfiguration) Validate ¶

func (s *DocumentRelevanceConfiguration) Validate() error

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

type DocumentsMetadataConfiguration ¶

type DocumentsMetadataConfiguration struct {

    // A prefix used to filter metadata configuration files in the AWS S3 bucket.
    // The S3 bucket might contain multiple metadata files. Use S3Prefix to include
    // only the desired metadata files.
    S3Prefix *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

func (DocumentsMetadataConfiguration) GoString ¶

func (s DocumentsMetadataConfiguration) GoString() string

GoString returns the string representation

func (*DocumentsMetadataConfiguration) SetS3Prefix ¶

func (s *DocumentsMetadataConfiguration) SetS3Prefix(v string) *DocumentsMetadataConfiguration

SetS3Prefix sets the S3Prefix field's value.

func (DocumentsMetadataConfiguration) String ¶

func (s DocumentsMetadataConfiguration) String() string

String returns the string representation

func (*DocumentsMetadataConfiguration) Validate ¶

func (s *DocumentsMetadataConfiguration) Validate() error

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

type Facet ¶

type Facet struct {

    // The unique key for the document attribute.
    DocumentAttributeKey *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Information about a document attribute

func (Facet) GoString ¶

func (s Facet) GoString() string

GoString returns the string representation

func (*Facet) SetDocumentAttributeKey ¶

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

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (Facet) String ¶

func (s Facet) String() string

String returns the string representation

func (*Facet) Validate ¶

func (s *Facet) Validate() error

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

type FacetResult ¶

type FacetResult struct {

    // The key for the facet values. This is the same as the DocumentAttributeKey
    // provided in the query.
    DocumentAttributeKey *string `min:"1" type:"string"`

    // An array of key/value pairs, where the key is the value of the attribute
    // and the count is the number of documents that share the key value.
    DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair `type:"list"`

    // The data type of the facet value. This is the same as the type defined for
    // the index field when it was created.
    DocumentAttributeValueType *string `type:"string" enum:"DocumentAttributeValueType"`
    // contains filtered or unexported fields
}

The facet values for the documents in the response.

func (FacetResult) GoString ¶

func (s FacetResult) GoString() string

GoString returns the string representation

func (*FacetResult) SetDocumentAttributeKey ¶

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

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*FacetResult) SetDocumentAttributeValueCountPairs ¶

func (s *FacetResult) SetDocumentAttributeValueCountPairs(v []*DocumentAttributeValueCountPair) *FacetResult

SetDocumentAttributeValueCountPairs sets the DocumentAttributeValueCountPairs field's value.

func (*FacetResult) SetDocumentAttributeValueType ¶

func (s *FacetResult) SetDocumentAttributeValueType(v string) *FacetResult

SetDocumentAttributeValueType sets the DocumentAttributeValueType field's value.

func (FacetResult) String ¶

func (s FacetResult) String() string

String returns the string representation

type FaqStatistics ¶

type FaqStatistics struct {

    // The total number of FAQ questions and answers contained in the index.
    //
    // IndexedQuestionAnswersCount is a required field
    IndexedQuestionAnswersCount *int64 `type:"integer" required:"true"`
    // contains filtered or unexported fields
}

Provides statistical information about the FAQ questions and answers contained in an index.

func (FaqStatistics) GoString ¶

func (s FaqStatistics) GoString() string

GoString returns the string representation

func (*FaqStatistics) SetIndexedQuestionAnswersCount ¶

func (s *FaqStatistics) SetIndexedQuestionAnswersCount(v int64) *FaqStatistics

SetIndexedQuestionAnswersCount sets the IndexedQuestionAnswersCount field's value.

func (FaqStatistics) String ¶

func (s FaqStatistics) String() string

String returns the string representation

type FaqSummary ¶

type FaqSummary struct {

    // The UNIX datetime that the FAQ was added to the index.
    CreatedAt *time.Time `type:"timestamp"`

    // The file type used to create the FAQ.
    FileFormat *string `type:"string" enum:"FaqFileFormat"`

    // The unique identifier of the FAQ.
    Id *string `min:"1" type:"string"`

    // The name that you assigned the FAQ when you created or updated the FAQ.
    Name *string `min:"1" type:"string"`

    // The current status of the FAQ. When the status is ACTIVE the FAQ is ready
    // for use.
    Status *string `type:"string" enum:"FaqStatus"`

    // The UNIX datetime that the FAQ was last updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides information about a frequently asked questions and answer contained in an index.

func (FaqSummary) GoString ¶

func (s FaqSummary) GoString() string

GoString returns the string representation

func (*FaqSummary) SetCreatedAt ¶

func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary

SetCreatedAt sets the CreatedAt field's value.

func (*FaqSummary) SetFileFormat ¶

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

SetFileFormat sets the FileFormat field's value.

func (*FaqSummary) SetId ¶

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

SetId sets the Id field's value.

func (*FaqSummary) SetName ¶

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

SetName sets the Name field's value.

func (*FaqSummary) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*FaqSummary) SetUpdatedAt ¶

func (s *FaqSummary) SetUpdatedAt(v time.Time) *FaqSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (FaqSummary) String ¶

func (s FaqSummary) String() string

String returns the string representation

type GetQuerySuggestionsInput ¶

type GetQuerySuggestionsInput struct {

    // The identifier of the index you want to get query suggestions from.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The maximum number of query suggestions you want to show to your users.
    MaxSuggestionsCount *int64 `type:"integer"`

    // The text of a user's query to generate query suggestions.
    //
    // A query is suggested if the query prefix matches what a user starts to type
    // as their query.
    //
    // Amazon Kendra does not show any suggestions if a user types fewer than two
    // characters or more than 60 characters. A query must also have at least one
    // search result and contain at least one word of more than four characters.
    //
    // QueryText is a required field
    QueryText *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetQuerySuggestionsInput) GoString ¶

func (s GetQuerySuggestionsInput) GoString() string

GoString returns the string representation

func (*GetQuerySuggestionsInput) SetIndexId ¶

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

SetIndexId sets the IndexId field's value.

func (*GetQuerySuggestionsInput) SetMaxSuggestionsCount ¶

func (s *GetQuerySuggestionsInput) SetMaxSuggestionsCount(v int64) *GetQuerySuggestionsInput

SetMaxSuggestionsCount sets the MaxSuggestionsCount field's value.

func (*GetQuerySuggestionsInput) SetQueryText ¶

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

SetQueryText sets the QueryText field's value.

func (GetQuerySuggestionsInput) String ¶

func (s GetQuerySuggestionsInput) String() string

String returns the string representation

func (*GetQuerySuggestionsInput) Validate ¶

func (s *GetQuerySuggestionsInput) Validate() error

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

type GetQuerySuggestionsOutput ¶

type GetQuerySuggestionsOutput struct {

    // The unique identifier for a list of query suggestions for an index.
    QuerySuggestionsId *string `min:"1" type:"string"`

    // A list of query suggestions for an index.
    Suggestions []*Suggestion `type:"list"`
    // contains filtered or unexported fields
}

func (GetQuerySuggestionsOutput) GoString ¶

func (s GetQuerySuggestionsOutput) GoString() string

GoString returns the string representation

func (*GetQuerySuggestionsOutput) SetQuerySuggestionsId ¶

func (s *GetQuerySuggestionsOutput) SetQuerySuggestionsId(v string) *GetQuerySuggestionsOutput

SetQuerySuggestionsId sets the QuerySuggestionsId field's value.

func (*GetQuerySuggestionsOutput) SetSuggestions ¶

func (s *GetQuerySuggestionsOutput) SetSuggestions(v []*Suggestion) *GetQuerySuggestionsOutput

SetSuggestions sets the Suggestions field's value.

func (GetQuerySuggestionsOutput) String ¶

func (s GetQuerySuggestionsOutput) String() string

String returns the string representation

type GoogleDriveConfiguration ¶

type GoogleDriveConfiguration struct {

    // A list of MIME types to exclude from the index. All documents matching the
    // specified MIME type are excluded.
    //
    // For a list of MIME types, see Using a Google Workspace Drive data source
    // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
    ExcludeMimeTypes []*string `type:"list"`

    // A list of identifiers or shared drives to exclude from the index. All files
    // and folders stored on the shared drive are excluded.
    ExcludeSharedDrives []*string `type:"list"`

    // A list of email addresses of the users. Documents owned by these users are
    // excluded from the index. Documents shared with excluded users are indexed
    // unless they are excluded in another way.
    ExcludeUserAccounts []*string `type:"list"`

    // A list of regular expression patterns that apply to the path on Google Drive.
    // Items that match the pattern are excluded from the index from both shared
    // drives and users' My Drives. Items that don't match the pattern are included
    // in the index. If an item matches both an exclusion pattern and an inclusion
    // pattern, it is excluded from the index.
    ExclusionPatterns []*string `type:"list"`

    // Defines mapping between a field in the Google Drive and a Amazon Kendra index
    // field.
    //
    // If you are using the console, you can define index fields when creating the
    // mapping. If you are using the API, you must first create the field using
    // the UpdateIndex operation.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of regular expression patterns that apply to path on Google Drive.
    // Items that match the pattern are included in the index from both shared drives
    // and users' My Drives. Items that don't match the pattern are excluded from
    // the index. If an item matches both an inclusion pattern and an exclusion
    // pattern, it is excluded from the index.
    InclusionPatterns []*string `type:"list"`

    // The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains
    // the credentials required to connect to Google Drive. For more information,
    // see Using a Google Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides configuration information for data sources that connect to Google Drive.

func (GoogleDriveConfiguration) GoString ¶

func (s GoogleDriveConfiguration) GoString() string

GoString returns the string representation

func (*GoogleDriveConfiguration) SetExcludeMimeTypes ¶

func (s *GoogleDriveConfiguration) SetExcludeMimeTypes(v []*string) *GoogleDriveConfiguration

SetExcludeMimeTypes sets the ExcludeMimeTypes field's value.

func (*GoogleDriveConfiguration) SetExcludeSharedDrives ¶

func (s *GoogleDriveConfiguration) SetExcludeSharedDrives(v []*string) *GoogleDriveConfiguration

SetExcludeSharedDrives sets the ExcludeSharedDrives field's value.

func (*GoogleDriveConfiguration) SetExcludeUserAccounts ¶

func (s *GoogleDriveConfiguration) SetExcludeUserAccounts(v []*string) *GoogleDriveConfiguration

SetExcludeUserAccounts sets the ExcludeUserAccounts field's value.

func (*GoogleDriveConfiguration) SetExclusionPatterns ¶

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*GoogleDriveConfiguration) SetFieldMappings ¶

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

SetFieldMappings sets the FieldMappings field's value.

func (*GoogleDriveConfiguration) SetInclusionPatterns ¶

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*GoogleDriveConfiguration) SetSecretArn ¶

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

SetSecretArn sets the SecretArn field's value.

func (GoogleDriveConfiguration) String ¶

func (s GoogleDriveConfiguration) String() string

String returns the string representation

func (*GoogleDriveConfiguration) Validate ¶

func (s *GoogleDriveConfiguration) Validate() error

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

type Highlight ¶

type Highlight struct {

    // The zero-based location in the response string where the highlight starts.
    //
    // BeginOffset is a required field
    BeginOffset *int64 `type:"integer" required:"true"`

    // The zero-based location in the response string where the highlight ends.
    //
    // EndOffset is a required field
    EndOffset *int64 `type:"integer" required:"true"`

    // Indicates whether the response is the best response. True if this is the
    // best response; otherwise, false.
    TopAnswer *bool `type:"boolean"`

    // The highlight type.
    Type *string `type:"string" enum:"HighlightType"`
    // contains filtered or unexported fields
}

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

func (Highlight) GoString ¶

func (s Highlight) GoString() string

GoString returns the string representation

func (*Highlight) SetBeginOffset ¶

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

SetBeginOffset sets the BeginOffset field's value.

func (*Highlight) SetEndOffset ¶

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

SetEndOffset sets the EndOffset field's value.

func (*Highlight) SetTopAnswer ¶

func (s *Highlight) SetTopAnswer(v bool) *Highlight

SetTopAnswer sets the TopAnswer field's value.

func (*Highlight) SetType ¶

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

SetType sets the Type field's value.

func (Highlight) String ¶

func (s Highlight) String() string

String returns the string representation

type IndexConfigurationSummary ¶

type IndexConfigurationSummary struct {

    // The Unix timestamp when the index was created.
    //
    // CreatedAt is a required field
    CreatedAt *time.Time `type:"timestamp" required:"true"`

    // Indicates whether the index is a enterprise edition index or a developer
    // edition index.
    Edition *string `type:"string" enum:"IndexEdition"`

    // A unique identifier for the index. Use this to identify the index when you
    // are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
    Id *string `min:"36" type:"string"`

    // The name of the index.
    Name *string `min:"1" type:"string"`

    // The current status of the index. When the status is ACTIVE, the index is
    // ready to search.
    //
    // Status is a required field
    Status *string `type:"string" required:"true" enum:"IndexStatus"`

    // The Unix timestamp when the index was last updated by the UpdateIndex operation.
    //
    // UpdatedAt is a required field
    UpdatedAt *time.Time `type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

A summary of information about an index.

func (IndexConfigurationSummary) GoString ¶

func (s IndexConfigurationSummary) GoString() string

GoString returns the string representation

func (*IndexConfigurationSummary) SetCreatedAt ¶

func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary

SetCreatedAt sets the CreatedAt field's value.

func (*IndexConfigurationSummary) SetEdition ¶

func (s *IndexConfigurationSummary) SetEdition(v string) *IndexConfigurationSummary

SetEdition sets the Edition field's value.

func (*IndexConfigurationSummary) SetId ¶

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

SetId sets the Id field's value.

func (*IndexConfigurationSummary) SetName ¶

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

SetName sets the Name field's value.

func (*IndexConfigurationSummary) SetStatus ¶

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

SetStatus sets the Status field's value.

func (*IndexConfigurationSummary) SetUpdatedAt ¶

func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (IndexConfigurationSummary) String ¶

func (s IndexConfigurationSummary) String() string

String returns the string representation

type IndexStatistics ¶

type IndexStatistics struct {

    // The number of question and answer topics in the index.
    //
    // FaqStatistics is a required field
    FaqStatistics *FaqStatistics `type:"structure" required:"true"`

    // The number of text documents indexed.
    //
    // TextDocumentStatistics is a required field
    TextDocumentStatistics *TextDocumentStatistics `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Provides information about the number of documents and the number of questions and answers in an index.

func (IndexStatistics) GoString ¶

func (s IndexStatistics) GoString() string

GoString returns the string representation

func (*IndexStatistics) SetFaqStatistics ¶

func (s *IndexStatistics) SetFaqStatistics(v *FaqStatistics) *IndexStatistics

SetFaqStatistics sets the FaqStatistics field's value.

func (*IndexStatistics) SetTextDocumentStatistics ¶

func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics

SetTextDocumentStatistics sets the TextDocumentStatistics field's value.

func (IndexStatistics) String ¶

func (s IndexStatistics) String() string

String returns the string representation

type InternalServerException ¶

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

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

func (*InternalServerException) Code ¶

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error ¶

func (s *InternalServerException) Error() string

func (InternalServerException) GoString ¶

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message ¶

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr ¶

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID ¶

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode ¶

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String ¶

func (s InternalServerException) String() string

String returns the string representation

type JsonTokenTypeConfiguration ¶

type JsonTokenTypeConfiguration struct {

    // The group attribute field.
    //
    // GroupAttributeField is a required field
    GroupAttributeField *string `min:"1" type:"string" required:"true"`

    // The user name attribute field.
    //
    // UserNameAttributeField is a required field
    UserNameAttributeField *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Configuration information for the JSON token type.

func (JsonTokenTypeConfiguration) GoString ¶

func (s JsonTokenTypeConfiguration) GoString() string

GoString returns the string representation

func (*JsonTokenTypeConfiguration) SetGroupAttributeField ¶

func (s *JsonTokenTypeConfiguration) SetGroupAttributeField(v string) *JsonTokenTypeConfiguration

SetGroupAttributeField sets the GroupAttributeField field's value.

func (*JsonTokenTypeConfiguration) SetUserNameAttributeField ¶

func (s *JsonTokenTypeConfiguration) SetUserNameAttributeField(v string) *JsonTokenTypeConfiguration

SetUserNameAttributeField sets the UserNameAttributeField field's value.

func (JsonTokenTypeConfiguration) String ¶

func (s JsonTokenTypeConfiguration) String() string

String returns the string representation

func (*JsonTokenTypeConfiguration) Validate ¶

func (s *JsonTokenTypeConfiguration) Validate() error

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

type JwtTokenTypeConfiguration ¶

type JwtTokenTypeConfiguration struct {

    // The regular expression that identifies the claim.
    ClaimRegex *string `min:"1" type:"string"`

    // The group attribute field.
    GroupAttributeField *string `min:"1" type:"string"`

    // The issuer of the token.
    Issuer *string `min:"1" type:"string"`

    // The location of the key.
    //
    // KeyLocation is a required field
    KeyLocation *string `type:"string" required:"true" enum:"KeyLocation"`

    // The Amazon Resource Name (arn) of the secret.
    SecretManagerArn *string `min:"1" type:"string"`

    // The signing key URL.
    URL *string `min:"1" type:"string"`

    // The user name attribute field.
    UserNameAttributeField *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Configuration information for the JWT token type.

func (JwtTokenTypeConfiguration) GoString ¶

func (s JwtTokenTypeConfiguration) GoString() string

GoString returns the string representation

func (*JwtTokenTypeConfiguration) SetClaimRegex ¶

func (s *JwtTokenTypeConfiguration) SetClaimRegex(v string) *JwtTokenTypeConfiguration

SetClaimRegex sets the ClaimRegex field's value.

func (*JwtTokenTypeConfiguration) SetGroupAttributeField ¶

func (s *JwtTokenTypeConfiguration) SetGroupAttributeField(v string) *JwtTokenTypeConfiguration

SetGroupAttributeField sets the GroupAttributeField field's value.

func (*JwtTokenTypeConfiguration) SetIssuer ¶

func (s *JwtTokenTypeConfiguration) SetIssuer(v string) *JwtTokenTypeConfiguration

SetIssuer sets the Issuer field's value.

func (*JwtTokenTypeConfiguration) SetKeyLocation ¶

func (s *JwtTokenTypeConfiguration) SetKeyLocation(v string) *JwtTokenTypeConfiguration

SetKeyLocation sets the KeyLocation field's value.

func (*JwtTokenTypeConfiguration) SetSecretManagerArn ¶

func (s *JwtTokenTypeConfiguration) SetSecretManagerArn(v string) *JwtTokenTypeConfiguration

SetSecretManagerArn sets the SecretManagerArn field's value.

func (*JwtTokenTypeConfiguration) SetURL ¶

func (s *JwtTokenTypeConfiguration) SetURL(v string) *JwtTokenTypeConfiguration

SetURL sets the URL field's value.

func (*JwtTokenTypeConfiguration) SetUserNameAttributeField ¶

func (s *JwtTokenTypeConfiguration) SetUserNameAttributeField(v string) *JwtTokenTypeConfiguration

SetUserNameAttributeField sets the UserNameAttributeField field's value.

func (JwtTokenTypeConfiguration) String ¶

func (s JwtTokenTypeConfiguration) String() string

String returns the string representation

func (*JwtTokenTypeConfiguration) Validate ¶

func (s *JwtTokenTypeConfiguration) Validate() error

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

type Kendra ¶

type Kendra struct {
    *client.Client
}

Kendra provides the API operation methods for making requests to AWSKendraFrontendService. See this package's package overview docs for details on the service.

Kendra methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New ¶

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Kendra

New creates a new instance of the Kendra client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a Kendra client from just a session.
svc := kendra.New(mySession)

// Create a Kendra client with additional configuration
svc := kendra.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Kendra) BatchDeleteDocument ¶

func (c *Kendra) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocument API operation for AWSKendraFrontendService.

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchDeleteDocument for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument

func (*Kendra) BatchDeleteDocumentRequest ¶

func (c *Kendra) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) (req *request.Request, output *BatchDeleteDocumentOutput)

BatchDeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteDocument for more information on using the BatchDeleteDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchDeleteDocumentRequest method.
req, resp := client.BatchDeleteDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument

func (*Kendra) BatchDeleteDocumentWithContext ¶

func (c *Kendra) BatchDeleteDocumentWithContext(ctx aws.Context, input *BatchDeleteDocumentInput, opts ...request.Option) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocumentWithContext is the same as BatchDeleteDocument with the addition of the ability to pass a context and additional request options.

See BatchDeleteDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchGetDocumentStatus ¶

func (c *Kendra) BatchGetDocumentStatus(input *BatchGetDocumentStatusInput) (*BatchGetDocumentStatusOutput, error)

BatchGetDocumentStatus API operation for AWSKendraFrontendService.

Returns the indexing status for one or more documents submitted with the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchGetDocumentStatus for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus

func (*Kendra) BatchGetDocumentStatusRequest ¶

func (c *Kendra) BatchGetDocumentStatusRequest(input *BatchGetDocumentStatusInput) (req *request.Request, output *BatchGetDocumentStatusOutput)

BatchGetDocumentStatusRequest generates a "aws/request.Request" representing the client's request for the BatchGetDocumentStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetDocumentStatus for more information on using the BatchGetDocumentStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetDocumentStatusRequest method.
req, resp := client.BatchGetDocumentStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus

func (*Kendra) BatchGetDocumentStatusWithContext ¶

func (c *Kendra) BatchGetDocumentStatusWithContext(ctx aws.Context, input *BatchGetDocumentStatusInput, opts ...request.Option) (*BatchGetDocumentStatusOutput, error)

BatchGetDocumentStatusWithContext is the same as BatchGetDocumentStatus with the addition of the ability to pass a context and additional request options.

See BatchGetDocumentStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchPutDocument ¶

func (c *Kendra) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error)

BatchPutDocument API operation for AWSKendraFrontendService.

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchPutDocument for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ServiceQuotaExceededException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument

func (*Kendra) BatchPutDocumentRequest ¶

func (c *Kendra) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req *request.Request, output *BatchPutDocumentOutput)

BatchPutDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchPutDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutDocument for more information on using the BatchPutDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchPutDocumentRequest method.
req, resp := client.BatchPutDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument

func (*Kendra) BatchPutDocumentWithContext ¶

func (c *Kendra) BatchPutDocumentWithContext(ctx aws.Context, input *BatchPutDocumentInput, opts ...request.Option) (*BatchPutDocumentOutput, error)

BatchPutDocumentWithContext is the same as BatchPutDocument with the addition of the ability to pass a context and additional request options.

See BatchPutDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ClearQuerySuggestions ¶

func (c *Kendra) ClearQuerySuggestions(input *ClearQuerySuggestionsInput) (*ClearQuerySuggestionsOutput, error)

ClearQuerySuggestions API operation for AWSKendraFrontendService.

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ClearQuerySuggestions for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* ConflictException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions

func (*Kendra) ClearQuerySuggestionsRequest ¶

func (c *Kendra) ClearQuerySuggestionsRequest(input *ClearQuerySuggestionsInput) (req *request.Request, output *ClearQuerySuggestionsOutput)

ClearQuerySuggestionsRequest generates a "aws/request.Request" representing the client's request for the ClearQuerySuggestions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ClearQuerySuggestions for more information on using the ClearQuerySuggestions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ClearQuerySuggestionsRequest method.
req, resp := client.ClearQuerySuggestionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions

func (*Kendra) ClearQuerySuggestionsWithContext ¶

func (c *Kendra) ClearQuerySuggestionsWithContext(ctx aws.Context, input *ClearQuerySuggestionsInput, opts ...request.Option) (*ClearQuerySuggestionsOutput, error)

ClearQuerySuggestionsWithContext is the same as ClearQuerySuggestions with the addition of the ability to pass a context and additional request options.

See ClearQuerySuggestions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateDataSource ¶

func (c *Kendra) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)

CreateDataSource API operation for AWSKendraFrontendService.

Creates a data source that you use to with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateDataSource for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ResourceAlreadyExistException

* ServiceQuotaExceededException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource

func (*Kendra) CreateDataSourceRequest ¶

func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *request.Request, output *CreateDataSourceOutput)

CreateDataSourceRequest generates a "aws/request.Request" representing the client's request for the CreateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDataSource for more information on using the CreateDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDataSourceRequest method.
req, resp := client.CreateDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource

func (*Kendra) CreateDataSourceWithContext ¶

func (c *Kendra) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataSourceInput, opts ...request.Option) (*CreateDataSourceOutput, error)

CreateDataSourceWithContext is the same as CreateDataSource with the addition of the ability to pass a context and additional request options.

See CreateDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateFaq ¶

func (c *Kendra) CreateFaq(input *CreateFaqInput) (*CreateFaqOutput, error)

CreateFaq API operation for AWSKendraFrontendService.

Creates an new set of frequently asked question (FAQ) questions and answers.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateFaq for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* ServiceQuotaExceededException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq

func (*Kendra) CreateFaqRequest ¶

func (c *Kendra) CreateFaqRequest(input *CreateFaqInput) (req *request.Request, output *CreateFaqOutput)

CreateFaqRequest generates a "aws/request.Request" representing the client's request for the CreateFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFaq for more information on using the CreateFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFaqRequest method.
req, resp := client.CreateFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq

func (*Kendra) CreateFaqWithContext ¶

func (c *Kendra) CreateFaqWithContext(ctx aws.Context, input *CreateFaqInput, opts ...request.Option) (*CreateFaqOutput, error)

CreateFaqWithContext is the same as CreateFaq with the addition of the ability to pass a context and additional request options.

See CreateFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateIndex ¶

func (c *Kendra) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)

CreateIndex API operation for AWSKendraFrontendService.

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateIndex for usage and error information.

Returned Error Types:

* ValidationException

* ResourceAlreadyExistException

* ServiceQuotaExceededException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex

func (*Kendra) CreateIndexRequest ¶

func (c *Kendra) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)

CreateIndexRequest generates a "aws/request.Request" representing the client's request for the CreateIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateIndex for more information on using the CreateIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateIndexRequest method.
req, resp := client.CreateIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex

func (*Kendra) CreateIndexWithContext ¶

func (c *Kendra) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)

CreateIndexWithContext is the same as CreateIndex with the addition of the ability to pass a context and additional request options.

See CreateIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateQuerySuggestionsBlockList ¶

func (c *Kendra) CreateQuerySuggestionsBlockList(input *CreateQuerySuggestionsBlockListInput) (*CreateQuerySuggestionsBlockListOutput, error)

CreateQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ServiceQuotaExceededException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList

func (*Kendra) CreateQuerySuggestionsBlockListRequest ¶

func (c *Kendra) CreateQuerySuggestionsBlockListRequest(input *CreateQuerySuggestionsBlockListInput) (req *request.Request, output *CreateQuerySuggestionsBlockListOutput)

CreateQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the CreateQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateQuerySuggestionsBlockList for more information on using the CreateQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateQuerySuggestionsBlockListRequest method.
req, resp := client.CreateQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList

func (*Kendra) CreateQuerySuggestionsBlockListWithContext ¶

func (c *Kendra) CreateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *CreateQuerySuggestionsBlockListInput, opts ...request.Option) (*CreateQuerySuggestionsBlockListOutput, error)

CreateQuerySuggestionsBlockListWithContext is the same as CreateQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See CreateQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateThesaurus ¶

func (c *Kendra) CreateThesaurus(input *CreateThesaurusInput) (*CreateThesaurusOutput, error)

CreateThesaurus API operation for AWSKendraFrontendService.

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateThesaurus for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* ServiceQuotaExceededException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus

func (*Kendra) CreateThesaurusRequest ¶

func (c *Kendra) CreateThesaurusRequest(input *CreateThesaurusInput) (req *request.Request, output *CreateThesaurusOutput)

CreateThesaurusRequest generates a "aws/request.Request" representing the client's request for the CreateThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateThesaurus for more information on using the CreateThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateThesaurusRequest method.
req, resp := client.CreateThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus

func (*Kendra) CreateThesaurusWithContext ¶

func (c *Kendra) CreateThesaurusWithContext(ctx aws.Context, input *CreateThesaurusInput, opts ...request.Option) (*CreateThesaurusOutput, error)

CreateThesaurusWithContext is the same as CreateThesaurus with the addition of the ability to pass a context and additional request options.

See CreateThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteDataSource ¶

func (c *Kendra) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)

DeleteDataSource API operation for AWSKendraFrontendService.

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteDataSource for usage and error information.

Returned Error Types:

* AccessDeniedException

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource

func (*Kendra) DeleteDataSourceRequest ¶

func (c *Kendra) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)

DeleteDataSourceRequest generates a "aws/request.Request" representing the client's request for the DeleteDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDataSource for more information on using the DeleteDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDataSourceRequest method.
req, resp := client.DeleteDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource

func (*Kendra) DeleteDataSourceWithContext ¶

func (c *Kendra) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)

DeleteDataSourceWithContext is the same as DeleteDataSource with the addition of the ability to pass a context and additional request options.

See DeleteDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteFaq ¶

func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error)

DeleteFaq API operation for AWSKendraFrontendService.

Removes an FAQ from an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteFaq for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq

func (*Kendra) DeleteFaqRequest ¶

func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput)

DeleteFaqRequest generates a "aws/request.Request" representing the client's request for the DeleteFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFaq for more information on using the DeleteFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFaqRequest method.
req, resp := client.DeleteFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq

func (*Kendra) DeleteFaqWithContext ¶

func (c *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error)

DeleteFaqWithContext is the same as DeleteFaq with the addition of the ability to pass a context and additional request options.

See DeleteFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteIndex ¶

func (c *Kendra) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)

DeleteIndex API operation for AWSKendraFrontendService.

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteIndex for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex

func (*Kendra) DeleteIndexRequest ¶

func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)

DeleteIndexRequest generates a "aws/request.Request" representing the client's request for the DeleteIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIndex for more information on using the DeleteIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteIndexRequest method.
req, resp := client.DeleteIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex

func (*Kendra) DeleteIndexWithContext ¶

func (c *Kendra) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)

DeleteIndexWithContext is the same as DeleteIndex with the addition of the ability to pass a context and additional request options.

See DeleteIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteQuerySuggestionsBlockList ¶

func (c *Kendra) DeleteQuerySuggestionsBlockList(input *DeleteQuerySuggestionsBlockListInput) (*DeleteQuerySuggestionsBlockListOutput, error)

DeleteQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList

func (*Kendra) DeleteQuerySuggestionsBlockListRequest ¶

func (c *Kendra) DeleteQuerySuggestionsBlockListRequest(input *DeleteQuerySuggestionsBlockListInput) (req *request.Request, output *DeleteQuerySuggestionsBlockListOutput)

DeleteQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the DeleteQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteQuerySuggestionsBlockList for more information on using the DeleteQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteQuerySuggestionsBlockListRequest method.
req, resp := client.DeleteQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList

func (*Kendra) DeleteQuerySuggestionsBlockListWithContext ¶

func (c *Kendra) DeleteQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DeleteQuerySuggestionsBlockListInput, opts ...request.Option) (*DeleteQuerySuggestionsBlockListOutput, error)

DeleteQuerySuggestionsBlockListWithContext is the same as DeleteQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See DeleteQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteThesaurus ¶

func (c *Kendra) DeleteThesaurus(input *DeleteThesaurusInput) (*DeleteThesaurusOutput, error)

DeleteThesaurus API operation for AWSKendraFrontendService.

Deletes an existing Amazon Kendra thesaurus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteThesaurus for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus

func (*Kendra) DeleteThesaurusRequest ¶

func (c *Kendra) DeleteThesaurusRequest(input *DeleteThesaurusInput) (req *request.Request, output *DeleteThesaurusOutput)

DeleteThesaurusRequest generates a "aws/request.Request" representing the client's request for the DeleteThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteThesaurus for more information on using the DeleteThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteThesaurusRequest method.
req, resp := client.DeleteThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus

func (*Kendra) DeleteThesaurusWithContext ¶

func (c *Kendra) DeleteThesaurusWithContext(ctx aws.Context, input *DeleteThesaurusInput, opts ...request.Option) (*DeleteThesaurusOutput, error)

DeleteThesaurusWithContext is the same as DeleteThesaurus with the addition of the ability to pass a context and additional request options.

See DeleteThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeDataSource ¶

func (c *Kendra) DescribeDataSource(input *DescribeDataSourceInput) (*DescribeDataSourceOutput, error)

DescribeDataSource API operation for AWSKendraFrontendService.

Gets information about a Amazon Kendra data source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeDataSource for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource

func (*Kendra) DescribeDataSourceRequest ¶

func (c *Kendra) DescribeDataSourceRequest(input *DescribeDataSourceInput) (req *request.Request, output *DescribeDataSourceOutput)

DescribeDataSourceRequest generates a "aws/request.Request" representing the client's request for the DescribeDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDataSource for more information on using the DescribeDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDataSourceRequest method.
req, resp := client.DescribeDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource

func (*Kendra) DescribeDataSourceWithContext ¶

func (c *Kendra) DescribeDataSourceWithContext(ctx aws.Context, input *DescribeDataSourceInput, opts ...request.Option) (*DescribeDataSourceOutput, error)

DescribeDataSourceWithContext is the same as DescribeDataSource with the addition of the ability to pass a context and additional request options.

See DescribeDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeFaq ¶

func (c *Kendra) DescribeFaq(input *DescribeFaqInput) (*DescribeFaqOutput, error)

DescribeFaq API operation for AWSKendraFrontendService.

Gets information about an FAQ list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeFaq for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq

func (*Kendra) DescribeFaqRequest ¶

func (c *Kendra) DescribeFaqRequest(input *DescribeFaqInput) (req *request.Request, output *DescribeFaqOutput)

DescribeFaqRequest generates a "aws/request.Request" representing the client's request for the DescribeFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFaq for more information on using the DescribeFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFaqRequest method.
req, resp := client.DescribeFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq

func (*Kendra) DescribeFaqWithContext ¶

func (c *Kendra) DescribeFaqWithContext(ctx aws.Context, input *DescribeFaqInput, opts ...request.Option) (*DescribeFaqOutput, error)

DescribeFaqWithContext is the same as DescribeFaq with the addition of the ability to pass a context and additional request options.

See DescribeFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeIndex ¶

func (c *Kendra) DescribeIndex(input *DescribeIndexInput) (*DescribeIndexOutput, error)

DescribeIndex API operation for AWSKendraFrontendService.

Describes an existing Amazon Kendra index

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeIndex for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex

func (*Kendra) DescribeIndexRequest ¶

func (c *Kendra) DescribeIndexRequest(input *DescribeIndexInput) (req *request.Request, output *DescribeIndexOutput)

DescribeIndexRequest generates a "aws/request.Request" representing the client's request for the DescribeIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIndex for more information on using the DescribeIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeIndexRequest method.
req, resp := client.DescribeIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex

func (*Kendra) DescribeIndexWithContext ¶

func (c *Kendra) DescribeIndexWithContext(ctx aws.Context, input *DescribeIndexInput, opts ...request.Option) (*DescribeIndexOutput, error)

DescribeIndexWithContext is the same as DescribeIndex with the addition of the ability to pass a context and additional request options.

See DescribeIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeQuerySuggestionsBlockList ¶

func (c *Kendra) DescribeQuerySuggestionsBlockList(input *DescribeQuerySuggestionsBlockListInput) (*DescribeQuerySuggestionsBlockListOutput, error)

DescribeQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Describes a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList

func (*Kendra) DescribeQuerySuggestionsBlockListRequest ¶

func (c *Kendra) DescribeQuerySuggestionsBlockListRequest(input *DescribeQuerySuggestionsBlockListInput) (req *request.Request, output *DescribeQuerySuggestionsBlockListOutput)

DescribeQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the DescribeQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQuerySuggestionsBlockList for more information on using the DescribeQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeQuerySuggestionsBlockListRequest method.
req, resp := client.DescribeQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList

func (*Kendra) DescribeQuerySuggestionsBlockListWithContext ¶

func (c *Kendra) DescribeQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DescribeQuerySuggestionsBlockListInput, opts ...request.Option) (*DescribeQuerySuggestionsBlockListOutput, error)

DescribeQuerySuggestionsBlockListWithContext is the same as DescribeQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See DescribeQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeQuerySuggestionsConfig ¶

func (c *Kendra) DescribeQuerySuggestionsConfig(input *DescribeQuerySuggestionsConfigInput) (*DescribeQuerySuggestionsConfigOutput, error)

DescribeQuerySuggestionsConfig API operation for AWSKendraFrontendService.

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeQuerySuggestionsConfig for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig

func (*Kendra) DescribeQuerySuggestionsConfigRequest ¶

func (c *Kendra) DescribeQuerySuggestionsConfigRequest(input *DescribeQuerySuggestionsConfigInput) (req *request.Request, output *DescribeQuerySuggestionsConfigOutput)

DescribeQuerySuggestionsConfigRequest generates a "aws/request.Request" representing the client's request for the DescribeQuerySuggestionsConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQuerySuggestionsConfig for more information on using the DescribeQuerySuggestionsConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeQuerySuggestionsConfigRequest method.
req, resp := client.DescribeQuerySuggestionsConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig

func (*Kendra) DescribeQuerySuggestionsConfigWithContext ¶

func (c *Kendra) DescribeQuerySuggestionsConfigWithContext(ctx aws.Context, input *DescribeQuerySuggestionsConfigInput, opts ...request.Option) (*DescribeQuerySuggestionsConfigOutput, error)

DescribeQuerySuggestionsConfigWithContext is the same as DescribeQuerySuggestionsConfig with the addition of the ability to pass a context and additional request options.

See DescribeQuerySuggestionsConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeThesaurus ¶

func (c *Kendra) DescribeThesaurus(input *DescribeThesaurusInput) (*DescribeThesaurusOutput, error)

DescribeThesaurus API operation for AWSKendraFrontendService.

Describes an existing Amazon Kendra thesaurus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeThesaurus for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus

func (*Kendra) DescribeThesaurusRequest ¶

func (c *Kendra) DescribeThesaurusRequest(input *DescribeThesaurusInput) (req *request.Request, output *DescribeThesaurusOutput)

DescribeThesaurusRequest generates a "aws/request.Request" representing the client's request for the DescribeThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeThesaurus for more information on using the DescribeThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeThesaurusRequest method.
req, resp := client.DescribeThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus

func (*Kendra) DescribeThesaurusWithContext ¶

func (c *Kendra) DescribeThesaurusWithContext(ctx aws.Context, input *DescribeThesaurusInput, opts ...request.Option) (*DescribeThesaurusOutput, error)

DescribeThesaurusWithContext is the same as DescribeThesaurus with the addition of the ability to pass a context and additional request options.

See DescribeThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) GetQuerySuggestions ¶

func (c *Kendra) GetQuerySuggestions(input *GetQuerySuggestionsInput) (*GetQuerySuggestionsOutput, error)

GetQuerySuggestions API operation for AWSKendraFrontendService.

Fetches the queries that are suggested to your users.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation GetQuerySuggestions for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ServiceQuotaExceededException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions

func (*Kendra) GetQuerySuggestionsRequest ¶

func (c *Kendra) GetQuerySuggestionsRequest(input *GetQuerySuggestionsInput) (req *request.Request, output *GetQuerySuggestionsOutput)

GetQuerySuggestionsRequest generates a "aws/request.Request" representing the client's request for the GetQuerySuggestions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQuerySuggestions for more information on using the GetQuerySuggestions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetQuerySuggestionsRequest method.
req, resp := client.GetQuerySuggestionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions

func (*Kendra) GetQuerySuggestionsWithContext ¶

func (c *Kendra) GetQuerySuggestionsWithContext(ctx aws.Context, input *GetQuerySuggestionsInput, opts ...request.Option) (*GetQuerySuggestionsOutput, error)

GetQuerySuggestionsWithContext is the same as GetQuerySuggestions with the addition of the ability to pass a context and additional request options.

See GetQuerySuggestions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourceSyncJobs ¶

func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobs API operation for AWSKendraFrontendService.

Gets statistics about synchronizing Amazon Kendra with a data source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSourceSyncJobs for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs

func (*Kendra) ListDataSourceSyncJobsPages ¶

func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error

ListDataSourceSyncJobsPages iterates over the pages of a ListDataSourceSyncJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSourceSyncJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDataSourceSyncJobs operation.
pageNum := 0
err := client.ListDataSourceSyncJobsPages(params,
    func(page *kendra.ListDataSourceSyncJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListDataSourceSyncJobsPagesWithContext ¶

func (c *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error

ListDataSourceSyncJobsPagesWithContext same as ListDataSourceSyncJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourceSyncJobsRequest ¶

func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput)

ListDataSourceSyncJobsRequest generates a "aws/request.Request" representing the client's request for the ListDataSourceSyncJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDataSourceSyncJobs for more information on using the ListDataSourceSyncJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDataSourceSyncJobsRequest method.
req, resp := client.ListDataSourceSyncJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs

func (*Kendra) ListDataSourceSyncJobsWithContext ¶

func (c *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobsWithContext is the same as ListDataSourceSyncJobs with the addition of the ability to pass a context and additional request options.

See ListDataSourceSyncJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSources ¶

func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)

ListDataSources API operation for AWSKendraFrontendService.

Lists the data sources that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSources for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* AccessDeniedException

* ThrottlingException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources

func (*Kendra) ListDataSourcesPages ¶

func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error

ListDataSourcesPages iterates over the pages of a ListDataSources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDataSources operation.
pageNum := 0
err := client.ListDataSourcesPages(params,
    func(page *kendra.ListDataSourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListDataSourcesPagesWithContext ¶

func (c *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error

ListDataSourcesPagesWithContext same as ListDataSourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourcesRequest ¶

func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)

ListDataSourcesRequest generates a "aws/request.Request" representing the client's request for the ListDataSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDataSources for more information on using the ListDataSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDataSourcesRequest method.
req, resp := client.ListDataSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources

func (*Kendra) ListDataSourcesWithContext ¶

func (c *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)

ListDataSourcesWithContext is the same as ListDataSources with the addition of the ability to pass a context and additional request options.

See ListDataSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListFaqs ¶

func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error)

ListFaqs API operation for AWSKendraFrontendService.

Gets a list of FAQ lists associated with an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListFaqs for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs

func (*Kendra) ListFaqsRequest ¶

func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput)

ListFaqsRequest generates a "aws/request.Request" representing the client's request for the ListFaqs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFaqs for more information on using the ListFaqs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFaqsRequest method.
req, resp := client.ListFaqsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs

func (*Kendra) ListFaqsWithContext ¶

func (c *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error)

ListFaqsWithContext is the same as ListFaqs with the addition of the ability to pass a context and additional request options.

See ListFaqs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListIndices ¶

func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)

ListIndices API operation for AWSKendraFrontendService.

Lists the Amazon Kendra indexes that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListIndices for usage and error information.

Returned Error Types:

* ValidationException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices

func (*Kendra) ListIndicesPages ¶

func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error

ListIndicesPages iterates over the pages of a ListIndices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListIndices operation.
pageNum := 0
err := client.ListIndicesPages(params,
    func(page *kendra.ListIndicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListIndicesPagesWithContext ¶

func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error

ListIndicesPagesWithContext same as ListIndicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListIndicesRequest ¶

func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)

ListIndicesRequest generates a "aws/request.Request" representing the client's request for the ListIndices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIndices for more information on using the ListIndices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIndicesRequest method.
req, resp := client.ListIndicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices

func (*Kendra) ListIndicesWithContext ¶

func (c *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)

ListIndicesWithContext is the same as ListIndices with the addition of the ability to pass a context and additional request options.

See ListIndices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListQuerySuggestionsBlockLists ¶

func (c *Kendra) ListQuerySuggestionsBlockLists(input *ListQuerySuggestionsBlockListsInput) (*ListQuerySuggestionsBlockListsOutput, error)

ListQuerySuggestionsBlockLists API operation for AWSKendraFrontendService.

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListQuerySuggestionsBlockLists for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists

func (*Kendra) ListQuerySuggestionsBlockListsRequest ¶

func (c *Kendra) ListQuerySuggestionsBlockListsRequest(input *ListQuerySuggestionsBlockListsInput) (req *request.Request, output *ListQuerySuggestionsBlockListsOutput)

ListQuerySuggestionsBlockListsRequest generates a "aws/request.Request" representing the client's request for the ListQuerySuggestionsBlockLists operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListQuerySuggestionsBlockLists for more information on using the ListQuerySuggestionsBlockLists API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListQuerySuggestionsBlockListsRequest method.
req, resp := client.ListQuerySuggestionsBlockListsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists

func (*Kendra) ListQuerySuggestionsBlockListsWithContext ¶

func (c *Kendra) ListQuerySuggestionsBlockListsWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, opts ...request.Option) (*ListQuerySuggestionsBlockListsOutput, error)

ListQuerySuggestionsBlockListsWithContext is the same as ListQuerySuggestionsBlockLists with the addition of the ability to pass a context and additional request options.

See ListQuerySuggestionsBlockLists for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListTagsForResource ¶

func (c *Kendra) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWSKendraFrontendService.

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListTagsForResource for usage and error information.

Returned Error Types:

* ValidationException

* ResourceUnavailableException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource

func (*Kendra) ListTagsForResourceRequest ¶

func (c *Kendra) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource

func (*Kendra) ListTagsForResourceWithContext ¶

func (c *Kendra) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListThesauri ¶

func (c *Kendra) ListThesauri(input *ListThesauriInput) (*ListThesauriOutput, error)

ListThesauri API operation for AWSKendraFrontendService.

Lists the Amazon Kendra thesauri associated with an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListThesauri for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri

func (*Kendra) ListThesauriRequest ¶

func (c *Kendra) ListThesauriRequest(input *ListThesauriInput) (req *request.Request, output *ListThesauriOutput)

ListThesauriRequest generates a "aws/request.Request" representing the client's request for the ListThesauri operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThesauri for more information on using the ListThesauri API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListThesauriRequest method.
req, resp := client.ListThesauriRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri

func (*Kendra) ListThesauriWithContext ¶

func (c *Kendra) ListThesauriWithContext(ctx aws.Context, input *ListThesauriInput, opts ...request.Option) (*ListThesauriOutput, error)

ListThesauriWithContext is the same as ListThesauri with the addition of the ability to pass a context and additional request options.

See ListThesauri for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) Query ¶

func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error)

Query API operation for AWSKendraFrontendService.

Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.