[−][src]Crate rusoto_kendra
Amazon Kendra is a service for indexing large document sets.
If you're using the service, you're probably looking for KendraClient and Kendra.
Structs
| AccessControlListConfiguration | Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources. |
| AclConfiguration | Provides information about the column that should be used for filtering the query response by groups. |
| AdditionalResultAttribute | An attribute returned from an index query. |
| AdditionalResultAttributeValue | An attribute returned with a document from a search. |
| AttributeFilter | Provides filtering the query results based on document attributes. When you use the
If you use more than 2 layers, you receive a |
| BatchDeleteDocumentRequest | |
| BatchDeleteDocumentResponse | |
| BatchDeleteDocumentResponseFailedDocument | Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation. |
| BatchPutDocumentRequest | |
| BatchPutDocumentResponse | |
| BatchPutDocumentResponseFailedDocument | Provides information about a document that could not be indexed. |
| CapacityUnitsConfiguration | Specifies capacity units configured for your index. You can add and remove capacity units to tune an index to your requirements. |
| ClickFeedback | Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information. |
| ColumnConfiguration | Provides information about how Amazon Kendra should use the columns of a database in an index. |
| ConfluenceAttachmentConfiguration | Specifies the attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them. |
| ConfluenceAttachmentToIndexFieldMapping | Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation. |
| ConfluenceBlogConfiguration | Specifies the blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the |
| ConfluenceBlogToIndexFieldMapping | Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation. |
| ConfluenceConfiguration | Provides configuration information for data sources that connect to Confluence. |
| ConfluencePageConfiguration | Specifies the page settings for the Confluence data source. |
| ConfluencePageToIndexFieldMapping | Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation. |
| ConfluenceSpaceConfiguration | Specifies the configuration for indexing Confluence spaces. |
| ConfluenceSpaceToIndexFieldMapping | Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation. |
| ConnectionConfiguration | Provides the information necessary to connect to a database. |
| CreateDataSourceRequest | |
| CreateDataSourceResponse | |
| CreateFaqRequest | |
| CreateFaqResponse | |
| CreateIndexRequest | |
| CreateIndexResponse | |
| CreateThesaurusRequest | |
| CreateThesaurusResponse | |
| DataSourceConfiguration | Configuration information for a Amazon Kendra data source. |
| DataSourceSummary | Summary information for a Amazon Kendra data source. Returned in a call to . |
| DataSourceSyncJob | Provides information about a synchronization job. |
| DataSourceSyncJobMetricTarget | Maps a particular data source sync job to a particular data source. |
| DataSourceSyncJobMetrics | Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector. |
| DataSourceToIndexFieldMapping | Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation. |
| DataSourceVpcConfiguration | Provides information for connecting to an Amazon VPC. |
| DatabaseConfiguration | Provides the information necessary to connect a database to an index. |
| DeleteDataSourceRequest | |
| DeleteFaqRequest | |
| DeleteIndexRequest | |
| DeleteThesaurusRequest | |
| DescribeDataSourceRequest | |
| DescribeDataSourceResponse | |
| DescribeFaqRequest | |
| DescribeFaqResponse | |
| DescribeIndexRequest | |
| DescribeIndexResponse | |
| DescribeThesaurusRequest | |
| DescribeThesaurusResponse | |
| Document | A document in an index. |
| DocumentAttribute | A custom attribute value assigned to a document. |
| DocumentAttributeValue | The value of a custom document attribute. You can only provide one value for a custom attribute. |
| DocumentAttributeValueCountPair | Provides the count of documents that match a particular attribute when doing a faceted search. |
| DocumentMetadataConfiguration | Specifies the properties of a custom index field. |
| DocumentsMetadataConfiguration | Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document. |
| Facet | Information about a document attribute |
| FacetResult | The facet values for the documents in the response. |
| FaqStatistics | Provides statistical information about the FAQ questions and answers contained in an index. |
| FaqSummary | Provides information about a frequently asked questions and answer contained in an index. |
| GoogleDriveConfiguration | Provides configuration information for data sources that connect to Google Drive. |
| Highlight | Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response. |
| IndexConfigurationSummary | A summary of information about an index. |
| IndexStatistics | Provides information about the number of documents and the number of questions and answers in an index. |
| JsonTokenTypeConfiguration | Configuration information for the JSON token type. |
| JwtTokenTypeConfiguration | Configuration information for the JWT token type. |
| KendraClient | A client for the kendra API. |
| ListDataSourceSyncJobsRequest | |
| ListDataSourceSyncJobsResponse | |
| ListDataSourcesRequest | |
| ListDataSourcesResponse | |
| ListFaqsRequest | |
| ListFaqsResponse | |
| ListIndicesRequest | |
| ListIndicesResponse | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResponse | |
| ListThesauriRequest | |
| ListThesauriResponse | |
| OneDriveConfiguration | Provides configuration information for data sources that connect to OneDrive. |
| OneDriveUsers | User accounts whose documents should be indexed. |
| Principal | Provides user and group information for document access filtering. |
| QueryRequest | |
| QueryResult | |
| QueryResultItem | A single query result. A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query. |
| Relevance | Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters. |
| RelevanceFeedback | Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information. |
| S3DataSourceConfiguration | Provides configuration information for a data source to index documents in an Amazon S3 bucket. |
| S3Path | Information required to find a specific file in an Amazon S3 bucket. |
| SalesforceChatterFeedConfiguration | Defines configuration for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table. |
| SalesforceConfiguration | Provides configuration information for connecting to a Salesforce data source. |
| SalesforceCustomKnowledgeArticleTypeConfiguration | Provides configuration information for indexing Salesforce custom articles. |
| SalesforceKnowledgeArticleConfiguration | Specifies configuration information for the knowlege article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both |
| SalesforceStandardKnowledgeArticleTypeConfiguration | Provides configuration information for standard Salesforce knowledge articles. |
| SalesforceStandardObjectAttachmentConfiguration | Provides configuration information for processing attachments to Salesforce standard objects. |
| SalesforceStandardObjectConfiguration | Specifies confguration information for indexing a single standard object. |
| ScoreAttributes | Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query. |
| Search | Provides information about how a custom index field is used during a search. |
| ServerSideEncryptionConfiguration | Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. |
| ServiceNowConfiguration | Provides configuration information required to connect to a ServiceNow data source. |
| ServiceNowKnowledgeArticleConfiguration | Provides configuration information for crawling knowledge articles in the ServiceNow site. |
| ServiceNowServiceCatalogConfiguration | Provides configuration information for crawling service catalog items in the ServiceNow site |
| SharePointConfiguration | Provides configuration information for connecting to a Microsoft SharePoint data source. |
| SortingConfiguration | Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the You can sort attributes of the following types.
You can't sort attributes of the following type.
|
| SqlConfiguration | Provides information that configures Amazon Kendra to use a SQL database. |
| StartDataSourceSyncJobRequest | |
| StartDataSourceSyncJobResponse | |
| StopDataSourceSyncJobRequest | |
| SubmitFeedbackRequest | |
| Tag | A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. |
| TagResourceRequest | |
| TagResourceResponse | |
| TextDocumentStatistics | Provides information about text documents indexed in an index. |
| TextWithHighlights | Provides text and information about where to highlight the text. |
| ThesaurusSummary | An array of summary information for one or more thesauruses. |
| TimeRange | Provides a range of time. |
| UntagResourceRequest | |
| UntagResourceResponse | |
| UpdateDataSourceRequest | |
| UpdateIndexRequest | |
| UpdateThesaurusRequest | |
| UserContext | Provides information about the user context for a Amazon Kendra index. |
| UserTokenConfiguration | Provides configuration information for a token configuration. |
Enums
| BatchDeleteDocumentError | Errors returned by BatchDeleteDocument |
| BatchPutDocumentError | Errors returned by BatchPutDocument |
| CreateDataSourceError | Errors returned by CreateDataSource |
| CreateFaqError | Errors returned by CreateFaq |
| CreateIndexError | Errors returned by CreateIndex |
| CreateThesaurusError | Errors returned by CreateThesaurus |
| DeleteDataSourceError | Errors returned by DeleteDataSource |
| DeleteFaqError | Errors returned by DeleteFaq |
| DeleteIndexError | Errors returned by DeleteIndex |
| DeleteThesaurusError | Errors returned by DeleteThesaurus |
| DescribeDataSourceError | Errors returned by DescribeDataSource |
| DescribeFaqError | Errors returned by DescribeFaq |
| DescribeIndexError | Errors returned by DescribeIndex |
| DescribeThesaurusError | Errors returned by DescribeThesaurus |
| ListDataSourceSyncJobsError | Errors returned by ListDataSourceSyncJobs |
| ListDataSourcesError | Errors returned by ListDataSources |
| ListFaqsError | Errors returned by ListFaqs |
| ListIndicesError | Errors returned by ListIndices |
| ListTagsForResourceError | Errors returned by ListTagsForResource |
| ListThesauriError | Errors returned by ListThesauri |
| QueryError | Errors returned by Query |
| StartDataSourceSyncJobError | Errors returned by StartDataSourceSyncJob |
| StopDataSourceSyncJobError | Errors returned by StopDataSourceSyncJob |
| SubmitFeedbackError | Errors returned by SubmitFeedback |
| TagResourceError | Errors returned by TagResource |
| UntagResourceError | Errors returned by UntagResource |
| UpdateDataSourceError | Errors returned by UpdateDataSource |
| UpdateIndexError | Errors returned by UpdateIndex |
| UpdateThesaurusError | Errors returned by UpdateThesaurus |
Traits
| Kendra | Trait representing the capabilities of the kendra API. kendra clients implement this trait. |