aws-sdk-kendra 1.22.0 → 1.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -61,7 +61,7 @@ module Aws::Kendra
61
61
  # A list of groups, separated by semi-colons, that filters a query
62
62
  # response based on user context. The document is only returned to
63
63
  # users that are in one of the groups specified in the `UserContext`
64
- # field of the Query operation.
64
+ # field of the `Query` operation.
65
65
  # @return [String]
66
66
  #
67
67
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
@@ -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
  #
@@ -541,7 +622,7 @@ module Aws::Kendra
541
622
  end
542
623
 
543
624
  # Provides information about documents that could not be removed from an
544
- # index by the BatchDeleteDocument operation.
625
+ # index by the `BatchDeleteDocument` operation.
545
626
  #
546
627
  # @!attribute [rw] id
547
628
  # The identifier of the document that couldn't be removed from the
@@ -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
  #
@@ -608,7 +786,7 @@ module Aws::Kendra
608
786
  #
609
787
  # @!attribute [rw] index_id
610
788
  # The identifier of the index to add the documents to. You need to
611
- # create the index first using the CreateIndex operation.
789
+ # create the index first using the `CreateIndex` operation.
612
790
  # @return [String]
613
791
  #
614
792
  # @!attribute [rw] role_arn
@@ -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,28 @@ 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 for an index provides 150 GB of storage space or 500,000
900
+ # documents, whichever 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.5 queries per
908
+ # second or approximately 40,000 queries per day.
909
+ #
910
+ # `GetQuerySuggestions` capacity is 5 times the provisioned query
911
+ # capacity for an index. For example, the base capacity for an index
912
+ # is 0.5 queries per second, so GetQuerySuggestions capacity is 2.5
913
+ # calls per second. If adding another 0.5 queries per second to total
914
+ # 1 queries per second for an index, the `GetQuerySuggestions`
915
+ # capacity is 5 calls per second.
916
+ #
917
+ #
918
+ #
919
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html
720
920
  # @return [Integer]
721
921
  #
722
922
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CapacityUnitsConfiguration AWS API Documentation
@@ -728,8 +928,28 @@ module Aws::Kendra
728
928
  include Aws::Structure
729
929
  end
730
930
 
931
+ # @note When making an API call, you may pass ClearQuerySuggestionsRequest
932
+ # data as a hash:
933
+ #
934
+ # {
935
+ # index_id: "IndexId", # required
936
+ # }
937
+ #
938
+ # @!attribute [rw] index_id
939
+ # The identifier of the index you want to clear query suggestions
940
+ # from.
941
+ # @return [String]
942
+ #
943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestionsRequest AWS API Documentation
944
+ #
945
+ class ClearQuerySuggestionsRequest < Struct.new(
946
+ :index_id)
947
+ SENSITIVE = []
948
+ include Aws::Structure
949
+ end
950
+
731
951
  # Gathers information about when a particular result was clicked by a
732
- # user. Your application uses the SubmitFeedback operation to provide
952
+ # user. Your application uses the `SubmitFeedback` operation to provide
733
953
  # click information.
734
954
  #
735
955
  # @note When making an API call, you may pass ClickFeedback
@@ -792,7 +1012,7 @@ module Aws::Kendra
792
1012
  # @!attribute [rw] field_mappings
793
1013
  # An array of objects that map database column names to the
794
1014
  # corresponding fields in an index. You must first create the fields
795
- # in the index using the UpdateIndex operation.
1015
+ # in the index using the `UpdateIndex` operation.
796
1016
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
797
1017
  #
798
1018
  # @!attribute [rw] change_detecting_columns
@@ -868,7 +1088,8 @@ module Aws::Kendra
868
1088
  # Defines the mapping between a field in the Confluence data source to a
869
1089
  # Amazon Kendra index field.
870
1090
  #
871
- # You must first create the index field using the operation.
1091
+ # You must first create the index field using the `UpdateIndex`
1092
+ # operation.
872
1093
  #
873
1094
  # @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
874
1095
  # data as a hash:
@@ -882,7 +1103,8 @@ module Aws::Kendra
882
1103
  # @!attribute [rw] data_source_field_name
883
1104
  # The name of the field in the data source.
884
1105
  #
885
- # You must first create the index field using the operation.
1106
+ # You must first create the index field using the `UpdateIndex`
1107
+ # operation.
886
1108
  # @return [String]
887
1109
  #
888
1110
  # @!attribute [rw] date_field_format
@@ -909,7 +1131,8 @@ module Aws::Kendra
909
1131
 
910
1132
  # Specifies the blog settings for the Confluence data source. Blogs are
911
1133
  # always indexed unless filtered from the index by the
912
- # `ExclusionPatterns` or `InclusionPatterns` fields in the data type.
1134
+ # `ExclusionPatterns` or `InclusionPatterns` fields in the
1135
+ # `ConfluenceConfiguration` type.
913
1136
  #
914
1137
  # @note When making an API call, you may pass ConfluenceBlogConfiguration
915
1138
  # data as a hash:
@@ -945,7 +1168,8 @@ module Aws::Kendra
945
1168
  # Defines the mapping between a blog field in the Confluence data source
946
1169
  # to a Amazon Kendra index field.
947
1170
  #
948
- # You must first create the index field using the operation.
1171
+ # You must first create the index field using the `UpdateIndex`
1172
+ # operation.
949
1173
  #
950
1174
  # @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
951
1175
  # data as a hash:
@@ -1158,7 +1382,8 @@ module Aws::Kendra
1158
1382
  # Defines the mapping between a field in the Confluence data source to a
1159
1383
  # Amazon Kendra index field.
1160
1384
  #
1161
- # You must first create the index field using the operation.
1385
+ # You must first create the index field using the `UpdateIndex`
1386
+ # operation.
1162
1387
  #
1163
1388
  # @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
1164
1389
  # data as a hash:
@@ -1271,7 +1496,8 @@ module Aws::Kendra
1271
1496
  # Defines the mapping between a field in the Confluence data source to a
1272
1497
  # Amazon Kendra index field.
1273
1498
  #
1274
- # You must first create the index field using the operation.
1499
+ # You must first create the index field using the `UpdateIndex`
1500
+ # operation.
1275
1501
  #
1276
1502
  # @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
1277
1503
  # data as a hash:
@@ -1369,7 +1595,7 @@ module Aws::Kendra
1369
1595
  # {
1370
1596
  # name: "DataSourceName", # required
1371
1597
  # index_id: "IndexId", # required
1372
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
1598
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER
1373
1599
  # configuration: {
1374
1600
  # s3_configuration: {
1375
1601
  # bucket_name: "S3BucketName", # required
@@ -1547,6 +1773,7 @@ module Aws::Kendra
1547
1773
  # index_field_name: "IndexFieldName", # required
1548
1774
  # },
1549
1775
  # ],
1776
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
1550
1777
  # },
1551
1778
  # service_catalog_configuration: {
1552
1779
  # crawl_attachments: false,
@@ -1562,6 +1789,7 @@ module Aws::Kendra
1562
1789
  # },
1563
1790
  # ],
1564
1791
  # },
1792
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
1565
1793
  # },
1566
1794
  # confluence_configuration: {
1567
1795
  # server_url: "Url", # required
@@ -1630,6 +1858,37 @@ module Aws::Kendra
1630
1858
  # exclude_user_accounts: ["UserAccount"],
1631
1859
  # exclude_shared_drives: ["SharedDriveId"],
1632
1860
  # },
1861
+ # web_crawler_configuration: {
1862
+ # urls: { # required
1863
+ # seed_url_configuration: {
1864
+ # seed_urls: ["SeedUrl"], # required
1865
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
1866
+ # },
1867
+ # site_maps_configuration: {
1868
+ # site_maps: ["SiteMap"], # required
1869
+ # },
1870
+ # },
1871
+ # crawl_depth: 1,
1872
+ # max_links_per_page: 1,
1873
+ # max_content_size_per_page_in_mega_bytes: 1.0,
1874
+ # max_urls_per_minute_crawl_rate: 1,
1875
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1876
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1877
+ # proxy_configuration: {
1878
+ # host: "Host", # required
1879
+ # port: 1, # required
1880
+ # credentials: "SecretArn",
1881
+ # },
1882
+ # authentication_configuration: {
1883
+ # basic_authentication: [
1884
+ # {
1885
+ # host: "Host", # required
1886
+ # port: 1, # required
1887
+ # credentials: "SecretArn", # required
1888
+ # },
1889
+ # ],
1890
+ # },
1891
+ # },
1633
1892
  # },
1634
1893
  # description: "Description",
1635
1894
  # schedule: "ScanSchedule",
@@ -1983,6 +2242,110 @@ module Aws::Kendra
1983
2242
  include Aws::Structure
1984
2243
  end
1985
2244
 
2245
+ # @note When making an API call, you may pass CreateQuerySuggestionsBlockListRequest
2246
+ # data as a hash:
2247
+ #
2248
+ # {
2249
+ # index_id: "IndexId", # required
2250
+ # name: "QuerySuggestionsBlockListName", # required
2251
+ # description: "Description",
2252
+ # source_s3_path: { # required
2253
+ # bucket: "S3BucketName", # required
2254
+ # key: "S3ObjectKey", # required
2255
+ # },
2256
+ # client_token: "ClientTokenName",
2257
+ # role_arn: "RoleArn", # required
2258
+ # tags: [
2259
+ # {
2260
+ # key: "TagKey", # required
2261
+ # value: "TagValue", # required
2262
+ # },
2263
+ # ],
2264
+ # }
2265
+ #
2266
+ # @!attribute [rw] index_id
2267
+ # The identifier of the index you want to create a query suggestions
2268
+ # block list for.
2269
+ # @return [String]
2270
+ #
2271
+ # @!attribute [rw] name
2272
+ # A user friendly name for the block list.
2273
+ #
2274
+ # For example, the block list named 'offensive-words' includes all
2275
+ # offensive words that could appear in user queries and need to be
2276
+ # blocked from suggestions.
2277
+ # @return [String]
2278
+ #
2279
+ # @!attribute [rw] description
2280
+ # A user-friendly description for the block list.
2281
+ #
2282
+ # For example, the description "List of all offensive words that can
2283
+ # appear in user queries and need to be blocked from suggestions."
2284
+ # @return [String]
2285
+ #
2286
+ # @!attribute [rw] source_s3_path
2287
+ # The S3 path to your block list text file in your S3 bucket.
2288
+ #
2289
+ # Each block word or phrase should be on a separate line in a text
2290
+ # file.
2291
+ #
2292
+ # For information on the current quota limits for block lists, see
2293
+ # [Quotas for Amazon Kendra][1].
2294
+ #
2295
+ #
2296
+ #
2297
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2298
+ # @return [Types::S3Path]
2299
+ #
2300
+ # @!attribute [rw] client_token
2301
+ # A token that you provide to identify the request to create a query
2302
+ # suggestions block list.
2303
+ #
2304
+ # **A suitable default value is auto-generated.** You should normally
2305
+ # not need to pass this option.
2306
+ # @return [String]
2307
+ #
2308
+ # @!attribute [rw] role_arn
2309
+ # The IAM (Identity and Access Management) role used by Amazon Kendra
2310
+ # to access the block list text file in your S3 bucket.
2311
+ #
2312
+ # You need permissions to the role ARN (Amazon Resource Name). The
2313
+ # role needs S3 read permissions to your file in S3 and needs to give
2314
+ # STS (Security Token Service) assume role permissions to Amazon
2315
+ # Kendra.
2316
+ # @return [String]
2317
+ #
2318
+ # @!attribute [rw] tags
2319
+ # A tag that you can assign to a block list that categorizes the block
2320
+ # list.
2321
+ # @return [Array<Types::Tag>]
2322
+ #
2323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation
2324
+ #
2325
+ class CreateQuerySuggestionsBlockListRequest < Struct.new(
2326
+ :index_id,
2327
+ :name,
2328
+ :description,
2329
+ :source_s3_path,
2330
+ :client_token,
2331
+ :role_arn,
2332
+ :tags)
2333
+ SENSITIVE = []
2334
+ include Aws::Structure
2335
+ end
2336
+
2337
+ # @!attribute [rw] id
2338
+ # The unique identifier of the created block list.
2339
+ # @return [String]
2340
+ #
2341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListResponse AWS API Documentation
2342
+ #
2343
+ class CreateQuerySuggestionsBlockListResponse < Struct.new(
2344
+ :id)
2345
+ SENSITIVE = []
2346
+ include Aws::Structure
2347
+ end
2348
+
1986
2349
  # @note When making an API call, you may pass CreateThesaurusRequest
1987
2350
  # data as a hash:
1988
2351
  #
@@ -2249,6 +2612,7 @@ module Aws::Kendra
2249
2612
  # index_field_name: "IndexFieldName", # required
2250
2613
  # },
2251
2614
  # ],
2615
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
2252
2616
  # },
2253
2617
  # service_catalog_configuration: {
2254
2618
  # crawl_attachments: false,
@@ -2264,6 +2628,7 @@ module Aws::Kendra
2264
2628
  # },
2265
2629
  # ],
2266
2630
  # },
2631
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
2267
2632
  # },
2268
2633
  # confluence_configuration: {
2269
2634
  # server_url: "Url", # required
@@ -2332,6 +2697,37 @@ module Aws::Kendra
2332
2697
  # exclude_user_accounts: ["UserAccount"],
2333
2698
  # exclude_shared_drives: ["SharedDriveId"],
2334
2699
  # },
2700
+ # web_crawler_configuration: {
2701
+ # urls: { # required
2702
+ # seed_url_configuration: {
2703
+ # seed_urls: ["SeedUrl"], # required
2704
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
2705
+ # },
2706
+ # site_maps_configuration: {
2707
+ # site_maps: ["SiteMap"], # required
2708
+ # },
2709
+ # },
2710
+ # crawl_depth: 1,
2711
+ # max_links_per_page: 1,
2712
+ # max_content_size_per_page_in_mega_bytes: 1.0,
2713
+ # max_urls_per_minute_crawl_rate: 1,
2714
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2715
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2716
+ # proxy_configuration: {
2717
+ # host: "Host", # required
2718
+ # port: 1, # required
2719
+ # credentials: "SecretArn",
2720
+ # },
2721
+ # authentication_configuration: {
2722
+ # basic_authentication: [
2723
+ # {
2724
+ # host: "Host", # required
2725
+ # port: 1, # required
2726
+ # credentials: "SecretArn", # required
2727
+ # },
2728
+ # ],
2729
+ # },
2730
+ # },
2335
2731
  # }
2336
2732
  #
2337
2733
  # @!attribute [rw] s3_configuration
@@ -2374,6 +2770,11 @@ module Aws::Kendra
2374
2770
  # Drive.
2375
2771
  # @return [Types::GoogleDriveConfiguration]
2376
2772
  #
2773
+ # @!attribute [rw] web_crawler_configuration
2774
+ # Provides the configuration information required for Amazon Kendra
2775
+ # web crawler.
2776
+ # @return [Types::WebCrawlerConfiguration]
2777
+ #
2377
2778
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
2378
2779
  #
2379
2780
  class DataSourceConfiguration < Struct.new(
@@ -2384,13 +2785,14 @@ module Aws::Kendra
2384
2785
  :one_drive_configuration,
2385
2786
  :service_now_configuration,
2386
2787
  :confluence_configuration,
2387
- :google_drive_configuration)
2788
+ :google_drive_configuration,
2789
+ :web_crawler_configuration)
2388
2790
  SENSITIVE = []
2389
2791
  include Aws::Structure
2390
2792
  end
2391
2793
 
2392
2794
  # Summary information for a Amazon Kendra data source. Returned in a
2393
- # call to .
2795
+ # call to the `DescribeDataSource` operation.
2394
2796
  #
2395
2797
  # @!attribute [rw] name
2396
2798
  # The name of the data source.
@@ -2413,7 +2815,7 @@ module Aws::Kendra
2413
2815
  # @return [Time]
2414
2816
  #
2415
2817
  # @!attribute [rw] status
2416
- # The status of the data source. When the status is `ATIVE` the data
2818
+ # The status of the data source. When the status is `ACTIVE` the data
2417
2819
  # source is ready to use.
2418
2820
  # @return [String]
2419
2821
  #
@@ -2496,7 +2898,7 @@ module Aws::Kendra
2496
2898
  #
2497
2899
  # {
2498
2900
  # data_source_id: "DataSourceId", # required
2499
- # data_source_sync_job_id: "DataSourceSyncJobId", # required
2901
+ # data_source_sync_job_id: "DataSourceSyncJobId",
2500
2902
  # }
2501
2903
  #
2502
2904
  # @!attribute [rw] data_source_id
@@ -2505,6 +2907,15 @@ module Aws::Kendra
2505
2907
  #
2506
2908
  # @!attribute [rw] data_source_sync_job_id
2507
2909
  # The ID of the sync job that is running on the data source.
2910
+ #
2911
+ # If the ID of a sync job is not provided and there is a sync job
2912
+ # running, then the ID of this sync job is used and metrics are
2913
+ # generated for this sync job.
2914
+ #
2915
+ # If the ID of a sync job is not provided and there is no sync job
2916
+ # running, then no metrics are generated and documents are
2917
+ # indexed/deleted at the index level without sync job metrics
2918
+ # included.
2508
2919
  # @return [String]
2509
2920
  #
2510
2921
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
@@ -2558,7 +2969,7 @@ module Aws::Kendra
2558
2969
  end
2559
2970
 
2560
2971
  # Maps a column or attribute in the data source to an index field. You
2561
- # must first create the fields in the index using the UpdateIndex
2972
+ # must first create the fields in the index using the `UpdateIndex`
2562
2973
  # operation.
2563
2974
  #
2564
2975
  # @note When making an API call, you may pass DataSourceToIndexFieldMapping
@@ -2771,6 +3182,31 @@ module Aws::Kendra
2771
3182
  include Aws::Structure
2772
3183
  end
2773
3184
 
3185
+ # @note When making an API call, you may pass DeleteQuerySuggestionsBlockListRequest
3186
+ # data as a hash:
3187
+ #
3188
+ # {
3189
+ # index_id: "IndexId", # required
3190
+ # id: "QuerySuggestionsBlockListId", # required
3191
+ # }
3192
+ #
3193
+ # @!attribute [rw] index_id
3194
+ # The identifier of the you want to delete a block list from.
3195
+ # @return [String]
3196
+ #
3197
+ # @!attribute [rw] id
3198
+ # The unique identifier of the block list that needs to be deleted.
3199
+ # @return [String]
3200
+ #
3201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
3202
+ #
3203
+ class DeleteQuerySuggestionsBlockListRequest < Struct.new(
3204
+ :index_id,
3205
+ :id)
3206
+ SENSITIVE = []
3207
+ include Aws::Structure
3208
+ end
3209
+
2774
3210
  # @note When making an API call, you may pass DeleteThesaurusRequest
2775
3211
  # data as a hash:
2776
3212
  #
@@ -3062,7 +3498,7 @@ module Aws::Kendra
3062
3498
  # @return [String]
3063
3499
  #
3064
3500
  # @!attribute [rw] capacity_units
3065
- # For enterprise edtion indexes, you can choose to use additional
3501
+ # For Enterprise edition indexes, you can choose to use additional
3066
3502
  # capacity to meet the needs of your application. This contains the
3067
3503
  # capacity units used for the index. A 0 for the query capacity or the
3068
3504
  # storage capacity indicates that the index is using the default
@@ -3099,37 +3535,249 @@ module Aws::Kendra
3099
3535
  include Aws::Structure
3100
3536
  end
3101
3537
 
3102
- # @note When making an API call, you may pass DescribeThesaurusRequest
3538
+ # @note When making an API call, you may pass DescribeQuerySuggestionsBlockListRequest
3103
3539
  # data as a hash:
3104
3540
  #
3105
3541
  # {
3106
- # id: "ThesaurusId", # required
3107
3542
  # index_id: "IndexId", # required
3543
+ # id: "QuerySuggestionsBlockListId", # required
3108
3544
  # }
3109
3545
  #
3110
- # @!attribute [rw] id
3111
- # The identifier of the thesaurus to describe.
3546
+ # @!attribute [rw] index_id
3547
+ # The identifier of the index for the block list.
3112
3548
  # @return [String]
3113
3549
  #
3114
- # @!attribute [rw] index_id
3115
- # The identifier of the index associated with the thesaurus to
3116
- # describe.
3550
+ # @!attribute [rw] id
3551
+ # The unique identifier of the block list.
3117
3552
  # @return [String]
3118
3553
  #
3119
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
3554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
3120
3555
  #
3121
- class DescribeThesaurusRequest < Struct.new(
3122
- :id,
3123
- :index_id)
3556
+ class DescribeQuerySuggestionsBlockListRequest < Struct.new(
3557
+ :index_id,
3558
+ :id)
3124
3559
  SENSITIVE = []
3125
3560
  include Aws::Structure
3126
3561
  end
3127
3562
 
3563
+ # @!attribute [rw] index_id
3564
+ # Shows the identifier of the index for the block list.
3565
+ # @return [String]
3566
+ #
3128
3567
  # @!attribute [rw] id
3129
- # The identifier of the thesaurus.
3568
+ # Shows the unique identifier of the block list.
3130
3569
  # @return [String]
3131
3570
  #
3132
- # @!attribute [rw] index_id
3571
+ # @!attribute [rw] name
3572
+ # Shows the name of the block list.
3573
+ # @return [String]
3574
+ #
3575
+ # @!attribute [rw] description
3576
+ # Shows the description for the block list.
3577
+ # @return [String]
3578
+ #
3579
+ # @!attribute [rw] status
3580
+ # Shows whether the current status of the block list is `ACTIVE` or
3581
+ # `INACTIVE`.
3582
+ # @return [String]
3583
+ #
3584
+ # @!attribute [rw] error_message
3585
+ # Shows the error message with details when there are issues in
3586
+ # processing the block list.
3587
+ # @return [String]
3588
+ #
3589
+ # @!attribute [rw] created_at
3590
+ # Shows the date-time a block list for query suggestions was last
3591
+ # created.
3592
+ # @return [Time]
3593
+ #
3594
+ # @!attribute [rw] updated_at
3595
+ # Shows the date-time a block list for query suggestions was last
3596
+ # updated.
3597
+ # @return [Time]
3598
+ #
3599
+ # @!attribute [rw] source_s3_path
3600
+ # Shows the current S3 path to your block list text file in your S3
3601
+ # bucket.
3602
+ #
3603
+ # Each block word or phrase should be on a separate line in a text
3604
+ # file.
3605
+ #
3606
+ # For information on the current quota limits for block lists, see
3607
+ # [Quotas for Amazon Kendra][1].
3608
+ #
3609
+ #
3610
+ #
3611
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
3612
+ # @return [Types::S3Path]
3613
+ #
3614
+ # @!attribute [rw] item_count
3615
+ # Shows the current number of valid, non-empty words or phrases in the
3616
+ # block list text file.
3617
+ # @return [Integer]
3618
+ #
3619
+ # @!attribute [rw] file_size_bytes
3620
+ # Shows the current size of the block list text file in S3.
3621
+ # @return [Integer]
3622
+ #
3623
+ # @!attribute [rw] role_arn
3624
+ # Shows the current IAM (Identity and Access Management) role used by
3625
+ # Amazon Kendra to access the block list text file in S3.
3626
+ #
3627
+ # The role needs S3 read permissions to your file in S3 and needs to
3628
+ # give STS (Security Token Service) assume role permissions to Amazon
3629
+ # Kendra.
3630
+ # @return [String]
3631
+ #
3632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListResponse AWS API Documentation
3633
+ #
3634
+ class DescribeQuerySuggestionsBlockListResponse < Struct.new(
3635
+ :index_id,
3636
+ :id,
3637
+ :name,
3638
+ :description,
3639
+ :status,
3640
+ :error_message,
3641
+ :created_at,
3642
+ :updated_at,
3643
+ :source_s3_path,
3644
+ :item_count,
3645
+ :file_size_bytes,
3646
+ :role_arn)
3647
+ SENSITIVE = []
3648
+ include Aws::Structure
3649
+ end
3650
+
3651
+ # @note When making an API call, you may pass DescribeQuerySuggestionsConfigRequest
3652
+ # data as a hash:
3653
+ #
3654
+ # {
3655
+ # index_id: "IndexId", # required
3656
+ # }
3657
+ #
3658
+ # @!attribute [rw] index_id
3659
+ # The identifier of the index you want to describe query suggestions
3660
+ # settings for.
3661
+ # @return [String]
3662
+ #
3663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
3664
+ #
3665
+ class DescribeQuerySuggestionsConfigRequest < Struct.new(
3666
+ :index_id)
3667
+ SENSITIVE = []
3668
+ include Aws::Structure
3669
+ end
3670
+
3671
+ # @!attribute [rw] mode
3672
+ # Shows whether query suggestions are currently in `ENABLED` mode or
3673
+ # `LEARN_ONLY` mode.
3674
+ #
3675
+ # By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
3676
+ # turns off query suggestions for your users. You can change the mode
3677
+ # using the [UpdateQuerySuggestionsConfig][1] operation.
3678
+ #
3679
+ #
3680
+ #
3681
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
3682
+ # @return [String]
3683
+ #
3684
+ # @!attribute [rw] status
3685
+ # Shows whether the status of query suggestions settings is currently
3686
+ # Active or Updating.
3687
+ #
3688
+ # Active means the current settings apply and Updating means your
3689
+ # changed settings are in the process of applying.
3690
+ # @return [String]
3691
+ #
3692
+ # @!attribute [rw] query_log_look_back_window_in_days
3693
+ # Shows how recent your queries are in your query log time window (in
3694
+ # days).
3695
+ # @return [Integer]
3696
+ #
3697
+ # @!attribute [rw] include_queries_without_user_information
3698
+ # Shows whether Amazon Kendra uses all queries or only uses queries
3699
+ # that include user information to generate query suggestions.
3700
+ # @return [Boolean]
3701
+ #
3702
+ # @!attribute [rw] minimum_number_of_querying_users
3703
+ # Shows the minimum number of unique users who must search a query in
3704
+ # order for the query to be eligible to suggest to your users.
3705
+ # @return [Integer]
3706
+ #
3707
+ # @!attribute [rw] minimum_query_count
3708
+ # Shows the minimum number of times a query must be searched in order
3709
+ # for the query to be eligible to suggest to your users.
3710
+ # @return [Integer]
3711
+ #
3712
+ # @!attribute [rw] last_suggestions_build_time
3713
+ # Shows the date-time query suggestions for an index was last updated.
3714
+ # @return [Time]
3715
+ #
3716
+ # @!attribute [rw] last_clear_time
3717
+ # Shows the date-time query suggestions for an index was last cleared.
3718
+ #
3719
+ # After you clear suggestions, Amazon Kendra learns new suggestions
3720
+ # based on new queries added to the query log from the time you
3721
+ # cleared suggestions. Amazon Kendra only considers re-occurences of a
3722
+ # query from the time you cleared suggestions.
3723
+ # @return [Time]
3724
+ #
3725
+ # @!attribute [rw] total_suggestions_count
3726
+ # Shows the current total count of query suggestions for an index.
3727
+ #
3728
+ # This count can change when you update your query suggestions
3729
+ # settings, if you filter out certain queries from suggestions using a
3730
+ # block list, and as the query log accumulates more queries for Amazon
3731
+ # Kendra to learn from.
3732
+ # @return [Integer]
3733
+ #
3734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigResponse AWS API Documentation
3735
+ #
3736
+ class DescribeQuerySuggestionsConfigResponse < Struct.new(
3737
+ :mode,
3738
+ :status,
3739
+ :query_log_look_back_window_in_days,
3740
+ :include_queries_without_user_information,
3741
+ :minimum_number_of_querying_users,
3742
+ :minimum_query_count,
3743
+ :last_suggestions_build_time,
3744
+ :last_clear_time,
3745
+ :total_suggestions_count)
3746
+ SENSITIVE = []
3747
+ include Aws::Structure
3748
+ end
3749
+
3750
+ # @note When making an API call, you may pass DescribeThesaurusRequest
3751
+ # data as a hash:
3752
+ #
3753
+ # {
3754
+ # id: "ThesaurusId", # required
3755
+ # index_id: "IndexId", # required
3756
+ # }
3757
+ #
3758
+ # @!attribute [rw] id
3759
+ # The identifier of the thesaurus to describe.
3760
+ # @return [String]
3761
+ #
3762
+ # @!attribute [rw] index_id
3763
+ # The identifier of the index associated with the thesaurus to
3764
+ # describe.
3765
+ # @return [String]
3766
+ #
3767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
3768
+ #
3769
+ class DescribeThesaurusRequest < Struct.new(
3770
+ :id,
3771
+ :index_id)
3772
+ SENSITIVE = []
3773
+ include Aws::Structure
3774
+ end
3775
+
3776
+ # @!attribute [rw] id
3777
+ # The identifier of the thesaurus.
3778
+ # @return [String]
3779
+ #
3780
+ # @!attribute [rw] index_id
3133
3781
  # The identifier of the index associated with the thesaurus to
3134
3782
  # describe.
3135
3783
  # @return [String]
@@ -3352,6 +4000,11 @@ module Aws::Kendra
3352
4000
  #
3353
4001
  # @!attribute [rw] date_value
3354
4002
  # A date expressed as an ISO 8601 string.
4003
+ #
4004
+ # It is important for the time zone to be included in the ISO 8601
4005
+ # date-time format. For example, 20120325T123010+01:00 is the ISO 8601
4006
+ # date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in
4007
+ # Central European Time.
3355
4008
  # @return [Time]
3356
4009
  #
3357
4010
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
@@ -3386,6 +4039,61 @@ module Aws::Kendra
3386
4039
  include Aws::Structure
3387
4040
  end
3388
4041
 
4042
+ # Identifies a document for which to retrieve status information
4043
+ #
4044
+ # @note When making an API call, you may pass DocumentInfo
4045
+ # data as a hash:
4046
+ #
4047
+ # {
4048
+ # document_id: "DocumentId", # required
4049
+ # attributes: [
4050
+ # {
4051
+ # key: "DocumentAttributeKey", # required
4052
+ # value: { # required
4053
+ # string_value: "DocumentAttributeStringValue",
4054
+ # string_list_value: ["String"],
4055
+ # long_value: 1,
4056
+ # date_value: Time.now,
4057
+ # },
4058
+ # },
4059
+ # ],
4060
+ # }
4061
+ #
4062
+ # @!attribute [rw] document_id
4063
+ # The unique identifier of the document.
4064
+ # @return [String]
4065
+ #
4066
+ # @!attribute [rw] attributes
4067
+ # Attributes that identify a specific version of a document to check.
4068
+ #
4069
+ # The only valid attributes are:
4070
+ #
4071
+ # * version
4072
+ #
4073
+ # * datasourceId
4074
+ #
4075
+ # * jobExecutionId
4076
+ #
4077
+ # The attributes follow these rules:
4078
+ #
4079
+ # * `dataSourceId` and `jobExecutionId` must be used together.
4080
+ #
4081
+ # * `version` is ignored if `dataSourceId` and `jobExecutionId` are
4082
+ # not provided.
4083
+ #
4084
+ # * If `dataSourceId` and `jobExecutionId` are provided, but `version`
4085
+ # is not, the version defaults to "0".
4086
+ # @return [Array<Types::DocumentAttribute>]
4087
+ #
4088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentInfo AWS API Documentation
4089
+ #
4090
+ class DocumentInfo < Struct.new(
4091
+ :document_id,
4092
+ :attributes)
4093
+ SENSITIVE = []
4094
+ include Aws::Structure
4095
+ end
4096
+
3389
4097
  # Specifies the properties of a custom index field.
3390
4098
  #
3391
4099
  # @note When making an API call, you may pass DocumentMetadataConfiguration
@@ -3439,6 +4147,45 @@ module Aws::Kendra
3439
4147
  include Aws::Structure
3440
4148
  end
3441
4149
 
4150
+ # Overrides the document relevance properties of a custom index field.
4151
+ #
4152
+ # @note When making an API call, you may pass DocumentRelevanceConfiguration
4153
+ # data as a hash:
4154
+ #
4155
+ # {
4156
+ # name: "DocumentMetadataConfigurationName", # required
4157
+ # relevance: { # required
4158
+ # freshness: false,
4159
+ # importance: 1,
4160
+ # duration: "Duration",
4161
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
4162
+ # value_importance_map: {
4163
+ # "ValueImportanceMapKey" => 1,
4164
+ # },
4165
+ # },
4166
+ # }
4167
+ #
4168
+ # @!attribute [rw] name
4169
+ # The name of the tuning configuration to override document relevance
4170
+ # at the index level.
4171
+ # @return [String]
4172
+ #
4173
+ # @!attribute [rw] relevance
4174
+ # Provides information for manually tuning the relevance of a field in
4175
+ # a search. When a query includes terms that match the field, the
4176
+ # results are given a boost in the response based on these tuning
4177
+ # parameters.
4178
+ # @return [Types::Relevance]
4179
+ #
4180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentRelevanceConfiguration AWS API Documentation
4181
+ #
4182
+ class DocumentRelevanceConfiguration < Struct.new(
4183
+ :name,
4184
+ :relevance)
4185
+ SENSITIVE = []
4186
+ include Aws::Structure
4187
+ end
4188
+
3442
4189
  # Document metadata files that contain information such as the document
3443
4190
  # access control information, source URI, document author, and custom
3444
4191
  # attributes. Each metadata file contains metadata about a single
@@ -3572,6 +4319,63 @@ module Aws::Kendra
3572
4319
  include Aws::Structure
3573
4320
  end
3574
4321
 
4322
+ # @note When making an API call, you may pass GetQuerySuggestionsRequest
4323
+ # data as a hash:
4324
+ #
4325
+ # {
4326
+ # index_id: "IndexId", # required
4327
+ # query_text: "SuggestionQueryText", # required
4328
+ # max_suggestions_count: 1,
4329
+ # }
4330
+ #
4331
+ # @!attribute [rw] index_id
4332
+ # The identifier of the index you want to get query suggestions from.
4333
+ # @return [String]
4334
+ #
4335
+ # @!attribute [rw] query_text
4336
+ # The text of a user's query to generate query suggestions.
4337
+ #
4338
+ # A query is suggested if the query prefix matches what a user starts
4339
+ # to type as their query.
4340
+ #
4341
+ # Amazon Kendra does not show any suggestions if a user types fewer
4342
+ # than two characters or more than 60 characters. A query must also
4343
+ # have at least one search result and contain at least one word of
4344
+ # more than four characters.
4345
+ # @return [String]
4346
+ #
4347
+ # @!attribute [rw] max_suggestions_count
4348
+ # The maximum number of query suggestions you want to show to your
4349
+ # users.
4350
+ # @return [Integer]
4351
+ #
4352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsRequest AWS API Documentation
4353
+ #
4354
+ class GetQuerySuggestionsRequest < Struct.new(
4355
+ :index_id,
4356
+ :query_text,
4357
+ :max_suggestions_count)
4358
+ SENSITIVE = []
4359
+ include Aws::Structure
4360
+ end
4361
+
4362
+ # @!attribute [rw] query_suggestions_id
4363
+ # The unique identifier for a list of query suggestions for an index.
4364
+ # @return [String]
4365
+ #
4366
+ # @!attribute [rw] suggestions
4367
+ # A list of query suggestions for an index.
4368
+ # @return [Array<Types::Suggestion>]
4369
+ #
4370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsResponse AWS API Documentation
4371
+ #
4372
+ class GetQuerySuggestionsResponse < Struct.new(
4373
+ :query_suggestions_id,
4374
+ :suggestions)
4375
+ SENSITIVE = []
4376
+ include Aws::Structure
4377
+ end
4378
+
3575
4379
  # Provides configuration information for data sources that connect to
3576
4380
  # Google Drive.
3577
4381
  #
@@ -3629,7 +4433,7 @@ module Aws::Kendra
3629
4433
  #
3630
4434
  # If you are using the console, you can define index fields when
3631
4435
  # creating the mapping. If you are using the API, you must first
3632
- # create the field using the UpdateIndex operation.
4436
+ # create the field using the `UpdateIndex` operation.
3633
4437
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
3634
4438
  #
3635
4439
  # @!attribute [rw] exclude_mime_types
@@ -4096,39 +4900,111 @@ module Aws::Kendra
4096
4900
  include Aws::Structure
4097
4901
  end
4098
4902
 
4099
- # @note When making an API call, you may pass ListTagsForResourceRequest
4903
+ # @note When making an API call, you may pass ListQuerySuggestionsBlockListsRequest
4100
4904
  # data as a hash:
4101
4905
  #
4102
4906
  # {
4103
- # resource_arn: "AmazonResourceName", # required
4907
+ # index_id: "IndexId", # required
4908
+ # next_token: "NextToken",
4909
+ # max_results: 1,
4104
4910
  # }
4105
4911
  #
4106
- # @!attribute [rw] resource_arn
4107
- # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
4108
- # get a list of tags for.
4109
- # @return [String]
4912
+ # @!attribute [rw] index_id
4913
+ # The identifier of the index for a list of all block lists that exist
4914
+ # for that index.
4110
4915
  #
4111
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceRequest AWS API Documentation
4916
+ # For information on the current quota limits for block lists, see
4917
+ # [Quotas for Amazon Kendra][1].
4112
4918
  #
4113
- class ListTagsForResourceRequest < Struct.new(
4114
- :resource_arn)
4115
- SENSITIVE = []
4116
- include Aws::Structure
4117
- end
4118
-
4119
- # @!attribute [rw] tags
4120
- # A list of tags associated with the index, FAQ, or data source.
4121
- # @return [Array<Types::Tag>]
4122
4919
  #
4123
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceResponse AWS API Documentation
4124
4920
  #
4125
- class ListTagsForResourceResponse < Struct.new(
4126
- :tags)
4127
- SENSITIVE = []
4128
- include Aws::Structure
4129
- end
4130
-
4131
- # @note When making an API call, you may pass ListThesauriRequest
4921
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
4922
+ # @return [String]
4923
+ #
4924
+ # @!attribute [rw] next_token
4925
+ # If the previous response was incomplete (because there is more data
4926
+ # to retrieve), Amazon Kendra returns a pagination token in the
4927
+ # response. You can use this pagination token to retrieve the next set
4928
+ # of block lists (`BlockListSummaryItems`).
4929
+ # @return [String]
4930
+ #
4931
+ # @!attribute [rw] max_results
4932
+ # The maximum number of block lists to return.
4933
+ # @return [Integer]
4934
+ #
4935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsRequest AWS API Documentation
4936
+ #
4937
+ class ListQuerySuggestionsBlockListsRequest < Struct.new(
4938
+ :index_id,
4939
+ :next_token,
4940
+ :max_results)
4941
+ SENSITIVE = []
4942
+ include Aws::Structure
4943
+ end
4944
+
4945
+ # @!attribute [rw] block_list_summary_items
4946
+ # Summary items for a block list.
4947
+ #
4948
+ # This includes summary items on the block list ID, block list name,
4949
+ # when the block list was created, when the block list was last
4950
+ # updated, and the count of block words/phrases in the block list.
4951
+ #
4952
+ # For information on the current quota limits for block lists, see
4953
+ # [Quotas for Amazon Kendra][1].
4954
+ #
4955
+ #
4956
+ #
4957
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
4958
+ # @return [Array<Types::QuerySuggestionsBlockListSummary>]
4959
+ #
4960
+ # @!attribute [rw] next_token
4961
+ # If the response is truncated, Amazon Kendra returns this token that
4962
+ # you can use in the subsequent request to retrieve the next set of
4963
+ # block lists.
4964
+ # @return [String]
4965
+ #
4966
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsResponse AWS API Documentation
4967
+ #
4968
+ class ListQuerySuggestionsBlockListsResponse < Struct.new(
4969
+ :block_list_summary_items,
4970
+ :next_token)
4971
+ SENSITIVE = []
4972
+ include Aws::Structure
4973
+ end
4974
+
4975
+ # @note When making an API call, you may pass ListTagsForResourceRequest
4976
+ # data as a hash:
4977
+ #
4978
+ # {
4979
+ # resource_arn: "AmazonResourceName", # required
4980
+ # }
4981
+ #
4982
+ # @!attribute [rw] resource_arn
4983
+ # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
4984
+ # get a list of tags for.
4985
+ # @return [String]
4986
+ #
4987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceRequest AWS API Documentation
4988
+ #
4989
+ class ListTagsForResourceRequest < Struct.new(
4990
+ :resource_arn)
4991
+ SENSITIVE = []
4992
+ include Aws::Structure
4993
+ end
4994
+
4995
+ # @!attribute [rw] tags
4996
+ # A list of tags associated with the index, FAQ, or data source.
4997
+ # @return [Array<Types::Tag>]
4998
+ #
4999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceResponse AWS API Documentation
5000
+ #
5001
+ class ListTagsForResourceResponse < Struct.new(
5002
+ :tags)
5003
+ SENSITIVE = []
5004
+ include Aws::Structure
5005
+ end
5006
+
5007
+ # @note When making an API call, you may pass ListThesauriRequest
4132
5008
  # data as a hash:
4133
5009
  #
4134
5010
  # {
@@ -4336,6 +5212,57 @@ module Aws::Kendra
4336
5212
  include Aws::Structure
4337
5213
  end
4338
5214
 
5215
+ # Provides the configuration information for a web proxy to connect to
5216
+ # website hosts.
5217
+ #
5218
+ # @note When making an API call, you may pass ProxyConfiguration
5219
+ # data as a hash:
5220
+ #
5221
+ # {
5222
+ # host: "Host", # required
5223
+ # port: 1, # required
5224
+ # credentials: "SecretArn",
5225
+ # }
5226
+ #
5227
+ # @!attribute [rw] host
5228
+ # The name of the website host you want to connect to via a web proxy
5229
+ # server.
5230
+ #
5231
+ # For example, the host name of https://a.example.com/page1.html is
5232
+ # "a.example.com".
5233
+ # @return [String]
5234
+ #
5235
+ # @!attribute [rw] port
5236
+ # The port number of the website host you want to connect to via a web
5237
+ # proxy server.
5238
+ #
5239
+ # For example, the port for https://a.example.com/page1.html is 443,
5240
+ # the standard port for HTTPS.
5241
+ # @return [Integer]
5242
+ #
5243
+ # @!attribute [rw] credentials
5244
+ # Your secret ARN, which you can create in [AWS Secrets Manager][1]
5245
+ #
5246
+ # The credentials are optional. You use a secret if web proxy
5247
+ # credentials are required to connect to a website host. Amazon Kendra
5248
+ # currently support basic authentication to connect to a web proxy
5249
+ # server. The secret stores your credentials.
5250
+ #
5251
+ #
5252
+ #
5253
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
5254
+ # @return [String]
5255
+ #
5256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ProxyConfiguration AWS API Documentation
5257
+ #
5258
+ class ProxyConfiguration < Struct.new(
5259
+ :host,
5260
+ :port,
5261
+ :credentials)
5262
+ SENSITIVE = []
5263
+ include Aws::Structure
5264
+ end
5265
+
4339
5266
  # @note When making an API call, you may pass QueryRequest
4340
5267
  # data as a hash:
4341
5268
  #
@@ -4427,6 +5354,20 @@ module Aws::Kendra
4427
5354
  # ],
4428
5355
  # requested_document_attributes: ["DocumentAttributeKey"],
4429
5356
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
5357
+ # document_relevance_override_configurations: [
5358
+ # {
5359
+ # name: "DocumentMetadataConfigurationName", # required
5360
+ # relevance: { # required
5361
+ # freshness: false,
5362
+ # importance: 1,
5363
+ # duration: "Duration",
5364
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
5365
+ # value_importance_map: {
5366
+ # "ValueImportanceMapKey" => 1,
5367
+ # },
5368
+ # },
5369
+ # },
5370
+ # ],
4430
5371
  # page_number: 1,
4431
5372
  # page_size: 1,
4432
5373
  # sorting_configuration: {
@@ -4441,7 +5382,7 @@ module Aws::Kendra
4441
5382
  #
4442
5383
  # @!attribute [rw] index_id
4443
5384
  # The unique identifier of the index to search. The identifier is
4444
- # returned in the response from the operation.
5385
+ # returned in the response from the `CreateIndex` operation.
4445
5386
  # @return [String]
4446
5387
  #
4447
5388
  # @!attribute [rw] query_text
@@ -4476,6 +5417,25 @@ module Aws::Kendra
4476
5417
  # are returned.
4477
5418
  # @return [String]
4478
5419
  #
5420
+ # @!attribute [rw] document_relevance_override_configurations
5421
+ # Overrides relevance tuning configurations of fields or attributes
5422
+ # set at the index level.
5423
+ #
5424
+ # If you use this API to override the relevance tuning configured at
5425
+ # the index level, but there is no relevance tuning configured at the
5426
+ # index level, then Amazon Kendra does not apply any relevance tuning.
5427
+ #
5428
+ # If there is relevance tuning configured at the index level, but you
5429
+ # do not use this API to override any relevance tuning in the index,
5430
+ # then Amazon Kendra uses the relevance tuning that is configured at
5431
+ # the index level.
5432
+ #
5433
+ # If there is relevance tuning configured for fields at the index
5434
+ # level, but you use this API to override only some of these fields,
5435
+ # then for the fields you did not override, the importance is set to
5436
+ # 1.
5437
+ # @return [Array<Types::DocumentRelevanceConfiguration>]
5438
+ #
4479
5439
  # @!attribute [rw] page_number
4480
5440
  # Query results are returned in pages the size of the `PageSize`
4481
5441
  # parameter. By default, Amazon Kendra returns the first page of
@@ -4520,6 +5480,7 @@ module Aws::Kendra
4520
5480
  :facets,
4521
5481
  :requested_document_attributes,
4522
5482
  :query_result_type_filter,
5483
+ :document_relevance_override_configurations,
4523
5484
  :page_number,
4524
5485
  :page_size,
4525
5486
  :sorting_configuration,
@@ -4643,6 +5604,57 @@ module Aws::Kendra
4643
5604
  include Aws::Structure
4644
5605
  end
4645
5606
 
5607
+ # Summary information on a query suggestions block list.
5608
+ #
5609
+ # This includes information on the block list ID, block list name, when
5610
+ # the block list was created, when the block list was last updated, and
5611
+ # the count of block words/phrases in the block list.
5612
+ #
5613
+ # For information on the current quota limits for block lists, see
5614
+ # [Quotas for Amazon Kendra][1].
5615
+ #
5616
+ #
5617
+ #
5618
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
5619
+ #
5620
+ # @!attribute [rw] id
5621
+ # The identifier of a block list.
5622
+ # @return [String]
5623
+ #
5624
+ # @!attribute [rw] name
5625
+ # The name of the block list.
5626
+ # @return [String]
5627
+ #
5628
+ # @!attribute [rw] status
5629
+ # The status of the block list.
5630
+ # @return [String]
5631
+ #
5632
+ # @!attribute [rw] created_at
5633
+ # The date-time summary information for a query suggestions block list
5634
+ # was last created.
5635
+ # @return [Time]
5636
+ #
5637
+ # @!attribute [rw] updated_at
5638
+ # The date-time the block list was last updated.
5639
+ # @return [Time]
5640
+ #
5641
+ # @!attribute [rw] item_count
5642
+ # The number of items in the block list file.
5643
+ # @return [Integer]
5644
+ #
5645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuerySuggestionsBlockListSummary AWS API Documentation
5646
+ #
5647
+ class QuerySuggestionsBlockListSummary < Struct.new(
5648
+ :id,
5649
+ :name,
5650
+ :status,
5651
+ :created_at,
5652
+ :updated_at,
5653
+ :item_count)
5654
+ SENSITIVE = []
5655
+ include Aws::Structure
5656
+ end
5657
+
4646
5658
  # Provides information for manually tuning the relevance of a field in a
4647
5659
  # search. When a query includes terms that match the field, the results
4648
5660
  # are given a boost in the response based on these tuning parameters.
@@ -4727,7 +5739,7 @@ module Aws::Kendra
4727
5739
  end
4728
5740
 
4729
5741
  # Provides feedback on how relevant a document is to a search. Your
4730
- # application uses the SubmitFeedback operation to provide relevance
5742
+ # application uses the `SubmitFeedback` operation to provide relevance
4731
5743
  # information.
4732
5744
  #
4733
5745
  # @note When making an API call, you may pass RelevanceFeedback
@@ -4833,12 +5845,21 @@ module Aws::Kendra
4833
5845
  # document that matches an inclusion pattern also matches an exclusion
4834
5846
  # pattern, the document is not indexed.
4835
5847
  #
4836
- # For more information about glob patterns, see [glob
4837
- # (programming)][1] in *Wikipedia*.
5848
+ # Some [examples][1] are:
5849
+ #
5850
+ # * **.txt* will include all text files in a directory (files with
5851
+ # the extension .txt).
4838
5852
  #
5853
+ # * ***/*.txt* will include all text files in a directory and its
5854
+ # subdirectories.
4839
5855
  #
5856
+ # * **tax** will include all files in a directory that contain
5857
+ # 'tax' in the file name, such as 'tax', 'taxes',
5858
+ # 'income\_tax'.
4840
5859
  #
4841
- # [1]: https://en.wikipedia.org/wiki/Glob_(programming)
5860
+ #
5861
+ #
5862
+ # [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
4842
5863
  # @return [Array<String>]
4843
5864
  #
4844
5865
  # @!attribute [rw] exclusion_patterns
@@ -4846,12 +5867,21 @@ module Aws::Kendra
4846
5867
  # a document that matches an inclusion prefix or inclusion pattern
4847
5868
  # also matches an exclusion pattern, the document is not indexed.
4848
5869
  #
4849
- # For more information about glob patterns, see [glob
4850
- # (programming)][1] in *Wikipedia*.
5870
+ # Some [examples][1] are:
5871
+ #
5872
+ # * **.png , *.jpg* will exclude all PNG and JPEG image files in a
5873
+ # directory (files with the extensions .png and .jpg).
5874
+ #
5875
+ # * **internal** will exclude all files in a directory that contain
5876
+ # 'internal' in the file name, such as 'internal',
5877
+ # 'internal\_only', 'company\_internal'.
4851
5878
  #
5879
+ # * ***/*internal** will exclude all internal-related files in a
5880
+ # directory and its subdirectories.
4852
5881
  #
4853
5882
  #
4854
- # [1]: https://en.wikipedia.org/wiki/Glob_(programming)
5883
+ #
5884
+ # [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
4855
5885
  # @return [Array<String>]
4856
5886
  #
4857
5887
  # @!attribute [rw] documents_metadata_configuration
@@ -4938,7 +5968,7 @@ module Aws::Kendra
4938
5968
  # @!attribute [rw] document_title_field_name
4939
5969
  # The name of the column in the Salesforce FeedItem table that
4940
5970
  # contains the title of the document. This is typically the `Title`
4941
- # collumn.
5971
+ # column.
4942
5972
  # @return [String]
4943
5973
  #
4944
5974
  # @!attribute [rw] field_mappings
@@ -5078,7 +6108,7 @@ module Aws::Kendra
5078
6108
  # @return [Array<Types::SalesforceStandardObjectConfiguration>]
5079
6109
  #
5080
6110
  # @!attribute [rw] knowledge_article_configuration
5081
- # Specifies configuration information for the knowlege article types
6111
+ # Specifies configuration information for the knowledge article types
5082
6112
  # that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
5083
6113
  # articles and the standard fields of knowledge articles, or the
5084
6114
  # custom fields of custom knowledge articles, but not both.
@@ -5183,7 +6213,7 @@ module Aws::Kendra
5183
6213
  include Aws::Structure
5184
6214
  end
5185
6215
 
5186
- # Specifies configuration information for the knowlege article types
6216
+ # Specifies configuration information for the knowledge article types
5187
6217
  # that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
5188
6218
  # articles and the standard fields of knowledge articles, or the custom
5189
6219
  # fields of custom knowledge articles, but not both
@@ -5323,7 +6353,7 @@ module Aws::Kendra
5323
6353
  include Aws::Structure
5324
6354
  end
5325
6355
 
5326
- # Specifies confguration information for indexing a single standard
6356
+ # Specifies configuration information for indexing a single standard
5327
6357
  # object.
5328
6358
  #
5329
6359
  # @note When making an API call, you may pass SalesforceStandardObjectConfiguration
@@ -5353,7 +6383,7 @@ module Aws::Kendra
5353
6383
  #
5354
6384
  # @!attribute [rw] document_title_field_name
5355
6385
  # The name of the field in the standard object table that contains the
5356
- # document titleB.
6386
+ # document title.
5357
6387
  # @return [String]
5358
6388
  #
5359
6389
  # @!attribute [rw] field_mappings
@@ -5438,6 +6468,59 @@ module Aws::Kendra
5438
6468
  include Aws::Structure
5439
6469
  end
5440
6470
 
6471
+ # Provides the configuration information of the seed or starting point
6472
+ # URLs to crawl.
6473
+ #
6474
+ # *When selecting websites to index, you must adhere to the [Amazon
6475
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
6476
+ # you must only use the Amazon Kendra web crawler to index your own
6477
+ # webpages, or webpages that you have authorization to index.*
6478
+ #
6479
+ #
6480
+ #
6481
+ # [1]: https://aws.amazon.com/aup/
6482
+ #
6483
+ # @note When making an API call, you may pass SeedUrlConfiguration
6484
+ # data as a hash:
6485
+ #
6486
+ # {
6487
+ # seed_urls: ["SeedUrl"], # required
6488
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
6489
+ # }
6490
+ #
6491
+ # @!attribute [rw] seed_urls
6492
+ # The list of seed or starting point URLs of the websites you want to
6493
+ # crawl.
6494
+ #
6495
+ # The list can include a maximum of 100 seed URLs.
6496
+ # @return [Array<String>]
6497
+ #
6498
+ # @!attribute [rw] web_crawler_mode
6499
+ # You can choose one of the following modes:
6500
+ #
6501
+ # * `HOST_ONLY` – crawl only the website host names. For example, if
6502
+ # the seed URL is "abc.example.com", then only URLs with host name
6503
+ # "abc.example.com" are crawled.
6504
+ #
6505
+ # * `SUBDOMAINS` – crawl the website host names with subdomains. For
6506
+ # example, if the seed URL is "abc.example.com", then
6507
+ # "a.abc.example.com" and "b.abc.example.com" are also crawled.
6508
+ #
6509
+ # * `EVERYTHING` – crawl the website host names with subdomains and
6510
+ # other domains that the webpages link to.
6511
+ #
6512
+ # The default mode is set to `HOST_ONLY`.
6513
+ # @return [String]
6514
+ #
6515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SeedUrlConfiguration AWS API Documentation
6516
+ #
6517
+ class SeedUrlConfiguration < Struct.new(
6518
+ :seed_urls,
6519
+ :web_crawler_mode)
6520
+ SENSITIVE = []
6521
+ include Aws::Structure
6522
+ end
6523
+
5441
6524
  # Provides the identifier of the AWS KMS customer master key (CMK) used
5442
6525
  # to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
5443
6526
  # support asymmetric CMKs.
@@ -5485,6 +6568,7 @@ module Aws::Kendra
5485
6568
  # index_field_name: "IndexFieldName", # required
5486
6569
  # },
5487
6570
  # ],
6571
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
5488
6572
  # },
5489
6573
  # service_catalog_configuration: {
5490
6574
  # crawl_attachments: false,
@@ -5500,6 +6584,7 @@ module Aws::Kendra
5500
6584
  # },
5501
6585
  # ],
5502
6586
  # },
6587
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
5503
6588
  # }
5504
6589
  #
5505
6590
  # @!attribute [rw] host_url
@@ -5529,6 +6614,25 @@ module Aws::Kendra
5529
6614
  # the ServiceNow site.
5530
6615
  # @return [Types::ServiceNowServiceCatalogConfiguration]
5531
6616
  #
6617
+ # @!attribute [rw] authentication_type
6618
+ # Determines the type of authentication used to connect to the
6619
+ # ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is
6620
+ # authenticated using the user name and password provided in the AWS
6621
+ # Secrets Manager secret in the `SecretArn` field. When you choose
6622
+ # `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and
6623
+ # secret provided in the Secrets Manager secret, and the user name and
6624
+ # password are used to determine which information Amazon Kendra has
6625
+ # access to.
6626
+ #
6627
+ # When you use `OAUTH2` authentication, you must generate a token and
6628
+ # a client secret using the ServiceNow console. For more information,
6629
+ # see [Using a ServiceNow data source][1].
6630
+ #
6631
+ #
6632
+ #
6633
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
6634
+ # @return [String]
6635
+ #
5532
6636
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
5533
6637
  #
5534
6638
  class ServiceNowConfiguration < Struct.new(
@@ -5536,7 +6640,8 @@ module Aws::Kendra
5536
6640
  :secret_arn,
5537
6641
  :service_now_build_version,
5538
6642
  :knowledge_article_configuration,
5539
- :service_catalog_configuration)
6643
+ :service_catalog_configuration,
6644
+ :authentication_type)
5540
6645
  SENSITIVE = []
5541
6646
  include Aws::Structure
5542
6647
  end
@@ -5560,6 +6665,7 @@ module Aws::Kendra
5560
6665
  # index_field_name: "IndexFieldName", # required
5561
6666
  # },
5562
6667
  # ],
6668
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
5563
6669
  # }
5564
6670
  #
5565
6671
  # @!attribute [rw] crawl_attachments
@@ -5594,6 +6700,20 @@ module Aws::Kendra
5594
6700
  # You must create the index field before you map the field.
5595
6701
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
5596
6702
  #
6703
+ # @!attribute [rw] filter_query
6704
+ # A query that selects the knowledge articles to index. The query can
6705
+ # return articles from multiple knowledge bases, and the knowledge
6706
+ # bases can be public or private.
6707
+ #
6708
+ # The query string must be one generated by the ServiceNow console.
6709
+ # For more information, see [Specifying documents to index with a
6710
+ # query][1].
6711
+ #
6712
+ #
6713
+ #
6714
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
6715
+ # @return [String]
6716
+ #
5597
6717
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
5598
6718
  #
5599
6719
  class ServiceNowKnowledgeArticleConfiguration < Struct.new(
@@ -5602,7 +6722,8 @@ module Aws::Kendra
5602
6722
  :exclude_attachment_file_patterns,
5603
6723
  :document_data_field_name,
5604
6724
  :document_title_field_name,
5605
- :field_mappings)
6725
+ :field_mappings,
6726
+ :filter_query)
5606
6727
  SENSITIVE = []
5607
6728
  include Aws::Structure
5608
6729
  end
@@ -5634,13 +6755,23 @@ module Aws::Kendra
5634
6755
  # @return [Boolean]
5635
6756
  #
5636
6757
  # @!attribute [rw] include_attachment_file_patterns
5637
- # Determines the types of file attachments that are included in the
5638
- # index.
6758
+ # A list of regular expression patterns. Documents that match the
6759
+ # patterns are included in the index. Documents that don't match the
6760
+ # patterns are excluded from the index. If a document matches both an
6761
+ # exclusion pattern and an inclusion pattern, the document is not
6762
+ # included in the index.
6763
+ #
6764
+ # The regex is applied to the file name of the attachment.
5639
6765
  # @return [Array<String>]
5640
6766
  #
5641
6767
  # @!attribute [rw] exclude_attachment_file_patterns
5642
- # Determines the types of file attachments that are excluded from the
5643
- # index.
6768
+ # A list of regular expression patterns. Documents that match the
6769
+ # patterns are excluded from the index. Documents that don't match
6770
+ # the patterns are included in the index. If a document matches both
6771
+ # an exclusion pattern and an inclusion pattern, the document is not
6772
+ # included in the index.
6773
+ #
6774
+ # The regex is applied to the file name of the attachment.
5644
6775
  # @return [Array<String>]
5645
6776
  #
5646
6777
  # @!attribute [rw] document_data_field_name
@@ -5775,9 +6906,9 @@ module Aws::Kendra
5775
6906
  # @!attribute [rw] field_mappings
5776
6907
  # A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
5777
6908
  # SharePoint attributes to custom fields in the Amazon Kendra index.
5778
- # You must first create the index fields using the operation before
5779
- # you map SharePoint attributes. For more information, see [Mapping
5780
- # Data Source Fields][1].
6909
+ # You must first create the index fields using the `UpdateIndex`
6910
+ # operation before you map SharePoint attributes. For more
6911
+ # information, see [Mapping Data Source Fields][1].
5781
6912
  #
5782
6913
  #
5783
6914
  #
@@ -5812,6 +6943,38 @@ module Aws::Kendra
5812
6943
  include Aws::Structure
5813
6944
  end
5814
6945
 
6946
+ # Provides the configuration information of the sitemap URLs to crawl.
6947
+ #
6948
+ # *When selecting websites to index, you must adhere to the [Amazon
6949
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
6950
+ # you must only use the Amazon Kendra web crawler to index your own
6951
+ # webpages, or webpages that you have authorization to index.*
6952
+ #
6953
+ #
6954
+ #
6955
+ # [1]: https://aws.amazon.com/aup/
6956
+ #
6957
+ # @note When making an API call, you may pass SiteMapsConfiguration
6958
+ # data as a hash:
6959
+ #
6960
+ # {
6961
+ # site_maps: ["SiteMap"], # required
6962
+ # }
6963
+ #
6964
+ # @!attribute [rw] site_maps
6965
+ # The list of sitemap URLs of the websites you want to crawl.
6966
+ #
6967
+ # The list can include a maximum of three sitemap URLs.
6968
+ # @return [Array<String>]
6969
+ #
6970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SiteMapsConfiguration AWS API Documentation
6971
+ #
6972
+ class SiteMapsConfiguration < Struct.new(
6973
+ :site_maps)
6974
+ SENSITIVE = []
6975
+ include Aws::Structure
6976
+ end
6977
+
5815
6978
  # Specifies the document attribute to use to sort the response to a
5816
6979
  # Amazon Kendra query. You can specify a single attribute for sorting.
5817
6980
  # The attribute must have the `Sortable` flag set to `true`, otherwise
@@ -5943,6 +7106,41 @@ module Aws::Kendra
5943
7106
  include Aws::Structure
5944
7107
  end
5945
7108
 
7109
+ # Provides information about the status of documents submitted for
7110
+ # indexing.
7111
+ #
7112
+ # @!attribute [rw] document_id
7113
+ # The unique identifier of the document.
7114
+ # @return [String]
7115
+ #
7116
+ # @!attribute [rw] document_status
7117
+ # The current status of a document.
7118
+ #
7119
+ # If the document was submitted for deletion, the status is
7120
+ # `NOT_FOUND` after the document is deleted.
7121
+ # @return [String]
7122
+ #
7123
+ # @!attribute [rw] failure_code
7124
+ # Indicates the source of the error.
7125
+ # @return [String]
7126
+ #
7127
+ # @!attribute [rw] failure_reason
7128
+ # Provides detailed information about why the document couldn't be
7129
+ # indexed. Use this information to correct the error before you
7130
+ # resubmit the document for indexing.
7131
+ # @return [String]
7132
+ #
7133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Status AWS API Documentation
7134
+ #
7135
+ class Status < Struct.new(
7136
+ :document_id,
7137
+ :document_status,
7138
+ :failure_code,
7139
+ :failure_reason)
7140
+ SENSITIVE = []
7141
+ include Aws::Structure
7142
+ end
7143
+
5946
7144
  # @note When making an API call, you may pass StopDataSourceSyncJobRequest
5947
7145
  # data as a hash:
5948
7146
  #
@@ -5995,7 +7193,8 @@ module Aws::Kendra
5995
7193
  #
5996
7194
  # @!attribute [rw] query_id
5997
7195
  # The identifier of the specific query for which you are submitting
5998
- # feedback. The query ID is returned in the response to the operation.
7196
+ # feedback. The query ID is returned in the response to the `Query`
7197
+ # operation.
5999
7198
  # @return [String]
6000
7199
  #
6001
7200
  # @!attribute [rw] click_feedback_items
@@ -6019,6 +7218,86 @@ module Aws::Kendra
6019
7218
  include Aws::Structure
6020
7219
  end
6021
7220
 
7221
+ # A single query suggestion.
7222
+ #
7223
+ # @!attribute [rw] id
7224
+ # The unique UUID (universally unique identifier) of a single query
7225
+ # suggestion.
7226
+ # @return [String]
7227
+ #
7228
+ # @!attribute [rw] value
7229
+ # The value for the unique UUID (universally unique identifier) of a
7230
+ # single query suggestion.
7231
+ #
7232
+ # The value is the text string of a suggestion.
7233
+ # @return [Types::SuggestionValue]
7234
+ #
7235
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Suggestion AWS API Documentation
7236
+ #
7237
+ class Suggestion < Struct.new(
7238
+ :id,
7239
+ :value)
7240
+ SENSITIVE = []
7241
+ include Aws::Structure
7242
+ end
7243
+
7244
+ # The text highlights for a single query suggestion.
7245
+ #
7246
+ # @!attribute [rw] begin_offset
7247
+ # The zero-based location in the response string where the highlight
7248
+ # starts.
7249
+ # @return [Integer]
7250
+ #
7251
+ # @!attribute [rw] end_offset
7252
+ # The zero-based location in the response string where the highlight
7253
+ # ends.
7254
+ # @return [Integer]
7255
+ #
7256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionHighlight AWS API Documentation
7257
+ #
7258
+ class SuggestionHighlight < Struct.new(
7259
+ :begin_offset,
7260
+ :end_offset)
7261
+ SENSITIVE = []
7262
+ include Aws::Structure
7263
+ end
7264
+
7265
+ # Provides text and information about where to highlight the query
7266
+ # suggestion text.
7267
+ #
7268
+ # @!attribute [rw] text
7269
+ # The query suggestion text to display to the user.
7270
+ # @return [String]
7271
+ #
7272
+ # @!attribute [rw] highlights
7273
+ # The beginning and end of the query suggestion text that should be
7274
+ # highlighted.
7275
+ # @return [Array<Types::SuggestionHighlight>]
7276
+ #
7277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionTextWithHighlights AWS API Documentation
7278
+ #
7279
+ class SuggestionTextWithHighlights < Struct.new(
7280
+ :text,
7281
+ :highlights)
7282
+ SENSITIVE = []
7283
+ include Aws::Structure
7284
+ end
7285
+
7286
+ # The `SuggestionTextWithHighlights` structure information.
7287
+ #
7288
+ # @!attribute [rw] text
7289
+ # The `SuggestionTextWithHighlights` structure that contains the query
7290
+ # suggestion text and highlights.
7291
+ # @return [Types::SuggestionTextWithHighlights]
7292
+ #
7293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionValue AWS API Documentation
7294
+ #
7295
+ class SuggestionValue < Struct.new(
7296
+ :text)
7297
+ SENSITIVE = []
7298
+ include Aws::Structure
7299
+ end
7300
+
6022
7301
  # A list of key/value pairs that identify an index, FAQ, or data source.
6023
7302
  # Tag keys and values can consist of Unicode letters, digits, white
6024
7303
  # space, and any of the following symbols: \_ . : / = + - @.
@@ -6412,6 +7691,7 @@ module Aws::Kendra
6412
7691
  # index_field_name: "IndexFieldName", # required
6413
7692
  # },
6414
7693
  # ],
7694
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
6415
7695
  # },
6416
7696
  # service_catalog_configuration: {
6417
7697
  # crawl_attachments: false,
@@ -6427,6 +7707,7 @@ module Aws::Kendra
6427
7707
  # },
6428
7708
  # ],
6429
7709
  # },
7710
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
6430
7711
  # },
6431
7712
  # confluence_configuration: {
6432
7713
  # server_url: "Url", # required
@@ -6495,6 +7776,37 @@ module Aws::Kendra
6495
7776
  # exclude_user_accounts: ["UserAccount"],
6496
7777
  # exclude_shared_drives: ["SharedDriveId"],
6497
7778
  # },
7779
+ # web_crawler_configuration: {
7780
+ # urls: { # required
7781
+ # seed_url_configuration: {
7782
+ # seed_urls: ["SeedUrl"], # required
7783
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
7784
+ # },
7785
+ # site_maps_configuration: {
7786
+ # site_maps: ["SiteMap"], # required
7787
+ # },
7788
+ # },
7789
+ # crawl_depth: 1,
7790
+ # max_links_per_page: 1,
7791
+ # max_content_size_per_page_in_mega_bytes: 1.0,
7792
+ # max_urls_per_minute_crawl_rate: 1,
7793
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
7794
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
7795
+ # proxy_configuration: {
7796
+ # host: "Host", # required
7797
+ # port: 1, # required
7798
+ # credentials: "SecretArn",
7799
+ # },
7800
+ # authentication_configuration: {
7801
+ # basic_authentication: [
7802
+ # {
7803
+ # host: "Host", # required
7804
+ # port: 1, # required
7805
+ # credentials: "SecretArn", # required
7806
+ # },
7807
+ # ],
7808
+ # },
7809
+ # },
6498
7810
  # },
6499
7811
  # description: "Description",
6500
7812
  # schedule: "ScanSchedule",
@@ -6621,7 +7933,7 @@ module Aws::Kendra
6621
7933
  # @return [Array<Types::DocumentMetadataConfiguration>]
6622
7934
  #
6623
7935
  # @!attribute [rw] capacity_units
6624
- # Sets the number of addtional storage and query capacity units that
7936
+ # Sets the number of additional storage and query capacity units that
6625
7937
  # should be used by the index. You can change the capacity of the
6626
7938
  # index up to 5 times per day.
6627
7939
  #
@@ -6653,6 +7965,158 @@ module Aws::Kendra
6653
7965
  include Aws::Structure
6654
7966
  end
6655
7967
 
7968
+ # @note When making an API call, you may pass UpdateQuerySuggestionsBlockListRequest
7969
+ # data as a hash:
7970
+ #
7971
+ # {
7972
+ # index_id: "IndexId", # required
7973
+ # id: "QuerySuggestionsBlockListId", # required
7974
+ # name: "QuerySuggestionsBlockListName",
7975
+ # description: "Description",
7976
+ # source_s3_path: {
7977
+ # bucket: "S3BucketName", # required
7978
+ # key: "S3ObjectKey", # required
7979
+ # },
7980
+ # role_arn: "RoleArn",
7981
+ # }
7982
+ #
7983
+ # @!attribute [rw] index_id
7984
+ # The identifier of the index for a block list.
7985
+ # @return [String]
7986
+ #
7987
+ # @!attribute [rw] id
7988
+ # The unique identifier of a block list.
7989
+ # @return [String]
7990
+ #
7991
+ # @!attribute [rw] name
7992
+ # The name of a block list.
7993
+ # @return [String]
7994
+ #
7995
+ # @!attribute [rw] description
7996
+ # The description for a block list.
7997
+ # @return [String]
7998
+ #
7999
+ # @!attribute [rw] source_s3_path
8000
+ # The S3 path where your block list text file sits in S3.
8001
+ #
8002
+ # If you update your block list and provide the same path to the block
8003
+ # list text file in S3, then Amazon Kendra reloads the file to refresh
8004
+ # the block list. Amazon Kendra does not automatically refresh your
8005
+ # block list. You need to call the `UpdateQuerySuggestionsBlockList`
8006
+ # API to refresh you block list.
8007
+ #
8008
+ # If you update your block list, then Amazon Kendra asynchronously
8009
+ # refreshes all query suggestions with the latest content in the S3
8010
+ # file. This means changes might not take effect immediately.
8011
+ # @return [Types::S3Path]
8012
+ #
8013
+ # @!attribute [rw] role_arn
8014
+ # The IAM (Identity and Access Management) role used to access the
8015
+ # block list text file in S3.
8016
+ # @return [String]
8017
+ #
8018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockListRequest AWS API Documentation
8019
+ #
8020
+ class UpdateQuerySuggestionsBlockListRequest < Struct.new(
8021
+ :index_id,
8022
+ :id,
8023
+ :name,
8024
+ :description,
8025
+ :source_s3_path,
8026
+ :role_arn)
8027
+ SENSITIVE = []
8028
+ include Aws::Structure
8029
+ end
8030
+
8031
+ # @note When making an API call, you may pass UpdateQuerySuggestionsConfigRequest
8032
+ # data as a hash:
8033
+ #
8034
+ # {
8035
+ # index_id: "IndexId", # required
8036
+ # mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
8037
+ # query_log_look_back_window_in_days: 1,
8038
+ # include_queries_without_user_information: false,
8039
+ # minimum_number_of_querying_users: 1,
8040
+ # minimum_query_count: 1,
8041
+ # }
8042
+ #
8043
+ # @!attribute [rw] index_id
8044
+ # The identifier of the index you want to update query suggestions
8045
+ # settings for.
8046
+ # @return [String]
8047
+ #
8048
+ # @!attribute [rw] mode
8049
+ # Set the mode to `ENABLED` or `LEARN_ONLY`.
8050
+ #
8051
+ # By default, Amazon Kendra enables query suggestions. `LEARN_ONLY`
8052
+ # mode allows you to turn off query suggestions. You can to update
8053
+ # this at any time.
8054
+ #
8055
+ # In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
8056
+ # queries to keep suggestions up to date for when you are ready to
8057
+ # switch to ENABLED mode again.
8058
+ # @return [String]
8059
+ #
8060
+ # @!attribute [rw] query_log_look_back_window_in_days
8061
+ # How recent your queries are in your query log time window.
8062
+ #
8063
+ # The time window is the number of days from current day to past days.
8064
+ #
8065
+ # By default, Amazon Kendra sets this to 180.
8066
+ # @return [Integer]
8067
+ #
8068
+ # @!attribute [rw] include_queries_without_user_information
8069
+ # `TRUE` to include queries without user information (i.e. all
8070
+ # queries, irrespective of the user), otherwise `FALSE` to only
8071
+ # include queries with user information.
8072
+ #
8073
+ # If you pass user information to Amazon Kendra along with the
8074
+ # queries, you can set this flag to `FALSE` and instruct Amazon Kendra
8075
+ # to only consider queries with user information.
8076
+ #
8077
+ # If you set to `FALSE`, Amazon Kendra only considers queries searched
8078
+ # at least `MinimumQueryCount` times across
8079
+ # `MinimumNumberOfQueryingUsers` unique users for suggestions.
8080
+ #
8081
+ # If you set to `TRUE`, Amazon Kendra ignores all user information and
8082
+ # learns from all queries.
8083
+ # @return [Boolean]
8084
+ #
8085
+ # @!attribute [rw] minimum_number_of_querying_users
8086
+ # The minimum number of unique users who must search a query in order
8087
+ # for the query to be eligible to suggest to your users.
8088
+ #
8089
+ # Increasing this number might decrease the number of suggestions.
8090
+ # However, this ensures a query is searched by many users and is truly
8091
+ # popular to suggest to users.
8092
+ #
8093
+ # How you tune this setting depends on your specific needs.
8094
+ # @return [Integer]
8095
+ #
8096
+ # @!attribute [rw] minimum_query_count
8097
+ # The the minimum number of times a query must be searched in order to
8098
+ # be eligible to suggest to your users.
8099
+ #
8100
+ # Decreasing this number increases the number of suggestions. However,
8101
+ # this affects the quality of suggestions as it sets a low bar for a
8102
+ # query to be considered popular to suggest to users.
8103
+ #
8104
+ # How you tune this setting depends on your specific needs.
8105
+ # @return [Integer]
8106
+ #
8107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation
8108
+ #
8109
+ class UpdateQuerySuggestionsConfigRequest < Struct.new(
8110
+ :index_id,
8111
+ :mode,
8112
+ :query_log_look_back_window_in_days,
8113
+ :include_queries_without_user_information,
8114
+ :minimum_number_of_querying_users,
8115
+ :minimum_query_count)
8116
+ SENSITIVE = []
8117
+ include Aws::Structure
8118
+ end
8119
+
6656
8120
  # @note When making an API call, you may pass UpdateThesaurusRequest
6657
8121
  # data as a hash:
6658
8122
  #
@@ -6705,6 +8169,58 @@ module Aws::Kendra
6705
8169
  include Aws::Structure
6706
8170
  end
6707
8171
 
8172
+ # Provides the configuration information of the URLs to crawl.
8173
+ #
8174
+ # *When selecting websites to index, you must adhere to the [Amazon
8175
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
8176
+ # you must only use the Amazon Kendra web crawler to index your own
8177
+ # webpages, or webpages that you have authorization to index.*
8178
+ #
8179
+ #
8180
+ #
8181
+ # [1]: https://aws.amazon.com/aup/
8182
+ #
8183
+ # @note When making an API call, you may pass Urls
8184
+ # data as a hash:
8185
+ #
8186
+ # {
8187
+ # seed_url_configuration: {
8188
+ # seed_urls: ["SeedUrl"], # required
8189
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
8190
+ # },
8191
+ # site_maps_configuration: {
8192
+ # site_maps: ["SiteMap"], # required
8193
+ # },
8194
+ # }
8195
+ #
8196
+ # @!attribute [rw] seed_url_configuration
8197
+ # Provides the configuration of the seed or starting point URLs of the
8198
+ # websites you want to crawl.
8199
+ #
8200
+ # You can choose to crawl only the website host names, or the website
8201
+ # host names with subdomains, or the website host names with
8202
+ # subdomains and other domains that the webpages link to.
8203
+ #
8204
+ # You can list up to 100 seed URLs.
8205
+ # @return [Types::SeedUrlConfiguration]
8206
+ #
8207
+ # @!attribute [rw] site_maps_configuration
8208
+ # Provides the configuration of the sitemap URLs of the websites you
8209
+ # want to crawl.
8210
+ #
8211
+ # Only URLs belonging to the same website host names are crawled. You
8212
+ # can list up to three sitemap URLs.
8213
+ # @return [Types::SiteMapsConfiguration]
8214
+ #
8215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Urls AWS API Documentation
8216
+ #
8217
+ class Urls < Struct.new(
8218
+ :seed_url_configuration,
8219
+ :site_maps_configuration)
8220
+ SENSITIVE = []
8221
+ include Aws::Structure
8222
+ end
8223
+
6708
8224
  # Provides information about the user context for a Amazon Kendra index.
6709
8225
  #
6710
8226
  # @note When making an API call, you may pass UserContext
@@ -6775,5 +8291,167 @@ module Aws::Kendra
6775
8291
  include Aws::Structure
6776
8292
  end
6777
8293
 
8294
+ # Provides the configuration information required for Amazon Kendra web
8295
+ # crawler.
8296
+ #
8297
+ # @note When making an API call, you may pass WebCrawlerConfiguration
8298
+ # data as a hash:
8299
+ #
8300
+ # {
8301
+ # urls: { # required
8302
+ # seed_url_configuration: {
8303
+ # seed_urls: ["SeedUrl"], # required
8304
+ # web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
8305
+ # },
8306
+ # site_maps_configuration: {
8307
+ # site_maps: ["SiteMap"], # required
8308
+ # },
8309
+ # },
8310
+ # crawl_depth: 1,
8311
+ # max_links_per_page: 1,
8312
+ # max_content_size_per_page_in_mega_bytes: 1.0,
8313
+ # max_urls_per_minute_crawl_rate: 1,
8314
+ # url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
8315
+ # url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
8316
+ # proxy_configuration: {
8317
+ # host: "Host", # required
8318
+ # port: 1, # required
8319
+ # credentials: "SecretArn",
8320
+ # },
8321
+ # authentication_configuration: {
8322
+ # basic_authentication: [
8323
+ # {
8324
+ # host: "Host", # required
8325
+ # port: 1, # required
8326
+ # credentials: "SecretArn", # required
8327
+ # },
8328
+ # ],
8329
+ # },
8330
+ # }
8331
+ #
8332
+ # @!attribute [rw] urls
8333
+ # Specifies the seed or starting point URLs of the websites or the
8334
+ # sitemap URLs of the websites you want to crawl.
8335
+ #
8336
+ # You can include website subdomains. You can list up to 100 seed URLs
8337
+ # and up to three sitemap URLs.
8338
+ #
8339
+ # *When selecting websites to index, you must adhere to the [Amazon
8340
+ # Acceptable Use Policy][1] and all other Amazon terms. Remember that
8341
+ # you must only use the Amazon Kendra web crawler to index your own
8342
+ # webpages, or webpages that you have authorization to index.*
8343
+ #
8344
+ #
8345
+ #
8346
+ # [1]: https://aws.amazon.com/aup/
8347
+ # @return [Types::Urls]
8348
+ #
8349
+ # @!attribute [rw] crawl_depth
8350
+ # Specifies the number of levels in a website that you want to crawl.
8351
+ #
8352
+ # The first level begins from the website seed or starting point URL.
8353
+ # For example, if a website has 3 levels – index level (i.e. seed in
8354
+ # this example), sections level, and subsections level – and you are
8355
+ # only interested in crawling information up to the sections level
8356
+ # (i.e. levels 0-1), you can set your depth to 1.
8357
+ #
8358
+ # The default crawl depth is set to 2.
8359
+ # @return [Integer]
8360
+ #
8361
+ # @!attribute [rw] max_links_per_page
8362
+ # The maximum number of URLs on a webpage to include when crawling a
8363
+ # website. This number is per webpage.
8364
+ #
8365
+ # As a website’s webpages are crawled, any URLs the webpages link to
8366
+ # are also crawled. URLs on a webpage are crawled in order of
8367
+ # appearance.
8368
+ #
8369
+ # The default maximum links per page is 100.
8370
+ # @return [Integer]
8371
+ #
8372
+ # @!attribute [rw] max_content_size_per_page_in_mega_bytes
8373
+ # The maximum size (in MB) of a webpage or attachment to crawl.
8374
+ #
8375
+ # Files larger than this size (in MB) are skipped/not crawled.
8376
+ #
8377
+ # The default maximum size of a webpage or attachment is set to 50 MB.
8378
+ # @return [Float]
8379
+ #
8380
+ # @!attribute [rw] max_urls_per_minute_crawl_rate
8381
+ # The maximum number of URLs crawled per website host per minute.
8382
+ #
8383
+ # A minimum of one URL is required.
8384
+ #
8385
+ # The default maximum number of URLs crawled per website host per
8386
+ # minute is 300.
8387
+ # @return [Integer]
8388
+ #
8389
+ # @!attribute [rw] url_inclusion_patterns
8390
+ # The regular expression pattern to include certain URLs to crawl.
8391
+ #
8392
+ # If there is a regular expression pattern to exclude certain URLs
8393
+ # that conflicts with the include pattern, the exclude pattern takes
8394
+ # precedence.
8395
+ # @return [Array<String>]
8396
+ #
8397
+ # @!attribute [rw] url_exclusion_patterns
8398
+ # The regular expression pattern to exclude certain URLs to crawl.
8399
+ #
8400
+ # If there is a regular expression pattern to include certain URLs
8401
+ # that conflicts with the exclude pattern, the exclude pattern takes
8402
+ # precedence.
8403
+ # @return [Array<String>]
8404
+ #
8405
+ # @!attribute [rw] proxy_configuration
8406
+ # Provides configuration information required to connect to your
8407
+ # internal websites via a web proxy.
8408
+ #
8409
+ # You must provide the website host name and port number. For example,
8410
+ # the host name of https://a.example.com/page1.html is
8411
+ # "a.example.com" and the port is 443, the standard port for HTTPS.
8412
+ #
8413
+ # Web proxy credentials are optional and you can use them to connect
8414
+ # to a web proxy server that requires basic authentication. To store
8415
+ # web proxy credentials, you use a secret in [AWS Secrets Manager][1].
8416
+ #
8417
+ #
8418
+ #
8419
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
8420
+ # @return [Types::ProxyConfiguration]
8421
+ #
8422
+ # @!attribute [rw] authentication_configuration
8423
+ # Provides configuration information required to connect to websites
8424
+ # using authentication.
8425
+ #
8426
+ # You can connect to websites using basic authentication of user name
8427
+ # and password.
8428
+ #
8429
+ # You must provide the website host name and port number. For example,
8430
+ # the host name of https://a.example.com/page1.html is
8431
+ # "a.example.com" and the port is 443, the standard port for HTTPS.
8432
+ # You use a secret in [AWS Secrets Manager][1] to store your
8433
+ # authentication credentials.
8434
+ #
8435
+ #
8436
+ #
8437
+ # [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
8438
+ # @return [Types::AuthenticationConfiguration]
8439
+ #
8440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/WebCrawlerConfiguration AWS API Documentation
8441
+ #
8442
+ class WebCrawlerConfiguration < Struct.new(
8443
+ :urls,
8444
+ :crawl_depth,
8445
+ :max_links_per_page,
8446
+ :max_content_size_per_page_in_mega_bytes,
8447
+ :max_urls_per_minute_crawl_rate,
8448
+ :url_inclusion_patterns,
8449
+ :url_exclusion_patterns,
8450
+ :proxy_configuration,
8451
+ :authentication_configuration)
8452
+ SENSITIVE = []
8453
+ include Aws::Structure
8454
+ end
8455
+
6778
8456
  end
6779
8457
  end