aws-sdk-kendra 1.52.0 → 1.53.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +156 -6
- data/lib/aws-sdk-kendra/client_api.rb +23 -0
- data/lib/aws-sdk-kendra/types.rb +373 -68
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 672ae54de47e382dfa52718a719162eb262219403eb879955ba165f90b0c8d02
|
4
|
+
data.tar.gz: fb3bc1ccbc786c2d1ba78332a8e51452f8688a4e2824704debdbc8c45ef3a06a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d430208cff3af8e2cdd2a54d6914252d192fe0a586f21724f0836874b51f9dfcff796d2f7d652e77af8482e9559aa59a25a916fb6cd9a37ffb7e5831afef7bba
|
7
|
+
data.tar.gz: aa3a7cad243adef4bf2439a20c1b4ab09637c1bd8df4ad356cb3ae0347db124692241a0cab75d9f99111983072c525b010636896b4a1507606480d6d80f70b14
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.53.0
|
@@ -611,6 +611,13 @@ module Aws::Kendra
|
|
611
611
|
# related to processing the batch are sent to your Amazon Web Services
|
612
612
|
# CloudWatch log.
|
613
613
|
#
|
614
|
+
# For an example of ingesting inline documents using Python and Java
|
615
|
+
# SDKs, see [Adding files directly to an index][1].
|
616
|
+
#
|
617
|
+
#
|
618
|
+
#
|
619
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html
|
620
|
+
#
|
614
621
|
# @option params [required, String] :index_id
|
615
622
|
# The identifier of the index to add the documents to. You need to
|
616
623
|
# create the index first using the `CreateIndex` API.
|
@@ -827,9 +834,16 @@ module Aws::Kendra
|
|
827
834
|
# Amazon S3 and [custom][1] data sources are the only supported data
|
828
835
|
# sources in the Amazon Web Services GovCloud (US-West) region.
|
829
836
|
#
|
837
|
+
# For an example of creating an index and data source using the Python
|
838
|
+
# SDK, see [Getting started with Python SDK][2]. For an example of
|
839
|
+
# creating an index and data source using the Java SDK, see [Getting
|
840
|
+
# started with Java SDK][3].
|
841
|
+
#
|
830
842
|
#
|
831
843
|
#
|
832
844
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html
|
845
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html
|
846
|
+
# [3]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
|
833
847
|
#
|
834
848
|
# @option params [required, String] :name
|
835
849
|
# A unique name for the data source. A data source name can't be
|
@@ -925,7 +939,7 @@ module Aws::Kendra
|
|
925
939
|
# resp = client.create_data_source({
|
926
940
|
# name: "DataSourceName", # required
|
927
941
|
# index_id: "IndexId", # required
|
928
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB
|
942
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO
|
929
943
|
# configuration: {
|
930
944
|
# s3_configuration: {
|
931
945
|
# bucket_name: "S3BucketName", # required
|
@@ -1500,6 +1514,45 @@ module Aws::Kendra
|
|
1500
1514
|
# },
|
1501
1515
|
# ],
|
1502
1516
|
# },
|
1517
|
+
# alfresco_configuration: {
|
1518
|
+
# site_url: "SiteUrl", # required
|
1519
|
+
# site_id: "SiteId", # required
|
1520
|
+
# secret_arn: "SecretArn", # required
|
1521
|
+
# ssl_certificate_s3_path: { # required
|
1522
|
+
# bucket: "S3BucketName", # required
|
1523
|
+
# key: "S3ObjectKey", # required
|
1524
|
+
# },
|
1525
|
+
# crawl_system_folders: false,
|
1526
|
+
# crawl_comments: false,
|
1527
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
1528
|
+
# document_library_field_mappings: [
|
1529
|
+
# {
|
1530
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1531
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1532
|
+
# index_field_name: "IndexFieldName", # required
|
1533
|
+
# },
|
1534
|
+
# ],
|
1535
|
+
# blog_field_mappings: [
|
1536
|
+
# {
|
1537
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1538
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1539
|
+
# index_field_name: "IndexFieldName", # required
|
1540
|
+
# },
|
1541
|
+
# ],
|
1542
|
+
# wiki_field_mappings: [
|
1543
|
+
# {
|
1544
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1545
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1546
|
+
# index_field_name: "IndexFieldName", # required
|
1547
|
+
# },
|
1548
|
+
# ],
|
1549
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1550
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1551
|
+
# vpc_configuration: {
|
1552
|
+
# subnet_ids: ["SubnetId"], # required
|
1553
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1554
|
+
# },
|
1555
|
+
# },
|
1503
1556
|
# },
|
1504
1557
|
# description: "Description",
|
1505
1558
|
# schedule: "ScanSchedule",
|
@@ -1584,8 +1637,9 @@ module Aws::Kendra
|
|
1584
1637
|
end
|
1585
1638
|
|
1586
1639
|
# Creates an Amazon Kendra experience such as a search application. For
|
1587
|
-
# more information on creating a search application experience,
|
1588
|
-
#
|
1640
|
+
# more information on creating a search application experience,
|
1641
|
+
# including using the Python and Java SDKs, see [Building a search
|
1642
|
+
# experience with no code][1].
|
1589
1643
|
#
|
1590
1644
|
#
|
1591
1645
|
#
|
@@ -1667,6 +1721,13 @@ module Aws::Kendra
|
|
1667
1721
|
#
|
1668
1722
|
# Adding FAQs to an index is an asynchronous operation.
|
1669
1723
|
#
|
1724
|
+
# For an example of adding an FAQ to an index using Python and Java
|
1725
|
+
# SDKs, see [Using you FAQ file][1].
|
1726
|
+
#
|
1727
|
+
#
|
1728
|
+
#
|
1729
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file
|
1730
|
+
#
|
1670
1731
|
# @option params [required, String] :index_id
|
1671
1732
|
# The identifier of the index that contains the FAQ.
|
1672
1733
|
#
|
@@ -1772,6 +1833,16 @@ module Aws::Kendra
|
|
1772
1833
|
# Once the index is active you can index your documents using the
|
1773
1834
|
# `BatchPutDocument` API or using one of the supported data sources.
|
1774
1835
|
#
|
1836
|
+
# For an example of creating an index and data source using the Python
|
1837
|
+
# SDK, see [Getting started with Python SDK][1]. For an example of
|
1838
|
+
# creating an index and data source using the Java SDK, see [Getting
|
1839
|
+
# started with Java SDK][2].
|
1840
|
+
#
|
1841
|
+
#
|
1842
|
+
#
|
1843
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html
|
1844
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
|
1845
|
+
#
|
1775
1846
|
# @option params [required, String] :name
|
1776
1847
|
# The name for the new index.
|
1777
1848
|
#
|
@@ -1919,9 +1990,13 @@ module Aws::Kendra
|
|
1919
1990
|
# `CreateQuerySuggestionsBlockList` is currently not supported in the
|
1920
1991
|
# Amazon Web Services GovCloud (US-West) region.
|
1921
1992
|
#
|
1993
|
+
# For an example of creating a block list for query suggestions using
|
1994
|
+
# the Python SDK, see [Query suggestions block list][2].
|
1995
|
+
#
|
1922
1996
|
#
|
1923
1997
|
#
|
1924
1998
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
1999
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list
|
1925
2000
|
#
|
1926
2001
|
# @option params [required, String] :index_id
|
1927
2002
|
# The identifier of the index you want to create a query suggestions
|
@@ -2012,6 +2087,13 @@ module Aws::Kendra
|
|
2012
2087
|
# Creates a thesaurus for an index. The thesaurus contains a list of
|
2013
2088
|
# synonyms in Solr format.
|
2014
2089
|
#
|
2090
|
+
# For an example of adding a thesaurus file to an index, see [Adding
|
2091
|
+
# custom synonyms to an index][1].
|
2092
|
+
#
|
2093
|
+
#
|
2094
|
+
#
|
2095
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html
|
2096
|
+
#
|
2015
2097
|
# @option params [required, String] :index_id
|
2016
2098
|
# The unique identifier of the index for the new thesaurus.
|
2017
2099
|
#
|
@@ -2367,7 +2449,7 @@ module Aws::Kendra
|
|
2367
2449
|
# resp.id #=> String
|
2368
2450
|
# resp.index_id #=> String
|
2369
2451
|
# resp.name #=> String
|
2370
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB"
|
2452
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO"
|
2371
2453
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
2372
2454
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
2373
2455
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -2788,6 +2870,35 @@ module Aws::Kendra
|
|
2788
2870
|
# resp.configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[0].data_source_field_name #=> String
|
2789
2871
|
# resp.configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[0].date_field_format #=> String
|
2790
2872
|
# resp.configuration.git_hub_configuration.git_hub_pull_request_document_attachment_configuration_field_mappings[0].index_field_name #=> String
|
2873
|
+
# resp.configuration.alfresco_configuration.site_url #=> String
|
2874
|
+
# resp.configuration.alfresco_configuration.site_id #=> String
|
2875
|
+
# resp.configuration.alfresco_configuration.secret_arn #=> String
|
2876
|
+
# resp.configuration.alfresco_configuration.ssl_certificate_s3_path.bucket #=> String
|
2877
|
+
# resp.configuration.alfresco_configuration.ssl_certificate_s3_path.key #=> String
|
2878
|
+
# resp.configuration.alfresco_configuration.crawl_system_folders #=> Boolean
|
2879
|
+
# resp.configuration.alfresco_configuration.crawl_comments #=> Boolean
|
2880
|
+
# resp.configuration.alfresco_configuration.entity_filter #=> Array
|
2881
|
+
# resp.configuration.alfresco_configuration.entity_filter[0] #=> String, one of "wiki", "blog", "documentLibrary"
|
2882
|
+
# resp.configuration.alfresco_configuration.document_library_field_mappings #=> Array
|
2883
|
+
# resp.configuration.alfresco_configuration.document_library_field_mappings[0].data_source_field_name #=> String
|
2884
|
+
# resp.configuration.alfresco_configuration.document_library_field_mappings[0].date_field_format #=> String
|
2885
|
+
# resp.configuration.alfresco_configuration.document_library_field_mappings[0].index_field_name #=> String
|
2886
|
+
# resp.configuration.alfresco_configuration.blog_field_mappings #=> Array
|
2887
|
+
# resp.configuration.alfresco_configuration.blog_field_mappings[0].data_source_field_name #=> String
|
2888
|
+
# resp.configuration.alfresco_configuration.blog_field_mappings[0].date_field_format #=> String
|
2889
|
+
# resp.configuration.alfresco_configuration.blog_field_mappings[0].index_field_name #=> String
|
2890
|
+
# resp.configuration.alfresco_configuration.wiki_field_mappings #=> Array
|
2891
|
+
# resp.configuration.alfresco_configuration.wiki_field_mappings[0].data_source_field_name #=> String
|
2892
|
+
# resp.configuration.alfresco_configuration.wiki_field_mappings[0].date_field_format #=> String
|
2893
|
+
# resp.configuration.alfresco_configuration.wiki_field_mappings[0].index_field_name #=> String
|
2894
|
+
# resp.configuration.alfresco_configuration.inclusion_patterns #=> Array
|
2895
|
+
# resp.configuration.alfresco_configuration.inclusion_patterns[0] #=> String
|
2896
|
+
# resp.configuration.alfresco_configuration.exclusion_patterns #=> Array
|
2897
|
+
# resp.configuration.alfresco_configuration.exclusion_patterns[0] #=> String
|
2898
|
+
# resp.configuration.alfresco_configuration.vpc_configuration.subnet_ids #=> Array
|
2899
|
+
# resp.configuration.alfresco_configuration.vpc_configuration.subnet_ids[0] #=> String
|
2900
|
+
# resp.configuration.alfresco_configuration.vpc_configuration.security_group_ids #=> Array
|
2901
|
+
# resp.configuration.alfresco_configuration.vpc_configuration.security_group_ids[0] #=> String
|
2791
2902
|
# resp.created_at #=> Time
|
2792
2903
|
# resp.updated_at #=> Time
|
2793
2904
|
# resp.description #=> String
|
@@ -3622,7 +3733,7 @@ module Aws::Kendra
|
|
3622
3733
|
# resp.summary_items #=> Array
|
3623
3734
|
# resp.summary_items[0].name #=> String
|
3624
3735
|
# resp.summary_items[0].id #=> String
|
3625
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB"
|
3736
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO"
|
3626
3737
|
# resp.summary_items[0].created_at #=> Time
|
3627
3738
|
# resp.summary_items[0].updated_at #=> Time
|
3628
3739
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -5353,6 +5464,45 @@ module Aws::Kendra
|
|
5353
5464
|
# },
|
5354
5465
|
# ],
|
5355
5466
|
# },
|
5467
|
+
# alfresco_configuration: {
|
5468
|
+
# site_url: "SiteUrl", # required
|
5469
|
+
# site_id: "SiteId", # required
|
5470
|
+
# secret_arn: "SecretArn", # required
|
5471
|
+
# ssl_certificate_s3_path: { # required
|
5472
|
+
# bucket: "S3BucketName", # required
|
5473
|
+
# key: "S3ObjectKey", # required
|
5474
|
+
# },
|
5475
|
+
# crawl_system_folders: false,
|
5476
|
+
# crawl_comments: false,
|
5477
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
5478
|
+
# document_library_field_mappings: [
|
5479
|
+
# {
|
5480
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5481
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5482
|
+
# index_field_name: "IndexFieldName", # required
|
5483
|
+
# },
|
5484
|
+
# ],
|
5485
|
+
# blog_field_mappings: [
|
5486
|
+
# {
|
5487
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5488
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5489
|
+
# index_field_name: "IndexFieldName", # required
|
5490
|
+
# },
|
5491
|
+
# ],
|
5492
|
+
# wiki_field_mappings: [
|
5493
|
+
# {
|
5494
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5495
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5496
|
+
# index_field_name: "IndexFieldName", # required
|
5497
|
+
# },
|
5498
|
+
# ],
|
5499
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5500
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5501
|
+
# vpc_configuration: {
|
5502
|
+
# subnet_ids: ["SubnetId"], # required
|
5503
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
5504
|
+
# },
|
5505
|
+
# },
|
5356
5506
|
# },
|
5357
5507
|
# description: "Description",
|
5358
5508
|
# schedule: "ScanSchedule",
|
@@ -5823,7 +5973,7 @@ module Aws::Kendra
|
|
5823
5973
|
params: params,
|
5824
5974
|
config: config)
|
5825
5975
|
context[:gem_name] = 'aws-sdk-kendra'
|
5826
|
-
context[:gem_version] = '1.
|
5976
|
+
context[:gem_version] = '1.53.0'
|
5827
5977
|
Seahorse::Client::Request.new(handlers, context)
|
5828
5978
|
end
|
5829
5979
|
|
@@ -20,6 +20,8 @@ module Aws::Kendra
|
|
20
20
|
AdditionalResultAttributeList = Shapes::ListShape.new(name: 'AdditionalResultAttributeList')
|
21
21
|
AdditionalResultAttributeValue = Shapes::StructureShape.new(name: 'AdditionalResultAttributeValue')
|
22
22
|
AdditionalResultAttributeValueType = Shapes::StringShape.new(name: 'AdditionalResultAttributeValueType')
|
23
|
+
AlfrescoConfiguration = Shapes::StructureShape.new(name: 'AlfrescoConfiguration')
|
24
|
+
AlfrescoEntity = Shapes::StringShape.new(name: 'AlfrescoEntity')
|
23
25
|
AmazonResourceName = Shapes::StringShape.new(name: 'AmazonResourceName')
|
24
26
|
AssociateEntitiesToExperienceFailedEntityList = Shapes::ListShape.new(name: 'AssociateEntitiesToExperienceFailedEntityList')
|
25
27
|
AssociateEntitiesToExperienceRequest = Shapes::StructureShape.new(name: 'AssociateEntitiesToExperienceRequest')
|
@@ -189,6 +191,7 @@ module Aws::Kendra
|
|
189
191
|
EnterpriseId = Shapes::StringShape.new(name: 'EnterpriseId')
|
190
192
|
EntityConfiguration = Shapes::StructureShape.new(name: 'EntityConfiguration')
|
191
193
|
EntityDisplayData = Shapes::StructureShape.new(name: 'EntityDisplayData')
|
194
|
+
EntityFilter = Shapes::ListShape.new(name: 'EntityFilter')
|
192
195
|
EntityId = Shapes::StringShape.new(name: 'EntityId')
|
193
196
|
EntityIdsList = Shapes::ListShape.new(name: 'EntityIdsList')
|
194
197
|
EntityPersonaConfiguration = Shapes::StructureShape.new(name: 'EntityPersonaConfiguration')
|
@@ -429,9 +432,11 @@ module Aws::Kendra
|
|
429
432
|
SharePointVersion = Shapes::StringShape.new(name: 'SharePointVersion')
|
430
433
|
SharedDriveId = Shapes::StringShape.new(name: 'SharedDriveId')
|
431
434
|
SinceCrawlDate = Shapes::StringShape.new(name: 'SinceCrawlDate')
|
435
|
+
SiteId = Shapes::StringShape.new(name: 'SiteId')
|
432
436
|
SiteMap = Shapes::StringShape.new(name: 'SiteMap')
|
433
437
|
SiteMapsConfiguration = Shapes::StructureShape.new(name: 'SiteMapsConfiguration')
|
434
438
|
SiteMapsList = Shapes::ListShape.new(name: 'SiteMapsList')
|
439
|
+
SiteUrl = Shapes::StringShape.new(name: 'SiteUrl')
|
435
440
|
SlackConfiguration = Shapes::StructureShape.new(name: 'SlackConfiguration')
|
436
441
|
SlackEntity = Shapes::StringShape.new(name: 'SlackEntity')
|
437
442
|
SlackEntityList = Shapes::ListShape.new(name: 'SlackEntityList')
|
@@ -538,6 +543,21 @@ module Aws::Kendra
|
|
538
543
|
AdditionalResultAttributeValue.add_member(:text_with_highlights_value, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "TextWithHighlightsValue"))
|
539
544
|
AdditionalResultAttributeValue.struct_class = Types::AdditionalResultAttributeValue
|
540
545
|
|
546
|
+
AlfrescoConfiguration.add_member(:site_url, Shapes::ShapeRef.new(shape: SiteUrl, required: true, location_name: "SiteUrl"))
|
547
|
+
AlfrescoConfiguration.add_member(:site_id, Shapes::ShapeRef.new(shape: SiteId, required: true, location_name: "SiteId"))
|
548
|
+
AlfrescoConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
|
549
|
+
AlfrescoConfiguration.add_member(:ssl_certificate_s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "SslCertificateS3Path"))
|
550
|
+
AlfrescoConfiguration.add_member(:crawl_system_folders, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlSystemFolders"))
|
551
|
+
AlfrescoConfiguration.add_member(:crawl_comments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlComments"))
|
552
|
+
AlfrescoConfiguration.add_member(:entity_filter, Shapes::ShapeRef.new(shape: EntityFilter, location_name: "EntityFilter"))
|
553
|
+
AlfrescoConfiguration.add_member(:document_library_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "DocumentLibraryFieldMappings"))
|
554
|
+
AlfrescoConfiguration.add_member(:blog_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "BlogFieldMappings"))
|
555
|
+
AlfrescoConfiguration.add_member(:wiki_field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "WikiFieldMappings"))
|
556
|
+
AlfrescoConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
557
|
+
AlfrescoConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
558
|
+
AlfrescoConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
|
559
|
+
AlfrescoConfiguration.struct_class = Types::AlfrescoConfiguration
|
560
|
+
|
541
561
|
AssociateEntitiesToExperienceFailedEntityList.member = Shapes::ShapeRef.new(shape: FailedEntity)
|
542
562
|
|
543
563
|
AssociateEntitiesToExperienceRequest.add_member(:id, Shapes::ShapeRef.new(shape: ExperienceId, required: true, location_name: "Id"))
|
@@ -849,6 +869,7 @@ module Aws::Kendra
|
|
849
869
|
DataSourceConfiguration.add_member(:quip_configuration, Shapes::ShapeRef.new(shape: QuipConfiguration, location_name: "QuipConfiguration"))
|
850
870
|
DataSourceConfiguration.add_member(:jira_configuration, Shapes::ShapeRef.new(shape: JiraConfiguration, location_name: "JiraConfiguration"))
|
851
871
|
DataSourceConfiguration.add_member(:git_hub_configuration, Shapes::ShapeRef.new(shape: GitHubConfiguration, location_name: "GitHubConfiguration"))
|
872
|
+
DataSourceConfiguration.add_member(:alfresco_configuration, Shapes::ShapeRef.new(shape: AlfrescoConfiguration, location_name: "AlfrescoConfiguration"))
|
852
873
|
DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
|
853
874
|
|
854
875
|
DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId"))
|
@@ -1184,6 +1205,8 @@ module Aws::Kendra
|
|
1184
1205
|
EntityDisplayData.add_member(:last_name, Shapes::ShapeRef.new(shape: NameType, location_name: "LastName"))
|
1185
1206
|
EntityDisplayData.struct_class = Types::EntityDisplayData
|
1186
1207
|
|
1208
|
+
EntityFilter.member = Shapes::ShapeRef.new(shape: AlfrescoEntity)
|
1209
|
+
|
1187
1210
|
EntityIdsList.member = Shapes::ShapeRef.new(shape: EntityId)
|
1188
1211
|
|
1189
1212
|
EntityPersonaConfiguration.add_member(:entity_id, Shapes::ShapeRef.new(shape: EntityId, required: true, location_name: "EntityId"))
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -112,6 +112,176 @@ module Aws::Kendra
|
|
112
112
|
include Aws::Structure
|
113
113
|
end
|
114
114
|
|
115
|
+
# Provides the configuration information to connect to Alfresco as your
|
116
|
+
# data source.
|
117
|
+
#
|
118
|
+
# @note When making an API call, you may pass AlfrescoConfiguration
|
119
|
+
# data as a hash:
|
120
|
+
#
|
121
|
+
# {
|
122
|
+
# site_url: "SiteUrl", # required
|
123
|
+
# site_id: "SiteId", # required
|
124
|
+
# secret_arn: "SecretArn", # required
|
125
|
+
# ssl_certificate_s3_path: { # required
|
126
|
+
# bucket: "S3BucketName", # required
|
127
|
+
# key: "S3ObjectKey", # required
|
128
|
+
# },
|
129
|
+
# crawl_system_folders: false,
|
130
|
+
# crawl_comments: false,
|
131
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
132
|
+
# document_library_field_mappings: [
|
133
|
+
# {
|
134
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
135
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
136
|
+
# index_field_name: "IndexFieldName", # required
|
137
|
+
# },
|
138
|
+
# ],
|
139
|
+
# blog_field_mappings: [
|
140
|
+
# {
|
141
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
142
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
143
|
+
# index_field_name: "IndexFieldName", # required
|
144
|
+
# },
|
145
|
+
# ],
|
146
|
+
# wiki_field_mappings: [
|
147
|
+
# {
|
148
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
149
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
150
|
+
# index_field_name: "IndexFieldName", # required
|
151
|
+
# },
|
152
|
+
# ],
|
153
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
154
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
155
|
+
# vpc_configuration: {
|
156
|
+
# subnet_ids: ["SubnetId"], # required
|
157
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
158
|
+
# },
|
159
|
+
# }
|
160
|
+
#
|
161
|
+
# @!attribute [rw] site_url
|
162
|
+
# The URL of the Alfresco site. For example, *https://hostname:8080*.
|
163
|
+
# @return [String]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] site_id
|
166
|
+
# The identifier of the Alfresco site. For example, *my-site*.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] secret_arn
|
170
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
171
|
+
# contains the key-value pairs required to connect to your Alfresco
|
172
|
+
# data source. The secret must contain a JSON structure with the
|
173
|
+
# following keys:
|
174
|
+
#
|
175
|
+
# * username—The user name of the Alfresco account.
|
176
|
+
#
|
177
|
+
# * password—The password of the Alfresco account.
|
178
|
+
# @return [String]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] ssl_certificate_s3_path
|
181
|
+
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
182
|
+
# use this to connect to Alfresco.
|
183
|
+
# @return [Types::S3Path]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] crawl_system_folders
|
186
|
+
# `TRUE` to index shared files.
|
187
|
+
# @return [Boolean]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] crawl_comments
|
190
|
+
# `TRUE` to index comments of wikis and blogs.
|
191
|
+
# @return [Boolean]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] entity_filter
|
194
|
+
# Specify whether to index document libraries, wikis, or blogs. You
|
195
|
+
# can specify one or more of these options.
|
196
|
+
# @return [Array<String>]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] document_library_field_mappings
|
199
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
200
|
+
# attributes or field names of Alfresco document libraries to Amazon
|
201
|
+
# Kendra index field names. To create custom fields, use the
|
202
|
+
# `UpdateIndex` API before you map to Alfresco fields. For more
|
203
|
+
# information, see [ Mapping data source fields][1]. The Alfresco data
|
204
|
+
# source field names must exist in your Alfresco custom metadata.
|
205
|
+
#
|
206
|
+
#
|
207
|
+
#
|
208
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
209
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
210
|
+
#
|
211
|
+
# @!attribute [rw] blog_field_mappings
|
212
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
213
|
+
# attributes or field names of Alfresco blogs to Amazon Kendra index
|
214
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
215
|
+
# before you map to Alfresco fields. For more information, see [
|
216
|
+
# Mapping data source fields][1]. The Alfresco data source field names
|
217
|
+
# must exist in your Alfresco custom metadata.
|
218
|
+
#
|
219
|
+
#
|
220
|
+
#
|
221
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
222
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
223
|
+
#
|
224
|
+
# @!attribute [rw] wiki_field_mappings
|
225
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
226
|
+
# attributes or field names of Alfresco wikis to Amazon Kendra index
|
227
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
228
|
+
# before you map to Alfresco fields. For more information, see [
|
229
|
+
# Mapping data source fields][1]. The Alfresco data source field names
|
230
|
+
# must exist in your Alfresco custom metadata.
|
231
|
+
#
|
232
|
+
#
|
233
|
+
#
|
234
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
235
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
236
|
+
#
|
237
|
+
# @!attribute [rw] inclusion_patterns
|
238
|
+
# A list of regular expression patterns to include certain files in
|
239
|
+
# your Alfresco data source. Files that match the patterns are
|
240
|
+
# included in the index. Files that don't match the patterns are
|
241
|
+
# excluded from the index. If a file matches both an inclusion pattern
|
242
|
+
# and an exclusion pattern, the exclusion pattern takes precedence and
|
243
|
+
# the file isn't included in the index.
|
244
|
+
# @return [Array<String>]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] exclusion_patterns
|
247
|
+
# A list of regular expression patterns to exclude certain files in
|
248
|
+
# your Alfresco data source. Files that match the patterns are
|
249
|
+
# excluded from the index. Files that don't match the patterns are
|
250
|
+
# included in the index. If a file matches both an inclusion pattern
|
251
|
+
# and an exclusion pattern, the exclusion pattern takes precedence and
|
252
|
+
# the file isn't included in the index.
|
253
|
+
# @return [Array<String>]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] vpc_configuration
|
256
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
257
|
+
# connect to your Alfresco. For more information, see [Configuring a
|
258
|
+
# VPC][1].
|
259
|
+
#
|
260
|
+
#
|
261
|
+
#
|
262
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
263
|
+
# @return [Types::DataSourceVpcConfiguration]
|
264
|
+
#
|
265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AlfrescoConfiguration AWS API Documentation
|
266
|
+
#
|
267
|
+
class AlfrescoConfiguration < Struct.new(
|
268
|
+
:site_url,
|
269
|
+
:site_id,
|
270
|
+
:secret_arn,
|
271
|
+
:ssl_certificate_s3_path,
|
272
|
+
:crawl_system_folders,
|
273
|
+
:crawl_comments,
|
274
|
+
:entity_filter,
|
275
|
+
:document_library_field_mappings,
|
276
|
+
:blog_field_mappings,
|
277
|
+
:wiki_field_mappings,
|
278
|
+
:inclusion_patterns,
|
279
|
+
:exclusion_patterns,
|
280
|
+
:vpc_configuration)
|
281
|
+
SENSITIVE = []
|
282
|
+
include Aws::Structure
|
283
|
+
end
|
284
|
+
|
115
285
|
# @note When making an API call, you may pass AssociateEntitiesToExperienceRequest
|
116
286
|
# data as a hash:
|
117
287
|
#
|
@@ -1294,7 +1464,7 @@ module Aws::Kendra
|
|
1294
1464
|
# @!attribute [rw] storage_capacity_units
|
1295
1465
|
# The amount of extra storage capacity for an index. A single capacity
|
1296
1466
|
# unit provides 30 GB of storage space or 100,000 documents, whichever
|
1297
|
-
# is reached first.
|
1467
|
+
# is reached first. You can add up to 100 extra capacity units.
|
1298
1468
|
# @return [Integer]
|
1299
1469
|
#
|
1300
1470
|
# @!attribute [rw] query_capacity_units
|
@@ -1302,7 +1472,8 @@ module Aws::Kendra
|
|
1302
1472
|
# [GetQuerySuggestions][1] capacity.
|
1303
1473
|
#
|
1304
1474
|
# A single extra capacity unit for an index provides 0.1 queries per
|
1305
|
-
# second or approximately 8,000 queries per day.
|
1475
|
+
# second or approximately 8,000 queries per day. You can add up to 100
|
1476
|
+
# extra capacity units.
|
1306
1477
|
#
|
1307
1478
|
# `GetQuerySuggestions` capacity is five times the provisioned query
|
1308
1479
|
# capacity for an index, or the base capacity of 2.5 calls per second,
|
@@ -1461,8 +1632,7 @@ module Aws::Kendra
|
|
1461
1632
|
# }
|
1462
1633
|
#
|
1463
1634
|
# @!attribute [rw] crawl_attachments
|
1464
|
-
#
|
1465
|
-
# blogs in the Confluence data source.
|
1635
|
+
# `TRUE` to index attachments of pages and blogs in Confluence.
|
1466
1636
|
# @return [Boolean]
|
1467
1637
|
#
|
1468
1638
|
# @!attribute [rw] attachment_field_mappings
|
@@ -1690,20 +1860,19 @@ module Aws::Kendra
|
|
1690
1860
|
#
|
1691
1861
|
# @!attribute [rw] secret_arn
|
1692
1862
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
1693
|
-
# contains the
|
1694
|
-
#
|
1695
|
-
#
|
1863
|
+
# contains the user name and password required to connect to the
|
1864
|
+
# Confluence instance. If you use Confluence cloud, you use a
|
1865
|
+
# generated API token as the password. For more information, see
|
1866
|
+
# [Using a Confluemce data source][1].
|
1867
|
+
#
|
1696
1868
|
#
|
1697
|
-
# * username—The user name or email address of a user with
|
1698
|
-
# administrative privileges for the Confluence server.
|
1699
1869
|
#
|
1700
|
-
#
|
1701
|
-
# Confluence server.
|
1870
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html
|
1702
1871
|
# @return [String]
|
1703
1872
|
#
|
1704
1873
|
# @!attribute [rw] version
|
1705
|
-
#
|
1706
|
-
#
|
1874
|
+
# The version or the type of the Confluence installation to connect
|
1875
|
+
# to.
|
1707
1876
|
# @return [String]
|
1708
1877
|
#
|
1709
1878
|
# @!attribute [rw] space_configuration
|
@@ -1744,9 +1913,9 @@ module Aws::Kendra
|
|
1744
1913
|
# @return [Array<String>]
|
1745
1914
|
#
|
1746
1915
|
# @!attribute [rw] exclusion_patterns
|
1747
|
-
#
|
1748
|
-
#
|
1749
|
-
#
|
1916
|
+
# A list of regular expression patterns to exclude certain blog posts,
|
1917
|
+
# pages, spaces, or attachments in your Confluence. Content that
|
1918
|
+
# matches the patterns are excluded from the index. Content that
|
1750
1919
|
# doesn't match the patterns is included in the index. If content
|
1751
1920
|
# matches both an inclusion and exclusion pattern, the exclusion
|
1752
1921
|
# pattern takes precedence and the content isn't included in the
|
@@ -1786,12 +1955,11 @@ module Aws::Kendra
|
|
1786
1955
|
# }
|
1787
1956
|
#
|
1788
1957
|
# @!attribute [rw] page_field_mappings
|
1789
|
-
#
|
1790
|
-
#
|
1791
|
-
#
|
1792
|
-
#
|
1793
|
-
#
|
1794
|
-
# metadata.
|
1958
|
+
# Maps attributes or field names of Confluence pages to Amazon Kendra
|
1959
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
1960
|
+
# API before you map to Confluence fields. For more information, see
|
1961
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
1962
|
+
# names must exist in your Confluence custom metadata.
|
1795
1963
|
#
|
1796
1964
|
# If you specify the `PageFieldMappings` parameter, you must specify
|
1797
1965
|
# at least one field mapping.
|
@@ -1874,11 +2042,11 @@ module Aws::Kendra
|
|
1874
2042
|
# }
|
1875
2043
|
#
|
1876
2044
|
# @!attribute [rw] crawl_personal_spaces
|
1877
|
-
#
|
1878
|
-
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
2045
|
+
# `TRUE` to index personal spaces. You can add restrictions to items
|
2046
|
+
# in personal spaces. If personal spaces are indexed, queries without
|
2047
|
+
# user context information may return restricted items from a personal
|
2048
|
+
# space in their results. For more information, see [Filtering on user
|
2049
|
+
# context][1].
|
1882
2050
|
#
|
1883
2051
|
#
|
1884
2052
|
#
|
@@ -1886,7 +2054,7 @@ module Aws::Kendra
|
|
1886
2054
|
# @return [Boolean]
|
1887
2055
|
#
|
1888
2056
|
# @!attribute [rw] crawl_archived_spaces
|
1889
|
-
#
|
2057
|
+
# `TRUE` to index archived spaces.
|
1890
2058
|
# @return [Boolean]
|
1891
2059
|
#
|
1892
2060
|
# @!attribute [rw] include_spaces
|
@@ -2112,7 +2280,7 @@ module Aws::Kendra
|
|
2112
2280
|
# {
|
2113
2281
|
# name: "DataSourceName", # required
|
2114
2282
|
# index_id: "IndexId", # required
|
2115
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB
|
2283
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO
|
2116
2284
|
# configuration: {
|
2117
2285
|
# s3_configuration: {
|
2118
2286
|
# bucket_name: "S3BucketName", # required
|
@@ -2687,6 +2855,45 @@ module Aws::Kendra
|
|
2687
2855
|
# },
|
2688
2856
|
# ],
|
2689
2857
|
# },
|
2858
|
+
# alfresco_configuration: {
|
2859
|
+
# site_url: "SiteUrl", # required
|
2860
|
+
# site_id: "SiteId", # required
|
2861
|
+
# secret_arn: "SecretArn", # required
|
2862
|
+
# ssl_certificate_s3_path: { # required
|
2863
|
+
# bucket: "S3BucketName", # required
|
2864
|
+
# key: "S3ObjectKey", # required
|
2865
|
+
# },
|
2866
|
+
# crawl_system_folders: false,
|
2867
|
+
# crawl_comments: false,
|
2868
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
2869
|
+
# document_library_field_mappings: [
|
2870
|
+
# {
|
2871
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2872
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2873
|
+
# index_field_name: "IndexFieldName", # required
|
2874
|
+
# },
|
2875
|
+
# ],
|
2876
|
+
# blog_field_mappings: [
|
2877
|
+
# {
|
2878
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2879
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2880
|
+
# index_field_name: "IndexFieldName", # required
|
2881
|
+
# },
|
2882
|
+
# ],
|
2883
|
+
# wiki_field_mappings: [
|
2884
|
+
# {
|
2885
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2886
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2887
|
+
# index_field_name: "IndexFieldName", # required
|
2888
|
+
# },
|
2889
|
+
# ],
|
2890
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2891
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2892
|
+
# vpc_configuration: {
|
2893
|
+
# subnet_ids: ["SubnetId"], # required
|
2894
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2895
|
+
# },
|
2896
|
+
# },
|
2690
2897
|
# },
|
2691
2898
|
# description: "Description",
|
2692
2899
|
# schedule: "ScanSchedule",
|
@@ -4136,6 +4343,45 @@ module Aws::Kendra
|
|
4136
4343
|
# },
|
4137
4344
|
# ],
|
4138
4345
|
# },
|
4346
|
+
# alfresco_configuration: {
|
4347
|
+
# site_url: "SiteUrl", # required
|
4348
|
+
# site_id: "SiteId", # required
|
4349
|
+
# secret_arn: "SecretArn", # required
|
4350
|
+
# ssl_certificate_s3_path: { # required
|
4351
|
+
# bucket: "S3BucketName", # required
|
4352
|
+
# key: "S3ObjectKey", # required
|
4353
|
+
# },
|
4354
|
+
# crawl_system_folders: false,
|
4355
|
+
# crawl_comments: false,
|
4356
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
4357
|
+
# document_library_field_mappings: [
|
4358
|
+
# {
|
4359
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4360
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4361
|
+
# index_field_name: "IndexFieldName", # required
|
4362
|
+
# },
|
4363
|
+
# ],
|
4364
|
+
# blog_field_mappings: [
|
4365
|
+
# {
|
4366
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4367
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4368
|
+
# index_field_name: "IndexFieldName", # required
|
4369
|
+
# },
|
4370
|
+
# ],
|
4371
|
+
# wiki_field_mappings: [
|
4372
|
+
# {
|
4373
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4374
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4375
|
+
# index_field_name: "IndexFieldName", # required
|
4376
|
+
# },
|
4377
|
+
# ],
|
4378
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4379
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4380
|
+
# vpc_configuration: {
|
4381
|
+
# subnet_ids: ["SubnetId"], # required
|
4382
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4383
|
+
# },
|
4384
|
+
# },
|
4139
4385
|
# }
|
4140
4386
|
#
|
4141
4387
|
# @!attribute [rw] s3_configuration
|
@@ -4218,6 +4464,11 @@ module Aws::Kendra
|
|
4218
4464
|
# data source.
|
4219
4465
|
# @return [Types::GitHubConfiguration]
|
4220
4466
|
#
|
4467
|
+
# @!attribute [rw] alfresco_configuration
|
4468
|
+
# Provides the configuration information to connect to Alfresco as
|
4469
|
+
# your data source.
|
4470
|
+
# @return [Types::AlfrescoConfiguration]
|
4471
|
+
#
|
4221
4472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
4222
4473
|
#
|
4223
4474
|
class DataSourceConfiguration < Struct.new(
|
@@ -4236,7 +4487,8 @@ module Aws::Kendra
|
|
4236
4487
|
:box_configuration,
|
4237
4488
|
:quip_configuration,
|
4238
4489
|
:jira_configuration,
|
4239
|
-
:git_hub_configuration
|
4490
|
+
:git_hub_configuration,
|
4491
|
+
:alfresco_configuration)
|
4240
4492
|
SENSITIVE = []
|
4241
4493
|
include Aws::Structure
|
4242
4494
|
end
|
@@ -8018,24 +8270,33 @@ module Aws::Kendra
|
|
8018
8270
|
# }
|
8019
8271
|
#
|
8020
8272
|
# @!attribute [rw] jira_account_url
|
8021
|
-
# The URL of the Jira account. For example, company.
|
8022
|
-
# https://jira.company.com
|
8023
|
-
# URL of your profile page for Jira desktop.
|
8273
|
+
# The URL of the Jira account. For example, *company.atlassian.net* or
|
8274
|
+
# *https://jira.company.com*. You can find your Jira account URL in
|
8275
|
+
# the URL of your profile page for Jira desktop.
|
8024
8276
|
# @return [String]
|
8025
8277
|
#
|
8026
8278
|
# @!attribute [rw] secret_arn
|
8027
|
-
# The Amazon Resource Name (ARN) of
|
8279
|
+
# The Amazon Resource Name (ARN) of a secret in Secrets Manager
|
8028
8280
|
# contains the key-value pairs required to connect to your Jira data
|
8029
8281
|
# source. The secret must contain a JSON structure with the following
|
8030
8282
|
# keys:
|
8031
8283
|
#
|
8032
|
-
# *
|
8284
|
+
# * jiraId—The Jira username.
|
8033
8285
|
#
|
8034
|
-
# * jiraCredentials—The
|
8286
|
+
# * jiraCredentials—The Jira API token. For more information on
|
8287
|
+
# creating an API token in Jira, see [ Authentication for a Jira
|
8288
|
+
# data source][1].
|
8289
|
+
#
|
8290
|
+
#
|
8291
|
+
#
|
8292
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html#jira-authentication
|
8035
8293
|
# @return [String]
|
8036
8294
|
#
|
8037
8295
|
# @!attribute [rw] use_change_log
|
8038
|
-
#
|
8296
|
+
# `TRUE` to use the Jira change log to determine which documents
|
8297
|
+
# require updating in the index. Depending on the change log's size,
|
8298
|
+
# it may take longer for Amazon Kendra to use the change log than to
|
8299
|
+
# scan all of your documents in Jira.
|
8039
8300
|
# @return [Boolean]
|
8040
8301
|
#
|
8041
8302
|
# @!attribute [rw] project
|
@@ -8959,7 +9220,8 @@ module Aws::Kendra
|
|
8959
9220
|
# @return [String]
|
8960
9221
|
#
|
8961
9222
|
# @!attribute [rw] ssl_certificate_s3_path
|
8962
|
-
#
|
9223
|
+
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
9224
|
+
# use this to connect to GitHub.
|
8963
9225
|
# @return [Types::S3Path]
|
8964
9226
|
#
|
8965
9227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OnPremiseConfiguration AWS API Documentation
|
@@ -9051,8 +9313,7 @@ module Aws::Kendra
|
|
9051
9313
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
9052
9314
|
#
|
9053
9315
|
# @!attribute [rw] disable_local_groups
|
9054
|
-
#
|
9055
|
-
# (`True`) or enabled (`False`).
|
9316
|
+
# `TRUE` to disable local groups information.
|
9056
9317
|
# @return [Boolean]
|
9057
9318
|
#
|
9058
9319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveConfiguration AWS API Documentation
|
@@ -9846,22 +10107,19 @@ module Aws::Kendra
|
|
9846
10107
|
# @return [String]
|
9847
10108
|
#
|
9848
10109
|
# @!attribute [rw] crawl_file_comments
|
9849
|
-
#
|
9850
|
-
# or more of these options.
|
10110
|
+
# `TRUE` to index file comments.
|
9851
10111
|
# @return [Boolean]
|
9852
10112
|
#
|
9853
10113
|
# @!attribute [rw] crawl_chat_rooms
|
9854
|
-
#
|
9855
|
-
# more of these options.
|
10114
|
+
# `TRUE` to index the contents of chat rooms.
|
9856
10115
|
# @return [Boolean]
|
9857
10116
|
#
|
9858
10117
|
# @!attribute [rw] crawl_attachments
|
9859
|
-
#
|
9860
|
-
# more of these options.
|
10118
|
+
# `TRUE` to index attachments.
|
9861
10119
|
# @return [Boolean]
|
9862
10120
|
#
|
9863
10121
|
# @!attribute [rw] folder_ids
|
9864
|
-
# The identifier of the Quip
|
10122
|
+
# The identifier of the Quip folders you want to index.
|
9865
10123
|
# @return [Array<String>]
|
9866
10124
|
#
|
9867
10125
|
# @!attribute [rw] thread_field_mappings
|
@@ -10945,7 +11203,14 @@ module Aws::Kendra
|
|
10945
11203
|
# @!attribute [rw] secret_arn
|
10946
11204
|
# The Amazon Resource Name (ARN) of the Secrets Manager secret that
|
10947
11205
|
# contains the user name and password required to connect to the
|
10948
|
-
# ServiceNow instance.
|
11206
|
+
# ServiceNow instance. You can also provide OAuth authentication
|
11207
|
+
# credentials of user name, password, client ID, and client secret.
|
11208
|
+
# For more information, see [Authentication for a ServiceNow data
|
11209
|
+
# source][1].
|
11210
|
+
#
|
11211
|
+
#
|
11212
|
+
#
|
11213
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html#servicenow-authentication
|
10949
11214
|
# @return [String]
|
10950
11215
|
#
|
10951
11216
|
# @!attribute [rw] service_now_build_version
|
@@ -11224,33 +11489,28 @@ module Aws::Kendra
|
|
11224
11489
|
# }
|
11225
11490
|
#
|
11226
11491
|
# @!attribute [rw] share_point_version
|
11227
|
-
# The version of Microsoft SharePoint that you
|
11228
|
-
# source.
|
11492
|
+
# The version of Microsoft SharePoint that you use.
|
11229
11493
|
# @return [String]
|
11230
11494
|
#
|
11231
11495
|
# @!attribute [rw] urls
|
11232
|
-
# The
|
11233
|
-
#
|
11496
|
+
# The Microsoft SharePoint site URLs for the documents you want to
|
11497
|
+
# indext.
|
11234
11498
|
# @return [Array<String>]
|
11235
11499
|
#
|
11236
11500
|
# @!attribute [rw] secret_arn
|
11237
|
-
# The Amazon Resource Name (ARN) of
|
11238
|
-
#
|
11239
|
-
# SharePoint Server, you also need to
|
11240
|
-
# part of the credentials. For more
|
11241
|
-
# Microsoft SharePoint Data Source][1].
|
11242
|
-
# Secrets Manager see [ What Is Secrets Manager][2] in the <i>Secrets
|
11243
|
-
# Manager </i> user guide.
|
11501
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
11502
|
+
# contains the user name and password required to connect to the
|
11503
|
+
# SharePoint instance. If you use SharePoint Server, you also need to
|
11504
|
+
# provide the sever domain name as part of the credentials. For more
|
11505
|
+
# information, see [Using a Microsoft SharePoint Data Source][1].
|
11244
11506
|
#
|
11245
11507
|
#
|
11246
11508
|
#
|
11247
11509
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
|
11248
|
-
# [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
|
11249
11510
|
# @return [String]
|
11250
11511
|
#
|
11251
11512
|
# @!attribute [rw] crawl_attachments
|
11252
|
-
# `TRUE` to
|
11253
|
-
# SharePoint site in the index; otherwise, `FALSE`.
|
11513
|
+
# `TRUE` to index document attachments.
|
11254
11514
|
# @return [Boolean]
|
11255
11515
|
#
|
11256
11516
|
# @!attribute [rw] use_change_log
|
@@ -11268,7 +11528,7 @@ module Aws::Kendra
|
|
11268
11528
|
# exclusion pattern, the exclusion pattern takes precedence and the
|
11269
11529
|
# document isn't included in the index.
|
11270
11530
|
#
|
11271
|
-
# The regex
|
11531
|
+
# The regex applies to the display URL of the SharePoint document.
|
11272
11532
|
# @return [Array<String>]
|
11273
11533
|
#
|
11274
11534
|
# @!attribute [rw] exclusion_patterns
|
@@ -11279,11 +11539,17 @@ module Aws::Kendra
|
|
11279
11539
|
# exclusion pattern, the exclusion pattern takes precedence and the
|
11280
11540
|
# document isn't included in the index.
|
11281
11541
|
#
|
11282
|
-
# The regex
|
11542
|
+
# The regex applies to the display URL of the SharePoint document.
|
11283
11543
|
# @return [Array<String>]
|
11284
11544
|
#
|
11285
11545
|
# @!attribute [rw] vpc_configuration
|
11286
|
-
#
|
11546
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
11547
|
+
# connect to your Microsoft SharePoint. For more information, see
|
11548
|
+
# [Configuring a VPC][1].
|
11549
|
+
#
|
11550
|
+
#
|
11551
|
+
#
|
11552
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
11287
11553
|
# @return [Types::DataSourceVpcConfiguration]
|
11288
11554
|
#
|
11289
11555
|
# @!attribute [rw] field_mappings
|
@@ -11305,12 +11571,12 @@ module Aws::Kendra
|
|
11305
11571
|
# @return [String]
|
11306
11572
|
#
|
11307
11573
|
# @!attribute [rw] disable_local_groups
|
11308
|
-
#
|
11309
|
-
# (`True`) or enabled (`False`).
|
11574
|
+
# `TRUE` to disable local groups information.
|
11310
11575
|
# @return [Boolean]
|
11311
11576
|
#
|
11312
11577
|
# @!attribute [rw] ssl_certificate_s3_path
|
11313
|
-
#
|
11578
|
+
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
11579
|
+
# use this to connect to SharePoint.
|
11314
11580
|
# @return [Types::S3Path]
|
11315
11581
|
#
|
11316
11582
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
|
@@ -12703,6 +12969,45 @@ module Aws::Kendra
|
|
12703
12969
|
# },
|
12704
12970
|
# ],
|
12705
12971
|
# },
|
12972
|
+
# alfresco_configuration: {
|
12973
|
+
# site_url: "SiteUrl", # required
|
12974
|
+
# site_id: "SiteId", # required
|
12975
|
+
# secret_arn: "SecretArn", # required
|
12976
|
+
# ssl_certificate_s3_path: { # required
|
12977
|
+
# bucket: "S3BucketName", # required
|
12978
|
+
# key: "S3ObjectKey", # required
|
12979
|
+
# },
|
12980
|
+
# crawl_system_folders: false,
|
12981
|
+
# crawl_comments: false,
|
12982
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
12983
|
+
# document_library_field_mappings: [
|
12984
|
+
# {
|
12985
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12986
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12987
|
+
# index_field_name: "IndexFieldName", # required
|
12988
|
+
# },
|
12989
|
+
# ],
|
12990
|
+
# blog_field_mappings: [
|
12991
|
+
# {
|
12992
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
12993
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
12994
|
+
# index_field_name: "IndexFieldName", # required
|
12995
|
+
# },
|
12996
|
+
# ],
|
12997
|
+
# wiki_field_mappings: [
|
12998
|
+
# {
|
12999
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
13000
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
13001
|
+
# index_field_name: "IndexFieldName", # required
|
13002
|
+
# },
|
13003
|
+
# ],
|
13004
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
13005
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
13006
|
+
# vpc_configuration: {
|
13007
|
+
# subnet_ids: ["SubnetId"], # required
|
13008
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
13009
|
+
# },
|
13010
|
+
# },
|
12706
13011
|
# },
|
12707
13012
|
# description: "Description",
|
12708
13013
|
# schedule: "ScanSchedule",
|
data/lib/aws-sdk-kendra.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kendra
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.53.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-06-
|
11
|
+
date: 2022-06-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|