kendra

package module
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 21, 2021 License: Apache-2.0 Imports: 32 Imported by: 11

Documentation

Overview

Package kendra provides the API client, operations, and parameter types for AWSKendraFrontendService.

Amazon Kendra is a service for indexing large document sets.

Index

Constants

View Source 
const ServiceAPIVersion = "2019-02-03"
View Source 
const ServiceID = "kendra"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type BatchDeleteDocumentInput 

type BatchDeleteDocumentInput struct {

	// One or more identifiers for documents to delete from the index.
	//
	// This member is required.
	DocumentIdList []string

	// The identifier of the index that contains the documents to delete.
	//
	// This member is required.
	IndexId *string

	// Maps a particular data source sync job to a particular data source.
	DataSourceSyncJobMetricTarget *types.DataSourceSyncJobMetricTarget
	// contains filtered or unexported fields
}

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 []types.BatchDeleteDocumentResponseFailedDocument

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchGetDocumentStatusInput added in v1.6.0 

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.
	//
	// This member is required.
	DocumentInfoList []types.DocumentInfo

	// The identifier of the index to add documents to. The index ID is returned by the
	// CreateIndex  (https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html)
	// operation.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type BatchGetDocumentStatusOutput added in v1.6.0 

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 []types.Status

	// 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 []types.BatchGetDocumentStatusResponseError

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type BatchPutDocumentInput 

type BatchPutDocumentInput struct {

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

	// The identifier of the index to add the documents to. You need to create the
	// index first using the CreateIndex operation.
	//
	// This member is required.
	IndexId *string

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

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 []types.BatchPutDocumentResponseFailedDocument

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ClearQuerySuggestionsInput added in v1.5.0 

type ClearQuerySuggestionsInput struct {

	// The identifier of the index you want to clear query suggestions from.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type ClearQuerySuggestionsOutput added in v1.5.0 

type ClearQuerySuggestionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

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

Client provides the API client to make operations call for AWSKendraFrontendService.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) BatchDeleteDocument 

func (c *Client) BatchDeleteDocument(ctx context.Context, params *BatchDeleteDocumentInput, optFns ...func(*Options)) (*BatchDeleteDocumentOutput, error)

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation. The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

func (*Client) BatchGetDocumentStatus added in v1.6.0 

func (c *Client) BatchGetDocumentStatus(ctx context.Context, params *BatchGetDocumentStatusInput, optFns ...func(*Options)) (*BatchGetDocumentStatusOutput, error)

Returns the indexing status for one or more documents submitted with the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) operation. When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed. You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

func (*Client) BatchPutDocument 

func (c *Client) BatchPutDocument(ctx context.Context, params *BatchPutDocumentInput, optFns ...func(*Options)) (*BatchPutDocumentOutput, error)

Adds one or more documents to an index. The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index. The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.

func (*Client) ClearQuerySuggestions added in v1.5.0 

func (c *Client) ClearQuerySuggestions(ctx context.Context, params *ClearQuerySuggestionsInput, optFns ...func(*Options)) (*ClearQuerySuggestionsOutput, error)

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.

func (*Client) CreateDataSource 

func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)

Creates a data source that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

func (*Client) CreateFaq 

func (c *Client) CreateFaq(ctx context.Context, params *CreateFaqInput, optFns ...func(*Options)) (*CreateFaqOutput, error)

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

func (*Client) CreateIndex 

func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error)

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use. Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.

func (*Client) CreateQuerySuggestionsBlockList added in v1.5.0 

func (c *Client) CreateQuerySuggestionsBlockList(ctx context.Context, params *CreateQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*CreateQuerySuggestionsBlockListOutput, error)

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

func (*Client) CreateThesaurus added in v0.31.0 

func (c *Client) CreateThesaurus(ctx context.Context, params *CreateThesaurusInput, optFns ...func(*Options)) (*CreateThesaurusOutput, error)

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

func (*Client) DeleteDataSource 

func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)

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

func (*Client) DeleteFaq 

func (c *Client) DeleteFaq(ctx context.Context, params *DeleteFaqInput, optFns ...func(*Options)) (*DeleteFaqOutput, error)

Removes an FAQ from an index.

func (*Client) DeleteIndex 

func (c *Client) DeleteIndex(ctx context.Context, params *DeleteIndexInput, optFns ...func(*Options)) (*DeleteIndexOutput, error)

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

func (*Client) DeletePrincipalMapping added in v1.9.0 

func (c *Client) DeletePrincipalMapping(ctx context.Context, params *DeletePrincipalMappingInput, optFns ...func(*Options)) (*DeletePrincipalMappingOutput, error)

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results. If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping.

func (*Client) DeleteQuerySuggestionsBlockList added in v1.5.0 

func (c *Client) DeleteQuerySuggestionsBlockList(ctx context.Context, params *DeleteQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*DeleteQuerySuggestionsBlockListOutput, error)

Deletes a block list used for query suggestions for an index. A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

func (*Client) DeleteThesaurus added in v0.31.0 

func (c *Client) DeleteThesaurus(ctx context.Context, params *DeleteThesaurusInput, optFns ...func(*Options)) (*DeleteThesaurusOutput, error)

Deletes an existing Amazon Kendra thesaurus.

func (*Client) DescribeDataSource 

func (c *Client) DescribeDataSource(ctx context.Context, params *DescribeDataSourceInput, optFns ...func(*Options)) (*DescribeDataSourceOutput, error)

Gets information about a Amazon Kendra data source.

func (*Client) DescribeFaq 

func (c *Client) DescribeFaq(ctx context.Context, params *DescribeFaqInput, optFns ...func(*Options)) (*DescribeFaqOutput, error)

Gets information about an FAQ list.

func (*Client) DescribeIndex 

func (c *Client) DescribeIndex(ctx context.Context, params *DescribeIndexInput, optFns ...func(*Options)) (*DescribeIndexOutput, error)

Describes an existing Amazon Kendra index

func (*Client) DescribePrincipalMapping added in v1.9.0 

func (c *Client) DescribePrincipalMapping(ctx context.Context, params *DescribePrincipalMappingInput, optFns ...func(*Options)) (*DescribePrincipalMappingOutput, error)

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

func (*Client) DescribeQuerySuggestionsBlockList added in v1.5.0 

func (c *Client) DescribeQuerySuggestionsBlockList(ctx context.Context, params *DescribeQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*DescribeQuerySuggestionsBlockListOutput, error)

Describes a block list used for query suggestions for an index. This is used to check the current settings that are applied to a block list.

func (*Client) DescribeQuerySuggestionsConfig added in v1.5.0 

func (c *Client) DescribeQuerySuggestionsConfig(ctx context.Context, params *DescribeQuerySuggestionsConfigInput, optFns ...func(*Options)) (*DescribeQuerySuggestionsConfigOutput, error)

Describes the settings of query suggestions for an index. This is used to check the current settings applied to query suggestions.

func (*Client) DescribeThesaurus added in v0.31.0 

func (c *Client) DescribeThesaurus(ctx context.Context, params *DescribeThesaurusInput, optFns ...func(*Options)) (*DescribeThesaurusOutput, error)

Describes an existing Amazon Kendra thesaurus.

func (*Client) GetQuerySuggestions added in v1.5.0 

func (c *Client) GetQuerySuggestions(ctx context.Context, params *GetQuerySuggestionsInput, optFns ...func(*Options)) (*GetQuerySuggestionsOutput, error)

Fetches the queries that are suggested to your users.

func (*Client) ListDataSourceSyncJobs 

func (c *Client) ListDataSourceSyncJobs(ctx context.Context, params *ListDataSourceSyncJobsInput, optFns ...func(*Options)) (*ListDataSourceSyncJobsOutput, error)

Gets statistics about synchronizing Amazon Kendra with a data source.

func (*Client) ListDataSources 

func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

Lists the data sources that you have created.

func (*Client) ListFaqs 

func (c *Client) ListFaqs(ctx context.Context, params *ListFaqsInput, optFns ...func(*Options)) (*ListFaqsOutput, error)

Gets a list of FAQ lists associated with an index.

func (*Client) ListGroupsOlderThanOrderingId added in v1.9.0 

func (c *Client) ListGroupsOlderThanOrderingId(ctx context.Context, params *ListGroupsOlderThanOrderingIdInput, optFns ...func(*Options)) (*ListGroupsOlderThanOrderingIdOutput, error)

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

func (*Client) ListIndices 

func (c *Client) ListIndices(ctx context.Context, params *ListIndicesInput, optFns ...func(*Options)) (*ListIndicesOutput, error)

Lists the Amazon Kendra indexes that you have created.

func (*Client) ListQuerySuggestionsBlockLists added in v1.5.0 

func (c *Client) ListQuerySuggestionsBlockLists(ctx context.Context, params *ListQuerySuggestionsBlockListsInput, optFns ...func(*Options)) (*ListQuerySuggestionsBlockListsOutput, error)

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

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

func (*Client) ListThesauri added in v0.31.0 

func (c *Client) ListThesauri(ctx context.Context, params *ListThesauriInput, optFns ...func(*Options)) (*ListThesauriOutput, error)

Lists the Amazon Kendra thesauri associated with an index.

func (*Client) PutPrincipalMapping added in v1.9.0 

func (c *Client) PutPrincipalMapping(ctx context.Context, params *PutPrincipalMappingInput, optFns ...func(*Options)) (*PutPrincipalMappingOutput, error)

Maps users to their groups so that you only need to provide the user ID when you issue the query. You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results. You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). If more than five PUT actions for a group are currently processing, a validation exception is thrown.

func (*Client) Query 

func (c *Client) Query(ctx context.Context, params *QueryInput, optFns ...func(*Options)) (*QueryOutput, error)

Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes. It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results. Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

* Relevant passages

* Matching FAQs

* Relevant documents

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter. Each query returns the 100 most relevant results.

func (*Client) StartDataSourceSyncJob 

func (c *Client) StartDataSourceSyncJob(ctx context.Context, params *StartDataSourceSyncJobInput, optFns ...func(*Options)) (*StartDataSourceSyncJobOutput, error)

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

func (*Client) StopDataSourceSyncJob 

func (c *Client) StopDataSourceSyncJob(ctx context.Context, params *StopDataSourceSyncJobInput, optFns ...func(*Options)) (*StopDataSourceSyncJobOutput, error)

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

func (*Client) SubmitFeedback 

func (c *Client) SubmitFeedback(ctx context.Context, params *SubmitFeedbackInput, optFns ...func(*Options)) (*SubmitFeedbackOutput, error)

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

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

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

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

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

func (*Client) UpdateDataSource 

func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)

Updates an existing Amazon Kendra data source.

func (*Client) UpdateIndex 

func (c *Client) UpdateIndex(ctx context.Context, params *UpdateIndexInput, optFns ...func(*Options)) (*UpdateIndexOutput, error)

Updates an existing Amazon Kendra index.

func (*Client) UpdateQuerySuggestionsBlockList added in v1.5.0 

func (c *Client) UpdateQuerySuggestionsBlockList(ctx context.Context, params *UpdateQuerySuggestionsBlockListInput, optFns ...func(*Options)) (*UpdateQuerySuggestionsBlockListOutput, error)

Updates a block list used for query suggestions for an index. Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately. If a block list is updating, then you need to wait for the first update to finish before submitting another update. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

func (*Client) UpdateQuerySuggestionsConfig added in v1.5.0 

func (c *Client) UpdateQuerySuggestionsConfig(ctx context.Context, params *UpdateQuerySuggestionsConfigInput, optFns ...func(*Options)) (*UpdateQuerySuggestionsConfigOutput, error)

Updates the settings of query suggestions for an index. Amazon Kendra supports partial updates, so you only need to provide the fields you want to update. If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update. Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index. You can still enable/disable query suggestions at any time.

func (*Client) UpdateThesaurus added in v0.31.0 

func (c *Client) UpdateThesaurus(ctx context.Context, params *UpdateThesaurusInput, optFns ...func(*Options)) (*UpdateThesaurusOutput, error)

Updates a thesaurus file associated with an index.

type CreateDataSourceInput 

type CreateDataSourceInput struct {

	// The identifier of the index that should be associated with this data source.
	//
	// This member is required.
	IndexId *string

	// A unique name for the data source. A data source name can't be changed without
	// deleting and recreating the data source.
	//
	// This member is required.
	Name *string

	// The type of repository that contains the data source.
	//
	// This member is required.
	Type types.DataSourceType

	// A token that you provide to identify the request to create a data source.
	// Multiple calls to the CreateDataSource operation with the same client token will
	// create only one data source.
	ClientToken *string

	// The connector configuration information that is required to access the
	// repository. You can't specify the Configuration parameter when the Type
	// parameter is set to CUSTOM. If you do, you receive a ValidationException
	// exception. The Configuration parameter is required for all other data sources.
	Configuration *types.DataSourceConfiguration

	// A description for the data source.
	Description *string

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

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

	// Sets the frequency that Amazon Kendra will check the documents in your
	// repository and update the index. If you don't set a schedule Amazon Kendra will
	// not periodically update the index. You can call the StartDataSourceSyncJob
	// operation to update the index. You can't specify the Schedule parameter when the
	// Type parameter is set to CUSTOM. If you do, you receive a ValidationException
	// exception.
	Schedule *string

	// A list of key-value pairs that identify the data source. You can use the tags to
	// identify and organize your resources and to control access to resources.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDataSourceOutput 

type CreateDataSourceOutput struct {

	// A unique identifier for the data source.
	//
	// This member is required.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFaqInput 

type CreateFaqInput struct {

	// The identifier of the index that contains the FAQ.
	//
	// This member is required.
	IndexId *string

	// The name that should be associated with the FAQ.
	//
	// This member is required.
	Name *string

	// 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).
	//
	// This member is required.
	RoleArn *string

	// The S3 location of the FAQ input data.
	//
	// This member is required.
	S3Path *types.S3Path

	// A token that you provide to identify the request to create a FAQ. Multiple calls
	// to the CreateFaqRequest operation with the same client token will create only
	// one FAQ.
	ClientToken *string

	// A description of the FAQ.
	Description *string

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

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

	// 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 []types.Tag
	// contains filtered or unexported fields
}

type CreateFaqOutput 

type CreateFaqOutput struct {

	// The unique identifier of the FAQ.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateIndexInput 

type CreateIndexInput struct {

	// The name for the new index.
	//
	// This member is required.
	Name *string

	// An Identity and Access Management(IAM) role that gives Amazon Kendra permissions
	// to access your Amazon CloudWatch logs and metrics. This is also the role used
	// when you use the BatchPutDocument operation to index documents from an Amazon S3
	// bucket.
	//
	// This member is required.
	RoleArn *string

	// A token that you provide to identify the request to create an index. Multiple
	// calls to the CreateIndex operation with the same client token will create only
	// one index.
	ClientToken *string

	// A description for the index.
	Description *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 types.IndexEdition

	// The identifier of the KMScustomer managed key (CMK) to use to encrypt data
	// indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.
	ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration

	// 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 []types.Tag

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

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

	// The user token configuration.
	UserTokenConfigurations []types.UserTokenConfiguration
	// contains filtered or unexported fields
}

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateQuerySuggestionsBlockListInput added in v1.5.0 

type CreateQuerySuggestionsBlockListInput struct {

	// The identifier of the index you want to create a query suggestions block list
	// for.
	//
	// This member is required.
	IndexId *string

	// 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.
	//
	// This member is required.
	Name *string

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

	// 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).
	//
	// This member is required.
	SourceS3Path *types.S3Path

	// A token that you provide to identify the request to create a query suggestions
	// block list.
	ClientToken *string

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

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

type CreateQuerySuggestionsBlockListOutput added in v1.5.0 

type CreateQuerySuggestionsBlockListOutput struct {

	// The unique identifier of the created block list.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateThesaurusInput added in v0.31.0 

type CreateThesaurusInput struct {

	// The unique identifier of the index for the new thesaurus.
	//
	// This member is required.
	IndexId *string

	// The name for the new thesaurus.
	//
	// This member is required.
	Name *string

	// An AWS Identity and Access Management (IAM) role that gives Amazon Kendra
	// permissions to access thesaurus file specified in SourceS3Path.
	//
	// This member is required.
	RoleArn *string

	// The thesaurus file Amazon S3 source path.
	//
	// This member is required.
	SourceS3Path *types.S3Path

	// A token that you provide to identify the request to create a thesaurus. Multiple
	// calls to the CreateThesaurus operation with the same client token will create
	// only one thesaurus.
	ClientToken *string

	// The description for the new thesaurus.
	Description *string

	// 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 []types.Tag
	// contains filtered or unexported fields
}

type CreateThesaurusOutput added in v0.31.0 

type CreateThesaurusOutput struct {

	// The unique identifier of the thesaurus.
	Id *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDataSourceInput 

type DeleteDataSourceInput struct {

	// The unique identifier of the data source to delete.
	//
	// This member is required.
	Id *string

	// The unique identifier of the index associated with the data source.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DeleteDataSourceOutput 

type DeleteDataSourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFaqInput 

type DeleteFaqInput struct {

	// The identifier of the FAQ to remove.
	//
	// This member is required.
	Id *string

	// The index to remove the FAQ from.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DeleteFaqOutput 

type DeleteFaqOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteIndexInput 

type DeleteIndexInput struct {

	// The identifier of the index to delete.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteIndexOutput 

type DeleteIndexOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeletePrincipalMappingInput added in v1.9.0 

type DeletePrincipalMappingInput struct {

	// The identifier of the group you want to delete.
	//
	// This member is required.
	GroupId *string

	// The identifier of the index you want to delete a group from.
	//
	// This member is required.
	IndexId *string

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

	// 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
	// contains filtered or unexported fields
}

type DeletePrincipalMappingOutput added in v1.9.0 

type DeletePrincipalMappingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteQuerySuggestionsBlockListInput added in v1.5.0 

type DeleteQuerySuggestionsBlockListInput struct {

	// The unique identifier of the block list that needs to be deleted.
	//
	// This member is required.
	Id *string

	// The identifier of the you want to delete a block list from.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DeleteQuerySuggestionsBlockListOutput added in v1.5.0 

type DeleteQuerySuggestionsBlockListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteThesaurusInput added in v0.31.0 

type DeleteThesaurusInput struct {

	// The identifier of the thesaurus to delete.
	//
	// This member is required.
	Id *string

	// The identifier of the index associated with the thesaurus to delete.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DeleteThesaurusOutput added in v0.31.0 

type DeleteThesaurusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDataSourceInput 

type DescribeDataSourceInput struct {

	// The unique identifier of the data source to describe.
	//
	// This member is required.
	Id *string

	// The identifier of the index that contains the data source.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DescribeDataSourceOutput 

type DescribeDataSourceOutput struct {

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

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

	// The description of the data source.
	Description *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

	// The identifier of the data source.
	Id *string

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

	// The name that you gave the data source when it was created.
	Name *string

	// The Amazon Resource Name (ARN) of the role that enables the data source to
	// access its resources.
	RoleArn *string

	// The schedule that Amazon Kendra will update the data source.
	Schedule *string

	// The current status of the data source. When the status is ACTIVE the data source
	// is ready to use. When the status is FAILED, the ErrorMessage field contains the
	// reason that the data source failed.
	Status types.DataSourceStatus

	// The type of the data source.
	Type types.DataSourceType

	// The Unix timestamp of when the data source was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFaqInput 

type DescribeFaqInput struct {

	// The unique identifier of the FAQ.
	//
	// This member is required.
	Id *string

	// The identifier of the index that contains the FAQ.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DescribeFaqOutput 

type DescribeFaqOutput struct {

	// The date and time that the FAQ was created.
	CreatedAt *time.Time

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

	// If the Status field is FAILED, the ErrorMessage field contains the reason why
	// the FAQ failed.
	ErrorMessage *string

	// The file format used by the input files for the FAQ.
	FileFormat types.FaqFileFormat

	// The identifier of the FAQ.
	Id *string

	// The identifier of the index that contains the FAQ.
	IndexId *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

	// The name that you gave the FAQ when it was created.
	Name *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

	// Information required to find a specific file in an Amazon S3 bucket.
	S3Path *types.S3Path

	// The status of the FAQ. It is ready to use when the status is ACTIVE.
	Status types.FaqStatus

	// The date and time that the FAQ was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeIndexInput 

type DescribeIndexInput struct {

	// The name of the index to describe.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DescribeIndexOutput 

type DescribeIndexOutput struct {

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

	// The Unix datetime that the index was created.
	CreatedAt *time.Time

	// The description of the index.
	Description *string

	// Configuration settings for any metadata applied to the documents in the index.
	DocumentMetadataConfigurations []types.DocumentMetadataConfiguration

	// The Amazon Kendra edition used for the index. You decide the edition when you
	// create the index.
	Edition types.IndexEdition

	// When th eStatus field value is FAILED, the ErrorMessage field contains a message
	// that explains why.
	ErrorMessage *string

	// The name of the index.
	Id *string

	// Provides information about the number of FAQ questions and answers and the
	// number of text documents indexed.
	IndexStatistics *types.IndexStatistics

	// The name of the index.
	Name *string

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

	// The identifier of the KMScustomer master key (CMK) used to encrypt your data.
	// Amazon Kendra doesn't support asymmetric CMKs.
	ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration

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

	// The Unix datetime that the index was last updated.
	UpdatedAt *time.Time

	// The user context policy for the Amazon Kendra index.
	UserContextPolicy types.UserContextPolicy

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

	// The user token configuration for the Amazon Kendra index.
	UserTokenConfigurations []types.UserTokenConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribePrincipalMappingInput added in v1.9.0 

type DescribePrincipalMappingInput struct {

	// The identifier of the group required to check the processing of PUT and DELETE
	// actions for mapping users to their groups.
	//
	// This member is required.
	GroupId *string

	// The identifier of the index required to check the processing of PUT and DELETE
	// actions for mapping users to their groups.
	//
	// This member is required.
	IndexId *string

	// The identifier of the data source to check the processing of PUT and DELETE
	// actions for mapping users to their groups.
	DataSourceId *string
	// contains filtered or unexported fields
}

type DescribePrincipalMappingOutput added in v1.9.0 

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

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

	// 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 []types.GroupOrderingIdSummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeQuerySuggestionsBlockListInput added in v1.5.0 

type DescribeQuerySuggestionsBlockListInput struct {

	// The unique identifier of the block list.
	//
	// This member is required.
	Id *string

	// The identifier of the index for the block list.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DescribeQuerySuggestionsBlockListOutput added in v1.5.0 

type DescribeQuerySuggestionsBlockListOutput struct {

	// Shows the date-time a block list for query suggestions was created.
	CreatedAt *time.Time

	// Shows the description for the block list.
	Description *string

	// Shows the error message with details when there are issues in processing the
	// block list.
	ErrorMessage *string

	// Shows the current size of the block list text file in S3.
	FileSizeBytes *int64

	// Shows the unique identifier of the block list.
	Id *string

	// Shows the identifier of the index for the block list.
	IndexId *string

	// Shows the current number of valid, non-empty words or phrases in the block list
	// text file.
	ItemCount *int32

	// Shows the name of the block list.
	Name *string

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

	// 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 *types.S3Path

	// Shows whether the current status of the block list is ACTIVE or INACTIVE.
	Status types.QuerySuggestionsBlockListStatus

	// Shows the date-time a block list for query suggestions was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeQuerySuggestionsConfigInput added in v1.5.0 

type DescribeQuerySuggestionsConfigInput struct {

	// The identifier of the index you want to describe query suggestions settings for.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DescribeQuerySuggestionsConfigOutput added in v1.5.0 

type DescribeQuerySuggestionsConfigOutput struct {

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

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

	// Shows the date-time query suggestions for an index was last updated.
	LastSuggestionsBuildTime *time.Time

	// Shows the minimum number of unique users who must search a query in order for
	// the query to be eligible to suggest to your users.
	MinimumNumberOfQueryingUsers *int32

	// Shows the minimum number of times a query must be searched in order for the
	// query to be eligible to suggest to your users.
	MinimumQueryCount *int32

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

	// Shows how recent your queries are in your query log time window (in days).
	QueryLogLookBackWindowInDays *int32

	// Shows whether the status of query suggestions settings is currently Active or
	// Updating. Active means the current settings apply and Updating means your
	// changed settings are in the process of applying.
	Status types.QuerySuggestionsStatus

	// Shows the current total count of query suggestions for an index. This count can
	// change when you update your query suggestions settings, if you filter out
	// certain queries from suggestions using a block list, and as the query log
	// accumulates more queries for Amazon Kendra to learn from.
	TotalSuggestionsCount *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeThesaurusInput added in v0.31.0 

type DescribeThesaurusInput struct {

	// The identifier of the thesaurus to describe.
	//
	// This member is required.
	Id *string

	// The identifier of the index associated with the thesaurus to describe.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type DescribeThesaurusOutput added in v0.31.0 

type DescribeThesaurusOutput struct {

	// The Unix datetime that the thesaurus was created.
	CreatedAt *time.Time

	// The thesaurus description.
	Description *string

	// When the Status field value is FAILED, the ErrorMessage field provides more
	// information.
	ErrorMessage *string

	// The size of the thesaurus file in bytes.
	FileSizeBytes *int64

	// The identifier of the thesaurus.
	Id *string

	// The identifier of the index associated with the thesaurus to describe.
	IndexId *string

	// The thesaurus name.
	Name *string

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

	// Information required to find a specific file in an Amazon S3 bucket.
	SourceS3Path *types.S3Path

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

	// The number of synonym rules in the thesaurus file.
	SynonymRuleCount *int64

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

	// The Unix datetime that the thesaurus was last updated.
	UpdatedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetQuerySuggestionsInput added in v1.5.0 

type GetQuerySuggestionsInput struct {

	// The identifier of the index you want to get query suggestions from.
	//
	// This member is required.
	IndexId *string

	// 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.
	//
	// This member is required.
	QueryText *string

	// The maximum number of query suggestions you want to show to your users.
	MaxSuggestionsCount *int32
	// contains filtered or unexported fields
}

type GetQuerySuggestionsOutput added in v1.5.0 

type GetQuerySuggestionsOutput struct {

	// The unique identifier for a list of query suggestions for an index.
	QuerySuggestionsId *string

	// A list of query suggestions for an index.
	Suggestions []types.Suggestion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListDataSourceSyncJobsAPIClient added in v0.30.0 

type ListDataSourceSyncJobsAPIClient interface {
	ListDataSourceSyncJobs(context.Context, *ListDataSourceSyncJobsInput, ...func(*Options)) (*ListDataSourceSyncJobsOutput, error)
}

ListDataSourceSyncJobsAPIClient is a client that implements the ListDataSourceSyncJobs operation.

type ListDataSourceSyncJobsInput 

type ListDataSourceSyncJobsInput struct {

	// The identifier of the data source.
	//
	// This member is required.
	Id *string

	// The identifier of the index that contains the data source.
	//
	// This member is required.
	IndexId *string

	// The maximum number of synchronization jobs to return in the response. If there
	// are fewer results in the list, this response contains only the actual results.
	MaxResults *int32

	// If the previous response was incomplete (because there is more data to
	// retrieve), Amazon Kendra returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of jobs.
	NextToken *string

	// When specified, the synchronization jobs returned in the list are limited to
	// jobs between the specified dates.
	StartTimeFilter *types.TimeRange

	// When specified, only returns synchronization jobs with the Status field equal to
	// the specified status.
	StatusFilter types.DataSourceSyncJobStatus
	// contains filtered or unexported fields
}

type ListDataSourceSyncJobsOutput 

type ListDataSourceSyncJobsOutput struct {

	// A history of synchronization jobs for the data source.
	History []types.DataSourceSyncJob

	// If the response is truncated, Amazon Kendra returns this token that you can use
	// in the subsequent request to retrieve the next set of jobs.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataSourceSyncJobsPaginator added in v0.30.0 

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

ListDataSourceSyncJobsPaginator is a paginator for ListDataSourceSyncJobs

func NewListDataSourceSyncJobsPaginator added in v0.30.0 

func NewListDataSourceSyncJobsPaginator(client ListDataSourceSyncJobsAPIClient, params *ListDataSourceSyncJobsInput, optFns ...func(*ListDataSourceSyncJobsPaginatorOptions)) *ListDataSourceSyncJobsPaginator

NewListDataSourceSyncJobsPaginator returns a new ListDataSourceSyncJobsPaginator

func (*ListDataSourceSyncJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListDataSourceSyncJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataSourceSyncJobsPaginator) NextPage added in v0.30.0 

func (p *ListDataSourceSyncJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourceSyncJobsOutput, error)

NextPage retrieves the next ListDataSourceSyncJobs page.

type ListDataSourceSyncJobsPaginatorOptions added in v0.30.0 

type ListDataSourceSyncJobsPaginatorOptions struct {
	// The maximum number of synchronization jobs to return in the response. If there
	// are fewer results in the list, this response contains only the actual results.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataSourceSyncJobsPaginatorOptions is the paginator options for ListDataSourceSyncJobs

type ListDataSourcesAPIClient added in v0.30.0 

type ListDataSourcesAPIClient interface {
	ListDataSources(context.Context, *ListDataSourcesInput, ...func(*Options)) (*ListDataSourcesOutput, error)
}

ListDataSourcesAPIClient is a client that implements the ListDataSources operation.

type ListDataSourcesInput 

type ListDataSourcesInput struct {

	// The identifier of the index that contains the data source.
	//
	// This member is required.
	IndexId *string

	// The maximum number of data sources to return.
	MaxResults *int32

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

type ListDataSourcesOutput 

type ListDataSourcesOutput struct {

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

	// An array of summary information for one or more data sources.
	SummaryItems []types.DataSourceSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataSourcesPaginator added in v0.30.0 

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

ListDataSourcesPaginator is a paginator for ListDataSources

func NewListDataSourcesPaginator added in v0.30.0 

func NewListDataSourcesPaginator(client ListDataSourcesAPIClient, params *ListDataSourcesInput, optFns ...func(*ListDataSourcesPaginatorOptions)) *ListDataSourcesPaginator

NewListDataSourcesPaginator returns a new ListDataSourcesPaginator

func (*ListDataSourcesPaginator) HasMorePages added in v0.30.0 

func (p *ListDataSourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataSourcesPaginator) NextPage added in v0.30.0 

func (p *ListDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

NextPage retrieves the next ListDataSources page.

type ListDataSourcesPaginatorOptions added in v0.30.0 

type ListDataSourcesPaginatorOptions struct {
	// The maximum number of data sources to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataSourcesPaginatorOptions is the paginator options for ListDataSources

type ListFaqsInput 

type ListFaqsInput struct {

	// The index that contains the FAQ lists.
	//
	// This member is required.
	IndexId *string

	// The maximum number of FAQs to return in the response. If there are fewer results
	// in the list, this response contains only the actual results.
	MaxResults *int32

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

type ListFaqsOutput 

type ListFaqsOutput struct {

	// information about the FAQs associated with the specified index.
	FaqSummaryItems []types.FaqSummary

	// If the response is truncated, Amazon Kendra returns this token that you can use
	// in the subsequent request to retrieve the next set of FAQs.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGroupsOlderThanOrderingIdInput added in v1.9.0 

type ListGroupsOlderThanOrderingIdInput struct {

	// The identifier of the index for getting a list of groups mapped to users before
	// a given ordering or timestamp identifier.
	//
	// This member is required.
	IndexId *string

	// The timestamp identifier used for the latest PUT or DELETE action for mapping
	// users to their groups.
	//
	// This member is required.
	OrderingId *int64

	// The identifier of the data source for getting a list of groups mapped to users
	// before a given ordering timestamp identifier.
	DataSourceId *string

	// The maximum number of returned groups that are mapped to users before a given
	// ordering or timestamp identifier.
	MaxResults *int32

	// If the previous response was incomplete (because there is more data to
	// retrieve), Amazon Kendra returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of groups that are mapped to
	// users before a given ordering or timestamp identifier.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGroupsOlderThanOrderingIdOutput added in v1.9.0 

type ListGroupsOlderThanOrderingIdOutput struct {

	// Summary information for list of groups that are mapped to users before a given
	// ordering or timestamp identifier.
	GroupsSummaries []types.GroupSummary

	// If the response is truncated, Amazon Kendra returns this token that you can use
	// in the subsequent request to retrieve the next set of groups that are mapped to
	// users before a given ordering or timestamp identifier.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIndicesAPIClient added in v0.30.0 

type ListIndicesAPIClient interface {
	ListIndices(context.Context, *ListIndicesInput, ...func(*Options)) (*ListIndicesOutput, error)
}

ListIndicesAPIClient is a client that implements the ListIndices operation.

type ListIndicesInput 

type ListIndicesInput struct {

	// The maximum number of data sources to return.
	MaxResults *int32

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

type ListIndicesOutput 

type ListIndicesOutput struct {

	// An array of summary information for one or more indexes.
	IndexConfigurationSummaryItems []types.IndexConfigurationSummary

	// If the response is truncated, Amazon Kendra returns this token that you can use
	// in the subsequent request to retrieve the next set of indexes.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIndicesPaginator added in v0.30.0 

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

ListIndicesPaginator is a paginator for ListIndices

func NewListIndicesPaginator added in v0.30.0 

func NewListIndicesPaginator(client ListIndicesAPIClient, params *ListIndicesInput, optFns ...func(*ListIndicesPaginatorOptions)) *ListIndicesPaginator

NewListIndicesPaginator returns a new ListIndicesPaginator

func (*ListIndicesPaginator) HasMorePages added in v0.30.0 

func (p *ListIndicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIndicesPaginator) NextPage added in v0.30.0 

func (p *ListIndicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIndicesOutput, error)

NextPage retrieves the next ListIndices page.

type ListIndicesPaginatorOptions added in v0.30.0 

type ListIndicesPaginatorOptions struct {
	// The maximum number of data sources to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIndicesPaginatorOptions is the paginator options for ListIndices

type ListQuerySuggestionsBlockListsInput added in v1.5.0 

type ListQuerySuggestionsBlockListsInput struct {

	// The identifier of the index for a list of all block lists that exist for that
	// index. For information on the current quota limits for block lists, see Quotas
	// for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	//
	// This member is required.
	IndexId *string

	// The maximum number of block lists to return.
	MaxResults *int32

	// If the previous response was incomplete (because there is more data to
	// retrieve), Amazon Kendra returns a pagination token in the response. You can use
	// this pagination token to retrieve the next set of block lists
	// (BlockListSummaryItems).
	NextToken *string
	// contains filtered or unexported fields
}

type ListQuerySuggestionsBlockListsOutput added in v1.5.0 

type ListQuerySuggestionsBlockListsOutput struct {

	// Summary items for a block list. This includes summary items on the block list
	// ID, block list name, when the block list was created, when the block list was
	// last updated, and the count of block words/phrases in the block list. For
	// information on the current quota limits for block lists, see Quotas for Amazon
	// Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).
	BlockListSummaryItems []types.QuerySuggestionsBlockListSummary

	// If the response is truncated, Amazon Kendra returns this token that you can use
	// in the subsequent request to retrieve the next set of block lists.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list
	// of tags for.
	//
	// This member is required.
	ResourceARN *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of tags associated with the index, FAQ, or data source.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListThesauriInput added in v0.31.0 

type ListThesauriInput struct {

	// The identifier of the index associated with the thesaurus to list.
	//
	// This member is required.
	IndexId *string

	// The maximum number of thesauri to return.
	MaxResults *int32

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

type ListThesauriOutput added in v0.31.0 

type ListThesauriOutput struct {

	// If the response is truncated, Amazon Kendra returns this token that you can use
	// in the subsequent request to retrieve the next set of thesauri.
	NextToken *string

	// An array of summary information for a thesaurus or multiple thesauri.
	ThesaurusSummaryItems []types.ThesaurusSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PutPrincipalMappingInput added in v1.9.0 

type PutPrincipalMappingInput struct {

	// The identifier of the group you want to map its users to.
	//
	// This member is required.
	GroupId *string

	// The list that contains your users or sub groups that belong the same group. For
	// example, the group "Company" includes the user "CEO" and the sub groups
	// "Research", "Engineering", and "Sales and Marketing". If you have more than 1000
	// users and/or sub groups for a single group, you need to provide the path to the
	// S3 file that lists your users and sub groups for a group. Your sub groups can
	// contain more than 1000 users, but the list of sub groups that belong to a group
	// (and/or users) must be no more than 1000.
	//
	// This member is required.
	GroupMembers *types.GroupMembers

	// The identifier of the index you want to map users to their groups.
	//
	// This member is required.
	IndexId *string

	// The identifier of the data source you want to map users to their groups. This is
	// useful if a group is tied to multiple data sources, but you only want the group
	// to access documents of a certain data source. For example, the groups
	// "Research", "Engineering", and "Sales and Marketing" are all tied to the
	// company's documents stored in the data sources Confluence and Salesforce.
	// However, "Sales and Marketing" team only needs access to customer-related
	// documents stored in Salesforce.
	DataSourceId *string

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

	// The Amazon Resource Name (ARN) of a role that has access to the S3 file that
	// contains your list of users or sub groups that belong to a group. For more
	// information, see IAM roles for Amazon Kendra
	// (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds).
	RoleArn *string
	// contains filtered or unexported fields
}

type PutPrincipalMappingOutput added in v1.9.0 

type PutPrincipalMappingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type QueryInput 

type QueryInput struct {

	// The unique identifier of the index to search. The identifier is returned in the
	// response from the CreateIndex operation.
	//
	// This member is required.
	IndexId *string

	// The text to search for.
	//
	// This member is required.
	QueryText *string

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

	// Overrides relevance tuning configurations of fields or attributes set at the
	// index level. If you use this API to override the relevance tuning configured at
	// the index level, but there is no relevance tuning configured at the index level,
	// then Amazon Kendra does not apply any relevance tuning. If there is relevance
	// tuning configured at the index level, but you do not use this API to override
	// any relevance tuning in the index, then Amazon Kendra uses the relevance tuning
	// that is configured at the index level. If there is relevance tuning configured
	// for fields at the index level, but you use this API to override only some of
	// these fields, then for the fields you did not override, the importance is set to
	// 1.
	DocumentRelevanceOverrideConfigurations []types.DocumentRelevanceConfiguration

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

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

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

	// Sets the type of query. Only results for the specified query type are returned.
	QueryResultTypeFilter types.QueryResultType

	// An array of document attributes to include in the response. No other document
	// attributes are included in the response. By default all document attributes are
	// included in the response.
	RequestedDocumentAttributes []string

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

	// The user context token or user and group information.
	UserContext *types.UserContext

	// Provides an identifier for a specific user. The VisitorId should be a unique
	// identifier, such as a GUID. Don't use personally identifiable information, such
	// as the user's email address, as the VisitorId.
	VisitorId *string
	// contains filtered or unexported fields
}

type QueryOutput 

type QueryOutput struct {

	// Contains the facet results. A FacetResult contains the counts for each attribute
	// key that was specified in the Facets input parameter.
	FacetResults []types.FacetResult

	// The unique identifier for the search. You use QueryId to identify the search
	// when using the feedback API.
	QueryId *string

	// The results of the search.
	ResultItems []types.QueryResultItem

	// The total number of items found by the search; however, you can only retrieve up
	// to 100 items. For example, if the search found 192 items, you can only retrieve
	// the first 100 of the items.
	TotalNumberOfResults *int32

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartDataSourceSyncJobInput 

type StartDataSourceSyncJobInput struct {

	// The identifier of the data source to synchronize.
	//
	// This member is required.
	Id *string

	// The identifier of the index that contains the data source.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type StartDataSourceSyncJobOutput 

type StartDataSourceSyncJobOutput struct {

	// Identifies a particular synchronization job.
	ExecutionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopDataSourceSyncJobInput 

type StopDataSourceSyncJobInput struct {

	// The identifier of the data source for which to stop the synchronization jobs.
	//
	// This member is required.
	Id *string

	// The identifier of the index that contains the data source.
	//
	// This member is required.
	IndexId *string
	// contains filtered or unexported fields
}

type StopDataSourceSyncJobOutput 

type StopDataSourceSyncJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SubmitFeedbackInput 

type SubmitFeedbackInput struct {

	// The identifier of the index that was queried.
	//
	// This member is required.
	IndexId *string

	// The identifier of the specific query for which you are submitting feedback. The
	// query ID is returned in the response to the Query operation.
	//
	// This member is required.
	QueryId *string

	// Tells Amazon Kendra that a particular search result link was chosen by the user.
	ClickFeedbackItems []types.ClickFeedback

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

type SubmitFeedbackOutput 

type SubmitFeedbackOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag.
	//
	// This member is required.
	ResourceARN *string

	// A list of tag keys to add to the index, FAQ, or data source. If a tag already
	// exists, the existing value is replaced with the new value.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the
	// tag from.
	//
	// This member is required.
	ResourceARN *string

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

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataSourceInput 

type UpdateDataSourceInput struct {

	// The unique identifier of the data source to update.
	//
	// This member is required.
	Id *string

	// The identifier of the index that contains the data source to update.
	//
	// This member is required.
	IndexId *string

	// Configuration information for a Amazon Kendra data source.
	Configuration *types.DataSourceConfiguration

	// The new description for the data source.
	Description *string

	// The code for a language. This allows you to support a language for all documents
	// when updating 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

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

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

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

type UpdateDataSourceOutput 

type UpdateDataSourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateIndexInput 

type UpdateIndexInput struct {

	// The identifier of the index to update.
	//
	// This member is required.
	Id *string

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

	// A new description for the index.
	Description *string

	// The document metadata to update.
	DocumentMetadataConfigurationUpdates []types.DocumentMetadataConfiguration

	// The name of the index to update.
	Name *string

	// A new IAM role that gives Amazon Kendra permission to access your Amazon
	// CloudWatch logs.
	RoleArn *string

	// The user context policy.
	UserContextPolicy types.UserContextPolicy

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

	// The user token configuration.
	UserTokenConfigurations []types.UserTokenConfiguration
	// contains filtered or unexported fields
}

type UpdateIndexOutput 

type UpdateIndexOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateQuerySuggestionsBlockListInput added in v1.5.0 

type UpdateQuerySuggestionsBlockListInput struct {

	// The unique identifier of a block list.
	//
	// This member is required.
	Id *string

	// The identifier of the index for a block list.
	//
	// This member is required.
	IndexId *string

	// The description for a block list.
	Description *string

	// The name of a block list.
	Name *string

	// The IAM (Identity and Access Management) role used to access the block list text
	// file in S3.
	RoleArn *string

	// The S3 path where your block list text file sits in S3. If you update your block
	// list and provide the same path to the block list text file in S3, then Amazon
	// Kendra reloads the file to refresh the block list. Amazon Kendra does not
	// automatically refresh your block list. You need to call the
	// UpdateQuerySuggestionsBlockList API to refresh you block list. If you update
	// your block list, then Amazon Kendra asynchronously refreshes all query
	// suggestions with the latest content in the S3 file. This means changes might not
	// take effect immediately.
	SourceS3Path *types.S3Path
	// contains filtered or unexported fields
}

type UpdateQuerySuggestionsBlockListOutput added in v1.5.0 

type UpdateQuerySuggestionsBlockListOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateQuerySuggestionsConfigInput added in v1.5.0 

type UpdateQuerySuggestionsConfigInput struct {

	// The identifier of the index you want to update query suggestions settings for.
	//
	// This member is required.
	IndexId *string

	// TRUE to include queries without user information (i.e. all queries, irrespective
	// of the user), otherwise FALSE to only include queries with user information. If
	// you pass user information to Amazon Kendra along with the queries, you can set
	// this flag to FALSE and instruct Amazon Kendra to only consider queries with user
	// information. If you set to FALSE, Amazon Kendra only considers queries searched
	// at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique
	// users for suggestions. If you set to TRUE, Amazon Kendra ignores all user
	// information and learns from all queries.
	IncludeQueriesWithoutUserInformation *bool

	// The minimum number of unique users who must search a query in order for the
	// query to be eligible to suggest to your users. Increasing this number might
	// decrease the number of suggestions. However, this ensures a query is searched by
	// many users and is truly popular to suggest to users. How you tune this setting
	// depends on your specific needs.
	MinimumNumberOfQueryingUsers *int32

	// The the minimum number of times a query must be searched in order to be eligible
	// to suggest to your users. Decreasing this number increases the number of
	// suggestions. However, this affects the quality of suggestions as it sets a low
	// bar for a query to be considered popular to suggest to users. How you tune this
	// setting depends on your specific needs.
	MinimumQueryCount *int32

	// Set the mode to ENABLED or LEARN_ONLY. By default, Amazon Kendra enables query
	// suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can
	// to update this at any time. In LEARN_ONLY mode, Amazon Kendra continues to learn
	// from new queries to keep suggestions up to date for when you are ready to switch
	// to ENABLED mode again.
	Mode types.Mode

	// How recent your queries are in your query log time window. The time window is
	// the number of days from current day to past days. By default, Amazon Kendra sets
	// this to 180.
	QueryLogLookBackWindowInDays *int32
	// contains filtered or unexported fields
}

type UpdateQuerySuggestionsConfigOutput added in v1.5.0 

type UpdateQuerySuggestionsConfigOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateThesaurusInput added in v0.31.0 

type UpdateThesaurusInput struct {

	// The identifier of the thesaurus to update.
	//
	// This member is required.
	Id *string

	// The identifier of the index associated with the thesaurus to update.
	//
	// This member is required.
	IndexId *string

	// The updated description of the thesaurus.
	Description *string

	// The updated name of the thesaurus.
	Name *string

	// The updated role ARN of the thesaurus.
	RoleArn *string

	// Information required to find a specific file in an Amazon S3 bucket.
	SourceS3Path *types.S3Path
	// contains filtered or unexported fields
}

type UpdateThesaurusOutput added in v0.31.0 

type UpdateThesaurusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.