aws-sdk-kendra 1.30.0 → 1.31.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0ebe1496353f4d08d15ade8d9c2dfee74b9766285ce574ecec5c4042c05f13bd
4
- data.tar.gz: 6455f17819e188b6767cb354b9dae504a933f77db5b528a0341ea2e64184adea
3
+ metadata.gz: 7038aaa06fb793e9d6e31cc0c4703220832b7a9c2cdd6e7fae73df18c3dc3fc8
4
+ data.tar.gz: 1a109408574701029f28633b7c9332130103c3ceee3a197ca37ed1b3790d81d4
5
5
  SHA512:
6
- metadata.gz: 7256531ac5a6b58d2cc16301377a6583f0f44fc77672a15f9e58d66adc044a3bb828d19735064a46a5a3754279e776e0d6cb15f96251dd39f0bc20b95a975b72
7
- data.tar.gz: ed4f321f7b7590a0fbb3a255ce759801ceed9fc87c588be3632e18567cdf7bb15437ab8a213b7f3545453a971111cee031c4801312aa46c69ef50992357c4daa
6
+ metadata.gz: 6c422c77076d0b647630c3daf4972454c8980cf62af30974ae3328b28aff8dba8168b73aadad3873dfe11ea97c23f8e1daa99da0acdc4800124fffbe83236413
7
+ data.tar.gz: 7798a38719c6685f28e746c99faf0d95996928d5c6ba63e67635fdd78b1370115279f8183eee9a6a95c77ba3ccdff3465ae0948cfe16081a8f35645a455a5b42
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.31.0 (2021-07-21)
5
+ ------------------
6
+
7
+ * Feature - Amazon Kendra now provides a data source connector for Amazon WorkDocs. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-workdocs.html
8
+
4
9
  1.30.0 (2021-07-12)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.30.0
1
+ 1.31.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
48
48
  # @!group service
49
49
  module Aws::Kendra
50
50
 
51
- GEM_VERSION = '1.30.0'
51
+ GEM_VERSION = '1.31.0'
52
52
 
53
53
  end
@@ -694,7 +694,7 @@ module Aws::Kendra
694
694
  # resp = client.create_data_source({
695
695
  # name: "DataSourceName", # required
696
696
  # index_id: "IndexId", # required
697
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER
697
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS
698
698
  # configuration: {
699
699
  # s3_configuration: {
700
700
  # bucket_name: "S3BucketName", # required
@@ -992,6 +992,20 @@ module Aws::Kendra
992
992
  # ],
993
993
  # },
994
994
  # },
995
+ # work_docs_configuration: {
996
+ # organization_id: "OrganizationId", # required
997
+ # crawl_comments: false,
998
+ # use_change_log: false,
999
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1000
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1001
+ # field_mappings: [
1002
+ # {
1003
+ # data_source_field_name: "DataSourceFieldName", # required
1004
+ # date_field_format: "DataSourceDateFieldFormat",
1005
+ # index_field_name: "IndexFieldName", # required
1006
+ # },
1007
+ # ],
1008
+ # },
995
1009
  # },
996
1010
  # description: "Description",
997
1011
  # schedule: "ScanSchedule",
@@ -1129,6 +1143,13 @@ module Aws::Kendra
1129
1143
  # The `Edition` parameter is optional. If you don't supply a value, the
1130
1144
  # default is `ENTERPRISE_EDITION`.
1131
1145
  #
1146
+ # For more information on quota limits for enterprise and developer
1147
+ # editions, see [Quotas][1].
1148
+ #
1149
+ #
1150
+ #
1151
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1152
+ #
1132
1153
  # @option params [required, String] :role_arn
1133
1154
  # An Identity and Access Management(IAM) role that gives Amazon Kendra
1134
1155
  # permissions to access your Amazon CloudWatch logs and metrics. This is
@@ -1647,7 +1668,7 @@ module Aws::Kendra
1647
1668
  # resp.id #=> String
1648
1669
  # resp.index_id #=> String
1649
1670
  # resp.name #=> String
1650
- # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
1671
+ # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
1651
1672
  # resp.configuration.s3_configuration.bucket_name #=> String
1652
1673
  # resp.configuration.s3_configuration.inclusion_prefixes #=> Array
1653
1674
  # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
@@ -1855,6 +1876,17 @@ module Aws::Kendra
1855
1876
  # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].host #=> String
1856
1877
  # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].port #=> Integer
1857
1878
  # resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].credentials #=> String
1879
+ # resp.configuration.work_docs_configuration.organization_id #=> String
1880
+ # resp.configuration.work_docs_configuration.crawl_comments #=> Boolean
1881
+ # resp.configuration.work_docs_configuration.use_change_log #=> Boolean
1882
+ # resp.configuration.work_docs_configuration.inclusion_patterns #=> Array
1883
+ # resp.configuration.work_docs_configuration.inclusion_patterns[0] #=> String
1884
+ # resp.configuration.work_docs_configuration.exclusion_patterns #=> Array
1885
+ # resp.configuration.work_docs_configuration.exclusion_patterns[0] #=> String
1886
+ # resp.configuration.work_docs_configuration.field_mappings #=> Array
1887
+ # resp.configuration.work_docs_configuration.field_mappings[0].data_source_field_name #=> String
1888
+ # resp.configuration.work_docs_configuration.field_mappings[0].date_field_format #=> String
1889
+ # resp.configuration.work_docs_configuration.field_mappings[0].index_field_name #=> String
1858
1890
  # resp.created_at #=> Time
1859
1891
  # resp.updated_at #=> Time
1860
1892
  # resp.description #=> String
@@ -2381,7 +2413,7 @@ module Aws::Kendra
2381
2413
  # resp.summary_items #=> Array
2382
2414
  # resp.summary_items[0].name #=> String
2383
2415
  # resp.summary_items[0].id #=> String
2384
- # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
2416
+ # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS"
2385
2417
  # resp.summary_items[0].created_at #=> Time
2386
2418
  # resp.summary_items[0].updated_at #=> Time
2387
2419
  # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
@@ -3150,7 +3182,7 @@ module Aws::Kendra
3150
3182
  end
3151
3183
 
3152
3184
  # Enables you to provide feedback to Amazon Kendra to improve the
3153
- # performance of the service.
3185
+ # performance of your index.
3154
3186
  #
3155
3187
  # @option params [required, String] :index_id
3156
3188
  # The identifier of the index that was queried.
@@ -3592,6 +3624,20 @@ module Aws::Kendra
3592
3624
  # ],
3593
3625
  # },
3594
3626
  # },
3627
+ # work_docs_configuration: {
3628
+ # organization_id: "OrganizationId", # required
3629
+ # crawl_comments: false,
3630
+ # use_change_log: false,
3631
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3632
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3633
+ # field_mappings: [
3634
+ # {
3635
+ # data_source_field_name: "DataSourceFieldName", # required
3636
+ # date_field_format: "DataSourceDateFieldFormat",
3637
+ # index_field_name: "IndexFieldName", # required
3638
+ # },
3639
+ # ],
3640
+ # },
3595
3641
  # },
3596
3642
  # description: "Description",
3597
3643
  # schedule: "ScanSchedule",
@@ -3921,7 +3967,7 @@ module Aws::Kendra
3921
3967
  params: params,
3922
3968
  config: config)
3923
3969
  context[:gem_name] = 'aws-sdk-kendra'
3924
- context[:gem_version] = '1.30.0'
3970
+ context[:gem_version] = '1.31.0'
3925
3971
  Seahorse::Client::Request.new(handlers, context)
3926
3972
  end
3927
3973
 
@@ -254,6 +254,7 @@ module Aws::Kendra
254
254
  OneDriveUserList = Shapes::ListShape.new(name: 'OneDriveUserList')
255
255
  OneDriveUsers = Shapes::StructureShape.new(name: 'OneDriveUsers')
256
256
  Order = Shapes::StringShape.new(name: 'Order')
257
+ OrganizationId = Shapes::StringShape.new(name: 'OrganizationId')
257
258
  Port = Shapes::IntegerShape.new(name: 'Port')
258
259
  Principal = Shapes::StructureShape.new(name: 'Principal')
259
260
  PrincipalList = Shapes::ListShape.new(name: 'PrincipalList')
@@ -397,6 +398,7 @@ module Aws::Kendra
397
398
  VpcSecurityGroupId = Shapes::StringShape.new(name: 'VpcSecurityGroupId')
398
399
  WebCrawlerConfiguration = Shapes::StructureShape.new(name: 'WebCrawlerConfiguration')
399
400
  WebCrawlerMode = Shapes::StringShape.new(name: 'WebCrawlerMode')
401
+ WorkDocsConfiguration = Shapes::StructureShape.new(name: 'WorkDocsConfiguration')
400
402
 
401
403
  AccessControlListConfiguration.add_member(:key_path, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "KeyPath"))
402
404
  AccessControlListConfiguration.struct_class = Types::AccessControlListConfiguration
@@ -651,6 +653,7 @@ module Aws::Kendra
651
653
  DataSourceConfiguration.add_member(:confluence_configuration, Shapes::ShapeRef.new(shape: ConfluenceConfiguration, location_name: "ConfluenceConfiguration"))
652
654
  DataSourceConfiguration.add_member(:google_drive_configuration, Shapes::ShapeRef.new(shape: GoogleDriveConfiguration, location_name: "GoogleDriveConfiguration"))
653
655
  DataSourceConfiguration.add_member(:web_crawler_configuration, Shapes::ShapeRef.new(shape: WebCrawlerConfiguration, location_name: "WebCrawlerConfiguration"))
656
+ DataSourceConfiguration.add_member(:work_docs_configuration, Shapes::ShapeRef.new(shape: WorkDocsConfiguration, location_name: "WorkDocsConfiguration"))
654
657
  DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
655
658
 
656
659
  DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId"))
@@ -1522,6 +1525,14 @@ module Aws::Kendra
1522
1525
  WebCrawlerConfiguration.add_member(:authentication_configuration, Shapes::ShapeRef.new(shape: AuthenticationConfiguration, location_name: "AuthenticationConfiguration"))
1523
1526
  WebCrawlerConfiguration.struct_class = Types::WebCrawlerConfiguration
1524
1527
 
1528
+ WorkDocsConfiguration.add_member(:organization_id, Shapes::ShapeRef.new(shape: OrganizationId, required: true, location_name: "OrganizationId"))
1529
+ WorkDocsConfiguration.add_member(:crawl_comments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlComments"))
1530
+ WorkDocsConfiguration.add_member(:use_change_log, Shapes::ShapeRef.new(shape: Boolean, location_name: "UseChangeLog"))
1531
+ WorkDocsConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
1532
+ WorkDocsConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
1533
+ WorkDocsConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings"))
1534
+ WorkDocsConfiguration.struct_class = Types::WorkDocsConfiguration
1535
+
1525
1536
 
1526
1537
  # @api private
1527
1538
  API = Seahorse::Model::Api.new.tap do |api|
@@ -128,6 +128,10 @@ module Aws::Kendra
128
128
  # exception with the message "`AttributeFilter` cannot have a depth of
129
129
  # more than 2."
130
130
  #
131
+ # If you use more than 10 attribute filters, you receive a
132
+ # `ValidationException` exception with the message "`AttributeFilter`
133
+ # cannot have a length of more than 10".
134
+ #
131
135
  # @note When making an API call, you may pass AttributeFilter
132
136
  # data as a hash:
133
137
  #
@@ -911,23 +915,25 @@ module Aws::Kendra
911
915
  #
912
916
  # @!attribute [rw] storage_capacity_units
913
917
  # The amount of extra storage capacity for an index. A single capacity
914
- # unit for an index provides 150 GB of storage space or 500,000
915
- # documents, whichever is reached first.
918
+ # unit provides 30 GB of storage space or 100,000 documents, whichever
919
+ # is reached first.
916
920
  # @return [Integer]
917
921
  #
918
922
  # @!attribute [rw] query_capacity_units
919
923
  # The amount of extra query capacity for an index and
920
924
  # [GetQuerySuggestions][1] capacity.
921
925
  #
922
- # A single extra capacity unit for an index provides 0.5 queries per
923
- # second or approximately 40,000 queries per day.
926
+ # A single extra capacity unit for an index provides 0.1 queries per
927
+ # second or approximately 8,000 queries per day.
924
928
  #
925
- # `GetQuerySuggestions` capacity is 5 times the provisioned query
926
- # capacity for an index. For example, the base capacity for an index
927
- # is 0.5 queries per second, so GetQuerySuggestions capacity is 2.5
928
- # calls per second. If adding another 0.5 queries per second to total
929
- # 1 queries per second for an index, the `GetQuerySuggestions`
930
- # capacity is 5 calls per second.
929
+ # `GetQuerySuggestions` capacity is five times the provisioned query
930
+ # capacity for an index, or the base capacity of 2.5 calls per second,
931
+ # whichever is higher. For example, the base capacity for an index is
932
+ # 0.1 queries per second, and `GetQuerySuggestions` capacity has a
933
+ # base of 2.5 calls per second. If you add another 0.1 queries per
934
+ # second to total 0.2 queries per second for an index, the
935
+ # `GetQuerySuggestions` capacity is 2.5 calls per second (higher than
936
+ # five times 0.2 queries per second).
931
937
  #
932
938
  #
933
939
  #
@@ -1580,11 +1586,11 @@ module Aws::Kendra
1580
1586
  # @return [String]
1581
1587
  #
1582
1588
  # @!attribute [rw] secret_arn
1583
- # The Amazon Resource Name (ARN) of credentials stored in AWS Secrets
1589
+ # The Amazon Resource Name (ARN) of credentials stored in Secrets
1584
1590
  # Manager. The credentials should be a user/password pair. For more
1585
1591
  # information, see [Using a Database Data Source][1]. For more
1586
- # information about AWS Secrets Manager, see [ What Is AWS Secrets
1587
- # Manager ][2] in the <i> Secrets Manager </i> user guide.
1592
+ # information about Secrets Manager, see [ What Is Secrets Manager][2]
1593
+ # in the <i> Secrets Manager </i> user guide.
1588
1594
  #
1589
1595
  #
1590
1596
  #
@@ -1610,7 +1616,7 @@ module Aws::Kendra
1610
1616
  # {
1611
1617
  # name: "DataSourceName", # required
1612
1618
  # index_id: "IndexId", # required
1613
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER
1619
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS
1614
1620
  # configuration: {
1615
1621
  # s3_configuration: {
1616
1622
  # bucket_name: "S3BucketName", # required
@@ -1908,6 +1914,20 @@ module Aws::Kendra
1908
1914
  # ],
1909
1915
  # },
1910
1916
  # },
1917
+ # work_docs_configuration: {
1918
+ # organization_id: "OrganizationId", # required
1919
+ # crawl_comments: false,
1920
+ # use_change_log: false,
1921
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1922
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1923
+ # field_mappings: [
1924
+ # {
1925
+ # data_source_field_name: "DataSourceFieldName", # required
1926
+ # date_field_format: "DataSourceDateFieldFormat",
1927
+ # index_field_name: "IndexFieldName", # required
1928
+ # },
1929
+ # ],
1930
+ # },
1911
1931
  # },
1912
1932
  # description: "Description",
1913
1933
  # schedule: "ScanSchedule",
@@ -2177,6 +2197,13 @@ module Aws::Kendra
2177
2197
  #
2178
2198
  # The `Edition` parameter is optional. If you don't supply a value,
2179
2199
  # the default is `ENTERPRISE_EDITION`.
2200
+ #
2201
+ # For more information on quota limits for enterprise and developer
2202
+ # editions, see [Quotas][1].
2203
+ #
2204
+ #
2205
+ #
2206
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2180
2207
  # @return [String]
2181
2208
  #
2182
2209
  # @!attribute [rw] role_arn
@@ -2750,6 +2777,20 @@ module Aws::Kendra
2750
2777
  # ],
2751
2778
  # },
2752
2779
  # },
2780
+ # work_docs_configuration: {
2781
+ # organization_id: "OrganizationId", # required
2782
+ # crawl_comments: false,
2783
+ # use_change_log: false,
2784
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2785
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2786
+ # field_mappings: [
2787
+ # {
2788
+ # data_source_field_name: "DataSourceFieldName", # required
2789
+ # date_field_format: "DataSourceDateFieldFormat",
2790
+ # index_field_name: "IndexFieldName", # required
2791
+ # },
2792
+ # ],
2793
+ # },
2753
2794
  # }
2754
2795
  #
2755
2796
  # @!attribute [rw] s3_configuration
@@ -2797,6 +2838,11 @@ module Aws::Kendra
2797
2838
  # web crawler.
2798
2839
  # @return [Types::WebCrawlerConfiguration]
2799
2840
  #
2841
+ # @!attribute [rw] work_docs_configuration
2842
+ # Provides the configuration information to connect to WorkDocs as
2843
+ # your data source.
2844
+ # @return [Types::WorkDocsConfiguration]
2845
+ #
2800
2846
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
2801
2847
  #
2802
2848
  class DataSourceConfiguration < Struct.new(
@@ -2808,7 +2854,8 @@ module Aws::Kendra
2808
2854
  :service_now_configuration,
2809
2855
  :confluence_configuration,
2810
2856
  :google_drive_configuration,
2811
- :web_crawler_configuration)
2857
+ :web_crawler_configuration,
2858
+ :work_docs_configuration)
2812
2859
  SENSITIVE = []
2813
2860
  include Aws::Structure
2814
2861
  end
@@ -7465,13 +7512,13 @@ module Aws::Kendra
7465
7512
  # @return [Array<String>]
7466
7513
  #
7467
7514
  # @!attribute [rw] secret_arn
7468
- # The Amazon Resource Name (ARN) of credentials stored in AWS Secrets
7515
+ # The Amazon Resource Name (ARN) of credentials stored in Secrets
7469
7516
  # Manager. The credentials should be a user/password pair. If you use
7470
- # SharePoint Sever, you also need to provide the sever domain name as
7517
+ # SharePoint Server, you also need to provide the sever domain name as
7471
7518
  # part of the credentials. For more information, see [Using a
7472
- # Microsoft SharePoint Data Source][1]. For more information about AWS
7473
- # Secrets Manager, see [ What Is AWS Secrets Manager ][2] in the
7474
- # <i>Secrets Manager </i> user guide.
7519
+ # Microsoft SharePoint Data Source][1]. For more information about
7520
+ # Secrets Manager, see [ What Is Secrets Manager][2] in the <i>Secrets
7521
+ # Manager </i> user guide.
7475
7522
  #
7476
7523
  #
7477
7524
  #
@@ -8430,6 +8477,20 @@ module Aws::Kendra
8430
8477
  # ],
8431
8478
  # },
8432
8479
  # },
8480
+ # work_docs_configuration: {
8481
+ # organization_id: "OrganizationId", # required
8482
+ # crawl_comments: false,
8483
+ # use_change_log: false,
8484
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
8485
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
8486
+ # field_mappings: [
8487
+ # {
8488
+ # data_source_field_name: "DataSourceFieldName", # required
8489
+ # date_field_format: "DataSourceDateFieldFormat",
8490
+ # index_field_name: "IndexFieldName", # required
8491
+ # },
8492
+ # ],
8493
+ # },
8433
8494
  # },
8434
8495
  # description: "Description",
8435
8496
  # schedule: "ScanSchedule",
@@ -9115,5 +9176,110 @@ module Aws::Kendra
9115
9176
  include Aws::Structure
9116
9177
  end
9117
9178
 
9179
+ # Provides the configuration information to connect to Amazon WorkDocs
9180
+ # as your data source.
9181
+ #
9182
+ # Amazon WorkDocs connector is available in Oregon, North Virginia,
9183
+ # Sydney, Singapore and Ireland regions.
9184
+ #
9185
+ # @note When making an API call, you may pass WorkDocsConfiguration
9186
+ # data as a hash:
9187
+ #
9188
+ # {
9189
+ # organization_id: "OrganizationId", # required
9190
+ # crawl_comments: false,
9191
+ # use_change_log: false,
9192
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
9193
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
9194
+ # field_mappings: [
9195
+ # {
9196
+ # data_source_field_name: "DataSourceFieldName", # required
9197
+ # date_field_format: "DataSourceDateFieldFormat",
9198
+ # index_field_name: "IndexFieldName", # required
9199
+ # },
9200
+ # ],
9201
+ # }
9202
+ #
9203
+ # @!attribute [rw] organization_id
9204
+ # The identifier of the directory corresponding to your Amazon
9205
+ # WorkDocs site repository.
9206
+ #
9207
+ # You can find the organization ID in the [AWS Directory Service][1]
9208
+ # by going to **Active Directory**, then **Directories**. Your Amazon
9209
+ # WorkDocs site directory has an ID, which is the organization ID. You
9210
+ # can also set up a new Amazon WorkDocs directory in the AWS Directory
9211
+ # Service console and enable a Amazon WorkDocs site for the directory
9212
+ # in the Amazon WorkDocs console.
9213
+ #
9214
+ #
9215
+ #
9216
+ # [1]: https://console.aws.amazon.com/directoryservicev2/
9217
+ # @return [String]
9218
+ #
9219
+ # @!attribute [rw] crawl_comments
9220
+ # `TRUE` to include comments on documents in your index. Including
9221
+ # comments in your index means each comment is a document that can be
9222
+ # searched on.
9223
+ #
9224
+ # The default is set to `FALSE`.
9225
+ # @return [Boolean]
9226
+ #
9227
+ # @!attribute [rw] use_change_log
9228
+ # `TRUE` to use the change logs to update documents in your index
9229
+ # instead of scanning all documents.
9230
+ #
9231
+ # If you are syncing your Amazon WorkDocs data source with your index
9232
+ # for the first time, all documents are scanned. After your first
9233
+ # sync, you can use the change logs to update your documents in your
9234
+ # index for future syncs.
9235
+ #
9236
+ # The default is set to `FALSE`.
9237
+ # @return [Boolean]
9238
+ #
9239
+ # @!attribute [rw] inclusion_patterns
9240
+ # A list of regular expression patterns to include certain files in
9241
+ # your Amazon WorkDocs site repository. Files that match the patterns
9242
+ # are included in the index. Files that don't match the patterns are
9243
+ # excluded from the index. If a file matches both an inclusion pattern
9244
+ # and an exclusion pattern, the exclusion pattern takes precedence and
9245
+ # the file isn’t included in the index.
9246
+ # @return [Array<String>]
9247
+ #
9248
+ # @!attribute [rw] exclusion_patterns
9249
+ # A list of regular expression patterns to exclude certain files in
9250
+ # your Amazon WorkDocs site repository. Files that match the patterns
9251
+ # are excluded from the index. Files that don’t match the patterns are
9252
+ # included in the index. If a file matches both an inclusion pattern
9253
+ # and an exclusion pattern, the exclusion pattern takes precedence and
9254
+ # the file isn’t included in the index.
9255
+ # @return [Array<String>]
9256
+ #
9257
+ # @!attribute [rw] field_mappings
9258
+ # A list of `DataSourceToIndexFieldMapping` objects that map Amazon
9259
+ # WorkDocs field names to custom index field names in Amazon Kendra.
9260
+ # You must first create the custom index fields using the
9261
+ # `UpdateIndex` operation before you map to Amazon WorkDocs fields.
9262
+ # For more information, see [Mapping Data Source Fields][1]. The
9263
+ # Amazon WorkDocs data source field names need to exist in your Amazon
9264
+ # WorkDocs custom metadata.
9265
+ #
9266
+ #
9267
+ #
9268
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
9269
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
9270
+ #
9271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/WorkDocsConfiguration AWS API Documentation
9272
+ #
9273
+ class WorkDocsConfiguration < Struct.new(
9274
+ :organization_id,
9275
+ :crawl_comments,
9276
+ :use_change_log,
9277
+ :inclusion_patterns,
9278
+ :exclusion_patterns,
9279
+ :field_mappings)
9280
+ SENSITIVE = []
9281
+ include Aws::Structure
9282
+ end
9283
+
9118
9284
  end
9119
9285
  end
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.30.0
4
+ version: 1.31.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: 2021-07-12 00:00:00.000000000 Z
11
+ date: 2021-07-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core