...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/kendra"
Overview
Constants

Overview ▾

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

Amazon Kendra is a service for indexing large document sets.

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

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

Using the Client

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

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

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

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

The stub package, kendraiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type Kendra
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Kendra
func (c *Kendra) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)
func (c *Kendra) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) (req *request.Request, output *BatchDeleteDocumentOutput)
func (c *Kendra) BatchDeleteDocumentWithContext(ctx aws.Context, input *BatchDeleteDocumentInput, opts ...request.Option) (*BatchDeleteDocumentOutput, error)
func (c *Kendra) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error)
func (c *Kendra) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req *request.Request, output *BatchPutDocumentOutput)
func (c *Kendra) BatchPutDocumentWithContext(ctx aws.Context, input *BatchPutDocumentInput, opts ...request.Option) (*BatchPutDocumentOutput, error)
func (c *Kendra) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)
func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *request.Request, output *CreateDataSourceOutput)
func (c *Kendra) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataSourceInput, opts ...request.Option) (*CreateDataSourceOutput, error)
func (c *Kendra) CreateFaq(input *CreateFaqInput) (*CreateFaqOutput, error)
func (c *Kendra) CreateFaqRequest(input *CreateFaqInput) (req *request.Request, output *CreateFaqOutput)
func (c *Kendra) CreateFaqWithContext(ctx aws.Context, input *CreateFaqInput, opts ...request.Option) (*CreateFaqOutput, error)
func (c *Kendra) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)
func (c *Kendra) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)
func (c *Kendra) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)
func (c *Kendra) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)
func (c *Kendra) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)
func (c *Kendra) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)
func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error)
func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput)
func (c *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error)
func (c *Kendra) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)
func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)
func (c *Kendra) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)
func (c *Kendra) DescribeDataSource(input *DescribeDataSourceInput) (*DescribeDataSourceOutput, error)
func (c *Kendra) DescribeDataSourceRequest(input *DescribeDataSourceInput) (req *request.Request, output *DescribeDataSourceOutput)
func (c *Kendra) DescribeDataSourceWithContext(ctx aws.Context, input *DescribeDataSourceInput, opts ...request.Option) (*DescribeDataSourceOutput, error)
func (c *Kendra) DescribeFaq(input *DescribeFaqInput) (*DescribeFaqOutput, error)
func (c *Kendra) DescribeFaqRequest(input *DescribeFaqInput) (req *request.Request, output *DescribeFaqOutput)
func (c *Kendra) DescribeFaqWithContext(ctx aws.Context, input *DescribeFaqInput, opts ...request.Option) (*DescribeFaqOutput, error)
func (c *Kendra) DescribeIndex(input *DescribeIndexInput) (*DescribeIndexOutput, error)
func (c *Kendra) DescribeIndexRequest(input *DescribeIndexInput) (req *request.Request, output *DescribeIndexOutput)
func (c *Kendra) DescribeIndexWithContext(ctx aws.Context, input *DescribeIndexInput, opts ...request.Option) (*DescribeIndexOutput, error)
func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error)
func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error
func (c *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput)
func (c *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error)
func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)
func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error
func (c *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)
func (c *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)
func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error)
func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput)
func (c *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error)
func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)
func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error
func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)
func (c *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)
func (c *Kendra) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
func (c *Kendra) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
func (c *Kendra) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error)
func (c *Kendra) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput)
func (c *Kendra) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error)
func (c *Kendra) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error)
func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput)
func (c *Kendra) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error)
func (c *Kendra) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error)
func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput)
func (c *Kendra) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error)
func (c *Kendra) SubmitFeedback(input *SubmitFeedbackInput) (*SubmitFeedbackOutput, error)
func (c *Kendra) SubmitFeedbackRequest(input *SubmitFeedbackInput) (req *request.Request, output *SubmitFeedbackOutput)
func (c *Kendra) SubmitFeedbackWithContext(ctx aws.Context, input *SubmitFeedbackInput, opts ...request.Option) (*SubmitFeedbackOutput, error)
func (c *Kendra) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
func (c *Kendra) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
func (c *Kendra) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
func (c *Kendra) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
func (c *Kendra) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
func (c *Kendra) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
func (c *Kendra) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)
func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)
func (c *Kendra) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)
func (c *Kendra) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error)
func (c *Kendra) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput)
func (c *Kendra) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error)
func AdditionalResultAttributeValueType_Values() []string
func ConfluenceAttachmentFieldName_Values() []string
func ConfluenceBlogFieldName_Values() []string
func ConfluencePageFieldName_Values() []string
func ConfluenceSpaceFieldName_Values() []string
func ConfluenceVersion_Values() []string
func ContentType_Values() []string
func DataSourceStatus_Values() []string
func DataSourceSyncJobStatus_Values() []string
func DataSourceType_Values() []string
func DatabaseEngineType_Values() []string
func DocumentAttributeValueType_Values() []string
func ErrorCode_Values() []string
func FaqFileFormat_Values() []string
func FaqStatus_Values() []string
func IndexEdition_Values() []string
func IndexStatus_Values() []string
func Order_Values() []string
func PrincipalType_Values() []string
func QueryIdentifiersEnclosingOption_Values() []string
func QueryResultType_Values() []string
func ReadAccessType_Values() []string
func RelevanceType_Values() []string
func SalesforceChatterFeedIncludeFilterType_Values() []string
func SalesforceKnowledgeArticleState_Values() []string
func SalesforceStandardObjectName_Values() []string
func ScoreConfidence_Values() []string
func ServiceNowBuildVersionType_Values() []string
func SharePointVersion_Values() []string
func SortOrder_Values() []string
type AccessControlListConfiguration
type AccessDeniedException
type AclConfiguration
type AdditionalResultAttribute
type AdditionalResultAttributeValue
type AttributeFilter
type BatchDeleteDocumentInput
type BatchDeleteDocumentOutput
type BatchDeleteDocumentResponseFailedDocument
type BatchPutDocumentInput
type BatchPutDocumentOutput
type BatchPutDocumentResponseFailedDocument
type CapacityUnitsConfiguration
type ClickFeedback
type ColumnConfiguration
type ConflictException
type ConfluenceAttachmentConfiguration
type ConfluenceAttachmentToIndexFieldMapping
type ConfluenceBlogConfiguration
type ConfluenceBlogToIndexFieldMapping
type ConfluenceConfiguration
type ConfluencePageConfiguration
type ConfluencePageToIndexFieldMapping
type ConfluenceSpaceConfiguration
type ConfluenceSpaceToIndexFieldMapping
type ConnectionConfiguration
type CreateDataSourceInput
type CreateDataSourceOutput
type CreateFaqInput
type CreateFaqOutput
type CreateIndexInput
type CreateIndexOutput
type DataSourceConfiguration
type DataSourceSummary
type DataSourceSyncJob
type DataSourceSyncJobMetricTarget
type DataSourceSyncJobMetrics
type DataSourceToIndexFieldMapping
type DataSourceVpcConfiguration
type DatabaseConfiguration
type DeleteDataSourceInput
type DeleteDataSourceOutput
type DeleteFaqInput
type DeleteFaqOutput
type DeleteIndexInput
type DeleteIndexOutput
type DescribeDataSourceInput
type DescribeDataSourceOutput
type DescribeFaqInput
type DescribeFaqOutput
type DescribeIndexInput
type DescribeIndexOutput
type Document
type DocumentAttribute
type DocumentAttributeValue
type DocumentAttributeValueCountPair
type DocumentMetadataConfiguration
type DocumentsMetadataConfiguration
type Facet
type FacetResult
type FaqStatistics
type FaqSummary
type Highlight
type IndexConfigurationSummary
type IndexStatistics
type InternalServerException
type ListDataSourceSyncJobsInput
type ListDataSourceSyncJobsOutput
type ListDataSourcesInput
type ListDataSourcesOutput
type ListFaqsInput
type ListFaqsOutput
type ListIndicesInput
type ListIndicesOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type OneDriveConfiguration
type OneDriveUsers
type Principal
type QueryInput
type QueryOutput
type QueryResultItem
type Relevance
type RelevanceFeedback
type ResourceAlreadyExistException
type ResourceInUseException
type ResourceNotFoundException
type ResourceUnavailableException
type S3DataSourceConfiguration
type S3Path
type SalesforceChatterFeedConfiguration
type SalesforceConfiguration
type SalesforceCustomKnowledgeArticleTypeConfiguration
type SalesforceKnowledgeArticleConfiguration
type SalesforceStandardKnowledgeArticleTypeConfiguration
type SalesforceStandardObjectAttachmentConfiguration
type SalesforceStandardObjectConfiguration
type ScoreAttributes
type Search
type ServerSideEncryptionConfiguration
type ServiceNowConfiguration
type ServiceNowKnowledgeArticleConfiguration
type ServiceNowServiceCatalogConfiguration
type ServiceQuotaExceededException
type SharePointConfiguration
type SortingConfiguration
type SqlConfiguration
type StartDataSourceSyncJobInput
type StartDataSourceSyncJobOutput
type StopDataSourceSyncJobInput
type StopDataSourceSyncJobOutput
type SubmitFeedbackInput
type SubmitFeedbackOutput
type Tag
type TagResourceInput
type TagResourceOutput
type TextDocumentStatistics
type TextWithHighlights
type ThrottlingException
type TimeRange
type UntagResourceInput
type UntagResourceOutput
type UpdateDataSourceInput
type UpdateDataSourceOutput
type UpdateIndexInput
type UpdateIndexOutput
type ValidationException

Constants ▾

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

Enumeration for query score confidence.

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 (

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

Service information constants

const (
    // AdditionalResultAttributeValueTypeTextWithHighlightsValue is a AdditionalResultAttributeValueType enum value
    AdditionalResultAttributeValueTypeTextWithHighlightsValue = "TEXT_WITH_HIGHLIGHTS_VALUE"
)
const (
    // ConfluenceVersionServer is a ConfluenceVersion enum value
    ConfluenceVersionServer = "SERVER"
)
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 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 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 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 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 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

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.

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 BatchPutDocumentInput

type BatchPutDocumentInput struct {

    // One or more documents to add to the index.
    //
    // 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 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 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 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 data 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 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 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 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 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"`
    // 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) 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 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"`

    // Provided 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) 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 ATIVE 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 .

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.
    //
    // DataSourceSyncJobId is a required field
    DataSourceSyncJobId *string `min:"1" type:"string" required:"true"`
    // 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 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 edtion 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"`
    // 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) String

func (s DescribeIndexOutput) 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.
    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 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 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 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"`
    // 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) 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 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 releated 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) 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) 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 . 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 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) 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 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) 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) 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) 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) 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.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

* Relevant passages

* Matching FAQs

* Relevant documents

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

Each query returns the 100 most relevant results.

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

See the AWS API reference guide for AWSKendraFrontendService's API operation Query 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/Query

func (*Kendra) QueryRequest

func (c *Kendra) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput)

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

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

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

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

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

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

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

func (*Kendra) QueryWithContext

func (c *Kendra) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error)

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

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

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

func (*Kendra) StartDataSourceSyncJob

func (c *Kendra) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error)

StartDataSourceSyncJob API operation for AWSKendraFrontendService.

Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

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

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

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ResourceInUseException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

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

func (*Kendra) StartDataSourceSyncJobRequest

func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInput) (req *request.Request, output *StartDataSourceSyncJobOutput)

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

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

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

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

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

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

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

func (*Kendra) StartDataSourceSyncJobWithContext

func (c *Kendra) StartDataSourceSyncJobWithContext(ctx aws.Context, input *StartDataSourceSyncJobInput, opts ...request.Option) (*StartDataSourceSyncJobOutput, error)

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

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

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

func (*Kendra) StopDataSourceSyncJob

func (c *Kendra) StopDataSourceSyncJob(input *StopDataSourceSyncJobInput) (*StopDataSourceSyncJobOutput, error)

StopDataSourceSyncJob API operation for AWSKendraFrontendService.

Stops a running synchronization job. You can't stop a scheduled synchronization job.

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

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

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

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

func (*Kendra) StopDataSourceSyncJobRequest

func (c *Kendra) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInput) (req *request.Request, output *StopDataSourceSyncJobOutput)

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

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

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

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

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

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

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

func (*Kendra) StopDataSourceSyncJobWithContext

func (c *Kendra) StopDataSourceSyncJobWithContext(ctx aws.Context, input *StopDataSourceSyncJobInput, opts ...request.Option) (*StopDataSourceSyncJobOutput, error)

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

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

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

func (*Kendra) SubmitFeedback

func (c *Kendra) SubmitFeedback(input *SubmitFeedbackInput) (*SubmitFeedbackOutput, error)

SubmitFeedback API operation for AWSKendraFrontendService.

Enables you to provide feedback to Amazon Kendra to improve the performance of the service.

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

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

Returned Error Types:

* ValidationException

* ResourceUnavailableException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

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

func (*Kendra) SubmitFeedbackRequest

func (c *Kendra) SubmitFeedbackRequest(input *SubmitFeedbackInput) (req *request.Request, output *SubmitFeedbackOutput)

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

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

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

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

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

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

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

func (*Kendra) SubmitFeedbackWithContext

func (c *Kendra) SubmitFeedbackWithContext(ctx aws.Context, input *SubmitFeedbackInput, opts ...request.Option) (*SubmitFeedbackOutput, error)

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

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

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

func (*Kendra) TagResource

func (c *Kendra) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWSKendraFrontendService.

Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.

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

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

Returned Error Types:

* ValidationException

* ResourceUnavailableException

* ThrottlingException

* AccessDeniedException

* InternalServerException

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

func (*Kendra) TagResourceRequest

func (c *Kendra) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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

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

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

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

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

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

func (*Kendra) TagResourceWithContext

func (c *Kendra) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

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

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

func (*Kendra) UntagResource

func (c *Kendra) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWSKendraFrontendService.

Removes a tag from an index, FAQ, or a data source.

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

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

Returned Error Types:

* ValidationException

* ResourceUnavailableException

* ThrottlingException

* AccessDeniedException

* InternalServerException

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

func (*Kendra) UntagResourceRequest

func (c *Kendra) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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

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

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

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

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

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

func (*Kendra) UntagResourceWithContext

func (c *Kendra) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

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

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

func (*Kendra) UpdateDataSource

func (c *Kendra) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)

UpdateDataSource API operation for AWSKendraFrontendService.

Updates an existing 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 UpdateDataSource 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/UpdateDataSource

func (*Kendra) UpdateDataSourceRequest

func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)

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

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

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

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

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

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

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

func (*Kendra) UpdateDataSourceWithContext

func (c *Kendra) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)

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

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

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

func (*Kendra) UpdateIndex

func (c *Kendra) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error)

UpdateIndex API operation for AWSKendraFrontendService.

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

func (*Kendra) UpdateIndexRequest

func (c *Kendra) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Request, output *UpdateIndexOutput)

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

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

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

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

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

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

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

func (*Kendra) UpdateIndexWithContext

func (c *Kendra) UpdateIndexWithContext(ctx aws.Context, input *UpdateIndexInput, opts ...request.Option) (*UpdateIndexOutput, error)

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

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

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

type ListDataSourceSyncJobsInput

type ListDataSourceSyncJobsInput struct {

    // The identifier of the data source.
    //
    // 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"`

    // The maximum number of synchronization jobs to return in the response. If
    // there are fewer results in the list, this response contains only the actual
    // results.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the result of the previous request to GetDataSourceSyncJobHistory was
    // truncated, include the NextToken to fetch the next set of jobs.
    NextToken *string `min:"1" type:"string"`

    // When specified, the synchronization jobs returned in the list are limited
    // to jobs between the specified dates.
    StartTimeFilter *TimeRange `type:"structure"`

    // When specified, only returns synchronization jobs with the Status field equal
    // to the specified status.
    StatusFilter *string `type:"string" enum:"DataSourceSyncJobStatus"`
    // contains filtered or unexported fields
}

func (ListDataSourceSyncJobsInput) GoString

func (s ListDataSourceSyncJobsInput) GoString() string

GoString returns the string representation

func (*ListDataSourceSyncJobsInput) SetId

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

SetId sets the Id field's value.

func (*ListDataSourceSyncJobsInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*ListDataSourceSyncJobsInput) SetMaxResults

func (s *ListDataSourceSyncJobsInput) SetMaxResults(v int64) *ListDataSourceSyncJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourceSyncJobsInput) SetNextToken

func (s *ListDataSourceSyncJobsInput) SetNextToken(v string) *ListDataSourceSyncJobsInput

SetNextToken sets the NextToken field's value.

func (*ListDataSourceSyncJobsInput) SetStartTimeFilter

func (s *ListDataSourceSyncJobsInput) SetStartTimeFilter(v *TimeRange) *ListDataSourceSyncJobsInput

SetStartTimeFilter sets the StartTimeFilter field's value.

func (*ListDataSourceSyncJobsInput) SetStatusFilter

func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput

SetStatusFilter sets the StatusFilter field's value.

func (ListDataSourceSyncJobsInput) String

func (s ListDataSourceSyncJobsInput) String() string

String returns the string representation

func (*ListDataSourceSyncJobsInput) Validate

func (s *ListDataSourceSyncJobsInput) Validate() error

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

type ListDataSourceSyncJobsOutput

type ListDataSourceSyncJobsOutput struct {

    // A history of synchronization jobs for the data source.
    History []*DataSourceSyncJob `type:"list"`

    // The GetDataSourceSyncJobHistory operation returns a page of vocabularies
    // at a time. The maximum size of the page is set by the MaxResults parameter.
    // If there are more jobs in the list than the page size, Amazon Kendra returns
    // the NextPage token. Include the token in the next request to the GetDataSourceSyncJobHistory
    // operation to return in the next page of jobs.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListDataSourceSyncJobsOutput) GoString

func (s ListDataSourceSyncJobsOutput) GoString() string

GoString returns the string representation

func (*ListDataSourceSyncJobsOutput) SetHistory

func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput

SetHistory sets the History field's value.

func (*ListDataSourceSyncJobsOutput) SetNextToken

func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyncJobsOutput

SetNextToken sets the NextToken field's value.

func (ListDataSourceSyncJobsOutput) String

func (s ListDataSourceSyncJobsOutput) String() string

String returns the string representation

type ListDataSourcesInput

type ListDataSourcesInput struct {

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

    // The maximum number of data sources to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of data sources (DataSourceSummaryItems).
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListDataSourcesInput) GoString

func (s ListDataSourcesInput) GoString() string

GoString returns the string representation

func (*ListDataSourcesInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*ListDataSourcesInput) SetMaxResults

func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourcesInput) SetNextToken

func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput

SetNextToken sets the NextToken field's value.

func (ListDataSourcesInput) String

func (s ListDataSourcesInput) String() string

String returns the string representation

func (*ListDataSourcesInput) Validate

func (s *ListDataSourcesInput) Validate() error

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

type ListDataSourcesOutput

type ListDataSourcesOutput struct {

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of data sources.
    NextToken *string `min:"1" type:"string"`

    // An array of summary information for one or more data sources.
    SummaryItems []*DataSourceSummary `type:"list"`
    // contains filtered or unexported fields
}

func (ListDataSourcesOutput) GoString

func (s ListDataSourcesOutput) GoString() string

GoString returns the string representation

func (*ListDataSourcesOutput) SetNextToken

func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListDataSourcesOutput) SetSummaryItems

func (s *ListDataSourcesOutput) SetSummaryItems(v []*DataSourceSummary) *ListDataSourcesOutput

SetSummaryItems sets the SummaryItems field's value.

func (ListDataSourcesOutput) String

func (s ListDataSourcesOutput) String() string

String returns the string representation

type ListFaqsInput

type ListFaqsInput struct {

    // The index that contains the FAQ lists.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The maximum number of FAQs to return in the response. If there are fewer
    // results in the list, this response contains only the actual results.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the result of the previous request to ListFaqs was truncated, include
    // the NextToken to fetch the next set of FAQs.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListFaqsInput) GoString

func (s ListFaqsInput) GoString() string

GoString returns the string representation

func (*ListFaqsInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*ListFaqsInput) SetMaxResults

func (s *ListFaqsInput) SetMaxResults(v int64) *ListFaqsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFaqsInput) SetNextToken

func (s *ListFaqsInput) SetNextToken(v string) *ListFaqsInput

SetNextToken sets the NextToken field's value.

func (ListFaqsInput) String

func (s ListFaqsInput) String() string

String returns the string representation

func (*ListFaqsInput) Validate

func (s *ListFaqsInput) Validate() error

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

type ListFaqsOutput

type ListFaqsOutput struct {

    // information about the FAQs associated with the specified index.
    FaqSummaryItems []*FaqSummary `type:"list"`

    // The ListFaqs operation returns a page of FAQs at a time. The maximum size
    // of the page is set by the MaxResults parameter. If there are more jobs in
    // the list than the page size, Amazon Kendra returns the NextPage token. Include
    // the token in the next request to the ListFaqs operation to return the next
    // page of FAQs.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListFaqsOutput) GoString

func (s ListFaqsOutput) GoString() string

GoString returns the string representation

func (*ListFaqsOutput) SetFaqSummaryItems

func (s *ListFaqsOutput) SetFaqSummaryItems(v []*FaqSummary) *ListFaqsOutput

SetFaqSummaryItems sets the FaqSummaryItems field's value.

func (*ListFaqsOutput) SetNextToken

func (s *ListFaqsOutput) SetNextToken(v string) *ListFaqsOutput

SetNextToken sets the NextToken field's value.

func (ListFaqsOutput) String

func (s ListFaqsOutput) String() string

String returns the string representation

type ListIndicesInput

type ListIndicesInput struct {

    // The maximum number of data sources to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of indexes (DataSourceSummaryItems).
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListIndicesInput) GoString

func (s ListIndicesInput) GoString() string

GoString returns the string representation

func (*ListIndicesInput) SetMaxResults

func (s *ListIndicesInput) SetMaxResults(v int64) *ListIndicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListIndicesInput) SetNextToken

func (s *ListIndicesInput) SetNextToken(v string) *ListIndicesInput

SetNextToken sets the NextToken field's value.

func (ListIndicesInput) String

func (s ListIndicesInput) String() string

String returns the string representation

func (*ListIndicesInput) Validate

func (s *ListIndicesInput) Validate() error

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

type ListIndicesOutput

type ListIndicesOutput struct {

    // An array of summary information for one or more indexes.
    IndexConfigurationSummaryItems []*IndexConfigurationSummary `type:"list"`

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of indexes.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListIndicesOutput) GoString

func (s ListIndicesOutput) GoString() string

GoString returns the string representation

func (*ListIndicesOutput) SetIndexConfigurationSummaryItems

func (s *ListIndicesOutput) SetIndexConfigurationSummaryItems(v []*IndexConfigurationSummary) *ListIndicesOutput

SetIndexConfigurationSummaryItems sets the IndexConfigurationSummaryItems field's value.

func (*ListIndicesOutput) SetNextToken

func (s *ListIndicesOutput) SetNextToken(v string) *ListIndicesOutput

SetNextToken sets the NextToken field's value.

func (ListIndicesOutput) String

func (s ListIndicesOutput) String() string

String returns the string representation

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

    // The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a
    // list of tags for.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceARN

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

    // A list of tags associated with the index, FAQ, or data source.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type OneDriveConfiguration

type OneDriveConfiguration struct {

    // List of regular expressions applied to documents. Items that match the exclusion
    // pattern are not indexed. If you provide both an inclusion pattern and an
    // exclusion pattern, any item that matches the exclusion pattern isn't indexed.
    //
    // The exclusion pattern is applied to the file name.
    ExclusionPatterns []*string `type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive
    // fields to custom fields in the Amazon Kendra index. You must first create
    // the index fields before you map OneDrive fields.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of regular expression patterns. Documents that match the pattern are
    // included in the index. Documents that don't match the pattern are excluded
    // from the index. If a document matches both an inclusion pattern and an exclusion
    // pattern, the document is not included in the index.
    //
    // The exclusion pattern is applied to the file name.
    InclusionPatterns []*string `type:"list"`

    // A list of user accounts whose documents should be indexed.
    //
    // OneDriveUsers is a required field
    OneDriveUsers *OneDriveUsers `type:"structure" required:"true"`

    // The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
    // the user name and password to connect to OneDrive. The user namd should be
    // the application ID for the OneDrive application, and the password is the
    // application key for the OneDrive application.
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`

    // Tha Azure Active Directory domain of the organization.
    //
    // TenantDomain is a required field
    TenantDomain *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides configuration information for data sources that connect to OneDrive.

func (OneDriveConfiguration) GoString

func (s OneDriveConfiguration) GoString() string

GoString returns the string representation

func (*OneDriveConfiguration) SetExclusionPatterns

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*OneDriveConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (*OneDriveConfiguration) SetInclusionPatterns

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*OneDriveConfiguration) SetOneDriveUsers

func (s *OneDriveConfiguration) SetOneDriveUsers(v *OneDriveUsers) *OneDriveConfiguration

SetOneDriveUsers sets the OneDriveUsers field's value.

func (*OneDriveConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*OneDriveConfiguration) SetTenantDomain

func (s *OneDriveConfiguration) SetTenantDomain(v string) *OneDriveConfiguration

SetTenantDomain sets the TenantDomain field's value.

func (OneDriveConfiguration) String

func (s OneDriveConfiguration) String() string

String returns the string representation

func (*OneDriveConfiguration) Validate

func (s *OneDriveConfiguration) Validate() error

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

type OneDriveUsers

type OneDriveUsers struct {

    // A list of users whose documents should be indexed. Specify the user names
    // in email format, for example, username@tenantdomain. If you need to index
    // the documents of more than 100 users, use the OneDriveUserS3Path field to
    // specify the location of a file containing a list of users.
    OneDriveUserList []*string `min:"1" type:"list"`

    // The S3 bucket location of a file containing a list of users whose documents
    // should be indexed.
    OneDriveUserS3Path *S3Path `type:"structure"`
    // contains filtered or unexported fields
}

User accounts whose documents should be indexed.

func (OneDriveUsers) GoString

func (s OneDriveUsers) GoString() string

GoString returns the string representation

func (*OneDriveUsers) SetOneDriveUserList

func (s *OneDriveUsers) SetOneDriveUserList(v []*string) *OneDriveUsers

SetOneDriveUserList sets the OneDriveUserList field's value.

func (*OneDriveUsers) SetOneDriveUserS3Path

func (s *OneDriveUsers) SetOneDriveUserS3Path(v *S3Path) *OneDriveUsers

SetOneDriveUserS3Path sets the OneDriveUserS3Path field's value.

func (OneDriveUsers) String

func (s OneDriveUsers) String() string

String returns the string representation

func (*OneDriveUsers) Validate

func (s *OneDriveUsers) Validate() error

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

type Principal

type Principal struct {

    // Whether to allow or deny access to the principal.
    //
    // Access is a required field
    Access *string `type:"string" required:"true" enum:"ReadAccessType"`

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

    // The type of principal.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"PrincipalType"`
    // contains filtered or unexported fields
}

Provides user and group information for document access filtering.

func (Principal) GoString

func (s Principal) GoString() string

GoString returns the string representation

func (*Principal) SetAccess

func (s *Principal) SetAccess(v string) *Principal

SetAccess sets the Access field's value.

func (*Principal) SetName

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

SetName sets the Name field's value.

func (*Principal) SetType

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

SetType sets the Type field's value.

func (Principal) String

func (s Principal) String() string

String returns the string representation

func (*Principal) Validate

func (s *Principal) Validate() error

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

type QueryInput

type QueryInput struct {

    // Enables filtered searches based on document attributes. You can only provide
    // one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters
    // parameters contain a list of other filters.
    //
    // The AttributeFilter parameter enables you to create a set of filtering rules
    // that a document must satisfy to be included in the query results.
    AttributeFilter *AttributeFilter `type:"structure"`

    // An array of documents attributes. Amazon Kendra returns a count for each
    // attribute key specified. You can use this information to help narrow the
    // search for your user.
    Facets []*Facet `type:"list"`

    // The unique identifier of the index to search. The identifier is returned
    // in the response from the operation.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // Query results are returned in pages the size of the PageSize parameter. By
    // default, Amazon Kendra returns the first page of results. Use this parameter
    // to get result pages after the first one.
    PageNumber *int64 `type:"integer"`

    // Sets the number of results that are returned in each page of results. The
    // default page size is 10. The maximum number of results returned is 100. If
    // you ask for more than 100 results, only 100 are returned.
    PageSize *int64 `type:"integer"`

    // Sets the type of query. Only results for the specified query type are returned.
    QueryResultTypeFilter *string `type:"string" enum:"QueryResultType"`

    // The text to search for.
    //
    // QueryText is a required field
    QueryText *string `min:"1" type:"string" required:"true"`

    // An array of document attributes to include in the response. No other document
    // attributes are included in the response. By default all document attributes
    // are included in the response.
    RequestedDocumentAttributes []*string `min:"1" type:"list"`

    // Provides information that determines how the results of the query are sorted.
    // You can set the field that Amazon Kendra should sort the results on, and
    // specify whether the results should be sorted in ascending or descending order.
    // In the case of ties in sorting the results, the results are sorted by relevance.
    //
    // If you don't provide sorting configuration, the results are sorted by the
    // relevance that Amazon Kendra determines for the result.
    SortingConfiguration *SortingConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

func (QueryInput) GoString

func (s QueryInput) GoString() string

GoString returns the string representation

func (*QueryInput) SetAttributeFilter

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

SetAttributeFilter sets the AttributeFilter field's value.

func (*QueryInput) SetFacets

func (s *QueryInput) SetFacets(v []*Facet) *QueryInput

SetFacets sets the Facets field's value.

func (*QueryInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*QueryInput) SetPageNumber

func (s *QueryInput) SetPageNumber(v int64) *QueryInput

SetPageNumber sets the PageNumber field's value.

func (*QueryInput) SetPageSize

func (s *QueryInput) SetPageSize(v int64) *QueryInput

SetPageSize sets the PageSize field's value.

func (*QueryInput) SetQueryResultTypeFilter

func (s *QueryInput) SetQueryResultTypeFilter(v string) *QueryInput

SetQueryResultTypeFilter sets the QueryResultTypeFilter field's value.

func (*QueryInput) SetQueryText

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

SetQueryText sets the QueryText field's value.

func (*QueryInput) SetRequestedDocumentAttributes

func (s *QueryInput) SetRequestedDocumentAttributes(v []*string) *QueryInput

SetRequestedDocumentAttributes sets the RequestedDocumentAttributes field's value.

func (*QueryInput) SetSortingConfiguration

func (s *QueryInput) SetSortingConfiguration(v *SortingConfiguration) *QueryInput

SetSortingConfiguration sets the SortingConfiguration field's value.

func (QueryInput) String

func (s QueryInput) String() string

String returns the string representation

func (*QueryInput) Validate

func (s *QueryInput) Validate() error

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

type QueryOutput

type QueryOutput struct {

    // Contains the facet results. A FacetResult contains the counts for each attribute
    // key that was specified in the Facets input parameter.
    FacetResults []*FacetResult `type:"list"`

    // The unique identifier for the search. You use QueryId to identify the search
    // when using the feedback API.
    QueryId *string `min:"1" type:"string"`

    // The results of the search.
    ResultItems []*QueryResultItem `type:"list"`

    // The total number of items found by the search; however, you can only retrieve
    // up to 100 items. For example, if the search found 192 items, you can only
    // retrieve the first 100 of the items.
    TotalNumberOfResults *int64 `type:"integer"`
    // contains filtered or unexported fields
}

func (QueryOutput) GoString

func (s QueryOutput) GoString() string

GoString returns the string representation

func (*QueryOutput) SetFacetResults

func (s *QueryOutput) SetFacetResults(v []*FacetResult) *QueryOutput

SetFacetResults sets the FacetResults field's value.

func (*QueryOutput) SetQueryId

func (s *QueryOutput) SetQueryId(v string) *QueryOutput

SetQueryId sets the QueryId field's value.

func (*QueryOutput) SetResultItems

func (s *QueryOutput) SetResultItems(v []*QueryResultItem) *QueryOutput

SetResultItems sets the ResultItems field's value.

func (*QueryOutput) SetTotalNumberOfResults

func (s *QueryOutput) SetTotalNumberOfResults(v int64) *QueryOutput

SetTotalNumberOfResults sets the TotalNumberOfResults field's value.

func (QueryOutput) String

func (s QueryOutput) String() string

String returns the string representation

type QueryResultItem

type QueryResultItem struct {

    // One or more additional attributes associated with the query result.
    AdditionalAttributes []*AdditionalResultAttribute `type:"list"`

    // An array of document attributes for the document that the query result maps
    // to. For example, the document author (Author) or the source URI (SourceUri)
    // of the document.
    DocumentAttributes []*DocumentAttribute `type:"list"`

    // An extract of the text in the document. Contains information about highlighting
    // the relevant terms in the excerpt.
    DocumentExcerpt *TextWithHighlights `type:"structure"`

    // The unique identifier for the document.
    DocumentId *string `min:"1" type:"string"`

    // The title of the document. Contains the text of the title and information
    // for highlighting the relevant terms in the title.
    DocumentTitle *TextWithHighlights `type:"structure"`

    // The URI of the original location of the document.
    DocumentURI *string `min:"1" type:"string"`

    // The unique identifier for the query result.
    Id *string `min:"1" type:"string"`

    // Indicates the confidence that Amazon Kendra has that a result matches the
    // query that you provided. Each result is placed into a bin that indicates
    // the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to
    // determine if a response meets the confidence needed for your application.
    //
    // The field is only set to LOW when the Type field is set to DOCUMENT and Amazon
    // Kendra is not confident that the result matches the query.
    ScoreAttributes *ScoreAttributes `type:"structure"`

    // The type of document.
    Type *string `type:"string" enum:"QueryResultType"`
    // contains filtered or unexported fields
}

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

func (QueryResultItem) GoString

func (s QueryResultItem) GoString() string

GoString returns the string representation

func (*QueryResultItem) SetAdditionalAttributes

func (s *QueryResultItem) SetAdditionalAttributes(v []*AdditionalResultAttribute) *QueryResultItem

SetAdditionalAttributes sets the AdditionalAttributes field's value.

func (*QueryResultItem) SetDocumentAttributes

func (s *QueryResultItem) SetDocumentAttributes(v []*DocumentAttribute) *QueryResultItem

SetDocumentAttributes sets the DocumentAttributes field's value.

func (*QueryResultItem) SetDocumentExcerpt

func (s *QueryResultItem) SetDocumentExcerpt(v *TextWithHighlights) *QueryResultItem

SetDocumentExcerpt sets the DocumentExcerpt field's value.

func (*QueryResultItem) SetDocumentId

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

SetDocumentId sets the DocumentId field's value.

func (*QueryResultItem) SetDocumentTitle

func (s *QueryResultItem) SetDocumentTitle(v *TextWithHighlights) *QueryResultItem

SetDocumentTitle sets the DocumentTitle field's value.

func (*QueryResultItem) SetDocumentURI

func (s *QueryResultItem) SetDocumentURI(v string) *QueryResultItem

SetDocumentURI sets the DocumentURI field's value.

func (*QueryResultItem) SetId

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

SetId sets the Id field's value.

func (*QueryResultItem) SetScoreAttributes

func (s *QueryResultItem) SetScoreAttributes(v *ScoreAttributes) *QueryResultItem

SetScoreAttributes sets the ScoreAttributes field's value.

func (*QueryResultItem) SetType

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

SetType sets the Type field's value.

func (QueryResultItem) String

func (s QueryResultItem) String() string

String returns the string representation

type Relevance

type Relevance struct {

    // Specifies the time period that the boost applies to. For example, to make
    // the boost apply to documents with the field value within the last month,
    // you would use "2628000s". Once the field value is beyond the specified range,
    // the effect of the boost drops off. The higher the importance, the faster
    // the effect drops off. If you don't specify a value, the default is 3 months.
    // The value of the field is a numeric string followed by the character "s",
    // for example "86400s" for one day, or "604800s" for one week.
    //
    // Only applies to DATE fields.
    Duration *string `min:"1" type:"string"`

    // Indicates that this field determines how "fresh" a document is. For example,
    // if document 1 was created on November 5, and document 2 was created on October
    // 31, document 1 is "fresher" than document 2. You can only set the Freshness
    // field on one DATE type field. Only applies to DATE fields.
    Freshness *bool `type:"boolean"`

    // The relative importance of the field in the search. Larger numbers provide
    // more of a boost than smaller numbers.
    Importance *int64 `min:"1" type:"integer"`

    // Determines how values should be interpreted.
    //
    // When the RankOrder field is ASCENDING, higher numbers are better. For example,
    // a document with a rating score of 10 is higher ranking than a document with
    // a rating score of 1.
    //
    // When the RankOrder field is DESCENDING, lower numbers are better. For example,
    // in a task tracking application, a priority 1 task is more important than
    // a priority 5 task.
    //
    // Only applies to LONG and DOUBLE fields.
    RankOrder *string `type:"string" enum:"Order"`

    // A list of values that should be given a different boost when they appear
    // in the result list. For example, if you are boosting a field called "department,"
    // query terms that match the department field are boosted in the result. However,
    // you can add entries from the department field to boost documents with those
    // values higher.
    //
    // For example, you can add entries to the map with names of departments. If
    // you add "HR",5 and "Legal",3 those departments are given special attention
    // when they appear in the metadata of a document. When those terms appear they
    // are given the specified importance instead of the regular importance for
    // the boost.
    ValueImportanceMap map[string]*int64 `type:"map"`
    // contains filtered or unexported fields
}

Provides information for 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.

func (Relevance) GoString

func (s Relevance) GoString() string

GoString returns the string representation

func (*Relevance) SetDuration

func (s *Relevance) SetDuration(v string) *Relevance

SetDuration sets the Duration field's value.

func (*Relevance) SetFreshness

func (s *Relevance) SetFreshness(v bool) *Relevance

SetFreshness sets the Freshness field's value.

func (*Relevance) SetImportance

func (s *Relevance) SetImportance(v int64) *Relevance

SetImportance sets the Importance field's value.

func (*Relevance) SetRankOrder

func (s *Relevance) SetRankOrder(v string) *Relevance

SetRankOrder sets the RankOrder field's value.

func (*Relevance) SetValueImportanceMap

func (s *Relevance) SetValueImportanceMap(v map[string]*int64) *Relevance

SetValueImportanceMap sets the ValueImportanceMap field's value.

func (Relevance) String

func (s Relevance) String() string

String returns the string representation

func (*Relevance) Validate

func (s *Relevance) Validate() error

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

type RelevanceFeedback

type RelevanceFeedback struct {

    // Whether to document was relevant or not relevant to the search.
    //
    // RelevanceValue is a required field
    RelevanceValue *string `type:"string" required:"true" enum:"RelevanceType"`

    // The unique identifier of the search result that the user provided relevance
    // feedback for.
    //
    // ResultId is a required field
    ResultId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information.

func (RelevanceFeedback) GoString

func (s RelevanceFeedback) GoString() string

GoString returns the string representation

func (*RelevanceFeedback) SetRelevanceValue

func (s *RelevanceFeedback) SetRelevanceValue(v string) *RelevanceFeedback

SetRelevanceValue sets the RelevanceValue field's value.

func (*RelevanceFeedback) SetResultId

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

SetResultId sets the ResultId field's value.

func (RelevanceFeedback) String

func (s RelevanceFeedback) String() string

String returns the string representation

func (*RelevanceFeedback) Validate

func (s *RelevanceFeedback) Validate() error

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

type ResourceAlreadyExistException

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

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

func (*ResourceAlreadyExistException) Code

func (s *ResourceAlreadyExistException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistException) Error

func (s *ResourceAlreadyExistException) Error() string

func (ResourceAlreadyExistException) GoString

func (s ResourceAlreadyExistException) GoString() string

GoString returns the string representation

func (*ResourceAlreadyExistException) Message

func (s *ResourceAlreadyExistException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistException) OrigErr

func (s *ResourceAlreadyExistException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistException) RequestID

func (s *ResourceAlreadyExistException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistException) StatusCode

func (s *ResourceAlreadyExistException) StatusCode() int

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

func (ResourceAlreadyExistException) String

func (s ResourceAlreadyExistException) String() string

String returns the string representation

type ResourceInUseException

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

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

func (*ResourceInUseException) Code

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString

func (s ResourceInUseException) GoString() string

GoString returns the string representation

func (*ResourceInUseException) Message

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode

func (s *ResourceInUseException) StatusCode() int

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

func (ResourceInUseException) String

func (s ResourceInUseException) String() string

String returns the string representation

type ResourceNotFoundException

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

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

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResourceUnavailableException

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

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

func (*ResourceUnavailableException) Code

func (s *ResourceUnavailableException) Code() string

Code returns the exception type name.

func (*ResourceUnavailableException) Error

func (s *ResourceUnavailableException) Error() string

func (ResourceUnavailableException) GoString

func (s ResourceUnavailableException) GoString() string

GoString returns the string representation

func (*ResourceUnavailableException) Message

func (s *ResourceUnavailableException) Message() string

Message returns the exception's message.

func (*ResourceUnavailableException) OrigErr

func (s *ResourceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceUnavailableException) RequestID

func (s *ResourceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceUnavailableException) StatusCode

func (s *ResourceUnavailableException) StatusCode() int

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

func (ResourceUnavailableException) String

func (s ResourceUnavailableException) String() string

String returns the string representation

type S3DataSourceConfiguration

type S3DataSourceConfiguration struct {

    // Provides the path to the S3 bucket that contains the user context filtering
    // files for the data source.
    AccessControlListConfiguration *AccessControlListConfiguration `type:"structure"`

    // The name of the bucket that contains the documents.
    //
    // BucketName is a required field
    BucketName *string `min:"3" type:"string" required:"true"`

    // Document metadata files that contain information such as the document access
    // control information, source URI, document author, and custom attributes.
    // Each metadata file contains metadata about a single document.
    DocumentsMetadataConfiguration *DocumentsMetadataConfiguration `type:"structure"`

    // A list of glob patterns for documents that should not be indexed. If a document
    // that matches an inclusion prefix or inclusion pattern also matches an exclusion
    // pattern, the document is not indexed.
    //
    // For more information about glob patterns, see glob (programming) (https://en.wikipedia.org/wiki/Glob_(programming))
    // in Wikipedia.
    ExclusionPatterns []*string `type:"list"`

    // A list of glob patterns for documents that should be indexed. If a document
    // that matches an inclusion pattern also matches an exclusion pattern, the
    // document is not indexed.
    //
    // For more information about glob patterns, see glob (programming) (https://en.wikipedia.org/wiki/Glob_(programming))
    // in Wikipedia.
    InclusionPatterns []*string `type:"list"`

    // A list of S3 prefixes for the documents that should be included in the index.
    InclusionPrefixes []*string `type:"list"`
    // contains filtered or unexported fields
}

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

func (S3DataSourceConfiguration) GoString

func (s S3DataSourceConfiguration) GoString() string

GoString returns the string representation

func (*S3DataSourceConfiguration) SetAccessControlListConfiguration

func (s *S3DataSourceConfiguration) SetAccessControlListConfiguration(v *AccessControlListConfiguration) *S3DataSourceConfiguration

SetAccessControlListConfiguration sets the AccessControlListConfiguration field's value.

func (*S3DataSourceConfiguration) SetBucketName

func (s *S3DataSourceConfiguration) SetBucketName(v string) *S3DataSourceConfiguration

SetBucketName sets the BucketName field's value.

func (*S3DataSourceConfiguration) SetDocumentsMetadataConfiguration

func (s *S3DataSourceConfiguration) SetDocumentsMetadataConfiguration(v *DocumentsMetadataConfiguration) *S3DataSourceConfiguration

SetDocumentsMetadataConfiguration sets the DocumentsMetadataConfiguration field's value.

func (*S3DataSourceConfiguration) SetExclusionPatterns

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*S3DataSourceConfiguration) SetInclusionPatterns

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*S3DataSourceConfiguration) SetInclusionPrefixes

func (s *S3DataSourceConfiguration) SetInclusionPrefixes(v []*string) *S3DataSourceConfiguration

SetInclusionPrefixes sets the InclusionPrefixes field's value.

func (S3DataSourceConfiguration) String

func (s S3DataSourceConfiguration) String() string

String returns the string representation

func (*S3DataSourceConfiguration) Validate

func (s *S3DataSourceConfiguration) Validate() error

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

type S3Path

type S3Path struct {

    // The name of the S3 bucket that contains the file.
    //
    // Bucket is a required field
    Bucket *string `min:"3" type:"string" required:"true"`

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

Information required to find a specific file in an Amazon S3 bucket.

func (S3Path) GoString

func (s S3Path) GoString() string

GoString returns the string representation

func (*S3Path) SetBucket

func (s *S3Path) SetBucket(v string) *S3Path

SetBucket sets the Bucket field's value.

func (*S3Path) SetKey

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

SetKey sets the Key field's value.

func (S3Path) String

func (s S3Path) String() string

String returns the string representation

func (*S3Path) Validate

func (s *S3Path) Validate() error

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

type SalesforceChatterFeedConfiguration

type SalesforceChatterFeedConfiguration struct {

    // The name of the column in the Salesforce FeedItem table that contains the
    // content to index. Typically this is the Body column.
    //
    // DocumentDataFieldName is a required field
    DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

    // The name of the column in the Salesforce FeedItem table that contains the
    // title of the document. This is typically the Title collumn.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // Filters the documents in the feed based on status of the user. When you specify
    // ACTIVE_USERS only documents from users who have an active account are indexed.
    // When you specify STANDARD_USER only documents for Salesforce standard users
    // are documented. You can specify both.
    IncludeFilterTypes []*string `min:"1" type:"list"`
    // contains filtered or unexported fields
}

Defines configuration for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.

func (SalesforceChatterFeedConfiguration) GoString

func (s SalesforceChatterFeedConfiguration) GoString() string

GoString returns the string representation

func (*SalesforceChatterFeedConfiguration) SetDocumentDataFieldName

func (s *SalesforceChatterFeedConfiguration) SetDocumentDataFieldName(v string) *SalesforceChatterFeedConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceChatterFeedConfiguration) SetDocumentTitleFieldName

func (s *SalesforceChatterFeedConfiguration) SetDocumentTitleFieldName(v string) *SalesforceChatterFeedConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceChatterFeedConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (*SalesforceChatterFeedConfiguration) SetIncludeFilterTypes

func (s *SalesforceChatterFeedConfiguration) SetIncludeFilterTypes(v []*string) *SalesforceChatterFeedConfiguration

SetIncludeFilterTypes sets the IncludeFilterTypes field's value.

func (SalesforceChatterFeedConfiguration) String

func (s SalesforceChatterFeedConfiguration) String() string

String returns the string representation

func (*SalesforceChatterFeedConfiguration) Validate

func (s *SalesforceChatterFeedConfiguration) Validate() error

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

type SalesforceConfiguration

type SalesforceConfiguration struct {

    // Specifies configuration information for Salesforce chatter feeds.
    ChatterFeedConfiguration *SalesforceChatterFeedConfiguration `type:"structure"`

    // Indicates whether Amazon Kendra should index attachments to Salesforce objects.
    CrawlAttachments *bool `type:"boolean"`

    // A list of regular expression patterns. Documents that match the patterns
    // are excluded from the index. Documents that don't match the patterns are
    // included in the index. If a document matches both an exclusion pattern and
    // an inclusion pattern, the document is not included in the index.
    //
    // The regex is applied to the name of the attached file.
    ExcludeAttachmentFilePatterns []*string `type:"list"`

    // A list of regular expression patterns. Documents that match the patterns
    // are included in the index. Documents that don't match the patterns are excluded
    // from the index. If a document matches both an inclusion pattern and an exclusion
    // pattern, the document is not included in the index.
    //
    // The regex is applied to the name of the attached file.
    IncludeAttachmentFilePatterns []*string `type:"list"`

    // Specifies configuration information for the knowlege article types that Amazon
    // Kendra indexes. Amazon Kendra indexes standard knowledge articles and the
    // standard fields of knowledge articles, or the custom fields of custom knowledge
    // articles, but not both.
    KnowledgeArticleConfiguration *SalesforceKnowledgeArticleConfiguration `type:"structure"`

    // The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains
    // the key/value pairs required to connect to your Salesforce instance. The
    // secret must contain a JSON structure with the following keys:
    //
    //    * authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to
    //    get an OAUTH token.
    //
    //    * consumerKey - The application public key generated when you created
    //    your Salesforce application.
    //
    //    * consumerSecret - The application private key generated when you created
    //    your Salesforce application.
    //
    //    * password - The password associated with the user logging in to the Salesforce
    //    instance.
    //
    //    * securityToken - The token associated with the user account logging in
    //    to the Salesforce instance.
    //
    //    * username - The user name of the user logging in to the Salesforce instance.
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`

    // The instance URL for the Salesforce site that you want to index.
    //
    // ServerUrl is a required field
    ServerUrl *string `min:"1" type:"string" required:"true"`

    // Provides configuration information for processing attachments to Salesforce
    // standard objects.
    StandardObjectAttachmentConfiguration *SalesforceStandardObjectAttachmentConfiguration `type:"structure"`

    // Specifies the Salesforce standard objects that Amazon Kendra indexes.
    StandardObjectConfigurations []*SalesforceStandardObjectConfiguration `min:"1" type:"list"`
    // contains filtered or unexported fields
}

Provides configuration information for connecting to a Salesforce data source.

func (SalesforceConfiguration) GoString

func (s SalesforceConfiguration) GoString() string

GoString returns the string representation

func (*SalesforceConfiguration) SetChatterFeedConfiguration

func (s *SalesforceConfiguration) SetChatterFeedConfiguration(v *SalesforceChatterFeedConfiguration) *SalesforceConfiguration

SetChatterFeedConfiguration sets the ChatterFeedConfiguration field's value.

func (*SalesforceConfiguration) SetCrawlAttachments

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

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*SalesforceConfiguration) SetExcludeAttachmentFilePatterns

func (s *SalesforceConfiguration) SetExcludeAttachmentFilePatterns(v []*string) *SalesforceConfiguration

SetExcludeAttachmentFilePatterns sets the ExcludeAttachmentFilePatterns field's value.

func (*SalesforceConfiguration) SetIncludeAttachmentFilePatterns

func (s *SalesforceConfiguration) SetIncludeAttachmentFilePatterns(v []*string) *SalesforceConfiguration

SetIncludeAttachmentFilePatterns sets the IncludeAttachmentFilePatterns field's value.

func (*SalesforceConfiguration) SetKnowledgeArticleConfiguration

func (s *SalesforceConfiguration) SetKnowledgeArticleConfiguration(v *SalesforceKnowledgeArticleConfiguration) *SalesforceConfiguration

SetKnowledgeArticleConfiguration sets the KnowledgeArticleConfiguration field's value.

func (*SalesforceConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*SalesforceConfiguration) SetServerUrl

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

SetServerUrl sets the ServerUrl field's value.

func (*SalesforceConfiguration) SetStandardObjectAttachmentConfiguration

func (s *SalesforceConfiguration) SetStandardObjectAttachmentConfiguration(v *SalesforceStandardObjectAttachmentConfiguration) *SalesforceConfiguration

SetStandardObjectAttachmentConfiguration sets the StandardObjectAttachmentConfiguration field's value.

func (*SalesforceConfiguration) SetStandardObjectConfigurations

func (s *SalesforceConfiguration) SetStandardObjectConfigurations(v []*SalesforceStandardObjectConfiguration) *SalesforceConfiguration

SetStandardObjectConfigurations sets the StandardObjectConfigurations field's value.

func (SalesforceConfiguration) String

func (s SalesforceConfiguration) String() string

String returns the string representation

func (*SalesforceConfiguration) Validate

func (s *SalesforceConfiguration) Validate() error

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

type SalesforceCustomKnowledgeArticleTypeConfiguration

type SalesforceCustomKnowledgeArticleTypeConfiguration struct {

    // The name of the field in the custom knowledge article that contains the document
    // data to index.
    //
    // DocumentDataFieldName is a required field
    DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

    // The name of the field in the custom knowledge article that contains the document
    // title.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // One or more objects that map fields in the custom knowledge article to fields
    // in the Amazon Kendra index.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

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

Provides configuration information for indexing Salesforce custom articles.

func (SalesforceCustomKnowledgeArticleTypeConfiguration) GoString

func (s SalesforceCustomKnowledgeArticleTypeConfiguration) GoString() string

GoString returns the string representation

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName(v string) *SalesforceCustomKnowledgeArticleTypeConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName(v string) *SalesforceCustomKnowledgeArticleTypeConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetName

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

SetName sets the Name field's value.

func (SalesforceCustomKnowledgeArticleTypeConfiguration) String

func (s SalesforceCustomKnowledgeArticleTypeConfiguration) String() string

String returns the string representation

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) Validate

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) Validate() error

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

type SalesforceKnowledgeArticleConfiguration

type SalesforceKnowledgeArticleConfiguration struct {

    // Provides configuration information for custom Salesforce knowledge articles.
    CustomKnowledgeArticleTypeConfigurations []*SalesforceCustomKnowledgeArticleTypeConfiguration `min:"1" type:"list"`

    // Specifies the document states that should be included when Amazon Kendra
    // indexes knowledge articles. You must specify at least one state.
    //
    // IncludedStates is a required field
    IncludedStates []*string `min:"1" type:"list" required:"true"`

    // Provides configuration information for standard Salesforce knowledge articles.
    StandardKnowledgeArticleTypeConfiguration *SalesforceStandardKnowledgeArticleTypeConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

Specifies configuration information for the knowlege article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

func (SalesforceKnowledgeArticleConfiguration) GoString

func (s SalesforceKnowledgeArticleConfiguration) GoString() string

GoString returns the string representation

func (*SalesforceKnowledgeArticleConfiguration) SetCustomKnowledgeArticleTypeConfigurations

func (s *SalesforceKnowledgeArticleConfiguration) SetCustomKnowledgeArticleTypeConfigurations(v []*SalesforceCustomKnowledgeArticleTypeConfiguration) *SalesforceKnowledgeArticleConfiguration

SetCustomKnowledgeArticleTypeConfigurations sets the CustomKnowledgeArticleTypeConfigurations field's value.

func (*SalesforceKnowledgeArticleConfiguration) SetIncludedStates

func (s *SalesforceKnowledgeArticleConfiguration) SetIncludedStates(v []*string) *SalesforceKnowledgeArticleConfiguration

SetIncludedStates sets the IncludedStates field's value.

func (*SalesforceKnowledgeArticleConfiguration) SetStandardKnowledgeArticleTypeConfiguration

func (s *SalesforceKnowledgeArticleConfiguration) SetStandardKnowledgeArticleTypeConfiguration(v *SalesforceStandardKnowledgeArticleTypeConfiguration) *SalesforceKnowledgeArticleConfiguration

SetStandardKnowledgeArticleTypeConfiguration sets the StandardKnowledgeArticleTypeConfiguration field's value.

func (SalesforceKnowledgeArticleConfiguration) String

func (s SalesforceKnowledgeArticleConfiguration) String() string

String returns the string representation

func (*SalesforceKnowledgeArticleConfiguration) Validate

func (s *SalesforceKnowledgeArticleConfiguration) Validate() error

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

type SalesforceStandardKnowledgeArticleTypeConfiguration

type SalesforceStandardKnowledgeArticleTypeConfiguration struct {

    // The name of the field that contains the document data to index.
    //
    // DocumentDataFieldName is a required field
    DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

    // The name of the field that contains the document title.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // One or more objects that map fields in the knowledge article to Amazon Kendra
    // index fields. The index field must exist before you can map a Salesforce
    // field to it.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
    // contains filtered or unexported fields
}

Provides configuration information for standard Salesforce knowledge articles.

func (SalesforceStandardKnowledgeArticleTypeConfiguration) GoString

func (s SalesforceStandardKnowledgeArticleTypeConfiguration) GoString() string

GoString returns the string representation

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName

func (s *SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName(v string) *SalesforceStandardKnowledgeArticleTypeConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName

func (s *SalesforceStandardKnowledgeArticleTypeConfiguration) SetDocumentTitleFieldName(v string) *SalesforceStandardKnowledgeArticleTypeConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (SalesforceStandardKnowledgeArticleTypeConfiguration) String

func (s SalesforceStandardKnowledgeArticleTypeConfiguration) String() string

String returns the string representation

func (*SalesforceStandardKnowledgeArticleTypeConfiguration) Validate

func (s *SalesforceStandardKnowledgeArticleTypeConfiguration) Validate() error

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

type SalesforceStandardObjectAttachmentConfiguration

type SalesforceStandardObjectAttachmentConfiguration struct {

    // The name of the field used for the document title.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // One or more objects that map fields in attachments to Amazon Kendra index
    // fields.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
    // contains filtered or unexported fields
}

Provides configuration information for processing attachments to Salesforce standard objects.

func (SalesforceStandardObjectAttachmentConfiguration) GoString

func (s SalesforceStandardObjectAttachmentConfiguration) GoString() string

GoString returns the string representation

func (*SalesforceStandardObjectAttachmentConfiguration) SetDocumentTitleFieldName

func (s *SalesforceStandardObjectAttachmentConfiguration) SetDocumentTitleFieldName(v string) *SalesforceStandardObjectAttachmentConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceStandardObjectAttachmentConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (SalesforceStandardObjectAttachmentConfiguration) String

func (s SalesforceStandardObjectAttachmentConfiguration) String() string

String returns the string representation

func (*SalesforceStandardObjectAttachmentConfiguration) Validate

func (s *SalesforceStandardObjectAttachmentConfiguration) Validate() error

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

type SalesforceStandardObjectConfiguration

type SalesforceStandardObjectConfiguration struct {

    // The name of the field in the standard object table that contains the document
    // contents.
    //
    // DocumentDataFieldName is a required field
    DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

    // The name of the field in the standard object table that contains the document
    // titleB.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // One or more objects that map fields in the standard object to Amazon Kendra
    // index fields. The index field must exist before you can map a Salesforce
    // field to it.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // The name of the standard object.
    //
    // Name is a required field
    Name *string `type:"string" required:"true" enum:"SalesforceStandardObjectName"`
    // contains filtered or unexported fields
}

Specifies confguration information for indexing a single standard object.

func (SalesforceStandardObjectConfiguration) GoString

func (s SalesforceStandardObjectConfiguration) GoString() string

GoString returns the string representation

func (*SalesforceStandardObjectConfiguration) SetDocumentDataFieldName

func (s *SalesforceStandardObjectConfiguration) SetDocumentDataFieldName(v string) *SalesforceStandardObjectConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*SalesforceStandardObjectConfiguration) SetDocumentTitleFieldName

func (s *SalesforceStandardObjectConfiguration) SetDocumentTitleFieldName(v string) *SalesforceStandardObjectConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SalesforceStandardObjectConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (*SalesforceStandardObjectConfiguration) SetName

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

SetName sets the Name field's value.

func (SalesforceStandardObjectConfiguration) String

func (s SalesforceStandardObjectConfiguration) String() string

String returns the string representation

func (*SalesforceStandardObjectConfiguration) Validate

func (s *SalesforceStandardObjectConfiguration) Validate() error

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

type ScoreAttributes

type ScoreAttributes struct {

    // A relative ranking for how well the response matches the query.
    ScoreConfidence *string `type:"string" enum:"ScoreConfidence"`
    // contains filtered or unexported fields
}

Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query.

func (ScoreAttributes) GoString

func (s ScoreAttributes) GoString() string

GoString returns the string representation

func (*ScoreAttributes) SetScoreConfidence

func (s *ScoreAttributes) SetScoreConfidence(v string) *ScoreAttributes

SetScoreConfidence sets the ScoreConfidence field's value.

func (ScoreAttributes) String

func (s ScoreAttributes) String() string

String returns the string representation

type Search struct {

    // Determines whether the field is returned in the query response. The default
    // is true.
    Displayable *bool `type:"boolean"`

    // Indicates that the field can be used to create search facets, a count of
    // results for each value in the field. The default is false .
    Facetable *bool `type:"boolean"`

    // Determines whether the field is used in the search. If the Searchable field
    // is true, you can use relevance tuning to manually tune how Amazon Kendra
    // weights the field in the search. The default is true for string fields and
    // false for number and date fields.
    Searchable *bool `type:"boolean"`

    // Determines whether the field can be used to sort the results of a query.
    // If you specify sorting on a field that does not have Sortable set to true,
    // Amazon Kendra returns an exception. The default is false.
    Sortable *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Provides information about how a custom index field is used during a search.

func (Search) GoString

func (s Search) GoString() string

GoString returns the string representation

func (*Search) SetDisplayable

func (s *Search) SetDisplayable(v bool) *Search

SetDisplayable sets the Displayable field's value.

func (*Search) SetFacetable

func (s *Search) SetFacetable(v bool) *Search

SetFacetable sets the Facetable field's value.

func (*Search) SetSearchable

func (s *Search) SetSearchable(v bool) *Search

SetSearchable sets the Searchable field's value.

func (*Search) SetSortable

func (s *Search) SetSortable(v bool) *Search

SetSortable sets the Sortable field's value.

func (Search) String

func (s Search) String() string

String returns the string representation

type ServerSideEncryptionConfiguration

type ServerSideEncryptionConfiguration struct {

    // The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't
    // support asymmetric CMKs.
    KmsKeyId *string `min:"1" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

func (ServerSideEncryptionConfiguration) GoString

func (s ServerSideEncryptionConfiguration) GoString() string

GoString returns the string representation

func (*ServerSideEncryptionConfiguration) SetKmsKeyId

func (s *ServerSideEncryptionConfiguration) SetKmsKeyId(v string) *ServerSideEncryptionConfiguration

SetKmsKeyId sets the KmsKeyId field's value.

func (ServerSideEncryptionConfiguration) String

func (s ServerSideEncryptionConfiguration) String() string

String returns the string representation

func (*ServerSideEncryptionConfiguration) Validate

func (s *ServerSideEncryptionConfiguration) Validate() error

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

type ServiceNowConfiguration

type ServiceNowConfiguration struct {

    // The ServiceNow instance that the data source connects to. The host endpoint
    // should look like the following: {instance}.service-now.com.
    //
    // HostUrl is a required field
    HostUrl *string `min:"1" type:"string" required:"true"`

    // Provides configuration information for crawling knowledge articles in the
    // ServiceNow site.
    KnowledgeArticleConfiguration *ServiceNowKnowledgeArticleConfiguration `type:"structure"`

    // The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains
    // the user name and password required to connect to the ServiceNow instance.
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`

    // Provides configuration information for crawling service catalogs in the ServiceNow
    // site.
    ServiceCatalogConfiguration *ServiceNowServiceCatalogConfiguration `type:"structure"`

    // The identifier of the release that the ServiceNow host is running. If the
    // host is not running the LONDON release, use OTHERS.
    //
    // ServiceNowBuildVersion is a required field
    ServiceNowBuildVersion *string `type:"string" required:"true" enum:"ServiceNowBuildVersionType"`
    // contains filtered or unexported fields
}

Provides configuration information required to connect to a ServiceNow data source.

func (ServiceNowConfiguration) GoString

func (s ServiceNowConfiguration) GoString() string

GoString returns the string representation

func (*ServiceNowConfiguration) SetHostUrl

func (s *ServiceNowConfiguration) SetHostUrl(v string) *ServiceNowConfiguration

SetHostUrl sets the HostUrl field's value.

func (*ServiceNowConfiguration) SetKnowledgeArticleConfiguration

func (s *ServiceNowConfiguration) SetKnowledgeArticleConfiguration(v *ServiceNowKnowledgeArticleConfiguration) *ServiceNowConfiguration

SetKnowledgeArticleConfiguration sets the KnowledgeArticleConfiguration field's value.

func (*ServiceNowConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*ServiceNowConfiguration) SetServiceCatalogConfiguration

func (s *ServiceNowConfiguration) SetServiceCatalogConfiguration(v *ServiceNowServiceCatalogConfiguration) *ServiceNowConfiguration

SetServiceCatalogConfiguration sets the ServiceCatalogConfiguration field's value.

func (*ServiceNowConfiguration) SetServiceNowBuildVersion

func (s *ServiceNowConfiguration) SetServiceNowBuildVersion(v string) *ServiceNowConfiguration

SetServiceNowBuildVersion sets the ServiceNowBuildVersion field's value.

func (ServiceNowConfiguration) String

func (s ServiceNowConfiguration) String() string

String returns the string representation

func (*ServiceNowConfiguration) Validate

func (s *ServiceNowConfiguration) Validate() error

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

type ServiceNowKnowledgeArticleConfiguration

type ServiceNowKnowledgeArticleConfiguration struct {

    // Indicates whether Amazon Kendra should index attachments to knowledge articles.
    CrawlAttachments *bool `type:"boolean"`

    // The name of the ServiceNow field that is mapped to the index document contents
    // field in the Amazon Kendra index.
    //
    // DocumentDataFieldName is a required field
    DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

    // The name of the ServiceNow field that is mapped to the index document title
    // field.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // List of regular expressions applied to knowledge articles. Items that don't
    // match the inclusion pattern are not indexed. The regex is applied to the
    // field specified in the PatternTargetField
    ExcludeAttachmentFilePatterns []*string `type:"list"`

    // Mapping between ServiceNow fields and Amazon Kendra index fields. You must
    // create the index field before you map the field.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // List of regular expressions applied to knowledge articles. Items that don't
    // match the inclusion pattern are not indexed. The regex is applied to the
    // field specified in the PatternTargetField.
    IncludeAttachmentFilePatterns []*string `type:"list"`
    // contains filtered or unexported fields
}

Provides configuration information for crawling knowledge articles in the ServiceNow site.

func (ServiceNowKnowledgeArticleConfiguration) GoString

func (s ServiceNowKnowledgeArticleConfiguration) GoString() string

GoString returns the string representation

func (*ServiceNowKnowledgeArticleConfiguration) SetCrawlAttachments

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

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetDocumentDataFieldName

func (s *ServiceNowKnowledgeArticleConfiguration) SetDocumentDataFieldName(v string) *ServiceNowKnowledgeArticleConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetDocumentTitleFieldName

func (s *ServiceNowKnowledgeArticleConfiguration) SetDocumentTitleFieldName(v string) *ServiceNowKnowledgeArticleConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetExcludeAttachmentFilePatterns

func (s *ServiceNowKnowledgeArticleConfiguration) SetExcludeAttachmentFilePatterns(v []*string) *ServiceNowKnowledgeArticleConfiguration

SetExcludeAttachmentFilePatterns sets the ExcludeAttachmentFilePatterns field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (*ServiceNowKnowledgeArticleConfiguration) SetIncludeAttachmentFilePatterns

func (s *ServiceNowKnowledgeArticleConfiguration) SetIncludeAttachmentFilePatterns(v []*string) *ServiceNowKnowledgeArticleConfiguration

SetIncludeAttachmentFilePatterns sets the IncludeAttachmentFilePatterns field's value.

func (ServiceNowKnowledgeArticleConfiguration) String

func (s ServiceNowKnowledgeArticleConfiguration) String() string

String returns the string representation

func (*ServiceNowKnowledgeArticleConfiguration) Validate

func (s *ServiceNowKnowledgeArticleConfiguration) Validate() error

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

type ServiceNowServiceCatalogConfiguration

type ServiceNowServiceCatalogConfiguration struct {

    // Indicates whether Amazon Kendra should crawl attachments to the service catalog
    // items.
    CrawlAttachments *bool `type:"boolean"`

    // The name of the ServiceNow field that is mapped to the index document contents
    // field in the Amazon Kendra index.
    //
    // DocumentDataFieldName is a required field
    DocumentDataFieldName *string `min:"1" type:"string" required:"true"`

    // The name of the ServiceNow field that is mapped to the index document title
    // field.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // Determines the types of file attachments that are excluded from the index.
    ExcludeAttachmentFilePatterns []*string `type:"list"`

    // Mapping between ServiceNow fields and Amazon Kendra index fields. You must
    // create the index field before you map the field.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // Determines the types of file attachments that are included in the index.
    IncludeAttachmentFilePatterns []*string `type:"list"`
    // contains filtered or unexported fields
}

Provides configuration information for crawling service catalog items in the ServiceNow site

func (ServiceNowServiceCatalogConfiguration) GoString

func (s ServiceNowServiceCatalogConfiguration) GoString() string

GoString returns the string representation

func (*ServiceNowServiceCatalogConfiguration) SetCrawlAttachments

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

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*ServiceNowServiceCatalogConfiguration) SetDocumentDataFieldName

func (s *ServiceNowServiceCatalogConfiguration) SetDocumentDataFieldName(v string) *ServiceNowServiceCatalogConfiguration

SetDocumentDataFieldName sets the DocumentDataFieldName field's value.

func (*ServiceNowServiceCatalogConfiguration) SetDocumentTitleFieldName

func (s *ServiceNowServiceCatalogConfiguration) SetDocumentTitleFieldName(v string) *ServiceNowServiceCatalogConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*ServiceNowServiceCatalogConfiguration) SetExcludeAttachmentFilePatterns

func (s *ServiceNowServiceCatalogConfiguration) SetExcludeAttachmentFilePatterns(v []*string) *ServiceNowServiceCatalogConfiguration

SetExcludeAttachmentFilePatterns sets the ExcludeAttachmentFilePatterns field's value.

func (*ServiceNowServiceCatalogConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (*ServiceNowServiceCatalogConfiguration) SetIncludeAttachmentFilePatterns

func (s *ServiceNowServiceCatalogConfiguration) SetIncludeAttachmentFilePatterns(v []*string) *ServiceNowServiceCatalogConfiguration

SetIncludeAttachmentFilePatterns sets the IncludeAttachmentFilePatterns field's value.

func (ServiceNowServiceCatalogConfiguration) String

func (s ServiceNowServiceCatalogConfiguration) String() string

String returns the string representation

func (*ServiceNowServiceCatalogConfiguration) Validate

func (s *ServiceNowServiceCatalogConfiguration) Validate() error

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

type ServiceQuotaExceededException

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

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

func (*ServiceQuotaExceededException) Code

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type SharePointConfiguration

type SharePointConfiguration struct {

    // TRUE to include attachments to documents stored in your Microsoft SharePoint
    // site in the index; otherwise, FALSE.
    CrawlAttachments *bool `type:"boolean"`

    // The Microsoft SharePoint attribute field that contains the title of the document.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // A list of regular expression patterns. Documents that match the patterns
    // are excluded from the index. Documents that don't match the patterns are
    // included in the index. If a document matches both an exclusion pattern and
    // an inclusion pattern, the document is not included in the index.
    //
    // The regex is applied to the display URL of the SharePoint document.
    ExclusionPatterns []*string `type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint
    // attributes to custom fields in the Amazon Kendra index. You must first create
    // the index fields using the operation before you map SharePoint attributes.
    // For more information, see Mapping Data Source Fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of regular expression patterns. Documents that match the patterns
    // are included in the index. Documents that don't match the patterns are excluded
    // from the index. If a document matches both an inclusion pattern and an exclusion
    // pattern, the document is not included in the index.
    //
    // The regex is applied to the display URL of the SharePoint document.
    InclusionPatterns []*string `type:"list"`

    // 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 Microsoft SharePoint Data Source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.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 version of Microsoft SharePoint that you are using as a data source.
    //
    // SharePointVersion is a required field
    SharePointVersion *string `type:"string" required:"true" enum:"SharePointVersion"`

    // The URLs of the Microsoft SharePoint site that contains the documents that
    // should be indexed.
    //
    // Urls is a required field
    Urls []*string `min:"1" type:"list" required:"true"`

    // Set to TRUE to use the Microsoft SharePoint change log to determine the documents
    // that need to be updated in the index. Depending on the size of the SharePoint
    // change log, it may take longer for Amazon Kendra to use the change log than
    // it takes it to determine the changed documents using the Amazon Kendra document
    // crawler.
    UseChangeLog *bool `type:"boolean"`

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

Provides configuration information for connecting to a Microsoft SharePoint data source.

func (SharePointConfiguration) GoString

func (s SharePointConfiguration) GoString() string

GoString returns the string representation

func (*SharePointConfiguration) SetCrawlAttachments

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

SetCrawlAttachments sets the CrawlAttachments field's value.

func (*SharePointConfiguration) SetDocumentTitleFieldName

func (s *SharePointConfiguration) SetDocumentTitleFieldName(v string) *SharePointConfiguration

SetDocumentTitleFieldName sets the DocumentTitleFieldName field's value.

func (*SharePointConfiguration) SetExclusionPatterns

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*SharePointConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (*SharePointConfiguration) SetInclusionPatterns

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*SharePointConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*SharePointConfiguration) SetSharePointVersion

func (s *SharePointConfiguration) SetSharePointVersion(v string) *SharePointConfiguration

SetSharePointVersion sets the SharePointVersion field's value.

func (*SharePointConfiguration) SetUrls

func (s *SharePointConfiguration) SetUrls(v []*string) *SharePointConfiguration

SetUrls sets the Urls field's value.

func (*SharePointConfiguration) SetUseChangeLog

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

SetUseChangeLog sets the UseChangeLog field's value.

func (*SharePointConfiguration) SetVpcConfiguration

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (SharePointConfiguration) String

func (s SharePointConfiguration) String() string

String returns the string representation

func (*SharePointConfiguration) Validate

func (s *SharePointConfiguration) Validate() error

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

type SortingConfiguration

type SortingConfiguration struct {

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

    // The order that the results should be returned in. In case of ties, the relevance
    // assigned to the result by Amazon Kendra is used as the tie-breaker.
    //
    // SortOrder is a required field
    SortOrder *string `type:"string" required:"true" enum:"SortOrder"`
    // contains filtered or unexported fields
}

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.

You can sort attributes of the following types.

* Date value

* Long value

* String value

You can't sort attributes of the following type.

* String list value

func (SortingConfiguration) GoString

func (s SortingConfiguration) GoString() string

GoString returns the string representation

func (*SortingConfiguration) SetDocumentAttributeKey

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

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*SortingConfiguration) SetSortOrder

func (s *SortingConfiguration) SetSortOrder(v string) *SortingConfiguration

SetSortOrder sets the SortOrder field's value.

func (SortingConfiguration) String

func (s SortingConfiguration) String() string

String returns the string representation

func (*SortingConfiguration) Validate

func (s *SortingConfiguration) Validate() error

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

type SqlConfiguration

type SqlConfiguration struct {

    // Determines whether Amazon Kendra encloses SQL identifiers for tables and
    // column names in double quotes (") when making a database query.
    //
    // By default, Amazon Kendra passes SQL identifiers the way that they are entered
    // into the data source configuration. It does not change the case of identifiers
    // or enclose them in quotes.
    //
    // PostgreSQL internally converts uppercase characters to lower case characters
    // in identifiers unless they are quoted. Choosing this option encloses identifiers
    // in quotes so that PostgreSQL does not convert the character's case.
    //
    // For MySQL databases, you must enable the ansi_quotes option when you set
    // this field to DOUBLE_QUOTES.
    QueryIdentifiersEnclosingOption *string `type:"string" enum:"QueryIdentifiersEnclosingOption"`
    // contains filtered or unexported fields
}

Provides information that configures Amazon Kendra to use a SQL database.

func (SqlConfiguration) GoString

func (s SqlConfiguration) GoString() string

GoString returns the string representation

func (*SqlConfiguration) SetQueryIdentifiersEnclosingOption

func (s *SqlConfiguration) SetQueryIdentifiersEnclosingOption(v string) *SqlConfiguration

SetQueryIdentifiersEnclosingOption sets the QueryIdentifiersEnclosingOption field's value.

func (SqlConfiguration) String

func (s SqlConfiguration) String() string

String returns the string representation

type StartDataSourceSyncJobInput

type StartDataSourceSyncJobInput struct {

    // The identifier of the data source to synchronize.
    //
    // 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 (StartDataSourceSyncJobInput) GoString

func (s StartDataSourceSyncJobInput) GoString() string

GoString returns the string representation

func (*StartDataSourceSyncJobInput) SetId

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

SetId sets the Id field's value.

func (*StartDataSourceSyncJobInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (StartDataSourceSyncJobInput) String

func (s StartDataSourceSyncJobInput) String() string

String returns the string representation

func (*StartDataSourceSyncJobInput) Validate

func (s *StartDataSourceSyncJobInput) Validate() error

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

type StartDataSourceSyncJobOutput

type StartDataSourceSyncJobOutput struct {

    // Identifies a particular synchronization job.
    ExecutionId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (StartDataSourceSyncJobOutput) GoString

func (s StartDataSourceSyncJobOutput) GoString() string

GoString returns the string representation

func (*StartDataSourceSyncJobOutput) SetExecutionId

func (s *StartDataSourceSyncJobOutput) SetExecutionId(v string) *StartDataSourceSyncJobOutput

SetExecutionId sets the ExecutionId field's value.

func (StartDataSourceSyncJobOutput) String

func (s StartDataSourceSyncJobOutput) String() string

String returns the string representation

type StopDataSourceSyncJobInput

type StopDataSourceSyncJobInput struct {

    // The identifier of the data source for which to stop the synchronization jobs.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

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

func (StopDataSourceSyncJobInput) GoString

func (s StopDataSourceSyncJobInput) GoString() string

GoString returns the string representation

func (*StopDataSourceSyncJobInput) SetId

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

SetId sets the Id field's value.

func (*StopDataSourceSyncJobInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (StopDataSourceSyncJobInput) String

func (s StopDataSourceSyncJobInput) String() string

String returns the string representation

func (*StopDataSourceSyncJobInput) Validate

func (s *StopDataSourceSyncJobInput) Validate() error

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

type StopDataSourceSyncJobOutput

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

func (StopDataSourceSyncJobOutput) GoString

func (s StopDataSourceSyncJobOutput) GoString() string

GoString returns the string representation

func (StopDataSourceSyncJobOutput) String

func (s StopDataSourceSyncJobOutput) String() string

String returns the string representation

type SubmitFeedbackInput

type SubmitFeedbackInput struct {

    // Tells Amazon Kendra that a particular search result link was chosen by the
    // user.
    ClickFeedbackItems []*ClickFeedback `type:"list"`

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

    // The identifier of the specific query for which you are submitting feedback.
    // The query ID is returned in the response to the operation.
    //
    // QueryId is a required field
    QueryId *string `min:"1" type:"string" required:"true"`

    // Provides Amazon Kendra with relevant or not relevant feedback for whether
    // a particular item was relevant to the search.
    RelevanceFeedbackItems []*RelevanceFeedback `type:"list"`
    // contains filtered or unexported fields
}

func (SubmitFeedbackInput) GoString

func (s SubmitFeedbackInput) GoString() string

GoString returns the string representation

func (*SubmitFeedbackInput) SetClickFeedbackItems

func (s *SubmitFeedbackInput) SetClickFeedbackItems(v []*ClickFeedback) *SubmitFeedbackInput

SetClickFeedbackItems sets the ClickFeedbackItems field's value.

func (*SubmitFeedbackInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*SubmitFeedbackInput) SetQueryId

func (s *SubmitFeedbackInput) SetQueryId(v string) *SubmitFeedbackInput

SetQueryId sets the QueryId field's value.

func (*SubmitFeedbackInput) SetRelevanceFeedbackItems

func (s *SubmitFeedbackInput) SetRelevanceFeedbackItems(v []*RelevanceFeedback) *SubmitFeedbackInput

SetRelevanceFeedbackItems sets the RelevanceFeedbackItems field's value.

func (SubmitFeedbackInput) String

func (s SubmitFeedbackInput) String() string

String returns the string representation

func (*SubmitFeedbackInput) Validate

func (s *SubmitFeedbackInput) Validate() error

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

type SubmitFeedbackOutput

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

func (SubmitFeedbackOutput) GoString

func (s SubmitFeedbackOutput) GoString() string

GoString returns the string representation

func (SubmitFeedbackOutput) String

func (s SubmitFeedbackOutput) String() string

String returns the string representation

type Tag

type Tag struct {

    // The key for the tag. Keys are not case sensitive and must be unique for the
    // index, FAQ, or data source.
    //
    // Key is a required field
    Key *string `min:"1" type:"string" required:"true"`

    // The value associated with the tag. The value may be an empty string but it
    // can't be null.
    //
    // Value is a required field
    Value *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey

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

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

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

type TagResourceInput

type TagResourceInput struct {

    // The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`

    // A list of tag keys to add to the index, FAQ, or data source. If a tag already
    // exists, the existing value is replaced with the new value.
    //
    // Tags is a required field
    Tags []*Tag `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags

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

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

type TextDocumentStatistics

type TextDocumentStatistics struct {

    // The total size, in bytes, of the indexed documents.
    //
    // IndexedTextBytes is a required field
    IndexedTextBytes *int64 `type:"long" required:"true"`

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

Provides information about text documents indexed in an index.

func (TextDocumentStatistics) GoString

func (s TextDocumentStatistics) GoString() string

GoString returns the string representation

func (*TextDocumentStatistics) SetIndexedTextBytes

func (s *TextDocumentStatistics) SetIndexedTextBytes(v int64) *TextDocumentStatistics

SetIndexedTextBytes sets the IndexedTextBytes field's value.

func (*TextDocumentStatistics) SetIndexedTextDocumentsCount

func (s *TextDocumentStatistics) SetIndexedTextDocumentsCount(v int64) *TextDocumentStatistics

SetIndexedTextDocumentsCount sets the IndexedTextDocumentsCount field's value.

func (TextDocumentStatistics) String

func (s TextDocumentStatistics) String() string

String returns the string representation

type TextWithHighlights

type TextWithHighlights struct {

    // The beginning and end of the text that should be highlighted.
    Highlights []*Highlight `type:"list"`

    // The text to display to the user.
    Text *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Provides text and information about where to highlight the text.

func (TextWithHighlights) GoString

func (s TextWithHighlights) GoString() string

GoString returns the string representation

func (*TextWithHighlights) SetHighlights

func (s *TextWithHighlights) SetHighlights(v []*Highlight) *TextWithHighlights

SetHighlights sets the Highlights field's value.

func (*TextWithHighlights) SetText

func (s *TextWithHighlights) SetText(v string) *TextWithHighlights

SetText sets the Text field's value.

func (TextWithHighlights) String

func (s TextWithHighlights) String() string

String returns the string representation

type ThrottlingException

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

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

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation

type TimeRange

type TimeRange struct {

    // The UNIX datetime of the end of the time range.
    EndTime *time.Time `type:"timestamp"`

    // The UNIX datetime of the beginning of the time range.
    StartTime *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Provides a range of time.

func (TimeRange) GoString

func (s TimeRange) GoString() string

GoString returns the string representation

func (*TimeRange) SetEndTime

func (s *TimeRange) SetEndTime(v time.Time) *TimeRange

SetEndTime sets the EndTime field's value.

func (*TimeRange) SetStartTime

func (s *TimeRange) SetStartTime(v time.Time) *TimeRange

SetStartTime sets the StartTime field's value.

func (TimeRange) String

func (s TimeRange) String() string

String returns the string representation

type UntagResourceInput

type UntagResourceInput struct {

    // The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove
    // the tag from.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`

    // A list of tag keys to remove from the index, FAQ, or data source. If a tag
    // key does not exist on the resource, it is ignored.
    //
    // TagKeys is a required field
    TagKeys []*string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateDataSourceInput

type UpdateDataSourceInput struct {

    // Configuration information for a Amazon Kendra data source.
    Configuration *DataSourceConfiguration `type:"structure"`

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

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

    // The identifier of the index that contains the data source to update.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The name of the data source to update. The name of the data source can't
    // be updated. To rename a data source you must delete the data source and re-create
    // it.
    Name *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the new role to use when the data source
    // is accessing resources on your behalf.
    RoleArn *string `min:"1" type:"string"`

    // The new update schedule for the data source.
    Schedule *string `type:"string"`
    // contains filtered or unexported fields
}

func (UpdateDataSourceInput) GoString

func (s UpdateDataSourceInput) GoString() string

GoString returns the string representation

func (*UpdateDataSourceInput) SetConfiguration

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

SetConfiguration sets the Configuration field's value.

func (*UpdateDataSourceInput) SetDescription

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

SetDescription sets the Description field's value.

func (*UpdateDataSourceInput) SetId

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

SetId sets the Id field's value.

func (*UpdateDataSourceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*UpdateDataSourceInput) SetName

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

SetName sets the Name field's value.

func (*UpdateDataSourceInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*UpdateDataSourceInput) SetSchedule

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

SetSchedule sets the Schedule field's value.

func (UpdateDataSourceInput) String

func (s UpdateDataSourceInput) String() string

String returns the string representation

func (*UpdateDataSourceInput) Validate

func (s *UpdateDataSourceInput) Validate() error

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

type UpdateDataSourceOutput

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

func (UpdateDataSourceOutput) GoString

func (s UpdateDataSourceOutput) GoString() string

GoString returns the string representation

func (UpdateDataSourceOutput) String

func (s UpdateDataSourceOutput) String() string

String returns the string representation

type UpdateIndexInput

type UpdateIndexInput struct {

    // Sets the number of addtional storage and query capacity units that should
    // be used by the index. You can change the capacity of the index up to 5 times
    // per day.
    //
    // If you are using extra storage units, you can't reduce the storage capacity
    // below that required to meet the storage needs for your index.
    CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

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

    // The document metadata to update.
    DocumentMetadataConfigurationUpdates []*DocumentMetadataConfiguration `type:"list"`

    // The identifier of the index to update.
    //
    // Id is a required field
    Id *string `min:"36" type:"string" required:"true"`

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

    // A new IAM role that gives Amazon Kendra permission to access your Amazon
    // CloudWatch logs.
    RoleArn *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (UpdateIndexInput) GoString

func (s UpdateIndexInput) GoString() string

GoString returns the string representation

func (*UpdateIndexInput) SetCapacityUnits

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

SetCapacityUnits sets the CapacityUnits field's value.

func (*UpdateIndexInput) SetDescription

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

SetDescription sets the Description field's value.

func (*UpdateIndexInput) SetDocumentMetadataConfigurationUpdates

func (s *UpdateIndexInput) SetDocumentMetadataConfigurationUpdates(v []*DocumentMetadataConfiguration) *UpdateIndexInput

SetDocumentMetadataConfigurationUpdates sets the DocumentMetadataConfigurationUpdates field's value.

func (*UpdateIndexInput) SetId

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

SetId sets the Id field's value.

func (*UpdateIndexInput) SetName

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

SetName sets the Name field's value.

func (*UpdateIndexInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (UpdateIndexInput) String

func (s UpdateIndexInput) String() string

String returns the string representation

func (*UpdateIndexInput) Validate

func (s *UpdateIndexInput) Validate() error

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

type UpdateIndexOutput

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

func (UpdateIndexOutput) GoString

func (s UpdateIndexOutput) GoString() string

GoString returns the string representation

func (UpdateIndexOutput) String

func (s UpdateIndexOutput) String() string

String returns the string representation

type ValidationException

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

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

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation