...
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) AssociateEntitiesToExperience(input *AssociateEntitiesToExperienceInput) (*AssociateEntitiesToExperienceOutput, error)
func (c *Kendra) AssociateEntitiesToExperienceRequest(input *AssociateEntitiesToExperienceInput) (req *request.Request, output *AssociateEntitiesToExperienceOutput)
func (c *Kendra) AssociateEntitiesToExperienceWithContext(ctx aws.Context, input *AssociateEntitiesToExperienceInput, opts ...request.Option) (*AssociateEntitiesToExperienceOutput, error)
func (c *Kendra) AssociatePersonasToEntities(input *AssociatePersonasToEntitiesInput) (*AssociatePersonasToEntitiesOutput, error)
func (c *Kendra) AssociatePersonasToEntitiesRequest(input *AssociatePersonasToEntitiesInput) (req *request.Request, output *AssociatePersonasToEntitiesOutput)
func (c *Kendra) AssociatePersonasToEntitiesWithContext(ctx aws.Context, input *AssociatePersonasToEntitiesInput, opts ...request.Option) (*AssociatePersonasToEntitiesOutput, error)
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) CreateAccessControlConfiguration(input *CreateAccessControlConfigurationInput) (*CreateAccessControlConfigurationOutput, error)
func (c *Kendra) CreateAccessControlConfigurationRequest(input *CreateAccessControlConfigurationInput) (req *request.Request, output *CreateAccessControlConfigurationOutput)
func (c *Kendra) CreateAccessControlConfigurationWithContext(ctx aws.Context, input *CreateAccessControlConfigurationInput, opts ...request.Option) (*CreateAccessControlConfigurationOutput, 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) CreateExperience(input *CreateExperienceInput) (*CreateExperienceOutput, error)
func (c *Kendra) CreateExperienceRequest(input *CreateExperienceInput) (req *request.Request, output *CreateExperienceOutput)
func (c *Kendra) CreateExperienceWithContext(ctx aws.Context, input *CreateExperienceInput, opts ...request.Option) (*CreateExperienceOutput, 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) DeleteAccessControlConfiguration(input *DeleteAccessControlConfigurationInput) (*DeleteAccessControlConfigurationOutput, error)
func (c *Kendra) DeleteAccessControlConfigurationRequest(input *DeleteAccessControlConfigurationInput) (req *request.Request, output *DeleteAccessControlConfigurationOutput)
func (c *Kendra) DeleteAccessControlConfigurationWithContext(ctx aws.Context, input *DeleteAccessControlConfigurationInput, opts ...request.Option) (*DeleteAccessControlConfigurationOutput, 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) DeleteExperience(input *DeleteExperienceInput) (*DeleteExperienceOutput, error)
func (c *Kendra) DeleteExperienceRequest(input *DeleteExperienceInput) (req *request.Request, output *DeleteExperienceOutput)
func (c *Kendra) DeleteExperienceWithContext(ctx aws.Context, input *DeleteExperienceInput, opts ...request.Option) (*DeleteExperienceOutput, 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) DescribeAccessControlConfiguration(input *DescribeAccessControlConfigurationInput) (*DescribeAccessControlConfigurationOutput, error)
func (c *Kendra) DescribeAccessControlConfigurationRequest(input *DescribeAccessControlConfigurationInput) (req *request.Request, output *DescribeAccessControlConfigurationOutput)
func (c *Kendra) DescribeAccessControlConfigurationWithContext(ctx aws.Context, input *DescribeAccessControlConfigurationInput, opts ...request.Option) (*DescribeAccessControlConfigurationOutput, 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) DescribeExperience(input *DescribeExperienceInput) (*DescribeExperienceOutput, error)
func (c *Kendra) DescribeExperienceRequest(input *DescribeExperienceInput) (req *request.Request, output *DescribeExperienceOutput)
func (c *Kendra) DescribeExperienceWithContext(ctx aws.Context, input *DescribeExperienceInput, opts ...request.Option) (*DescribeExperienceOutput, 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) DisassociateEntitiesFromExperience(input *DisassociateEntitiesFromExperienceInput) (*DisassociateEntitiesFromExperienceOutput, error)
func (c *Kendra) DisassociateEntitiesFromExperienceRequest(input *DisassociateEntitiesFromExperienceInput) (req *request.Request, output *DisassociateEntitiesFromExperienceOutput)
func (c *Kendra) DisassociateEntitiesFromExperienceWithContext(ctx aws.Context, input *DisassociateEntitiesFromExperienceInput, opts ...request.Option) (*DisassociateEntitiesFromExperienceOutput, error)
func (c *Kendra) DisassociatePersonasFromEntities(input *DisassociatePersonasFromEntitiesInput) (*DisassociatePersonasFromEntitiesOutput, error)
func (c *Kendra) DisassociatePersonasFromEntitiesRequest(input *DisassociatePersonasFromEntitiesInput) (req *request.Request, output *DisassociatePersonasFromEntitiesOutput)
func (c *Kendra) DisassociatePersonasFromEntitiesWithContext(ctx aws.Context, input *DisassociatePersonasFromEntitiesInput, opts ...request.Option) (*DisassociatePersonasFromEntitiesOutput, 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) GetSnapshots(input *GetSnapshotsInput) (*GetSnapshotsOutput, error)
func (c *Kendra) GetSnapshotsPages(input *GetSnapshotsInput, fn func(*GetSnapshotsOutput, bool) bool) error
func (c *Kendra) GetSnapshotsPagesWithContext(ctx aws.Context, input *GetSnapshotsInput, fn func(*GetSnapshotsOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) GetSnapshotsRequest(input *GetSnapshotsInput) (req *request.Request, output *GetSnapshotsOutput)
func (c *Kendra) GetSnapshotsWithContext(ctx aws.Context, input *GetSnapshotsInput, opts ...request.Option) (*GetSnapshotsOutput, error)
func (c *Kendra) ListAccessControlConfigurations(input *ListAccessControlConfigurationsInput) (*ListAccessControlConfigurationsOutput, error)
func (c *Kendra) ListAccessControlConfigurationsPages(input *ListAccessControlConfigurationsInput, fn func(*ListAccessControlConfigurationsOutput, bool) bool) error
func (c *Kendra) ListAccessControlConfigurationsPagesWithContext(ctx aws.Context, input *ListAccessControlConfigurationsInput, fn func(*ListAccessControlConfigurationsOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) ListAccessControlConfigurationsRequest(input *ListAccessControlConfigurationsInput) (req *request.Request, output *ListAccessControlConfigurationsOutput)
func (c *Kendra) ListAccessControlConfigurationsWithContext(ctx aws.Context, input *ListAccessControlConfigurationsInput, opts ...request.Option) (*ListAccessControlConfigurationsOutput, 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) ListEntityPersonas(input *ListEntityPersonasInput) (*ListEntityPersonasOutput, error)
func (c *Kendra) ListEntityPersonasPages(input *ListEntityPersonasInput, fn func(*ListEntityPersonasOutput, bool) bool) error
func (c *Kendra) ListEntityPersonasPagesWithContext(ctx aws.Context, input *ListEntityPersonasInput, fn func(*ListEntityPersonasOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) ListEntityPersonasRequest(input *ListEntityPersonasInput) (req *request.Request, output *ListEntityPersonasOutput)
func (c *Kendra) ListEntityPersonasWithContext(ctx aws.Context, input *ListEntityPersonasInput, opts ...request.Option) (*ListEntityPersonasOutput, error)
func (c *Kendra) ListExperienceEntities(input *ListExperienceEntitiesInput) (*ListExperienceEntitiesOutput, error)
func (c *Kendra) ListExperienceEntitiesPages(input *ListExperienceEntitiesInput, fn func(*ListExperienceEntitiesOutput, bool) bool) error
func (c *Kendra) ListExperienceEntitiesPagesWithContext(ctx aws.Context, input *ListExperienceEntitiesInput, fn func(*ListExperienceEntitiesOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) ListExperienceEntitiesRequest(input *ListExperienceEntitiesInput) (req *request.Request, output *ListExperienceEntitiesOutput)
func (c *Kendra) ListExperienceEntitiesWithContext(ctx aws.Context, input *ListExperienceEntitiesInput, opts ...request.Option) (*ListExperienceEntitiesOutput, error)
func (c *Kendra) ListExperiences(input *ListExperiencesInput) (*ListExperiencesOutput, error)
func (c *Kendra) ListExperiencesPages(input *ListExperiencesInput, fn func(*ListExperiencesOutput, bool) bool) error
func (c *Kendra) ListExperiencesPagesWithContext(ctx aws.Context, input *ListExperiencesInput, fn func(*ListExperiencesOutput, bool) bool, opts ...request.Option) error
func (c *Kendra) ListExperiencesRequest(input *ListExperiencesInput) (req *request.Request, output *ListExperiencesOutput)
func (c *Kendra) ListExperiencesWithContext(ctx aws.Context, input *ListExperiencesInput, opts ...request.Option) (*ListExperiencesOutput, error)
func (c *Kendra) ListFaqs(input *ListFaqsInput) (*ListFaqsOutput, error)
func (c *Kendra) ListFaqsPages(input *ListFaqsInput, fn func(*ListFaqsOutput, bool) bool) error
func (c *Kendra) ListFaqsPagesWithContext(ctx aws.Context, input *ListFaqsInput, fn func(*ListFaqsOutput, bool) bool, opts ...request.Option) 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) ListGroupsOlderThanOrderingIdPages(input *ListGroupsOlderThanOrderingIdInput, fn func(*ListGroupsOlderThanOrderingIdOutput, bool) bool) error
func (c *Kendra) ListGroupsOlderThanOrderingIdPagesWithContext(ctx aws.Context, input *ListGroupsOlderThanOrderingIdInput, fn func(*ListGroupsOlderThanOrderingIdOutput, bool) bool, opts ...request.Option) 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) ListQuerySuggestionsBlockListsPages(input *ListQuerySuggestionsBlockListsInput, fn func(*ListQuerySuggestionsBlockListsOutput, bool) bool) error
func (c *Kendra) ListQuerySuggestionsBlockListsPagesWithContext(ctx aws.Context, input *ListQuerySuggestionsBlockListsInput, fn func(*ListQuerySuggestionsBlockListsOutput, bool) bool, opts ...request.Option) 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) ListThesauriPages(input *ListThesauriInput, fn func(*ListThesauriOutput, bool) bool) error
func (c *Kendra) ListThesauriPagesWithContext(ctx aws.Context, input *ListThesauriInput, fn func(*ListThesauriOutput, bool) bool, opts ...request.Option) 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) UpdateAccessControlConfiguration(input *UpdateAccessControlConfigurationInput) (*UpdateAccessControlConfigurationOutput, error)
func (c *Kendra) UpdateAccessControlConfigurationRequest(input *UpdateAccessControlConfigurationInput) (req *request.Request, output *UpdateAccessControlConfigurationOutput)
func (c *Kendra) UpdateAccessControlConfigurationWithContext(ctx aws.Context, input *UpdateAccessControlConfigurationInput, opts ...request.Option) (*UpdateAccessControlConfigurationOutput, 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) UpdateExperience(input *UpdateExperienceInput) (*UpdateExperienceOutput, error)
func (c *Kendra) UpdateExperienceRequest(input *UpdateExperienceInput) (req *request.Request, output *UpdateExperienceOutput)
func (c *Kendra) UpdateExperienceWithContext(ctx aws.Context, input *UpdateExperienceInput, opts ...request.Option) (*UpdateExperienceOutput, 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 AlfrescoEntity_Values() []string
func ConditionOperator_Values() []string
func ConfluenceAttachmentFieldName_Values() []string
func ConfluenceAuthenticationType_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 EndpointType_Values() []string
func EntityType_Values() []string
func ErrorCode_Values() []string
func ExperienceStatus_Values() []string
func FaqFileFormat_Values() []string
func FaqStatus_Values() []string
func FsxFileSystemType_Values() []string
func HighlightType_Values() []string
func IndexEdition_Values() []string
func IndexStatus_Values() []string
func Interval_Values() []string
func IssueSubEntity_Values() []string
func KeyLocation_Values() []string
func MetricType_Values() []string
func Mode_Values() []string
func Order_Values() []string
func Persona_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 SharePointOnlineAuthenticationType_Values() []string
func SharePointVersion_Values() []string
func SlackEntity_Values() []string
func SortOrder_Values() []string
func ThesaurusStatus_Values() []string
func Type_Values() []string
func UserContextPolicy_Values() []string
func UserGroupResolutionMode_Values() []string
func WarningCode_Values() []string
func WebCrawlerMode_Values() []string
type AccessControlConfigurationSummary
type AccessControlListConfiguration
type AccessDeniedException
type AclConfiguration
type AdditionalResultAttribute
type AdditionalResultAttributeValue
type AlfrescoConfiguration
type AssociateEntitiesToExperienceInput
type AssociateEntitiesToExperienceOutput
type AssociatePersonasToEntitiesInput
type AssociatePersonasToEntitiesOutput
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 BoxConfiguration
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 ContentSourceConfiguration
type Correction
type CreateAccessControlConfigurationInput
type CreateAccessControlConfigurationOutput
type CreateDataSourceInput
type CreateDataSourceOutput
type CreateExperienceInput
type CreateExperienceOutput
type CreateFaqInput
type CreateFaqOutput
type CreateIndexInput
type CreateIndexOutput
type CreateQuerySuggestionsBlockListInput
type CreateQuerySuggestionsBlockListOutput
type CreateThesaurusInput
type CreateThesaurusOutput
type CustomDocumentEnrichmentConfiguration
type DataSourceConfiguration
type DataSourceGroup
type DataSourceSummary
type DataSourceSyncJob
type DataSourceSyncJobMetricTarget
type DataSourceSyncJobMetrics
type DataSourceToIndexFieldMapping
type DataSourceVpcConfiguration
type DatabaseConfiguration
type DeleteAccessControlConfigurationInput
type DeleteAccessControlConfigurationOutput
type DeleteDataSourceInput
type DeleteDataSourceOutput
type DeleteExperienceInput
type DeleteExperienceOutput
type DeleteFaqInput
type DeleteFaqOutput
type DeleteIndexInput
type DeleteIndexOutput
type DeletePrincipalMappingInput
type DeletePrincipalMappingOutput
type DeleteQuerySuggestionsBlockListInput
type DeleteQuerySuggestionsBlockListOutput
type DeleteThesaurusInput
type DeleteThesaurusOutput
type DescribeAccessControlConfigurationInput
type DescribeAccessControlConfigurationOutput
type DescribeDataSourceInput
type DescribeDataSourceOutput
type DescribeExperienceInput
type DescribeExperienceOutput
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 DisassociateEntitiesFromExperienceInput
type DisassociateEntitiesFromExperienceOutput
type DisassociatePersonasFromEntitiesInput
type DisassociatePersonasFromEntitiesOutput
type Document
type DocumentAttribute
type DocumentAttributeCondition
type DocumentAttributeTarget
type DocumentAttributeValue
type DocumentAttributeValueCountPair
type DocumentInfo
type DocumentMetadataConfiguration
type DocumentRelevanceConfiguration
type DocumentsMetadataConfiguration
type EntityConfiguration
type EntityDisplayData
type EntityPersonaConfiguration
type ExperienceConfiguration
type ExperienceEndpoint
type ExperienceEntitiesSummary
type ExperiencesSummary
type Facet
type FacetResult
type FailedEntity
type FaqStatistics
type FaqSummary
type FsxConfiguration
type GetQuerySuggestionsInput
type GetQuerySuggestionsOutput
type GetSnapshotsInput
type GetSnapshotsOutput
type GitHubConfiguration
type GitHubDocumentCrawlProperties
type GoogleDriveConfiguration
type GroupMembers
type GroupOrderingIdSummary
type GroupSummary
type HierarchicalPrincipal
type Highlight
type HookConfiguration
type IndexConfigurationSummary
type IndexStatistics
type InlineCustomDocumentEnrichmentConfiguration
type InternalServerException
type InvalidRequestException
type JiraConfiguration
type JsonTokenTypeConfiguration
type JwtTokenTypeConfiguration
type ListAccessControlConfigurationsInput
type ListAccessControlConfigurationsOutput
type ListDataSourceSyncJobsInput
type ListDataSourceSyncJobsOutput
type ListDataSourcesInput
type ListDataSourcesOutput
type ListEntityPersonasInput
type ListEntityPersonasOutput
type ListExperienceEntitiesInput
type ListExperienceEntitiesOutput
type ListExperiencesInput
type ListExperiencesOutput
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 OnPremiseConfiguration
type OneDriveConfiguration
type OneDriveUsers
type PersonasSummary
type Principal
type ProxyConfiguration
type PutPrincipalMappingInput
type PutPrincipalMappingOutput
type QueryInput
type QueryOutput
type QueryResultItem
type QuerySuggestionsBlockListSummary
type QuipConfiguration
type Relevance
type RelevanceFeedback
type ResourceAlreadyExistException
type ResourceInUseException
type ResourceNotFoundException
type ResourceUnavailableException
type S3DataSourceConfiguration
type S3Path
type SaaSConfiguration
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 SlackConfiguration
type SortingConfiguration
type SpellCorrectedQuery
type SpellCorrectionConfiguration
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 TemplateConfiguration
type TextDocumentStatistics
type TextWithHighlights
type ThesaurusSummary
type ThrottlingException
type TimeRange
type UntagResourceInput
type UntagResourceOutput
type UpdateAccessControlConfigurationInput
type UpdateAccessControlConfigurationOutput
type UpdateDataSourceInput
type UpdateDataSourceOutput
type UpdateExperienceInput
type UpdateExperienceOutput
type UpdateIndexInput
type UpdateIndexOutput
type UpdateQuerySuggestionsBlockListInput
type UpdateQuerySuggestionsBlockListOutput
type UpdateQuerySuggestionsConfigInput
type UpdateQuerySuggestionsConfigOutput
type UpdateThesaurusInput
type UpdateThesaurusOutput
type Urls
type UserContext
type UserGroupResolutionConfiguration
type UserIdentityConfiguration
type UserTokenConfiguration
type ValidationException
type Warning
type WebCrawlerConfiguration
type WorkDocsConfiguration

Constants ▾

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

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

    // AlfrescoEntityDocumentLibrary is a AlfrescoEntity enum value
    AlfrescoEntityDocumentLibrary = "documentLibrary"
)
const (
    // ConditionOperatorGreaterThan is a ConditionOperator enum value
    ConditionOperatorGreaterThan = "GreaterThan"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // MetricTypeTrendQueryDocMetrics is a MetricType enum value
    MetricTypeTrendQueryDocMetrics = "TREND_QUERY_DOC_METRICS"
)
const (
    // ModeEnabled is a Mode enum value
    ModeEnabled = "ENABLED"

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

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

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

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

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

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

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

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

    // QueryIdentifiersEnclosingOptionNone is a QueryIdentifiersEnclosingOption enum value
    QueryIdentifiersEnclosingOptionNone = "NONE"
)
const (
    // 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 (
    // SharePointOnlineAuthenticationTypeHttpBasic is a SharePointOnlineAuthenticationType enum value
    SharePointOnlineAuthenticationTypeHttpBasic = "HTTP_BASIC"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // ErrCodeInvalidRequestException for service response error code
    // "InvalidRequestException".
    //
    // The input to the request is not valid.
    ErrCodeInvalidRequestException = "InvalidRequestException"

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

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

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

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

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

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

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "kendra"    // Name of service.
    EndpointsID = ServiceName // ID to lookup a service endpoint with.
    ServiceID   = "kendra"    // ServiceID is a unique identifier of a specific service.
)

Service information constants

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

func AdditionalResultAttributeValueType_Values

func AdditionalResultAttributeValueType_Values() []string

AdditionalResultAttributeValueType_Values returns all elements of the AdditionalResultAttributeValueType enum

func AlfrescoEntity_Values

func AlfrescoEntity_Values() []string

AlfrescoEntity_Values returns all elements of the AlfrescoEntity enum

func ConditionOperator_Values

func ConditionOperator_Values() []string

ConditionOperator_Values returns all elements of the ConditionOperator enum

func ConfluenceAttachmentFieldName_Values

func ConfluenceAttachmentFieldName_Values() []string

ConfluenceAttachmentFieldName_Values returns all elements of the ConfluenceAttachmentFieldName enum

func ConfluenceAuthenticationType_Values

func ConfluenceAuthenticationType_Values() []string

ConfluenceAuthenticationType_Values returns all elements of the ConfluenceAuthenticationType enum

func ConfluenceBlogFieldName_Values

func ConfluenceBlogFieldName_Values() []string

ConfluenceBlogFieldName_Values returns all elements of the ConfluenceBlogFieldName enum

func ConfluencePageFieldName_Values

func ConfluencePageFieldName_Values() []string

ConfluencePageFieldName_Values returns all elements of the ConfluencePageFieldName enum

func ConfluenceSpaceFieldName_Values

func ConfluenceSpaceFieldName_Values() []string

ConfluenceSpaceFieldName_Values returns all elements of the ConfluenceSpaceFieldName enum

func ConfluenceVersion_Values

func ConfluenceVersion_Values() []string

ConfluenceVersion_Values returns all elements of the ConfluenceVersion enum

func ContentType_Values

func ContentType_Values() []string

ContentType_Values returns all elements of the ContentType enum

func DataSourceStatus_Values

func DataSourceStatus_Values() []string

DataSourceStatus_Values returns all elements of the DataSourceStatus enum

func DataSourceSyncJobStatus_Values

func DataSourceSyncJobStatus_Values() []string

DataSourceSyncJobStatus_Values returns all elements of the DataSourceSyncJobStatus enum

func DataSourceType_Values

func DataSourceType_Values() []string

DataSourceType_Values returns all elements of the DataSourceType enum

func DatabaseEngineType_Values

func DatabaseEngineType_Values() []string

DatabaseEngineType_Values returns all elements of the DatabaseEngineType enum

func DocumentAttributeValueType_Values

func DocumentAttributeValueType_Values() []string

DocumentAttributeValueType_Values returns all elements of the DocumentAttributeValueType enum

func DocumentStatus_Values

func DocumentStatus_Values() []string

DocumentStatus_Values returns all elements of the DocumentStatus enum

func EndpointType_Values

func EndpointType_Values() []string

EndpointType_Values returns all elements of the EndpointType enum

func EntityType_Values

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func ErrorCode_Values

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func ExperienceStatus_Values

func ExperienceStatus_Values() []string

ExperienceStatus_Values returns all elements of the ExperienceStatus enum

func FaqFileFormat_Values

func FaqFileFormat_Values() []string

FaqFileFormat_Values returns all elements of the FaqFileFormat enum

func FaqStatus_Values

func FaqStatus_Values() []string

FaqStatus_Values returns all elements of the FaqStatus enum

func FsxFileSystemType_Values

func FsxFileSystemType_Values() []string

FsxFileSystemType_Values returns all elements of the FsxFileSystemType enum

func HighlightType_Values

func HighlightType_Values() []string

HighlightType_Values returns all elements of the HighlightType enum

func IndexEdition_Values

func IndexEdition_Values() []string

IndexEdition_Values returns all elements of the IndexEdition enum

func IndexStatus_Values

func IndexStatus_Values() []string

IndexStatus_Values returns all elements of the IndexStatus enum

func Interval_Values

func Interval_Values() []string

Interval_Values returns all elements of the Interval enum

func IssueSubEntity_Values

func IssueSubEntity_Values() []string

IssueSubEntity_Values returns all elements of the IssueSubEntity enum

func KeyLocation_Values

func KeyLocation_Values() []string

KeyLocation_Values returns all elements of the KeyLocation enum

func MetricType_Values

func MetricType_Values() []string

MetricType_Values returns all elements of the MetricType enum

func Mode_Values

func Mode_Values() []string

Mode_Values returns all elements of the Mode enum

func Order_Values

func Order_Values() []string

Order_Values returns all elements of the Order enum

func Persona_Values

func Persona_Values() []string

Persona_Values returns all elements of the Persona enum

func PrincipalMappingStatus_Values

func PrincipalMappingStatus_Values() []string

PrincipalMappingStatus_Values returns all elements of the PrincipalMappingStatus enum

func PrincipalType_Values

func PrincipalType_Values() []string

PrincipalType_Values returns all elements of the PrincipalType enum

func QueryIdentifiersEnclosingOption_Values

func QueryIdentifiersEnclosingOption_Values() []string

QueryIdentifiersEnclosingOption_Values returns all elements of the QueryIdentifiersEnclosingOption enum

func QueryResultType_Values

func QueryResultType_Values() []string

QueryResultType_Values returns all elements of the QueryResultType enum

func QuerySuggestionsBlockListStatus_Values

func QuerySuggestionsBlockListStatus_Values() []string

QuerySuggestionsBlockListStatus_Values returns all elements of the QuerySuggestionsBlockListStatus enum

func QuerySuggestionsStatus_Values

func QuerySuggestionsStatus_Values() []string

QuerySuggestionsStatus_Values returns all elements of the QuerySuggestionsStatus enum

func ReadAccessType_Values

func ReadAccessType_Values() []string

ReadAccessType_Values returns all elements of the ReadAccessType enum

func RelevanceType_Values

func RelevanceType_Values() []string

RelevanceType_Values returns all elements of the RelevanceType enum

func SalesforceChatterFeedIncludeFilterType_Values

func SalesforceChatterFeedIncludeFilterType_Values() []string

SalesforceChatterFeedIncludeFilterType_Values returns all elements of the SalesforceChatterFeedIncludeFilterType enum

func SalesforceKnowledgeArticleState_Values

func SalesforceKnowledgeArticleState_Values() []string

SalesforceKnowledgeArticleState_Values returns all elements of the SalesforceKnowledgeArticleState enum

func SalesforceStandardObjectName_Values

func SalesforceStandardObjectName_Values() []string

SalesforceStandardObjectName_Values returns all elements of the SalesforceStandardObjectName enum

func ScoreConfidence_Values

func ScoreConfidence_Values() []string

ScoreConfidence_Values returns all elements of the ScoreConfidence enum

func ServiceNowAuthenticationType_Values

func ServiceNowAuthenticationType_Values() []string

ServiceNowAuthenticationType_Values returns all elements of the ServiceNowAuthenticationType enum

func ServiceNowBuildVersionType_Values

func ServiceNowBuildVersionType_Values() []string

ServiceNowBuildVersionType_Values returns all elements of the ServiceNowBuildVersionType enum

func SharePointOnlineAuthenticationType_Values

func SharePointOnlineAuthenticationType_Values() []string

SharePointOnlineAuthenticationType_Values returns all elements of the SharePointOnlineAuthenticationType enum

func SharePointVersion_Values

func SharePointVersion_Values() []string

SharePointVersion_Values returns all elements of the SharePointVersion enum

func SlackEntity_Values

func SlackEntity_Values() []string

SlackEntity_Values returns all elements of the SlackEntity enum

func SortOrder_Values

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func ThesaurusStatus_Values

func ThesaurusStatus_Values() []string

ThesaurusStatus_Values returns all elements of the ThesaurusStatus enum

func Type_Values

func Type_Values() []string

Type_Values returns all elements of the Type enum

func UserContextPolicy_Values

func UserContextPolicy_Values() []string

UserContextPolicy_Values returns all elements of the UserContextPolicy enum

func UserGroupResolutionMode_Values

func UserGroupResolutionMode_Values() []string

UserGroupResolutionMode_Values returns all elements of the UserGroupResolutionMode enum

func WarningCode_Values

func WarningCode_Values() []string

WarningCode_Values returns all elements of the WarningCode enum

func WebCrawlerMode_Values

func WebCrawlerMode_Values() []string

WebCrawlerMode_Values returns all elements of the WebCrawlerMode enum

type AccessControlConfigurationSummary

type AccessControlConfigurationSummary struct {

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

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

func (AccessControlConfigurationSummary) GoString

func (s AccessControlConfigurationSummary) GoString() string

GoString returns the string representation.

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

func (*AccessControlConfigurationSummary) SetId

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

SetId sets the Id field's value.

func (AccessControlConfigurationSummary) String

func (s AccessControlConfigurationSummary) String() string

String returns the string representation.

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

type AccessControlListConfiguration

type AccessControlListConfiguration struct {

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

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

func (AccessControlListConfiguration) GoString

func (s AccessControlListConfiguration) GoString() string

GoString returns the string representation.

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

func (*AccessControlListConfiguration) SetKeyPath

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

SetKeyPath sets the KeyPath field's value.

func (AccessControlListConfiguration) String

func (s AccessControlListConfiguration) String() string

String returns the string representation.

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

func (*AccessControlListConfiguration) Validate

func (s *AccessControlListConfiguration) Validate() error

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

type AccessDeniedException

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

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

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

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

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

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

type AclConfiguration

type AclConfiguration struct {

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

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

func (AclConfiguration) GoString

func (s AclConfiguration) GoString() string

GoString returns the string representation.

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

func (*AclConfiguration) SetAllowedGroupsColumnName

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

SetAllowedGroupsColumnName sets the AllowedGroupsColumnName field's value.

func (AclConfiguration) String

func (s AclConfiguration) String() string

String returns the string representation.

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

func (*AclConfiguration) Validate

func (s *AclConfiguration) Validate() error

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

type AdditionalResultAttribute

type AdditionalResultAttribute struct {

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

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

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

An attribute returned from an index query.

func (AdditionalResultAttribute) GoString

func (s AdditionalResultAttribute) GoString() string

GoString returns the string representation.

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

func (*AdditionalResultAttribute) SetKey

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

SetKey sets the Key field's value.

func (*AdditionalResultAttribute) SetValue

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

SetValue sets the Value field's value.

func (*AdditionalResultAttribute) SetValueType

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

SetValueType sets the ValueType field's value.

func (AdditionalResultAttribute) String

func (s AdditionalResultAttribute) String() string

String returns the string representation.

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

type AdditionalResultAttributeValue

type AdditionalResultAttributeValue struct {

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

An attribute returned with a document from a search.

func (AdditionalResultAttributeValue) GoString

func (s AdditionalResultAttributeValue) GoString() string

GoString returns the string representation.

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

func (*AdditionalResultAttributeValue) SetTextWithHighlightsValue

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

SetTextWithHighlightsValue sets the TextWithHighlightsValue field's value.

func (AdditionalResultAttributeValue) String

func (s AdditionalResultAttributeValue) String() string

String returns the string representation.

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

type AlfrescoConfiguration

type AlfrescoConfiguration struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (AlfrescoConfiguration) GoString

func (s AlfrescoConfiguration) GoString() string

GoString returns the string representation.

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

func (*AlfrescoConfiguration) SetBlogFieldMappings

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

SetBlogFieldMappings sets the BlogFieldMappings field's value.

func (*AlfrescoConfiguration) SetCrawlComments

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

SetCrawlComments sets the CrawlComments field's value.

func (*AlfrescoConfiguration) SetCrawlSystemFolders

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

SetCrawlSystemFolders sets the CrawlSystemFolders field's value.

func (*AlfrescoConfiguration) SetDocumentLibraryFieldMappings

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

SetDocumentLibraryFieldMappings sets the DocumentLibraryFieldMappings field's value.

func (*AlfrescoConfiguration) SetEntityFilter

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

SetEntityFilter sets the EntityFilter field's value.

func (*AlfrescoConfiguration) SetExclusionPatterns

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*AlfrescoConfiguration) SetInclusionPatterns

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*AlfrescoConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*AlfrescoConfiguration) SetSiteId

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

SetSiteId sets the SiteId field's value.

func (*AlfrescoConfiguration) SetSiteUrl

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

SetSiteUrl sets the SiteUrl field's value.

func (*AlfrescoConfiguration) SetSslCertificateS3Path

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

SetSslCertificateS3Path sets the SslCertificateS3Path field's value.

func (*AlfrescoConfiguration) SetVpcConfiguration

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*AlfrescoConfiguration) SetWikiFieldMappings

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

SetWikiFieldMappings sets the WikiFieldMappings field's value.

func (AlfrescoConfiguration) String

func (s AlfrescoConfiguration) String() string

String returns the string representation.

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

func (*AlfrescoConfiguration) Validate

func (s *AlfrescoConfiguration) Validate() error

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

type AssociateEntitiesToExperienceInput

type AssociateEntitiesToExperienceInput struct {

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

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

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

func (AssociateEntitiesToExperienceInput) GoString

func (s AssociateEntitiesToExperienceInput) GoString() string

GoString returns the string representation.

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

func (*AssociateEntitiesToExperienceInput) SetEntityList

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

SetEntityList sets the EntityList field's value.

func (*AssociateEntitiesToExperienceInput) SetId

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

SetId sets the Id field's value.

func (*AssociateEntitiesToExperienceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (AssociateEntitiesToExperienceInput) String

func (s AssociateEntitiesToExperienceInput) String() string

String returns the string representation.

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

func (*AssociateEntitiesToExperienceInput) Validate

func (s *AssociateEntitiesToExperienceInput) Validate() error

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

type AssociateEntitiesToExperienceOutput

type AssociateEntitiesToExperienceOutput struct {

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

func (AssociateEntitiesToExperienceOutput) GoString

func (s AssociateEntitiesToExperienceOutput) GoString() string

GoString returns the string representation.

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

func (*AssociateEntitiesToExperienceOutput) SetFailedEntityList

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

SetFailedEntityList sets the FailedEntityList field's value.

func (AssociateEntitiesToExperienceOutput) String

func (s AssociateEntitiesToExperienceOutput) String() string

String returns the string representation.

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

type AssociatePersonasToEntitiesInput

type AssociatePersonasToEntitiesInput struct {

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

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

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

func (AssociatePersonasToEntitiesInput) GoString

func (s AssociatePersonasToEntitiesInput) GoString() string

GoString returns the string representation.

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

func (*AssociatePersonasToEntitiesInput) SetId

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

SetId sets the Id field's value.

func (*AssociatePersonasToEntitiesInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*AssociatePersonasToEntitiesInput) SetPersonas

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

SetPersonas sets the Personas field's value.

func (AssociatePersonasToEntitiesInput) String

func (s AssociatePersonasToEntitiesInput) String() string

String returns the string representation.

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

func (*AssociatePersonasToEntitiesInput) Validate

func (s *AssociatePersonasToEntitiesInput) Validate() error

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

type AssociatePersonasToEntitiesOutput

type AssociatePersonasToEntitiesOutput struct {

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

func (AssociatePersonasToEntitiesOutput) GoString

func (s AssociatePersonasToEntitiesOutput) GoString() string

GoString returns the string representation.

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

func (*AssociatePersonasToEntitiesOutput) SetFailedEntityList

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

SetFailedEntityList sets the FailedEntityList field's value.

func (AssociatePersonasToEntitiesOutput) String

func (s AssociatePersonasToEntitiesOutput) String() string

String returns the string representation.

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

type AttributeFilter

type AttributeFilter struct {

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

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

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

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

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

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

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

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

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

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

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

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

<AndAllFilters>

<OrAllFilters>

<EqualsTo>

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

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

func (AttributeFilter) GoString

func (s AttributeFilter) GoString() string

GoString returns the string representation.

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

func (*AttributeFilter) SetAndAllFilters

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

SetAndAllFilters sets the AndAllFilters field's value.

func (*AttributeFilter) SetContainsAll

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

SetContainsAll sets the ContainsAll field's value.

func (*AttributeFilter) SetContainsAny

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

SetContainsAny sets the ContainsAny field's value.

func (*AttributeFilter) SetEqualsTo

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

SetEqualsTo sets the EqualsTo field's value.

func (*AttributeFilter) SetGreaterThan

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

SetGreaterThan sets the GreaterThan field's value.

func (*AttributeFilter) SetGreaterThanOrEquals

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

SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value.

func (*AttributeFilter) SetLessThan

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

SetLessThan sets the LessThan field's value.

func (*AttributeFilter) SetLessThanOrEquals

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

SetLessThanOrEquals sets the LessThanOrEquals field's value.

func (*AttributeFilter) SetNotFilter

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

SetNotFilter sets the NotFilter field's value.

func (*AttributeFilter) SetOrAllFilters

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

SetOrAllFilters sets the OrAllFilters field's value.

func (AttributeFilter) String

func (s AttributeFilter) String() string

String returns the string representation.

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

func (*AttributeFilter) Validate

func (s *AttributeFilter) Validate() error

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

type AuthenticationConfiguration

type AuthenticationConfiguration struct {

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

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

func (AuthenticationConfiguration) GoString

func (s AuthenticationConfiguration) GoString() string

GoString returns the string representation.

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

func (*AuthenticationConfiguration) SetBasicAuthentication

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

SetBasicAuthentication sets the BasicAuthentication field's value.

func (AuthenticationConfiguration) String

func (s AuthenticationConfiguration) String() string

String returns the string representation.

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

func (*AuthenticationConfiguration) Validate

func (s *AuthenticationConfiguration) Validate() error

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

type BasicAuthenticationConfiguration

type BasicAuthenticationConfiguration struct {

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

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

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

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

func (BasicAuthenticationConfiguration) GoString

func (s BasicAuthenticationConfiguration) GoString() string

GoString returns the string representation.

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

func (*BasicAuthenticationConfiguration) SetCredentials

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

SetCredentials sets the Credentials field's value.

func (*BasicAuthenticationConfiguration) SetHost

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

SetHost sets the Host field's value.

func (*BasicAuthenticationConfiguration) SetPort

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

SetPort sets the Port field's value.

func (BasicAuthenticationConfiguration) String

func (s BasicAuthenticationConfiguration) String() string

String returns the string representation.

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

func (*BasicAuthenticationConfiguration) Validate

func (s *BasicAuthenticationConfiguration) Validate() error

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

type BatchDeleteDocumentInput

type BatchDeleteDocumentInput struct {

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

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

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

func (BatchDeleteDocumentInput) GoString

func (s BatchDeleteDocumentInput) GoString() string

GoString returns the string representation.

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

func (*BatchDeleteDocumentInput) SetDataSourceSyncJobMetricTarget

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

SetDataSourceSyncJobMetricTarget sets the DataSourceSyncJobMetricTarget field's value.

func (*BatchDeleteDocumentInput) SetDocumentIdList

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

SetDocumentIdList sets the DocumentIdList field's value.

func (*BatchDeleteDocumentInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (BatchDeleteDocumentInput) String

func (s BatchDeleteDocumentInput) String() string

String returns the string representation.

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

func (*BatchDeleteDocumentInput) Validate

func (s *BatchDeleteDocumentInput) Validate() error

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

type BatchDeleteDocumentOutput

type BatchDeleteDocumentOutput struct {

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

func (BatchDeleteDocumentOutput) GoString

func (s BatchDeleteDocumentOutput) GoString() string

GoString returns the string representation.

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

func (*BatchDeleteDocumentOutput) SetFailedDocuments

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

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchDeleteDocumentOutput) String

func (s BatchDeleteDocumentOutput) String() string

String returns the string representation.

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

type BatchDeleteDocumentResponseFailedDocument

type BatchDeleteDocumentResponseFailedDocument struct {

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

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

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

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

func (BatchDeleteDocumentResponseFailedDocument) GoString

func (s BatchDeleteDocumentResponseFailedDocument) GoString() string

GoString returns the string representation.

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

func (*BatchDeleteDocumentResponseFailedDocument) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*BatchDeleteDocumentResponseFailedDocument) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchDeleteDocumentResponseFailedDocument) SetId

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

SetId sets the Id field's value.

func (BatchDeleteDocumentResponseFailedDocument) String

func (s BatchDeleteDocumentResponseFailedDocument) String() string

String returns the string representation.

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

type BatchGetDocumentStatusInput

type BatchGetDocumentStatusInput struct {

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

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

func (BatchGetDocumentStatusInput) GoString

func (s BatchGetDocumentStatusInput) GoString() string

GoString returns the string representation.

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

func (*BatchGetDocumentStatusInput) SetDocumentInfoList

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

SetDocumentInfoList sets the DocumentInfoList field's value.

func (*BatchGetDocumentStatusInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (BatchGetDocumentStatusInput) String

func (s BatchGetDocumentStatusInput) String() string

String returns the string representation.

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

func (*BatchGetDocumentStatusInput) Validate

func (s *BatchGetDocumentStatusInput) Validate() error

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

type BatchGetDocumentStatusOutput

type BatchGetDocumentStatusOutput struct {

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

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

func (BatchGetDocumentStatusOutput) GoString

func (s BatchGetDocumentStatusOutput) GoString() string

GoString returns the string representation.

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

func (*BatchGetDocumentStatusOutput) SetDocumentStatusList

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

SetDocumentStatusList sets the DocumentStatusList field's value.

func (*BatchGetDocumentStatusOutput) SetErrors

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

SetErrors sets the Errors field's value.

func (BatchGetDocumentStatusOutput) String

func (s BatchGetDocumentStatusOutput) String() string

String returns the string representation.

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

type BatchGetDocumentStatusResponseError

type BatchGetDocumentStatusResponseError struct {

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

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

    // One or more documents to add to the index.
    //
    // Documents have the following file size limits.
    //
    //    * 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 API.
    //
    // 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
    // API. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
    RoleArn *string `type:"string"`
    // contains filtered or unexported fields
}

func (BatchPutDocumentInput) GoString

func (s BatchPutDocumentInput) GoString() string

GoString returns the string representation.

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

func (*BatchPutDocumentInput) SetCustomDocumentEnrichmentConfiguration

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

SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value.

func (*BatchPutDocumentInput) SetDocuments

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

SetDocuments sets the Documents field's value.

func (*BatchPutDocumentInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*BatchPutDocumentInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (BatchPutDocumentInput) String

func (s BatchPutDocumentInput) String() string

String returns the string representation.

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

func (*BatchPutDocumentInput) Validate

func (s *BatchPutDocumentInput) Validate() error

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

type BatchPutDocumentOutput

type BatchPutDocumentOutput struct {

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

func (BatchPutDocumentOutput) GoString

func (s BatchPutDocumentOutput) GoString() string

GoString returns the string representation.

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

func (*BatchPutDocumentOutput) SetFailedDocuments

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

SetFailedDocuments sets the FailedDocuments field's value.

func (BatchPutDocumentOutput) String

func (s BatchPutDocumentOutput) String() string

String returns the string representation.

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

type BatchPutDocumentResponseFailedDocument

type BatchPutDocumentResponseFailedDocument struct {

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

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

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

type BoxConfiguration struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

func (BoxConfiguration) GoString

func (s BoxConfiguration) GoString() string

GoString returns the string representation.

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

func (*BoxConfiguration) SetCommentFieldMappings

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

SetCommentFieldMappings sets the CommentFieldMappings field's value.

func (*BoxConfiguration) SetCrawlComments

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

SetCrawlComments sets the CrawlComments field's value.

func (*BoxConfiguration) SetCrawlTasks

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

SetCrawlTasks sets the CrawlTasks field's value.

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

SetCrawlWebLinks sets the CrawlWebLinks field's value.

func (*BoxConfiguration) SetEnterpriseId

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

SetEnterpriseId sets the EnterpriseId field's value.

func (*BoxConfiguration) SetExclusionPatterns

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*BoxConfiguration) SetFileFieldMappings

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

SetFileFieldMappings sets the FileFieldMappings field's value.

func (*BoxConfiguration) SetInclusionPatterns

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*BoxConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*BoxConfiguration) SetTaskFieldMappings

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

SetTaskFieldMappings sets the TaskFieldMappings field's value.

func (*BoxConfiguration) SetUseChangeLog

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

SetUseChangeLog sets the UseChangeLog field's value.

func (*BoxConfiguration) SetVpcConfiguration

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*BoxConfiguration) SetWebLinkFieldMappings

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

SetWebLinkFieldMappings sets the WebLinkFieldMappings field's value.

func (BoxConfiguration) String

func (s BoxConfiguration) String() string

String returns the string representation.

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

func (*BoxConfiguration) Validate

func (s *BoxConfiguration) Validate() error

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

type CapacityUnitsConfiguration

type CapacityUnitsConfiguration struct {

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

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

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

func (CapacityUnitsConfiguration) GoString

func (s CapacityUnitsConfiguration) GoString() string

GoString returns the string representation.

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

func (*CapacityUnitsConfiguration) SetQueryCapacityUnits

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

SetQueryCapacityUnits sets the QueryCapacityUnits field's value.

func (*CapacityUnitsConfiguration) SetStorageCapacityUnits

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

SetStorageCapacityUnits sets the StorageCapacityUnits field's value.

func (CapacityUnitsConfiguration) String

func (s CapacityUnitsConfiguration) String() string

String returns the string representation.

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

func (*CapacityUnitsConfiguration) Validate

func (s *CapacityUnitsConfiguration) Validate() error

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

type ClearQuerySuggestionsInput

type ClearQuerySuggestionsInput struct {

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

func (ClearQuerySuggestionsInput) GoString

func (s ClearQuerySuggestionsInput) GoString() string

GoString returns the string representation.

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

func (*ClearQuerySuggestionsInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (ClearQuerySuggestionsInput) String

func (s ClearQuerySuggestionsInput) String() string

String returns the string representation.

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

func (*ClearQuerySuggestionsInput) Validate

func (s *ClearQuerySuggestionsInput) Validate() error

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

type ClearQuerySuggestionsOutput

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

func (ClearQuerySuggestionsOutput) GoString

func (s ClearQuerySuggestionsOutput) GoString() string

GoString returns the string representation.

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

func (ClearQuerySuggestionsOutput) String

func (s ClearQuerySuggestionsOutput) String() string

String returns the string representation.

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

type ClickFeedback

type ClickFeedback struct {

    // The Unix timestamp 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 API to provide click information.

func (ClickFeedback) GoString

func (s ClickFeedback) GoString() string

GoString returns the string representation.

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

func (*ClickFeedback) SetClickTime

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

SetClickTime sets the ClickTime field's value.

func (*ClickFeedback) SetResultId

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

SetResultId sets the ResultId field's value.

func (ClickFeedback) String

func (s ClickFeedback) String() string

String returns the string representation.

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

func (*ClickFeedback) Validate

func (s *ClickFeedback) Validate() error

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

type ColumnConfiguration

type ColumnConfiguration struct {

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

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

    // The column that provides the document's 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
    // API.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
    // contains filtered or unexported fields
}

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

func (ColumnConfiguration) GoString

func (s ColumnConfiguration) GoString() string

GoString returns the string representation.

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

func (*ColumnConfiguration) SetChangeDetectingColumns

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

SetChangeDetectingColumns sets the ChangeDetectingColumns field's value.

func (*ColumnConfiguration) SetDocumentDataColumnName

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

SetDocumentDataColumnName sets the DocumentDataColumnName field's value.

func (*ColumnConfiguration) SetDocumentIdColumnName

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

SetDocumentIdColumnName sets the DocumentIdColumnName field's value.

func (*ColumnConfiguration) SetDocumentTitleColumnName

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

SetDocumentTitleColumnName sets the DocumentTitleColumnName field's value.

func (*ColumnConfiguration) SetFieldMappings

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

SetFieldMappings sets the FieldMappings field's value.

func (ColumnConfiguration) String

func (s ColumnConfiguration) String() string

String returns the string representation.

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

func (*ColumnConfiguration) Validate

func (s *ColumnConfiguration) Validate() error

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

type ConflictException

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

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

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 {

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

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

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

func (ConfluenceAttachmentConfiguration) GoString

func (s ConfluenceAttachmentConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConfluenceAttachmentConfiguration) SetAttachmentFieldMappings

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

SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value.

func (*ConfluenceAttachmentConfiguration) SetCrawlAttachments

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

SetCrawlAttachments sets the CrawlAttachments field's value.

func (ConfluenceAttachmentConfiguration) String

func (s ConfluenceAttachmentConfiguration) String() string

String returns the string representation.

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

func (*ConfluenceAttachmentConfiguration) Validate

func (s *ConfluenceAttachmentConfiguration) Validate() error

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

type ConfluenceAttachmentToIndexFieldMapping

type ConfluenceAttachmentToIndexFieldMapping struct {

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

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

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

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

func (ConfluenceAttachmentToIndexFieldMapping) GoString

func (s ConfluenceAttachmentToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluenceAttachmentToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceAttachmentToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceAttachmentToIndexFieldMapping) String

func (s ConfluenceAttachmentToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluenceAttachmentToIndexFieldMapping) Validate

func (s *ConfluenceAttachmentToIndexFieldMapping) Validate() error

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

type ConfluenceBlogConfiguration

type ConfluenceBlogConfiguration struct {

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

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

func (ConfluenceBlogConfiguration) GoString

func (s ConfluenceBlogConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConfluenceBlogConfiguration) SetBlogFieldMappings

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

SetBlogFieldMappings sets the BlogFieldMappings field's value.

func (ConfluenceBlogConfiguration) String

func (s ConfluenceBlogConfiguration) String() string

String returns the string representation.

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

func (*ConfluenceBlogConfiguration) Validate

func (s *ConfluenceBlogConfiguration) Validate() error

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

type ConfluenceBlogToIndexFieldMapping

type ConfluenceBlogToIndexFieldMapping struct {

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

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

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

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

func (ConfluenceBlogToIndexFieldMapping) GoString

func (s ConfluenceBlogToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluenceBlogToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceBlogToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceBlogToIndexFieldMapping) String

func (s ConfluenceBlogToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluenceBlogToIndexFieldMapping) Validate

func (s *ConfluenceBlogToIndexFieldMapping) Validate() error

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

type ConfluenceConfiguration

type ConfluenceConfiguration struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

func (ConfluenceConfiguration) GoString

func (s ConfluenceConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConfluenceConfiguration) SetAttachmentConfiguration

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

SetAttachmentConfiguration sets the AttachmentConfiguration field's value.

func (*ConfluenceConfiguration) SetAuthenticationType

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

SetAuthenticationType sets the AuthenticationType field's value.

func (*ConfluenceConfiguration) SetBlogConfiguration

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

SetBlogConfiguration sets the BlogConfiguration field's value.

func (*ConfluenceConfiguration) SetExclusionPatterns

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

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*ConfluenceConfiguration) SetInclusionPatterns

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

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*ConfluenceConfiguration) SetPageConfiguration

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

SetPageConfiguration sets the PageConfiguration field's value.

func (*ConfluenceConfiguration) SetProxyConfiguration

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

SetProxyConfiguration sets the ProxyConfiguration field's value.

func (*ConfluenceConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*ConfluenceConfiguration) SetServerUrl

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

SetServerUrl sets the ServerUrl field's value.

func (*ConfluenceConfiguration) SetSpaceConfiguration

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

SetSpaceConfiguration sets the SpaceConfiguration field's value.

func (*ConfluenceConfiguration) SetVersion

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

SetVersion sets the Version field's value.

func (*ConfluenceConfiguration) SetVpcConfiguration

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (ConfluenceConfiguration) String

func (s ConfluenceConfiguration) String() string

String returns the string representation.

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

func (*ConfluenceConfiguration) Validate

func (s *ConfluenceConfiguration) Validate() error

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

type ConfluencePageConfiguration

type ConfluencePageConfiguration struct {

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

Configuration of the page settings for the Confluence data source.

func (ConfluencePageConfiguration) GoString

func (s ConfluencePageConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConfluencePageConfiguration) SetPageFieldMappings

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

SetPageFieldMappings sets the PageFieldMappings field's value.

func (ConfluencePageConfiguration) String

func (s ConfluencePageConfiguration) String() string

String returns the string representation.

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

func (*ConfluencePageConfiguration) Validate

func (s *ConfluencePageConfiguration) Validate() error

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

type ConfluencePageToIndexFieldMapping

type ConfluencePageToIndexFieldMapping struct {

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

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

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

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

func (ConfluencePageToIndexFieldMapping) GoString

func (s ConfluencePageToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluencePageToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluencePageToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluencePageToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluencePageToIndexFieldMapping) String

func (s ConfluencePageToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluencePageToIndexFieldMapping) Validate

func (s *ConfluencePageToIndexFieldMapping) Validate() error

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

type ConfluenceSpaceConfiguration

type ConfluenceSpaceConfiguration struct {

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

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

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

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

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

Configuration information for indexing Confluence spaces.

func (ConfluenceSpaceConfiguration) GoString

func (s ConfluenceSpaceConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConfluenceSpaceConfiguration) SetCrawlArchivedSpaces

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

SetCrawlArchivedSpaces sets the CrawlArchivedSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetCrawlPersonalSpaces

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

SetCrawlPersonalSpaces sets the CrawlPersonalSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetExcludeSpaces

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

SetExcludeSpaces sets the ExcludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetIncludeSpaces

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

SetIncludeSpaces sets the IncludeSpaces field's value.

func (*ConfluenceSpaceConfiguration) SetSpaceFieldMappings

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

SetSpaceFieldMappings sets the SpaceFieldMappings field's value.

func (ConfluenceSpaceConfiguration) String

func (s ConfluenceSpaceConfiguration) String() string

String returns the string representation.

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

func (*ConfluenceSpaceConfiguration) Validate

func (s *ConfluenceSpaceConfiguration) Validate() error

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

type ConfluenceSpaceToIndexFieldMapping

type ConfluenceSpaceToIndexFieldMapping struct {

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

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

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

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

func (ConfluenceSpaceToIndexFieldMapping) GoString

func (s ConfluenceSpaceToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*ConfluenceSpaceToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*ConfluenceSpaceToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (ConfluenceSpaceToIndexFieldMapping) String

func (s ConfluenceSpaceToIndexFieldMapping) String() string

String returns the string representation.

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

func (*ConfluenceSpaceToIndexFieldMapping) Validate

func (s *ConfluenceSpaceToIndexFieldMapping) Validate() error

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

type ConnectionConfiguration

type ConnectionConfiguration struct {

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

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

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

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

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

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

func (ConnectionConfiguration) GoString

func (s ConnectionConfiguration) GoString() string

GoString returns the string representation.

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

func (*ConnectionConfiguration) SetDatabaseHost

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

SetDatabaseHost sets the DatabaseHost field's value.

func (*ConnectionConfiguration) SetDatabaseName

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

SetDatabaseName sets the DatabaseName field's value.

func (*ConnectionConfiguration) SetDatabasePort

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

SetDatabasePort sets the DatabasePort field's value.

func (*ConnectionConfiguration) SetSecretArn

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

SetSecretArn sets the SecretArn field's value.

func (*ConnectionConfiguration) SetTableName

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

SetTableName sets the TableName field's value.

func (ConnectionConfiguration) String

func (s ConnectionConfiguration) String() string

String returns the string representation.

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

func (*ConnectionConfiguration) Validate

func (s *ConnectionConfiguration) Validate() error

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

type ContentSourceConfiguration

type ContentSourceConfiguration struct {

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

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

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

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

func (ContentSourceConfiguration) GoString

func (s ContentSourceConfiguration) GoString() string

GoString returns the string representation.

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

func (*ContentSourceConfiguration) SetDataSourceIds

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

SetDataSourceIds sets the DataSourceIds field's value.

func (*ContentSourceConfiguration) SetDirectPutContent

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

SetDirectPutContent sets the DirectPutContent field's value.

func (*ContentSourceConfiguration) SetFaqIds

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

SetFaqIds sets the FaqIds field's value.

func (ContentSourceConfiguration) String

func (s ContentSourceConfiguration) String() string

String returns the string representation.

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

func (*ContentSourceConfiguration) Validate

func (s *ContentSourceConfiguration) Validate() error

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

type Correction

type Correction struct {

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

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

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

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

A corrected misspelled word in a query.

func (Correction) GoString

func (s Correction) GoString() string

GoString returns the string representation.

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

func (*Correction) SetBeginOffset

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

SetBeginOffset sets the BeginOffset field's value.

func (*Correction) SetCorrectedTerm

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

SetCorrectedTerm sets the CorrectedTerm field's value.

func (*Correction) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (*Correction) SetTerm

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

SetTerm sets the Term field's value.

func (Correction) String

func (s Correction) String() string

String returns the string representation.

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

type CreateAccessControlConfigurationInput

type CreateAccessControlConfigurationInput struct {

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

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

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

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

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

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

func (CreateAccessControlConfigurationInput) GoString

func (s CreateAccessControlConfigurationInput) GoString() string

GoString returns the string representation.

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

func (*CreateAccessControlConfigurationInput) SetAccessControlList

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

SetAccessControlList sets the AccessControlList field's value.

func (*CreateAccessControlConfigurationInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateAccessControlConfigurationInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateAccessControlConfigurationInput) SetHierarchicalAccessControlList

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

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*CreateAccessControlConfigurationInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateAccessControlConfigurationInput) SetName

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

SetName sets the Name field's value.

func (CreateAccessControlConfigurationInput) String

func (s CreateAccessControlConfigurationInput) String() string

String returns the string representation.

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

func (*CreateAccessControlConfigurationInput) Validate

func (s *CreateAccessControlConfigurationInput) Validate() error

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

type CreateAccessControlConfigurationOutput

type CreateAccessControlConfigurationOutput struct {

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

func (CreateAccessControlConfigurationOutput) GoString

func (s CreateAccessControlConfigurationOutput) GoString() string

GoString returns the string representation.

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

func (*CreateAccessControlConfigurationOutput) SetId

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

SetId sets the Id field's value.

func (CreateAccessControlConfigurationOutput) String

func (s CreateAccessControlConfigurationOutput) String() string

String returns the string representation.

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

type CreateDataSourceInput

type CreateDataSourceInput struct {

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

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

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

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

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

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

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

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

    // Sets the frequency for Amazon Kendra to check the documents in your data
    // source repository and update the index. If you don't set a schedule Amazon
    // Kendra will not periodically update the index. You can call the StartDataSourceSyncJob
    // API to update the index.
    //
    // 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 connector. You can
    // use the tags to identify and organize your resources and to control access
    // to resources.
    Tags []*Tag `type:"list"`

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

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

func (CreateDataSourceInput) GoString

func (s CreateDataSourceInput) GoString() string

GoString returns the string representation.

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

func (*CreateDataSourceInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateDataSourceInput) SetConfiguration

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

SetConfiguration sets the Configuration field's value.

func (*CreateDataSourceInput) SetCustomDocumentEnrichmentConfiguration

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

SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value.

func (*CreateDataSourceInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateDataSourceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateDataSourceInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*CreateDataSourceInput) SetName

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

SetName sets the Name field's value.

func (*CreateDataSourceInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateDataSourceInput) SetSchedule

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

SetSchedule sets the Schedule field's value.

func (*CreateDataSourceInput) SetTags

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

SetTags sets the Tags field's value.

func (*CreateDataSourceInput) SetType

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

SetType sets the Type field's value.

func (*CreateDataSourceInput) SetVpcConfiguration

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (CreateDataSourceInput) String

func (s CreateDataSourceInput) String() string

String returns the string representation.

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

func (*CreateDataSourceInput) Validate

func (s *CreateDataSourceInput) Validate() error

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

type CreateDataSourceOutput

type CreateDataSourceOutput struct {

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

func (CreateDataSourceOutput) GoString

func (s CreateDataSourceOutput) GoString() string

GoString returns the string representation.

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

func (*CreateDataSourceOutput) SetId

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

SetId sets the Id field's value.

func (CreateDataSourceOutput) String

func (s CreateDataSourceOutput) String() string

String returns the string representation.

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

type CreateExperienceInput

type CreateExperienceInput struct {

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

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

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

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

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

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

func (CreateExperienceInput) GoString

func (s CreateExperienceInput) GoString() string

GoString returns the string representation.

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

func (*CreateExperienceInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateExperienceInput) SetConfiguration

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

SetConfiguration sets the Configuration field's value.

func (*CreateExperienceInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateExperienceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateExperienceInput) SetName

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

SetName sets the Name field's value.

func (*CreateExperienceInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (CreateExperienceInput) String

func (s CreateExperienceInput) String() string

String returns the string representation.

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

func (*CreateExperienceInput) Validate

func (s *CreateExperienceInput) Validate() error

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

type CreateExperienceOutput

type CreateExperienceOutput struct {

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

func (CreateExperienceOutput) GoString

func (s CreateExperienceOutput) GoString() string

GoString returns the string representation.

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

func (*CreateExperienceOutput) SetId

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

SetId sets the Id field's value.

func (CreateExperienceOutput) String

func (s CreateExperienceOutput) String() string

String returns the string representation.

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

type CreateFaqInput

type CreateFaqInput struct {

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

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

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

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

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

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

    // The Amazon Resource Name (ARN) of 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 `type:"string" required:"true"`

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

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

func (CreateFaqInput) GoString

func (s CreateFaqInput) GoString() string

GoString returns the string representation.

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

func (*CreateFaqInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateFaqInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateFaqInput) SetFileFormat

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

SetFileFormat sets the FileFormat field's value.

func (*CreateFaqInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*CreateFaqInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*CreateFaqInput) SetName

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

SetName sets the Name field's value.

func (*CreateFaqInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateFaqInput) SetS3Path

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

SetS3Path sets the S3Path field's value.

func (*CreateFaqInput) SetTags

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

SetTags sets the Tags field's value.

func (CreateFaqInput) String

func (s CreateFaqInput) String() string

String returns the string representation.

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

func (*CreateFaqInput) Validate

func (s *CreateFaqInput) Validate() error

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

type CreateFaqOutput

type CreateFaqOutput struct {

    // The 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 API with the same client token will create only
    // one index.
    ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

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

    // The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION
    // for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION
    // for 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"`

    // A name for the 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
    // you use when you call the BatchPutDocument API to index documents from an
    // Amazon S3 bucket.
    //
    // RoleArn is a required field
    RoleArn *string `type:"string" required:"true"`

    // The identifier of the KMS customer managed key (CMK) that's used to encrypt
    // data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
    ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

    // A list of key-value pairs that identify 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 IAM Identity Center
    // (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration
    // (https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html).
    UserGroupResolutionConfiguration *UserGroupResolutionConfiguration `type:"structure"`

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

func (CreateIndexInput) GoString

func (s CreateIndexInput) GoString() string

GoString returns the string representation.

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

func (*CreateIndexInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateIndexInput) SetDescription

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

SetDescription sets the Description field's value.

func (*CreateIndexInput) SetEdition

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

SetEdition sets the Edition field's value.

func (*CreateIndexInput) SetName

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

SetName sets the Name field's value.

func (*CreateIndexInput) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (*CreateIndexInput) SetServerSideEncryptionConfiguration

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

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*CreateIndexInput) SetTags

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

SetTags sets the Tags field's value.

func (*CreateIndexInput) SetUserContextPolicy

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

SetUserContextPolicy sets the UserContextPolicy field's value.

func (*CreateIndexInput) SetUserGroupResolutionConfiguration

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

SetUserGroupResolutionConfiguration sets the UserGroupResolutionConfiguration field's value.

func (*CreateIndexInput) SetUserTokenConfigurations

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

SetUserTokenConfigurations sets the UserTokenConfigurations field's value.

func (CreateIndexInput) String

func (s CreateIndexInput) String() string

String returns the string representation.

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

func (*CreateIndexInput) Validate

func (s *CreateIndexInput) Validate() error

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

type CreateIndexOutput

type CreateIndexOutput struct {

    // The 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 Web Services 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 `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 API with the same client token will create only
    // one thesaurus.
    ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

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

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

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

    // An IAM role that gives Amazon Kendra permissions to access thesaurus file
    // specified in SourceS3Path.
    //
    // RoleArn is a required field
    RoleArn *string `type:"string" required:"true"`

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

    // A list of key-value pairs that identify 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 CustomDocumentEnrichmentConfiguration

type CustomDocumentEnrichmentConfiguration struct {

    // Configuration information to alter document attributes or metadata fields
    // and content when ingesting documents into Amazon Kendra.
    InlineConfigurations []*InlineCustomDocumentEnrichmentConfiguration `type:"list"`

    // Configuration information for invoking a Lambda function in Lambda on the
    // structured documents with their metadata and text extracted. You can use
    // a Lambda function to apply advanced logic for creating, modifying, or deleting
    // document metadata and content. For more information, see Advanced data manipulation
    // (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).
    PostExtractionHookConfiguration *HookConfiguration `type:"structure"`

    // Configuration information for invoking a Lambda function in Lambda on the
    // original or raw documents before extracting their metadata and text. You
    // can use a Lambda function to apply advanced logic for creating, modifying,
    // or deleting document metadata and content. For more information, see Advanced
    // data manipulation (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation).
    PreExtractionHookConfiguration *HookConfiguration `type:"structure"`

    // The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration
    // and PostExtractionHookConfiguration for altering document metadata and content
    // during the document ingestion process. For more information, see IAM roles
    // for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
    RoleArn *string `type:"string"`
    // contains filtered or unexported fields
}

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).

func (CustomDocumentEnrichmentConfiguration) GoString

func (s CustomDocumentEnrichmentConfiguration) GoString() string

GoString returns the string representation.

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

func (*CustomDocumentEnrichmentConfiguration) SetInlineConfigurations

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

SetInlineConfigurations sets the InlineConfigurations field's value.

func (*CustomDocumentEnrichmentConfiguration) SetPostExtractionHookConfiguration

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

SetPostExtractionHookConfiguration sets the PostExtractionHookConfiguration field's value.

func (*CustomDocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration

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

SetPreExtractionHookConfiguration sets the PreExtractionHookConfiguration field's value.

func (*CustomDocumentEnrichmentConfiguration) SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

func (CustomDocumentEnrichmentConfiguration) String

func (s CustomDocumentEnrichmentConfiguration) String() string

String returns the string representation.

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

func (*CustomDocumentEnrichmentConfiguration) Validate

func (s *CustomDocumentEnrichmentConfiguration) Validate() error

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

type DataSourceConfiguration

type DataSourceConfiguration struct {

    // Provides the configuration information to connect to Alfresco as your data
    // source.
    AlfrescoConfiguration *AlfrescoConfiguration `type:"structure"`

    // Provides the configuration information to connect to Box as your data source.
    BoxConfiguration *BoxConfiguration `type:"structure"`

    // Provides the configuration information to connect to Confluence as your data
    // source.
    ConfluenceConfiguration *ConfluenceConfiguration `type:"structure"`

    // Provides the configuration information to connect to a database as your data
    // source.
    DatabaseConfiguration *DatabaseConfiguration `type:"structure"`

    // Provides the configuration information to connect to Amazon FSx as your data
    // source.
    FsxConfiguration *FsxConfiguration `type:"structure"`

    // Provides the configuration information to connect to GitHub as your data
    // source.
    GitHubConfiguration *GitHubConfiguration `type:"structure"`

    // Provides the configuration information to connect to Google Drive as your
    // data source.
    GoogleDriveConfiguration *GoogleDriveConfiguration `type:"structure"`

    // Provides the configuration information to connect to Jira as your data source.
    JiraConfiguration *JiraConfiguration `type:"structure"`

    // Provides the configuration information to connect to Microsoft OneDrive as
    // your data source.
    OneDriveConfiguration *OneDriveConfiguration `type:"structure"`

    // Provides the configuration information to connect to Quip as your data source.
    QuipConfiguration *QuipConfiguration `type:"structure"`

    // Provides the configuration information to connect to an Amazon S3 bucket
    // as your data source.
    S3Configuration *S3DataSourceConfiguration `type:"structure"`

    // Provides the configuration information to connect to Salesforce as your data
    // source.
    SalesforceConfiguration *SalesforceConfiguration `type:"structure"`

    // Provides the configuration information to connect to ServiceNow as your data
    // source.
    ServiceNowConfiguration *ServiceNowConfiguration `type:"structure"`

    // Provides the configuration information to connect to Microsoft SharePoint
    // as your data source.
    SharePointConfiguration *SharePointConfiguration `type:"structure"`

    // Provides the configuration information to connect to Slack as your data source.
    SlackConfiguration *SlackConfiguration `type:"structure"`

    // Provides a template for the configuration information to connect to your
    // data source.
    TemplateConfiguration *TemplateConfiguration `type:"structure"`

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

    // Provides the configuration information to connect to Amazon WorkDocs as your
    // data source.
    WorkDocsConfiguration *WorkDocsConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

Provides the configuration information for an Amazon Kendra data source.

func (DataSourceConfiguration) GoString

func (s DataSourceConfiguration) GoString() string

GoString returns the string representation.

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

func (*DataSourceConfiguration) SetAlfrescoConfiguration

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

SetAlfrescoConfiguration sets the AlfrescoConfiguration field's value.

func (*DataSourceConfiguration) SetBoxConfiguration

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

SetBoxConfiguration sets the BoxConfiguration field's value.

func (*DataSourceConfiguration) SetConfluenceConfiguration

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

SetConfluenceConfiguration sets the ConfluenceConfiguration field's value.

func (*DataSourceConfiguration) SetDatabaseConfiguration

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

SetDatabaseConfiguration sets the DatabaseConfiguration field's value.

func (*DataSourceConfiguration) SetFsxConfiguration

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

SetFsxConfiguration sets the FsxConfiguration field's value.

func (*DataSourceConfiguration) SetGitHubConfiguration

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

SetGitHubConfiguration sets the GitHubConfiguration field's value.

func (*DataSourceConfiguration) SetGoogleDriveConfiguration

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

SetGoogleDriveConfiguration sets the GoogleDriveConfiguration field's value.

func (*DataSourceConfiguration) SetJiraConfiguration

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

SetJiraConfiguration sets the JiraConfiguration field's value.

func (*DataSourceConfiguration) SetOneDriveConfiguration

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

SetOneDriveConfiguration sets the OneDriveConfiguration field's value.

func (*DataSourceConfiguration) SetQuipConfiguration

func (s *DataSourceConfiguration) SetQuipConfiguration(v *QuipConfiguration) *DataSourceConfiguration

SetQuipConfiguration sets the QuipConfiguration field's value.

func (*DataSourceConfiguration) SetS3Configuration

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

SetS3Configuration sets the S3Configuration field's value.

func (*DataSourceConfiguration) SetSalesforceConfiguration

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

SetSalesforceConfiguration sets the SalesforceConfiguration field's value.

func (*DataSourceConfiguration) SetServiceNowConfiguration

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

SetServiceNowConfiguration sets the ServiceNowConfiguration field's value.

func (*DataSourceConfiguration) SetSharePointConfiguration

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

SetSharePointConfiguration sets the SharePointConfiguration field's value.

func (*DataSourceConfiguration) SetSlackConfiguration

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

SetSlackConfiguration sets the SlackConfiguration field's value.

func (*DataSourceConfiguration) SetTemplateConfiguration

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

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*DataSourceConfiguration) SetWebCrawlerConfiguration

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

SetWebCrawlerConfiguration sets the WebCrawlerConfiguration field's value.

func (*DataSourceConfiguration) SetWorkDocsConfiguration

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

SetWorkDocsConfiguration sets the WorkDocsConfiguration field's value.

func (DataSourceConfiguration) String

func (s DataSourceConfiguration) String() string

String returns the string representation.

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

func (*DataSourceConfiguration) Validate

func (s *DataSourceConfiguration) Validate() error

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

type DataSourceGroup

type DataSourceGroup struct {

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

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

Data source information for user context filtering.

func (DataSourceGroup) GoString

func (s DataSourceGroup) GoString() string

GoString returns the string representation.

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

func (*DataSourceGroup) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceGroup) SetGroupId

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

SetGroupId sets the GroupId field's value.

func (DataSourceGroup) String

func (s DataSourceGroup) String() string

String returns the string representation.

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

func (*DataSourceGroup) Validate

func (s *DataSourceGroup) Validate() error

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

type DataSourceSummary

type DataSourceSummary struct {

    // The UNIX 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 an Amazon Kendra data source. Returned in a call to the DescribeDataSource API.

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 completed.
    EndTime *time.Time `type:"timestamp"`

    // If the Status field is set to FAILED, the ErrorCode field indicates the reason
    // the synchronization failed.
    ErrorCode *string `type:"string" enum:"ErrorCode"`

    // If the Status field is set to ERROR, the ErrorMessage field contains a description
    // of the error that caused the synchronization to fail.
    ErrorMessage *string `min:"1" type:"string"`

    // A 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 started.
    StartTime *time.Time `type:"timestamp"`

    // The execution status of the synchronization job. When the Status field is
    // set to SUCCEEDED, the synchronization job is done. If the status code is
    // set to FAILED, the ErrorCode and ErrorMessage fields give you the reason
    // for the failure.
    Status *string `type:"string" enum:"DataSourceSyncJobStatus"`
    // contains filtered or unexported fields
}

Provides information about a data source synchronization job.

func (DataSourceSyncJob) GoString

func (s DataSourceSyncJob) GoString() string

GoString returns the string representation.

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

func (*DataSourceSyncJob) SetDataSourceErrorCode

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

SetDataSourceErrorCode sets the DataSourceErrorCode field's value.

func (*DataSourceSyncJob) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*DataSourceSyncJob) SetErrorCode

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

SetErrorCode sets the ErrorCode field's value.

func (*DataSourceSyncJob) SetErrorMessage

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

SetErrorMessage sets the ErrorMessage field's value.

func (*DataSourceSyncJob) SetExecutionId

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

SetExecutionId sets the ExecutionId field's value.

func (*DataSourceSyncJob) SetMetrics

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

SetMetrics sets the Metrics field's value.

func (*DataSourceSyncJob) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (*DataSourceSyncJob) SetStatus

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

SetStatus sets the Status field's value.

func (DataSourceSyncJob) String

func (s DataSourceSyncJob) String() string

String returns the string representation.

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

type DataSourceSyncJobMetricTarget

type DataSourceSyncJobMetricTarget struct {

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

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

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

func (DataSourceSyncJobMetricTarget) GoString

func (s DataSourceSyncJobMetricTarget) GoString() string

GoString returns the string representation.

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

func (*DataSourceSyncJobMetricTarget) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId

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

SetDataSourceSyncJobId sets the DataSourceSyncJobId field's value.

func (DataSourceSyncJobMetricTarget) String

func (s DataSourceSyncJobMetricTarget) String() string

String returns the string representation.

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

func (*DataSourceSyncJobMetricTarget) Validate

func (s *DataSourceSyncJobMetricTarget) Validate() error

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

type DataSourceSyncJobMetrics

type DataSourceSyncJobMetrics struct {

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

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

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

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

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

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

func (DataSourceSyncJobMetrics) GoString

func (s DataSourceSyncJobMetrics) GoString() string

GoString returns the string representation.

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

func (*DataSourceSyncJobMetrics) SetDocumentsAdded

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

SetDocumentsAdded sets the DocumentsAdded field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsDeleted

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

SetDocumentsDeleted sets the DocumentsDeleted field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsFailed

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

SetDocumentsFailed sets the DocumentsFailed field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsModified

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

SetDocumentsModified sets the DocumentsModified field's value.

func (*DataSourceSyncJobMetrics) SetDocumentsScanned

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

SetDocumentsScanned sets the DocumentsScanned field's value.

func (DataSourceSyncJobMetrics) String

func (s DataSourceSyncJobMetrics) String() string

String returns the string representation.

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

type DataSourceToIndexFieldMapping

type DataSourceToIndexFieldMapping struct {

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

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

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

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

func (DataSourceToIndexFieldMapping) GoString

func (s DataSourceToIndexFieldMapping) GoString() string

GoString returns the string representation.

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

func (*DataSourceToIndexFieldMapping) SetDataSourceFieldName

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

SetDataSourceFieldName sets the DataSourceFieldName field's value.

func (*DataSourceToIndexFieldMapping) SetDateFieldFormat

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

SetDateFieldFormat sets the DateFieldFormat field's value.

func (*DataSourceToIndexFieldMapping) SetIndexFieldName

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

SetIndexFieldName sets the IndexFieldName field's value.

func (DataSourceToIndexFieldMapping) String

func (s DataSourceToIndexFieldMapping) String() string

String returns the string representation.

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

func (*DataSourceToIndexFieldMapping) Validate

func (s *DataSourceToIndexFieldMapping) Validate() error

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

type DataSourceVpcConfiguration

type DataSourceVpcConfiguration struct {

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

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

Provides the configuration information to connect to an Amazon VPC.

func (DataSourceVpcConfiguration) GoString

func (s DataSourceVpcConfiguration) GoString() string

GoString returns the string representation.

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

func (*DataSourceVpcConfiguration) SetSecurityGroupIds

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

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*DataSourceVpcConfiguration) SetSubnetIds

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

SetSubnetIds sets the SubnetIds field's value.

func (DataSourceVpcConfiguration) String

func (s DataSourceVpcConfiguration) String() string

String returns the string representation.

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

func (*DataSourceVpcConfiguration) Validate

func (s *DataSourceVpcConfiguration) Validate() error

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

type DatabaseConfiguration

type DatabaseConfiguration struct {

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

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

    // Configuration information that's required to connect to a database.
    //
    // ConnectionConfiguration is a required field
    ConnectionConfiguration *ConnectionConfiguration `type:"structure" required:"true"`

    // The type of database engine that runs the database.
    //
    // DatabaseEngineType is a required field
    DatabaseEngineType *string `type:"string" required:"true" enum:"DatabaseEngineType"`

    // Provides information about how Amazon Kendra uses quote marks around SQL
    // identifiers when querying a database data source.
    SqlConfiguration *SqlConfiguration `type:"structure"`

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

Provides the configuration information to connect to a index.

func (DatabaseConfiguration) GoString

func (s DatabaseConfiguration) GoString() string

GoString returns the string representation.

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

func (*DatabaseConfiguration) SetAclConfiguration

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

SetAclConfiguration sets the AclConfiguration field's value.

func (*DatabaseConfiguration) SetColumnConfiguration

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

SetColumnConfiguration sets the ColumnConfiguration field's value.

func (*DatabaseConfiguration) SetConnectionConfiguration

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

SetConnectionConfiguration sets the ConnectionConfiguration field's value.

func (*DatabaseConfiguration) SetDatabaseEngineType

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

SetDatabaseEngineType sets the DatabaseEngineType field's value.

func (*DatabaseConfiguration) SetSqlConfiguration

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

SetSqlConfiguration sets the SqlConfiguration field's value.

func (*DatabaseConfiguration) SetVpcConfiguration

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

SetVpcConfiguration sets the VpcConfiguration field's value.

func (DatabaseConfiguration) String

func (s DatabaseConfiguration) String() string

String returns the string representation.

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

func (*DatabaseConfiguration) Validate

func (s *DatabaseConfiguration) Validate() error

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

type DeleteAccessControlConfigurationInput

type DeleteAccessControlConfigurationInput struct {

    // The identifier of the access control configuration you want to delete.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

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

func (DeleteAccessControlConfigurationInput) GoString

func (s DeleteAccessControlConfigurationInput) GoString() string

GoString returns the string representation.

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

func (*DeleteAccessControlConfigurationInput) SetId

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

SetId sets the Id field's value.

func (*DeleteAccessControlConfigurationInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteAccessControlConfigurationInput) String

func (s DeleteAccessControlConfigurationInput) String() string

String returns the string representation.

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

func (*DeleteAccessControlConfigurationInput) Validate

func (s *DeleteAccessControlConfigurationInput) Validate() error

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

type DeleteAccessControlConfigurationOutput

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

func (DeleteAccessControlConfigurationOutput) GoString

func (s DeleteAccessControlConfigurationOutput) GoString() string

GoString returns the string representation.

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

func (DeleteAccessControlConfigurationOutput) String

func (s DeleteAccessControlConfigurationOutput) String() string

String returns the string representation.

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

type DeleteDataSourceInput

type DeleteDataSourceInput struct {

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

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

func (DeleteDataSourceInput) GoString

func (s DeleteDataSourceInput) GoString() string

GoString returns the string representation.

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

func (*DeleteDataSourceInput) SetId

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

SetId sets the Id field's value.

func (*DeleteDataSourceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteDataSourceInput) String

func (s DeleteDataSourceInput) String() string

String returns the string representation.

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

func (*DeleteDataSourceInput) Validate

func (s *DeleteDataSourceInput) Validate() error

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

type DeleteDataSourceOutput

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

func (DeleteDataSourceOutput) GoString

func (s DeleteDataSourceOutput) GoString() string

GoString returns the string representation.

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

func (DeleteDataSourceOutput) String

func (s DeleteDataSourceOutput) String() string

String returns the string representation.

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

type DeleteExperienceInput

type DeleteExperienceInput struct {

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

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

func (DeleteExperienceInput) GoString

func (s DeleteExperienceInput) GoString() string

GoString returns the string representation.

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

func (*DeleteExperienceInput) SetId

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

SetId sets the Id field's value.

func (*DeleteExperienceInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteExperienceInput) String

func (s DeleteExperienceInput) String() string

String returns the string representation.

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

func (*DeleteExperienceInput) Validate

func (s *DeleteExperienceInput) Validate() error

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

type DeleteExperienceOutput

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

func (DeleteExperienceOutput) GoString

func (s DeleteExperienceOutput) GoString() string

GoString returns the string representation.

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

func (DeleteExperienceOutput) String

func (s DeleteExperienceOutput) String() string

String returns the string representation.

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

type DeleteFaqInput

type DeleteFaqInput struct {

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

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

func (DeleteFaqInput) GoString

func (s DeleteFaqInput) GoString() string

GoString returns the string representation.

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

func (*DeleteFaqInput) SetId

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

SetId sets the Id field's value.

func (*DeleteFaqInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (DeleteFaqInput) String

func (s DeleteFaqInput) String() string

String returns the string representation.

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

func (*DeleteFaqInput) Validate

func (s *DeleteFaqInput) Validate() error

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

type DeleteFaqOutput

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

func (DeleteFaqOutput) GoString

func (s DeleteFaqOutput) GoString() string

GoString returns the string representation.

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

func (DeleteFaqOutput) String

func (s DeleteFaqOutput) String() string

String returns the string representation.

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

type DeleteIndexInput

type DeleteIndexInput struct {

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

func (DeleteIndexInput) GoString

func (s DeleteIndexInput) GoString() string

GoString returns the string representation.

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

func (*DeleteIndexInput) SetId

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

SetId sets the Id field's value.

func (DeleteIndexInput) String

func (s DeleteIndexInput) String() string

String returns the string representation.

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

func (*DeleteIndexInput) Validate

func (s *DeleteIndexInput) Validate() error

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

type DeleteIndexOutput

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

func (DeleteIndexOutput) GoString

func (s DeleteIndexOutput) GoString() string

GoString returns the string representation.

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

func (DeleteIndexOutput) String

func (s DeleteIndexOutput) String() string

String returns the string representation.

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

type DeletePrincipalMappingInput

type DeletePrincipalMappingInput struct {

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

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

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

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

func (DeletePrincipalMappingInput) GoString

func (s DeletePrincipalMappingInput) GoString() string

GoString returns the string representation.

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

func (*DeletePrincipalMappingInput) SetDataSourceId

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

SetDataSourceId sets the DataSourceId field's value.

func (*DeletePrincipalMappingInput) SetGroupId

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

SetGroupId sets the GroupId field's value.

func (*DeletePrincipalMappingInput) SetIndexId

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

SetIndexId sets the IndexId field's value.

func (*DeletePrincipalMappingInput) SetOrderingId

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

SetOrderingId sets the OrderingId field's value.

func (DeletePrincipalMappingInput) String

func (s DeletePrincipalMappingInput) String() string

String returns the string representation.

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

func (*DeletePrincipalMappingInput) Validate

func (s *DeletePrincipalMappingInput) Validate() error

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

type DeletePrincipalMappingOutput

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

func (DeletePrincipalMappingOutput) GoString

func (s DeletePrincipalMappingOutput) GoString() string

GoString returns the string representation.

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

func (DeletePrincipalMappingOutput) String

func (s DeletePrincipalMappingOutput) String() string

String returns the string representation.

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

type DeleteQuerySuggestionsBlockListInput

type DeleteQuerySuggestionsBlockListInput struct {

    // The identifier of the block list you want to delete.
    //
    // Id is a required field
    Id *string `min:"36" type:"string" required:"true"`

    // The identifier of the index for the block list.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteQuerySuggestionsBlockListInput) GoString

func (s DeleteQuerySuggestionsBlockListInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQuerySuggestionsBlockListInput) SetId

func (s *DeleteQuerySuggestionsBlockListInput) SetId(v string) *DeleteQuerySuggestionsBlockListInput

SetId sets the Id field's value.

func (*DeleteQuerySuggestionsBlockListInput) SetIndexId

func (s *DeleteQuerySuggestionsBlockListInput) SetIndexId(v string) *DeleteQuerySuggestionsBlockListInput

SetIndexId sets the IndexId field's value.

func (DeleteQuerySuggestionsBlockListInput) String

func (s DeleteQuerySuggestionsBlockListInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteQuerySuggestionsBlockListInput) Validate

func (s *DeleteQuerySuggestionsBlockListInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteQuerySuggestionsBlockListOutput

type DeleteQuerySuggestionsBlockListOutput struct {
    // contains filtered or unexported fields
}

func (DeleteQuerySuggestionsBlockListOutput) GoString

func (s DeleteQuerySuggestionsBlockListOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteQuerySuggestionsBlockListOutput) String

func (s DeleteQuerySuggestionsBlockListOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteThesaurusInput

type DeleteThesaurusInput struct {

    // The identifier of the thesaurus you want to delete.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index for the thesaurus.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteThesaurusInput) GoString

func (s DeleteThesaurusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThesaurusInput) SetId

func (s *DeleteThesaurusInput) SetId(v string) *DeleteThesaurusInput

SetId sets the Id field's value.

func (*DeleteThesaurusInput) SetIndexId

func (s *DeleteThesaurusInput) SetIndexId(v string) *DeleteThesaurusInput

SetIndexId sets the IndexId field's value.

func (DeleteThesaurusInput) String

func (s DeleteThesaurusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteThesaurusInput) Validate

func (s *DeleteThesaurusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteThesaurusOutput

type DeleteThesaurusOutput struct {
    // contains filtered or unexported fields
}

func (DeleteThesaurusOutput) GoString

func (s DeleteThesaurusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteThesaurusOutput) String

func (s DeleteThesaurusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccessControlConfigurationInput

type DescribeAccessControlConfigurationInput struct {

    // The identifier of the access control configuration you want to get information
    // on.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index for an access control configuration.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeAccessControlConfigurationInput) GoString

func (s DescribeAccessControlConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessControlConfigurationInput) SetId

func (s *DescribeAccessControlConfigurationInput) SetId(v string) *DescribeAccessControlConfigurationInput

SetId sets the Id field's value.

func (*DescribeAccessControlConfigurationInput) SetIndexId

func (s *DescribeAccessControlConfigurationInput) SetIndexId(v string) *DescribeAccessControlConfigurationInput

SetIndexId sets the IndexId field's value.

func (DescribeAccessControlConfigurationInput) String

func (s DescribeAccessControlConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessControlConfigurationInput) Validate

func (s *DescribeAccessControlConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccessControlConfigurationOutput

type DescribeAccessControlConfigurationOutput struct {

    // Information on principals (users and/or groups) and which documents they
    // should have access to. This is useful for user context filtering, where search
    // results are filtered based on the user or their group access to documents.
    AccessControlList []*Principal `type:"list"`

    // The description for the access control configuration.
    Description *string `type:"string"`

    // The error message containing details if there are issues processing the access
    // control configuration.
    ErrorMessage *string `min:"1" type:"string"`

    // The list of principal (https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html)
    // lists that define the hierarchy for which documents users should have access
    // to.
    HierarchicalAccessControlList []*HierarchicalPrincipal `min:"1" type:"list"`

    // The name for the access control configuration.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeAccessControlConfigurationOutput) GoString

func (s DescribeAccessControlConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessControlConfigurationOutput) SetAccessControlList

func (s *DescribeAccessControlConfigurationOutput) SetAccessControlList(v []*Principal) *DescribeAccessControlConfigurationOutput

SetAccessControlList sets the AccessControlList field's value.

func (*DescribeAccessControlConfigurationOutput) SetDescription

func (s *DescribeAccessControlConfigurationOutput) SetDescription(v string) *DescribeAccessControlConfigurationOutput

SetDescription sets the Description field's value.

func (*DescribeAccessControlConfigurationOutput) SetErrorMessage

func (s *DescribeAccessControlConfigurationOutput) SetErrorMessage(v string) *DescribeAccessControlConfigurationOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeAccessControlConfigurationOutput) SetHierarchicalAccessControlList

func (s *DescribeAccessControlConfigurationOutput) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *DescribeAccessControlConfigurationOutput

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*DescribeAccessControlConfigurationOutput) SetName

func (s *DescribeAccessControlConfigurationOutput) SetName(v string) *DescribeAccessControlConfigurationOutput

SetName sets the Name field's value.

func (DescribeAccessControlConfigurationOutput) String

func (s DescribeAccessControlConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDataSourceInput

type DescribeDataSourceInput struct {

    // The identifier of the data source connector.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index used with the data source connector.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeDataSourceInput) GoString

func (s DescribeDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataSourceInput) SetId

func (s *DescribeDataSourceInput) SetId(v string) *DescribeDataSourceInput

SetId sets the Id field's value.

func (*DescribeDataSourceInput) SetIndexId

func (s *DescribeDataSourceInput) SetIndexId(v string) *DescribeDataSourceInput

SetIndexId sets the IndexId field's value.

func (DescribeDataSourceInput) String

func (s DescribeDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataSourceInput) Validate

func (s *DescribeDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDataSourceOutput

type DescribeDataSourceOutput struct {

    // Configuration details for the data source connector. This shows how the data
    // source is configured. The configuration options for a data source depend
    // on the data source provider.
    Configuration *DataSourceConfiguration `type:"structure"`

    // The Unix timestamp of when the data source connector was created.
    CreatedAt *time.Time `type:"timestamp"`

    // Configuration information for altering document metadata and content during
    // the document ingestion process when you describe a data source.
    //
    // For more information on how to create, modify and delete document metadata,
    // or make other content alterations when you ingest documents into Amazon Kendra,
    // see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).
    CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"`

    // The description for the data source connector.
    Description *string `type:"string"`

    // When the Status field value is FAILED, the ErrorMessage field contains a
    // description of the error that caused the data source to fail.
    ErrorMessage *string `min:"1" type:"string"`

    // The identifier of the data source connector.
    Id *string `min:"1" type:"string"`

    // The identifier of the index used with the data source connector.
    IndexId *string `min:"36" type:"string"`

    // The code for a language. This shows a supported language for all documents
    // in the data source. English is supported by default. For more information
    // on supported languages, including their codes, see Adding documents in languages
    // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
    LanguageCode *string `min:"2" type:"string"`

    // The name for the data source connector.
    Name *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the role with permission to access the
    // data source and required resources.
    RoleArn *string `type:"string"`

    // The schedule for Amazon Kendra to update the index.
    Schedule *string `type:"string"`

    // The current status of the data source connector. When the status is ACTIVE
    // the data source is ready to use. When the status is FAILED, the ErrorMessage
    // field contains the reason that the data source failed.
    Status *string `type:"string" enum:"DataSourceStatus"`

    // The type of the data source. For example, SHAREPOINT.
    Type *string `type:"string" enum:"DataSourceType"`

    // The Unix timestamp of when the data source connector was last updated.
    UpdatedAt *time.Time `type:"timestamp"`

    // Configuration information for an Amazon Virtual Private Cloud to connect
    // to your data source. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
    VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeDataSourceOutput) GoString

func (s DescribeDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDataSourceOutput) SetConfiguration

func (s *DescribeDataSourceOutput) SetConfiguration(v *DataSourceConfiguration) *DescribeDataSourceOutput

SetConfiguration sets the Configuration field's value.

func (*DescribeDataSourceOutput) SetCreatedAt

func (s *DescribeDataSourceOutput) SetCreatedAt(v time.Time) *DescribeDataSourceOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeDataSourceOutput) SetCustomDocumentEnrichmentConfiguration

func (s *DescribeDataSourceOutput) SetCustomDocumentEnrichmentConfiguration(v *CustomDocumentEnrichmentConfiguration) *DescribeDataSourceOutput

SetCustomDocumentEnrichmentConfiguration sets the CustomDocumentEnrichmentConfiguration field's value.

func (*DescribeDataSourceOutput) SetDescription

func (s *DescribeDataSourceOutput) SetDescription(v string) *DescribeDataSourceOutput

SetDescription sets the Description field's value.

func (*DescribeDataSourceOutput) SetErrorMessage

func (s *DescribeDataSourceOutput) SetErrorMessage(v string) *DescribeDataSourceOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeDataSourceOutput) SetId

func (s *DescribeDataSourceOutput) SetId(v string) *DescribeDataSourceOutput

SetId sets the Id field's value.

func (*DescribeDataSourceOutput) SetIndexId

func (s *DescribeDataSourceOutput) SetIndexId(v string) *DescribeDataSourceOutput

SetIndexId sets the IndexId field's value.

func (*DescribeDataSourceOutput) SetLanguageCode

func (s *DescribeDataSourceOutput) SetLanguageCode(v string) *DescribeDataSourceOutput

SetLanguageCode sets the LanguageCode field's value.

func (*DescribeDataSourceOutput) SetName

func (s *DescribeDataSourceOutput) SetName(v string) *DescribeDataSourceOutput

SetName sets the Name field's value.

func (*DescribeDataSourceOutput) SetRoleArn

func (s *DescribeDataSourceOutput) SetRoleArn(v string) *DescribeDataSourceOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeDataSourceOutput) SetSchedule

func (s *DescribeDataSourceOutput) SetSchedule(v string) *DescribeDataSourceOutput

SetSchedule sets the Schedule field's value.

func (*DescribeDataSourceOutput) SetStatus

func (s *DescribeDataSourceOutput) SetStatus(v string) *DescribeDataSourceOutput

SetStatus sets the Status field's value.

func (*DescribeDataSourceOutput) SetType

func (s *DescribeDataSourceOutput) SetType(v string) *DescribeDataSourceOutput

SetType sets the Type field's value.

func (*DescribeDataSourceOutput) SetUpdatedAt

func (s *DescribeDataSourceOutput) SetUpdatedAt(v time.Time) *DescribeDataSourceOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (*DescribeDataSourceOutput) SetVpcConfiguration

func (s *DescribeDataSourceOutput) SetVpcConfiguration(v *DataSourceVpcConfiguration) *DescribeDataSourceOutput

SetVpcConfiguration sets the VpcConfiguration field's value.

func (DescribeDataSourceOutput) String

func (s DescribeDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeExperienceInput

type DescribeExperienceInput struct {

    // The identifier of your Amazon Kendra experience you want to get information
    // on.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index for your Amazon Kendra experience.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeExperienceInput) GoString

func (s DescribeExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExperienceInput) SetId

func (s *DescribeExperienceInput) SetId(v string) *DescribeExperienceInput

SetId sets the Id field's value.

func (*DescribeExperienceInput) SetIndexId

func (s *DescribeExperienceInput) SetIndexId(v string) *DescribeExperienceInput

SetIndexId sets the IndexId field's value.

func (DescribeExperienceInput) String

func (s DescribeExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExperienceInput) Validate

func (s *DescribeExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeExperienceOutput

type DescribeExperienceOutput struct {

    // Shows the configuration information for your Amazon Kendra experience. This
    // includes ContentSourceConfiguration, which specifies the data source IDs
    // and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or
    // group information to grant access to your Amazon Kendra experience.
    Configuration *ExperienceConfiguration `type:"structure"`

    // Shows the date-time your Amazon Kendra experience was created.
    CreatedAt *time.Time `type:"timestamp"`

    // Shows the description for your Amazon Kendra experience.
    Description *string `type:"string"`

    // Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are
    // unique and fully hosted by Amazon Web Services.
    Endpoints []*ExperienceEndpoint `min:"1" type:"list"`

    // The reason your Amazon Kendra experience could not properly process.
    ErrorMessage *string `min:"1" type:"string"`

    // Shows the identifier of your Amazon Kendra experience.
    Id *string `min:"1" type:"string"`

    // Shows the identifier of the index for your Amazon Kendra experience.
    IndexId *string `min:"36" type:"string"`

    // Shows the name of your Amazon Kendra experience.
    Name *string `min:"1" type:"string"`

    // Shows the Amazon Resource Name (ARN) of a role with permission to access
    // Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center
    // that stores your user and group information.
    RoleArn *string `type:"string"`

    // The current processing status of your Amazon Kendra experience. When the
    // status is ACTIVE, your Amazon Kendra experience is ready to use. When the
    // status is FAILED, the ErrorMessage field contains the reason that this failed.
    Status *string `type:"string" enum:"ExperienceStatus"`

    // Shows the date-time your Amazon Kendra experience was last updated.
    UpdatedAt *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

func (DescribeExperienceOutput) GoString

func (s DescribeExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeExperienceOutput) SetConfiguration

func (s *DescribeExperienceOutput) SetConfiguration(v *ExperienceConfiguration) *DescribeExperienceOutput

SetConfiguration sets the Configuration field's value.

func (*DescribeExperienceOutput) SetCreatedAt

func (s *DescribeExperienceOutput) SetCreatedAt(v time.Time) *DescribeExperienceOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeExperienceOutput) SetDescription

func (s *DescribeExperienceOutput) SetDescription(v string) *DescribeExperienceOutput

SetDescription sets the Description field's value.

func (*DescribeExperienceOutput) SetEndpoints

func (s *DescribeExperienceOutput) SetEndpoints(v []*ExperienceEndpoint) *DescribeExperienceOutput

SetEndpoints sets the Endpoints field's value.

func (*DescribeExperienceOutput) SetErrorMessage

func (s *DescribeExperienceOutput) SetErrorMessage(v string) *DescribeExperienceOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeExperienceOutput) SetId

func (s *DescribeExperienceOutput) SetId(v string) *DescribeExperienceOutput

SetId sets the Id field's value.

func (*DescribeExperienceOutput) SetIndexId

func (s *DescribeExperienceOutput) SetIndexId(v string) *DescribeExperienceOutput

SetIndexId sets the IndexId field's value.

func (*DescribeExperienceOutput) SetName

func (s *DescribeExperienceOutput) SetName(v string) *DescribeExperienceOutput

SetName sets the Name field's value.

func (*DescribeExperienceOutput) SetRoleArn

func (s *DescribeExperienceOutput) SetRoleArn(v string) *DescribeExperienceOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeExperienceOutput) SetStatus

func (s *DescribeExperienceOutput) SetStatus(v string) *DescribeExperienceOutput

SetStatus sets the Status field's value.

func (*DescribeExperienceOutput) SetUpdatedAt

func (s *DescribeExperienceOutput) SetUpdatedAt(v time.Time) *DescribeExperienceOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (DescribeExperienceOutput) String

func (s DescribeExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFaqInput

type DescribeFaqInput struct {

    // The identifier of the FAQ you want to get information on.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index for the FAQ.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeFaqInput) GoString

func (s DescribeFaqInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFaqInput) SetId

func (s *DescribeFaqInput) SetId(v string) *DescribeFaqInput

SetId sets the Id field's value.

func (*DescribeFaqInput) SetIndexId

func (s *DescribeFaqInput) SetIndexId(v string) *DescribeFaqInput

SetIndexId sets the IndexId field's value.

func (DescribeFaqInput) String

func (s DescribeFaqInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFaqInput) Validate

func (s *DescribeFaqInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFaqOutput

type DescribeFaqOutput struct {

    // The 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 for the FAQ.
    IndexId *string `min:"36" type:"string"`

    // The code for a language. This shows a supported language for the FAQ document.
    // English is supported by default. For more information on supported languages,
    // including their codes, see Adding documents in languages other than English
    // (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
    LanguageCode *string `min:"2" type:"string"`

    // The name that you gave the FAQ when it was created.
    Name *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the role that provides access to the S3
    // bucket containing the input files for the FAQ.
    RoleArn *string `type:"string"`

    // Information required to find a specific file in an Amazon S3 bucket.
    S3Path *S3Path `type:"structure"`

    // The status of the FAQ. It is ready to use when the status is ACTIVE.
    Status *string `type:"string" enum:"FaqStatus"`

    // The 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 identifier of the index you want to get information on.
    //
    // Id is a required field
    Id *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeIndexInput) GoString

func (s DescribeIndexInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIndexInput) SetId

func (s *DescribeIndexInput) SetId(v string) *DescribeIndexInput

SetId sets the Id field's value.

func (DescribeIndexInput) String

func (s DescribeIndexInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIndexInput) Validate

func (s *DescribeIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeIndexOutput

type DescribeIndexOutput struct {

    // For Enterprise Edition indexes, you can choose to use additional capacity
    // to meet the needs of your application. This contains the capacity units used
    // for the index. A query or document storage capacity of zero indicates that
    // the index is using the default capacity. For more information on the default
    // capacity for an index and adjusting this, see Adjusting capacity (https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html).
    CapacityUnits *CapacityUnitsConfiguration `type:"structure"`

    // The Unix datetime that the index was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The description for the index.
    Description *string `type:"string"`

    // Configuration information for document metadata or fields. Document metadata
    // are fields or attributes associated with your documents. For example, the
    // company department name associated with each document.
    DocumentMetadataConfigurations []*DocumentMetadataConfiguration `type:"list"`

    // The Amazon Kendra edition used for the index. You decide the edition when
    // you create the index.
    Edition *string `type:"string" enum:"IndexEdition"`

    // When the Status field value is FAILED, the ErrorMessage field contains a
    // message that explains why.
    ErrorMessage *string `min:"1" type:"string"`

    // The identifier of the index.
    Id *string `min:"36" type:"string"`

    // Provides information about the number of FAQ questions and answers and the
    // number of text documents indexed.
    IndexStatistics *IndexStatistics `type:"structure"`

    // The name of the index.
    Name *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission
    // to write to your Amazon Cloudwatch logs.
    RoleArn *string `type:"string"`

    // The identifier of the KMScustomer master key (CMK) that is used to encrypt
    // your data. Amazon Kendra doesn't support asymmetric CMKs.
    ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"`

    // The current status of the index. When the value is ACTIVE, the index is ready
    // for use. If the Status field value is FAILED, the ErrorMessage field contains
    // a message that explains why.
    Status *string `type:"string" enum:"IndexStatus"`

    // The Unix 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"`

    // Whether you have enabled the configuration for fetching access levels of
    // groups and users from an IAM Identity Center (successor to 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 identifier of the block list you want to get information on.
    //
    // Id is a required field
    Id *string `min:"36" type:"string" required:"true"`

    // The identifier of the index for the block list.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeQuerySuggestionsBlockListInput) GoString

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 {

    // The date-time a block list for query suggestions was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The description for the block list.
    Description *string `type:"string"`

    // The error message containing details if there are issues processing the block
    // list.
    ErrorMessage *string `min:"1" type:"string"`

    // The current size of the block list text file in S3.
    FileSizeBytes *int64 `type:"long"`

    // The identifier of the block list.
    Id *string `min:"36" type:"string"`

    // The identifier of the index for the block list.
    IndexId *string `min:"36" type:"string"`

    // The current number of valid, non-empty words or phrases in the block list
    // text file.
    ItemCount *int64 `type:"integer"`

    // The name of the block list.
    Name *string `min:"1" type:"string"`

    // The IAM (Identity and Access Management) role used by Amazon Kendra to access
    // the block list text file in S3.
    //
    // The role needs S3 read permissions to your file in S3 and needs to give STS
    // (Security Token Service) assume role permissions to Amazon Kendra.
    RoleArn *string `type:"string"`

    // Shows the current S3 path to your block list text file in your S3 bucket.
    //
    // Each block word or phrase should be on a separate line in a text file.
    //
    // For information on the current quota limits for block lists, see Quotas for
    // Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
    SourceS3Path *S3Path `type:"structure"`

    // The current status of the block list. When the value is ACTIVE, the block
    // list is ready for use.
    Status *string `type:"string" enum:"QuerySuggestionsBlockListStatus"`

    // The 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 with query suggestions that you want to get information
    // on.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeQuerySuggestionsConfigInput) GoString

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 {

    // TRUE to use all queries, otherwise use only queries that include user information
    // to generate the query suggestions.
    IncludeQueriesWithoutUserInformation *bool `type:"boolean"`

    // 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"`

    // The date-time query suggestions for an index was last updated.
    LastSuggestionsBuildTime *time.Time `type:"timestamp"`

    // The minimum number of unique users who must search a query in order for the
    // query to be eligible to suggest to your users.
    MinimumNumberOfQueryingUsers *int64 `min:"1" type:"integer"`

    // The minimum number of times a query must be searched in order for the query
    // to be eligible to suggest to your users.
    MinimumQueryCount *int64 `min:"1" type:"integer"`

    // Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
    //
    // By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off
    // query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig
    // (https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html)
    // API.
    Mode *string `type:"string" enum:"Mode"`

    // How recent your queries are in your query log time window (in days).
    QueryLogLookBackWindowInDays *int64 `type:"integer"`

    // Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
    //
    // Active means the current settings apply and Updating means your changed settings
    // are in the process of applying.
    Status *string `type:"string" enum:"QuerySuggestionsStatus"`

    // The current total count of query suggestions for an index.
    //
    // This count can change when you update your query suggestions settings, if
    // you filter out certain queries from suggestions using a block list, and as
    // the query log accumulates more queries for Amazon Kendra to learn from.
    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 you want to get information on.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index for the thesaurus.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeThesaurusInput) GoString

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 for the thesaurus.
    IndexId *string `min:"36" type:"string"`

    // The thesaurus name.
    Name *string `min:"1" type:"string"`

    // An IAM role that gives Amazon Kendra permissions to access thesaurus file
    // specified in SourceS3Path.
    RoleArn *string `type:"string"`

    // Information required to find a specific file in an Amazon S3 bucket.
    SourceS3Path *S3Path `type:"structure"`

    // The current status of the thesaurus. When the value is ACTIVE, queries are
    // able to use the thesaurus. If the Status field value is FAILED, the ErrorMessage
    // field provides more information.
    //
    // If the status is ACTIVE_BUT_UPDATE_FAILED, it means that Amazon Kendra could
    // not ingest the new thesaurus file. The old thesaurus file is still active.
    Status *string `type:"string" enum:"ThesaurusStatus"`

    // The number of synonym rules in the thesaurus file.
    SynonymRuleCount *int64 `type:"long"`

    // The number of unique terms in the thesaurus file. For example, the synonyms
    // a,b,c and a=>d, the term count would be 4.
    TermCount *int64 `type:"long"`

    // The Unix 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 DisassociateEntitiesFromExperienceInput

type DisassociateEntitiesFromExperienceInput struct {

    // Lists users or groups in your IAM Identity Center identity source.
    //
    // EntityList is a required field
    EntityList []*EntityConfiguration `min:"1" type:"list" required:"true"`

    // The identifier of your Amazon Kendra experience.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index for your Amazon Kendra experience.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DisassociateEntitiesFromExperienceInput) GoString

func (s DisassociateEntitiesFromExperienceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateEntitiesFromExperienceInput) SetEntityList

func (s *DisassociateEntitiesFromExperienceInput) SetEntityList(v []*EntityConfiguration) *DisassociateEntitiesFromExperienceInput

SetEntityList sets the EntityList field's value.

func (*DisassociateEntitiesFromExperienceInput) SetId

func (s *DisassociateEntitiesFromExperienceInput) SetId(v string) *DisassociateEntitiesFromExperienceInput

SetId sets the Id field's value.

func (*DisassociateEntitiesFromExperienceInput) SetIndexId

func (s *DisassociateEntitiesFromExperienceInput) SetIndexId(v string) *DisassociateEntitiesFromExperienceInput

SetIndexId sets the IndexId field's value.

func (DisassociateEntitiesFromExperienceInput) String

func (s DisassociateEntitiesFromExperienceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateEntitiesFromExperienceInput) Validate

func (s *DisassociateEntitiesFromExperienceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateEntitiesFromExperienceOutput

type DisassociateEntitiesFromExperienceOutput struct {

    // Lists the users or groups in your IAM Identity Center identity source that
    // failed to properly remove access to your Amazon Kendra experience.
    FailedEntityList []*FailedEntity `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (DisassociateEntitiesFromExperienceOutput) GoString

func (s DisassociateEntitiesFromExperienceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateEntitiesFromExperienceOutput) SetFailedEntityList

func (s *DisassociateEntitiesFromExperienceOutput) SetFailedEntityList(v []*FailedEntity) *DisassociateEntitiesFromExperienceOutput

SetFailedEntityList sets the FailedEntityList field's value.

func (DisassociateEntitiesFromExperienceOutput) String

func (s DisassociateEntitiesFromExperienceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociatePersonasFromEntitiesInput

type DisassociatePersonasFromEntitiesInput struct {

    // The identifiers of users or groups in your IAM Identity Center identity source.
    // For example, user IDs could be user emails.
    //
    // EntityIds is a required field
    EntityIds []*string `min:"1" type:"list" required:"true"`

    // The identifier of your Amazon Kendra experience.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // The identifier of the index for your Amazon Kendra experience.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DisassociatePersonasFromEntitiesInput) GoString

func (s DisassociatePersonasFromEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociatePersonasFromEntitiesInput) SetEntityIds

func (s *DisassociatePersonasFromEntitiesInput) SetEntityIds(v []*string) *DisassociatePersonasFromEntitiesInput

SetEntityIds sets the EntityIds field's value.

func (*DisassociatePersonasFromEntitiesInput) SetId

func (s *DisassociatePersonasFromEntitiesInput) SetId(v string) *DisassociatePersonasFromEntitiesInput

SetId sets the Id field's value.

func (*DisassociatePersonasFromEntitiesInput) SetIndexId

func (s *DisassociatePersonasFromEntitiesInput) SetIndexId(v string) *DisassociatePersonasFromEntitiesInput

SetIndexId sets the IndexId field's value.

func (DisassociatePersonasFromEntitiesInput) String

func (s DisassociatePersonasFromEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociatePersonasFromEntitiesInput) Validate

func (s *DisassociatePersonasFromEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociatePersonasFromEntitiesOutput

type DisassociatePersonasFromEntitiesOutput struct {

    // Lists the users or groups in your IAM Identity Center identity source that
    // failed to properly remove access to your Amazon Kendra experience.
    FailedEntityList []*FailedEntity `min:"1" type:"list"`
    // contains filtered or unexported fields
}

func (DisassociatePersonasFromEntitiesOutput) GoString

func (s DisassociatePersonasFromEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociatePersonasFromEntitiesOutput) SetFailedEntityList

func (s *DisassociatePersonasFromEntitiesOutput) SetFailedEntityList(v []*FailedEntity) *DisassociatePersonasFromEntitiesOutput

SetFailedEntityList sets the FailedEntityList field's value.

func (DisassociatePersonasFromEntitiesOutput) String

func (s DisassociatePersonasFromEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Document

type Document struct {

    // The identifier of the access control configuration that you want to apply
    // to the document.
    AccessControlConfigurationId *string `min:"1" type:"string"`

    // Information on principals (users and/or groups) and which documents they
    // should have access to. This is useful for user context filtering, where search
    // results are filtered based on the user or their group access to documents.
    AccessControlList []*Principal `type:"list"`

    // Custom attributes to apply to the document. Use the custom attributes to
    // provide additional information for searching, to provide facets for refining
    // searches, and to provide additional information in the query response.
    //
    // For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
    // that provide information on the synchronization of documents running on a
    // data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute
    // as Amazon Kendra will use the ID of a running sync job.
    Attributes []*DocumentAttribute `type:"list"`

    // The contents of the document.
    //
    // Documents passed to the Blob parameter must be base64 encoded. Your code
    // might not need to encode the document file bytes if you're using an Amazon
    // Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon
    // Kendra endpoint directly using REST, you must base64 encode the contents
    // before sending.
    // Blob is automatically base64 encoded/decoded by the SDK.
    Blob []byte `type:"blob"`

    // The file type of the document in the Blob field.
    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.
    //
    // Note, each document ID must be unique per index. You cannot create a data
    // source to index your documents with their unique IDs and then use the BatchPutDocument
    // API to index the same documents, or vice versa. You can delete a data source
    // and then use the BatchPutDocument API to index the same documents, or vice
    // versa.
    //
    // Id is a required field
    Id *string `min:"1" type:"string" required:"true"`

    // Information required to find a specific file in an Amazon S3 bucket.
    S3Path *S3Path `type:"structure"`

    // The title of the document.
    Title *string `type:"string"`
    // contains filtered or unexported fields
}

A document in an index.

func (Document) GoString

func (s Document) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Document) SetAccessControlConfigurationId

func (s *Document) SetAccessControlConfigurationId(v string) *Document

SetAccessControlConfigurationId sets the AccessControlConfigurationId field's value.

func (*Document) SetAccessControlList

func (s *Document) SetAccessControlList(v []*Principal) *Document

SetAccessControlList sets the AccessControlList field's value.

func (*Document) SetAttributes

func (s *Document) SetAttributes(v []*DocumentAttribute) *Document

SetAttributes sets the Attributes field's value.

func (*Document) SetBlob

func (s *Document) SetBlob(v []byte) *Document

SetBlob sets the Blob field's value.

func (*Document) SetContentType

func (s *Document) SetContentType(v string) *Document

SetContentType sets the ContentType field's value.

func (*Document) SetHierarchicalAccessControlList

func (s *Document) SetHierarchicalAccessControlList(v []*HierarchicalPrincipal) *Document

SetHierarchicalAccessControlList sets the HierarchicalAccessControlList field's value.

func (*Document) SetId

func (s *Document) SetId(v string) *Document

SetId sets the Id field's value.

func (*Document) SetS3Path

func (s *Document) SetS3Path(v *S3Path) *Document

SetS3Path sets the S3Path field's value.

func (*Document) SetTitle

func (s *Document) SetTitle(v string) *Document

SetTitle sets the Title field's value.

func (Document) String

func (s Document) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Document) Validate

func (s *Document) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttribute

type DocumentAttribute struct {

    // The identifier for the attribute.
    //
    // Key is a required field
    Key *string `min:"1" type:"string" required:"true"`

    // The value of the attribute.
    //
    // Value is a required field
    Value *DocumentAttributeValue `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

A document attribute or metadata field. To create custom document attributes, see Custom attributes (https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html).

func (DocumentAttribute) GoString

func (s DocumentAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttribute) SetKey

func (s *DocumentAttribute) SetKey(v string) *DocumentAttribute

SetKey sets the Key field's value.

func (*DocumentAttribute) SetValue

func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute

SetValue sets the Value field's value.

func (DocumentAttribute) String

func (s DocumentAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttribute) Validate

func (s *DocumentAttribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeCondition

type DocumentAttributeCondition struct {

    // The identifier of the document attribute used for the condition.
    //
    // For example, 'Source_URI' could be an identifier for the attribute or metadata
    // field that contains source URIs associated with the documents.
    //
    // Amazon Kendra currently does not support _document_body as an attribute key
    // used for the condition.
    //
    // ConditionDocumentAttributeKey is a required field
    ConditionDocumentAttributeKey *string `min:"1" type:"string" required:"true"`

    // The value used by the operator.
    //
    // For example, you can specify the value 'financial' for strings in the 'Source_URI'
    // field that partially match or contain this value.
    ConditionOnValue *DocumentAttributeValue `type:"structure"`

    // The condition operator.
    //
    // For example, you can use 'Contains' to partially match a string.
    //
    // Operator is a required field
    Operator *string `type:"string" required:"true" enum:"ConditionOperator"`
    // contains filtered or unexported fields
}

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. You use this with DocumentAttributeTarget to apply the condition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html).

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

func (DocumentAttributeCondition) GoString

func (s DocumentAttributeCondition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeCondition) SetConditionDocumentAttributeKey

func (s *DocumentAttributeCondition) SetConditionDocumentAttributeKey(v string) *DocumentAttributeCondition

SetConditionDocumentAttributeKey sets the ConditionDocumentAttributeKey field's value.

func (*DocumentAttributeCondition) SetConditionOnValue

func (s *DocumentAttributeCondition) SetConditionOnValue(v *DocumentAttributeValue) *DocumentAttributeCondition

SetConditionOnValue sets the ConditionOnValue field's value.

func (*DocumentAttributeCondition) SetOperator

func (s *DocumentAttributeCondition) SetOperator(v string) *DocumentAttributeCondition

SetOperator sets the Operator field's value.

func (DocumentAttributeCondition) String

func (s DocumentAttributeCondition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeCondition) Validate

func (s *DocumentAttributeCondition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeTarget

type DocumentAttributeTarget struct {

    // The identifier of the target document attribute or metadata field.
    //
    // For example, 'Department' could be an identifier for the target attribute
    // or metadata field that includes the department names associated with the
    // documents.
    TargetDocumentAttributeKey *string `min:"1" type:"string"`

    // The target value you want to create for the target attribute.
    //
    // For example, 'Finance' could be the target value for the target attribute
    // key 'Department'.
    TargetDocumentAttributeValue *DocumentAttributeValue `type:"structure"`

    // TRUE to delete the existing target value for your specified target attribute
    // key. You cannot create a target value and set this to TRUE. To create a target
    // value (TargetDocumentAttributeValue), set this to FALSE.
    TargetDocumentAttributeValueDeletion *bool `type:"boolean"`
    // contains filtered or unexported fields
}

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Kendra cannot create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Kendra then will map your newly created metadata field to your index field.

You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeCondition.html).

func (DocumentAttributeTarget) GoString

func (s DocumentAttributeTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeTarget) SetTargetDocumentAttributeKey

func (s *DocumentAttributeTarget) SetTargetDocumentAttributeKey(v string) *DocumentAttributeTarget

SetTargetDocumentAttributeKey sets the TargetDocumentAttributeKey field's value.

func (*DocumentAttributeTarget) SetTargetDocumentAttributeValue

func (s *DocumentAttributeTarget) SetTargetDocumentAttributeValue(v *DocumentAttributeValue) *DocumentAttributeTarget

SetTargetDocumentAttributeValue sets the TargetDocumentAttributeValue field's value.

func (*DocumentAttributeTarget) SetTargetDocumentAttributeValueDeletion

func (s *DocumentAttributeTarget) SetTargetDocumentAttributeValueDeletion(v bool) *DocumentAttributeTarget

SetTargetDocumentAttributeValueDeletion sets the TargetDocumentAttributeValueDeletion field's value.

func (DocumentAttributeTarget) String

func (s DocumentAttributeTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeTarget) Validate

func (s *DocumentAttributeTarget) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeValue

type DocumentAttributeValue struct {

    // A date expressed as an ISO 8601 string.
    //
    // It is important for the time zone to be included in the ISO 8601 date-time
    // format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time
    // format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European
    // Time.
    DateValue *time.Time `type:"timestamp"`

    // A long integer value.
    LongValue *int64 `type:"long"`

    // A list of strings.
    StringListValue []*string `type:"list"`

    // A string, such as "department".
    StringValue *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

The value of a document attribute. You can only provide one value for a document attribute.

func (DocumentAttributeValue) GoString

func (s DocumentAttributeValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeValue) SetDateValue

func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue

SetDateValue sets the DateValue field's value.

func (*DocumentAttributeValue) SetLongValue

func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue

SetLongValue sets the LongValue field's value.

func (*DocumentAttributeValue) SetStringListValue

func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue

SetStringListValue sets the StringListValue field's value.

func (*DocumentAttributeValue) SetStringValue

func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue

SetStringValue sets the StringValue field's value.

func (DocumentAttributeValue) String

func (s DocumentAttributeValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentAttributeValue) Validate

func (s *DocumentAttributeValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentAttributeValueCountPair

type DocumentAttributeValueCountPair struct {

    // The number of documents in the response that have the attribute value for
    // the key.
    Count *int64 `type:"integer"`

    // The value of the attribute. For example, "HR".
    DocumentAttributeValue *DocumentAttributeValue `type:"structure"`

    // Contains the results of a document attribute that is a nested facet. A FacetResult
    // contains the counts for each facet nested within a facet.
    //
    // For example, the document attribute or facet "Department" includes a value
    // called "Engineering". In addition, the document attribute or facet "SubDepartment"
    // includes the values "Frontend" and "Backend" for documents assigned to "Engineering".
    // You can display nested facets in the search results so that documents can
    // be searched not only by department but also by a sub department within a
    // department. The counts for documents that belong to "Frontend" and "Backend"
    // within "Engineering" are returned for a query.
    FacetResults []*FacetResult `type:"list"`
    // contains filtered or unexported fields
}

Provides the count of documents that match a particular 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) SetFacetResults

func (s *DocumentAttributeValueCountPair) SetFacetResults(v []*FacetResult) *DocumentAttributeValueCountPair

SetFacetResults sets the FacetResults field's value.

func (DocumentAttributeValueCountPair) String

func (s DocumentAttributeValueCountPair) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocumentInfo

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 tuning parameters to determine how the field affects the search
    // results.
    Relevance *Relevance `type:"structure"`

    // Provides information about how the field is used during a search.
    Search *Search `type:"structure"`

    // The data type of the index field.
    //
    // Type is a required field
    Type *string `type:"string" required:"true" enum:"DocumentAttributeValueType"`
    // contains filtered or unexported fields
}

Specifies the properties, such as relevance tuning and searchability, of an index field.

func (DocumentMetadataConfiguration) GoString

func (s DocumentMetadataConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentMetadataConfiguration) SetName

func (s *DocumentMetadataConfiguration) SetName(v string) *DocumentMetadataConfiguration

SetName sets the Name field's value.

func (*DocumentMetadataConfiguration) SetRelevance

func (s *DocumentMetadataConfiguration) SetRelevance(v *Relevance) *DocumentMetadataConfiguration

SetRelevance sets the Relevance field's value.

func (*DocumentMetadataConfiguration) SetSearch

func (s *DocumentMetadataConfiguration) SetSearch(v *Search) *DocumentMetadataConfiguration

SetSearch sets the Search field's value.

func (*DocumentMetadataConfiguration) SetType

func (s *DocumentMetadataConfiguration) SetType(v string) *DocumentMetadataConfiguration

SetType sets the Type field's value.

func (DocumentMetadataConfiguration) String

func (s DocumentMetadataConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DocumentMetadataConfiguration) Validate

func (s *DocumentMetadataConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DocumentRelevanceConfiguration

type DocumentRelevanceConfiguration struct {

    // The name of the index field.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // Provides information for tuning the relevance of a field in a search. When
    // a query includes terms that match the field, the results are given a boost
    // in the response based on these tuning parameters.
    //
    // Relevance is a required field
    Relevance *Relevance `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Overrides the document relevance properties of a custom index field.

func (DocumentRelevanceConfiguration) GoString

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 EntityConfiguration

type EntityConfiguration struct {

    // The identifier of a user or group in your IAM Identity Center identity source.
    // For example, a user ID could be an email.
    //
    // EntityId is a required field
    EntityId *string `min:"1" type:"string" required:"true"`

    // Specifies whether you are configuring a User or a Group.
    //
    // EntityType is a required field
    EntityType *string `type:"string" required:"true" enum:"EntityType"`
    // contains filtered or unexported fields
}

Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.

func (EntityConfiguration) GoString

func (s EntityConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityConfiguration) SetEntityId

func (s *EntityConfiguration) SetEntityId(v string) *EntityConfiguration

SetEntityId sets the EntityId field's value.

func (*EntityConfiguration) SetEntityType

func (s *EntityConfiguration) SetEntityType(v string) *EntityConfiguration

SetEntityType sets the EntityType field's value.

func (EntityConfiguration) String

func (s EntityConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityConfiguration) Validate

func (s *EntityConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EntityDisplayData

type EntityDisplayData struct {

    // The first name of the user.
    //
    // FirstName is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by EntityDisplayData's
    // String and GoString methods.
    FirstName *string `min:"1" type:"string" sensitive:"true"`

    // The name of the group.
    //
    // GroupName is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by EntityDisplayData's
    // String and GoString methods.
    GroupName *string `min:"1" type:"string" sensitive:"true"`

    // The user name of the user.
    //
    // IdentifiedUserName is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by EntityDisplayData's
    // String and GoString methods.
    IdentifiedUserName *string `min:"1" type:"string" sensitive:"true"`

    // The last name of the user.
    //
    // LastName is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by EntityDisplayData's
    // String and GoString methods.
    LastName *string `min:"1" type:"string" sensitive:"true"`

    // The name of the user.
    //
    // UserName is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by EntityDisplayData's
    // String and GoString methods.
    UserName *string `min:"1" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

Information about the user entity.

func (EntityDisplayData) GoString

func (s EntityDisplayData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityDisplayData) SetFirstName

func (s *EntityDisplayData) SetFirstName(v string) *EntityDisplayData

SetFirstName sets the FirstName field's value.

func (*EntityDisplayData) SetGroupName

func (s *EntityDisplayData) SetGroupName(v string) *EntityDisplayData

SetGroupName sets the GroupName field's value.

func (*EntityDisplayData) SetIdentifiedUserName

func (s *EntityDisplayData) SetIdentifiedUserName(v string) *EntityDisplayData

SetIdentifiedUserName sets the IdentifiedUserName field's value.

func (*EntityDisplayData) SetLastName

func (s *EntityDisplayData) SetLastName(v string) *EntityDisplayData

SetLastName sets the LastName field's value.

func (*EntityDisplayData) SetUserName

func (s *EntityDisplayData) SetUserName(v string) *EntityDisplayData

SetUserName sets the UserName field's value.

func (EntityDisplayData) String

func (s EntityDisplayData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EntityPersonaConfiguration

type EntityPersonaConfiguration struct {

    // The identifier of a user or group in your IAM Identity Center identity source.
    // For example, a user ID could be an email.
    //
    // EntityId is a required field
    EntityId *string `min:"1" type:"string" required:"true"`

    // The persona that defines the specific permissions of the user or group in
    // your IAM Identity Center identity source. The available personas or access
    // roles are Owner and Viewer. For more information on these personas, see Providing
    // access to your search page (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience).
    //
    // Persona is a required field
    Persona *string `type:"string" required:"true" enum:"Persona"`
    // contains filtered or unexported fields
}

Provides the configuration information for users or groups in your IAM Identity Center identity source for access to your Amazon Kendra experience. Specific permissions are defined for each user or group once they are granted access to your Amazon Kendra experience.

func (EntityPersonaConfiguration) GoString

func (s EntityPersonaConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityPersonaConfiguration) SetEntityId

func (s *EntityPersonaConfiguration) SetEntityId(v string) *EntityPersonaConfiguration

SetEntityId sets the EntityId field's value.

func (*EntityPersonaConfiguration) SetPersona

func (s *EntityPersonaConfiguration) SetPersona(v string) *EntityPersonaConfiguration

SetPersona sets the Persona field's value.

func (EntityPersonaConfiguration) String

func (s EntityPersonaConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EntityPersonaConfiguration) Validate

func (s *EntityPersonaConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExperienceConfiguration

type ExperienceConfiguration struct {

    // The identifiers of your data sources and FAQs. Or, you can specify that you
    // want to use documents indexed via the BatchPutDocument API. This is the content
    // you want to use for your Amazon Kendra experience.
    ContentSourceConfiguration *ContentSourceConfiguration `type:"structure"`

    // The IAM Identity Center field name that contains the identifiers of your
    // users, such as their emails.
    UserIdentityConfiguration *UserIdentityConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

Provides the configuration information for your Amazon Kendra experience. This includes the data source IDs and/or FAQ IDs, and user or group information to grant access to your Amazon Kendra experience.

func (ExperienceConfiguration) GoString

func (s ExperienceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceConfiguration) SetContentSourceConfiguration

func (s *ExperienceConfiguration) SetContentSourceConfiguration(v *ContentSourceConfiguration) *ExperienceConfiguration

SetContentSourceConfiguration sets the ContentSourceConfiguration field's value.

func (*ExperienceConfiguration) SetUserIdentityConfiguration

func (s *ExperienceConfiguration) SetUserIdentityConfiguration(v *UserIdentityConfiguration) *ExperienceConfiguration

SetUserIdentityConfiguration sets the UserIdentityConfiguration field's value.

func (ExperienceConfiguration) String

func (s ExperienceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceConfiguration) Validate

func (s *ExperienceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExperienceEndpoint

type ExperienceEndpoint struct {

    // The endpoint of your Amazon Kendra experience.
    Endpoint *string `min:"1" type:"string"`

    // The type of endpoint for your Amazon Kendra experience. The type currently
    // available is HOME, which is a unique and fully hosted URL to the home page
    // of your Amazon Kendra experience.
    EndpointType *string `type:"string" enum:"EndpointType"`
    // contains filtered or unexported fields
}

Provides the configuration information for the endpoint for your Amazon Kendra experience.

func (ExperienceEndpoint) GoString

func (s ExperienceEndpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceEndpoint) SetEndpoint

func (s *ExperienceEndpoint) SetEndpoint(v string) *ExperienceEndpoint

SetEndpoint sets the Endpoint field's value.

func (*ExperienceEndpoint) SetEndpointType

func (s *ExperienceEndpoint) SetEndpointType(v string) *ExperienceEndpoint

SetEndpointType sets the EndpointType field's value.

func (ExperienceEndpoint) String

func (s ExperienceEndpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExperienceEntitiesSummary

type ExperienceEntitiesSummary struct {

    // Information about the user entity.
    DisplayData *EntityDisplayData `type:"structure"`

    // The identifier of a user or group in your IAM Identity Center identity source.
    // For example, a user ID could be an email.
    EntityId *string `min:"1" type:"string"`

    // Shows the type as User or Group.
    EntityType *string `type:"string" enum:"EntityType"`
    // contains filtered or unexported fields
}

Summary information for users or groups in your IAM Identity Center identity source with granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

func (ExperienceEntitiesSummary) GoString

func (s ExperienceEntitiesSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperienceEntitiesSummary) SetDisplayData

func (s *ExperienceEntitiesSummary) SetDisplayData(v *EntityDisplayData) *ExperienceEntitiesSummary

SetDisplayData sets the DisplayData field's value.

func (*ExperienceEntitiesSummary) SetEntityId

func (s *ExperienceEntitiesSummary) SetEntityId(v string) *ExperienceEntitiesSummary

SetEntityId sets the EntityId field's value.

func (*ExperienceEntitiesSummary) SetEntityType

func (s *ExperienceEntitiesSummary) SetEntityType(v string) *ExperienceEntitiesSummary

SetEntityType sets the EntityType field's value.

func (ExperienceEntitiesSummary) String

func (s ExperienceEntitiesSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExperiencesSummary

type ExperiencesSummary struct {

    // The date-time your Amazon Kendra experience was created.
    CreatedAt *time.Time `type:"timestamp"`

    // The endpoint URLs for your Amazon Kendra experiences. The URLs are unique
    // and fully hosted by Amazon Web Services.
    Endpoints []*ExperienceEndpoint `min:"1" type:"list"`

    // The identifier of your Amazon Kendra experience.
    Id *string `min:"1" type:"string"`

    // The name of your Amazon Kendra experience.
    Name *string `min:"1" type:"string"`

    // The processing status of your Amazon Kendra experience.
    Status *string `type:"string" enum:"ExperienceStatus"`
    // contains filtered or unexported fields
}

Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

func (ExperiencesSummary) GoString

func (s ExperiencesSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExperiencesSummary) SetCreatedAt

func (s *ExperiencesSummary) SetCreatedAt(v time.Time) *ExperiencesSummary

SetCreatedAt sets the CreatedAt field's value.

func (*ExperiencesSummary) SetEndpoints

func (s *ExperiencesSummary) SetEndpoints(v []*ExperienceEndpoint) *ExperiencesSummary

SetEndpoints sets the Endpoints field's value.

func (*ExperiencesSummary) SetId

func (s *ExperiencesSummary) SetId(v string) *ExperiencesSummary

SetId sets the Id field's value.

func (*ExperiencesSummary) SetName

func (s *ExperiencesSummary) SetName(v string) *ExperiencesSummary

SetName sets the Name field's value.

func (*ExperiencesSummary) SetStatus

func (s *ExperiencesSummary) SetStatus(v string) *ExperiencesSummary

SetStatus sets the Status field's value.

func (ExperiencesSummary) String

func (s ExperiencesSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Facet

type Facet struct {

    // The unique key for the document attribute.
    DocumentAttributeKey *string `min:"1" type:"string"`

    // An array of document attributes that are nested facets within a facet.
    //
    // For example, the document attribute or facet "Department" includes a value
    // called "Engineering". In addition, the document attribute or facet "SubDepartment"
    // includes the values "Frontend" and "Backend" for documents assigned to "Engineering".
    // You can display nested facets in the search results so that documents can
    // be searched not only by department but also by a sub department within a
    // department. This helps your users further narrow their search.
    //
    // You can only have one nested facet within a facet. If you want to increase
    // this limit, contact Support (http://aws.amazon.com/contact-us/).
    Facets []*Facet `type:"list"`

    // Maximum number of facet values per facet. The default is 10. You can use
    // this to limit the number of facet values to less than 10. If you want to
    // increase the default, contact Support (http://aws.amazon.com/contact-us/).
    MaxResults *int64 `type:"integer"`
    // contains filtered or unexported fields
}

Information about a document attribute. You can use document attributes as facets.

For example, the document attribute or facet "Department" includes the values "HR", "Engineering", and "Accounting". You can display these values in the search results so that documents can be searched by department.

You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support (http://aws.amazon.com/contact-us/).

func (Facet) GoString

func (s Facet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Facet) SetDocumentAttributeKey

func (s *Facet) SetDocumentAttributeKey(v string) *Facet

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*Facet) SetFacets

func (s *Facet) SetFacets(v []*Facet) *Facet

SetFacets sets the Facets field's value.

func (*Facet) SetMaxResults

func (s *Facet) SetMaxResults(v int64) *Facet

SetMaxResults sets the MaxResults field's value.

func (Facet) String

func (s Facet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Facet) Validate

func (s *Facet) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FacetResult

type FacetResult struct {

    // The key for the facet values. This is the same as the DocumentAttributeKey
    // provided in the query.
    DocumentAttributeKey *string `min:"1" type:"string"`

    // An array of key/value pairs, where the key is the value of the attribute
    // and the count is the number of documents that share the key value.
    DocumentAttributeValueCountPairs []*DocumentAttributeValueCountPair `type:"list"`

    // The data type of the facet value. This is the same as the type defined for
    // the index field when it was created.
    DocumentAttributeValueType *string `type:"string" enum:"DocumentAttributeValueType"`
    // contains filtered or unexported fields
}

The facet values for the documents in the response.

func (FacetResult) GoString

func (s FacetResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FacetResult) SetDocumentAttributeKey

func (s *FacetResult) SetDocumentAttributeKey(v string) *FacetResult

SetDocumentAttributeKey sets the DocumentAttributeKey field's value.

func (*FacetResult) SetDocumentAttributeValueCountPairs

func (s *FacetResult) SetDocumentAttributeValueCountPairs(v []*DocumentAttributeValueCountPair) *FacetResult

SetDocumentAttributeValueCountPairs sets the DocumentAttributeValueCountPairs field's value.

func (*FacetResult) SetDocumentAttributeValueType

func (s *FacetResult) SetDocumentAttributeValueType(v string) *FacetResult

SetDocumentAttributeValueType sets the DocumentAttributeValueType field's value.

func (FacetResult) String

func (s FacetResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedEntity

type FailedEntity struct {

    // The identifier of the user or group in your IAM Identity Center identity
    // source. For example, a user ID could be an email.
    EntityId *string `min:"1" type:"string"`

    // The reason the user or group in your IAM Identity Center identity source
    // failed to properly configure with your Amazon Kendra experience.
    ErrorMessage *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Information on the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.

func (FailedEntity) GoString

func (s FailedEntity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedEntity) SetEntityId

func (s *FailedEntity) SetEntityId(v string) *FailedEntity

SetEntityId sets the EntityId field's value.

func (*FailedEntity) SetErrorMessage

func (s *FailedEntity) SetErrorMessage(v string) *FailedEntity

SetErrorMessage sets the ErrorMessage field's value.

func (FailedEntity) String

func (s FailedEntity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FaqStatistics

type FaqStatistics struct {

    // The total number of FAQ questions and answers contained in the index.
    //
    // IndexedQuestionAnswersCount is a required field
    IndexedQuestionAnswersCount *int64 `type:"integer" required:"true"`
    // contains filtered or unexported fields
}

Provides statistical information about the FAQ questions and answers contained in an index.

func (FaqStatistics) GoString

func (s FaqStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FaqStatistics) SetIndexedQuestionAnswersCount

func (s *FaqStatistics) SetIndexedQuestionAnswersCount(v int64) *FaqStatistics

SetIndexedQuestionAnswersCount sets the IndexedQuestionAnswersCount field's value.

func (FaqStatistics) String

func (s FaqStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FaqSummary

type FaqSummary struct {

    // The UNIX 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
}

Summary information for frequently asked questions and answers included in an index.

func (FaqSummary) GoString

func (s FaqSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FaqSummary) SetCreatedAt

func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary

SetCreatedAt sets the CreatedAt field's value.

func (*FaqSummary) SetFileFormat

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 FsxConfiguration

type FsxConfiguration struct {

    // A list of regular expression patterns to exclude certain files in your Amazon
    // FSx file system. Files that match the patterns are excluded from the index.
    // Files that don't match the patterns are included in the index. If a file
    // matches both an inclusion and exclusion pattern, the exclusion pattern takes
    // precedence and the file isn't included in the index.
    ExclusionPatterns []*string `type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map Amazon FSx data
    // source attributes or field names to Amazon Kendra index field names. To create
    // custom fields, use the UpdateIndex API before you map to Amazon FSx fields.
    // For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The Amazon FSx data source field names must exist in your Amazon FSx custom
    // metadata.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // The identifier of the Amazon FSx file system.
    //
    // You can find your file system ID on the file system dashboard in the Amazon
    // FSx console. For information on how to create a file system in Amazon FSx
    // console, using Windows File Server as an example, see Amazon FSx Getting
    // started guide (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html).
    //
    // FileSystemId is a required field
    FileSystemId *string `min:"11" type:"string" required:"true"`

    // The Amazon FSx file system type. Windows is currently the only supported
    // type.
    //
    // FileSystemType is a required field
    FileSystemType *string `type:"string" required:"true" enum:"FsxFileSystemType"`

    // A list of regular expression patterns to include certain files in your Amazon
    // FSx file system. Files that match the patterns are included in the index.
    // Files that don't match the patterns are excluded from the index. If a file
    // matches both an inclusion and exclusion pattern, the exclusion pattern takes
    // precedence and the file isn't included in the index.
    InclusionPatterns []*string `type:"list"`

    // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
    // the key-value pairs required to connect to your Amazon FSx file system. Windows
    // is currently the only supported type. The secret must contain a JSON structure
    // with the following keys:
    //
    //    * username—The Active Directory user name, along with the Domain Name
    //    System (DNS) domain name. For example, user@corp.example.com. The Active
    //    Directory user account must have read and mounting access to the Amazon
    //    FSx file system for Windows.
    //
    //    * password—The password of the Active Directory user account with read
    //    and mounting access to the Amazon FSx Windows file system.
    SecretArn *string `min:"1" type:"string"`

    // Configuration information for an Amazon Virtual Private Cloud to connect
    // to your Amazon FSx. Your Amazon FSx instance must reside inside your VPC.
    //
    // VpcConfiguration is a required field
    VpcConfiguration *DataSourceVpcConfiguration `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Provides the configuration information to connect to Amazon FSx as your data source.

func (FsxConfiguration) GoString

func (s FsxConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FsxConfiguration) SetExclusionPatterns

func (s *FsxConfiguration) SetExclusionPatterns(v []*string) *FsxConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*FsxConfiguration) SetFieldMappings

func (s *FsxConfiguration) SetFieldMappings(v []*DataSourceToIndexFieldMapping) *FsxConfiguration

SetFieldMappings sets the FieldMappings field's value.

func (*FsxConfiguration) SetFileSystemId

func (s *FsxConfiguration) SetFileSystemId(v string) *FsxConfiguration

SetFileSystemId sets the FileSystemId field's value.

func (*FsxConfiguration) SetFileSystemType

func (s *FsxConfiguration) SetFileSystemType(v string) *FsxConfiguration

SetFileSystemType sets the FileSystemType field's value.

func (*FsxConfiguration) SetInclusionPatterns

func (s *FsxConfiguration) SetInclusionPatterns(v []*string) *FsxConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*FsxConfiguration) SetSecretArn

func (s *FsxConfiguration) SetSecretArn(v string) *FsxConfiguration

SetSecretArn sets the SecretArn field's value.

func (*FsxConfiguration) SetVpcConfiguration

func (s *FsxConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *FsxConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (FsxConfiguration) String

func (s FsxConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FsxConfiguration) Validate

func (s *FsxConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 GetSnapshotsInput

type GetSnapshotsInput struct {

    // The identifier of the index to get search metrics data.
    //
    // IndexId is a required field
    IndexId *string `min:"36" type:"string" required:"true"`

    // The time interval or time window to get search metrics data. The time interval
    // uses the time zone of your index. You can view data in the following time
    // windows:
    //
    //    * THIS_WEEK: The current week, starting on the Sunday and ending on the
    //    day before the current date.
    //
    //    * ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on
    //    the following Saturday.
    //
    //    * TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday
    //    and ending on the following Saturday.
    //
    //    * THIS_MONTH: The current month, starting on the first day of the month
    //    and ending on the day before the current date.
    //
    //    * ONE_MONTH_AGO: The previous month, starting on the first day of the
    //    month and ending on the last day of the month.
    //
    //    * TWO_MONTHS_AGO: The month before the previous month, starting on the
    //    first day of the month and ending on last day of the month.
    //
    // Interval is a required field
    Interval *string `type:"string" required:"true" enum:"Interval"`

    // The maximum number of returned data for the metric.
    MaxResults *int64 `type:"integer"`

    // The metric you want to retrieve. You can specify only one metric per call.
    //
    // For more information about the metrics you can view, see Gaining insights
    // with search analytics (https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html).
    //
    // MetricType is a required field
    MetricType *string `type:"string" required:"true" enum:"MetricType"`

    // If the previous response was incomplete (because there is more data to retrieve),
    // Amazon Kendra returns a pagination token in the response. You can use this
    // pagination token to retrieve the next set of search metrics data.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetSnapshotsInput) GoString

func (s GetSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotsInput) SetIndexId

func (s *GetSnapshotsInput) SetIndexId(v string) *GetSnapshotsInput

SetIndexId sets the IndexId field's value.

func (*GetSnapshotsInput) SetInterval

func (s *GetSnapshotsInput) SetInterval(v string) *GetSnapshotsInput

SetInterval sets the Interval field's value.

func (*GetSnapshotsInput) SetMaxResults

func (s *GetSnapshotsInput) SetMaxResults(v int64) *GetSnapshotsInput

SetMaxResults sets the MaxResults field's value.

func (*GetSnapshotsInput) SetMetricType

func (s *GetSnapshotsInput) SetMetricType(v string) *GetSnapshotsInput

SetMetricType sets the MetricType field's value.

func (*GetSnapshotsInput) SetNextToken

func (s *GetSnapshotsInput) SetNextToken(v string) *GetSnapshotsInput

SetNextToken sets the NextToken field's value.

func (GetSnapshotsInput) String

func (s GetSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotsInput) Validate

func (s *GetSnapshotsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSnapshotsOutput

type GetSnapshotsOutput struct {

    // If the response is truncated, Amazon Kendra returns this token, which you
    // can use in a later request to retrieve the next set of search metrics data.
    NextToken *string `min:"1" type:"string"`

    // The date-time for the beginning and end of the time window for the search
    // metrics data.
    SnapShotTimeFilter *TimeRange `type:"structure"`

    // The search metrics data. The data returned depends on the metric type you
    // requested.
    SnapshotsData [][]*string `type:"list"`

    // The column headers for the search metrics data.
    SnapshotsDataHeader []*string `type:"list"`
    // contains filtered or unexported fields
}

func (GetSnapshotsOutput) GoString

func (s GetSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSnapshotsOutput) SetNextToken

func (s *GetSnapshotsOutput) SetNextToken(v string) *GetSnapshotsOutput

SetNextToken sets the NextToken field's value.

func (*GetSnapshotsOutput) SetSnapShotTimeFilter

func (s *GetSnapshotsOutput) SetSnapShotTimeFilter(v *TimeRange) *GetSnapshotsOutput

SetSnapShotTimeFilter sets the SnapShotTimeFilter field's value.

func (*GetSnapshotsOutput) SetSnapshotsData

func (s *GetSnapshotsOutput) SetSnapshotsData(v [][]*string) *GetSnapshotsOutput

SetSnapshotsData sets the SnapshotsData field's value.

func (*GetSnapshotsOutput) SetSnapshotsDataHeader

func (s *GetSnapshotsOutput) SetSnapshotsDataHeader(v []*string) *GetSnapshotsOutput

SetSnapshotsDataHeader sets the SnapshotsDataHeader field's value.

func (GetSnapshotsOutput) String

func (s GetSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GitHubConfiguration

type GitHubConfiguration struct {

    // A list of regular expression patterns to exclude certain file names in your
    // GitHub repository or repositories. File names that match the patterns are
    // excluded from the index. File names that don't match the patterns are included
    // in the index. If a file matches both an exclusion and inclusion pattern,
    // the exclusion pattern takes precedence and the file isn't included in the
    // index.
    ExclusionFileNamePatterns []*string `type:"list"`

    // A list of regular expression patterns to exclude certain file types in your
    // GitHub repository or repositories. File types that match the patterns are
    // excluded from the index. File types that don't match the patterns are included
    // in the index. If a file matches both an exclusion and inclusion pattern,
    // the exclusion pattern takes precedence and the file isn't included in the
    // index.
    ExclusionFileTypePatterns []*string `type:"list"`

    // A list of regular expression patterns to exclude certain folder names in
    // your GitHub repository or repositories. Folder names that match the patterns
    // are excluded from the index. Folder names that don't match the patterns are
    // included in the index. If a folder matches both an exclusion and inclusion
    // pattern, the exclusion pattern takes precedence and the folder isn't included
    // in the index.
    ExclusionFolderNamePatterns []*string `type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of GitHub commits to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to GitHub fields. For more
    // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubCommitConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // Configuration information to include certain types of GitHub content. You
    // can configure to index repository files only, or also include issues and
    // pull requests, comments, and comment attachments.
    GitHubDocumentCrawlProperties *GitHubDocumentCrawlProperties `type:"structure"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of GitHub issue attachments to Amazon Kendra index field names. To
    // create custom fields, use the UpdateIndex API before you map to GitHub fields.
    // For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubIssueAttachmentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of GitHub issue comments to Amazon Kendra index field names. To create
    // custom fields, use the UpdateIndex API before you map to GitHub fields. For
    // more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubIssueCommentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of GitHub issues to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to GitHub fields. For more
    // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubIssueDocumentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of GitHub pull request comments to Amazon Kendra index field names.
    // To create custom fields, use the UpdateIndex API before you map to GitHub
    // fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubPullRequestCommentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of GitHub pull request attachments to Amazon Kendra index field names.
    // To create custom fields, use the UpdateIndex API before you map to GitHub
    // fields. For more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubPullRequestDocumentAttachmentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of GitHub pull requests to Amazon Kendra index field names. To create
    // custom fields, use the UpdateIndex API before you map to GitHub fields. For
    // more information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubPullRequestDocumentConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map GitHub repository
    // attributes or field names to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to GitHub fields. For more
    // information, see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The GitHub data source field names must exist in your GitHub custom metadata.
    GitHubRepositoryConfigurationFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of regular expression patterns to include certain file names in your
    // GitHub repository or repositories. File names that match the patterns are
    // included in the index. File names that don't match the patterns are excluded
    // from the index. If a file matches both an inclusion and exclusion pattern,
    // the exclusion pattern takes precedence and the file isn't included in the
    // index.
    InclusionFileNamePatterns []*string `type:"list"`

    // A list of regular expression patterns to include certain file types in your
    // GitHub repository or repositories. File types that match the patterns are
    // included in the index. File types that don't match the patterns are excluded
    // from the index. If a file matches both an inclusion and exclusion pattern,
    // the exclusion pattern takes precedence and the file isn't included in the
    // index.
    InclusionFileTypePatterns []*string `type:"list"`

    // A list of regular expression patterns to include certain folder names in
    // your GitHub repository or repositories. Folder names that match the patterns
    // are included in the index. Folder names that don't match the patterns are
    // excluded from the index. If a folder matches both an inclusion and exclusion
    // pattern, the exclusion pattern takes precedence and the folder isn't included
    // in the index.
    InclusionFolderNamePatterns []*string `type:"list"`

    // Configuration information to connect to GitHub Enterprise Server (on premises).
    OnPremiseConfiguration *OnPremiseConfiguration `type:"structure"`

    // A list of names of the specific repositories you want to index.
    RepositoryFilter []*string `type:"list"`

    // Configuration information to connect to GitHub Enterprise Cloud (SaaS).
    SaaSConfiguration *SaaSConfiguration `type:"structure"`

    // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
    // the key-value pairs required to connect to your GitHub. The secret must contain
    // a JSON structure with the following keys:
    //
    //    * githubToken—The access token created in GitHub. For more information
    //    on creating a token in GitHub, see Authentication for a GitHub data source
    //    (https://docs.aws.amazon.com/kendra/latest/dg/data-source-github.html#github-authentication).
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`

    // The type of GitHub service you want to connect to—GitHub Enterprise Cloud
    // (SaaS) or GitHub Enterprise Server (on premises).
    Type *string `type:"string" enum:"Type"`

    // TRUE to use the GitHub change log to determine which documents require updating
    // in the index. Depending on the GitHub change log's size, it may take longer
    // for Amazon Kendra to use the change log than to scan all of your documents
    // in GitHub.
    UseChangeLog *bool `type:"boolean"`

    // Configuration information of an Amazon Virtual Private Cloud to connect to
    // your GitHub. For more information, see Configuring a VPC (https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html).
    VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`
    // contains filtered or unexported fields
}

Provides the configuration information to connect to GitHub as your data source.

func (GitHubConfiguration) GoString

func (s GitHubConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GitHubConfiguration) SetExclusionFileNamePatterns

func (s *GitHubConfiguration) SetExclusionFileNamePatterns(v []*string) *GitHubConfiguration

SetExclusionFileNamePatterns sets the ExclusionFileNamePatterns field's value.

func (*GitHubConfiguration) SetExclusionFileTypePatterns

func (s *GitHubConfiguration) SetExclusionFileTypePatterns(v []*string) *GitHubConfiguration

SetExclusionFileTypePatterns sets the ExclusionFileTypePatterns field's value.

func (*GitHubConfiguration) SetExclusionFolderNamePatterns

func (s *GitHubConfiguration) SetExclusionFolderNamePatterns(v []*string) *GitHubConfiguration

SetExclusionFolderNamePatterns sets the ExclusionFolderNamePatterns field's value.

func (*GitHubConfiguration) SetGitHubCommitConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubCommitConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubCommitConfigurationFieldMappings sets the GitHubCommitConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubDocumentCrawlProperties

func (s *GitHubConfiguration) SetGitHubDocumentCrawlProperties(v *GitHubDocumentCrawlProperties) *GitHubConfiguration

SetGitHubDocumentCrawlProperties sets the GitHubDocumentCrawlProperties field's value.

func (*GitHubConfiguration) SetGitHubIssueAttachmentConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubIssueAttachmentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubIssueAttachmentConfigurationFieldMappings sets the GitHubIssueAttachmentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubIssueCommentConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubIssueCommentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubIssueCommentConfigurationFieldMappings sets the GitHubIssueCommentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubIssueDocumentConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubIssueDocumentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubIssueDocumentConfigurationFieldMappings sets the GitHubIssueDocumentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubPullRequestCommentConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubPullRequestCommentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubPullRequestCommentConfigurationFieldMappings sets the GitHubPullRequestCommentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubPullRequestDocumentAttachmentConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubPullRequestDocumentAttachmentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubPullRequestDocumentAttachmentConfigurationFieldMappings sets the GitHubPullRequestDocumentAttachmentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubPullRequestDocumentConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubPullRequestDocumentConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubPullRequestDocumentConfigurationFieldMappings sets the GitHubPullRequestDocumentConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetGitHubRepositoryConfigurationFieldMappings

func (s *GitHubConfiguration) SetGitHubRepositoryConfigurationFieldMappings(v []*DataSourceToIndexFieldMapping) *GitHubConfiguration

SetGitHubRepositoryConfigurationFieldMappings sets the GitHubRepositoryConfigurationFieldMappings field's value.

func (*GitHubConfiguration) SetInclusionFileNamePatterns

func (s *GitHubConfiguration) SetInclusionFileNamePatterns(v []*string) *GitHubConfiguration

SetInclusionFileNamePatterns sets the InclusionFileNamePatterns field's value.

func (*GitHubConfiguration) SetInclusionFileTypePatterns

func (s *GitHubConfiguration) SetInclusionFileTypePatterns(v []*string) *GitHubConfiguration

SetInclusionFileTypePatterns sets the InclusionFileTypePatterns field's value.

func (*GitHubConfiguration) SetInclusionFolderNamePatterns

func (s *GitHubConfiguration) SetInclusionFolderNamePatterns(v []*string) *GitHubConfiguration

SetInclusionFolderNamePatterns sets the InclusionFolderNamePatterns field's value.

func (*GitHubConfiguration) SetOnPremiseConfiguration

func (s *GitHubConfiguration) SetOnPremiseConfiguration(v *OnPremiseConfiguration) *GitHubConfiguration

SetOnPremiseConfiguration sets the OnPremiseConfiguration field's value.

func (*GitHubConfiguration) SetRepositoryFilter

func (s *GitHubConfiguration) SetRepositoryFilter(v []*string) *GitHubConfiguration

SetRepositoryFilter sets the RepositoryFilter field's value.

func (*GitHubConfiguration) SetSaaSConfiguration

func (s *GitHubConfiguration) SetSaaSConfiguration(v *SaaSConfiguration) *GitHubConfiguration

SetSaaSConfiguration sets the SaaSConfiguration field's value.

func (*GitHubConfiguration) SetSecretArn

func (s *GitHubConfiguration) SetSecretArn(v string) *GitHubConfiguration

SetSecretArn sets the SecretArn field's value.

func (*GitHubConfiguration) SetType

func (s *GitHubConfiguration) SetType(v string) *GitHubConfiguration

SetType sets the Type field's value.

func (*GitHubConfiguration) SetUseChangeLog

func (s *GitHubConfiguration) SetUseChangeLog(v bool) *GitHubConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (*GitHubConfiguration) SetVpcConfiguration

func (s *GitHubConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *GitHubConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (GitHubConfiguration) String

func (s GitHubConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GitHubConfiguration) Validate

func (s *GitHubConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GitHubDocumentCrawlProperties

type GitHubDocumentCrawlProperties struct {

    // TRUE to index all issues within a repository.
    CrawlIssue *bool `type:"boolean"`

    // TRUE to index all comments on issues.
    CrawlIssueComment *bool `type:"boolean"`

    // TRUE to include all comment attachments for issues.
    CrawlIssueCommentAttachment *bool `type:"boolean"`

    // TRUE to index all pull requests within a repository.
    CrawlPullRequest *bool `type:"boolean"`

    // TRUE to index all comments on pull requests.
    CrawlPullRequestComment *bool `type:"boolean"`

    // TRUE to include all comment attachments for pull requests.
    CrawlPullRequestCommentAttachment *bool `type:"boolean"`

    // TRUE to index all files with a repository.
    CrawlRepositoryDocuments *bool `type:"boolean"`
    // contains filtered or unexported fields
}

Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

func (GitHubDocumentCrawlProperties) GoString

func (s GitHubDocumentCrawlProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GitHubDocumentCrawlProperties) SetCrawlIssue

func (s *GitHubDocumentCrawlProperties) SetCrawlIssue(v bool) *GitHubDocumentCrawlProperties

SetCrawlIssue sets the CrawlIssue field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlIssueComment

func (s *GitHubDocumentCrawlProperties) SetCrawlIssueComment(v bool) *GitHubDocumentCrawlProperties

SetCrawlIssueComment sets the CrawlIssueComment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlIssueCommentAttachment

func (s *GitHubDocumentCrawlProperties) SetCrawlIssueCommentAttachment(v bool) *GitHubDocumentCrawlProperties

SetCrawlIssueCommentAttachment sets the CrawlIssueCommentAttachment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlPullRequest

func (s *GitHubDocumentCrawlProperties) SetCrawlPullRequest(v bool) *GitHubDocumentCrawlProperties

SetCrawlPullRequest sets the CrawlPullRequest field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlPullRequestComment

func (s *GitHubDocumentCrawlProperties) SetCrawlPullRequestComment(v bool) *GitHubDocumentCrawlProperties

SetCrawlPullRequestComment sets the CrawlPullRequestComment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlPullRequestCommentAttachment

func (s *GitHubDocumentCrawlProperties) SetCrawlPullRequestCommentAttachment(v bool) *GitHubDocumentCrawlProperties

SetCrawlPullRequestCommentAttachment sets the CrawlPullRequestCommentAttachment field's value.

func (*GitHubDocumentCrawlProperties) SetCrawlRepositoryDocuments

func (s *GitHubDocumentCrawlProperties) SetCrawlRepositoryDocuments(v bool) *GitHubDocumentCrawlProperties

SetCrawlRepositoryDocuments sets the CrawlRepositoryDocuments field's value.

func (GitHubDocumentCrawlProperties) String

func (s GitHubDocumentCrawlProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GoogleDriveConfiguration

type GoogleDriveConfiguration struct {

    // A list of MIME types to exclude from the index. All documents matching the
    // specified MIME type are excluded.
    //
    // For a list of MIME types, see Using a Google Workspace Drive data source
    // (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
    ExcludeMimeTypes []*string `type:"list"`

    // A list of identifiers or shared drives to exclude from the index. All files
    // and folders stored on the shared drive are excluded.
    ExcludeSharedDrives []*string `type:"list"`

    // A list of email addresses of the users. Documents owned by these users are
    // excluded from the index. Documents shared with excluded users are indexed
    // unless they are excluded in another way.
    ExcludeUserAccounts []*string `type:"list"`

    // A list of regular expression patterns to exclude certain items in your Google
    // Drive, including shared drives and users' My Drives. Items that match the
    // patterns are excluded from the index. Items that don't match the patterns
    // are included in the index. If an item matches both an inclusion and exclusion
    // pattern, the exclusion pattern takes precedence and the item isn't included
    // in the index.
    ExclusionPatterns []*string `type:"list"`

    // Maps Google Drive data source attributes or field names to Amazon Kendra
    // index field names. To create custom fields, use the UpdateIndex API before
    // you map to Google Drive fields. For more information, see Mapping data source
    // fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The Google Drive data source field names must exist in your Google Drive
    // custom metadata.
    FieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of regular expression patterns to include certain items in your Google
    // Drive, including shared drives and users' My Drives. Items that match the
    // patterns are included in the index. Items that don't match the patterns are
    // excluded from the index. If an item matches both an inclusion and exclusion
    // pattern, the exclusion pattern takes precedence and the item isn't included
    // in the index.
    InclusionPatterns []*string `type:"list"`

    // The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the
    // credentials required to connect to Google Drive. For more information, see
    // Using a Google Workspace Drive data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html).
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides the configuration information to connect to Google Drive as your data source.

func (GoogleDriveConfiguration) GoString

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. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

func (GroupMembers) GoString

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
}

Summary 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
}

Summary information for groups.

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 HookConfiguration

type HookConfiguration struct {

    // The condition used for when a Lambda function should be invoked.
    //
    // For example, you can specify a condition that if there are empty date-time
    // values, then Amazon Kendra should invoke a function that inserts the current
    // date-time.
    InvocationCondition *DocumentAttributeCondition `type:"structure"`

    // The Amazon Resource Name (ARN) of a role with permission to run a Lambda
    // function during ingestion. For more information, see IAM roles for Amazon
    // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).
    //
    // LambdaArn is a required field
    LambdaArn *string `min:"1" type:"string" required:"true"`

    // Stores the original, raw documents or the structured, parsed documents before
    // and after altering them. For more information, see Data contracts for Lambda
    // functions (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda).
    //
    // S3Bucket is a required field
    S3Bucket *string `min:"3" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using PreExtractionHookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html) if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra structured documents, you must configure your Lambda function using PostExtractionHookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html). You can only invoke one Lambda function. However, this function can invoke other functions it requires.

For more information, see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).

func (HookConfiguration) GoString

func (s HookConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HookConfiguration) SetInvocationCondition

func (s *HookConfiguration) SetInvocationCondition(v *DocumentAttributeCondition) *HookConfiguration

SetInvocationCondition sets the InvocationCondition field's value.

func (*HookConfiguration) SetLambdaArn

func (s *HookConfiguration) SetLambdaArn(v string) *HookConfiguration

SetLambdaArn sets the LambdaArn field's value.

func (*HookConfiguration) SetS3Bucket

func (s *HookConfiguration) SetS3Bucket(v string) *HookConfiguration

SetS3Bucket sets the S3Bucket field's value.

func (HookConfiguration) String

func (s HookConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HookConfiguration) Validate

func (s *HookConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IndexConfigurationSummary

type IndexConfigurationSummary struct {

    // The Unix timestamp when the index was created.
    //
    // CreatedAt is a required field
    CreatedAt *time.Time `type:"timestamp" required:"true"`

    // Indicates whether the index is a enterprise edition index or a developer
    // edition index.
    Edition *string `type:"string" enum:"IndexEdition"`

    // A unique identifier for the index. Use this to identify the index when you
    // are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
    Id *string `min:"36" type:"string"`

    // The identifier 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 API.
    //
    // UpdatedAt is a required field
    UpdatedAt *time.Time `type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

Summary information on the configuration of an index.

func (IndexConfigurationSummary) GoString

func (s IndexConfigurationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IndexConfigurationSummary) SetCreatedAt

func (s *IndexConfigurationSummary) SetCreatedAt(v time.Time) *IndexConfigurationSummary

SetCreatedAt sets the CreatedAt field's value.

func (*IndexConfigurationSummary) SetEdition

func (s *IndexConfigurationSummary) SetEdition(v string) *IndexConfigurationSummary

SetEdition sets the Edition field's value.

func (*IndexConfigurationSummary) SetId

func (s *IndexConfigurationSummary) SetId(v string) *IndexConfigurationSummary

SetId sets the Id field's value.

func (*IndexConfigurationSummary) SetName

func (s *IndexConfigurationSummary) SetName(v string) *IndexConfigurationSummary

SetName sets the Name field's value.

func (*IndexConfigurationSummary) SetStatus

func (s *IndexConfigurationSummary) SetStatus(v string) *IndexConfigurationSummary

SetStatus sets the Status field's value.

func (*IndexConfigurationSummary) SetUpdatedAt

func (s *IndexConfigurationSummary) SetUpdatedAt(v time.Time) *IndexConfigurationSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (IndexConfigurationSummary) String

func (s IndexConfigurationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IndexStatistics

type IndexStatistics struct {

    // The number of question and answer topics in the index.
    //
    // FaqStatistics is a required field
    FaqStatistics *FaqStatistics `type:"structure" required:"true"`

    // The number of text documents indexed.
    //
    // TextDocumentStatistics is a required field
    TextDocumentStatistics *TextDocumentStatistics `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Provides information about the number of documents and the number of questions and answers in an index.

func (IndexStatistics) GoString

func (s IndexStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IndexStatistics) SetFaqStatistics

func (s *IndexStatistics) SetFaqStatistics(v *FaqStatistics) *IndexStatistics

SetFaqStatistics sets the FaqStatistics field's value.

func (*IndexStatistics) SetTextDocumentStatistics

func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) *IndexStatistics

SetTextDocumentStatistics sets the TextDocumentStatistics field's value.

func (IndexStatistics) String

func (s IndexStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InlineCustomDocumentEnrichmentConfiguration

type InlineCustomDocumentEnrichmentConfiguration struct {

    // Configuration of the condition used for the target document attribute or
    // metadata field when ingesting documents into Amazon Kendra.
    Condition *DocumentAttributeCondition `type:"structure"`

    // TRUE to delete content if the condition used for the target attribute is
    // met.
    DocumentContentDeletion *bool `type:"boolean"`

    // Configuration of the target document attribute or metadata field when ingesting
    // documents into Amazon Kendra. You can also include a value.
    Target *DocumentAttributeTarget `type:"structure"`
    // contains filtered or unexported fields
}

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Kendra. To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration (https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html).

For more information, see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html).

func (InlineCustomDocumentEnrichmentConfiguration) GoString

func (s InlineCustomDocumentEnrichmentConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InlineCustomDocumentEnrichmentConfiguration) SetCondition

func (s *InlineCustomDocumentEnrichmentConfiguration) SetCondition(v *DocumentAttributeCondition) *InlineCustomDocumentEnrichmentConfiguration

SetCondition sets the Condition field's value.

func (*InlineCustomDocumentEnrichmentConfiguration) SetDocumentContentDeletion

func (s *InlineCustomDocumentEnrichmentConfiguration) SetDocumentContentDeletion(v bool) *InlineCustomDocumentEnrichmentConfiguration

SetDocumentContentDeletion sets the DocumentContentDeletion field's value.

func (*InlineCustomDocumentEnrichmentConfiguration) SetTarget

func (s *InlineCustomDocumentEnrichmentConfiguration) SetTarget(v *DocumentAttributeTarget) *InlineCustomDocumentEnrichmentConfiguration

SetTarget sets the Target field's value.

func (InlineCustomDocumentEnrichmentConfiguration) String

func (s InlineCustomDocumentEnrichmentConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InlineCustomDocumentEnrichmentConfiguration) Validate

func (s *InlineCustomDocumentEnrichmentConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 InvalidRequestException

type InvalidRequestException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The input to the request is not valid.

func (*InvalidRequestException) Code

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type JiraConfiguration

type JiraConfiguration struct {

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of Jira attachments to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to Jira fields. For more information,
    // see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The Jira data source field names must exist in your Jira custom metadata.
    AttachmentFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of Jira comments to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to Jira fields. For more information,
    // see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The Jira data source field names must exist in your Jira custom metadata.
    CommentFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // A list of regular expression patterns to exclude certain file paths, file
    // names, and file types in your Jira data source. Files that match the patterns
    // are excluded from the index. Files that don’t match the patterns are included
    // in the index. If a file matches both an inclusion pattern and an exclusion
    // pattern, the exclusion pattern takes precedence and the file isn't included
    // in the index.
    ExclusionPatterns []*string `type:"list"`

    // A list of regular expression patterns to include certain file paths, file
    // names, and file types in your Jira data source. Files that match the patterns
    // are included in the index. Files that don't match the patterns are excluded
    // from the index. If a file matches both an inclusion pattern and an exclusion
    // pattern, the exclusion pattern takes precedence and the file isn't included
    // in the index.
    InclusionPatterns []*string `type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of Jira issues to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to Jira fields. For more information,
    // see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The Jira data source field names must exist in your Jira custom metadata.
    IssueFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // Specify whether to crawl comments, attachments, and work logs. You can specify
    // one or more of these options.
    IssueSubEntityFilter []*string `type:"list" enum:"IssueSubEntity"`

    // Specify which issue types to crawl in your Jira data source. You can specify
    // one or more of these options to crawl.
    IssueType []*string `type:"list"`

    // The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com.
    // You can find your Jira account URL in the URL of your profile page for Jira
    // desktop.
    //
    // JiraAccountUrl is a required field
    JiraAccountUrl *string `min:"1" type:"string" required:"true"`

    // Specify which projects to crawl in your Jira data source. You can specify
    // one or more Jira project IDs.
    Project []*string `type:"list"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of Jira projects to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to Jira fields. For more information,
    // see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The Jira data source field names must exist in your Jira custom metadata.
    ProjectFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`

    // The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the
    // key-value pairs required to connect to your Jira data source. The secret
    // must contain a JSON structure with the following keys:
    //
    //    * jiraId—The Jira username.
    //
    //    * jiraCredentials—The Jira API token. For more information on creating
    //    an API token in Jira, see Authentication for a Jira data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html#jira-authentication).
    //
    // SecretArn is a required field
    SecretArn *string `min:"1" type:"string" required:"true"`

    // Specify which statuses to crawl in your Jira data source. You can specify
    // one or more of these options to crawl.
    Status []*string `type:"list"`

    // TRUE to use the Jira change log to determine which documents require updating
    // in the index. Depending on the change log's size, it may take longer for
    // Amazon Kendra to use the change log than to scan all of your documents in
    // Jira.
    UseChangeLog *bool `type:"boolean"`

    // Configuration information for an Amazon Virtual Private Cloud to connect
    // to your Jira. Your Jira account must reside inside your VPC.
    VpcConfiguration *DataSourceVpcConfiguration `type:"structure"`

    // A list of DataSourceToIndexFieldMapping objects that map attributes or field
    // names of Jira work logs to Amazon Kendra index field names. To create custom
    // fields, use the UpdateIndex API before you map to Jira fields. For more information,
    // see Mapping data source fields (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
    // The Jira data source field names must exist in your Jira custom metadata.
    WorkLogFieldMappings []*DataSourceToIndexFieldMapping `min:"1" type:"list"`
    // contains filtered or unexported fields
}

Provides the configuration information to connect to Jira as your data source.

func (JiraConfiguration) GoString

func (s JiraConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JiraConfiguration) SetAttachmentFieldMappings

func (s *JiraConfiguration) SetAttachmentFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetAttachmentFieldMappings sets the AttachmentFieldMappings field's value.

func (*JiraConfiguration) SetCommentFieldMappings

func (s *JiraConfiguration) SetCommentFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetCommentFieldMappings sets the CommentFieldMappings field's value.

func (*JiraConfiguration) SetExclusionPatterns

func (s *JiraConfiguration) SetExclusionPatterns(v []*string) *JiraConfiguration

SetExclusionPatterns sets the ExclusionPatterns field's value.

func (*JiraConfiguration) SetInclusionPatterns

func (s *JiraConfiguration) SetInclusionPatterns(v []*string) *JiraConfiguration

SetInclusionPatterns sets the InclusionPatterns field's value.

func (*JiraConfiguration) SetIssueFieldMappings

func (s *JiraConfiguration) SetIssueFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetIssueFieldMappings sets the IssueFieldMappings field's value.

func (*JiraConfiguration) SetIssueSubEntityFilter

func (s *JiraConfiguration) SetIssueSubEntityFilter(v []*string) *JiraConfiguration

SetIssueSubEntityFilter sets the IssueSubEntityFilter field's value.

func (*JiraConfiguration) SetIssueType

func (s *JiraConfiguration) SetIssueType(v []*string) *JiraConfiguration

SetIssueType sets the IssueType field's value.

func (*JiraConfiguration) SetJiraAccountUrl

func (s *JiraConfiguration) SetJiraAccountUrl(v string) *JiraConfiguration

SetJiraAccountUrl sets the JiraAccountUrl field's value.

func (*JiraConfiguration) SetProject

func (s *JiraConfiguration) SetProject(v []*string) *JiraConfiguration

SetProject sets the Project field's value.

func (*JiraConfiguration) SetProjectFieldMappings

func (s *JiraConfiguration) SetProjectFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetProjectFieldMappings sets the ProjectFieldMappings field's value.

func (*JiraConfiguration) SetSecretArn

func (s *JiraConfiguration) SetSecretArn(v string) *JiraConfiguration

SetSecretArn sets the SecretArn field's value.

func (*JiraConfiguration) SetStatus

func (s *JiraConfiguration) SetStatus(v []*string) *JiraConfiguration

SetStatus sets the Status field's value.

func (*JiraConfiguration) SetUseChangeLog

func (s *JiraConfiguration) SetUseChangeLog(v bool) *JiraConfiguration

SetUseChangeLog sets the UseChangeLog field's value.

func (*JiraConfiguration) SetVpcConfiguration

func (s *JiraConfiguration) SetVpcConfiguration(v *DataSourceVpcConfiguration) *JiraConfiguration

SetVpcConfiguration sets the VpcConfiguration field's value.

func (*JiraConfiguration) SetWorkLogFieldMappings

func (s *JiraConfiguration) SetWorkLogFieldMappings(v []*DataSourceToIndexFieldMapping) *JiraConfiguration

SetWorkLogFieldMappings sets the WorkLogFieldMappings field's value.

func (JiraConfiguration) String

func (s JiraConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JiraConfiguration) Validate

func (s *JiraConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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
}

Provides the 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 `type:"string"`

    // The signing key URL.
    URL *string `min:"1" type:"string"`

    // The user name attribute field.
    UserNameAttributeField *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Provides the configuration information for the JWT token type.

func (JwtTokenTypeConfiguration) GoString

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) AssociateEntitiesToExperience

func (c *Kendra) AssociateEntitiesToExperience(input *AssociateEntitiesToExperienceInput) (*AssociateEntitiesToExperienceOutput, error)

AssociateEntitiesToExperience API operation for AWSKendraFrontendService.

Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation AssociateEntitiesToExperience for usage and error information.

Returned Error Types:

  • ValidationException

  • ResourceNotFoundException

  • ResourceAlreadyExistException

  • ThrottlingException

  • AccessDeniedException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperience

func (*Kendra) AssociateEntitiesToExperienceRequest

func (c *Kendra) AssociateEntitiesToExperienceRequest(input *AssociateEntitiesToExperienceInput) (req *request.Request, output *AssociateEntitiesToExperienceOutput)

AssociateEntitiesToExperienceRequest generates a "aws/request.Request" representing the client's request for the AssociateEntitiesToExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateEntitiesToExperience for more information on using the AssociateEntitiesToExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateEntitiesToExperienceRequest method.
req, resp := client.AssociateEntitiesToExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperience

func (*Kendra) AssociateEntitiesToExperienceWithContext

func (c *Kendra) AssociateEntitiesToExperienceWithContext(ctx aws.Context, input *AssociateEntitiesToExperienceInput, opts ...request.Option) (*AssociateEntitiesToExperienceOutput, error)

AssociateEntitiesToExperienceWithContext is the same as AssociateEntitiesToExperience with the addition of the ability to pass a context and additional request options.

See AssociateEntitiesToExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) AssociatePersonasToEntities

func (c *Kendra) AssociatePersonasToEntities(input *AssociatePersonasToEntitiesInput) (*AssociatePersonasToEntitiesOutput, error)

AssociatePersonasToEntities API operation for AWSKendraFrontendService.

Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation AssociatePersonasToEntities for usage and error information.

Returned Error Types:

  • ValidationException

  • ResourceNotFoundException

  • ResourceAlreadyExistException

  • ThrottlingException

  • AccessDeniedException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntities

func (*Kendra) AssociatePersonasToEntitiesRequest

func (c *Kendra) AssociatePersonasToEntitiesRequest(input *AssociatePersonasToEntitiesInput) (req *request.Request, output *AssociatePersonasToEntitiesOutput)

AssociatePersonasToEntitiesRequest generates a "aws/request.Request" representing the client's request for the AssociatePersonasToEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociatePersonasToEntities for more information on using the AssociatePersonasToEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociatePersonasToEntitiesRequest method.
req, resp := client.AssociatePersonasToEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntities

func (*Kendra) AssociatePersonasToEntitiesWithContext

func (c *Kendra) AssociatePersonasToEntitiesWithContext(ctx aws.Context, input *AssociatePersonasToEntitiesInput, opts ...request.Option) (*AssociatePersonasToEntitiesOutput, error)

AssociatePersonasToEntitiesWithContext is the same as AssociatePersonasToEntities with the addition of the ability to pass a context and additional request options.

See AssociatePersonasToEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) BatchDeleteDocument

func (c *Kendra) BatchDeleteDocument(input *BatchDeleteDocumentInput) (*BatchDeleteDocumentOutput, error)

BatchDeleteDocument API operation for AWSKendraFrontendService.

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to 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) API.

When you use the BatchPutDocument API, documents are indexed asynchronously. You can use the BatchGetDocumentStatus API to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus API to check the status of the BatchDeleteDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) API. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchGetDocumentStatus for usage and error information.

Returned Error Types:

  • ValidationException

  • 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 API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.

For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation BatchPutDocument for usage and error information.

Returned Error Types:

  • ValidationException

  • 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.

ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation ClearQuerySuggestions for usage and error information.

Returned Error Types:

  • ValidationException

  • 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) CreateAccessControlConfiguration

func (c *Kendra) CreateAccessControlConfiguration(input *CreateAccessControlConfigurationInput) (*CreateAccessControlConfigurationOutput, error)

CreateAccessControlConfiguration API operation for AWSKendraFrontendService.

Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.

To apply your access control configuration to certain documents, you call the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) API with the AccessControlConfigurationId included in the Document (https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html) object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateAccessControlConfiguration for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException

  • ValidationException

  • ThrottlingException

  • ConflictException

  • AccessDeniedException

  • ResourceNotFoundException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfiguration

func (*Kendra) CreateAccessControlConfigurationRequest

func (c *Kendra) CreateAccessControlConfigurationRequest(input *CreateAccessControlConfigurationInput) (req *request.Request, output *CreateAccessControlConfigurationOutput)

CreateAccessControlConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateAccessControlConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAccessControlConfiguration for more information on using the CreateAccessControlConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAccessControlConfigurationRequest method.
req, resp := client.CreateAccessControlConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfiguration

func (*Kendra) CreateAccessControlConfigurationWithContext

func (c *Kendra) CreateAccessControlConfigurationWithContext(ctx aws.Context, input *CreateAccessControlConfigurationInput, opts ...request.Option) (*CreateAccessControlConfigurationOutput, error)

CreateAccessControlConfigurationWithContext is the same as CreateAccessControlConfiguration with the addition of the ability to pass a context and additional request options.

See CreateAccessControlConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateDataSource

func (c *Kendra) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)

CreateDataSource API operation for AWSKendraFrontendService.

Creates a data source connector that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Amazon S3 and custom (https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html) data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateDataSource for usage and error information.

Returned Error Types:

  • ValidationException

  • 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) CreateExperience

func (c *Kendra) CreateExperience(input *CreateExperienceInput) (*CreateExperienceOutput, error)

CreateExperience API operation for AWSKendraFrontendService.

Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code (https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateExperience for usage and error information.

Returned Error Types:

  • ValidationException

  • ConflictException

  • ResourceNotFoundException

  • ServiceQuotaExceededException

  • ThrottlingException

  • AccessDeniedException

  • InternalServerException

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperience

func (*Kendra) CreateExperienceRequest

func (c *Kendra) CreateExperienceRequest(input *CreateExperienceInput) (req *request.Request, output *CreateExperienceOutput)

CreateExperienceRequest generates a "aws/request.Request" representing the client's request for the CreateExperience operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateExperience for more information on using the CreateExperience API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateExperienceRequest method.
req, resp := client.CreateExperienceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperience

func (*Kendra) CreateExperienceWithContext

func (c *Kendra) CreateExperienceWithContext(ctx aws.Context, input *CreateExperienceInput, opts ...request.Option) (*CreateExperienceOutput, error)

CreateExperienceWithContext is the same as CreateExperience with the addition of the ability to pass a context and additional request options.

See CreateExperience for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Kendra) CreateFaq

func (c *Kendra) CreateFaq(input *CreateFaqInput) (*CreateFaqOutput, error)

CreateFaq API operation for AWSKendraFrontendService.

Creates an new set of frequently asked question (FAQ) questions and answers.

Adding FAQs to an index is an asynchronous operation.

For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateFaq for usage and error information.

Returned Error Types:

  • ValidationException

  • 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 an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html). For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK (https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWSKendraFrontendService's API operation CreateIndex for usage and error information.

Returned Error Types:

  • ValidationException

  • 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).

CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.

For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list (https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-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 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 a