...
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) BatchGetDocumentStatus(input *BatchGetDocumentStatusInput) (*BatchGetDocumentStatusOutput, error)
func (c *Kendra) BatchGetDocumentStatusRequest(input *BatchGetDocumentStatusInput) (req *request.Request, output *BatchGetDocumentStatusOutput)
func (c *Kendra) BatchGetDocumentStatusWithContext(ctx aws.Context, input *BatchGetDocumentStatusInput, opts ...request.Option) (*BatchGetDocumentStatusOutput, 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) ClearQuerySuggestions(input *ClearQuerySuggestionsInput) (*ClearQuerySuggestionsOutput, error)
func (c *Kendra) ClearQuerySuggestionsRequest(input *ClearQuerySuggestionsInput) (req *request.Request, output *ClearQuerySuggestionsOutput)
func (c *Kendra) ClearQuerySuggestionsWithContext(ctx aws.Context, input *ClearQuerySuggestionsInput, opts ...request.Option) (*ClearQuerySuggestionsOutput, 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) CreateQuerySuggestionsBlockList(input *CreateQuerySuggestionsBlockListInput) (*CreateQuerySuggestionsBlockListOutput, error)
func (c *Kendra) CreateQuerySuggestionsBlockListRequest(input *CreateQuerySuggestionsBlockListInput) (req *request.Request, output *CreateQuerySuggestionsBlockListOutput)
func (c *Kendra) CreateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *CreateQuerySuggestionsBlockListInput, opts ...request.Option) (*CreateQuerySuggestionsBlockListOutput, error)
func (c *Kendra) CreateThesaurus(input *CreateThesaurusInput) (*CreateThesaurusOutput, error)
func (c *Kendra) CreateThesaurusRequest(input *CreateThesaurusInput) (req *request.Request, output *CreateThesaurusOutput)
func (c *Kendra) CreateThesaurusWithContext(ctx aws.Context, input *CreateThesaurusInput, opts ...request.Option) (*CreateThesaurusOutput, 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) DeletePrincipalMapping(input *DeletePrincipalMappingInput) (*DeletePrincipalMappingOutput, error)
func (c *Kendra) DeletePrincipalMappingRequest(input *DeletePrincipalMappingInput) (req *request.Request, output *DeletePrincipalMappingOutput)
func (c *Kendra) DeletePrincipalMappingWithContext(ctx aws.Context, input *DeletePrincipalMappingInput, opts ...request.Option) (*DeletePrincipalMappingOutput, error)
func (c *Kendra) DeleteQuerySuggestionsBlockList(input *DeleteQuerySuggestionsBlockListInput) (*DeleteQuerySuggestionsBlockListOutput, error)
func (c *Kendra) DeleteQuerySuggestionsBlockListRequest(input *DeleteQuerySuggestionsBlockListInput) (req *request.Request, output *DeleteQuerySuggestionsBlockListOutput)
func (c *Kendra) DeleteQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DeleteQuerySuggestionsBlockListInput, opts ...request.Option) (*DeleteQuerySuggestionsBlockListOutput, error)
func (c *Kendra) DeleteThesaurus(input *DeleteThesaurusInput) (*DeleteThesaurusOutput, error)
func (c *Kendra) DeleteThesaurusRequest(input *DeleteThesaurusInput) (req *request.Request, output *DeleteThesaurusOutput)
func (c *Kendra) DeleteThesaurusWithContext(ctx aws.Context, input *DeleteThesaurusInput, opts ...request.Option) (*DeleteThesaurusOutput, 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) DescribePrincipalMapping(input *DescribePrincipalMappingInput) (*DescribePrincipalMappingOutput, error)
func (c *Kendra) DescribePrincipalMappingRequest(input *DescribePrincipalMappingInput) (req *request.Request, output *DescribePrincipalMappingOutput)
func (c *Kendra) DescribePrincipalMappingWithContext(ctx aws.Context, input *DescribePrincipalMappingInput, opts ...request.Option) (*DescribePrincipalMappingOutput, error)
func (c *Kendra) DescribeQuerySuggestionsBlockList(input *DescribeQuerySuggestionsBlockListInput) (*DescribeQuerySuggestionsBlockListOutput, error)
func (c *Kendra) DescribeQuerySuggestionsBlockListRequest(input *DescribeQuerySuggestionsBlockListInput) (req *request.Request, output *DescribeQuerySuggestionsBlockListOutput)
func (c *Kendra) DescribeQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DescribeQuerySuggestionsBlockListInput, opts ...request.Option) (*DescribeQuerySuggestionsBlockListOutput, error)
func (c *Kendra) DescribeQuerySuggestionsConfig(input *DescribeQuerySuggestionsConfigInput) (*DescribeQuerySuggestionsConfigOutput, error)
func (c *Kendra) DescribeQuerySuggestionsConfigRequest(input *DescribeQuerySuggestionsConfigInput) (req *request.Request, output *DescribeQuerySuggestionsConfigOutput)
func (c *Kendra) DescribeQuerySuggestionsConfigWithContext(ctx aws.Context, input *DescribeQuerySuggestionsConfigInput, opts ...request.Option) (*DescribeQuerySuggestionsConfigOutput, error)
func (c *Kendra) DescribeThesaurus(input *DescribeThesaurusInput) (*DescribeThesaurusOutput, error)
func (c *Kendra) DescribeThesaurusRequest(input *DescribeThesaurusInput) (req *request.Request, output *DescribeThesaurusOutput)
func (c *Kendra) DescribeThesaurusWithContext(ctx aws.Context, input *DescribeThesaurusInput, opts ...request.Option) (*DescribeThesaurusOutput, error)
func (c *Kendra) GetQuerySuggestions(input *GetQuerySuggestionsInput) (*GetQuerySuggestionsOutput, error)
func (c *Kendra) GetQuerySuggestionsRequest(input *GetQuerySuggestionsInput) (req *request.Request, output *GetQuerySuggestionsOutput)
func (c *Kendra) GetQuerySuggestionsWithContext(ctx aws.Context, input *GetQuerySuggestionsInput, opts ...request.Option) (*GetQuerySuggestionsOutput, 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) ListGroupsOlderThanOrderingId(input *ListGroupsOlderThanOrderingIdInput) (*ListGroupsOlderThanOrderingIdOutput, error)
func (c *Kendra) ListGroupsOlderThanOrderingIdRequest(input *ListGroupsOlderThanOrderingIdInput) (req *request.Request, output *ListGroupsOlderThanOrderingIdOutput)
func (c *Kendra) ListGroupsOlderThanOrderingIdWithContext(ctx aws.Context, input *ListGroupsOlderThanOrderingIdInput, opts ...request.Option) (*ListGroupsOlderThanOrderingIdOutput, 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) ListQuerySuggestionsBlockLists(input *ListQuerySuggestionsBlockListsInput) (*ListQuerySuggestionsBlockListsOutput, error)
func (c *Kendra) ListQuerySuggestionsBlockListsRequest(input *ListQuerySuggestionsBlockListsInput) (req *request.Request, output *ListQuerySuggestionsBlockListsOutput)
func (c *Kendra) ListQuerySuggestionsBlockListsWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, opts ...request.Option) (*ListQuerySuggestionsBlockListsOutput, 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) ListThesauri(input *ListThesauriInput) (*ListThesauriOutput, error)
func (c *Kendra) ListThesauriRequest(input *ListThesauriInput) (req *request.Request, output *ListThesauriOutput)
func (c *Kendra) ListThesauriWithContext(ctx aws.Context, input *ListThesauriInput, opts ...request.Option) (*ListThesauriOutput, error)
func (c *Kendra) PutPrincipalMapping(input *PutPrincipalMappingInput) (*PutPrincipalMappingOutput, error)
func (c *Kendra) PutPrincipalMappingRequest(input *PutPrincipalMappingInput) (req *request.Request, output *PutPrincipalMappingOutput)
func (c *Kendra) PutPrincipalMappingWithContext(ctx aws.Context, input *PutPrincipalMappingInput, opts ...request.Option) (*PutPrincipalMappingOutput, 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 (c *Kendra) UpdateQuerySuggestionsBlockList(input *UpdateQuerySuggestionsBlockListInput) (*UpdateQuerySuggestionsBlockListOutput, error)
func (c *Kendra) UpdateQuerySuggestionsBlockListRequest(input *UpdateQuerySuggestionsBlockListInput) (req *request.Request, output *UpdateQuerySuggestionsBlockListOutput)
func (c *Kendra) UpdateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *UpdateQuerySuggestionsBlockListInput, opts ...request.Option) (*UpdateQuerySuggestionsBlockListOutput, error)
func (c *Kendra) UpdateQuerySuggestionsConfig(input *UpdateQuerySuggestionsConfigInput) (*UpdateQuerySuggestionsConfigOutput, error)
func (c *Kendra) UpdateQuerySuggestionsConfigRequest(input *UpdateQuerySuggestionsConfigInput) (req *request.Request, output *UpdateQuerySuggestionsConfigOutput)
func (c *Kendra) UpdateQuerySuggestionsConfigWithContext(ctx aws.Context, input *UpdateQuerySuggestionsConfigInput, opts ...request.Option) (*UpdateQuerySuggestionsConfigOutput, error)
func (c *Kendra) UpdateThesaurus(input *UpdateThesaurusInput) (*UpdateThesaurusOutput, error)
func (c *Kendra) UpdateThesaurusRequest(input *UpdateThesaurusInput) (req *request.Request, output *UpdateThesaurusOutput)
func (c *Kendra) UpdateThesaurusWithContext(ctx aws.Context, input *UpdateThesaurusInput, opts ...request.Option) (*UpdateThesaurusOutput, 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 DocumentStatus_Values() []string
func ErrorCode_Values() []string
func FaqFileFormat_Values() []string
func FaqStatus_Values() []string
func HighlightType_Values() []string
func IndexEdition_Values() []string
func IndexStatus_Values() []string
func KeyLocation_Values() []string
func Mode_Values() []string
func Order_Values() []string
func PrincipalMappingStatus_Values() []string
func PrincipalType_Values() []string
func QueryIdentifiersEnclosingOption_Values() []string
func QueryResultType_Values() []string
func QuerySuggestionsBlockListStatus_Values() []string
func QuerySuggestionsStatus_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 ServiceNowAuthenticationType_Values() []string
func ServiceNowBuildVersionType_Values() []string
func SharePointVersion_Values() []string
func SortOrder_Values() []string
func ThesaurusStatus_Values() []string
func UserContextPolicy_Values() []string
func UserGroupResolutionMode_Values() []string
func WebCrawlerMode_Values() []string
type AccessControlListConfiguration
type AccessDeniedException
type AclConfiguration
type AdditionalResultAttribute
type AdditionalResultAttributeValue
type AttributeFilter
type AuthenticationConfiguration
type BasicAuthenticationConfiguration
type BatchDeleteDocumentInput
type BatchDeleteDocumentOutput
type BatchDeleteDocumentResponseFailedDocument
type BatchGetDocumentStatusInput
type BatchGetDocumentStatusOutput
type BatchGetDocumentStatusResponseError
type BatchPutDocumentInput
type BatchPutDocumentOutput
type BatchPutDocumentResponseFailedDocument
type CapacityUnitsConfiguration
type ClearQuerySuggestionsInput
type ClearQuerySuggestionsOutput
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 CreateQuerySuggestionsBlockListInput
type CreateQuerySuggestionsBlockListOutput
type CreateThesaurusInput
type CreateThesaurusOutput
type DataSourceConfiguration
type DataSourceGroup
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 DeletePrincipalMappingInput
type DeletePrincipalMappingOutput
type DeleteQuerySuggestionsBlockListInput
type DeleteQuerySuggestionsBlockListOutput
type DeleteThesaurusInput
type DeleteThesaurusOutput
type DescribeDataSourceInput
type DescribeDataSourceOutput
type DescribeFaqInput
type DescribeFaqOutput
type DescribeIndexInput
type DescribeIndexOutput
type DescribePrincipalMappingInput
type DescribePrincipalMappingOutput
type DescribeQuerySuggestionsBlockListInput
type DescribeQuerySuggestionsBlockListOutput
type DescribeQuerySuggestionsConfigInput
type DescribeQuerySuggestionsConfigOutput
type DescribeThesaurusInput
type DescribeThesaurusOutput
type Document
type DocumentAttribute
type DocumentAttributeValue
type DocumentAttributeValueCountPair
type DocumentInfo
type DocumentMetadataConfiguration
type DocumentRelevanceConfiguration
type DocumentsMetadataConfiguration
type Facet
type FacetResult
type FaqStatistics
type FaqSummary
type GetQuerySuggestionsInput
type GetQuerySuggestionsOutput
type GoogleDriveConfiguration
type GroupMembers
type GroupOrderingIdSummary
type GroupSummary
type HierarchicalPrincipal
type Highlight
type IndexConfigurationSummary
type IndexStatistics
type InternalServerException
type JsonTokenTypeConfiguration
type JwtTokenTypeConfiguration
type ListDataSourceSyncJobsInput
type ListDataSourceSyncJobsOutput
type ListDataSourcesInput
type ListDataSourcesOutput
type ListFaqsInput
type ListFaqsOutput
type ListGroupsOlderThanOrderingIdInput
type ListGroupsOlderThanOrderingIdOutput
type ListIndicesInput
type ListIndicesOutput
type ListQuerySuggestionsBlockListsInput
type ListQuerySuggestionsBlockListsOutput
type ListTagsForResourceInput
type ListTagsForResourceOutput
type ListThesauriInput
type ListThesauriOutput
type MemberGroup
type MemberUser
type OneDriveConfiguration
type OneDriveUsers
type Principal
type ProxyConfiguration
type PutPrincipalMappingInput
type PutPrincipalMappingOutput
type QueryInput
type QueryOutput
type QueryResultItem
type QuerySuggestionsBlockListSummary
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 SeedUrlConfiguration
type ServerSideEncryptionConfiguration
type ServiceNowConfiguration
type ServiceNowKnowledgeArticleConfiguration
type ServiceNowServiceCatalogConfiguration
type ServiceQuotaExceededException
type SharePointConfiguration
type SiteMapsConfiguration
type SortingConfiguration
type SqlConfiguration
type StartDataSourceSyncJobInput
type StartDataSourceSyncJobOutput
type Status
type StopDataSourceSyncJobInput
type StopDataSourceSyncJobOutput
type SubmitFeedbackInput
type SubmitFeedbackOutput
type Suggestion
type SuggestionHighlight
type SuggestionTextWithHighlights
type SuggestionValue
type Tag
type TagResourceInput
type TagResourceOutput
type TextDocumentStatistics
type TextWithHighlights
type ThesaurusSummary
type ThrottlingException
type TimeRange
type UntagResourceInput
type UntagResourceOutput
type UpdateDataSourceInput
type UpdateDataSourceOutput
type UpdateIndexInput
type UpdateIndexOutput
type UpdateQuerySuggestionsBlockListInput
type UpdateQuerySuggestionsBlockListOutput
type UpdateQuerySuggestionsConfigInput
type UpdateQuerySuggestionsConfigOutput
type UpdateThesaurusInput
type UpdateThesaurusOutput
type Urls
type UserContext
type UserGroupResolutionConfiguration
type UserTokenConfiguration
type ValidationException
type WebCrawlerConfiguration
type WorkDocsConfiguration

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 (
    // ConfluenceVersionCloud is a ConfluenceVersion enum value
    ConfluenceVersionCloud = "CLOUD"

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

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

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

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

    // ContentTypePpt is a ContentType enum value
    ContentTypePpt = "PPT"
)
const (
    // DataSourceStatusCreating is a DataSourceStatus enum value
    DataSourceStatusCreating = "CREATING"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // DataSourceTypeWorkdocs is a DataSourceType enum value
    DataSourceTypeWorkdocs = "WORKDOCS"
)
const (
    // DatabaseEngineTypeRdsAuroraMysql is a DatabaseEngineType enum value
    DatabaseEngineTypeRdsAuroraMysql = "RDS_AURORA_MYSQL"

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

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

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

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

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

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

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

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

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

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

    // DocumentStatusUpdateFailed is a DocumentStatus enum value
    DocumentStatusUpdateFailed = "UPDATE_FAILED"
)
const (
    // ErrorCodeInternalError is a ErrorCode enum value
    ErrorCodeInternalError = "InternalError"

    // ErrorCodeInvalidRequest is a ErrorCode enum value
    ErrorCodeInvalidRequest = "InvalidRequest"
)
const (
    // FaqFileFormatCsv is a FaqFileFormat enum value
    FaqFileFormatCsv = "CSV"

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

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

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

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

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

    // FaqStatusFailed is a FaqStatus enum value
    FaqStatusFailed = "FAILED"
)
const (
    // HighlightTypeStandard is a HighlightType enum value
    HighlightTypeStandard = "STANDARD"

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

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

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

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

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

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

    // IndexStatusSystemUpdating is a IndexStatus enum value
    IndexStatusSystemUpdating = "SYSTEM_UPDATING"
)
const (
    // KeyLocationUrl is a KeyLocation enum value
    KeyLocationUrl = "URL"

    // KeyLocationSecretManager is a KeyLocation enum value
    KeyLocationSecretManager = "SECRET_MANAGER"
)
const (
    // ModeEnabled is a Mode enum value
    ModeEnabled = "ENABLED"

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

    // OrderDescending is a Order enum value
    OrderDescending = "DESCENDING"
)
const (
    // PrincipalMappingStatusFailed is a PrincipalMappingStatus enum value
    PrincipalMappingStatusFailed = "FAILED"

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

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

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

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

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

    // QueryIdentifiersEnclosingOptionNone is a QueryIdentifiersEnclosingOption enum value
    QueryIdentifiersEnclosingOptionNone = "NONE"
)
const (
    // QueryResultTypeDocument is a QueryResultType enum value
    QueryResultTypeDocument = "DOCUMENT"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Enumeration for query score confidence.

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

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

    // ServiceNowBuildVersionTypeOthers is a ServiceNowBuildVersionType enum value
    ServiceNowBuildVersionTypeOthers = "OTHERS"
)
const (
    // SharePointVersionSharepoint2013 is a SharePointVersion enum value
    SharePointVersionSharepoint2013 = "SHAREPOINT_2013"

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

    // SharePointVersionSharepointOnline is a SharePointVersion enum value
    SharePointVersionSharepointOnline = "SHAREPOINT_ONLINE"
)
const (
    // SortOrderDesc is a SortOrder enum value
    SortOrderDesc = "DESC"

    // SortOrderAsc is a SortOrder enum value
    SortOrderAsc = "ASC"
)
const (
    // ThesaurusStatusCreating is a ThesaurusStatus enum value
    ThesaurusStatusCreating = "CREATING"

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

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

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

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

    // ThesaurusStatusFailed is a ThesaurusStatus enum value
    ThesaurusStatusFailed = "FAILED"
)
const (
    // UserContextPolicyAttributeFilter is a UserContextPolicy enum value
    UserContextPolicyAttributeFilter = "ATTRIBUTE_FILTER"

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

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

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

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

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    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"
)

func AdditionalResultAttributeValueType_Values

func AdditionalResultAttributeValueType_Values() []string

AdditionalResultAttributeValueType_Values returns all elements of the AdditionalResultAttributeValueType enum

func ConfluenceAttachmentFieldName_Values

func ConfluenceAttachmentFieldName_Values() []string

ConfluenceAttachmentFieldName_Values returns all elements of the ConfluenceAttachmentFieldName enum

func ConfluenceBlogFieldName_Values

func ConfluenceBlogFieldName_Values() []string

ConfluenceBlogFieldName_Values returns all elements of the ConfluenceBlogFieldName enum

func ConfluencePageFieldName_Values

func ConfluencePageFieldName_Values() []string

ConfluencePageFieldName_Values returns all elements of the ConfluencePageFieldName enum

func ConfluenceSpaceFieldName_Values

func ConfluenceSpaceFieldName_Values() []string

ConfluenceSpaceFieldName_Values returns all elements of the ConfluenceSpaceFieldName enum

func ConfluenceVersion_Values

func ConfluenceVersion_Values() []string

ConfluenceVersion_Values returns all elements of the ConfluenceVersion enum

func ContentType_Values

func ContentType_Values() []string

ContentType_Values returns all elements of the ContentType enum

func DataSourceStatus_Values

func DataSourceStatus_Values() []string

DataSourceStatus_Values returns all elements of the DataSourceStatus enum

func DataSourceSyncJobStatus_Values

func DataSourceSyncJobStatus_Values() []string

DataSourceSyncJobStatus_Values returns all elements of the DataSourceSyncJobStatus enum

func DataSourceType_Values

func DataSourceType_Values() []string

DataSourceType_Values returns all elements of the DataSourceType enum

func DatabaseEngineType_Values

func DatabaseEngineType_Values() []string

DatabaseEngineType_Values returns all elements of the DatabaseEngineType enum

func DocumentAttributeValueType_Values

func DocumentAttributeValueType_Values() []string

DocumentAttributeValueType_Values returns all elements of the DocumentAttributeValueType enum

func DocumentStatus_Values

func DocumentStatus_Values() []string

DocumentStatus_Values returns all elements of the DocumentStatus enum

func ErrorCode_Values

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func FaqFileFormat_Values

func FaqFileFormat_Values() []string

FaqFileFormat_Values returns all elements of the FaqFileFormat enum

func FaqStatus_Values

func FaqStatus_Values() []string

FaqStatus_Values returns all elements of the FaqStatus enum

func HighlightType_Values

func HighlightType_Values() []string

HighlightType_Values returns all elements of the HighlightType enum

func IndexEdition_Values

func IndexEdition_Values() []string

IndexEdition_Values returns all elements of the IndexEdition enum

func IndexStatus_Values

func IndexStatus_Values() []string

IndexStatus_Values returns all elements of the IndexStatus enum

func KeyLocation_Values

func KeyLocation_Values() []string

KeyLocation_Values returns all elements of the KeyLocation enum

func Mode_Values

func Mode_Values() []string

Mode_Values returns all elements of the Mode enum

func Order_Values

func Order_Values() []string

Order_Values returns all elements of the Order enum

func PrincipalMappingStatus_Values

func PrincipalMappingStatus_Values() []string

PrincipalMappingStatus_Values returns all elements of the PrincipalMappingStatus enum

func PrincipalType_Values

func PrincipalType_Values() []string

PrincipalType_Values returns all elements of the PrincipalType enum

func QueryIdentifiersEnclosingOption_Values

func QueryIdentifiersEnclosingOption_Values() []string

QueryIdentifiersEnclosingOption_Values returns all elements of the QueryIdentifiersEnclosingOption enum

func QueryResultType_Values

func QueryResultType_Values() []string

QueryResultType_Values returns all elements of the QueryResultType enum

func QuerySuggestionsBlockListStatus_Values

func QuerySuggestionsBlockListStatus_Values() []string

QuerySuggestionsBlockListStatus_Values returns all elements of the QuerySuggestionsBlockListStatus enum

func QuerySuggestionsStatus_Values

func QuerySuggestionsStatus_Values() []string

QuerySuggestionsStatus_Values returns all elements of the QuerySuggestionsStatus enum

func ReadAccessType_Values

func ReadAccessType_Values() []string

ReadAccessType_Values returns all elements of the ReadAccessType enum

func RelevanceType_Values

func RelevanceType_Values() []string

RelevanceType_Values returns all elements of the RelevanceType enum

func SalesforceChatterFeedIncludeFilterType_Values

func SalesforceChatterFeedIncludeFilterType_Values() []string

SalesforceChatterFeedIncludeFilterType_Values returns all elements of the SalesforceChatterFeedIncludeFilterType enum

func SalesforceKnowledgeArticleState_Values

func SalesforceKnowledgeArticleState_Values() []string

SalesforceKnowledgeArticleState_Values returns all elements of the SalesforceKnowledgeArticleState enum

func SalesforceStandardObjectName_Values

func SalesforceStandardObjectName_Values() []string

SalesforceStandardObjectName_Values returns all elements of the SalesforceStandardObjectName enum

func ScoreConfidence_Values

func ScoreConfidence_Values() []string

ScoreConfidence_Values returns all elements of the ScoreConfidence enum

func ServiceNowAuthenticationType_Values

func ServiceNowAuthenticationType_Values() []string

ServiceNowAuthenticationType_Values returns all elements of the ServiceNowAuthenticationType enum

func ServiceNowBuildVersionType_Values

func ServiceNowBuildVersionType_Values() []string

ServiceNowBuildVersionType_Values returns all elements of the ServiceNowBuildVersionType enum

func SharePointVersion_Values

func SharePointVersion_Values() []string

SharePointVersion_Values returns all elements of the SharePointVersion enum

func SortOrder_Values

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func ThesaurusStatus_Values

func ThesaurusStatus_Values() []string

ThesaurusStatus_Values returns all elements of the ThesaurusStatus enum

func UserContextPolicy_Values

func UserContextPolicy_Values() []string

UserContextPolicy_Values returns all elements of the UserContextPolicy enum

func UserGroupResolutionMode_Values

func UserGroupResolutionMode_Values() []string

UserGroupResolutionMode_Values returns all elements of the UserGroupResolutionMode enum

func WebCrawlerMode_Values

func WebCrawlerMode_Values() []string

WebCrawlerMode_Values returns all elements of the WebCrawlerMode enum

type AccessControlListConfiguration

type AccessControlListConfiguration struct {

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

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

func (AccessControlListConfiguration) GoString

func (s AccessControlListConfiguration) GoString() string

GoString returns the string representation.

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

func (*AccessControlListConfiguration) SetKeyPath

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

SetKeyPath sets the KeyPath field's value.

func (AccessControlListConfiguration) String

func (s AccessControlListConfiguration) String() string

String returns the string representation.

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

func (*AccessControlListConfiguration) Validate

func (s *AccessControlListConfiguration) Validate() error

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

type AccessDeniedException

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

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

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

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

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

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

type AclConfiguration

type AclConfiguration struct {

    // A list of groups, separated by semi-colons, that filters a query response
    // based on user context. The document is only returned to users that are in
    // one of the groups specified in the UserContext field of the Query 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.

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

func (*AclConfiguration) SetAllowedGroupsColumnName

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

SetAllowedGroupsColumnName sets the AllowedGroupsColumnName field's value.

func (AclConfiguration) String

func (s AclConfiguration) String() string

String returns the string representation.

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

func (*AclConfiguration) Validate

func (s *AclConfiguration) Validate() error

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

type AdditionalResultAttribute

type AdditionalResultAttribute struct {

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

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

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

An attribute returned from an index query.

func (AdditionalResultAttribute) GoString

func (s AdditionalResultAttribute) GoString() string

GoString returns the string representation.

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

func (*AdditionalResultAttribute) SetKey

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

SetKey sets the Key field's value.

func (*AdditionalResultAttribute) SetValue

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

SetValue sets the Value field's value.

func (*AdditionalResultAttribute) SetValueType

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

SetValueType sets the ValueType field's value.

func (AdditionalResultAttribute) String

func (s AdditionalResultAttribute) String() string

String returns the string representation.

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

type AdditionalResultAttributeValue

type AdditionalResultAttributeValue struct {

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

An attribute returned with a document from a search.

func (AdditionalResultAttributeValue) GoString

func (s AdditionalResultAttributeValue) GoString() string

GoString returns the string representation.

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

func (*AdditionalResultAttributeValue) SetTextWithHighlightsValue

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

SetTextWithHighlightsValue sets the TextWithHighlightsValue field's value.

func (AdditionalResultAttributeValue) String

func (s AdditionalResultAttributeValue) String() string

String returns the string representation.

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

type 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 Date or Long.
    GreaterThan *DocumentAttribute `type:"structure"`

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

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

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

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

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

Provides filtering the query results based on document attributes.

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

If you use more than 10 attribute filters in a given list for AndAllFilters or OrAllFilters, you receive a ValidationException with the message "AttributeFilter cannot have a length of more than 10".

func (AttributeFilter) GoString

func (s AttributeFilter) GoString() string

GoString returns the string representation.

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

func (*AttributeFilter) SetAndAllFilters

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

SetAndAllFilters sets the AndAllFilters field's value.

func (*AttributeFilter) SetContainsAll

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

SetContainsAll sets the ContainsAll field's value.

func (*AttributeFilter) SetContainsAny

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

SetContainsAny sets the ContainsAny field's value.

func (*AttributeFilter) SetEqualsTo

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

SetEqualsTo sets the EqualsTo field's value.

func (*AttributeFilter) SetGreaterThan

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

SetGreaterThan sets the GreaterThan field's value.

func (*AttributeFilter) SetGreaterThanOrEquals

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

SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value.

func (*AttributeFilter) SetLessThan

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

SetLessThan sets the LessThan field's value.

func (*AttributeFilter) SetLessThanOrEquals

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

SetLessThanOrEquals sets the LessThanOrEquals field's value.

func (*AttributeFilter) SetNotFilter

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

SetNotFilter sets the NotFilter field's value.

func (*AttributeFilter) SetOrAllFilters

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

SetOrAllFilters sets the OrAllFilters field's value.

func (AttributeFilter) String

func (s AttributeFilter) String() string

String returns the string representation.

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

func (*AttributeFilter) Validate

func (s *AttributeFilter) Validate() error

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

type AuthenticationConfiguration

type AuthenticationConfiguration struct {

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

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

func (AuthenticationConfiguration) GoString

func (s AuthenticationConfiguration) GoString() string

GoString returns the string representation.

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

func (*AuthenticationConfiguration) SetBasicAuthentication

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

SetBasicAuthentication sets the BasicAuthentication field's value.

func (AuthenticationConfiguration) String

func (s AuthenticationConfiguration) String() string

String returns the string representation.

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

func (*AuthenticationConfiguration) Validate

func (s *AuthenticationConfiguration) Validate() error

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

type BasicAuthenticationConfiguration

type BasicAuthenticationConfiguration struct {

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

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

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

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

func (BasicAuthenticationConfiguration) GoString

func (s BasicAuthenticationConfiguration) GoString() string

GoString returns the string representation.

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

func (*BasicAuthenticationConfiguration) SetCredentials

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

SetCredentials sets the Credentials field's value.

func (*BasicAuthenticationConfiguration) SetHost

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

SetHost sets the Host field's value.

func (*BasicAuthenticationConfiguration) SetPort

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

SetPort sets the Port field's value.

func (BasicAuthenticationConfiguration) String

func (s BasicAuthenticationConfiguration) String() string

String returns the string representation.

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

func (*BasicAuthenticationConfiguration) Validate

func (s *BasicAuthenticationConfiguration) Validate() error

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

type BatchDeleteDocumentInput

type BatchDeleteDocumentInput struct {

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

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

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

func (BatchDeleteDocumentInput) GoString

func (s BatchDeleteDocumentInput) GoString() string

GoString returns the string representation.

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

func (*BatchDeleteDocumentInput) SetDataSourceSyncJobMetricTarget

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

SetDataSourceSyncJobMetricTarget sets the DataSourceSyncJobMetricTarget field's value.

func (*BatchDeleteDocumentInput) SetDocumentIdList

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

SetDocumentIdList sets the DocumentIdList field's value.

func (*BatchDeleteDocumentInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (BatchDeleteDocumentInput) String

func (s BatchDeleteDocumentInput) String() string

String returns the string representation.

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

func (*BatchDeleteDocumentInput) Validate

func (s *BatchDeleteDocumentInput) Validate() error

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

type BatchDeleteDocumentOutput

type BatchDeleteDocumentOutput struct {

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

func (BatchDeleteDocumentOutput) GoString

func (s BatchDeleteDocumentOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDeleteDocumentOutput) SetFailedDocuments

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

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchDeleteDocumentOutput) String

func (s BatchDeleteDocumentOutput) String() string

String returns the string representation.

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

type BatchDeleteDocumentResponseFailedDocument

type BatchDeleteDocumentResponseFailedDocument struct {

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

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

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

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

func (BatchDeleteDocumentResponseFailedDocument) GoString

func (s BatchDeleteDocumentResponseFailedDocument) GoString() string

GoString returns the string representation.

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

func (*BatchDeleteDocumentResponseFailedDocument) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchDeleteDocumentResponseFailedDocument) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchDeleteDocumentResponseFailedDocument) SetId

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

SetId sets the Id field's value.

func (BatchDeleteDocumentResponseFailedDocument) String

func (s BatchDeleteDocumentResponseFailedDocument) String() string

String returns the string representation.

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

type BatchGetDocumentStatusInput

type BatchGetDocumentStatusInput struct {

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

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

func (BatchGetDocumentStatusInput) GoString

func (s BatchGetDocumentStatusInput) GoString() string

GoString returns the string representation.

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

func (*BatchGetDocumentStatusInput) SetDocumentInfoList

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

SetDocumentInfoList sets the DocumentInfoList field's value.

func (*BatchGetDocumentStatusInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (BatchGetDocumentStatusInput) String

func (s BatchGetDocumentStatusInput) String() string

String returns the string representation.

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

func (*BatchGetDocumentStatusInput) Validate

func (s *BatchGetDocumentStatusInput) Validate() error

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

type BatchGetDocumentStatusOutput

type BatchGetDocumentStatusOutput struct {

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

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

func (BatchGetDocumentStatusOutput) GoString

func (s BatchGetDocumentStatusOutput) GoString() string

GoString returns the string representation.

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

func (*BatchGetDocumentStatusOutput) SetDocumentStatusList

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

SetDocumentStatusList sets the DocumentStatusList field's value.

func (*BatchGetDocumentStatusOutput) SetErrors

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

SetErrors sets the Errors field's value.

func (BatchGetDocumentStatusOutput) String

func (s BatchGetDocumentStatusOutput) String() string

String returns the string representation.

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

type BatchGetDocumentStatusResponseError

type BatchGetDocumentStatusResponseError struct {

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

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

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

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

func (BatchGetDocumentStatusResponseError) GoString

func (s BatchGetDocumentStatusResponseError) GoString() string

GoString returns the string representation.

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

func (*BatchGetDocumentStatusResponseError) SetDocumentId

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

SetDocumentId sets the DocumentId field's value.

func (*BatchGetDocumentStatusResponseError) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetDocumentStatusResponseError) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (BatchGetDocumentStatusResponseError) String

func (s BatchGetDocumentStatusResponseError) String() string

String returns the string representation.

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

type BatchPutDocumentInput

type BatchPutDocumentInput struct {

    // One or more documents to add to the index.
    //
    // Documents can include custom attributes. For example, 'DataSourceId' and
    // 'DataSourceSyncJobId' are custom attributes that provide information on the
    // synchronization of documents running on a data source. Note, 'DataSourceSyncJobId'
    // could be an optional custom attribute as Amazon Kendra will use the ID of
    // a running sync job.
    //
    // Documents have the following file size limits.
    //
    //    * 5 MB total size for inline documents
    //
    //    * 50 MB total size for files from an S3 bucket
    //
    //    * 5 MB extracted text for any file
    //
    // For more information about file size and transaction per second quotas, see
    // Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
    //
    // Documents is a required field
    Documents []*Document `min:"1" type:"list" required:"true"`

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

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

func (BatchPutDocumentInput) GoString

func (s BatchPutDocumentInput) GoString() string

GoString returns the string representation.

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

func (*BatchPutDocumentInput) SetDocuments

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

SetDocuments sets the Documents field's value.

func (*BatchPutDocumentInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*BatchPutDocumentInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (BatchPutDocumentInput) String

func (s BatchPutDocumentInput) String() string

String returns the string representation.

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

func (*BatchPutDocumentInput) Validate

func (s *BatchPutDocumentInput) Validate() error

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

type BatchPutDocumentOutput

type BatchPutDocumentOutput struct {

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

func (BatchPutDocumentOutput) GoString

func (s BatchPutDocumentOutput) GoString() string

GoString returns the string representation.

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

func (*BatchPutDocumentOutput) SetFailedDocuments

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

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchPutDocumentOutput) String

func (s BatchPutDocumentOutput) String() string

String returns the string representation.

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

type BatchPutDocumentResponseFailedDocument

type BatchPutDocumentResponseFailedDocument struct {

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

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

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

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

func (*BatchPutDocumentResponseFailedDocument) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchPutDocumentResponseFailedDocument) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchPutDocumentResponseFailedDocument) SetId

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

SetId sets the Id field's value.

func (BatchPutDocumentResponseFailedDocument) String

func (s BatchPutDocumentResponseFailedDocument) String() string

String returns the string representation.

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

type CapacityUnitsConfiguration

type CapacityUnitsConfiguration struct {

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

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

Specifies capacity units configured for your enterprise edition 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.

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

func (*CapacityUnitsConfiguration) SetQueryCapacityUnits

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

SetQueryCapacityUnits sets the QueryCapacityUnits field's value.

func (*CapacityUnitsConfiguration) SetStorageCapacityUnits

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

SetStorageCapacityUnits sets the StorageCapacityUnits field's value.

func (CapacityUnitsConfiguration) String

func (s CapacityUnitsConfiguration) String() string

String returns the string representation.

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

func (*CapacityUnitsConfiguration) Validate

func (s *CapacityUnitsConfiguration) Validate() error

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

type ClearQuerySuggestionsInput

type ClearQuerySuggestionsInput struct {

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

func (ClearQuerySuggestionsInput) GoString

func (s ClearQuerySuggestionsInput) GoString() string

GoString returns the string representation.

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

func (*ClearQuerySuggestionsInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (ClearQuerySuggestionsInput) String

func (s ClearQuerySuggestionsInput) String() string

String returns the string representation.

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

func (*ClearQuerySuggestionsInput) Validate

func (s *ClearQuerySuggestionsInput) Validate() error

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

type ClearQuerySuggestionsOutput

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

func (ClearQuerySuggestionsOutput) GoString

func (s ClearQuerySuggestionsOutput) GoString() string

GoString returns the string representation.

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

func (ClearQuerySuggestionsOutput) String

func (s ClearQuerySuggestionsOutput) String() string

String returns the string representation.

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

type ClickFeedback

type ClickFeedback struct {

    // The Unix timestamp 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.

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

func (*ClickFeedback) SetClickTime

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

SetClickTime sets the ClickTime field's value.

func (*ClickFeedback) SetResultId

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

SetResultId sets the ResultId field's value.

func (ClickFeedback) String

func (s ClickFeedback) String() string

String returns the string representation.

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

func (*ClickFeedback) Validate

func (s *ClickFeedback) Validate() error

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

type ColumnConfiguration

type ColumnConfiguration struct {

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

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

    // The column that provides the document's 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.

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

func (*ColumnConfiguration) SetChangeDetectingColumns

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

SetChangeDetectingColumns sets the ChangeDetectingColumns field's value.

func (*ColumnConfiguration) SetDocumentDataColumnName

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

SetDocumentDataColumnName sets the DocumentDataColumnName field's value.

func (*ColumnConfiguration) SetDocumentIdColumnName

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

SetDocumentIdColumnName sets the DocumentIdColumnName field's value.

func (*ColumnConfiguration) SetDocumentTitleColumnName

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

SetDocumentTitleColumnName sets the DocumentTitleColumnName field's value.

func (*ColumnConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (ColumnConfiguration) String

func (s ColumnConfiguration) String() string

String returns the string representation.

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

func (*ColumnConfiguration) Validate

func (s *ColumnConfiguration) Validate() error

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

type ConflictException

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

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

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

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

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

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

func (*ConfluenceAttachmentConfiguration) SetAttachmentFieldMappings

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

SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value.

func (*ConfluenceAttachmentConfiguration) SetCrawlAttachments

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

SetCrawlAttachments sets the CrawlAttachments field's value.

func (ConfluenceAttachmentConfiguration) String

func (s ConfluenceAttachmentConfiguration) String() string

String returns the string representation.

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

func (*ConfluenceAttachmentConfiguration) Validate

func (s *ConfluenceAttachmentConfiguration) Validate() error

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

type ConfluenceAttachmentToIndexFieldMapping

type ConfluenceAttachmentToIndexFieldMapping struct {

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

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

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

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

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

func (ConfluenceAttachmentToIndexFieldMapping) GoString

func (s ConfluenceAttachmentToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluenceAttachmentToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceAttachmentToIndexFieldMapping) String

func (s ConfluenceAttachmentToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluenceAttachmentToIndexFieldMapping) Validate

func (s *ConfluenceAttachmentToIndexFieldMapping) Validate() error

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

type ConfluenceBlogConfiguration

type ConfluenceBlogConfiguration struct {

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

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

func (ConfluenceBlogConfiguration) GoString

func (s ConfluenceBlogConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConfluenceBlogConfiguration) SetBlogFieldMappings

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

SetBlogFieldMappings sets the BlogFieldMappings field's value.

func (ConfluenceBlogConfiguration) String

func (s ConfluenceBlogConfiguration) String() string

String returns the string representation.

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

func (*ConfluenceBlogConfiguration) Validate

func (s *ConfluenceBlogConfiguration) Validate() error

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

type ConfluenceBlogToIndexFieldMapping

type ConfluenceBlogToIndexFieldMapping struct {

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

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

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

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

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

func (ConfluenceBlogToIndexFieldMapping) GoString

func (s ConfluenceBlogToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluenceBlogToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceBlogToIndexFieldMapping) String

func (s ConfluenceBlogToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluenceBlogToIndexFieldMapping) Validate

func (s *ConfluenceBlogToIndexFieldMapping) Validate() error

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

type ConfluenceConfiguration

type ConfluenceConfiguration struct {

    // 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 Secrets Managersecret that contains
    // the key/value pairs required to connect to your Confluence server. The secret
    // must contain a JSON structure with the following keys:
    //
    //    * username - The user name or email address of a user with administrative
    //    privileges for the Confluence server.
    //
    //    * password - The password associated with the user logging in to the Confluence
    //    server.
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`

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

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

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

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

Provides configuration information for data sources that connect to Confluence.

func (ConfluenceConfiguration) GoString

func (s ConfluenceConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConfluenceConfiguration) SetAttachmentConfiguration

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

SetAttachmentConfiguration sets the AttachmentConfiguration field's value.

func (*ConfluenceConfiguration) 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.

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

func (*ConfluenceConfiguration) Validate

func (s *ConfluenceConfiguration) Validate() error

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

type ConfluencePageConfiguration

type ConfluencePageConfiguration struct {

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

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

func (*ConfluencePageConfiguration) SetPageFieldMappings

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

SetPageFieldMappings sets the PageFieldMappings field's value.

func (ConfluencePageConfiguration) String

func (s ConfluencePageConfiguration) String() string

String returns the string representation.

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

func (*ConfluencePageConfiguration) Validate

func (s *ConfluencePageConfiguration) Validate() error

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

type ConfluencePageToIndexFieldMapping

type ConfluencePageToIndexFieldMapping struct {

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

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

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

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

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

func (ConfluencePageToIndexFieldMapping) GoString

func (s ConfluencePageToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluencePageToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluencePageToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluencePageToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluencePageToIndexFieldMapping) String

func (s ConfluencePageToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluencePageToIndexFieldMapping) Validate

func (s *ConfluencePageToIndexFieldMapping) Validate() error

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

type ConfluenceSpaceConfiguration

type ConfluenceSpaceConfiguration struct {

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

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

func (*ConfluenceSpaceConfiguration) SetCrawlArchivedSpaces

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

SetCrawlArchivedSpaces sets the CrawlArchivedSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetCrawlPersonalSpaces

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

SetCrawlPersonalSpaces sets the CrawlPersonalSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetExcludeSpaces

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

SetExcludeSpaces sets the ExcludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetIncludeSpaces

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

SetIncludeSpaces sets the IncludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetSpaceFieldMappings

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

SetSpaceFieldMappings sets the SpaceFieldMappings field's value.

func (ConfluenceSpaceConfiguration) String

func (s ConfluenceSpaceConfiguration) String() string

String returns the string representation.

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

func (*ConfluenceSpaceConfiguration) Validate

func (s *ConfluenceSpaceConfiguration) Validate() error

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

type ConfluenceSpaceToIndexFieldMapping

type ConfluenceSpaceToIndexFieldMapping struct {

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

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

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

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

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

func (ConfluenceSpaceToIndexFieldMapping) GoString

func (s ConfluenceSpaceToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluenceSpaceToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceSpaceToIndexFieldMapping) String

func (s ConfluenceSpaceToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluenceSpaceToIndexFieldMapping) Validate

func (s *ConfluenceSpaceToIndexFieldMapping) Validate() error

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

type ConnectionConfiguration

type ConnectionConfiguration struct {

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

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

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

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

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

Provides the information necessary to connect to a database.

func (ConnectionConfiguration) GoString

func (s ConnectionConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConnectionConfiguration) SetDatabaseHost

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

SetDatabaseHost sets the DatabaseHost field's value.

func (*ConnectionConfiguration) SetDatabaseName

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

SetDatabaseName sets the DatabaseName field's value.

func (*ConnectionConfiguration) SetDatabasePort

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

SetDatabasePort sets the DatabasePort field's value.

func (*ConnectionConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*ConnectionConfiguration) SetTableName

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

SetTableName sets the TableName field's value.

func (ConnectionConfiguration) String

func (s ConnectionConfiguration) String() string

String returns the string representation.

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

func (*ConnectionConfiguration) Validate

func (s *ConnectionConfiguration) Validate() error

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

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

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

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

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

func (*CreateDataSourceInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateDataSourceInput) SetConfiguration

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

SetConfiguration sets the Configuration field's value.

func (*CreateDataSourceInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateDataSourceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateDataSourceInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*CreateDataSourceInput) SetName

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

SetName sets the Name field's value.

func (*CreateDataSourceInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateDataSourceInput) SetSchedule

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

SetSchedule sets the Schedule field's value.

func (*CreateDataSourceInput) SetTags

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

SetTags sets the Tags field's value.

func (*CreateDataSourceInput) SetType

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

SetType sets the Type field's value.

func (CreateDataSourceInput) String

func (s CreateDataSourceInput) String() string

String returns the string representation.

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

func (*CreateDataSourceInput) Validate

func (s *CreateDataSourceInput) Validate() error

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

type CreateDataSourceOutput

type CreateDataSourceOutput struct {

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

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

func (*CreateDataSourceOutput) SetId

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

SetId sets the Id field's value.

func (CreateDataSourceOutput) String

func (s CreateDataSourceOutput) String() string

String returns the string representation.

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

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

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

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

func (*CreateFaqInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateFaqInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateFaqInput) SetFileFormat

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

SetFileFormat sets the FileFormat field's value.

func (*CreateFaqInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateFaqInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*CreateFaqInput) SetName

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

SetName sets the Name field's value.

func (*CreateFaqInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateFaqInput) SetS3Path

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

SetS3Path sets the S3Path field's value.

func (*CreateFaqInput) SetTags

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

SetTags sets the Tags field's value.

func (CreateFaqInput) String

func (s CreateFaqInput) String() string

String returns the string representation.

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

func (*CreateFaqInput) Validate

func (s *CreateFaqInput) Validate() error

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

type CreateFaqOutput

type CreateFaqOutput struct {

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

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

func (*CreateFaqOutput) SetId

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

SetId sets the Id field's value.

func (CreateFaqOutput) String

func (s CreateFaqOutput) String() string

String returns the string representation.

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

type 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.
    //
    // For more information on quota limits for enterprise and developer editions,
    // see Quotas (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
    Edition *string `type:"string" enum:"IndexEdition"`

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

    // An 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 KMScustomer managed key (CMK) to use to encrypt data
    // indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
    ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

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

    // The user context policy.
    //
    // ATTRIBUTE_FILTER
    //
    // All indexed content is searchable and displayable for all users. If you want
    // to filter search results on user context, you can use the attribute filters
    // of _user_id and _group_ids or you can provide user and group information
    // in UserContext.
    //
    // USER_TOKEN
    //
    // Enables token-based user access control to filter search results on user
    // context. All documents with no access control and all documents accessible
    // to the user will be searchable and displayable.
    UserContextPolicy *string `type:"string" enum:"UserContextPolicy"`

    // Enables fetching access levels of groups and users from an AWS Single Sign-On
    // identity source. To configure this, see UserGroupResolutionConfiguration
    // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html).
    UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"`

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

func (CreateIndexInput) GoString

func (s CreateIndexInput) GoString() string

GoString returns the string representation.

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

func (*CreateIndexInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateIndexInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateIndexInput) SetEdition

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

SetEdition sets the Edition field's value.

func (*CreateIndexInput) SetName

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

SetName sets the Name field's value.

func (*CreateIndexInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateIndexInput) SetServerSideEncryptionConfiguration

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

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*CreateIndexInput) SetTags

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

SetTags sets the Tags field's value.

func (*CreateIndexInput) SetUserContextPolicy

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

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*CreateIndexInput) SetUserGroupResolutionConfiguration

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

SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value.

func (*CreateIndexInput) SetUserTokenConfigurations

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

SetUserTokenConfigurations sets the UserTokenConfigurations field's value.

func (CreateIndexInput) String

func (s CreateIndexInput) String() string

String returns the string representation.

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

func (*CreateIndexInput) Validate

func (s *CreateIndexInput) Validate() error

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

type CreateIndexOutput

type CreateIndexOutput struct {

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

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

func (*CreateIndexOutput) SetId

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

SetId sets the Id field's value.

func (CreateIndexOutput) String

func (s CreateIndexOutput) String() string

String returns the string representation.

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

type CreateQuerySuggestionsBlockListInput

type CreateQuerySuggestionsBlockListInput struct {

    // A token that you provide to identify the request to create a query suggestions
    // block list.
    ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // A user-friendly description for the block list.
    //
    // For example, the description "List of all offensive words that can appear
    // in user queries and need to be blocked from suggestions."
    Description *string `type:"string"`

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

    // A user friendly name for the block list.
    //
    // For example, the block list named 'offensive-words' includes all offensive
    // words that could appear in user queries and need to be blocked from suggestions.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The IAM (Identity and Access Management) role used by Amazon Kendra to access
    // the block list text file in your S3 bucket.
    //
    // You need permissions to the role ARN (Amazon Resource Name). The role needs
    // S3 read permissions to your file in S3 and needs to give STS (Security Token
    // Service) assume role permissions to Amazon Kendra.
    //
    // RoleArn is a required field
    RoleArn *string `min:"1" type:"string" required:"true"`

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

    // A tag that you can assign to a block list that categorizes the block list.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateQuerySuggestionsBlockListInput) GoString

func (s CreateQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

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

func (*CreateQuerySuggestionsBlockListInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateQuerySuggestionsBlockListInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateQuerySuggestionsBlockListInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateQuerySuggestionsBlockListInput) SetName

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

SetName sets the Name field's value.

func (*CreateQuerySuggestionsBlockListInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateQuerySuggestionsBlockListInput) SetSourceS3Path

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

SetSourceS3Path sets the SourceS3Path field's value.

func (*CreateQuerySuggestionsBlockListInput) SetTags

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

SetTags sets the Tags field's value.

func (CreateQuerySuggestionsBlockListInput) String

func (s CreateQuerySuggestionsBlockListInput) String() string

String returns the string representation.

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

func (*CreateQuerySuggestionsBlockListInput) Validate

func (s *CreateQuerySuggestionsBlockListInput) Validate() error

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

type CreateQuerySuggestionsBlockListOutput

type CreateQuerySuggestionsBlockListOutput struct {

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

func (CreateQuerySuggestionsBlockListOutput) GoString

func (s CreateQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

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

func (*CreateQuerySuggestionsBlockListOutput) SetId

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

SetId sets the Id field's value.

func (CreateQuerySuggestionsBlockListOutput) String

func (s CreateQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

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

type CreateThesaurusInput

type CreateThesaurusInput struct {

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

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

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

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

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

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

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

func (CreateThesaurusInput) GoString

func (s CreateThesaurusInput) GoString() string

GoString returns the string representation.

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

func (*CreateThesaurusInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateThesaurusInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateThesaurusInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateThesaurusInput) SetName

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

SetName sets the Name field's value.

func (*CreateThesaurusInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateThesaurusInput) SetSourceS3Path

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

SetSourceS3Path sets the SourceS3Path field's value.

func (*CreateThesaurusInput) SetTags

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

SetTags sets the Tags field's value.

func (CreateThesaurusInput) String

func (s CreateThesaurusInput) String() string

String returns the string representation.

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

func (*CreateThesaurusInput) Validate

func (s *CreateThesaurusInput) Validate() error

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

type CreateThesaurusOutput

type CreateThesaurusOutput struct {

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

func (CreateThesaurusOutput) GoString

func (s CreateThesaurusOutput) GoString() string

GoString returns the string representation.

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

func (*CreateThesaurusOutput) SetId

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

SetId sets the Id field's value.

func (CreateThesaurusOutput) String

func (s CreateThesaurusOutput) String() string

String returns the string representation.

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

type DataSourceConfiguration

type DataSourceConfiguration struct {

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

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

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

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

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

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

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

    // Provides information necessary to create a data source connector for a Microsoft
    // SharePoint site.
    SharePointConfiguration *SharePointConfiguration `type:"structure"`

    // Provides the configuration information required for Amazon Kendra web crawler.
    WebCrawlerConfiguration *WebCrawlerConfiguration `type:"structure"`

    // Provides the configuration information to connect to WorkDocs as your data
    // source.
    WorkDocsConfiguration *WorkDocsConfiguration `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.

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

func (*DataSourceConfiguration) SetConfluenceConfiguration

func (s *DataSourceConfiguration) SetConfluenceConfiguration(v *ConfluenceConfiguration) *DataSourceConfiguration

SetConfluenceConfiguration sets the ConfluenceConfiguration field's value.

func (*DataSourceConfiguration) SetDatabaseConfiguration

func (s *DataSourceConfiguration) SetDatabaseConfiguration(v *DatabaseConfiguration) *DataSourceConfiguration

SetDatabaseConfiguration sets the DatabaseConfiguration field's value.

func (*DataSourceConfiguration) SetGoogleDriveConfiguration

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

SetGoogleDriveConfiguration sets the GoogleDriveConfiguration field's value.

func (*DataSourceConfiguration) SetOneDriveConfiguration

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

SetOneDriveConfiguration sets the OneDriveConfiguration field's value.

func (*DataSourceConfiguration) SetS3Configuration

func (s *DataSourceConfiguration) SetS3Configuration(v *S3DataSourceConfiguration) *DataSourceConfiguration

SetS3Configuration sets the S3Configuration field's value.

func (*DataSourceConfiguration) SetSalesforceConfiguration

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

SetSalesforceConfiguration sets the SalesforceConfiguration field's value.

func (*DataSourceConfiguration) SetServiceNowConfiguration

func (s *DataSourceConfiguration) SetServiceNowConfiguration(v *ServiceNowConfiguration) *DataSourceConfiguration

SetServiceNowConfiguration sets the ServiceNowConfiguration field's value.

func (*DataSourceConfiguration) SetSharePointConfiguration

func (s *DataSourceConfiguration) SetSharePointConfiguration(v *SharePointConfiguration) *DataSourceConfiguration

SetSharePointConfiguration sets the SharePointConfiguration field's value.

func (*DataSourceConfiguration) SetWebCrawlerConfiguration

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

SetWebCrawlerConfiguration sets the WebCrawlerConfiguration field's value.

func (*DataSourceConfiguration) SetWorkDocsConfiguration

func (s *DataSourceConfiguration) SetWorkDocsConfiguration(v *WorkDocsConfiguration) *DataSourceConfiguration

SetWorkDocsConfiguration sets the WorkDocsConfiguration field's value.

func (DataSourceConfiguration) String

func (s DataSourceConfiguration) String() string

String returns the string representation.

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

func (*DataSourceConfiguration) Validate

func (s *DataSourceConfiguration) Validate() error

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

type DataSourceGroup

type DataSourceGroup struct {

    // The identifier of the data source group you want to add to your list of data
    // source groups. This is for filtering search results based on the groups'
    // access to documents in that data source.
    //
    // DataSourceId is a required field
    DataSourceId *string `min:"1" type:"string" required:"true"`

    // The identifier of the group you want to add to your list of groups. This
    // is for filtering search results based on the groups' access to documents.
    //
    // GroupId is a required field
    GroupId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Data source information for user context filtering.

func (DataSourceGroup) GoString

func (s DataSourceGroup) GoString() string

GoString returns the string representation.

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

func (*DataSourceGroup) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceGroup) SetGroupId

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

SetGroupId sets the GroupId field's value.

func (DataSourceGroup) String

func (s DataSourceGroup) String() string

String returns the string representation.

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

func (*DataSourceGroup) Validate

func (s *DataSourceGroup) Validate() error

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

type DataSourceSummary

type DataSourceSummary struct {

    // The UNIX 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 code for a language. This shows a supported language for all documents
    // in the data source. English is supported by default. For more information
    // on supported languages, including their codes, see Adding documents in languages
    // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
    LanguageCode *string `min:"2" type:"string"`

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

    // The status of the data source. When the status is ACTIVE the data source
    // is ready to use.
    Status *string `type:"string" enum:"DataSourceStatus"`

    // The type of the data source.
    Type *string `type:"string" enum:"DataSourceType"`

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

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

func (DataSourceSummary) GoString

func (s DataSourceSummary) GoString() string

GoString returns the string representation.

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

func (*DataSourceSummary) SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

func (*DataSourceSummary) SetId

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

SetId sets the Id field's value.

func (*DataSourceSummary) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*DataSourceSummary) SetName

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

SetName sets the Name field's value.

func (*DataSourceSummary) SetStatus

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

SetStatus sets the Status field's value.

func (*DataSourceSummary) SetType

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

SetType sets the Type field's value.

func (*DataSourceSummary) SetUpdatedAt

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

SetUpdatedAt sets the UpdatedAt field's value.

func (DataSourceSummary) String

func (s DataSourceSummary) String() string

String returns the string representation.

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

type DataSourceSyncJob

type DataSourceSyncJob struct {

    // If the reason that the synchronization failed is due to an error with the
    // underlying data source, this field contains a code that identifies the error.
    DataSourceErrorCode *string `min:"1" type:"string"`

    // The UNIX 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.

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

func (*DataSourceSyncJob) SetDataSourceErrorCode

func (s *DataSourceSyncJob) SetDataSourceErrorCode(v string) *DataSourceSyncJob

SetDataSourceErrorCode sets the DataSourceErrorCode field's value.

func (*DataSourceSyncJob) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*DataSourceSyncJob) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*DataSourceSyncJob) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DataSourceSyncJob) SetExecutionId

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

SetExecutionId sets the ExecutionId field's value.

func (*DataSourceSyncJob) SetMetrics

func (s *DataSourceSyncJob) SetMetrics(v *DataSourceSyncJobMetrics) *DataSourceSyncJob

SetMetrics sets the Metrics field's value.

func (*DataSourceSyncJob) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (*DataSourceSyncJob) SetStatus

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

SetStatus sets the Status field's value.

func (DataSourceSyncJob) String

func (s DataSourceSyncJob) String() string

String returns the string representation.

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

type DataSourceSyncJobMetricTarget

type DataSourceSyncJobMetricTarget struct {

    // The ID of the data source that is running the sync job.
    //
    // DataSourceId is a required field
    DataSourceId *string `min:"1" type:"string" required:"true"`

    // The ID of the sync job that is running on the data source.
    //
    // If the ID of a sync job is not provided and there is a sync job running,
    // then the ID of this sync job is used and metrics are generated for this sync
    // job.
    //
    // If the ID of a sync job is not provided and there is no sync job running,
    // then no metrics are generated and documents are indexed/deleted at the index
    // level without sync job metrics included.
    DataSourceSyncJobId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Maps a particular data source sync job to a particular data source.

func (DataSourceSyncJobMetricTarget) GoString

func (s DataSourceSyncJobMetricTarget) GoString() string

GoString returns the string representation.

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

func (*DataSourceSyncJobMetricTarget) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId

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

SetDataSourceSyncJobId sets the DataSourceSyncJobId field's value.

func (DataSourceSyncJobMetricTarget) String

func (s DataSourceSyncJobMetricTarget) String() string

String returns the string representation.

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

func (*DataSourceSyncJobMetricTarget) Validate

func (s *DataSourceSyncJobMetricTarget) Validate() error

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

type DataSourceSyncJobMetrics

type DataSourceSyncJobMetrics struct {

    // The number of documents added from the data source up to now in the data
    // source sync.
    DocumentsAdded *string `type:"string"`

    // The number of documents deleted from the data source up to now in the data
    // source sync run.
    DocumentsDeleted *string `type:"string"`

    // The number of documents that failed to sync from the data source up to now
    // in the data source sync run.
    DocumentsFailed *string `type:"string"`

    // The number of documents modified in the data source up to now in the data
    // source sync run.
    DocumentsModified *string `type:"string"`

    // The current number of documents crawled by the current sync job in the data
    // source.
    DocumentsScanned *string `type:"string"`
    // contains filtered or unexported fields
}

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

func (DataSourceSyncJobMetrics) GoString

func (s DataSourceSyncJobMetrics) GoString() string

GoString returns the string representation.

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

func (*DataSourceSyncJobMetrics) SetDocumentsAdded

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

SetDocumentsAdded sets the DocumentsAdded field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsDeleted

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

SetDocumentsDeleted sets the DocumentsDeleted field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsFailed

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

SetDocumentsFailed sets the DocumentsFailed field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsModified

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

SetDocumentsModified sets the DocumentsModified field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsScanned

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

SetDocumentsScanned sets the DocumentsScanned field's value.

func (DataSourceSyncJobMetrics) String

func (s DataSourceSyncJobMetrics) String() string

String returns the string representation.

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

type DataSourceToIndexFieldMapping

type DataSourceToIndexFieldMapping struct {

    // The name of the column or attribute in the data source.
    //
    // DataSourceFieldName is a required field
    DataSourceFieldName *string `min:"1" type:"string" required:"true"`

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

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

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

func (DataSourceToIndexFieldMapping) GoString

func (s DataSourceToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*DataSourceToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*DataSourceToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*DataSourceToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (DataSourceToIndexFieldMapping) String

func (s DataSourceToIndexFieldMapping) String() string

String returns the string representation.

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

func (*DataSourceToIndexFieldMapping) Validate

func (s *DataSourceToIndexFieldMapping) Validate() error

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

type DataSourceVpcConfiguration

type DataSourceVpcConfiguration struct {

    // A list of identifiers of security groups within your Amazon VPC. The security
    // groups should enable Amazon Kendra to connect to the data source.
    //
    // SecurityGroupIds is a required field
    SecurityGroupIds []*string `min:"1" type:"list" required:"true"`

    // A list of identifiers for subnets within your Amazon VPC. The subnets should
    // be able to connect to each other in the VPC, and they should have outgoing
    // access to the Internet through a NAT device.
    //
    // SubnetIds is a required field
    SubnetIds []*string `min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

Provides information for connecting to an Amazon VPC.

func (DataSourceVpcConfiguration) GoString

func (s DataSourceVpcConfiguration) GoString() string

GoString returns the string representation.

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

func (*DataSourceVpcConfiguration) SetSecurityGroupIds

func (s *DataSourceVpcConfiguration) SetSecurityGroupIds(v []*string) *DataSourceVpcConfiguration

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*DataSourceVpcConfiguration) SetSubnetIds

func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcConfiguration

SetSubnetIds sets the SubnetIds field's value.

func (DataSourceVpcConfiguration) String

func (s DataSourceVpcConfiguration) String() string

String returns the string representation.

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

func (*DataSourceVpcConfiguration) Validate

func (s *DataSourceVpcConfiguration) Validate() error

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

type DatabaseConfiguration

type DatabaseConfiguration struct {

    // Information about the database column that provides information for user
    // context filtering.
    AclConfiguration *AclConfiguration `type:"structure"`

    // Information about where the index should get the document information from
    // the database.
    //
    // ColumnConfiguration is a required field
    ColumnConfiguration *ColumnConfiguration `type:"structure" required:"true"`

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

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

func (*DatabaseConfiguration) SetAclConfiguration

func (s *DatabaseConfiguration) SetAclConfiguration(v *AclConfiguration) *DatabaseConfiguration

SetAclConfiguration sets the AclConfiguration field's value.

func (*DatabaseConfiguration) SetColumnConfiguration

func (s *DatabaseConfiguration) SetColumnConfiguration(v *ColumnConfiguration) *DatabaseConfiguration

SetColumnConfiguration sets the ColumnConfiguration field's value.

func (*DatabaseConfiguration) SetConnectionConfiguration

func (s *DatabaseConfiguration) SetConnectionConfiguration(v *ConnectionConfiguration) *DatabaseConfiguration

SetConnectionConfiguration sets the ConnectionConfiguration field's value.

func (*DatabaseConfiguration) SetDatabaseEngineType

func (s *DatabaseConfiguration) SetDatabaseEngineType(v string) *DatabaseConfiguration

SetDatabaseEngineType sets the DatabaseEngineType field's value.

func (*DatabaseConfiguration) SetSqlConfiguration

func (s *DatabaseConfiguration) SetSqlConfiguration(v *SqlConfiguration) *DatabaseConfiguration

SetSqlConfiguration sets the SqlConfiguration field's value.

func (*DatabaseConfiguration) SetVpcConfiguration

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (DatabaseConfiguration) String

func (s DatabaseConfiguration) String() string

String returns the string representation.

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

func (*DatabaseConfiguration) Validate

func (s *DatabaseConfiguration) Validate() error

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

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

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

func (*DeleteDataSourceInput) SetId

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

SetId sets the Id field's value.

func (*DeleteDataSourceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteDataSourceInput) String

func (s DeleteDataSourceInput) String() string

String returns the string representation.

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

func (*DeleteDataSourceInput) Validate

func (s *DeleteDataSourceInput) Validate() error

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

type DeleteDataSourceOutput

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

func (DeleteDataSourceOutput) GoString

func (s DeleteDataSourceOutput) GoString() string

GoString returns the string representation.

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

func (DeleteDataSourceOutput) String

func (s DeleteDataSourceOutput) String() string

String returns the string representation.

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

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

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

func (*DeleteFaqInput) SetId

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

SetId sets the Id field's value.

func (*DeleteFaqInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteFaqInput) String

func (s DeleteFaqInput) String() string

String returns the string representation.

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

func (*DeleteFaqInput) Validate

func (s *DeleteFaqInput) Validate() error

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

type DeleteFaqOutput

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

func (DeleteFaqOutput) GoString

func (s DeleteFaqOutput) GoString() string

GoString returns the string representation.

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

func (DeleteFaqOutput) String

func (s DeleteFaqOutput) String() string

String returns the string representation.

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

type DeleteIndexInput

type DeleteIndexInput struct {

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

func (DeleteIndexInput) GoString

func (s DeleteIndexInput) GoString() string

GoString returns the string representation.

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

func (*DeleteIndexInput) SetId

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

SetId sets the Id field's value.

func (DeleteIndexInput) String

func (s DeleteIndexInput) String() string

String returns the string representation.

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

func (*DeleteIndexInput) Validate

func (s *DeleteIndexInput) Validate() error

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

type DeleteIndexOutput

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

func (DeleteIndexOutput) GoString

func (s DeleteIndexOutput) GoString() string

GoString returns the string representation.

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

func (DeleteIndexOutput) String

func (s DeleteIndexOutput) String() string

String returns the string representation.

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

type DeletePrincipalMappingInput

type DeletePrincipalMappingInput struct {

    // The identifier of the data source you want to delete a group from.
    //
    // This is useful if a group is tied to multiple data sources and you want to
    // delete a group from accessing documents in a certain data source. For example,
    // the groups "Research", "Engineering", and "Sales and Marketing" are all tied
    // to the company's documents stored in the data sources Confluence and Salesforce.
    // You want to delete "Research" and "Engineering" groups from Salesforce, so
    // that these groups cannot access customer-related documents stored in Salesforce.
    // Only "Sales and Marketing" should access documents in the Salesforce data
    // source.
    DataSourceId *string `min:"1" type:"string"`

    // The identifier of the group you want to delete.
    //
    // GroupId is a required field
    GroupId *string `min:"1" type:"string" required:"true"`

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

    // The timestamp identifier you specify to ensure Amazon Kendra does not override
    // the latest DELETE action with previous actions. The highest number ID, which
    // is the ordering ID, is the latest action you want to process and apply on
    // top of other actions with lower number IDs. This prevents previous actions
    // with lower number IDs from possibly overriding the latest action.
    //
    // The ordering ID can be the UNIX time of the last update you made to a group
    // members list. You would then provide this list when calling PutPrincipalMapping.
    // This ensures your DELETE action for that updated group with the latest members
    // list doesn't get overwritten by earlier DELETE actions for the same group
    // which are yet to be processed.
    //
    // The default ordering ID is the current UNIX time in milliseconds that the
    // action was received by Amazon Kendra.
    OrderingId *int64 `type:"long"`
    // contains filtered or unexported fields
}

func (DeletePrincipalMappingInput) GoString

func (s DeletePrincipalMappingInput) GoString() string

GoString returns the string representation.

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

func (*DeletePrincipalMappingInput) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DeletePrincipalMappingInput) SetGroupId

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

SetGroupId sets the GroupId field's value.

func (*DeletePrincipalMappingInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*DeletePrincipalMappingInput) SetOrderingId

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

SetOrderingId sets the OrderingId field's value.

func (DeletePrincipalMappingInput) String

func (s DeletePrincipalMappingInput) String() string

String returns the string representation.

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

func (*DeletePrincipalMappingInput) Validate

func (s *DeletePrincipalMappingInput) Validate() error

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

type DeletePrincipalMappingOutput

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

func (DeletePrincipalMappingOutput) GoString

func (s DeletePrincipalMappingOutput) GoString() string

GoString returns the string representation.

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

func (DeletePrincipalMappingOutput) String

func (s DeletePrincipalMappingOutput) String() string

String returns the string representation.

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

type DeleteQuerySuggestionsBlockListInput

type DeleteQuerySuggestionsBlockListInput struct {

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

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

func (DeleteQuerySuggestionsBlockListInput) GoString

func (s DeleteQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

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

func (*DeleteQuerySuggestionsBlockListInput) SetId

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

SetId sets the Id field's value.

func (*DeleteQuerySuggestionsBlockListInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteQuerySuggestionsBlockListInput) String

func (s DeleteQuerySuggestionsBlockListInput) String() string

String returns the string representation.

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

func (*DeleteQuerySuggestionsBlockListInput) Validate

func (s *DeleteQuerySuggestionsBlockListInput) Validate() error

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

type DeleteQuerySuggestionsBlockListOutput

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

func (DeleteQuerySuggestionsBlockListOutput) GoString

func (s DeleteQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

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

func (DeleteQuerySuggestionsBlockListOutput) String

func (s DeleteQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

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

type DeleteThesaurusInput

type DeleteThesaurusInput struct {

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

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

func (DeleteThesaurusInput) GoString

func (s DeleteThesaurusInput) GoString() string

GoString returns the string representation.

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

func (*DeleteThesaurusInput) SetId

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

SetId sets the Id field's value.

func (*DeleteThesaurusInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteThesaurusInput) String

func (s DeleteThesaurusInput) String() string

String returns the string representation.

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

func (*DeleteThesaurusInput) Validate

func (s *DeleteThesaurusInput) Validate() error

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

type DeleteThesaurusOutput

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

func (DeleteThesaurusOutput) GoString

func (s DeleteThesaurusOutput) GoString() string

GoString returns the string representation.

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

func (DeleteThesaurusOutput) String

func (s DeleteThesaurusOutput) String() string

String returns the string representation.

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

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

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

func (*DescribeDataSourceInput) SetId

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

SetId sets the Id field's value.

func (*DescribeDataSourceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DescribeDataSourceInput) String

func (s DescribeDataSourceInput) String() string

String returns the string representation.

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

func (*DescribeDataSourceInput) Validate

func (s *DescribeDataSourceInput) Validate() error

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

type DescribeDataSourceOutput

type DescribeDataSourceOutput struct {

    // 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 code for a language. This shows a supported language for all documents
    // in the data source. English is supported by default. For more information
    // on supported languages, including their codes, see Adding documents in languages
    // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
    LanguageCode *string `min:"2" type:"string"`

    // The name 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.

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

func (*DescribeDataSourceOutput) SetConfiguration

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

SetConfiguration sets the Configuration field's value.

func (*DescribeDataSourceOutput) SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeDataSourceOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*DescribeDataSourceOutput) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeDataSourceOutput) SetId

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

SetId sets the Id field's value.

func (*DescribeDataSourceOutput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*DescribeDataSourceOutput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*DescribeDataSourceOutput) SetName

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

SetName sets the Name field's value.

func (*DescribeDataSourceOutput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeDataSourceOutput) SetSchedule

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

SetSchedule sets the Schedule field's value.

func (*DescribeDataSourceOutput) SetStatus

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

SetStatus sets the Status field's value.

func (*DescribeDataSourceOutput) SetType

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

SetType sets the Type field's value.

func (*DescribeDataSourceOutput) SetUpdatedAt

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

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeDataSourceOutput) String

func (s DescribeDataSourceOutput) String() string

String returns the string representation.

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

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

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

func (*DescribeFaqInput) SetId

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

SetId sets the Id field's value.

func (*DescribeFaqInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DescribeFaqInput) String

func (s DescribeFaqInput) String() string

String returns the string representation.

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

func (*DescribeFaqInput) Validate

func (s *DescribeFaqInput) Validate() error

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

type DescribeFaqOutput

type DescribeFaqOutput struct {

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

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

    // The Amazon Resource Name (ARN) of the role that provides access to the S3
    // bucket containing the input files for the FAQ.
    RoleArn *string `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.

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

func (*DescribeFaqOutput) SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeFaqOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*DescribeFaqOutput) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeFaqOutput) SetFileFormat

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

SetFileFormat sets the FileFormat field's value.

func (*DescribeFaqOutput) SetId

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

SetId sets the Id field's value.

func (*DescribeFaqOutput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*DescribeFaqOutput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*DescribeFaqOutput) SetName

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

SetName sets the Name field's value.

func (*DescribeFaqOutput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeFaqOutput) SetS3Path

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

SetS3Path sets the S3Path field's value.

func (*DescribeFaqOutput) SetStatus

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

SetStatus sets the Status field's value.

func (*DescribeFaqOutput) SetUpdatedAt

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

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeFaqOutput) String

func (s DescribeFaqOutput) String() string

String returns the string representation.

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

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

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

func (*DescribeIndexInput) SetId

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

SetId sets the Id field's value.

func (DescribeIndexInput) String

func (s DescribeIndexInput) String() string

String returns the string representation.

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

func (*DescribeIndexInput) Validate

func (s *DescribeIndexInput) Validate() error

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

type DescribeIndexOutput

type DescribeIndexOutput struct {

    // For Enterprise edition indexes, you can choose to use additional capacity
    // to meet the needs of your application. This contains the capacity units used
    // for the index. A 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 KMScustomer master key (CMK) used to encrypt your data.
    // Amazon Kendra doesn't support asymmetric CMKs.
    ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

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

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

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

    // Shows whether you have enabled the configuration for fetching access levels
    // of groups and users from an AWS Single Sign-On identity source.
    UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"`

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

func (DescribeIndexOutput) GoString

func (s DescribeIndexOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeIndexOutput) SetCapacityUnits

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

SetCapacityUnits sets the CapacityUnits field's value.

func (*DescribeIndexOutput) SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeIndexOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*DescribeIndexOutput) SetDocumentMetadataConfigurations

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

SetDocumentMetadataConfigurations sets the DocumentMetadataConfigurations field's value.

func (*DescribeIndexOutput) SetEdition

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

SetEdition sets the Edition field's value.

func (*DescribeIndexOutput) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeIndexOutput) SetId

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

SetId sets the Id field's value.

func (*DescribeIndexOutput) SetIndexStatistics

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

SetIndexStatistics sets the IndexStatistics field's value.

func (*DescribeIndexOutput) SetName

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

SetName sets the Name field's value.

func (*DescribeIndexOutput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeIndexOutput) SetServerSideEncryptionConfiguration

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

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*DescribeIndexOutput) SetStatus

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

SetStatus sets the Status field's value.

func (*DescribeIndexOutput) SetUpdatedAt

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*DescribeIndexOutput) SetUserContextPolicy

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

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*DescribeIndexOutput) SetUserGroupResolutionConfiguration

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

SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value.

func (*DescribeIndexOutput) SetUserTokenConfigurations

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

SetUserTokenConfigurations sets the UserTokenConfigurations field's value.

func (DescribeIndexOutput) String

func (s DescribeIndexOutput) String() string

String returns the string representation.

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

type DescribePrincipalMappingInput

type DescribePrincipalMappingInput struct {

    // The identifier of the data source to check the processing of PUT and DELETE
    // actions for mapping users to their groups.
    DataSourceId *string `min:"1" type:"string"`

    // The identifier of the group required to check the processing of PUT and DELETE
    // actions for mapping users to their groups.
    //
    // GroupId is a required field
    GroupId *string `min:"1" type:"string" required:"true"`

    // The identifier of the index required to check the processing of PUT and DELETE
    // actions for mapping users to their groups.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribePrincipalMappingInput) GoString

func (s DescribePrincipalMappingInput) GoString() string

GoString returns the string representation.

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

func (*DescribePrincipalMappingInput) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DescribePrincipalMappingInput) SetGroupId

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

SetGroupId sets the GroupId field's value.

func (*DescribePrincipalMappingInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DescribePrincipalMappingInput) String

func (s DescribePrincipalMappingInput) String() string

String returns the string representation.

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

func (*DescribePrincipalMappingInput) Validate

func (s *DescribePrincipalMappingInput) Validate() error

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

type DescribePrincipalMappingOutput

type DescribePrincipalMappingOutput struct {

    // Shows the identifier of the data source to see information on the processing
    // of PUT and DELETE actions for mapping users to their groups.
    DataSourceId *string `min:"1" type:"string"`

    // Shows the identifier of the group to see information on the processing of
    // PUT and DELETE actions for mapping users to their groups.
    GroupId *string `min:"1" type:"string"`

    // Shows the following information on the processing of PUT and DELETE actions
    // for mapping users to their groups:
    //
    //    * Status – the status can be either PROCESSING, SUCCEEDED, DELETING,
    //    DELETED, or FAILED.
    //
    //    * Last updated – the last date-time an action was updated.
    //
    //    * Received – the last date-time an action was received or submitted.
    //
    //    * Ordering ID – the latest action that should process and apply after
    //    other actions.
    //
    //    * Failure reason – the reason an action could not be processed.
    GroupOrderingIdSummaries []*GroupOrderingIdSummary `type:"list"`

    // Shows the identifier of the index to see information on the processing of
    // PUT and DELETE actions for mapping users to their groups.
    IndexId *string `min:"36" type:"string"`
    // contains filtered or unexported fields
}

func (DescribePrincipalMappingOutput) GoString

func (s DescribePrincipalMappingOutput) GoString() string

GoString returns the string representation.

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

func (*DescribePrincipalMappingOutput) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DescribePrincipalMappingOutput) SetGroupId

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

SetGroupId sets the GroupId field's value.

func (*DescribePrincipalMappingOutput) SetGroupOrderingIdSummaries

func (s *DescribePrincipalMappingOutput) SetGroupOrderingIdSummaries(v []*GroupOrderingIdSummary) *DescribePrincipalMappingOutput

SetGroupOrderingIdSummaries sets the GroupOrderingIdSummaries field's value.

func (*DescribePrincipalMappingOutput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DescribePrincipalMappingOutput) String

func (s DescribePrincipalMappingOutput) String() string

String returns the string representation.

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

type DescribeQuerySuggestionsBlockListInput

type DescribeQuerySuggestionsBlockListInput struct {

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

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

func (DescribeQuerySuggestionsBlockListInput) GoString

func (s DescribeQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

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

func (*DescribeQuerySuggestionsBlockListInput) SetId

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

SetId sets the Id field's value.

func (*DescribeQuerySuggestionsBlockListInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DescribeQuerySuggestionsBlockListInput) String

func (s DescribeQuerySuggestionsBlockListInput) String() string

String returns the string representation.

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

func (*DescribeQuerySuggestionsBlockListInput) Validate

func (s *DescribeQuerySuggestionsBlockListInput) Validate() error

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

type DescribeQuerySuggestionsBlockListOutput

type DescribeQuerySuggestionsBlockListOutput struct {

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

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

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

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

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

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

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

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

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

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

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

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

func (DescribeQuerySuggestionsBlockListOutput) GoString

func (s DescribeQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeQuerySuggestionsBlockListOutput) SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetFileSizeBytes

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

SetFileSizeBytes sets the FileSizeBytes field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetId

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

SetId sets the Id field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetItemCount

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

SetItemCount sets the ItemCount field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetName

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

SetName sets the Name field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetSourceS3Path

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

SetSourceS3Path sets the SourceS3Path field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetStatus

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

SetStatus sets the Status field's value.

func (*DescribeQuerySuggestionsBlockListOutput) SetUpdatedAt

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

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeQuerySuggestionsBlockListOutput) String

func (s DescribeQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

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

type DescribeQuerySuggestionsConfigInput

type DescribeQuerySuggestionsConfigInput struct {

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

func (DescribeQuerySuggestionsConfigInput) GoString

func (s DescribeQuerySuggestionsConfigInput) GoString() string

GoString returns the string representation.

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

func (*DescribeQuerySuggestionsConfigInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DescribeQuerySuggestionsConfigInput) String

func (s DescribeQuerySuggestionsConfigInput) String() string

String returns the string representation.

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

func (*DescribeQuerySuggestionsConfigInput) Validate

func (s *DescribeQuerySuggestionsConfigInput) Validate() error

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

type DescribeQuerySuggestionsConfigOutput

type DescribeQuerySuggestionsConfigOutput struct {

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

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

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

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

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

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

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

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

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

func (DescribeQuerySuggestionsConfigOutput) GoString

func (s DescribeQuerySuggestionsConfigOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeQuerySuggestionsConfigOutput) SetIncludeQueriesWithoutUserInformation

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

SetIncludeQueriesWithoutUserInformation sets the IncludeQueriesWithoutUserInformation field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetLastClearTime

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

SetLastClearTime sets the LastClearTime field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetLastSuggestionsBuildTime

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

SetLastSuggestionsBuildTime sets the LastSuggestionsBuildTime field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMinimumNumberOfQueryingUsers

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

SetMinimumNumberOfQueryingUsers sets the MinimumNumberOfQueryingUsers field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMinimumQueryCount

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

SetMinimumQueryCount sets the MinimumQueryCount field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetMode

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

SetMode sets the Mode field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetQueryLogLookBackWindowInDays

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

SetQueryLogLookBackWindowInDays sets the QueryLogLookBackWindowInDays field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetStatus

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

SetStatus sets the Status field's value.

func (*DescribeQuerySuggestionsConfigOutput) SetTotalSuggestionsCount

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

SetTotalSuggestionsCount sets the TotalSuggestionsCount field's value.

func (DescribeQuerySuggestionsConfigOutput) String

func (s DescribeQuerySuggestionsConfigOutput) String() string

String returns the string representation.

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

type DescribeThesaurusInput

type DescribeThesaurusInput struct {

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

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

func (DescribeThesaurusInput) GoString

func (s DescribeThesaurusInput) GoString() string

GoString returns the string representation.

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

func (*DescribeThesaurusInput) SetId

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

SetId sets the Id field's value.

func (*DescribeThesaurusInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DescribeThesaurusInput) String

func (s DescribeThesaurusInput) String() string

String returns the string representation.

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

func (*DescribeThesaurusInput) Validate

func (s *DescribeThesaurusInput) Validate() error

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

type DescribeThesaurusOutput

type DescribeThesaurusOutput struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

func (DescribeThesaurusOutput) GoString

func (s DescribeThesaurusOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeThesaurusOutput) SetCreatedAt

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

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeThesaurusOutput) SetDescription

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

SetDescription sets the Description field's value.

func (*DescribeThesaurusOutput) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeThesaurusOutput) SetFileSizeBytes

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

SetFileSizeBytes sets the FileSizeBytes field's value.

func (*DescribeThesaurusOutput) SetId

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

SetId sets the Id field's value.

func (*DescribeThesaurusOutput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*DescribeThesaurusOutput) SetName

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

SetName sets the Name field's value.

func (*DescribeThesaurusOutput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*DescribeThesaurusOutput) SetSourceS3Path

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

SetSourceS3Path sets the SourceS3Path field's value.

func (*DescribeThesaurusOutput) SetStatus

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

SetStatus sets the Status field's value.

func (*DescribeThesaurusOutput) SetSynonymRuleCount

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

SetSynonymRuleCount sets the SynonymRuleCount field's value.

func (*DescribeThesaurusOutput) SetTermCount

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

SetTermCount sets the TermCount field's value.

func (*DescribeThesaurusOutput) SetUpdatedAt

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

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeThesaurusOutput) String

func (s DescribeThesaurusOutput) String() string

String returns the string representation.

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

type Document

type Document struct {

    // Information on user and group access rights, which is used 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 Amazon
    // Web Services 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"`

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

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

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

func (*Document) SetAccessControlList

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

SetAccessControlList sets the AccessControlList field's value.

func (*Document) SetAttributes

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

SetAttributes sets the Attributes field's value.

func (*Document) SetBlob

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

SetBlob sets the Blob field's value.

func (*Document) SetContentType

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

SetContentType sets the ContentType field's value.

func (*Document) SetHierarchicalAccessControlList

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

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*Document) SetId

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

SetId sets the Id field's value.

func (*Document) SetS3Path

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

SetS3Path sets the S3Path field's value.

func (*Document) SetTitle

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

SetTitle sets the Title field's value.

func (Document) String

func (s Document) String() string

String returns the string representation.

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

func (*Document) Validate

func (s *Document) Validate() error

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

type DocumentAttribute

type DocumentAttribute struct {

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

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

A custom attribute value assigned to a document.

func (DocumentAttribute) GoString

func (s DocumentAttribute) GoString() string

GoString returns the string representation.

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

func (*DocumentAttribute) SetKey

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

SetKey sets the Key field's value.

func (*DocumentAttribute) SetValue

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

SetValue sets the Value field's value.

func (DocumentAttribute) String

func (s DocumentAttribute) String() string

String returns the string representation.

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

func (*DocumentAttribute) Validate

func (s *DocumentAttribute) Validate() error

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

type DocumentAttributeValue

type DocumentAttributeValue struct {

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

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

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

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

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

func (DocumentAttributeValue) GoString

func (s DocumentAttributeValue) GoString() string

GoString returns the string representation.

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

func (*DocumentAttributeValue) SetDateValue

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

SetDateValue sets the DateValue field's value.

func (*DocumentAttributeValue) SetLongValue

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

SetLongValue sets the LongValue field's value.

func (*DocumentAttributeValue) SetStringListValue

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

SetStringListValue sets the StringListValue field's value.

func (*DocumentAttributeValue) SetStringValue

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

SetStringValue sets the StringValue field's value.

func (DocumentAttributeValue) String

func (s DocumentAttributeValue) String() string

String returns the string representation.

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

func (*DocumentAttributeValue) Validate

func (s *DocumentAttributeValue) Validate() error

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

type DocumentAttributeValueCountPair

type DocumentAttributeValueCountPair struct {

    // The number of documents in the response that have the attribute 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.

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

func (*DocumentAttributeValueCountPair) SetCount

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

SetCount sets the Count field's value.

func (*DocumentAttributeValueCountPair) SetDocumentAttributeValue

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

SetDocumentAttributeValue sets the DocumentAttributeValue field's value.

func (DocumentAttributeValueCountPair) String

func (s DocumentAttributeValueCountPair) String() string

String returns the string representation.

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

type DocumentInfo

type DocumentInfo struct {

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

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

Identifies a document for which to retrieve status information

func (DocumentInfo) GoString

func (s DocumentInfo) GoString() string

GoString returns the string representation.

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

func (*DocumentInfo) SetAttributes

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

SetAttributes sets the Attributes field's value.

func (*DocumentInfo) SetDocumentId

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

SetDocumentId sets the DocumentId field's value.

func (DocumentInfo) String

func (s DocumentInfo) String() string

String returns the string representation.

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

func (*DocumentInfo) Validate

func (s *DocumentInfo) Validate() error

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

type DocumentMetadataConfiguration

type DocumentMetadataConfiguration struct {

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

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

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

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

Specifies the properties of a custom index field.

func (DocumentMetadataConfiguration) GoString

func (s DocumentMetadataConfiguration) GoString() string

GoString returns the string representation.

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

func (*DocumentMetadataConfiguration) SetName

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

SetName sets the Name field's value.

func (*DocumentMetadataConfiguration) SetRelevance

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

SetRelevance sets the Relevance field's value.

func (*DocumentMetadataConfiguration) SetSearch

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

SetSearch sets the Search field's value.

func (*DocumentMetadataConfiguration) SetType

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

SetType sets the Type field's value.

func (DocumentMetadataConfiguration) String

func (s DocumentMetadataConfiguration) String() string

String returns the string representation.

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

func (*DocumentMetadataConfiguration) Validate

func (s *DocumentMetadataConfiguration) Validate() error

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

type DocumentRelevanceConfiguration

type DocumentRelevanceConfiguration struct {

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

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

Overrides the document relevance properties of a custom index field.

func (DocumentRelevanceConfiguration) GoString

func (s DocumentRelevanceConfiguration) GoString() string

GoString returns the string representation.

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

func (*DocumentRelevanceConfiguration) SetName

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

SetName sets the Name field's value.

func (*DocumentRelevanceConfiguration) SetRelevance

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

SetRelevance sets the Relevance field's value.

func (DocumentRelevanceConfiguration) String

func (s DocumentRelevanceConfiguration) String() string

String returns the string representation.

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

func (*DocumentRelevanceConfiguration) Validate

func (s *DocumentRelevanceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentsMetadataConfiguration

type DocumentsMetadataConfiguration struct {

    // A prefix used to filter metadata configuration files in the Amazon Web Services
    // S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix
    // to include only the desired metadata files.
    S3Prefix *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

func (DocumentsMetadataConfiguration) GoString

func (s DocumentsMetadataConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentsMetadataConfiguration) SetS3Prefix

func (s *DocumentsMetadataConfiguration) SetS3Prefix(v string) *DocumentsMetadataConfiguration

SetS3Prefix sets the S3Prefix field's value.

func (DocumentsMetadataConfiguration) String

func (s DocumentsMetadataConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentsMetadataConfiguration) Validate

func (s *DocumentsMetadataConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Facet) SetDocumentAttributeKey

func (s *Facet) SetDocumentAttributeKey(v string) *Facet

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (Facet) String

func (s Facet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Facet) Validate

func (s *Facet) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FacetResult

type FacetResult struct {

    // The key for the facet values. This is the same as the DocumentAttributeKey
    // provided in the query.
    DocumentAttributeKey *string `min:"1" type:"string"`

    // An array of key/value pairs, where the key is the value of the attribute
    // and the count is the number of documents that share the key value.
    DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair `type:"list"`

    // The data type of the facet value. This is the same as the type defined for
    // the index field when it was created.
    DocumentAttributeValueType *string `type:"string" enum:"DocumentAttributeValueType"`
    // contains filtered or unexported fields
}

The facet values for the documents in the response.

func (FacetResult) GoString

func (s FacetResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FacetResult) SetDocumentAttributeKey

func (s *FacetResult) SetDocumentAttributeKey(v string) *FacetResult

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*FacetResult) SetDocumentAttributeValueCountPairs

func (s *FacetResult) SetDocumentAttributeValueCountPairs(v []*DocumentAttributeValueCountPair) *FacetResult

SetDocumentAttributeValueCountPairs sets the DocumentAttributeValueCountPairs field's value.

func (*FacetResult) SetDocumentAttributeValueType

func (s *FacetResult) SetDocumentAttributeValueType(v string) *FacetResult

SetDocumentAttributeValueType sets the DocumentAttributeValueType field's value.

func (FacetResult) String

func (s FacetResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FaqStatistics

type FaqStatistics struct {

    // The total number of FAQ questions and answers contained in the index.
    //
    // IndexedQuestionAnswersCount is a required field
    IndexedQuestionAnswersCount *int64 `type:"integer" required:"true"`
    // contains filtered or unexported fields
}

Provides statistical information about the FAQ questions and answers contained in an index.

func (FaqStatistics) GoString

func (s FaqStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FaqStatistics) SetIndexedQuestionAnswersCount

func (s *FaqStatistics) SetIndexedQuestionAnswersCount(v int64) *FaqStatistics

SetIndexedQuestionAnswersCount sets the IndexedQuestionAnswersCount field's value.

func (FaqStatistics) String

func (s FaqStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FaqSummary

type FaqSummary struct {

    // The UNIX 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 code for a language. This shows a supported language for the FAQ document
    // as part of the summary information for FAQs. English is supported by default.
    // For more information on supported languages, including their codes, see Adding
    // documents in languages other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
    LanguageCode *string `min:"2" type:"string"`

    // The name that you assigned the FAQ when you created or updated the FAQ.
    Name *string `min:"1" type:"string"`

    // The current status of the FAQ. When the status is ACTIVE the FAQ is ready
    // for use.
    Status *string `type:"string" enum:"FaqStatus"`

    // The UNIX 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FaqSummary) SetCreatedAt

func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary

SetCreatedAt sets the CreatedAt field's value.

func (*FaqSummary) SetFileFormat

func (s *FaqSummary) SetFileFormat(v string) *FaqSummary

SetFileFormat sets the FileFormat field's value.

func (*FaqSummary) SetId

func (s *FaqSummary) SetId(v string) *FaqSummary

SetId sets the Id field's value.

func (*FaqSummary) SetLanguageCode

func (s *FaqSummary) SetLanguageCode(v string) *FaqSummary

SetLanguageCode sets the LanguageCode field's value.

func (*FaqSummary) SetName

func (s *FaqSummary) SetName(v string) *FaqSummary

SetName sets the Name field's value.

func (*FaqSummary) SetStatus

func (s *FaqSummary) SetStatus(v string) *FaqSummary

SetStatus sets the Status field's value.

func (*FaqSummary) SetUpdatedAt

func (s *FaqSummary) SetUpdatedAt(v time.Time) *FaqSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (FaqSummary) String

func (s FaqSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetQuerySuggestionsInput

type GetQuerySuggestionsInput struct {

    // The identifier of the index you want to get query suggestions from.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The maximum number of query suggestions you want to show to your users.
    MaxSuggestionsCount *int64 `type:"integer"`

    // The text of a user's query to generate query suggestions.
    //
    // A query is suggested if the query prefix matches what a user starts to type
    // as their query.
    //
    // Amazon Kendra does not show any suggestions if a user types fewer than two
    // characters or more than 60 characters. A query must also have at least one
    // search result and contain at least one word of more than four characters.
    //
    // QueryText is a required field
    QueryText *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetQuerySuggestionsInput) GoString

func (s GetQuerySuggestionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuerySuggestionsInput) SetIndexId

func (s *GetQuerySuggestionsInput) SetIndexId(v string) *GetQuerySuggestionsInput

SetIndexId sets the IndexId field's value.

func (*GetQuerySuggestionsInput) SetMaxSuggestionsCount

func (s *GetQuerySuggestionsInput) SetMaxSuggestionsCount(v int64) *GetQuerySuggestionsInput

SetMaxSuggestionsCount sets the MaxSuggestionsCount field's value.

func (*GetQuerySuggestionsInput) SetQueryText

func (s *GetQuerySuggestionsInput) SetQueryText(v string) *GetQuerySuggestionsInput

SetQueryText sets the QueryText field's value.

func (GetQuerySuggestionsInput) String

func (s GetQuerySuggestionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuerySuggestionsInput) Validate

func (s *GetQuerySuggestionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQuerySuggestionsOutput

type GetQuerySuggestionsOutput struct {

    // The unique identifier for a list of query suggestions for an index.
    QuerySuggestionsId *string `min:"1" type:"string"`

    // A list of query suggestions for an index.
    Suggestions []*Suggestion `type:"list"`
    // contains filtered or unexported fields
}

func (GetQuerySuggestionsOutput) GoString

func (s GetQuerySuggestionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetQuerySuggestionsOutput) SetQuerySuggestionsId

func (s *GetQuerySuggestionsOutput) SetQuerySuggestionsId(v string) *GetQuerySuggestionsOutput

SetQuerySuggestionsId sets the QuerySuggestionsId field's value.

func (*GetQuerySuggestionsOutput) SetSuggestions

func (s *GetQuerySuggestionsOutput) SetSuggestions(v []*Suggestion) *GetQuerySuggestionsOutput

SetSuggestions sets the Suggestions field's value.

func (GetQuerySuggestionsOutput) String

func (s GetQuerySuggestionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GoogleDriveConfiguration

type GoogleDriveConfiguration struct {

    // A list of MIME types to exclude from the index. All documents matching the
    // specified MIME type are excluded.
    //
    // For a list of MIME types, see Using a Google Workspace Drive data source
    // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
    ExcludeMimeTypes []*string `type:"list"`

    // A list of identifiers or shared drives to exclude from the index. All files
    // and folders stored on the shared drive are excluded.
    ExcludeSharedDrives []*string `type:"list"`

    // A list of email addresses of the users. Documents owned by these users are
    // excluded from the index. Documents shared with excluded users are indexed
    // unless they are excluded in another way.
    ExcludeUserAccounts []*string `type:"list"`

    // A list of regular expression patterns that apply to the path on Google Drive.
    // Items that match the pattern are excluded from the index from both shared
    // drives and users' My Drives. Items that don't match the pattern are included
    // in the index. If an item matches both an exclusion pattern and an inclusion
    // pattern, it is excluded from the index.
    ExclusionPatterns []*string `type:"list"`

    // Defines mapping between a field in the Google Drive and a Amazon Kendra index
    // field.
    //
    // If you are using the console, you can define index fields when creating the
    // mapping. If you are using the API, you must first create the field using
    // the UpdateIndex operation.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of regular expression patterns that apply to path on Google Drive.
    // Items that match the pattern are included in the index from both shared drives
    // and users' My Drives. Items that don't match the pattern are excluded from
    // the index. If an item matches both an inclusion pattern and an exclusion
    // pattern, it is excluded from the index.
    InclusionPatterns []*string `type:"list"`

    // The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the
    // credentials required to connect to Google Drive. For more information, see
    // Using a Google Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides configuration information for data sources that connect to Google Drive.

func (GoogleDriveConfiguration) GoString

func (s GoogleDriveConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GoogleDriveConfiguration) SetExcludeMimeTypes

func (s *GoogleDriveConfiguration) SetExcludeMimeTypes(v []*string) *GoogleDriveConfiguration

SetExcludeMimeTypes sets the ExcludeMimeTypes field's value.

func (*GoogleDriveConfiguration) SetExcludeSharedDrives

func (s *GoogleDriveConfiguration) SetExcludeSharedDrives(v []*string) *GoogleDriveConfiguration

SetExcludeSharedDrives sets the ExcludeSharedDrives field's value.

func (*GoogleDriveConfiguration) SetExcludeUserAccounts

func (s *GoogleDriveConfiguration) SetExcludeUserAccounts(v []*string) *GoogleDriveConfiguration

SetExcludeUserAccounts sets the ExcludeUserAccounts field's value.

func (*GoogleDriveConfiguration) SetExclusionPatterns

func (s *GoogleDriveConfiguration) SetExclusionPatterns(v []*string) *GoogleDriveConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*GoogleDriveConfiguration) SetFieldMappings

func (s *GoogleDriveConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *GoogleDriveConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*GoogleDriveConfiguration) SetInclusionPatterns

func (s *GoogleDriveConfiguration) SetInclusionPatterns(v []*string) *GoogleDriveConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*GoogleDriveConfiguration) SetSecretArn

func (s *GoogleDriveConfiguration) SetSecretArn(v string) *GoogleDriveConfiguration

SetSecretArn sets the SecretArn field's value.

func (GoogleDriveConfiguration) String

func (s GoogleDriveConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GoogleDriveConfiguration) Validate

func (s *GoogleDriveConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GroupMembers

type GroupMembers struct {

    // A list of sub groups that belong to a group. For example, the sub groups
    // "Research", "Engineering", and "Sales and Marketing" all belong to the group
    // "Company".
    MemberGroups []*MemberGroup `min:"1" type:"list"`

    // A list of users that belong to a group. For example, a list of interns all
    // belong to the "Interns" group.
    MemberUsers []*MemberUser `min:"1" type:"list"`

    // If you have more than 1000 users and/or sub groups for a single group, you
    // need to provide the path to the S3 file that lists your users and sub groups
    // for a group. Your sub groups can contain more than 1000 users, but the list
    // of sub groups that belong to a group (and/or users) must be no more than
    // 1000.
    //
    // You can download this example S3 file (https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip)
    // that uses the correct format for listing group members. Note, dataSourceId
    // is optional. The value of type for a group is always GROUP and for a user
    // it is always USER.
    S3PathforGroupMembers *S3Path `type:"structure"`
    // contains filtered or unexported fields
}

A list of users or sub groups that belong to a group. Users and groups are useful for filtering search results to different users based on their group's access to documents.

func (GroupMembers) GoString

func (s GroupMembers) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupMembers) SetMemberGroups

func (s *GroupMembers) SetMemberGroups(v []*MemberGroup) *GroupMembers

SetMemberGroups sets the MemberGroups field's value.

func (*GroupMembers) SetMemberUsers

func (s *GroupMembers) SetMemberUsers(v []*MemberUser) *GroupMembers

SetMemberUsers sets the MemberUsers field's value.

func (*GroupMembers) SetS3PathforGroupMembers

func (s *GroupMembers) SetS3PathforGroupMembers(v *S3Path) *GroupMembers

SetS3PathforGroupMembers sets the S3PathforGroupMembers field's value.

func (GroupMembers) String

func (s GroupMembers) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupMembers) Validate

func (s *GroupMembers) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GroupOrderingIdSummary

type GroupOrderingIdSummary struct {

    // The reason an action could not be processed. An action can be a PUT or DELETE
    // action for mapping users to their groups.
    FailureReason *string `min:"1" type:"string"`

    // The last date-time an action was updated. An action can be a PUT or DELETE
    // action for mapping users to their groups.
    LastUpdatedAt *time.Time `type:"timestamp"`

    // The order in which actions should complete processing. An action can be a
    // PUT or DELETE action for mapping users to their groups.
    OrderingId *int64 `type:"long"`

    // The date-time an action was received by Amazon Kendra. An action can be a
    // PUT or DELETE action for mapping users to their groups.
    ReceivedAt *time.Time `type:"timestamp"`

    // The current processing status of actions for mapping users to their groups.
    // The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.
    Status *string `type:"string" enum:"PrincipalMappingStatus"`
    // contains filtered or unexported fields
}

Information on the processing of PUT and DELETE actions for mapping users to their groups.

func (GroupOrderingIdSummary) GoString

func (s GroupOrderingIdSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupOrderingIdSummary) SetFailureReason

func (s *GroupOrderingIdSummary) SetFailureReason(v string) *GroupOrderingIdSummary

SetFailureReason sets the FailureReason field's value.

func (*GroupOrderingIdSummary) SetLastUpdatedAt

func (s *GroupOrderingIdSummary) SetLastUpdatedAt(v time.Time) *GroupOrderingIdSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*GroupOrderingIdSummary) SetOrderingId

func (s *GroupOrderingIdSummary) SetOrderingId(v int64) *GroupOrderingIdSummary

SetOrderingId sets the OrderingId field's value.

func (*GroupOrderingIdSummary) SetReceivedAt

func (s *GroupOrderingIdSummary) SetReceivedAt(v time.Time) *GroupOrderingIdSummary

SetReceivedAt sets the ReceivedAt field's value.

func (*GroupOrderingIdSummary) SetStatus

func (s *GroupOrderingIdSummary) SetStatus(v string) *GroupOrderingIdSummary

SetStatus sets the Status field's value.

func (GroupOrderingIdSummary) String

func (s GroupOrderingIdSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GroupSummary

type GroupSummary struct {

    // The identifier of the group you want group summary information on.
    GroupId *string `min:"1" type:"string"`

    // The timestamp identifier used for the latest PUT or DELETE action.
    OrderingId *int64 `type:"long"`
    // contains filtered or unexported fields
}

Group summary information.

func (GroupSummary) GoString

func (s GroupSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupSummary) SetGroupId

func (s *GroupSummary) SetGroupId(v string) *GroupSummary

SetGroupId sets the GroupId field's value.

func (*GroupSummary) SetOrderingId

func (s *GroupSummary) SetOrderingId(v int64) *GroupSummary

SetOrderingId sets the OrderingId field's value.

func (GroupSummary) String

func (s GroupSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HierarchicalPrincipal

type HierarchicalPrincipal struct {

    // A list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html)
    // lists that define the hierarchy for which documents users should have access
    // to. Each hierarchical list specifies which user or group has allow or deny
    // access for each document.
    //
    // PrincipalList is a required field
    PrincipalList []*Principal `type:"list" required:"true"`
    // contains filtered or unexported fields
}

Information to define the hierarchy for which documents users should have access to.

func (HierarchicalPrincipal) GoString

func (s HierarchicalPrincipal) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HierarchicalPrincipal) SetPrincipalList

func (s *HierarchicalPrincipal) SetPrincipalList(v []*Principal) *HierarchicalPrincipal

SetPrincipalList sets the PrincipalList field's value.

func (HierarchicalPrincipal) String

func (s HierarchicalPrincipal) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HierarchicalPrincipal) Validate

func (s *HierarchicalPrincipal) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Highlight

type Highlight struct {

    // The zero-based location in the response string where the highlight starts.
    //
    // BeginOffset is a required field
    BeginOffset *int64 `type:"integer" required:"true"`

    // The zero-based location in the response string where the highlight ends.
    //
    // EndOffset is a required field
    EndOffset *int64 `type:"integer" required:"true"`

    // Indicates whether the response is the best response. True if this is the
    // best response; otherwise, false.
    TopAnswer *bool `type:"boolean"`

    // The highlight type.
    Type *string `type:"string" enum:"HighlightType"`
    // contains filtered or unexported fields
}

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

func (Highlight) GoString

func (s Highlight) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Highlight) SetBeginOffset

func (s *Highlight) SetBeginOffset(v int64) *Highlight

SetBeginOffset sets the BeginOffset field's value.

func (*Highlight) SetEndOffset

func (s *Highlight) SetEndOffset(v int64) *Highlight

SetEndOffset sets the EndOffset field's value.

func (*Highlight) SetTopAnswer

func (s *Highlight) SetTopAnswer(v bool) *Highlight

SetTopAnswer sets the TopAnswer field's value.

func (*Highlight) SetType

func (s *Highlight) SetType(v string) *Highlight

SetType sets the Type field's value.

func (Highlight) String

func (s Highlight) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IndexConfigurationSummary) SetCreatedAt

func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary

SetCreatedAt sets the CreatedAt field's value.

func (*IndexConfigurationSummary) SetEdition

func (s *IndexConfigurationSummary) SetEdition(v string) *IndexConfigurationSummary

SetEdition sets the Edition field's value.

func (*IndexConfigurationSummary) SetId

func (s *IndexConfigurationSummary) SetId(v string) *IndexConfigurationSummary

SetId sets the Id field's value.

func (*IndexConfigurationSummary) SetName

func (s *IndexConfigurationSummary) SetName(v string) *IndexConfigurationSummary

SetName sets the Name field's value.

func (*IndexConfigurationSummary) SetStatus

func (s *IndexConfigurationSummary) SetStatus(v string) *IndexConfigurationSummary

SetStatus sets the Status field's value.

func (*IndexConfigurationSummary) SetUpdatedAt

func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (IndexConfigurationSummary) String

func (s IndexConfigurationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IndexStatistics

type IndexStatistics struct {

    // The number of question and answer topics in the index.
    //
    // FaqStatistics is a required field
    FaqStatistics *FaqStatistics `type:"structure" required:"true"`

    // The number of text documents indexed.
    //
    // TextDocumentStatistics is a required field
    TextDocumentStatistics *TextDocumentStatistics `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Provides information about the number of documents and the number of questions and answers in an index.

func (IndexStatistics) GoString

func (s IndexStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IndexStatistics) SetFaqStatistics

func (s *IndexStatistics) SetFaqStatistics(v *FaqStatistics) *IndexStatistics

SetFaqStatistics sets the FaqStatistics field's value.

func (*IndexStatistics) SetTextDocumentStatistics

func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics

SetTextDocumentStatistics sets the TextDocumentStatistics field's value.

func (IndexStatistics) String

func (s IndexStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JsonTokenTypeConfiguration

type JsonTokenTypeConfiguration struct {

    // The group attribute field.
    //
    // GroupAttributeField is a required field
    GroupAttributeField *string `min:"1" type:"string" required:"true"`

    // The user name attribute field.
    //
    // UserNameAttributeField is a required field
    UserNameAttributeField *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Configuration information for the JSON token type.

func (JsonTokenTypeConfiguration) GoString

func (s JsonTokenTypeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JsonTokenTypeConfiguration) SetGroupAttributeField

func (s *JsonTokenTypeConfiguration) SetGroupAttributeField(v string) *JsonTokenTypeConfiguration

SetGroupAttributeField sets the GroupAttributeField field's value.

func (*JsonTokenTypeConfiguration) SetUserNameAttributeField

func (s *JsonTokenTypeConfiguration) SetUserNameAttributeField(v string) *JsonTokenTypeConfiguration

SetUserNameAttributeField sets the UserNameAttributeField field's value.

func (JsonTokenTypeConfiguration) String

func (s JsonTokenTypeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JsonTokenTypeConfiguration) Validate

func (s *JsonTokenTypeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JwtTokenTypeConfiguration

type JwtTokenTypeConfiguration struct {

    // The regular expression that identifies the claim.
    ClaimRegex *string `min:"1" type:"string"`

    // The group attribute field.
    GroupAttributeField *string `min:"1" type:"string"`

    // The issuer of the token.
    Issuer *string `min:"1" type:"string"`

    // The location of the key.
    //
    // KeyLocation is a required field
    KeyLocation *string `type:"string" required:"true" enum:"KeyLocation"`

    // The Amazon Resource Name (arn) of the secret.
    SecretManagerArn *string `min:"1" type:"string"`

    // The signing key URL.
    URL *string `min:"1" type:"string"`

    // The user name attribute field.
    UserNameAttributeField *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Configuration information for the JWT token type.

func (JwtTokenTypeConfiguration) GoString

func (s JwtTokenTypeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JwtTokenTypeConfiguration) SetClaimRegex

func (s *JwtTokenTypeConfiguration) SetClaimRegex(v string) *JwtTokenTypeConfiguration

SetClaimRegex sets the ClaimRegex field's value.

func (*JwtTokenTypeConfiguration) SetGroupAttributeField

func (s *JwtTokenTypeConfiguration) SetGroupAttributeField(v string) *JwtTokenTypeConfiguration

SetGroupAttributeField sets the GroupAttributeField field's value.

func (*JwtTokenTypeConfiguration) SetIssuer

func (s *JwtTokenTypeConfiguration) SetIssuer(v string) *JwtTokenTypeConfiguration

SetIssuer sets the Issuer field's value.

func (*JwtTokenTypeConfiguration) SetKeyLocation

func (s *JwtTokenTypeConfiguration) SetKeyLocation(v string) *JwtTokenTypeConfiguration

SetKeyLocation sets the KeyLocation field's value.

func (*JwtTokenTypeConfiguration) SetSecretManagerArn

func (s *JwtTokenTypeConfiguration) SetSecretManagerArn(v string) *JwtTokenTypeConfiguration

SetSecretManagerArn sets the SecretManagerArn field's value.

func (*JwtTokenTypeConfiguration) SetURL

func (s *JwtTokenTypeConfiguration) SetURL(v string) *JwtTokenTypeConfiguration

SetURL sets the URL field's value.

func (*JwtTokenTypeConfiguration) SetUserNameAttributeField

func (s *JwtTokenTypeConfiguration) SetUserNameAttributeField(v string) *JwtTokenTypeConfiguration

SetUserNameAttributeField sets the UserNameAttributeField field's value.

func (JwtTokenTypeConfiguration) String

func (s JwtTokenTypeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JwtTokenTypeConfiguration) Validate

func (s *JwtTokenTypeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Kendra

type Kendra struct {
    *client.Client
}

Kendra provides the API operation methods for making requests to AWSKendraFrontendService. See this package's package overview docs for details on the service.

Kendra methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Kendra

New creates a new instance of the Kendra client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a Kendra client from just a session.
svc := kendra.New(mySession)

// Create a Kendra client with additional configuration
svc := kendra.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Kendra) BatchDeleteDocument

func (c *Kendra) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocument API operation for AWSKendraFrontendService.

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchDeleteDocument for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument

func (*Kendra) BatchDeleteDocumentRequest

func (c *Kendra) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) (req *request.Request, output *BatchDeleteDocumentOutput)

BatchDeleteDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDeleteDocument for more information on using the BatchDeleteDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchDeleteDocumentRequest method.
req, resp := client.BatchDeleteDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocument

func (*Kendra) BatchDeleteDocumentWithContext

func (c *Kendra) BatchDeleteDocumentWithContext(ctx aws.Context, input *BatchDeleteDocumentInput, opts ...request.Option) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocumentWithContext is the same as BatchDeleteDocument with the addition of the ability to pass a context and additional request options.

See BatchDeleteDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchGetDocumentStatus

func (c *Kendra) BatchGetDocumentStatus(input *BatchGetDocumentStatusInput) (*BatchGetDocumentStatusOutput, error)

BatchGetDocumentStatus API operation for AWSKendraFrontendService.

Returns the indexing status for one or more documents submitted with the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchGetDocumentStatus for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus

func (*Kendra) BatchGetDocumentStatusRequest

func (c *Kendra) BatchGetDocumentStatusRequest(input *BatchGetDocumentStatusInput) (req *request.Request, output *BatchGetDocumentStatusOutput)

BatchGetDocumentStatusRequest generates a "aws/request.Request" representing the client's request for the BatchGetDocumentStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetDocumentStatus for more information on using the BatchGetDocumentStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetDocumentStatusRequest method.
req, resp := client.BatchGetDocumentStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus

func (*Kendra) BatchGetDocumentStatusWithContext

func (c *Kendra) BatchGetDocumentStatusWithContext(ctx aws.Context, input *BatchGetDocumentStatusInput, opts ...request.Option) (*BatchGetDocumentStatusOutput, error)

BatchGetDocumentStatusWithContext is the same as BatchGetDocumentStatus with the addition of the ability to pass a context and additional request options.

See BatchGetDocumentStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchPutDocument

func (c *Kendra) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error)

BatchPutDocument API operation for AWSKendraFrontendService.

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchPutDocument for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ServiceQuotaExceededException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument

func (*Kendra) BatchPutDocumentRequest

func (c *Kendra) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req *request.Request, output *BatchPutDocumentOutput)

BatchPutDocumentRequest generates a "aws/request.Request" representing the client's request for the BatchPutDocument operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutDocument for more information on using the BatchPutDocument API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchPutDocumentRequest method.
req, resp := client.BatchPutDocumentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocument

func (*Kendra) BatchPutDocumentWithContext

func (c *Kendra) BatchPutDocumentWithContext(ctx aws.Context, input *BatchPutDocumentInput, opts ...request.Option) (*BatchPutDocumentOutput, error)

BatchPutDocumentWithContext is the same as BatchPutDocument with the addition of the ability to pass a context and additional request options.

See BatchPutDocument for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ClearQuerySuggestions

func (c *Kendra) ClearQuerySuggestions(input *ClearQuerySuggestionsInput) (*ClearQuerySuggestionsOutput, error)

ClearQuerySuggestions API operation for AWSKendraFrontendService.

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ClearQuerySuggestions for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* ConflictException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions

func (*Kendra) ClearQuerySuggestionsRequest

func (c *Kendra) ClearQuerySuggestionsRequest(input *ClearQuerySuggestionsInput) (req *request.Request, output *ClearQuerySuggestionsOutput)

ClearQuerySuggestionsRequest generates a "aws/request.Request" representing the client's request for the ClearQuerySuggestions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ClearQuerySuggestions for more information on using the ClearQuerySuggestions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ClearQuerySuggestionsRequest method.
req, resp := client.ClearQuerySuggestionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions

func (*Kendra) ClearQuerySuggestionsWithContext

func (c *Kendra) ClearQuerySuggestionsWithContext(ctx aws.Context, input *ClearQuerySuggestionsInput, opts ...request.Option) (*ClearQuerySuggestionsOutput, error)

ClearQuerySuggestionsWithContext is the same as ClearQuerySuggestions with the addition of the ability to pass a context and additional request options.

See ClearQuerySuggestions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateDataSource

func (c *Kendra) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)

CreateDataSource API operation for AWSKendraFrontendService.

Creates a data source that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateDataSource for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ResourceAlreadyExistException

* ServiceQuotaExceededException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource

func (*Kendra) CreateDataSourceRequest

func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *request.Request, output *CreateDataSourceOutput)

CreateDataSourceRequest generates a "aws/request.Request" representing the client's request for the CreateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDataSource for more information on using the CreateDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDataSourceRequest method.
req, resp := client.CreateDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSource

func (*Kendra) CreateDataSourceWithContext

func (c *Kendra) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataSourceInput, opts ...request.Option) (*CreateDataSourceOutput, error)

CreateDataSourceWithContext is the same as CreateDataSource with the addition of the ability to pass a context and additional request options.

See CreateDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateFaq

func (c *Kendra) CreateFaq(input *CreateFaqInput) (*CreateFaqOutput, error)

CreateFaq API operation for AWSKendraFrontendService.

Creates an new set of frequently asked question (FAQ) questions and answers.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateFaq for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* ServiceQuotaExceededException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq

func (*Kendra) CreateFaqRequest

func (c *Kendra) CreateFaqRequest(input *CreateFaqInput) (req *request.Request, output *CreateFaqOutput)

CreateFaqRequest generates a "aws/request.Request" representing the client's request for the CreateFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFaq for more information on using the CreateFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFaqRequest method.
req, resp := client.CreateFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaq

func (*Kendra) CreateFaqWithContext

func (c *Kendra) CreateFaqWithContext(ctx aws.Context, input *CreateFaqInput, opts ...request.Option) (*CreateFaqOutput, error)

CreateFaqWithContext is the same as CreateFaq with the addition of the ability to pass a context and additional request options.

See CreateFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateIndex

func (c *Kendra) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)

CreateIndex API operation for AWSKendraFrontendService.

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateIndex for usage and error information.

Returned Error Types:

* ValidationException

* ResourceAlreadyExistException

* ServiceQuotaExceededException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex

func (*Kendra) CreateIndexRequest

func (c *Kendra) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)

CreateIndexRequest generates a "aws/request.Request" representing the client's request for the CreateIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateIndex for more information on using the CreateIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateIndexRequest method.
req, resp := client.CreateIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndex

func (*Kendra) CreateIndexWithContext

func (c *Kendra) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)

CreateIndexWithContext is the same as CreateIndex with the addition of the ability to pass a context and additional request options.

See CreateIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateQuerySuggestionsBlockList

func (c *Kendra) CreateQuerySuggestionsBlockList(input *CreateQuerySuggestionsBlockListInput) (*CreateQuerySuggestionsBlockListOutput, error)

CreateQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ServiceQuotaExceededException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList

func (*Kendra) CreateQuerySuggestionsBlockListRequest

func (c *Kendra) CreateQuerySuggestionsBlockListRequest(input *CreateQuerySuggestionsBlockListInput) (req *request.Request, output *CreateQuerySuggestionsBlockListOutput)

CreateQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the CreateQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateQuerySuggestionsBlockList for more information on using the CreateQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateQuerySuggestionsBlockListRequest method.
req, resp := client.CreateQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList

func (*Kendra) CreateQuerySuggestionsBlockListWithContext

func (c *Kendra) CreateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *CreateQuerySuggestionsBlockListInput, opts ...request.Option) (*CreateQuerySuggestionsBlockListOutput, error)

CreateQuerySuggestionsBlockListWithContext is the same as CreateQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See CreateQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateThesaurus

func (c *Kendra) CreateThesaurus(input *CreateThesaurusInput) (*CreateThesaurusOutput, error)

CreateThesaurus API operation for AWSKendraFrontendService.

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateThesaurus for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* ServiceQuotaExceededException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus

func (*Kendra) CreateThesaurusRequest

func (c *Kendra) CreateThesaurusRequest(input *CreateThesaurusInput) (req *request.Request, output *CreateThesaurusOutput)

CreateThesaurusRequest generates a "aws/request.Request" representing the client's request for the CreateThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateThesaurus for more information on using the CreateThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateThesaurusRequest method.
req, resp := client.CreateThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus

func (*Kendra) CreateThesaurusWithContext

func (c *Kendra) CreateThesaurusWithContext(ctx aws.Context, input *CreateThesaurusInput, opts ...request.Option) (*CreateThesaurusOutput, error)

CreateThesaurusWithContext is the same as CreateThesaurus with the addition of the ability to pass a context and additional request options.

See CreateThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteDataSource

func (c *Kendra) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)

DeleteDataSource API operation for AWSKendraFrontendService.

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteDataSource for usage and error information.

Returned Error Types:

* AccessDeniedException

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource

func (*Kendra) DeleteDataSourceRequest

func (c *Kendra) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)

DeleteDataSourceRequest generates a "aws/request.Request" representing the client's request for the DeleteDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDataSource for more information on using the DeleteDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDataSourceRequest method.
req, resp := client.DeleteDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource

func (*Kendra) DeleteDataSourceWithContext

func (c *Kendra) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)

DeleteDataSourceWithContext is the same as DeleteDataSource with the addition of the ability to pass a context and additional request options.

See DeleteDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteFaq

func (c *Kendra) DeleteFaq(input *DeleteFaqInput) (*DeleteFaqOutput, error)

DeleteFaq API operation for AWSKendraFrontendService.

Removes an FAQ from an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteFaq for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq

func (*Kendra) DeleteFaqRequest

func (c *Kendra) DeleteFaqRequest(input *DeleteFaqInput) (req *request.Request, output *DeleteFaqOutput)

DeleteFaqRequest generates a "aws/request.Request" representing the client's request for the DeleteFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFaq for more information on using the DeleteFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFaqRequest method.
req, resp := client.DeleteFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaq

func (*Kendra) DeleteFaqWithContext

func (c *Kendra) DeleteFaqWithContext(ctx aws.Context, input *DeleteFaqInput, opts ...request.Option) (*DeleteFaqOutput, error)

DeleteFaqWithContext is the same as DeleteFaq with the addition of the ability to pass a context and additional request options.

See DeleteFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteIndex

func (c *Kendra) DeleteIndex(input *DeleteIndexInput) (*DeleteIndexOutput, error)

DeleteIndex API operation for AWSKendraFrontendService.

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteIndex for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex

func (*Kendra) DeleteIndexRequest

func (c *Kendra) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Request, output *DeleteIndexOutput)

DeleteIndexRequest generates a "aws/request.Request" representing the client's request for the DeleteIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIndex for more information on using the DeleteIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteIndexRequest method.
req, resp := client.DeleteIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndex

func (*Kendra) DeleteIndexWithContext

func (c *Kendra) DeleteIndexWithContext(ctx aws.Context, input *DeleteIndexInput, opts ...request.Option) (*DeleteIndexOutput, error)

DeleteIndexWithContext is the same as DeleteIndex with the addition of the ability to pass a context and additional request options.

See DeleteIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeletePrincipalMapping

func (c *Kendra) DeletePrincipalMapping(input *DeletePrincipalMappingInput) (*DeletePrincipalMappingOutput, error)

DeletePrincipalMapping API operation for AWSKendraFrontendService.

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.

If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeletePrincipalMapping for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMapping

func (*Kendra) DeletePrincipalMappingRequest

func (c *Kendra) DeletePrincipalMappingRequest(input *DeletePrincipalMappingInput) (req *request.Request, output *DeletePrincipalMappingOutput)

DeletePrincipalMappingRequest generates a "aws/request.Request" representing the client's request for the DeletePrincipalMapping operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePrincipalMapping for more information on using the DeletePrincipalMapping API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeletePrincipalMappingRequest method.
req, resp := client.DeletePrincipalMappingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMapping

func (*Kendra) DeletePrincipalMappingWithContext

func (c *Kendra) DeletePrincipalMappingWithContext(ctx aws.Context, input *DeletePrincipalMappingInput, opts ...request.Option) (*DeletePrincipalMappingOutput, error)

DeletePrincipalMappingWithContext is the same as DeletePrincipalMapping with the addition of the ability to pass a context and additional request options.

See DeletePrincipalMapping for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteQuerySuggestionsBlockList

func (c *Kendra) DeleteQuerySuggestionsBlockList(input *DeleteQuerySuggestionsBlockListInput) (*DeleteQuerySuggestionsBlockListOutput, error)

DeleteQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList

func (*Kendra) DeleteQuerySuggestionsBlockListRequest

func (c *Kendra) DeleteQuerySuggestionsBlockListRequest(input *DeleteQuerySuggestionsBlockListInput) (req *request.Request, output *DeleteQuerySuggestionsBlockListOutput)

DeleteQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the DeleteQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteQuerySuggestionsBlockList for more information on using the DeleteQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteQuerySuggestionsBlockListRequest method.
req, resp := client.DeleteQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList

func (*Kendra) DeleteQuerySuggestionsBlockListWithContext

func (c *Kendra) DeleteQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DeleteQuerySuggestionsBlockListInput, opts ...request.Option) (*DeleteQuerySuggestionsBlockListOutput, error)

DeleteQuerySuggestionsBlockListWithContext is the same as DeleteQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See DeleteQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DeleteThesaurus

func (c *Kendra) DeleteThesaurus(input *DeleteThesaurusInput) (*DeleteThesaurusOutput, error)

DeleteThesaurus API operation for AWSKendraFrontendService.

Deletes an existing Amazon Kendra thesaurus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DeleteThesaurus for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus

func (*Kendra) DeleteThesaurusRequest

func (c *Kendra) DeleteThesaurusRequest(input *DeleteThesaurusInput) (req *request.Request, output *DeleteThesaurusOutput)

DeleteThesaurusRequest generates a "aws/request.Request" representing the client's request for the DeleteThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteThesaurus for more information on using the DeleteThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteThesaurusRequest method.
req, resp := client.DeleteThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus

func (*Kendra) DeleteThesaurusWithContext

func (c *Kendra) DeleteThesaurusWithContext(ctx aws.Context, input *DeleteThesaurusInput, opts ...request.Option) (*DeleteThesaurusOutput, error)

DeleteThesaurusWithContext is the same as DeleteThesaurus with the addition of the ability to pass a context and additional request options.

See DeleteThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeDataSource

func (c *Kendra) DescribeDataSource(input *DescribeDataSourceInput) (*DescribeDataSourceOutput, error)

DescribeDataSource API operation for AWSKendraFrontendService.

Gets information about a Amazon Kendra data source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeDataSource for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource

func (*Kendra) DescribeDataSourceRequest

func (c *Kendra) DescribeDataSourceRequest(input *DescribeDataSourceInput) (req *request.Request, output *DescribeDataSourceOutput)

DescribeDataSourceRequest generates a "aws/request.Request" representing the client's request for the DescribeDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDataSource for more information on using the DescribeDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDataSourceRequest method.
req, resp := client.DescribeDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource

func (*Kendra) DescribeDataSourceWithContext

func (c *Kendra) DescribeDataSourceWithContext(ctx aws.Context, input *DescribeDataSourceInput, opts ...request.Option) (*DescribeDataSourceOutput, error)

DescribeDataSourceWithContext is the same as DescribeDataSource with the addition of the ability to pass a context and additional request options.

See DescribeDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeFaq

func (c *Kendra) DescribeFaq(input *DescribeFaqInput) (*DescribeFaqOutput, error)

DescribeFaq API operation for AWSKendraFrontendService.

Gets information about an FAQ list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeFaq for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq

func (*Kendra) DescribeFaqRequest

func (c *Kendra) DescribeFaqRequest(input *DescribeFaqInput) (req *request.Request, output *DescribeFaqOutput)

DescribeFaqRequest generates a "aws/request.Request" representing the client's request for the DescribeFaq operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFaq for more information on using the DescribeFaq API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFaqRequest method.
req, resp := client.DescribeFaqRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq

func (*Kendra) DescribeFaqWithContext

func (c *Kendra) DescribeFaqWithContext(ctx aws.Context, input *DescribeFaqInput, opts ...request.Option) (*DescribeFaqOutput, error)

DescribeFaqWithContext is the same as DescribeFaq with the addition of the ability to pass a context and additional request options.

See DescribeFaq for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeIndex

func (c *Kendra) DescribeIndex(input *DescribeIndexInput) (*DescribeIndexOutput, error)

DescribeIndex API operation for AWSKendraFrontendService.

Describes an existing Amazon Kendra index

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeIndex for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex

func (*Kendra) DescribeIndexRequest

func (c *Kendra) DescribeIndexRequest(input *DescribeIndexInput) (req *request.Request, output *DescribeIndexOutput)

DescribeIndexRequest generates a "aws/request.Request" representing the client's request for the DescribeIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIndex for more information on using the DescribeIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeIndexRequest method.
req, resp := client.DescribeIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex

func (*Kendra) DescribeIndexWithContext

func (c *Kendra) DescribeIndexWithContext(ctx aws.Context, input *DescribeIndexInput, opts ...request.Option) (*DescribeIndexOutput, error)

DescribeIndexWithContext is the same as DescribeIndex with the addition of the ability to pass a context and additional request options.

See DescribeIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribePrincipalMapping

func (c *Kendra) DescribePrincipalMapping(input *DescribePrincipalMappingInput) (*DescribePrincipalMappingOutput, error)

DescribePrincipalMapping API operation for AWSKendraFrontendService.

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribePrincipalMapping for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMapping

func (*Kendra) DescribePrincipalMappingRequest

func (c *Kendra) DescribePrincipalMappingRequest(input *DescribePrincipalMappingInput) (req *request.Request, output *DescribePrincipalMappingOutput)

DescribePrincipalMappingRequest generates a "aws/request.Request" representing the client's request for the DescribePrincipalMapping operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePrincipalMapping for more information on using the DescribePrincipalMapping API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePrincipalMappingRequest method.
req, resp := client.DescribePrincipalMappingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMapping

func (*Kendra) DescribePrincipalMappingWithContext

func (c *Kendra) DescribePrincipalMappingWithContext(ctx aws.Context, input *DescribePrincipalMappingInput, opts ...request.Option) (*DescribePrincipalMappingOutput, error)

DescribePrincipalMappingWithContext is the same as DescribePrincipalMapping with the addition of the ability to pass a context and additional request options.

See DescribePrincipalMapping for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeQuerySuggestionsBlockList

func (c *Kendra) DescribeQuerySuggestionsBlockList(input *DescribeQuerySuggestionsBlockListInput) (*DescribeQuerySuggestionsBlockListOutput, error)

DescribeQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Describes a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList

func (*Kendra) DescribeQuerySuggestionsBlockListRequest

func (c *Kendra) DescribeQuerySuggestionsBlockListRequest(input *DescribeQuerySuggestionsBlockListInput) (req *request.Request, output *DescribeQuerySuggestionsBlockListOutput)

DescribeQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the DescribeQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQuerySuggestionsBlockList for more information on using the DescribeQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeQuerySuggestionsBlockListRequest method.
req, resp := client.DescribeQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList

func (*Kendra) DescribeQuerySuggestionsBlockListWithContext

func (c *Kendra) DescribeQuerySuggestionsBlockListWithContext(ctx aws.Context, input *DescribeQuerySuggestionsBlockListInput, opts ...request.Option) (*DescribeQuerySuggestionsBlockListOutput, error)

DescribeQuerySuggestionsBlockListWithContext is the same as DescribeQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See DescribeQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeQuerySuggestionsConfig

func (c *Kendra) DescribeQuerySuggestionsConfig(input *DescribeQuerySuggestionsConfigInput) (*DescribeQuerySuggestionsConfigOutput, error)

DescribeQuerySuggestionsConfig API operation for AWSKendraFrontendService.

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeQuerySuggestionsConfig for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig

func (*Kendra) DescribeQuerySuggestionsConfigRequest

func (c *Kendra) DescribeQuerySuggestionsConfigRequest(input *DescribeQuerySuggestionsConfigInput) (req *request.Request, output *DescribeQuerySuggestionsConfigOutput)

DescribeQuerySuggestionsConfigRequest generates a "aws/request.Request" representing the client's request for the DescribeQuerySuggestionsConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeQuerySuggestionsConfig for more information on using the DescribeQuerySuggestionsConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeQuerySuggestionsConfigRequest method.
req, resp := client.DescribeQuerySuggestionsConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig

func (*Kendra) DescribeQuerySuggestionsConfigWithContext

func (c *Kendra) DescribeQuerySuggestionsConfigWithContext(ctx aws.Context, input *DescribeQuerySuggestionsConfigInput, opts ...request.Option) (*DescribeQuerySuggestionsConfigOutput, error)

DescribeQuerySuggestionsConfigWithContext is the same as DescribeQuerySuggestionsConfig with the addition of the ability to pass a context and additional request options.

See DescribeQuerySuggestionsConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) DescribeThesaurus

func (c *Kendra) DescribeThesaurus(input *DescribeThesaurusInput) (*DescribeThesaurusOutput, error)

DescribeThesaurus API operation for AWSKendraFrontendService.

Describes an existing Amazon Kendra thesaurus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation DescribeThesaurus for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus

func (*Kendra) DescribeThesaurusRequest

func (c *Kendra) DescribeThesaurusRequest(input *DescribeThesaurusInput) (req *request.Request, output *DescribeThesaurusOutput)

DescribeThesaurusRequest generates a "aws/request.Request" representing the client's request for the DescribeThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeThesaurus for more information on using the DescribeThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeThesaurusRequest method.
req, resp := client.DescribeThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus

func (*Kendra) DescribeThesaurusWithContext

func (c *Kendra) DescribeThesaurusWithContext(ctx aws.Context, input *DescribeThesaurusInput, opts ...request.Option) (*DescribeThesaurusOutput, error)

DescribeThesaurusWithContext is the same as DescribeThesaurus with the addition of the ability to pass a context and additional request options.

See DescribeThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) GetQuerySuggestions

func (c *Kendra) GetQuerySuggestions(input *GetQuerySuggestionsInput) (*GetQuerySuggestionsOutput, error)

GetQuerySuggestions API operation for AWSKendraFrontendService.

Fetches the queries that are suggested to your users.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation GetQuerySuggestions for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ServiceQuotaExceededException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions

func (*Kendra) GetQuerySuggestionsRequest

func (c *Kendra) GetQuerySuggestionsRequest(input *GetQuerySuggestionsInput) (req *request.Request, output *GetQuerySuggestionsOutput)

GetQuerySuggestionsRequest generates a "aws/request.Request" representing the client's request for the GetQuerySuggestions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetQuerySuggestions for more information on using the GetQuerySuggestions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetQuerySuggestionsRequest method.
req, resp := client.GetQuerySuggestionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions

func (*Kendra) GetQuerySuggestionsWithContext

func (c *Kendra) GetQuerySuggestionsWithContext(ctx aws.Context, input *GetQuerySuggestionsInput, opts ...request.Option) (*GetQuerySuggestionsOutput, error)

GetQuerySuggestionsWithContext is the same as GetQuerySuggestions with the addition of the ability to pass a context and additional request options.

See GetQuerySuggestions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourceSyncJobs

func (c *Kendra) ListDataSourceSyncJobs(input *ListDataSourceSyncJobsInput) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobs API operation for AWSKendraFrontendService.

Gets statistics about synchronizing Amazon Kendra with a data source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSourceSyncJobs for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs

func (*Kendra) ListDataSourceSyncJobsPages

func (c *Kendra) ListDataSourceSyncJobsPages(input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool) error

ListDataSourceSyncJobsPages iterates over the pages of a ListDataSourceSyncJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSourceSyncJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDataSourceSyncJobs operation.
pageNum := 0
err := client.ListDataSourceSyncJobsPages(params,
    func(page *kendra.ListDataSourceSyncJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListDataSourceSyncJobsPagesWithContext

func (c *Kendra) ListDataSourceSyncJobsPagesWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, fn func(*ListDataSourceSyncJobsOutput, bool) bool, opts ...request.Option) error

ListDataSourceSyncJobsPagesWithContext same as ListDataSourceSyncJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourceSyncJobsRequest

func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInput) (req *request.Request, output *ListDataSourceSyncJobsOutput)

ListDataSourceSyncJobsRequest generates a "aws/request.Request" representing the client's request for the ListDataSourceSyncJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDataSourceSyncJobs for more information on using the ListDataSourceSyncJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDataSourceSyncJobsRequest method.
req, resp := client.ListDataSourceSyncJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs

func (*Kendra) ListDataSourceSyncJobsWithContext

func (c *Kendra) ListDataSourceSyncJobsWithContext(ctx aws.Context, input *ListDataSourceSyncJobsInput, opts ...request.Option) (*ListDataSourceSyncJobsOutput, error)

ListDataSourceSyncJobsWithContext is the same as ListDataSourceSyncJobs with the addition of the ability to pass a context and additional request options.

See ListDataSourceSyncJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSources

func (c *Kendra) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)

ListDataSources API operation for AWSKendraFrontendService.

Lists the data sources that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListDataSources for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* AccessDeniedException

* ThrottlingException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources

func (*Kendra) ListDataSourcesPages

func (c *Kendra) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error

ListDataSourcesPages iterates over the pages of a ListDataSources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDataSources operation.
pageNum := 0
err := client.ListDataSourcesPages(params,
    func(page *kendra.ListDataSourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListDataSourcesPagesWithContext

func (c *Kendra) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error

ListDataSourcesPagesWithContext same as ListDataSourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListDataSourcesRequest

func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)

ListDataSourcesRequest generates a "aws/request.Request" representing the client's request for the ListDataSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDataSources for more information on using the ListDataSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDataSourcesRequest method.
req, resp := client.ListDataSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources

func (*Kendra) ListDataSourcesWithContext

func (c *Kendra) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)

ListDataSourcesWithContext is the same as ListDataSources with the addition of the ability to pass a context and additional request options.

See ListDataSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListFaqs

func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error)

ListFaqs API operation for AWSKendraFrontendService.

Gets a list of FAQ lists associated with an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListFaqs for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs

func (*Kendra) ListFaqsRequest

func (c *Kendra) ListFaqsRequest(input *ListFaqsInput) (req *request.Request, output *ListFaqsOutput)

ListFaqsRequest generates a "aws/request.Request" representing the client's request for the ListFaqs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFaqs for more information on using the ListFaqs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFaqsRequest method.
req, resp := client.ListFaqsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs

func (*Kendra) ListFaqsWithContext

func (c *Kendra) ListFaqsWithContext(ctx aws.Context, input *ListFaqsInput, opts ...request.Option) (*ListFaqsOutput, error)

ListFaqsWithContext is the same as ListFaqs with the addition of the ability to pass a context and additional request options.

See ListFaqs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListGroupsOlderThanOrderingId

func (c *Kendra) ListGroupsOlderThanOrderingId(input *ListGroupsOlderThanOrderingIdInput) (*ListGroupsOlderThanOrderingIdOutput, error)

ListGroupsOlderThanOrderingId API operation for AWSKendraFrontendService.

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListGroupsOlderThanOrderingId for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* AccessDeniedException

* ThrottlingException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId

func (*Kendra) ListGroupsOlderThanOrderingIdRequest

func (c *Kendra) ListGroupsOlderThanOrderingIdRequest(input *ListGroupsOlderThanOrderingIdInput) (req *request.Request, output *ListGroupsOlderThanOrderingIdOutput)

ListGroupsOlderThanOrderingIdRequest generates a "aws/request.Request" representing the client's request for the ListGroupsOlderThanOrderingId operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGroupsOlderThanOrderingId for more information on using the ListGroupsOlderThanOrderingId API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListGroupsOlderThanOrderingIdRequest method.
req, resp := client.ListGroupsOlderThanOrderingIdRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId

func (*Kendra) ListGroupsOlderThanOrderingIdWithContext

func (c *Kendra) ListGroupsOlderThanOrderingIdWithContext(ctx aws.Context, input *ListGroupsOlderThanOrderingIdInput, opts ...request.Option) (*ListGroupsOlderThanOrderingIdOutput, error)

ListGroupsOlderThanOrderingIdWithContext is the same as ListGroupsOlderThanOrderingId with the addition of the ability to pass a context and additional request options.

See ListGroupsOlderThanOrderingId for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListIndices

func (c *Kendra) ListIndices(input *ListIndicesInput) (*ListIndicesOutput, error)

ListIndices API operation for AWSKendraFrontendService.

Lists the Amazon Kendra indexes that you have created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListIndices for usage and error information.

Returned Error Types:

* ValidationException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices

func (*Kendra) ListIndicesPages

func (c *Kendra) ListIndicesPages(input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool) error

ListIndicesPages iterates over the pages of a ListIndices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListIndices operation.
pageNum := 0
err := client.ListIndicesPages(params,
    func(page *kendra.ListIndicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kendra) ListIndicesPagesWithContext

func (c *Kendra) ListIndicesPagesWithContext(ctx aws.Context, input *ListIndicesInput, fn func(*ListIndicesOutput, bool) bool, opts ...request.Option) error

ListIndicesPagesWithContext same as ListIndicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListIndicesRequest

func (c *Kendra) ListIndicesRequest(input *ListIndicesInput) (req *request.Request, output *ListIndicesOutput)

ListIndicesRequest generates a "aws/request.Request" representing the client's request for the ListIndices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIndices for more information on using the ListIndices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIndicesRequest method.
req, resp := client.ListIndicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices

func (*Kendra) ListIndicesWithContext

func (c *Kendra) ListIndicesWithContext(ctx aws.Context, input *ListIndicesInput, opts ...request.Option) (*ListIndicesOutput, error)

ListIndicesWithContext is the same as ListIndices with the addition of the ability to pass a context and additional request options.

See ListIndices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListQuerySuggestionsBlockLists

func (c *Kendra) ListQuerySuggestionsBlockLists(input *ListQuerySuggestionsBlockListsInput) (*ListQuerySuggestionsBlockListsOutput, error)

ListQuerySuggestionsBlockLists API operation for AWSKendraFrontendService.

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListQuerySuggestionsBlockLists for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists

func (*Kendra) ListQuerySuggestionsBlockListsRequest

func (c *Kendra) ListQuerySuggestionsBlockListsRequest(input *ListQuerySuggestionsBlockListsInput) (req *request.Request, output *ListQuerySuggestionsBlockListsOutput)

ListQuerySuggestionsBlockListsRequest generates a "aws/request.Request" representing the client's request for the ListQuerySuggestionsBlockLists operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListQuerySuggestionsBlockLists for more information on using the ListQuerySuggestionsBlockLists API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListQuerySuggestionsBlockListsRequest method.
req, resp := client.ListQuerySuggestionsBlockListsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists

func (*Kendra) ListQuerySuggestionsBlockListsWithContext

func (c *Kendra) ListQuerySuggestionsBlockListsWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, opts ...request.Option) (*ListQuerySuggestionsBlockListsOutput, error)

ListQuerySuggestionsBlockListsWithContext is the same as ListQuerySuggestionsBlockLists with the addition of the ability to pass a context and additional request options.

See ListQuerySuggestionsBlockLists for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListTagsForResource

func (c *Kendra) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWSKendraFrontendService.

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListTagsForResource for usage and error information.

Returned Error Types:

* ValidationException

* ResourceUnavailableException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource

func (*Kendra) ListTagsForResourceRequest

func (c *Kendra) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource

func (*Kendra) ListTagsForResourceWithContext

func (c *Kendra) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) ListThesauri

func (c *Kendra) ListThesauri(input *ListThesauriInput) (*ListThesauriOutput, error)

ListThesauri API operation for AWSKendraFrontendService.

Lists the Amazon Kendra thesauri associated with an index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ListThesauri for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri

func (*Kendra) ListThesauriRequest

func (c *Kendra) ListThesauriRequest(input *ListThesauriInput) (req *request.Request, output *ListThesauriOutput)

ListThesauriRequest generates a "aws/request.Request" representing the client's request for the ListThesauri operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListThesauri for more information on using the ListThesauri API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListThesauriRequest method.
req, resp := client.ListThesauriRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri

func (*Kendra) ListThesauriWithContext

func (c *Kendra) ListThesauriWithContext(ctx aws.Context, input *ListThesauriInput, opts ...request.Option) (*ListThesauriOutput, error)

ListThesauriWithContext is the same as ListThesauri with the addition of the ability to pass a context and additional request options.

See ListThesauri for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) PutPrincipalMapping

func (c *Kendra) PutPrincipalMapping(input *PutPrincipalMappingInput) (*PutPrincipalMappingOutput, error)

PutPrincipalMapping API operation for AWSKendraFrontendService.

Maps users to their groups so that you only need to provide the user ID when you issue the query.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.

You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html).

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation PutPrincipalMapping for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ServiceQuotaExceededException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping

func (*Kendra) PutPrincipalMappingRequest

func (c *Kendra) PutPrincipalMappingRequest(input *PutPrincipalMappingInput) (req *request.Request, output *PutPrincipalMappingOutput)

PutPrincipalMappingRequest generates a "aws/request.Request" representing the client's request for the PutPrincipalMapping operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPrincipalMapping for more information on using the PutPrincipalMapping API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutPrincipalMappingRequest method.
req, resp := client.PutPrincipalMappingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping

func (*Kendra) PutPrincipalMappingWithContext

func (c *Kendra) PutPrincipalMappingWithContext(ctx aws.Context, input *PutPrincipalMappingInput, opts ...request.Option) (*PutPrincipalMappingOutput, error)

PutPrincipalMappingWithContext is the same as PutPrincipalMapping with the addition of the ability to pass a context and additional request options.

See PutPrincipalMapping for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) Query

func (c *Kendra) Query(input *QueryInput) (*QueryOutput, error)

Query API operation for AWSKendraFrontendService.

Searches an 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 your 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 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.

func (*Kendra) UpdateQuerySuggestionsBlockList

func (c *Kendra) UpdateQuerySuggestionsBlockList(input *UpdateQuerySuggestionsBlockListInput) (*UpdateQuerySuggestionsBlockListOutput, error)

UpdateQuerySuggestionsBlockList API operation for AWSKendraFrontendService.

Updates a block list used for query suggestions for an index.

Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

If a block list is updating, then you need to wait for the first update to finish before submitting another update.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateQuerySuggestionsBlockList for usage and error information.

Returned Error Types:

* ValidationException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* ConflictException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList

func (*Kendra) UpdateQuerySuggestionsBlockListRequest

func (c *Kendra) UpdateQuerySuggestionsBlockListRequest(input *UpdateQuerySuggestionsBlockListInput) (req *request.Request, output *UpdateQuerySuggestionsBlockListOutput)

UpdateQuerySuggestionsBlockListRequest generates a "aws/request.Request" representing the client's request for the UpdateQuerySuggestionsBlockList operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateQuerySuggestionsBlockList for more information on using the UpdateQuerySuggestionsBlockList API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateQuerySuggestionsBlockListRequest method.
req, resp := client.UpdateQuerySuggestionsBlockListRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList

func (*Kendra) UpdateQuerySuggestionsBlockListWithContext

func (c *Kendra) UpdateQuerySuggestionsBlockListWithContext(ctx aws.Context, input *UpdateQuerySuggestionsBlockListInput, opts ...request.Option) (*UpdateQuerySuggestionsBlockListOutput, error)

UpdateQuerySuggestionsBlockListWithContext is the same as UpdateQuerySuggestionsBlockList with the addition of the ability to pass a context and additional request options.

See UpdateQuerySuggestionsBlockList for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateQuerySuggestionsConfig

func (c *Kendra) UpdateQuerySuggestionsConfig(input *UpdateQuerySuggestionsConfigInput) (*UpdateQuerySuggestionsConfigOutput, error)

UpdateQuerySuggestionsConfig API operation for AWSKendraFrontendService.

Updates the settings of query suggestions for an index.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.

Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

You can still enable/disable query suggestions at any time.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation UpdateQuerySuggestionsConfig for usage and error information.

Returned Error Types:

* ValidationException

* ConflictException

* ResourceNotFoundException

* ThrottlingException

* AccessDeniedException

* InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig

func (*Kendra) UpdateQuerySuggestionsConfigRequest

func (c *Kendra) UpdateQuerySuggestionsConfigRequest(input *UpdateQuerySuggestionsConfigInput) (req *request.Request, output *UpdateQuerySuggestionsConfigOutput)

UpdateQuerySuggestionsConfigRequest generates a "aws/request.Request" representing the client's request for the UpdateQuerySuggestionsConfig operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateQuerySuggestionsConfig for more information on using the UpdateQuerySuggestionsConfig API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateQuerySuggestionsConfigRequest method.
req, resp := client.UpdateQuerySuggestionsConfigRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig

func (*Kendra) UpdateQuerySuggestionsConfigWithContext

func (c *Kendra) UpdateQuerySuggestionsConfigWithContext(ctx aws.Context, input *UpdateQuerySuggestionsConfigInput, opts ...request.Option) (*UpdateQuerySuggestionsConfigOutput, error)

UpdateQuerySuggestionsConfigWithContext is the same as UpdateQuerySuggestionsConfig with the addition of the ability to pass a context and additional request options.

See UpdateQuerySuggestionsConfig for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) UpdateThesaurus

func (c *Kendra) UpdateThesaurus(input *UpdateThesaurusInput) (*UpdateThesaurusOutput, error)

UpdateThesaurus API operation for AWSKendraFrontendService.

Updates a thesaurus file 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 UpdateThesaurus 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/UpdateThesaurus

func (*Kendra) UpdateThesaurusRequest

func (c *Kendra) UpdateThesaurusRequest(input *UpdateThesaurusInput) (req *request.Request, output *UpdateThesaurusOutput)

UpdateThesaurusRequest generates a "aws/request.Request" representing the client's request for the UpdateThesaurus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateThesaurus for more information on using the UpdateThesaurus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateThesaurusRequest method.
req, resp := client.UpdateThesaurusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus

func (*Kendra) UpdateThesaurusWithContext

func (c *Kendra) UpdateThesaurusWithContext(ctx aws.Context, input *UpdateThesaurusInput, opts ...request.Option) (*UpdateThesaurusOutput, error)

UpdateThesaurusWithContext is the same as UpdateThesaurus with the addition of the ability to pass a context and additional request options.

See UpdateThesaurus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type 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 previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of jobs.
    NextToken *string `min:"1" type:"string"`

    // When specified, the synchronization jobs returned in the list are limited
    // to jobs between the specified dates.
    StartTimeFilter *TimeRange `type:"structure"`

    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourceSyncJobsInput) SetId

func (s *ListDataSourceSyncJobsInput) SetId(v string) *ListDataSourceSyncJobsInput

SetId sets the Id field's value.

func (*ListDataSourceSyncJobsInput) SetIndexId

func (s *ListDataSourceSyncJobsInput) SetIndexId(v string) *ListDataSourceSyncJobsInput

SetIndexId sets the IndexId field's value.

func (*ListDataSourceSyncJobsInput) SetMaxResults

func (s *ListDataSourceSyncJobsInput) SetMaxResults(v int64) *ListDataSourceSyncJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourceSyncJobsInput) SetNextToken

func (s *ListDataSourceSyncJobsInput) SetNextToken(v string) *ListDataSourceSyncJobsInput

SetNextToken sets the NextToken field's value.

func (*ListDataSourceSyncJobsInput) SetStartTimeFilter

func (s *ListDataSourceSyncJobsInput) SetStartTimeFilter(v *TimeRange) *ListDataSourceSyncJobsInput

SetStartTimeFilter sets the StartTimeFilter field's value.

func (*ListDataSourceSyncJobsInput) SetStatusFilter

func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceSyncJobsInput

SetStatusFilter sets the StatusFilter field's value.

func (ListDataSourceSyncJobsInput) String

func (s ListDataSourceSyncJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourceSyncJobsInput) Validate

func (s *ListDataSourceSyncJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDataSourceSyncJobsOutput

type ListDataSourceSyncJobsOutput struct {

    // A history of synchronization jobs for the data source.
    History []*DataSourceSyncJob `type:"list"`

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of jobs.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListDataSourceSyncJobsOutput) GoString

func (s ListDataSourceSyncJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourceSyncJobsOutput) SetHistory

func (s *ListDataSourceSyncJobsOutput) SetHistory(v []*DataSourceSyncJob) *ListDataSourceSyncJobsOutput

SetHistory sets the History field's value.

func (*ListDataSourceSyncJobsOutput) SetNextToken

func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyncJobsOutput

SetNextToken sets the NextToken field's value.

func (ListDataSourceSyncJobsOutput) String

func (s ListDataSourceSyncJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDataSourcesInput

type ListDataSourcesInput struct {

    // The identifier of the index 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) SetIndexId

func (s *ListDataSourcesInput) SetIndexId(v string) *ListDataSourcesInput

SetIndexId sets the IndexId field's value.

func (*ListDataSourcesInput) SetMaxResults

func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourcesInput) SetNextToken

func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput

SetNextToken sets the NextToken field's value.

func (ListDataSourcesInput) String

func (s ListDataSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) Validate

func (s *ListDataSourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDataSourcesOutput

type ListDataSourcesOutput struct {

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of data 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesOutput) SetNextToken

func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListDataSourcesOutput) SetSummaryItems

func (s *ListDataSourcesOutput) SetSummaryItems(v []*DataSourceSummary) *ListDataSourcesOutput

SetSummaryItems sets the SummaryItems field's value.

func (ListDataSourcesOutput) String

func (s ListDataSourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFaqsInput

type ListFaqsInput struct {

    // The index that contains the FAQ lists.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The maximum number of FAQs to return in the response. If there are fewer
    // results in the list, this response contains only the actual results.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of FAQs.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListFaqsInput) GoString

func (s ListFaqsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFaqsInput) SetIndexId

func (s *ListFaqsInput) SetIndexId(v string) *ListFaqsInput

SetIndexId sets the IndexId field's value.

func (*ListFaqsInput) SetMaxResults

func (s *ListFaqsInput) SetMaxResults(v int64) *ListFaqsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFaqsInput) SetNextToken

func (s *ListFaqsInput) SetNextToken(v string) *ListFaqsInput

SetNextToken sets the NextToken field's value.

func (ListFaqsInput) String

func (s ListFaqsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFaqsInput) Validate

func (s *ListFaqsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFaqsOutput

type ListFaqsOutput struct {

    // information about the FAQs associated with the specified index.
    FaqSummaryItems []*FaqSummary `type:"list"`

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of FAQs.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListFaqsOutput) GoString

func (s ListFaqsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFaqsOutput) SetFaqSummaryItems

func (s *ListFaqsOutput) SetFaqSummaryItems(v []*FaqSummary) *ListFaqsOutput

SetFaqSummaryItems sets the FaqSummaryItems field's value.

func (*ListFaqsOutput) SetNextToken

func (s *ListFaqsOutput) SetNextToken(v string) *ListFaqsOutput

SetNextToken sets the NextToken field's value.

func (ListFaqsOutput) String

func (s ListFaqsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGroupsOlderThanOrderingIdInput

type ListGroupsOlderThanOrderingIdInput struct {

    // The identifier of the data source for getting a list of groups mapped to
    // users before a given ordering timestamp identifier.
    DataSourceId *string `min:"1" type:"string"`

    // The identifier of the index for getting a list of groups mapped to users
    // before a given ordering or timestamp identifier.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The maximum number of returned groups that are mapped to users before a given
    // ordering or timestamp identifier.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of groups that are mapped to users
    // before a given ordering or timestamp identifier.
    NextToken *string `min:"1" type:"string"`

    // The timestamp identifier used for the latest PUT or DELETE action for mapping
    // users to their groups.
    //
    // OrderingId is a required field
    OrderingId *int64 `type:"long" required:"true"`
    // contains filtered or unexported fields
}

func (ListGroupsOlderThanOrderingIdInput) GoString

func (s ListGroupsOlderThanOrderingIdInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGroupsOlderThanOrderingIdInput) SetDataSourceId

func (s *ListGroupsOlderThanOrderingIdInput) SetDataSourceId(v string) *ListGroupsOlderThanOrderingIdInput

SetDataSourceId sets the DataSourceId field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetIndexId

func (s *ListGroupsOlderThanOrderingIdInput) SetIndexId(v string) *ListGroupsOlderThanOrderingIdInput

SetIndexId sets the IndexId field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetMaxResults

func (s *ListGroupsOlderThanOrderingIdInput) SetMaxResults(v int64) *ListGroupsOlderThanOrderingIdInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetNextToken

func (s *ListGroupsOlderThanOrderingIdInput) SetNextToken(v string) *ListGroupsOlderThanOrderingIdInput

SetNextToken sets the NextToken field's value.

func (*ListGroupsOlderThanOrderingIdInput) SetOrderingId

func (s *ListGroupsOlderThanOrderingIdInput) SetOrderingId(v int64) *ListGroupsOlderThanOrderingIdInput

SetOrderingId sets the OrderingId field's value.

func (ListGroupsOlderThanOrderingIdInput) String

func (s ListGroupsOlderThanOrderingIdInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGroupsOlderThanOrderingIdInput) Validate

func (s *ListGroupsOlderThanOrderingIdInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGroupsOlderThanOrderingIdOutput

type ListGroupsOlderThanOrderingIdOutput struct {

    // Summary information for list of groups that are mapped to users before a
    // given ordering or timestamp identifier.
    GroupsSummaries []*GroupSummary `type:"list"`

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of groups that are
    // mapped to users before a given ordering or timestamp identifier.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListGroupsOlderThanOrderingIdOutput) GoString

func (s ListGroupsOlderThanOrderingIdOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGroupsOlderThanOrderingIdOutput) SetGroupsSummaries

func (s *ListGroupsOlderThanOrderingIdOutput) SetGroupsSummaries(v []*GroupSummary) *ListGroupsOlderThanOrderingIdOutput

SetGroupsSummaries sets the GroupsSummaries field's value.

func (*ListGroupsOlderThanOrderingIdOutput) SetNextToken

func (s *ListGroupsOlderThanOrderingIdOutput) SetNextToken(v string) *ListGroupsOlderThanOrderingIdOutput

SetNextToken sets the NextToken field's value.

func (ListGroupsOlderThanOrderingIdOutput) String

func (s ListGroupsOlderThanOrderingIdOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListIndicesInput

type ListIndicesInput struct {

    // The maximum number of 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndicesInput) SetMaxResults

func (s *ListIndicesInput) SetMaxResults(v int64) *ListIndicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListIndicesInput) SetNextToken

func (s *ListIndicesInput) SetNextToken(v string) *ListIndicesInput

SetNextToken sets the NextToken field's value.

func (ListIndicesInput) String

func (s ListIndicesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndicesInput) Validate

func (s *ListIndicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIndicesOutput

type ListIndicesOutput struct {

    // An array of summary information 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIndicesOutput) SetIndexConfigurationSummaryItems

func (s *ListIndicesOutput) SetIndexConfigurationSummaryItems(v []*IndexConfigurationSummary) *ListIndicesOutput

SetIndexConfigurationSummaryItems sets the IndexConfigurationSummaryItems field's value.

func (*ListIndicesOutput) SetNextToken

func (s *ListIndicesOutput) SetNextToken(v string) *ListIndicesOutput

SetNextToken sets the NextToken field's value.

func (ListIndicesOutput) String

func (s ListIndicesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListQuerySuggestionsBlockListsInput

type ListQuerySuggestionsBlockListsInput struct {

    // The identifier of the index for a list of all block lists that exist for
    // that index.
    //
    // For information on the current quota limits for block lists, see Quotas for
    // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The maximum number of block lists to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of block lists (BlockListSummaryItems).
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListQuerySuggestionsBlockListsInput) GoString

func (s ListQuerySuggestionsBlockListsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuerySuggestionsBlockListsInput) SetIndexId

func (s *ListQuerySuggestionsBlockListsInput) SetIndexId(v string) *ListQuerySuggestionsBlockListsInput

SetIndexId sets the IndexId field's value.

func (*ListQuerySuggestionsBlockListsInput) SetMaxResults

func (s *ListQuerySuggestionsBlockListsInput) SetMaxResults(v int64) *ListQuerySuggestionsBlockListsInput

SetMaxResults sets the MaxResults field's value.

func (*ListQuerySuggestionsBlockListsInput) SetNextToken

func (s *ListQuerySuggestionsBlockListsInput) SetNextToken(v string) *ListQuerySuggestionsBlockListsInput

SetNextToken sets the NextToken field's value.

func (ListQuerySuggestionsBlockListsInput) String

func (s ListQuerySuggestionsBlockListsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuerySuggestionsBlockListsInput) Validate

func (s *ListQuerySuggestionsBlockListsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListQuerySuggestionsBlockListsOutput

type ListQuerySuggestionsBlockListsOutput struct {

    // Summary items for a block list.
    //
    // This includes summary items on the block list ID, block list name, when the
    // block list was created, when the block list was last updated, and the count
    // of block words/phrases in the block list.
    //
    // For information on the current quota limits for block lists, see Quotas for
    // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
    BlockListSummaryItems []*QuerySuggestionsBlockListSummary `type:"list"`

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of block lists.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListQuerySuggestionsBlockListsOutput) GoString

func (s ListQuerySuggestionsBlockListsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListQuerySuggestionsBlockListsOutput) SetBlockListSummaryItems

func (s *ListQuerySuggestionsBlockListsOutput) SetBlockListSummaryItems(v []*QuerySuggestionsBlockListSummary) *ListQuerySuggestionsBlockListsOutput

SetBlockListSummaryItems sets the BlockListSummaryItems field's value.

func (*ListQuerySuggestionsBlockListsOutput) SetNextToken

func (s *ListQuerySuggestionsBlockListsOutput) SetNextToken(v string) *ListQuerySuggestionsBlockListsOutput

SetNextToken sets the NextToken field's value.

func (ListQuerySuggestionsBlockListsOutput) String

func (s ListQuerySuggestionsBlockListsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListThesauriInput

type ListThesauriInput struct {

    // The identifier of the index associated with the thesaurus to list.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The maximum number of thesauri to return.
    MaxResults *int64 `min:"1" type:"integer"`

    // If the previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of thesauri (ThesaurusSummaryItems).
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListThesauriInput) GoString

func (s ListThesauriInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThesauriInput) SetIndexId

func (s *ListThesauriInput) SetIndexId(v string) *ListThesauriInput

SetIndexId sets the IndexId field's value.

func (*ListThesauriInput) SetMaxResults

func (s *ListThesauriInput) SetMaxResults(v int64) *ListThesauriInput

SetMaxResults sets the MaxResults field's value.

func (*ListThesauriInput) SetNextToken

func (s *ListThesauriInput) SetNextToken(v string) *ListThesauriInput

SetNextToken sets the NextToken field's value.

func (ListThesauriInput) String

func (s ListThesauriInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThesauriInput) Validate

func (s *ListThesauriInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListThesauriOutput

type ListThesauriOutput struct {

    // If the response is truncated, Amazon Kendra returns this token that you can
    // use in the subsequent request to retrieve the next set of thesauri.
    NextToken *string `min:"1" type:"string"`

    // An array of summary information for a thesaurus or multiple thesauri.
    ThesaurusSummaryItems []*ThesaurusSummary `type:"list"`
    // contains filtered or unexported fields
}

func (ListThesauriOutput) GoString

func (s ListThesauriOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListThesauriOutput) SetNextToken

func (s *ListThesauriOutput) SetNextToken(v string) *ListThesauriOutput

SetNextToken sets the NextToken field's value.

func (*ListThesauriOutput) SetThesaurusSummaryItems

func (s *ListThesauriOutput) SetThesaurusSummaryItems(v []*ThesaurusSummary) *ListThesauriOutput

SetThesaurusSummaryItems sets the ThesaurusSummaryItems field's value.

func (ListThesauriOutput) String

func (s ListThesauriOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MemberGroup

type MemberGroup struct {

    // The identifier of the data source for the sub group you want to map to a
    // group.
    DataSourceId *string `min:"1" type:"string"`

    // The identifier of the sub group you want to map to a group.
    //
    // GroupId is a required field
    GroupId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

The sub groups that belong to a group.

func (MemberGroup) GoString

func (s MemberGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberGroup) SetDataSourceId

func (s *MemberGroup) SetDataSourceId(v string) *MemberGroup

SetDataSourceId sets the DataSourceId field's value.

func (*MemberGroup) SetGroupId

func (s *MemberGroup) SetGroupId(v string) *MemberGroup

SetGroupId sets the GroupId field's value.

func (MemberGroup) String

func (s MemberGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberGroup) Validate

func (s *MemberGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MemberUser

type MemberUser struct {

    // The identifier of the user you want to map to a group.
    //
    // UserId is a required field
    UserId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

The users that belong to a group.

func (MemberUser) GoString

func (s MemberUser) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberUser) SetUserId

func (s *MemberUser) SetUserId(v string) *MemberUser

SetUserId sets the UserId field's value.

func (MemberUser) String

func (s MemberUser) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemberUser) Validate

func (s *MemberUser) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OneDriveConfiguration

type OneDriveConfiguration struct {

    // A Boolean value that specifies whether local groups are disabled (True) or
    // enabled (False).
    DisableLocalGroups *bool `type:"boolean"`

    // 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 Secrets Managersecret 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"`

    // The Azure Active Directory domain of the organization.
    //
    // TenantDomain is a required field
    TenantDomain *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides configuration information for data sources that connect to OneDrive.

func (OneDriveConfiguration) GoString

func (s OneDriveConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveConfiguration) SetDisableLocalGroups

func (s *OneDriveConfiguration) SetDisableLocalGroups(v bool) *OneDriveConfiguration

SetDisableLocalGroups sets the DisableLocalGroups field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveConfiguration) Validate

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveUsers) SetOneDriveUserList

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OneDriveUsers) Validate

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 identifier of the data source the principal should access documents from.
    DataSourceId *string `min:"1" type:"string"`

    // The name of the user or group.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The type of principal.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"PrincipalType"`
    // contains filtered or unexported fields
}

Provides user and group information for document access filtering.

func (Principal) GoString

func (s Principal) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Principal) SetAccess

func (s *Principal) SetAccess(v string) *Principal

SetAccess sets the Access field's value.

func (*Principal) SetDataSourceId

func (s *Principal) SetDataSourceId(v string) *Principal

SetDataSourceId sets the DataSourceId field's value.

func (*Principal) SetName

func (s *Principal) SetName(v string) *Principal

SetName sets the Name field's value.

func (*Principal) SetType

func (s *Principal) SetType(v string) *Principal

SetType sets the Type field's value.

func (Principal) String

func (s Principal) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Principal) Validate

func (s *Principal) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ProxyConfiguration

type ProxyConfiguration struct {

    // Your secret ARN, which you can create in AWS Secrets Manager (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
    //
    // The credentials are optional. You use a secret if web proxy credentials are
    // required to connect to a website host. Amazon Kendra currently support basic
    // authentication to connect to a web proxy server. The secret stores your credentials.
    Credentials *string `min:"1" type:"string"`

    // The name of the website host you want to connect to via a web proxy server.
    //
    // For example, the host name of https://a.example.com/page1.html is "a.example.com".
    //
    // Host is a required field
    Host *string `min:"1" type:"string" required:"true"`

    // The port number of the website host you want to connect to via a web proxy
    // server.
    //
    // For example, the port for https://a.example.com/page1.html is 443, the standard
    // port for HTTPS.
    //
    // Port is a required field
    Port *int64 `min:"1" type:"integer" required:"true"`
    // contains filtered or unexported fields
}

Provides the configuration information for a web proxy to connect to website hosts.

func (ProxyConfiguration) GoString

func (s ProxyConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProxyConfiguration) SetCredentials

func (s *ProxyConfiguration) SetCredentials(v string) *ProxyConfiguration

SetCredentials sets the Credentials field's value.

func (*ProxyConfiguration) SetHost

func (s *ProxyConfiguration) SetHost(v string) *ProxyConfiguration

SetHost sets the Host field's value.

func (*ProxyConfiguration) SetPort

func (s *ProxyConfiguration) SetPort(v int64) *ProxyConfiguration

SetPort sets the Port field's value.

func (ProxyConfiguration) String

func (s ProxyConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProxyConfiguration) Validate

func (s *ProxyConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPrincipalMappingInput

type PutPrincipalMappingInput struct {

    // The identifier of the data source you want to map users to their groups.
    //
    // This is useful if a group is tied to multiple data sources, but you only
    // want the group to access documents of a certain data source. For example,
    // the groups "Research", "Engineering", and "Sales and Marketing" are all tied
    // to the company's documents stored in the data sources Confluence and Salesforce.
    // However, "Sales and Marketing" team only needs access to customer-related
    // documents stored in Salesforce.
    DataSourceId *string `min:"1" type:"string"`

    // The identifier of the group you want to map its users to.
    //
    // GroupId is a required field
    GroupId *string `min:"1" type:"string" required:"true"`

    // The list that contains your users or sub groups that belong the same group.
    //
    // For example, the group "Company" includes the user "CEO" and the sub groups
    // "Research", "Engineering", and "Sales and Marketing".
    //
    // If you have more than 1000 users and/or sub groups for a single group, you
    // need to provide the path to the S3 file that lists your users and sub groups
    // for a group. Your sub groups can contain more than 1000 users, but the list
    // of sub groups that belong to a group (and/or users) must be no more than
    // 1000.
    //
    // GroupMembers is a required field
    GroupMembers *GroupMembers `type:"structure" required:"true"`

    // The identifier of the index you want to map users to their groups.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The timestamp identifier you specify to ensure Amazon Kendra does not override
    // the latest PUT action with previous actions. The highest number ID, which
    // is the ordering ID, is the latest action you want to process and apply on
    // top of other actions with lower number IDs. This prevents previous actions
    // with lower number IDs from possibly overriding the latest action.
    //
    // The ordering ID can be the UNIX time of the last update you made to a group
    // members list. You would then provide this list when calling PutPrincipalMapping.
    // This ensures your PUT action for that updated group with the latest members
    // list doesn't get overwritten by earlier PUT actions for the same group which
    // are yet to be processed.
    //
    // The default ordering ID is the current UNIX time in milliseconds that the
    // action was received by Amazon Kendra.
    OrderingId *int64 `type:"long"`

    // The Amazon Resource Name (ARN) of a role that has access to the S3 file that
    // contains your list of users or sub groups that belong to a group.
    //
    // For more information, see IAM roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
    RoleArn *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (PutPrincipalMappingInput) GoString

func (s PutPrincipalMappingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPrincipalMappingInput) SetDataSourceId

func (s *PutPrincipalMappingInput) SetDataSourceId(v string) *PutPrincipalMappingInput

SetDataSourceId sets the DataSourceId field's value.

func (*PutPrincipalMappingInput) SetGroupId

func (s *PutPrincipalMappingInput) SetGroupId(v string) *PutPrincipalMappingInput

SetGroupId sets the GroupId field's value.

func (*PutPrincipalMappingInput) SetGroupMembers

func (s *PutPrincipalMappingInput) SetGroupMembers(v *GroupMembers) *PutPrincipalMappingInput

SetGroupMembers sets the GroupMembers field's value.

func (*PutPrincipalMappingInput) SetIndexId

func (s *PutPrincipalMappingInput) SetIndexId(v string) *PutPrincipalMappingInput

SetIndexId sets the IndexId field's value.

func (*PutPrincipalMappingInput) SetOrderingId

func (s *PutPrincipalMappingInput) SetOrderingId(v int64) *PutPrincipalMappingInput

SetOrderingId sets the OrderingId field's value.

func (*PutPrincipalMappingInput) SetRoleArn

func (s *PutPrincipalMappingInput) SetRoleArn(v string) *PutPrincipalMappingInput

SetRoleArn sets the RoleArn field's value.

func (PutPrincipalMappingInput) String

func (s PutPrincipalMappingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPrincipalMappingInput) Validate

func (s *PutPrincipalMappingInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPrincipalMappingOutput

type PutPrincipalMappingOutput struct {
    // contains filtered or unexported fields
}

func (PutPrincipalMappingOutput) GoString

func (s PutPrincipalMappingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutPrincipalMappingOutput) String

func (s PutPrincipalMappingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryInput

type QueryInput struct {

    // 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"`

    // Overrides relevance tuning configurations of fields or attributes set at
    // the index level.
    //
    // If you use this API to override the relevance tuning configured at the index
    // level, but there is no relevance tuning configured at the index level, then
    // Amazon Kendra does not apply any relevance tuning.
    //
    // If there is relevance tuning configured at the index level, but you do not
    // use this API to override any relevance tuning in the index, then Amazon Kendra
    // uses the relevance tuning that is configured at the index level.
    //
    // If there is relevance tuning configured for fields at the index level, but
    // you use this API to override only some of these fields, then for the fields
    // you did not override, the importance is set to 1.
    DocumentRelevanceOverrideConfigurations []*DocumentRelevanceConfiguration `type:"list"`

    // An array of documents 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 CreateIndex 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"`

    // The user context token or user and group information.
    UserContext *UserContext `type:"structure"`

    // Provides an identifier for a specific user. The VisitorId should be a unique
    // identifier, such as a GUID. Don't use personally identifiable information,
    // such as the user's email address, as the VisitorId.
    VisitorId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (QueryInput) GoString

func (s QueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryInput) SetAttributeFilter

func (s *QueryInput) SetAttributeFilter(v *AttributeFilter) *QueryInput

SetAttributeFilter sets the AttributeFilter field's value.

func (*QueryInput) SetDocumentRelevanceOverrideConfigurations

func (s *QueryInput) SetDocumentRelevanceOverrideConfigurations(v []*DocumentRelevanceConfiguration) *QueryInput

SetDocumentRelevanceOverrideConfigurations sets the DocumentRelevanceOverrideConfigurations field's value.

func (*QueryInput) SetFacets

func (s *QueryInput) SetFacets(v []*Facet) *QueryInput

SetFacets sets the Facets field's value.

func (*QueryInput) SetIndexId

func (s *QueryInput) SetIndexId(v string) *QueryInput

SetIndexId sets the IndexId field's value.

func (*QueryInput) SetPageNumber

func (s *QueryInput) SetPageNumber(v int64) *QueryInput

SetPageNumber sets the PageNumber field's value.

func (*QueryInput) SetPageSize

func (s *QueryInput) SetPageSize(v int64) *QueryInput

SetPageSize sets the PageSize field's value.

func (*QueryInput) SetQueryResultTypeFilter

func (s *QueryInput) SetQueryResultTypeFilter(v string) *QueryInput

SetQueryResultTypeFilter sets the QueryResultTypeFilter field's value.

func (*QueryInput) SetQueryText

func (s *QueryInput) SetQueryText(v string) *QueryInput

SetQueryText sets the QueryText field's value.

func (*QueryInput) SetRequestedDocumentAttributes

func (s *QueryInput) SetRequestedDocumentAttributes(v []*string) *QueryInput

SetRequestedDocumentAttributes sets the RequestedDocumentAttributes field's value.

func (*QueryInput) SetSortingConfiguration

func (s *QueryInput) SetSortingConfiguration(v *SortingConfiguration) *QueryInput

SetSortingConfiguration sets the SortingConfiguration field's value.

func (*QueryInput) SetUserContext

func (s *QueryInput) SetUserContext(v *UserContext) *QueryInput

SetUserContext sets the UserContext field's value.

func (*QueryInput) SetVisitorId

func (s *QueryInput) SetVisitorId(v string) *QueryInput

SetVisitorId sets the VisitorId field's value.

func (QueryInput) String

func (s QueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryInput) Validate

func (s *QueryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type QueryOutput

type QueryOutput struct {

    // Contains the facet results. A FacetResult contains the counts for each 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryOutput) SetFacetResults

func (s *QueryOutput) SetFacetResults(v []*FacetResult) *QueryOutput

SetFacetResults sets the FacetResults field's value.

func (*QueryOutput) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryResultItem

type QueryResultItem struct {

    // One or more additional 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"`

    // A token that identifies a particular result from a particular query. Use
    // this token to provide click-through feedback for the result. For more information,
    // see Submitting feedback (https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html).
    FeedbackToken *string `min:"1" type:"string"`

    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryResultItem) SetAdditionalAttributes

func (s *QueryResultItem) SetAdditionalAttributes(v []*AdditionalResultAttribute) *QueryResultItem

SetAdditionalAttributes sets the AdditionalAttributes field's value.

func (*QueryResultItem) SetDocumentAttributes

func (s *QueryResultItem) SetDocumentAttributes(v []*DocumentAttribute) *QueryResultItem

SetDocumentAttributes sets the DocumentAttributes field's value.

func (*QueryResultItem) SetDocumentExcerpt

func (s *QueryResultItem) SetDocumentExcerpt(v *TextWithHighlights) *QueryResultItem

SetDocumentExcerpt sets the DocumentExcerpt field's value.

func (*QueryResultItem) SetDocumentId

func (s *QueryResultItem) SetDocumentId(v string) *QueryResultItem

SetDocumentId sets the DocumentId field's value.

func (*QueryResultItem) SetDocumentTitle

func (s *QueryResultItem) SetDocumentTitle(v *TextWithHighlights) *QueryResultItem

SetDocumentTitle sets the DocumentTitle field's value.

func (*QueryResultItem) SetDocumentURI

func (s *QueryResultItem) SetDocumentURI(v string) *QueryResultItem

SetDocumentURI sets the DocumentURI field's value.

func (*QueryResultItem) SetFeedbackToken

func (s *QueryResultItem) SetFeedbackToken(v string) *QueryResultItem

SetFeedbackToken sets the FeedbackToken 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuerySuggestionsBlockListSummary

type QuerySuggestionsBlockListSummary struct {

    // The date-time summary information for a query suggestions block list was
    // last created.
    CreatedAt *time.Time `type:"timestamp"`

    // The identifier of a block list.
    Id *string `min:"36" type:"string"`

    // The number of items in the block list file.
    ItemCount *int64 `type:"integer"`

    // The name of the block list.
    Name *string `min:"1" type:"string"`

    // The status of the block list.
    Status *string `type:"string" enum:"QuerySuggestionsBlockListStatus"`

    // The date-time the block list was last updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Summary information on a query suggestions block list.

This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

func (QuerySuggestionsBlockListSummary) GoString

func (s QuerySuggestionsBlockListSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuerySuggestionsBlockListSummary) SetCreatedAt

func (s *QuerySuggestionsBlockListSummary) SetCreatedAt(v time.Time) *QuerySuggestionsBlockListSummary

SetCreatedAt sets the CreatedAt field's value.

func (*QuerySuggestionsBlockListSummary) SetId

func (s *QuerySuggestionsBlockListSummary) SetId(v string) *QuerySuggestionsBlockListSummary

SetId sets the Id field's value.

func (*QuerySuggestionsBlockListSummary) SetItemCount

func (s *QuerySuggestionsBlockListSummary) SetItemCount(v int64) *QuerySuggestionsBlockListSummary

SetItemCount sets the ItemCount field's value.

func (*QuerySuggestionsBlockListSummary) SetName

func (s *QuerySuggestionsBlockListSummary) SetName(v string) *QuerySuggestionsBlockListSummary

SetName sets the Name field's value.

func (*QuerySuggestionsBlockListSummary) SetStatus

func (s *QuerySuggestionsBlockListSummary) SetStatus(v string) *QuerySuggestionsBlockListSummary

SetStatus sets the Status field's value.

func (*QuerySuggestionsBlockListSummary) SetUpdatedAt

func (s *QuerySuggestionsBlockListSummary) SetUpdatedAt(v time.Time) *QuerySuggestionsBlockListSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (QuerySuggestionsBlockListSummary) String

func (s QuerySuggestionsBlockListSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Relevance) SetDuration

func (s *Relevance) SetDuration(v string) *Relevance

SetDuration sets the Duration field's value.

func (*Relevance) SetFreshness

func (s *Relevance) SetFreshness(v bool) *Relevance

SetFreshness sets the Freshness field's value.

func (*Relevance) SetImportance

func (s *Relevance) SetImportance(v int64) *Relevance

SetImportance sets the Importance field's value.

func (*Relevance) SetRankOrder

func (s *Relevance) SetRankOrder(v string) *Relevance

SetRankOrder sets the RankOrder field's value.

func (*Relevance) SetValueImportanceMap

func (s *Relevance) SetValueImportanceMap(v map[string]*int64) *Relevance

SetValueImportanceMap sets the ValueImportanceMap field's value.

func (Relevance) String

func (s Relevance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Relevance) Validate

func (s *Relevance) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RelevanceFeedback

type RelevanceFeedback struct {

    // Whether 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelevanceFeedback) SetRelevanceValue

func (s *RelevanceFeedback) SetRelevanceValue(v string) *RelevanceFeedback

SetRelevanceValue sets the RelevanceValue field's value.

func (*RelevanceFeedback) SetResultId

func (s *RelevanceFeedback) SetResultId(v string) *RelevanceFeedback

SetResultId sets the ResultId field's value.

func (RelevanceFeedback) String

func (s RelevanceFeedback) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelevanceFeedback) Validate

func (s *RelevanceFeedback) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceAlreadyExistException

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistException) Message

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceUnavailableException

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceUnavailableException) Message

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3DataSourceConfiguration

type S3DataSourceConfiguration struct {

    // Provides the path to the S3 bucket that contains the user context filtering
    // files for the data source. For the format of the file, see Access control
    // for S3 data sources (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html).
    AccessControlListConfiguration *AccessControlListConfiguration `type:"structure"`

    // The name of the bucket that contains the documents.
    //
    // BucketName is a required field
    BucketName *string `min:"3" type:"string" required:"true"`

    // Document metadata files that contain information such as the document access
    // control information, source URI, document author, and custom attributes.
    // Each metadata file contains metadata about a single document.
    DocumentsMetadataConfiguration *DocumentsMetadataConfiguration `type:"structure"`

    // A list of glob patterns 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.
    //
    // Some examples (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters)
    // are:
    //
    //    * *.png , *.jpg will exclude all PNG and JPEG image files in a directory
    //    (files with the extensions .png and .jpg).
    //
    //    * *internal* will exclude all files in a directory that contain 'internal'
    //    in the file name, such as 'internal', 'internal_only', 'company_internal'.
    //
    //    * **/*internal* will exclude all internal-related files in a directory
    //    and its subdirectories.
    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.
    //
    // Some examples (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters)
    // are:
    //
    //    * *.txt will include all text files in a directory (files with the extension
    //    .txt).
    //
    //    * **/*.txt will include all text files in a directory and its subdirectories.
    //
    //    * *tax* will include all files in a directory that contain 'tax' in the
    //    file name, such as 'tax', 'taxes', 'income_tax'.
    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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSourceConfiguration) SetAccessControlListConfiguration

func (s *S3DataSourceConfiguration) SetAccessControlListConfiguration(v *AccessControlListConfiguration) *S3DataSourceConfiguration

SetAccessControlListConfiguration sets the AccessControlListConfiguration field's value.

func (*S3DataSourceConfiguration) SetBucketName

func (s *S3DataSourceConfiguration) SetBucketName(v string) *S3DataSourceConfiguration

SetBucketName sets the BucketName field's value.

func (*S3DataSourceConfiguration) SetDocumentsMetadataConfiguration

func (s *S3DataSourceConfiguration) SetDocumentsMetadataConfiguration(v *DocumentsMetadataConfiguration) *S3DataSourceConfiguration

SetDocumentsMetadataConfiguration sets the DocumentsMetadataConfiguration field's value.

func (*S3DataSourceConfiguration) SetExclusionPatterns

func (s *S3DataSourceConfiguration) SetExclusionPatterns(v []*string) *S3DataSourceConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*S3DataSourceConfiguration) SetInclusionPatterns

func (s *S3DataSourceConfiguration) SetInclusionPatterns(v []*string) *S3DataSourceConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*S3DataSourceConfiguration) SetInclusionPrefixes

func (s *S3DataSourceConfiguration) SetInclusionPrefixes(v []*string) *S3DataSourceConfiguration

SetInclusionPrefixes sets the InclusionPrefixes field's value.

func (S3DataSourceConfiguration) String

func (s S3DataSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSourceConfiguration) Validate

func (s *S3DataSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Path

type S3Path struct {

    // The name of the S3 bucket that contains the file.
    //
    // Bucket is a required field
    Bucket *string `min:"3" type:"string" required:"true"`

    // The name of the file.
    //
    // Key is a required field
    Key *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Information required to find a specific file in an Amazon S3 bucket.

func (S3Path) GoString

func (s S3Path) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Path) SetBucket

func (s *S3Path) SetBucket(v string) *S3Path

SetBucket sets the Bucket field's value.

func (*S3Path) SetKey

func (s *S3Path) SetKey(v string) *S3Path

SetKey sets the Key field's value.

func (S3Path) String

func (s S3Path) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Path) Validate

func (s *S3Path) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type 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 column.
    DocumentTitleFieldName *string `min:"1" type:"string"`

    // Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // Filters the documents in the feed based on status of the user. When you specify
    // ACTIVE_USERS only documents from users who have an active account are indexed.
    // When you specify STANDARD_USER only documents for Salesforce standard users
    // are documented. You can specify both.
    IncludeFilterTypes []*string `min:"1" type:"list"`
    // 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceChatterFeedConfiguration) SetDocumentDataFieldName

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceChatterFeedConfiguration) Validate

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 knowledge article types that
    // Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles
    // and the standard fields of knowledge articles, or the custom fields of custom
    // knowledge articles, but not both.
    KnowledgeArticleConfiguration *SalesforceKnowledgeArticleConfiguration `type:"structure"`

    // The Amazon Resource Name (ARN) of an Secrets Managersecret that contains
    // the key/value pairs required to connect to your Salesforce instance. The
    // secret must contain a JSON structure with the following keys:
    //
    //    * authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to
    //    get an OAUTH token.
    //
    //    * consumerKey - The application public key generated when you created
    //    your Salesforce application.
    //
    //    * consumerSecret - The application private key generated when you created
    //    your Salesforce application.
    //
    //    * password - The password associated with the user logging in to the Salesforce
    //    instance.
    //
    //    * securityToken - The token associated with the user 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceConfiguration) SetChatterFeedConfiguration

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceConfiguration) Validate

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) SetDocumentDataFieldName

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SalesforceCustomKnowledgeArticleTypeConfiguration) Validate

func (s *SalesforceCustomKnowledgeArticleTypeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they