aws-sdk-kendra 1.24.0 → 1.29.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -492,6 +492,87 @@ module Aws::Kendra
492
492
  include Aws::Structure
493
493
  end
494
494
 
495
+ # Provides the configuration information to connect to websites that
496
+ # require user authentication.
497
+ #
498
+ # @note When making an API call, you may pass AuthenticationConfiguration
499
+ # data as a hash:
500
+ #
501
+ # {
502
+ # basic_authentication: [
503
+ # {
504
+ # host: "Host", # required
505
+ # port: 1, # required
506
+ # credentials: "SecretArn", # required
507
+ # },
508
+ # ],
509
+ # }
510
+ #
511
+ # @!attribute [rw] basic_authentication
512
+ # The list of configuration information that's required to connect to
513
+ # and crawl a website host using basic authentication credentials.
514
+ #
515
+ # The list includes the name and port number of the website host.
516
+ # @return [Array<Types::BasicAuthenticationConfiguration>]
517
+ #
518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AuthenticationConfiguration AWS API Documentation
519
+ #
520
+ class AuthenticationConfiguration < Struct.new(
521
+ :basic_authentication)
522
+ SENSITIVE = []
523
+ include Aws::Structure
524
+ end
525
+
526
+ # Provides the configuration information to connect to websites that
527
+ # require basic user authentication.
528
+ #
529
+ # @note When making an API call, you may pass BasicAuthenticationConfiguration
530
+ # data as a hash:
531
+ #
532
+ # {
533
+ # host: "Host", # required
534
+ # port: 1, # required
535
+ # credentials: "SecretArn", # required
536
+ # }
537
+ #
538
+ # @!attribute [rw] host
539
+ # The name of the website host you want to connect to using
540
+ # authentication credentials.
541
+ #
542
+ # For example, the host name of https://a.example.com/page1.html is
543
+ # "a.example.com".
544
+ # @return [String]
545
+ #
546
+ # @!attribute [rw] port
547
+ # The port number of the website host you want to connect to using
548
+ # authentication credentials.
549
+ #
550
+ # For example, the port for https://a.example.com/page1.html is 443,
551
+ # the standard port for HTTPS.
552
+ # @return [Integer]
553
+ #
554
+ # @!attribute [rw] credentials
555
+ # Your secret ARN, which you can create in [AWS Secrets Manager][1]
556
+ #
557
+ # You use a secret if basic authentication credentials are required to
558
+ # connect to a website. The secret stores your credentials of user
559
+ # name and password.
560
+ #
561
+ #
562
+ #
563
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
564
+ # @return [String]
565
+ #
566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BasicAuthenticationConfiguration AWS API Documentation
567
+ #
568
+ class BasicAuthenticationConfiguration < Struct.new(
569
+ :host,
570
+ :port,
571
+ :credentials)
572
+ SENSITIVE = []
573
+ include Aws::Structure
574
+ end
575
+
495
576
  # @note When making an API call, you may pass BatchDeleteDocumentRequest
496
577
  # data as a hash:
497
578
  #
@@ -500,7 +581,7 @@ module Aws::Kendra
500
581
  # document_id_list: ["DocumentId"], # required
501
582
  # data_source_sync_job_metric_target: {
502
583
  # data_source_id: "DataSourceId", # required
503
- # data_source_sync_job_id: "DataSourceSyncJobId", # required
584
+ # data_source_sync_job_id: "DataSourceSyncJobId",
504
585
  # },
505
586
  # }
506
587
  #
@@ -568,6 +649,103 @@ module Aws::Kendra
568
649
  include Aws::Structure
569
650
  end
570
651
 
652
+ # @note When making an API call, you may pass BatchGetDocumentStatusRequest
653
+ # data as a hash:
654
+ #
655
+ # {
656
+ # index_id: "IndexId", # required
657
+ # document_info_list: [ # required
658
+ # {
659
+ # document_id: "DocumentId", # required
660
+ # attributes: [
661
+ # {
662
+ # key: "DocumentAttributeKey", # required
663
+ # value: { # required
664
+ # string_value: "DocumentAttributeStringValue",
665
+ # string_list_value: ["String"],
666
+ # long_value: 1,
667
+ # date_value: Time.now,
668
+ # },
669
+ # },
670
+ # ],
671
+ # },
672
+ # ],
673
+ # }
674
+ #
675
+ # @!attribute [rw] index_id
676
+ # The identifier of the index to add documents to. The index ID is
677
+ # returned by the [ CreateIndex ][1] operation.
678
+ #
679
+ #
680
+ #
681
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
682
+ # @return [String]
683
+ #
684
+ # @!attribute [rw] document_info_list
685
+ # A list of `DocumentInfo` objects that identify the documents for
686
+ # which to get the status. You identify the documents by their
687
+ # document ID and optional attributes.
688
+ # @return [Array<Types::DocumentInfo>]
689
+ #
690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusRequest AWS API Documentation
691
+ #
692
+ class BatchGetDocumentStatusRequest < Struct.new(
693
+ :index_id,
694
+ :document_info_list)
695
+ SENSITIVE = []
696
+ include Aws::Structure
697
+ end
698
+
699
+ # @!attribute [rw] errors
700
+ # A list of documents that Amazon Kendra couldn't get the status for.
701
+ # The list includes the ID of the document and the reason that the
702
+ # status couldn't be found.
703
+ # @return [Array<Types::BatchGetDocumentStatusResponseError>]
704
+ #
705
+ # @!attribute [rw] document_status_list
706
+ # The status of documents. The status indicates if the document is
707
+ # waiting to be indexed, is in the process of indexing, has completed
708
+ # indexing, or failed indexing. If a document failed indexing, the
709
+ # status provides the reason why.
710
+ # @return [Array<Types::Status>]
711
+ #
712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponse AWS API Documentation
713
+ #
714
+ class BatchGetDocumentStatusResponse < Struct.new(
715
+ :errors,
716
+ :document_status_list)
717
+ SENSITIVE = []
718
+ include Aws::Structure
719
+ end
720
+
721
+ # Provides a response when the status of a document could not be
722
+ # retrieved.
723
+ #
724
+ # @!attribute [rw] document_id
725
+ # The unique identifier of the document whose status could not be
726
+ # retrieved.
727
+ # @return [String]
728
+ #
729
+ # @!attribute [rw] error_code
730
+ # Indicates the source of the error.
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] error_message
734
+ # States that the API could not get the status of a document. This
735
+ # could be because the request is not valid or there is a system
736
+ # error.
737
+ # @return [String]
738
+ #
739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponseError AWS API Documentation
740
+ #
741
+ class BatchGetDocumentStatusResponseError < Struct.new(
742
+ :document_id,
743
+ :error_code,
744
+ :error_message)
745
+ SENSITIVE = []
746
+ include Aws::Structure
747
+ end
748
+
571
749
  # @note When making an API call, you may pass BatchPutDocumentRequest
572
750
  # data as a hash:
573
751
  #
@@ -624,6 +802,13 @@ module Aws::Kendra
624
802
  # @!attribute [rw] documents
625
803
  # One or more documents to add to the index.
626
804
  #
805
+ # Documents can include custom attributes. For example,
806
+ # 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
807
+ # that provide information on the synchronization of documents running
808
+ # on a data source. Note, 'DataSourceSyncJobId' could be an optional
809
+ # custom attribute as Amazon Kendra will use the ID of a running sync
810
+ # job.
811
+ #
627
812
  # Documents have the following file size limits.
628
813
  #
629
814
  # * 5 MB total size for inline documents
@@ -697,8 +882,9 @@ module Aws::Kendra
697
882
  include Aws::Structure
698
883
  end
699
884
 
700
- # Specifies capacity units configured for your index. You can add and
701
- # remove capacity units to tune an index to your requirements.
885
+ # Specifies capacity units configured for your enterprise edition index.
886
+ # You can add and remove capacity units to tune an index to your
887
+ # requirements.
702
888
  #
703
889
  # @note When making an API call, you may pass CapacityUnitsConfiguration
704
890
  # data as a hash:
@@ -709,14 +895,30 @@ module Aws::Kendra
709
895
  # }
710
896
  #
711
897
  # @!attribute [rw] storage_capacity_units
712
- # The amount of extra storage capacity for an index. Each capacity
713
- # unit provides 150 Gb of storage space or 500,000 documents,
714
- # whichever is reached first.
898
+ # The amount of extra storage capacity for an index. A single capacity
899
+ # unit provides 30 GB of storage space or 100,000 documents, whichever
900
+ # is reached first.
715
901
  # @return [Integer]
716
902
  #
717
903
  # @!attribute [rw] query_capacity_units
718
- # The amount of extra query capacity for an index. Each capacity unit
719
- # provides 0.5 queries per second and 40,000 queries per day.
904
+ # The amount of extra query capacity for an index and
905
+ # [GetQuerySuggestions][1] capacity.
906
+ #
907
+ # A single extra capacity unit for an index provides 0.1 queries per
908
+ # second or approximately 8,000 queries per day.
909
+ #
910
+ # `GetQuerySuggestions` capacity is five times the provisioned query
911
+ # capacity for an index, or the base capacity of 2.5 calls per second,
912
+ # whichever is higher. For example, the base capacity for an index is
913
+ # 0.1 queries per second, and `GetQuerySuggestions` capacity has a
914
+ # base of 2.5 calls per second. If you add another 0.1 queries per
915
+ # second to total 0.2 queries per second for an index, the
916
+ # `GetQuerySuggestions` capacity is 2.5 calls per second (higher than
917
+ # five times 0.2 queries per second).
918
+ #
919
+ #
920
+ #
921
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html
720
922
  # @return [Integer]
721
923
  #
722
924
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CapacityUnitsConfiguration AWS API Documentation
@@ -728,6 +930,26 @@ module Aws::Kendra
728
930
  include Aws::Structure
729
931
  end
730
932
 
933
+ # @note When making an API call, you may pass ClearQuerySuggestionsRequest
934
+ # data as a hash:
935
+ #
936
+ # {
937
+ # index_id: "IndexId", # required
938
+ # }
939
+ #
940
+ # @!attribute [rw] index_id
941
+ # The identifier of the index you want to clear query suggestions
942
+ # from.
943
+ # @return [String]
944
+ #
945
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestionsRequest AWS API Documentation
946
+ #
947
+ class ClearQuerySuggestionsRequest < Struct.new(
948
+ :index_id)
949
+ SENSITIVE = []
950
+ include Aws::Structure
951
+ end
952
+
731
953
  # Gathers information about when a particular result was clicked by a
732
954
  # user. Your application uses the `SubmitFeedback` operation to provide
733
955
  # click information.
@@ -1375,7 +1597,7 @@ module Aws::Kendra
1375
1597
  # {
1376
1598
  # name: "DataSourceName", # required
1377
1599
  # index_id: "IndexId", # required
1378
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
1600
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER
1379
1601
  # configuration: {
1380
1602
  # s3_configuration: {
1381
1603
  # bucket_name: "S3BucketName", # required
@@ -1390,7 +1612,7 @@ module Aws::Kendra
1390
1612
  # },
1391
1613
  # },
1392
1614
  # share_point_configuration: {
1393
- # share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
1615
+ # share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
1394
1616
  # urls: ["Url"], # required
1395
1617
  # secret_arn: "SecretArn", # required
1396
1618
  # crawl_attachments: false,
@@ -1410,6 +1632,10 @@ module Aws::Kendra
1410
1632
  # ],
1411
1633
  # document_title_field_name: "DataSourceFieldName",
1412
1634
  # disable_local_groups: false,
1635
+ # ssl_certificate_s3_path: {
1636
+ # bucket: "S3BucketName", # required
1637
+ # key: "S3ObjectKey", # required
1638
+ # },
1413
1639
  # },
1414
1640
  # database_configuration: {
1415
1641
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -1638,6 +1864,37 @@ module Aws::Kendra
1638
1864
  # exclude_user_accounts: ["UserAccount"],
1639
1865
  # exclude_shared_drives: ["SharedDriveId"],
1640
1866
  # },
1867
+ # web_crawler_configuration: {
1868
+ # urls: { # required
1869
+ # seed_url_configuration: {
1870
+ # seed_urls: ["SeedUrl"], # required
1871
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
1872
+ # },
1873
+ # site_maps_configuration: {
1874
+ # site_maps: ["SiteMap"], # required
1875
+ # },
1876
+ # },
1877
+ # crawl_depth: 1,
1878
+ # max_links_per_page: 1,
1879
+ # max_content_size_per_page_in_mega_bytes: 1.0,
1880
+ # max_urls_per_minute_crawl_rate: 1,
1881
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1882
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1883
+ # proxy_configuration: {
1884
+ # host: "Host", # required
1885
+ # port: 1, # required
1886
+ # credentials: "SecretArn",
1887
+ # },
1888
+ # authentication_configuration: {
1889
+ # basic_authentication: [
1890
+ # {
1891
+ # host: "Host", # required
1892
+ # port: 1, # required
1893
+ # credentials: "SecretArn", # required
1894
+ # },
1895
+ # ],
1896
+ # },
1897
+ # },
1641
1898
  # },
1642
1899
  # description: "Description",
1643
1900
  # schedule: "ScanSchedule",
@@ -1907,6 +2164,13 @@ module Aws::Kendra
1907
2164
  #
1908
2165
  # The `Edition` parameter is optional. If you don't supply a value,
1909
2166
  # the default is `ENTERPRISE_EDITION`.
2167
+ #
2168
+ # For more information on quota limits for enterprise and developer
2169
+ # editions, see [Quotas][1].
2170
+ #
2171
+ #
2172
+ #
2173
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1910
2174
  # @return [String]
1911
2175
  #
1912
2176
  # @!attribute [rw] role_arn
@@ -1991,6 +2255,110 @@ module Aws::Kendra
1991
2255
  include Aws::Structure
1992
2256
  end
1993
2257
 
2258
+ # @note When making an API call, you may pass CreateQuerySuggestionsBlockListRequest
2259
+ # data as a hash:
2260
+ #
2261
+ # {
2262
+ # index_id: "IndexId", # required
2263
+ # name: "QuerySuggestionsBlockListName", # required
2264
+ # description: "Description",
2265
+ # source_s3_path: { # required
2266
+ # bucket: "S3BucketName", # required
2267
+ # key: "S3ObjectKey", # required
2268
+ # },
2269
+ # client_token: "ClientTokenName",
2270
+ # role_arn: "RoleArn", # required
2271
+ # tags: [
2272
+ # {
2273
+ # key: "TagKey", # required
2274
+ # value: "TagValue", # required
2275
+ # },
2276
+ # ],
2277
+ # }
2278
+ #
2279
+ # @!attribute [rw] index_id
2280
+ # The identifier of the index you want to create a query suggestions
2281
+ # block list for.
2282
+ # @return [String]
2283
+ #
2284
+ # @!attribute [rw] name
2285
+ # A user friendly name for the block list.
2286
+ #
2287
+ # For example, the block list named 'offensive-words' includes all
2288
+ # offensive words that could appear in user queries and need to be
2289
+ # blocked from suggestions.
2290
+ # @return [String]
2291
+ #
2292
+ # @!attribute [rw] description
2293
+ # A user-friendly description for the block list.
2294
+ #
2295
+ # For example, the description "List of all offensive words that can
2296
+ # appear in user queries and need to be blocked from suggestions."
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] source_s3_path
2300
+ # The S3 path to your block list text file in your S3 bucket.
2301
+ #
2302
+ # Each block word or phrase should be on a separate line in a text
2303
+ # file.
2304
+ #
2305
+ # For information on the current quota limits for block lists, see
2306
+ # [Quotas for Amazon Kendra][1].
2307
+ #
2308
+ #
2309
+ #
2310
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2311
+ # @return [Types::S3Path]
2312
+ #
2313
+ # @!attribute [rw] client_token
2314
+ # A token that you provide to identify the request to create a query
2315
+ # suggestions block list.
2316
+ #
2317
+ # **A suitable default value is auto-generated.** You should normally
2318
+ # not need to pass this option.
2319
+ # @return [String]
2320
+ #
2321
+ # @!attribute [rw] role_arn
2322
+ # The IAM (Identity and Access Management) role used by Amazon Kendra
2323
+ # to access the block list text file in your S3 bucket.
2324
+ #
2325
+ # You need permissions to the role ARN (Amazon Resource Name). The
2326
+ # role needs S3 read permissions to your file in S3 and needs to give
2327
+ # STS (Security Token Service) assume role permissions to Amazon
2328
+ # Kendra.
2329
+ # @return [String]
2330
+ #
2331
+ # @!attribute [rw] tags
2332
+ # A tag that you can assign to a block list that categorizes the block
2333
+ # list.
2334
+ # @return [Array<Types::Tag>]
2335
+ #
2336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation
2337
+ #
2338
+ class CreateQuerySuggestionsBlockListRequest < Struct.new(
2339
+ :index_id,
2340
+ :name,
2341
+ :description,
2342
+ :source_s3_path,
2343
+ :client_token,
2344
+ :role_arn,
2345
+ :tags)
2346
+ SENSITIVE = []
2347
+ include Aws::Structure
2348
+ end
2349
+
2350
+ # @!attribute [rw] id
2351
+ # The unique identifier of the created block list.
2352
+ # @return [String]
2353
+ #
2354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListResponse AWS API Documentation
2355
+ #
2356
+ class CreateQuerySuggestionsBlockListResponse < Struct.new(
2357
+ :id)
2358
+ SENSITIVE = []
2359
+ include Aws::Structure
2360
+ end
2361
+
1994
2362
  # @note When making an API call, you may pass CreateThesaurusRequest
1995
2363
  # data as a hash:
1996
2364
  #
@@ -2094,7 +2462,7 @@ module Aws::Kendra
2094
2462
  # },
2095
2463
  # },
2096
2464
  # share_point_configuration: {
2097
- # share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
2465
+ # share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
2098
2466
  # urls: ["Url"], # required
2099
2467
  # secret_arn: "SecretArn", # required
2100
2468
  # crawl_attachments: false,
@@ -2114,6 +2482,10 @@ module Aws::Kendra
2114
2482
  # ],
2115
2483
  # document_title_field_name: "DataSourceFieldName",
2116
2484
  # disable_local_groups: false,
2485
+ # ssl_certificate_s3_path: {
2486
+ # bucket: "S3BucketName", # required
2487
+ # key: "S3ObjectKey", # required
2488
+ # },
2117
2489
  # },
2118
2490
  # database_configuration: {
2119
2491
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -2342,6 +2714,37 @@ module Aws::Kendra
2342
2714
  # exclude_user_accounts: ["UserAccount"],
2343
2715
  # exclude_shared_drives: ["SharedDriveId"],
2344
2716
  # },
2717
+ # web_crawler_configuration: {
2718
+ # urls: { # required
2719
+ # seed_url_configuration: {
2720
+ # seed_urls: ["SeedUrl"], # required
2721
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
2722
+ # },
2723
+ # site_maps_configuration: {
2724
+ # site_maps: ["SiteMap"], # required
2725
+ # },
2726
+ # },
2727
+ # crawl_depth: 1,
2728
+ # max_links_per_page: 1,
2729
+ # max_content_size_per_page_in_mega_bytes: 1.0,
2730
+ # max_urls_per_minute_crawl_rate: 1,
2731
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2732
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2733
+ # proxy_configuration: {
2734
+ # host: "Host", # required
2735
+ # port: 1, # required
2736
+ # credentials: "SecretArn",
2737
+ # },
2738
+ # authentication_configuration: {
2739
+ # basic_authentication: [
2740
+ # {
2741
+ # host: "Host", # required
2742
+ # port: 1, # required
2743
+ # credentials: "SecretArn", # required
2744
+ # },
2745
+ # ],
2746
+ # },
2747
+ # },
2345
2748
  # }
2346
2749
  #
2347
2750
  # @!attribute [rw] s3_configuration
@@ -2384,6 +2787,11 @@ module Aws::Kendra
2384
2787
  # Drive.
2385
2788
  # @return [Types::GoogleDriveConfiguration]
2386
2789
  #
2790
+ # @!attribute [rw] web_crawler_configuration
2791
+ # Provides the configuration information required for Amazon Kendra
2792
+ # web crawler.
2793
+ # @return [Types::WebCrawlerConfiguration]
2794
+ #
2387
2795
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
2388
2796
  #
2389
2797
  class DataSourceConfiguration < Struct.new(
@@ -2394,7 +2802,8 @@ module Aws::Kendra
2394
2802
  :one_drive_configuration,
2395
2803
  :service_now_configuration,
2396
2804
  :confluence_configuration,
2397
- :google_drive_configuration)
2805
+ :google_drive_configuration,
2806
+ :web_crawler_configuration)
2398
2807
  SENSITIVE = []
2399
2808
  include Aws::Structure
2400
2809
  end
@@ -2506,7 +2915,7 @@ module Aws::Kendra
2506
2915
  #
2507
2916
  # {
2508
2917
  # data_source_id: "DataSourceId", # required
2509
- # data_source_sync_job_id: "DataSourceSyncJobId", # required
2918
+ # data_source_sync_job_id: "DataSourceSyncJobId",
2510
2919
  # }
2511
2920
  #
2512
2921
  # @!attribute [rw] data_source_id
@@ -2515,6 +2924,15 @@ module Aws::Kendra
2515
2924
  #
2516
2925
  # @!attribute [rw] data_source_sync_job_id
2517
2926
  # The ID of the sync job that is running on the data source.
2927
+ #
2928
+ # If the ID of a sync job is not provided and there is a sync job
2929
+ # running, then the ID of this sync job is used and metrics are
2930
+ # generated for this sync job.
2931
+ #
2932
+ # If the ID of a sync job is not provided and there is no sync job
2933
+ # running, then no metrics are generated and documents are
2934
+ # indexed/deleted at the index level without sync job metrics
2935
+ # included.
2518
2936
  # @return [String]
2519
2937
  #
2520
2938
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
@@ -2781,6 +3199,31 @@ module Aws::Kendra
2781
3199
  include Aws::Structure
2782
3200
  end
2783
3201
 
3202
+ # @note When making an API call, you may pass DeleteQuerySuggestionsBlockListRequest
3203
+ # data as a hash:
3204
+ #
3205
+ # {
3206
+ # index_id: "IndexId", # required
3207
+ # id: "QuerySuggestionsBlockListId", # required
3208
+ # }
3209
+ #
3210
+ # @!attribute [rw] index_id
3211
+ # The identifier of the you want to delete a block list from.
3212
+ # @return [String]
3213
+ #
3214
+ # @!attribute [rw] id
3215
+ # The unique identifier of the block list that needs to be deleted.
3216
+ # @return [String]
3217
+ #
3218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
3219
+ #
3220
+ class DeleteQuerySuggestionsBlockListRequest < Struct.new(
3221
+ :index_id,
3222
+ :id)
3223
+ SENSITIVE = []
3224
+ include Aws::Structure
3225
+ end
3226
+
2784
3227
  # @note When making an API call, you may pass DeleteThesaurusRequest
2785
3228
  # data as a hash:
2786
3229
  #
@@ -3109,29 +3552,241 @@ module Aws::Kendra
3109
3552
  include Aws::Structure
3110
3553
  end
3111
3554
 
3112
- # @note When making an API call, you may pass DescribeThesaurusRequest
3555
+ # @note When making an API call, you may pass DescribeQuerySuggestionsBlockListRequest
3113
3556
  # data as a hash:
3114
3557
  #
3115
3558
  # {
3116
- # id: "ThesaurusId", # required
3117
3559
  # index_id: "IndexId", # required
3560
+ # id: "QuerySuggestionsBlockListId", # required
3118
3561
  # }
3119
3562
  #
3120
- # @!attribute [rw] id
3121
- # The identifier of the thesaurus to describe.
3563
+ # @!attribute [rw] index_id
3564
+ # The identifier of the index for the block list.
3122
3565
  # @return [String]
3123
3566
  #
3124
- # @!attribute [rw] index_id
3125
- # The identifier of the index associated with the thesaurus to
3126
- # describe.
3567
+ # @!attribute [rw] id
3568
+ # The unique identifier of the block list.
3127
3569
  # @return [String]
3128
3570
  #
3129
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
3571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
3130
3572
  #
3131
- class DescribeThesaurusRequest < Struct.new(
3132
- :id,
3133
- :index_id)
3134
- SENSITIVE = []
3573
+ class DescribeQuerySuggestionsBlockListRequest < Struct.new(
3574
+ :index_id,
3575
+ :id)
3576
+ SENSITIVE = []
3577
+ include Aws::Structure
3578
+ end
3579
+
3580
+ # @!attribute [rw] index_id
3581
+ # Shows the identifier of the index for the block list.
3582
+ # @return [String]
3583
+ #
3584
+ # @!attribute [rw] id
3585
+ # Shows the unique identifier of the block list.
3586
+ # @return [String]
3587
+ #
3588
+ # @!attribute [rw] name
3589
+ # Shows the name of the block list.
3590
+ # @return [String]
3591
+ #
3592
+ # @!attribute [rw] description
3593
+ # Shows the description for the block list.
3594
+ # @return [String]
3595
+ #
3596
+ # @!attribute [rw] status
3597
+ # Shows whether the current status of the block list is `ACTIVE` or
3598
+ # `INACTIVE`.
3599
+ # @return [String]
3600
+ #
3601
+ # @!attribute [rw] error_message
3602
+ # Shows the error message with details when there are issues in
3603
+ # processing the block list.
3604
+ # @return [String]
3605
+ #
3606
+ # @!attribute [rw] created_at
3607
+ # Shows the date-time a block list for query suggestions was last
3608
+ # created.
3609
+ # @return [Time]
3610
+ #
3611
+ # @!attribute [rw] updated_at
3612
+ # Shows the date-time a block list for query suggestions was last
3613
+ # updated.
3614
+ # @return [Time]
3615
+ #
3616
+ # @!attribute [rw] source_s3_path
3617
+ # Shows the current S3 path to your block list text file in your S3
3618
+ # bucket.
3619
+ #
3620
+ # Each block word or phrase should be on a separate line in a text
3621
+ # file.
3622
+ #
3623
+ # For information on the current quota limits for block lists, see
3624
+ # [Quotas for Amazon Kendra][1].
3625
+ #
3626
+ #
3627
+ #
3628
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
3629
+ # @return [Types::S3Path]
3630
+ #
3631
+ # @!attribute [rw] item_count
3632
+ # Shows the current number of valid, non-empty words or phrases in the
3633
+ # block list text file.
3634
+ # @return [Integer]
3635
+ #
3636
+ # @!attribute [rw] file_size_bytes
3637
+ # Shows the current size of the block list text file in S3.
3638
+ # @return [Integer]
3639
+ #
3640
+ # @!attribute [rw] role_arn
3641
+ # Shows the current IAM (Identity and Access Management) role used by
3642
+ # Amazon Kendra to access the block list text file in S3.
3643
+ #
3644
+ # The role needs S3 read permissions to your file in S3 and needs to
3645
+ # give STS (Security Token Service) assume role permissions to Amazon
3646
+ # Kendra.
3647
+ # @return [String]
3648
+ #
3649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListResponse AWS API Documentation
3650
+ #
3651
+ class DescribeQuerySuggestionsBlockListResponse < Struct.new(
3652
+ :index_id,
3653
+ :id,
3654
+ :name,
3655
+ :description,
3656
+ :status,
3657
+ :error_message,
3658
+ :created_at,
3659
+ :updated_at,
3660
+ :source_s3_path,
3661
+ :item_count,
3662
+ :file_size_bytes,
3663
+ :role_arn)
3664
+ SENSITIVE = []
3665
+ include Aws::Structure
3666
+ end
3667
+
3668
+ # @note When making an API call, you may pass DescribeQuerySuggestionsConfigRequest
3669
+ # data as a hash:
3670
+ #
3671
+ # {
3672
+ # index_id: "IndexId", # required
3673
+ # }
3674
+ #
3675
+ # @!attribute [rw] index_id
3676
+ # The identifier of the index you want to describe query suggestions
3677
+ # settings for.
3678
+ # @return [String]
3679
+ #
3680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
3681
+ #
3682
+ class DescribeQuerySuggestionsConfigRequest < Struct.new(
3683
+ :index_id)
3684
+ SENSITIVE = []
3685
+ include Aws::Structure
3686
+ end
3687
+
3688
+ # @!attribute [rw] mode
3689
+ # Shows whether query suggestions are currently in `ENABLED` mode or
3690
+ # `LEARN_ONLY` mode.
3691
+ #
3692
+ # By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
3693
+ # turns off query suggestions for your users. You can change the mode
3694
+ # using the [UpdateQuerySuggestionsConfig][1] operation.
3695
+ #
3696
+ #
3697
+ #
3698
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
3699
+ # @return [String]
3700
+ #
3701
+ # @!attribute [rw] status
3702
+ # Shows whether the status of query suggestions settings is currently
3703
+ # Active or Updating.
3704
+ #
3705
+ # Active means the current settings apply and Updating means your
3706
+ # changed settings are in the process of applying.
3707
+ # @return [String]
3708
+ #
3709
+ # @!attribute [rw] query_log_look_back_window_in_days
3710
+ # Shows how recent your queries are in your query log time window (in
3711
+ # days).
3712
+ # @return [Integer]
3713
+ #
3714
+ # @!attribute [rw] include_queries_without_user_information
3715
+ # Shows whether Amazon Kendra uses all queries or only uses queries
3716
+ # that include user information to generate query suggestions.
3717
+ # @return [Boolean]
3718
+ #
3719
+ # @!attribute [rw] minimum_number_of_querying_users
3720
+ # Shows the minimum number of unique users who must search a query in
3721
+ # order for the query to be eligible to suggest to your users.
3722
+ # @return [Integer]
3723
+ #
3724
+ # @!attribute [rw] minimum_query_count
3725
+ # Shows the minimum number of times a query must be searched in order
3726
+ # for the query to be eligible to suggest to your users.
3727
+ # @return [Integer]
3728
+ #
3729
+ # @!attribute [rw] last_suggestions_build_time
3730
+ # Shows the date-time query suggestions for an index was last updated.
3731
+ # @return [Time]
3732
+ #
3733
+ # @!attribute [rw] last_clear_time
3734
+ # Shows the date-time query suggestions for an index was last cleared.
3735
+ #
3736
+ # After you clear suggestions, Amazon Kendra learns new suggestions
3737
+ # based on new queries added to the query log from the time you
3738
+ # cleared suggestions. Amazon Kendra only considers re-occurences of a
3739
+ # query from the time you cleared suggestions.
3740
+ # @return [Time]
3741
+ #
3742
+ # @!attribute [rw] total_suggestions_count
3743
+ # Shows the current total count of query suggestions for an index.
3744
+ #
3745
+ # This count can change when you update your query suggestions
3746
+ # settings, if you filter out certain queries from suggestions using a
3747
+ # block list, and as the query log accumulates more queries for Amazon
3748
+ # Kendra to learn from.
3749
+ # @return [Integer]
3750
+ #
3751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigResponse AWS API Documentation
3752
+ #
3753
+ class DescribeQuerySuggestionsConfigResponse < Struct.new(
3754
+ :mode,
3755
+ :status,
3756
+ :query_log_look_back_window_in_days,
3757
+ :include_queries_without_user_information,
3758
+ :minimum_number_of_querying_users,
3759
+ :minimum_query_count,
3760
+ :last_suggestions_build_time,
3761
+ :last_clear_time,
3762
+ :total_suggestions_count)
3763
+ SENSITIVE = []
3764
+ include Aws::Structure
3765
+ end
3766
+
3767
+ # @note When making an API call, you may pass DescribeThesaurusRequest
3768
+ # data as a hash:
3769
+ #
3770
+ # {
3771
+ # id: "ThesaurusId", # required
3772
+ # index_id: "IndexId", # required
3773
+ # }
3774
+ #
3775
+ # @!attribute [rw] id
3776
+ # The identifier of the thesaurus to describe.
3777
+ # @return [String]
3778
+ #
3779
+ # @!attribute [rw] index_id
3780
+ # The identifier of the index associated with the thesaurus to
3781
+ # describe.
3782
+ # @return [String]
3783
+ #
3784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
3785
+ #
3786
+ class DescribeThesaurusRequest < Struct.new(
3787
+ :id,
3788
+ :index_id)
3789
+ SENSITIVE = []
3135
3790
  include Aws::Structure
3136
3791
  end
3137
3792
 
@@ -3362,6 +4017,11 @@ module Aws::Kendra
3362
4017
  #
3363
4018
  # @!attribute [rw] date_value
3364
4019
  # A date expressed as an ISO 8601 string.
4020
+ #
4021
+ # It is important for the time zone to be included in the ISO 8601
4022
+ # date-time format. For example, 20120325T123010+01:00 is the ISO 8601
4023
+ # date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in
4024
+ # Central European Time.
3365
4025
  # @return [Time]
3366
4026
  #
3367
4027
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
@@ -3396,6 +4056,61 @@ module Aws::Kendra
3396
4056
  include Aws::Structure
3397
4057
  end
3398
4058
 
4059
+ # Identifies a document for which to retrieve status information
4060
+ #
4061
+ # @note When making an API call, you may pass DocumentInfo
4062
+ # data as a hash:
4063
+ #
4064
+ # {
4065
+ # document_id: "DocumentId", # required
4066
+ # attributes: [
4067
+ # {
4068
+ # key: "DocumentAttributeKey", # required
4069
+ # value: { # required
4070
+ # string_value: "DocumentAttributeStringValue",
4071
+ # string_list_value: ["String"],
4072
+ # long_value: 1,
4073
+ # date_value: Time.now,
4074
+ # },
4075
+ # },
4076
+ # ],
4077
+ # }
4078
+ #
4079
+ # @!attribute [rw] document_id
4080
+ # The unique identifier of the document.
4081
+ # @return [String]
4082
+ #
4083
+ # @!attribute [rw] attributes
4084
+ # Attributes that identify a specific version of a document to check.
4085
+ #
4086
+ # The only valid attributes are:
4087
+ #
4088
+ # * version
4089
+ #
4090
+ # * datasourceId
4091
+ #
4092
+ # * jobExecutionId
4093
+ #
4094
+ # The attributes follow these rules:
4095
+ #
4096
+ # * `dataSourceId` and `jobExecutionId` must be used together.
4097
+ #
4098
+ # * `version` is ignored if `dataSourceId` and `jobExecutionId` are
4099
+ # not provided.
4100
+ #
4101
+ # * If `dataSourceId` and `jobExecutionId` are provided, but `version`
4102
+ # is not, the version defaults to "0".
4103
+ # @return [Array<Types::DocumentAttribute>]
4104
+ #
4105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentInfo AWS API Documentation
4106
+ #
4107
+ class DocumentInfo < Struct.new(
4108
+ :document_id,
4109
+ :attributes)
4110
+ SENSITIVE = []
4111
+ include Aws::Structure
4112
+ end
4113
+
3399
4114
  # Specifies the properties of a custom index field.
3400
4115
  #
3401
4116
  # @note When making an API call, you may pass DocumentMetadataConfiguration
@@ -3621,6 +4336,63 @@ module Aws::Kendra
3621
4336
  include Aws::Structure
3622
4337
  end
3623
4338
 
4339
+ # @note When making an API call, you may pass GetQuerySuggestionsRequest
4340
+ # data as a hash:
4341
+ #
4342
+ # {
4343
+ # index_id: "IndexId", # required
4344
+ # query_text: "SuggestionQueryText", # required
4345
+ # max_suggestions_count: 1,
4346
+ # }
4347
+ #
4348
+ # @!attribute [rw] index_id
4349
+ # The identifier of the index you want to get query suggestions from.
4350
+ # @return [String]
4351
+ #
4352
+ # @!attribute [rw] query_text
4353
+ # The text of a user's query to generate query suggestions.
4354
+ #
4355
+ # A query is suggested if the query prefix matches what a user starts
4356
+ # to type as their query.
4357
+ #
4358
+ # Amazon Kendra does not show any suggestions if a user types fewer
4359
+ # than two characters or more than 60 characters. A query must also
4360
+ # have at least one search result and contain at least one word of
4361
+ # more than four characters.
4362
+ # @return [String]
4363
+ #
4364
+ # @!attribute [rw] max_suggestions_count
4365
+ # The maximum number of query suggestions you want to show to your
4366
+ # users.
4367
+ # @return [Integer]
4368
+ #
4369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsRequest AWS API Documentation
4370
+ #
4371
+ class GetQuerySuggestionsRequest < Struct.new(
4372
+ :index_id,
4373
+ :query_text,
4374
+ :max_suggestions_count)
4375
+ SENSITIVE = []
4376
+ include Aws::Structure
4377
+ end
4378
+
4379
+ # @!attribute [rw] query_suggestions_id
4380
+ # The unique identifier for a list of query suggestions for an index.
4381
+ # @return [String]
4382
+ #
4383
+ # @!attribute [rw] suggestions
4384
+ # A list of query suggestions for an index.
4385
+ # @return [Array<Types::Suggestion>]
4386
+ #
4387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsResponse AWS API Documentation
4388
+ #
4389
+ class GetQuerySuggestionsResponse < Struct.new(
4390
+ :query_suggestions_id,
4391
+ :suggestions)
4392
+ SENSITIVE = []
4393
+ include Aws::Structure
4394
+ end
4395
+
3624
4396
  # Provides configuration information for data sources that connect to
3625
4397
  # Google Drive.
3626
4398
  #
@@ -4145,6 +4917,78 @@ module Aws::Kendra
4145
4917
  include Aws::Structure
4146
4918
  end
4147
4919
 
4920
+ # @note When making an API call, you may pass ListQuerySuggestionsBlockListsRequest
4921
+ # data as a hash:
4922
+ #
4923
+ # {
4924
+ # index_id: "IndexId", # required
4925
+ # next_token: "NextToken",
4926
+ # max_results: 1,
4927
+ # }
4928
+ #
4929
+ # @!attribute [rw] index_id
4930
+ # The identifier of the index for a list of all block lists that exist
4931
+ # for that index.
4932
+ #
4933
+ # For information on the current quota limits for block lists, see
4934
+ # [Quotas for Amazon Kendra][1].
4935
+ #
4936
+ #
4937
+ #
4938
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
4939
+ # @return [String]
4940
+ #
4941
+ # @!attribute [rw] next_token
4942
+ # If the previous response was incomplete (because there is more data
4943
+ # to retrieve), Amazon Kendra returns a pagination token in the
4944
+ # response. You can use this pagination token to retrieve the next set
4945
+ # of block lists (`BlockListSummaryItems`).
4946
+ # @return [String]
4947
+ #
4948
+ # @!attribute [rw] max_results
4949
+ # The maximum number of block lists to return.
4950
+ # @return [Integer]
4951
+ #
4952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsRequest AWS API Documentation
4953
+ #
4954
+ class ListQuerySuggestionsBlockListsRequest < Struct.new(
4955
+ :index_id,
4956
+ :next_token,
4957
+ :max_results)
4958
+ SENSITIVE = []
4959
+ include Aws::Structure
4960
+ end
4961
+
4962
+ # @!attribute [rw] block_list_summary_items
4963
+ # Summary items for a block list.
4964
+ #
4965
+ # This includes summary items on the block list ID, block list name,
4966
+ # when the block list was created, when the block list was last
4967
+ # updated, and the count of block words/phrases in the block list.
4968
+ #
4969
+ # For information on the current quota limits for block lists, see
4970
+ # [Quotas for Amazon Kendra][1].
4971
+ #
4972
+ #
4973
+ #
4974
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
4975
+ # @return [Array<Types::QuerySuggestionsBlockListSummary>]
4976
+ #
4977
+ # @!attribute [rw] next_token
4978
+ # If the response is truncated, Amazon Kendra returns this token that
4979
+ # you can use in the subsequent request to retrieve the next set of
4980
+ # block lists.
4981
+ # @return [String]
4982
+ #
4983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsResponse AWS API Documentation
4984
+ #
4985
+ class ListQuerySuggestionsBlockListsResponse < Struct.new(
4986
+ :block_list_summary_items,
4987
+ :next_token)
4988
+ SENSITIVE = []
4989
+ include Aws::Structure
4990
+ end
4991
+
4148
4992
  # @note When making an API call, you may pass ListTagsForResourceRequest
4149
4993
  # data as a hash:
4150
4994
  #
@@ -4385,6 +5229,57 @@ module Aws::Kendra
4385
5229
  include Aws::Structure
4386
5230
  end
4387
5231
 
5232
+ # Provides the configuration information for a web proxy to connect to
5233
+ # website hosts.
5234
+ #
5235
+ # @note When making an API call, you may pass ProxyConfiguration
5236
+ # data as a hash:
5237
+ #
5238
+ # {
5239
+ # host: "Host", # required
5240
+ # port: 1, # required
5241
+ # credentials: "SecretArn",
5242
+ # }
5243
+ #
5244
+ # @!attribute [rw] host
5245
+ # The name of the website host you want to connect to via a web proxy
5246
+ # server.
5247
+ #
5248
+ # For example, the host name of https://a.example.com/page1.html is
5249
+ # "a.example.com".
5250
+ # @return [String]
5251
+ #
5252
+ # @!attribute [rw] port
5253
+ # The port number of the website host you want to connect to via a web
5254
+ # proxy server.
5255
+ #
5256
+ # For example, the port for https://a.example.com/page1.html is 443,
5257
+ # the standard port for HTTPS.
5258
+ # @return [Integer]
5259
+ #
5260
+ # @!attribute [rw] credentials
5261
+ # Your secret ARN, which you can create in [AWS Secrets Manager][1]
5262
+ #
5263
+ # The credentials are optional. You use a secret if web proxy
5264
+ # credentials are required to connect to a website host. Amazon Kendra
5265
+ # currently support basic authentication to connect to a web proxy
5266
+ # server. The secret stores your credentials.
5267
+ #
5268
+ #
5269
+ #
5270
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
5271
+ # @return [String]
5272
+ #
5273
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ProxyConfiguration AWS API Documentation
5274
+ #
5275
+ class ProxyConfiguration < Struct.new(
5276
+ :host,
5277
+ :port,
5278
+ :credentials)
5279
+ SENSITIVE = []
5280
+ include Aws::Structure
5281
+ end
5282
+
4388
5283
  # @note When making an API call, you may pass QueryRequest
4389
5284
  # data as a hash:
4390
5285
  #
@@ -4726,6 +5621,57 @@ module Aws::Kendra
4726
5621
  include Aws::Structure
4727
5622
  end
4728
5623
 
5624
+ # Summary information on a query suggestions block list.
5625
+ #
5626
+ # This includes information on the block list ID, block list name, when
5627
+ # the block list was created, when the block list was last updated, and
5628
+ # the count of block words/phrases in the block list.
5629
+ #
5630
+ # For information on the current quota limits for block lists, see
5631
+ # [Quotas for Amazon Kendra][1].
5632
+ #
5633
+ #
5634
+ #
5635
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
5636
+ #
5637
+ # @!attribute [rw] id
5638
+ # The identifier of a block list.
5639
+ # @return [String]
5640
+ #
5641
+ # @!attribute [rw] name
5642
+ # The name of the block list.
5643
+ # @return [String]
5644
+ #
5645
+ # @!attribute [rw] status
5646
+ # The status of the block list.
5647
+ # @return [String]
5648
+ #
5649
+ # @!attribute [rw] created_at
5650
+ # The date-time summary information for a query suggestions block list
5651
+ # was last created.
5652
+ # @return [Time]
5653
+ #
5654
+ # @!attribute [rw] updated_at
5655
+ # The date-time the block list was last updated.
5656
+ # @return [Time]
5657
+ #
5658
+ # @!attribute [rw] item_count
5659
+ # The number of items in the block list file.
5660
+ # @return [Integer]
5661
+ #
5662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuerySuggestionsBlockListSummary AWS API Documentation
5663
+ #
5664
+ class QuerySuggestionsBlockListSummary < Struct.new(
5665
+ :id,
5666
+ :name,
5667
+ :status,
5668
+ :created_at,
5669
+ :updated_at,
5670
+ :item_count)
5671
+ SENSITIVE = []
5672
+ include Aws::Structure
5673
+ end
5674
+
4729
5675
  # Provides information for manually tuning the relevance of a field in a
4730
5676
  # search. When a query includes terms that match the field, the results
4731
5677
  # are given a boost in the response based on these tuning parameters.
@@ -4916,12 +5862,21 @@ module Aws::Kendra
4916
5862
  # document that matches an inclusion pattern also matches an exclusion
4917
5863
  # pattern, the document is not indexed.
4918
5864
  #
4919
- # For more information about glob patterns, see [glob
4920
- # (programming)][1] in *Wikipedia*.
5865
+ # Some [examples][1] are:
4921
5866
  #
5867
+ # * **.txt* will include all text files in a directory (files with
5868
+ # the extension .txt).
4922
5869
  #
5870
+ # * ***/*.txt* will include all text files in a directory and its
5871
+ # subdirectories.
4923
5872
  #
4924
- # [1]: https://en.wikipedia.org/wiki/Glob_(programming)
5873
+ # * **tax** will include all files in a directory that contain
5874
+ # 'tax' in the file name, such as 'tax', 'taxes',
5875
+ # 'income\_tax'.
5876
+ #
5877
+ #
5878
+ #
5879
+ # [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
4925
5880
  # @return [Array<String>]
4926
5881
  #
4927
5882
  # @!attribute [rw] exclusion_patterns
@@ -4929,12 +5884,21 @@ module Aws::Kendra
4929
5884
  # a document that matches an inclusion prefix or inclusion pattern
4930
5885
  # also matches an exclusion pattern, the document is not indexed.
4931
5886
  #
4932
- # For more information about glob patterns, see [glob
4933
- # (programming)][1] in *Wikipedia*.
5887
+ # Some [examples][1] are:
5888
+ #
5889
+ # * **.png , *.jpg* will exclude all PNG and JPEG image files in a
5890
+ # directory (files with the extensions .png and .jpg).
5891
+ #
5892
+ # * **internal** will exclude all files in a directory that contain
5893
+ # 'internal' in the file name, such as 'internal',
5894
+ # 'internal\_only', 'company\_internal'.
5895
+ #
5896
+ # * ***/*internal** will exclude all internal-related files in a
5897
+ # directory and its subdirectories.
4934
5898
  #
4935
5899
  #
4936
5900
  #
4937
- # [1]: https://en.wikipedia.org/wiki/Glob_(programming)
5901
+ # [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
4938
5902
  # @return [Array<String>]
4939
5903
  #
4940
5904
  # @!attribute [rw] documents_metadata_configuration
@@ -5021,7 +5985,7 @@ module Aws::Kendra
5021
5985
  # @!attribute [rw] document_title_field_name
5022
5986
  # The name of the column in the Salesforce FeedItem table that
5023
5987
  # contains the title of the document. This is typically the `Title`
5024
- # collumn.
5988
+ # column.
5025
5989
  # @return [String]
5026
5990
  #
5027
5991
  # @!attribute [rw] field_mappings
@@ -5521,6 +6485,59 @@ module Aws::Kendra
5521
6485
  include Aws::Structure
5522
6486
  end
5523
6487
 
6488
+ # Provides the configuration information of the seed or starting point
6489
+ # URLs to crawl.
6490
+ #
6491
+ # *When selecting websites to index, you must adhere to the [Amazon
6492
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
6493
+ # you must only use the Amazon Kendra web crawler to index your own
6494
+ # webpages, or webpages that you have authorization to index.*
6495
+ #
6496
+ #
6497
+ #
6498
+ # [1]: https://aws.amazon.com/aup/
6499
+ #
6500
+ # @note When making an API call, you may pass SeedUrlConfiguration
6501
+ # data as a hash:
6502
+ #
6503
+ # {
6504
+ # seed_urls: ["SeedUrl"], # required
6505
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
6506
+ # }
6507
+ #
6508
+ # @!attribute [rw] seed_urls
6509
+ # The list of seed or starting point URLs of the websites you want to
6510
+ # crawl.
6511
+ #
6512
+ # The list can include a maximum of 100 seed URLs.
6513
+ # @return [Array<String>]
6514
+ #
6515
+ # @!attribute [rw] web_crawler_mode
6516
+ # You can choose one of the following modes:
6517
+ #
6518
+ # * `HOST_ONLY` – crawl only the website host names. For example, if
6519
+ # the seed URL is "abc.example.com", then only URLs with host name
6520
+ # "abc.example.com" are crawled.
6521
+ #
6522
+ # * `SUBDOMAINS` – crawl the website host names with subdomains. For
6523
+ # example, if the seed URL is "abc.example.com", then
6524
+ # "a.abc.example.com" and "b.abc.example.com" are also crawled.
6525
+ #
6526
+ # * `EVERYTHING` – crawl the website host names with subdomains and
6527
+ # other domains that the webpages link to.
6528
+ #
6529
+ # The default mode is set to `HOST_ONLY`.
6530
+ # @return [String]
6531
+ #
6532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SeedUrlConfiguration AWS API Documentation
6533
+ #
6534
+ class SeedUrlConfiguration < Struct.new(
6535
+ :seed_urls,
6536
+ :web_crawler_mode)
6537
+ SENSITIVE = []
6538
+ include Aws::Structure
6539
+ end
6540
+
5524
6541
  # Provides the identifier of the AWS KMS customer master key (CMK) used
5525
6542
  # to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
5526
6543
  # support asymmetric CMKs.
@@ -5820,7 +6837,7 @@ module Aws::Kendra
5820
6837
  # data as a hash:
5821
6838
  #
5822
6839
  # {
5823
- # share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
6840
+ # share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
5824
6841
  # urls: ["Url"], # required
5825
6842
  # secret_arn: "SecretArn", # required
5826
6843
  # crawl_attachments: false,
@@ -5840,6 +6857,10 @@ module Aws::Kendra
5840
6857
  # ],
5841
6858
  # document_title_field_name: "DataSourceFieldName",
5842
6859
  # disable_local_groups: false,
6860
+ # ssl_certificate_s3_path: {
6861
+ # bucket: "S3BucketName", # required
6862
+ # key: "S3ObjectKey", # required
6863
+ # },
5843
6864
  # }
5844
6865
  #
5845
6866
  # @!attribute [rw] share_point_version
@@ -5925,6 +6946,10 @@ module Aws::Kendra
5925
6946
  # (`True`) or enabled (`False`).
5926
6947
  # @return [Boolean]
5927
6948
  #
6949
+ # @!attribute [rw] ssl_certificate_s3_path
6950
+ # Information required to find a specific file in an Amazon S3 bucket.
6951
+ # @return [Types::S3Path]
6952
+ #
5928
6953
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
5929
6954
  #
5930
6955
  class SharePointConfiguration < Struct.new(
@@ -5938,7 +6963,40 @@ module Aws::Kendra
5938
6963
  :vpc_configuration,
5939
6964
  :field_mappings,
5940
6965
  :document_title_field_name,
5941
- :disable_local_groups)
6966
+ :disable_local_groups,
6967
+ :ssl_certificate_s3_path)
6968
+ SENSITIVE = []
6969
+ include Aws::Structure
6970
+ end
6971
+
6972
+ # Provides the configuration information of the sitemap URLs to crawl.
6973
+ #
6974
+ # *When selecting websites to index, you must adhere to the [Amazon
6975
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
6976
+ # you must only use the Amazon Kendra web crawler to index your own
6977
+ # webpages, or webpages that you have authorization to index.*
6978
+ #
6979
+ #
6980
+ #
6981
+ # [1]: https://aws.amazon.com/aup/
6982
+ #
6983
+ # @note When making an API call, you may pass SiteMapsConfiguration
6984
+ # data as a hash:
6985
+ #
6986
+ # {
6987
+ # site_maps: ["SiteMap"], # required
6988
+ # }
6989
+ #
6990
+ # @!attribute [rw] site_maps
6991
+ # The list of sitemap URLs of the websites you want to crawl.
6992
+ #
6993
+ # The list can include a maximum of three sitemap URLs.
6994
+ # @return [Array<String>]
6995
+ #
6996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SiteMapsConfiguration AWS API Documentation
6997
+ #
6998
+ class SiteMapsConfiguration < Struct.new(
6999
+ :site_maps)
5942
7000
  SENSITIVE = []
5943
7001
  include Aws::Structure
5944
7002
  end
@@ -6074,6 +7132,41 @@ module Aws::Kendra
6074
7132
  include Aws::Structure
6075
7133
  end
6076
7134
 
7135
+ # Provides information about the status of documents submitted for
7136
+ # indexing.
7137
+ #
7138
+ # @!attribute [rw] document_id
7139
+ # The unique identifier of the document.
7140
+ # @return [String]
7141
+ #
7142
+ # @!attribute [rw] document_status
7143
+ # The current status of a document.
7144
+ #
7145
+ # If the document was submitted for deletion, the status is
7146
+ # `NOT_FOUND` after the document is deleted.
7147
+ # @return [String]
7148
+ #
7149
+ # @!attribute [rw] failure_code
7150
+ # Indicates the source of the error.
7151
+ # @return [String]
7152
+ #
7153
+ # @!attribute [rw] failure_reason
7154
+ # Provides detailed information about why the document couldn't be
7155
+ # indexed. Use this information to correct the error before you
7156
+ # resubmit the document for indexing.
7157
+ # @return [String]
7158
+ #
7159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Status AWS API Documentation
7160
+ #
7161
+ class Status < Struct.new(
7162
+ :document_id,
7163
+ :document_status,
7164
+ :failure_code,
7165
+ :failure_reason)
7166
+ SENSITIVE = []
7167
+ include Aws::Structure
7168
+ end
7169
+
6077
7170
  # @note When making an API call, you may pass StopDataSourceSyncJobRequest
6078
7171
  # data as a hash:
6079
7172
  #
@@ -6151,6 +7244,86 @@ module Aws::Kendra
6151
7244
  include Aws::Structure
6152
7245
  end
6153
7246
 
7247
+ # A single query suggestion.
7248
+ #
7249
+ # @!attribute [rw] id
7250
+ # The unique UUID (universally unique identifier) of a single query
7251
+ # suggestion.
7252
+ # @return [String]
7253
+ #
7254
+ # @!attribute [rw] value
7255
+ # The value for the unique UUID (universally unique identifier) of a
7256
+ # single query suggestion.
7257
+ #
7258
+ # The value is the text string of a suggestion.
7259
+ # @return [Types::SuggestionValue]
7260
+ #
7261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Suggestion AWS API Documentation
7262
+ #
7263
+ class Suggestion < Struct.new(
7264
+ :id,
7265
+ :value)
7266
+ SENSITIVE = []
7267
+ include Aws::Structure
7268
+ end
7269
+
7270
+ # The text highlights for a single query suggestion.
7271
+ #
7272
+ # @!attribute [rw] begin_offset
7273
+ # The zero-based location in the response string where the highlight
7274
+ # starts.
7275
+ # @return [Integer]
7276
+ #
7277
+ # @!attribute [rw] end_offset
7278
+ # The zero-based location in the response string where the highlight
7279
+ # ends.
7280
+ # @return [Integer]
7281
+ #
7282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionHighlight AWS API Documentation
7283
+ #
7284
+ class SuggestionHighlight < Struct.new(
7285
+ :begin_offset,
7286
+ :end_offset)
7287
+ SENSITIVE = []
7288
+ include Aws::Structure
7289
+ end
7290
+
7291
+ # Provides text and information about where to highlight the query
7292
+ # suggestion text.
7293
+ #
7294
+ # @!attribute [rw] text
7295
+ # The query suggestion text to display to the user.
7296
+ # @return [String]
7297
+ #
7298
+ # @!attribute [rw] highlights
7299
+ # The beginning and end of the query suggestion text that should be
7300
+ # highlighted.
7301
+ # @return [Array<Types::SuggestionHighlight>]
7302
+ #
7303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionTextWithHighlights AWS API Documentation
7304
+ #
7305
+ class SuggestionTextWithHighlights < Struct.new(
7306
+ :text,
7307
+ :highlights)
7308
+ SENSITIVE = []
7309
+ include Aws::Structure
7310
+ end
7311
+
7312
+ # The `SuggestionTextWithHighlights` structure information.
7313
+ #
7314
+ # @!attribute [rw] text
7315
+ # The `SuggestionTextWithHighlights` structure that contains the query
7316
+ # suggestion text and highlights.
7317
+ # @return [Types::SuggestionTextWithHighlights]
7318
+ #
7319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionValue AWS API Documentation
7320
+ #
7321
+ class SuggestionValue < Struct.new(
7322
+ :text)
7323
+ SENSITIVE = []
7324
+ include Aws::Structure
7325
+ end
7326
+
6154
7327
  # A list of key/value pairs that identify an index, FAQ, or data source.
6155
7328
  # Tag keys and values can consist of Unicode letters, digits, white
6156
7329
  # space, and any of the following symbols: \_ . : / = + - @.
@@ -6381,7 +7554,7 @@ module Aws::Kendra
6381
7554
  # },
6382
7555
  # },
6383
7556
  # share_point_configuration: {
6384
- # share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
7557
+ # share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
6385
7558
  # urls: ["Url"], # required
6386
7559
  # secret_arn: "SecretArn", # required
6387
7560
  # crawl_attachments: false,
@@ -6401,6 +7574,10 @@ module Aws::Kendra
6401
7574
  # ],
6402
7575
  # document_title_field_name: "DataSourceFieldName",
6403
7576
  # disable_local_groups: false,
7577
+ # ssl_certificate_s3_path: {
7578
+ # bucket: "S3BucketName", # required
7579
+ # key: "S3ObjectKey", # required
7580
+ # },
6404
7581
  # },
6405
7582
  # database_configuration: {
6406
7583
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -6629,6 +7806,37 @@ module Aws::Kendra
6629
7806
  # exclude_user_accounts: ["UserAccount"],
6630
7807
  # exclude_shared_drives: ["SharedDriveId"],
6631
7808
  # },
7809
+ # web_crawler_configuration: {
7810
+ # urls: { # required
7811
+ # seed_url_configuration: {
7812
+ # seed_urls: ["SeedUrl"], # required
7813
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
7814
+ # },
7815
+ # site_maps_configuration: {
7816
+ # site_maps: ["SiteMap"], # required
7817
+ # },
7818
+ # },
7819
+ # crawl_depth: 1,
7820
+ # max_links_per_page: 1,
7821
+ # max_content_size_per_page_in_mega_bytes: 1.0,
7822
+ # max_urls_per_minute_crawl_rate: 1,
7823
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
7824
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
7825
+ # proxy_configuration: {
7826
+ # host: "Host", # required
7827
+ # port: 1, # required
7828
+ # credentials: "SecretArn",
7829
+ # },
7830
+ # authentication_configuration: {
7831
+ # basic_authentication: [
7832
+ # {
7833
+ # host: "Host", # required
7834
+ # port: 1, # required
7835
+ # credentials: "SecretArn", # required
7836
+ # },
7837
+ # ],
7838
+ # },
7839
+ # },
6632
7840
  # },
6633
7841
  # description: "Description",
6634
7842
  # schedule: "ScanSchedule",
@@ -6787,6 +7995,158 @@ module Aws::Kendra
6787
7995
  include Aws::Structure
6788
7996
  end
6789
7997
 
7998
+ # @note When making an API call, you may pass UpdateQuerySuggestionsBlockListRequest
7999
+ # data as a hash:
8000
+ #
8001
+ # {
8002
+ # index_id: "IndexId", # required
8003
+ # id: "QuerySuggestionsBlockListId", # required
8004
+ # name: "QuerySuggestionsBlockListName",
8005
+ # description: "Description",
8006
+ # source_s3_path: {
8007
+ # bucket: "S3BucketName", # required
8008
+ # key: "S3ObjectKey", # required
8009
+ # },
8010
+ # role_arn: "RoleArn",
8011
+ # }
8012
+ #
8013
+ # @!attribute [rw] index_id
8014
+ # The identifier of the index for a block list.
8015
+ # @return [String]
8016
+ #
8017
+ # @!attribute [rw] id
8018
+ # The unique identifier of a block list.
8019
+ # @return [String]
8020
+ #
8021
+ # @!attribute [rw] name
8022
+ # The name of a block list.
8023
+ # @return [String]
8024
+ #
8025
+ # @!attribute [rw] description
8026
+ # The description for a block list.
8027
+ # @return [String]
8028
+ #
8029
+ # @!attribute [rw] source_s3_path
8030
+ # The S3 path where your block list text file sits in S3.
8031
+ #
8032
+ # If you update your block list and provide the same path to the block
8033
+ # list text file in S3, then Amazon Kendra reloads the file to refresh
8034
+ # the block list. Amazon Kendra does not automatically refresh your
8035
+ # block list. You need to call the `UpdateQuerySuggestionsBlockList`
8036
+ # API to refresh you block list.
8037
+ #
8038
+ # If you update your block list, then Amazon Kendra asynchronously
8039
+ # refreshes all query suggestions with the latest content in the S3
8040
+ # file. This means changes might not take effect immediately.
8041
+ # @return [Types::S3Path]
8042
+ #
8043
+ # @!attribute [rw] role_arn
8044
+ # The IAM (Identity and Access Management) role used to access the
8045
+ # block list text file in S3.
8046
+ # @return [String]
8047
+ #
8048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockListRequest AWS API Documentation
8049
+ #
8050
+ class UpdateQuerySuggestionsBlockListRequest < Struct.new(
8051
+ :index_id,
8052
+ :id,
8053
+ :name,
8054
+ :description,
8055
+ :source_s3_path,
8056
+ :role_arn)
8057
+ SENSITIVE = []
8058
+ include Aws::Structure
8059
+ end
8060
+
8061
+ # @note When making an API call, you may pass UpdateQuerySuggestionsConfigRequest
8062
+ # data as a hash:
8063
+ #
8064
+ # {
8065
+ # index_id: "IndexId", # required
8066
+ # mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
8067
+ # query_log_look_back_window_in_days: 1,
8068
+ # include_queries_without_user_information: false,
8069
+ # minimum_number_of_querying_users: 1,
8070
+ # minimum_query_count: 1,
8071
+ # }
8072
+ #
8073
+ # @!attribute [rw] index_id
8074
+ # The identifier of the index you want to update query suggestions
8075
+ # settings for.
8076
+ # @return [String]
8077
+ #
8078
+ # @!attribute [rw] mode
8079
+ # Set the mode to `ENABLED` or `LEARN_ONLY`.
8080
+ #
8081
+ # By default, Amazon Kendra enables query suggestions. `LEARN_ONLY`
8082
+ # mode allows you to turn off query suggestions. You can to update
8083
+ # this at any time.
8084
+ #
8085
+ # In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
8086
+ # queries to keep suggestions up to date for when you are ready to
8087
+ # switch to ENABLED mode again.
8088
+ # @return [String]
8089
+ #
8090
+ # @!attribute [rw] query_log_look_back_window_in_days
8091
+ # How recent your queries are in your query log time window.
8092
+ #
8093
+ # The time window is the number of days from current day to past days.
8094
+ #
8095
+ # By default, Amazon Kendra sets this to 180.
8096
+ # @return [Integer]
8097
+ #
8098
+ # @!attribute [rw] include_queries_without_user_information
8099
+ # `TRUE` to include queries without user information (i.e. all
8100
+ # queries, irrespective of the user), otherwise `FALSE` to only
8101
+ # include queries with user information.
8102
+ #
8103
+ # If you pass user information to Amazon Kendra along with the
8104
+ # queries, you can set this flag to `FALSE` and instruct Amazon Kendra
8105
+ # to only consider queries with user information.
8106
+ #
8107
+ # If you set to `FALSE`, Amazon Kendra only considers queries searched
8108
+ # at least `MinimumQueryCount` times across
8109
+ # `MinimumNumberOfQueryingUsers` unique users for suggestions.
8110
+ #
8111
+ # If you set to `TRUE`, Amazon Kendra ignores all user information and
8112
+ # learns from all queries.
8113
+ # @return [Boolean]
8114
+ #
8115
+ # @!attribute [rw] minimum_number_of_querying_users
8116
+ # The minimum number of unique users who must search a query in order
8117
+ # for the query to be eligible to suggest to your users.
8118
+ #
8119
+ # Increasing this number might decrease the number of suggestions.
8120
+ # However, this ensures a query is searched by many users and is truly
8121
+ # popular to suggest to users.
8122
+ #
8123
+ # How you tune this setting depends on your specific needs.
8124
+ # @return [Integer]
8125
+ #
8126
+ # @!attribute [rw] minimum_query_count
8127
+ # The the minimum number of times a query must be searched in order to
8128
+ # be eligible to suggest to your users.
8129
+ #
8130
+ # Decreasing this number increases the number of suggestions. However,
8131
+ # this affects the quality of suggestions as it sets a low bar for a
8132
+ # query to be considered popular to suggest to users.
8133
+ #
8134
+ # How you tune this setting depends on your specific needs.
8135
+ # @return [Integer]
8136
+ #
8137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation
8138
+ #
8139
+ class UpdateQuerySuggestionsConfigRequest < Struct.new(
8140
+ :index_id,
8141
+ :mode,
8142
+ :query_log_look_back_window_in_days,
8143
+ :include_queries_without_user_information,
8144
+ :minimum_number_of_querying_users,
8145
+ :minimum_query_count)
8146
+ SENSITIVE = []
8147
+ include Aws::Structure
8148
+ end
8149
+
6790
8150
  # @note When making an API call, you may pass UpdateThesaurusRequest
6791
8151
  # data as a hash:
6792
8152
  #
@@ -6839,6 +8199,58 @@ module Aws::Kendra
6839
8199
  include Aws::Structure
6840
8200
  end
6841
8201
 
8202
+ # Provides the configuration information of the URLs to crawl.
8203
+ #
8204
+ # *When selecting websites to index, you must adhere to the [Amazon
8205
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
8206
+ # you must only use the Amazon Kendra web crawler to index your own
8207
+ # webpages, or webpages that you have authorization to index.*
8208
+ #
8209
+ #
8210
+ #
8211
+ # [1]: https://aws.amazon.com/aup/
8212
+ #
8213
+ # @note When making an API call, you may pass Urls
8214
+ # data as a hash:
8215
+ #
8216
+ # {
8217
+ # seed_url_configuration: {
8218
+ # seed_urls: ["SeedUrl"], # required
8219
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
8220
+ # },
8221
+ # site_maps_configuration: {
8222
+ # site_maps: ["SiteMap"], # required
8223
+ # },
8224
+ # }
8225
+ #
8226
+ # @!attribute [rw] seed_url_configuration
8227
+ # Provides the configuration of the seed or starting point URLs of the
8228
+ # websites you want to crawl.
8229
+ #
8230
+ # You can choose to crawl only the website host names, or the website
8231
+ # host names with subdomains, or the website host names with
8232
+ # subdomains and other domains that the webpages link to.
8233
+ #
8234
+ # You can list up to 100 seed URLs.
8235
+ # @return [Types::SeedUrlConfiguration]
8236
+ #
8237
+ # @!attribute [rw] site_maps_configuration
8238
+ # Provides the configuration of the sitemap URLs of the websites you
8239
+ # want to crawl.
8240
+ #
8241
+ # Only URLs belonging to the same website host names are crawled. You
8242
+ # can list up to three sitemap URLs.
8243
+ # @return [Types::SiteMapsConfiguration]
8244
+ #
8245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Urls AWS API Documentation
8246
+ #
8247
+ class Urls < Struct.new(
8248
+ :seed_url_configuration,
8249
+ :site_maps_configuration)
8250
+ SENSITIVE = []
8251
+ include Aws::Structure
8252
+ end
8253
+
6842
8254
  # Provides information about the user context for a Amazon Kendra index.
6843
8255
  #
6844
8256
  # @note When making an API call, you may pass UserContext
@@ -6909,5 +8321,167 @@ module Aws::Kendra
6909
8321
  include Aws::Structure
6910
8322
  end
6911
8323
 
8324
+ # Provides the configuration information required for Amazon Kendra web
8325
+ # crawler.
8326
+ #
8327
+ # @note When making an API call, you may pass WebCrawlerConfiguration
8328
+ # data as a hash:
8329
+ #
8330
+ # {
8331
+ # urls: { # required
8332
+ # seed_url_configuration: {
8333
+ # seed_urls: ["SeedUrl"], # required
8334
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
8335
+ # },
8336
+ # site_maps_configuration: {
8337
+ # site_maps: ["SiteMap"], # required
8338
+ # },
8339
+ # },
8340
+ # crawl_depth: 1,
8341
+ # max_links_per_page: 1,
8342
+ # max_content_size_per_page_in_mega_bytes: 1.0,
8343
+ # max_urls_per_minute_crawl_rate: 1,
8344
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
8345
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
8346
+ # proxy_configuration: {
8347
+ # host: "Host", # required
8348
+ # port: 1, # required
8349
+ # credentials: "SecretArn",
8350
+ # },
8351
+ # authentication_configuration: {
8352
+ # basic_authentication: [
8353
+ # {
8354
+ # host: "Host", # required
8355
+ # port: 1, # required
8356
+ # credentials: "SecretArn", # required
8357
+ # },
8358
+ # ],
8359
+ # },
8360
+ # }
8361
+ #
8362
+ # @!attribute [rw] urls
8363
+ # Specifies the seed or starting point URLs of the websites or the
8364
+ # sitemap URLs of the websites you want to crawl.
8365
+ #
8366
+ # You can include website subdomains. You can list up to 100 seed URLs
8367
+ # and up to three sitemap URLs.
8368
+ #
8369
+ # *When selecting websites to index, you must adhere to the [Amazon
8370
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
8371
+ # you must only use the Amazon Kendra web crawler to index your own
8372
+ # webpages, or webpages that you have authorization to index.*
8373
+ #
8374
+ #
8375
+ #
8376
+ # [1]: https://aws.amazon.com/aup/
8377
+ # @return [Types::Urls]
8378
+ #
8379
+ # @!attribute [rw] crawl_depth
8380
+ # Specifies the number of levels in a website that you want to crawl.
8381
+ #
8382
+ # The first level begins from the website seed or starting point URL.
8383
+ # For example, if a website has 3 levels – index level (i.e. seed in
8384
+ # this example), sections level, and subsections level – and you are
8385
+ # only interested in crawling information up to the sections level
8386
+ # (i.e. levels 0-1), you can set your depth to 1.
8387
+ #
8388
+ # The default crawl depth is set to 2.
8389
+ # @return [Integer]
8390
+ #
8391
+ # @!attribute [rw] max_links_per_page
8392
+ # The maximum number of URLs on a webpage to include when crawling a
8393
+ # website. This number is per webpage.
8394
+ #
8395
+ # As a website’s webpages are crawled, any URLs the webpages link to
8396
+ # are also crawled. URLs on a webpage are crawled in order of
8397
+ # appearance.
8398
+ #
8399
+ # The default maximum links per page is 100.
8400
+ # @return [Integer]
8401
+ #
8402
+ # @!attribute [rw] max_content_size_per_page_in_mega_bytes
8403
+ # The maximum size (in MB) of a webpage or attachment to crawl.
8404
+ #
8405
+ # Files larger than this size (in MB) are skipped/not crawled.
8406
+ #
8407
+ # The default maximum size of a webpage or attachment is set to 50 MB.
8408
+ # @return [Float]
8409
+ #
8410
+ # @!attribute [rw] max_urls_per_minute_crawl_rate
8411
+ # The maximum number of URLs crawled per website host per minute.
8412
+ #
8413
+ # A minimum of one URL is required.
8414
+ #
8415
+ # The default maximum number of URLs crawled per website host per
8416
+ # minute is 300.
8417
+ # @return [Integer]
8418
+ #
8419
+ # @!attribute [rw] url_inclusion_patterns
8420
+ # The regular expression pattern to include certain URLs to crawl.
8421
+ #
8422
+ # If there is a regular expression pattern to exclude certain URLs
8423
+ # that conflicts with the include pattern, the exclude pattern takes
8424
+ # precedence.
8425
+ # @return [Array<String>]
8426
+ #
8427
+ # @!attribute [rw] url_exclusion_patterns
8428
+ # The regular expression pattern to exclude certain URLs to crawl.
8429
+ #
8430
+ # If there is a regular expression pattern to include certain URLs
8431
+ # that conflicts with the exclude pattern, the exclude pattern takes
8432
+ # precedence.
8433
+ # @return [Array<String>]
8434
+ #
8435
+ # @!attribute [rw] proxy_configuration
8436
+ # Provides configuration information required to connect to your
8437
+ # internal websites via a web proxy.
8438
+ #
8439
+ # You must provide the website host name and port number. For example,
8440
+ # the host name of https://a.example.com/page1.html is
8441
+ # "a.example.com" and the port is 443, the standard port for HTTPS.
8442
+ #
8443
+ # Web proxy credentials are optional and you can use them to connect
8444
+ # to a web proxy server that requires basic authentication. To store
8445
+ # web proxy credentials, you use a secret in [AWS Secrets Manager][1].
8446
+ #
8447
+ #
8448
+ #
8449
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
8450
+ # @return [Types::ProxyConfiguration]
8451
+ #
8452
+ # @!attribute [rw] authentication_configuration
8453
+ # Provides configuration information required to connect to websites
8454
+ # using authentication.
8455
+ #
8456
+ # You can connect to websites using basic authentication of user name
8457
+ # and password.
8458
+ #
8459
+ # You must provide the website host name and port number. For example,
8460
+ # the host name of https://a.example.com/page1.html is
8461
+ # "a.example.com" and the port is 443, the standard port for HTTPS.
8462
+ # You use a secret in [AWS Secrets Manager][1] to store your
8463
+ # authentication credentials.
8464
+ #
8465
+ #
8466
+ #
8467
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
8468
+ # @return [Types::AuthenticationConfiguration]
8469
+ #
8470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/WebCrawlerConfiguration AWS API Documentation
8471
+ #
8472
+ class WebCrawlerConfiguration < Struct.new(
8473
+ :urls,
8474
+ :crawl_depth,
8475
+ :max_links_per_page,
8476
+ :max_content_size_per_page_in_mega_bytes,
8477
+ :max_urls_per_minute_crawl_rate,
8478
+ :url_inclusion_patterns,
8479
+ :url_exclusion_patterns,
8480
+ :proxy_configuration,
8481
+ :authentication_configuration)
8482
+ SENSITIVE = []
8483
+ include Aws::Structure
8484
+ end
8485
+
6912
8486
  end
6913
8487
  end