aws-sdk-kendra 1.23.0 → 1.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +756 -8
- data/lib/aws-sdk-kendra/client_api.rb +396 -1
- data/lib/aws-sdk-kendra/types.rb +1687 -47
- metadata +3 -4
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -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",
|
584
|
+
# data_source_sync_job_id: "DataSourceSyncJobId",
|
504
585
|
# },
|
505
586
|
# }
|
506
587
|
#
|
@@ -568,6 +649,103 @@ module Aws::Kendra
|
|
568
649
|
include Aws::Structure
|
569
650
|
end
|
570
651
|
|
652
|
+
# @note When making an API call, you may pass BatchGetDocumentStatusRequest
|
653
|
+
# data as a hash:
|
654
|
+
#
|
655
|
+
# {
|
656
|
+
# index_id: "IndexId", # required
|
657
|
+
# document_info_list: [ # required
|
658
|
+
# {
|
659
|
+
# document_id: "DocumentId", # required
|
660
|
+
# attributes: [
|
661
|
+
# {
|
662
|
+
# key: "DocumentAttributeKey", # required
|
663
|
+
# value: { # required
|
664
|
+
# string_value: "DocumentAttributeStringValue",
|
665
|
+
# string_list_value: ["String"],
|
666
|
+
# long_value: 1,
|
667
|
+
# date_value: Time.now,
|
668
|
+
# },
|
669
|
+
# },
|
670
|
+
# ],
|
671
|
+
# },
|
672
|
+
# ],
|
673
|
+
# }
|
674
|
+
#
|
675
|
+
# @!attribute [rw] index_id
|
676
|
+
# The identifier of the index to add documents to. The index ID is
|
677
|
+
# returned by the [ CreateIndex ][1] operation.
|
678
|
+
#
|
679
|
+
#
|
680
|
+
#
|
681
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
|
682
|
+
# @return [String]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] document_info_list
|
685
|
+
# A list of `DocumentInfo` objects that identify the documents for
|
686
|
+
# which to get the status. You identify the documents by their
|
687
|
+
# document ID and optional attributes.
|
688
|
+
# @return [Array<Types::DocumentInfo>]
|
689
|
+
#
|
690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusRequest AWS API Documentation
|
691
|
+
#
|
692
|
+
class BatchGetDocumentStatusRequest < Struct.new(
|
693
|
+
:index_id,
|
694
|
+
:document_info_list)
|
695
|
+
SENSITIVE = []
|
696
|
+
include Aws::Structure
|
697
|
+
end
|
698
|
+
|
699
|
+
# @!attribute [rw] errors
|
700
|
+
# A list of documents that Amazon Kendra couldn't get the status for.
|
701
|
+
# The list includes the ID of the document and the reason that the
|
702
|
+
# status couldn't be found.
|
703
|
+
# @return [Array<Types::BatchGetDocumentStatusResponseError>]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] document_status_list
|
706
|
+
# The status of documents. The status indicates if the document is
|
707
|
+
# waiting to be indexed, is in the process of indexing, has completed
|
708
|
+
# indexing, or failed indexing. If a document failed indexing, the
|
709
|
+
# status provides the reason why.
|
710
|
+
# @return [Array<Types::Status>]
|
711
|
+
#
|
712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponse AWS API Documentation
|
713
|
+
#
|
714
|
+
class BatchGetDocumentStatusResponse < Struct.new(
|
715
|
+
:errors,
|
716
|
+
:document_status_list)
|
717
|
+
SENSITIVE = []
|
718
|
+
include Aws::Structure
|
719
|
+
end
|
720
|
+
|
721
|
+
# Provides a response when the status of a document could not be
|
722
|
+
# retrieved.
|
723
|
+
#
|
724
|
+
# @!attribute [rw] document_id
|
725
|
+
# The unique identifier of the document whose status could not be
|
726
|
+
# retrieved.
|
727
|
+
# @return [String]
|
728
|
+
#
|
729
|
+
# @!attribute [rw] error_code
|
730
|
+
# Indicates the source of the error.
|
731
|
+
# @return [String]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] error_message
|
734
|
+
# States that the API could not get the status of a document. This
|
735
|
+
# could be because the request is not valid or there is a system
|
736
|
+
# error.
|
737
|
+
# @return [String]
|
738
|
+
#
|
739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponseError AWS API Documentation
|
740
|
+
#
|
741
|
+
class BatchGetDocumentStatusResponseError < Struct.new(
|
742
|
+
:document_id,
|
743
|
+
:error_code,
|
744
|
+
:error_message)
|
745
|
+
SENSITIVE = []
|
746
|
+
include Aws::Structure
|
747
|
+
end
|
748
|
+
|
571
749
|
# @note When making an API call, you may pass BatchPutDocumentRequest
|
572
750
|
# data as a hash:
|
573
751
|
#
|
@@ -624,6 +802,13 @@ module Aws::Kendra
|
|
624
802
|
# @!attribute [rw] documents
|
625
803
|
# One or more documents to add to the index.
|
626
804
|
#
|
805
|
+
# Documents can include custom attributes. For example,
|
806
|
+
# 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
|
807
|
+
# that provide information on the synchronization of documents running
|
808
|
+
# on a data source. Note, 'DataSourceSyncJobId' could be an optional
|
809
|
+
# custom attribute as Amazon Kendra will use the ID of a running sync
|
810
|
+
# job.
|
811
|
+
#
|
627
812
|
# Documents have the following file size limits.
|
628
813
|
#
|
629
814
|
# * 5 MB total size for inline documents
|
@@ -697,8 +882,9 @@ module Aws::Kendra
|
|
697
882
|
include Aws::Structure
|
698
883
|
end
|
699
884
|
|
700
|
-
# Specifies capacity units configured for your index.
|
701
|
-
# remove capacity units to tune an index to your
|
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.
|
713
|
-
# unit provides 150
|
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
|
719
|
-
#
|
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,6 +928,26 @@ 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
952
|
# user. Your application uses the `SubmitFeedback` operation to provide
|
733
953
|
# click information.
|
@@ -1375,7 +1595,7 @@ module Aws::Kendra
|
|
1375
1595
|
# {
|
1376
1596
|
# name: "DataSourceName", # required
|
1377
1597
|
# index_id: "IndexId", # required
|
1378
|
-
# 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
|
1379
1599
|
# configuration: {
|
1380
1600
|
# s3_configuration: {
|
1381
1601
|
# bucket_name: "S3BucketName", # required
|
@@ -1390,7 +1610,7 @@ module Aws::Kendra
|
|
1390
1610
|
# },
|
1391
1611
|
# },
|
1392
1612
|
# share_point_configuration: {
|
1393
|
-
# share_point_version: "
|
1613
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
1394
1614
|
# urls: ["Url"], # required
|
1395
1615
|
# secret_arn: "SecretArn", # required
|
1396
1616
|
# crawl_attachments: false,
|
@@ -1410,6 +1630,10 @@ module Aws::Kendra
|
|
1410
1630
|
# ],
|
1411
1631
|
# document_title_field_name: "DataSourceFieldName",
|
1412
1632
|
# disable_local_groups: false,
|
1633
|
+
# ssl_certificate_s3_path: {
|
1634
|
+
# bucket: "S3BucketName", # required
|
1635
|
+
# key: "S3ObjectKey", # required
|
1636
|
+
# },
|
1413
1637
|
# },
|
1414
1638
|
# database_configuration: {
|
1415
1639
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -1638,6 +1862,37 @@ module Aws::Kendra
|
|
1638
1862
|
# exclude_user_accounts: ["UserAccount"],
|
1639
1863
|
# exclude_shared_drives: ["SharedDriveId"],
|
1640
1864
|
# },
|
1865
|
+
# web_crawler_configuration: {
|
1866
|
+
# urls: { # required
|
1867
|
+
# seed_url_configuration: {
|
1868
|
+
# seed_urls: ["SeedUrl"], # required
|
1869
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
1870
|
+
# },
|
1871
|
+
# site_maps_configuration: {
|
1872
|
+
# site_maps: ["SiteMap"], # required
|
1873
|
+
# },
|
1874
|
+
# },
|
1875
|
+
# crawl_depth: 1,
|
1876
|
+
# max_links_per_page: 1,
|
1877
|
+
# max_content_size_per_page_in_mega_bytes: 1.0,
|
1878
|
+
# max_urls_per_minute_crawl_rate: 1,
|
1879
|
+
# url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1880
|
+
# url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1881
|
+
# proxy_configuration: {
|
1882
|
+
# host: "Host", # required
|
1883
|
+
# port: 1, # required
|
1884
|
+
# credentials: "SecretArn",
|
1885
|
+
# },
|
1886
|
+
# authentication_configuration: {
|
1887
|
+
# basic_authentication: [
|
1888
|
+
# {
|
1889
|
+
# host: "Host", # required
|
1890
|
+
# port: 1, # required
|
1891
|
+
# credentials: "SecretArn", # required
|
1892
|
+
# },
|
1893
|
+
# ],
|
1894
|
+
# },
|
1895
|
+
# },
|
1641
1896
|
# },
|
1642
1897
|
# description: "Description",
|
1643
1898
|
# schedule: "ScanSchedule",
|
@@ -1991,6 +2246,110 @@ module Aws::Kendra
|
|
1991
2246
|
include Aws::Structure
|
1992
2247
|
end
|
1993
2248
|
|
2249
|
+
# @note When making an API call, you may pass CreateQuerySuggestionsBlockListRequest
|
2250
|
+
# data as a hash:
|
2251
|
+
#
|
2252
|
+
# {
|
2253
|
+
# index_id: "IndexId", # required
|
2254
|
+
# name: "QuerySuggestionsBlockListName", # required
|
2255
|
+
# description: "Description",
|
2256
|
+
# source_s3_path: { # required
|
2257
|
+
# bucket: "S3BucketName", # required
|
2258
|
+
# key: "S3ObjectKey", # required
|
2259
|
+
# },
|
2260
|
+
# client_token: "ClientTokenName",
|
2261
|
+
# role_arn: "RoleArn", # required
|
2262
|
+
# tags: [
|
2263
|
+
# {
|
2264
|
+
# key: "TagKey", # required
|
2265
|
+
# value: "TagValue", # required
|
2266
|
+
# },
|
2267
|
+
# ],
|
2268
|
+
# }
|
2269
|
+
#
|
2270
|
+
# @!attribute [rw] index_id
|
2271
|
+
# The identifier of the index you want to create a query suggestions
|
2272
|
+
# block list for.
|
2273
|
+
# @return [String]
|
2274
|
+
#
|
2275
|
+
# @!attribute [rw] name
|
2276
|
+
# A user friendly name for the block list.
|
2277
|
+
#
|
2278
|
+
# For example, the block list named 'offensive-words' includes all
|
2279
|
+
# offensive words that could appear in user queries and need to be
|
2280
|
+
# blocked from suggestions.
|
2281
|
+
# @return [String]
|
2282
|
+
#
|
2283
|
+
# @!attribute [rw] description
|
2284
|
+
# A user-friendly description for the block list.
|
2285
|
+
#
|
2286
|
+
# For example, the description "List of all offensive words that can
|
2287
|
+
# appear in user queries and need to be blocked from suggestions."
|
2288
|
+
# @return [String]
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] source_s3_path
|
2291
|
+
# The S3 path to your block list text file in your S3 bucket.
|
2292
|
+
#
|
2293
|
+
# Each block word or phrase should be on a separate line in a text
|
2294
|
+
# file.
|
2295
|
+
#
|
2296
|
+
# For information on the current quota limits for block lists, see
|
2297
|
+
# [Quotas for Amazon Kendra][1].
|
2298
|
+
#
|
2299
|
+
#
|
2300
|
+
#
|
2301
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
2302
|
+
# @return [Types::S3Path]
|
2303
|
+
#
|
2304
|
+
# @!attribute [rw] client_token
|
2305
|
+
# A token that you provide to identify the request to create a query
|
2306
|
+
# suggestions block list.
|
2307
|
+
#
|
2308
|
+
# **A suitable default value is auto-generated.** You should normally
|
2309
|
+
# not need to pass this option.
|
2310
|
+
# @return [String]
|
2311
|
+
#
|
2312
|
+
# @!attribute [rw] role_arn
|
2313
|
+
# The IAM (Identity and Access Management) role used by Amazon Kendra
|
2314
|
+
# to access the block list text file in your S3 bucket.
|
2315
|
+
#
|
2316
|
+
# You need permissions to the role ARN (Amazon Resource Name). The
|
2317
|
+
# role needs S3 read permissions to your file in S3 and needs to give
|
2318
|
+
# STS (Security Token Service) assume role permissions to Amazon
|
2319
|
+
# Kendra.
|
2320
|
+
# @return [String]
|
2321
|
+
#
|
2322
|
+
# @!attribute [rw] tags
|
2323
|
+
# A tag that you can assign to a block list that categorizes the block
|
2324
|
+
# list.
|
2325
|
+
# @return [Array<Types::Tag>]
|
2326
|
+
#
|
2327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation
|
2328
|
+
#
|
2329
|
+
class CreateQuerySuggestionsBlockListRequest < Struct.new(
|
2330
|
+
:index_id,
|
2331
|
+
:name,
|
2332
|
+
:description,
|
2333
|
+
:source_s3_path,
|
2334
|
+
:client_token,
|
2335
|
+
:role_arn,
|
2336
|
+
:tags)
|
2337
|
+
SENSITIVE = []
|
2338
|
+
include Aws::Structure
|
2339
|
+
end
|
2340
|
+
|
2341
|
+
# @!attribute [rw] id
|
2342
|
+
# The unique identifier of the created block list.
|
2343
|
+
# @return [String]
|
2344
|
+
#
|
2345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListResponse AWS API Documentation
|
2346
|
+
#
|
2347
|
+
class CreateQuerySuggestionsBlockListResponse < Struct.new(
|
2348
|
+
:id)
|
2349
|
+
SENSITIVE = []
|
2350
|
+
include Aws::Structure
|
2351
|
+
end
|
2352
|
+
|
1994
2353
|
# @note When making an API call, you may pass CreateThesaurusRequest
|
1995
2354
|
# data as a hash:
|
1996
2355
|
#
|
@@ -2094,7 +2453,7 @@ module Aws::Kendra
|
|
2094
2453
|
# },
|
2095
2454
|
# },
|
2096
2455
|
# share_point_configuration: {
|
2097
|
-
# share_point_version: "
|
2456
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
2098
2457
|
# urls: ["Url"], # required
|
2099
2458
|
# secret_arn: "SecretArn", # required
|
2100
2459
|
# crawl_attachments: false,
|
@@ -2114,6 +2473,10 @@ module Aws::Kendra
|
|
2114
2473
|
# ],
|
2115
2474
|
# document_title_field_name: "DataSourceFieldName",
|
2116
2475
|
# disable_local_groups: false,
|
2476
|
+
# ssl_certificate_s3_path: {
|
2477
|
+
# bucket: "S3BucketName", # required
|
2478
|
+
# key: "S3ObjectKey", # required
|
2479
|
+
# },
|
2117
2480
|
# },
|
2118
2481
|
# database_configuration: {
|
2119
2482
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -2342,6 +2705,37 @@ module Aws::Kendra
|
|
2342
2705
|
# exclude_user_accounts: ["UserAccount"],
|
2343
2706
|
# exclude_shared_drives: ["SharedDriveId"],
|
2344
2707
|
# },
|
2708
|
+
# web_crawler_configuration: {
|
2709
|
+
# urls: { # required
|
2710
|
+
# seed_url_configuration: {
|
2711
|
+
# seed_urls: ["SeedUrl"], # required
|
2712
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
2713
|
+
# },
|
2714
|
+
# site_maps_configuration: {
|
2715
|
+
# site_maps: ["SiteMap"], # required
|
2716
|
+
# },
|
2717
|
+
# },
|
2718
|
+
# crawl_depth: 1,
|
2719
|
+
# max_links_per_page: 1,
|
2720
|
+
# max_content_size_per_page_in_mega_bytes: 1.0,
|
2721
|
+
# max_urls_per_minute_crawl_rate: 1,
|
2722
|
+
# url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2723
|
+
# url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2724
|
+
# proxy_configuration: {
|
2725
|
+
# host: "Host", # required
|
2726
|
+
# port: 1, # required
|
2727
|
+
# credentials: "SecretArn",
|
2728
|
+
# },
|
2729
|
+
# authentication_configuration: {
|
2730
|
+
# basic_authentication: [
|
2731
|
+
# {
|
2732
|
+
# host: "Host", # required
|
2733
|
+
# port: 1, # required
|
2734
|
+
# credentials: "SecretArn", # required
|
2735
|
+
# },
|
2736
|
+
# ],
|
2737
|
+
# },
|
2738
|
+
# },
|
2345
2739
|
# }
|
2346
2740
|
#
|
2347
2741
|
# @!attribute [rw] s3_configuration
|
@@ -2384,6 +2778,11 @@ module Aws::Kendra
|
|
2384
2778
|
# Drive.
|
2385
2779
|
# @return [Types::GoogleDriveConfiguration]
|
2386
2780
|
#
|
2781
|
+
# @!attribute [rw] web_crawler_configuration
|
2782
|
+
# Provides the configuration information required for Amazon Kendra
|
2783
|
+
# web crawler.
|
2784
|
+
# @return [Types::WebCrawlerConfiguration]
|
2785
|
+
#
|
2387
2786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
2388
2787
|
#
|
2389
2788
|
class DataSourceConfiguration < Struct.new(
|
@@ -2394,7 +2793,8 @@ module Aws::Kendra
|
|
2394
2793
|
:one_drive_configuration,
|
2395
2794
|
:service_now_configuration,
|
2396
2795
|
:confluence_configuration,
|
2397
|
-
:google_drive_configuration
|
2796
|
+
:google_drive_configuration,
|
2797
|
+
:web_crawler_configuration)
|
2398
2798
|
SENSITIVE = []
|
2399
2799
|
include Aws::Structure
|
2400
2800
|
end
|
@@ -2506,7 +2906,7 @@ module Aws::Kendra
|
|
2506
2906
|
#
|
2507
2907
|
# {
|
2508
2908
|
# data_source_id: "DataSourceId", # required
|
2509
|
-
# data_source_sync_job_id: "DataSourceSyncJobId",
|
2909
|
+
# data_source_sync_job_id: "DataSourceSyncJobId",
|
2510
2910
|
# }
|
2511
2911
|
#
|
2512
2912
|
# @!attribute [rw] data_source_id
|
@@ -2515,6 +2915,15 @@ module Aws::Kendra
|
|
2515
2915
|
#
|
2516
2916
|
# @!attribute [rw] data_source_sync_job_id
|
2517
2917
|
# The ID of the sync job that is running on the data source.
|
2918
|
+
#
|
2919
|
+
# If the ID of a sync job is not provided and there is a sync job
|
2920
|
+
# running, then the ID of this sync job is used and metrics are
|
2921
|
+
# generated for this sync job.
|
2922
|
+
#
|
2923
|
+
# If the ID of a sync job is not provided and there is no sync job
|
2924
|
+
# running, then no metrics are generated and documents are
|
2925
|
+
# indexed/deleted at the index level without sync job metrics
|
2926
|
+
# included.
|
2518
2927
|
# @return [String]
|
2519
2928
|
#
|
2520
2929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
|
@@ -2781,6 +3190,31 @@ module Aws::Kendra
|
|
2781
3190
|
include Aws::Structure
|
2782
3191
|
end
|
2783
3192
|
|
3193
|
+
# @note When making an API call, you may pass DeleteQuerySuggestionsBlockListRequest
|
3194
|
+
# data as a hash:
|
3195
|
+
#
|
3196
|
+
# {
|
3197
|
+
# index_id: "IndexId", # required
|
3198
|
+
# id: "QuerySuggestionsBlockListId", # required
|
3199
|
+
# }
|
3200
|
+
#
|
3201
|
+
# @!attribute [rw] index_id
|
3202
|
+
# The identifier of the you want to delete a block list from.
|
3203
|
+
# @return [String]
|
3204
|
+
#
|
3205
|
+
# @!attribute [rw] id
|
3206
|
+
# The unique identifier of the block list that needs to be deleted.
|
3207
|
+
# @return [String]
|
3208
|
+
#
|
3209
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
|
3210
|
+
#
|
3211
|
+
class DeleteQuerySuggestionsBlockListRequest < Struct.new(
|
3212
|
+
:index_id,
|
3213
|
+
:id)
|
3214
|
+
SENSITIVE = []
|
3215
|
+
include Aws::Structure
|
3216
|
+
end
|
3217
|
+
|
2784
3218
|
# @note When making an API call, you may pass DeleteThesaurusRequest
|
2785
3219
|
# data as a hash:
|
2786
3220
|
#
|
@@ -3109,34 +3543,246 @@ module Aws::Kendra
|
|
3109
3543
|
include Aws::Structure
|
3110
3544
|
end
|
3111
3545
|
|
3112
|
-
# @note When making an API call, you may pass
|
3546
|
+
# @note When making an API call, you may pass DescribeQuerySuggestionsBlockListRequest
|
3113
3547
|
# data as a hash:
|
3114
3548
|
#
|
3115
3549
|
# {
|
3116
|
-
# id: "ThesaurusId", # required
|
3117
3550
|
# index_id: "IndexId", # required
|
3551
|
+
# id: "QuerySuggestionsBlockListId", # required
|
3118
3552
|
# }
|
3119
3553
|
#
|
3120
|
-
# @!attribute [rw]
|
3121
|
-
# The identifier of the
|
3554
|
+
# @!attribute [rw] index_id
|
3555
|
+
# The identifier of the index for the block list.
|
3122
3556
|
# @return [String]
|
3123
3557
|
#
|
3124
|
-
# @!attribute [rw]
|
3125
|
-
# The identifier of the
|
3126
|
-
# describe.
|
3558
|
+
# @!attribute [rw] id
|
3559
|
+
# The unique identifier of the block list.
|
3127
3560
|
# @return [String]
|
3128
3561
|
#
|
3129
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/
|
3562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
|
3130
3563
|
#
|
3131
|
-
class
|
3132
|
-
:
|
3133
|
-
:
|
3564
|
+
class DescribeQuerySuggestionsBlockListRequest < Struct.new(
|
3565
|
+
:index_id,
|
3566
|
+
:id)
|
3134
3567
|
SENSITIVE = []
|
3135
3568
|
include Aws::Structure
|
3136
3569
|
end
|
3137
3570
|
|
3571
|
+
# @!attribute [rw] index_id
|
3572
|
+
# Shows the identifier of the index for the block list.
|
3573
|
+
# @return [String]
|
3574
|
+
#
|
3138
3575
|
# @!attribute [rw] id
|
3139
|
-
#
|
3576
|
+
# Shows the unique identifier of the block list.
|
3577
|
+
# @return [String]
|
3578
|
+
#
|
3579
|
+
# @!attribute [rw] name
|
3580
|
+
# Shows the name of the block list.
|
3581
|
+
# @return [String]
|
3582
|
+
#
|
3583
|
+
# @!attribute [rw] description
|
3584
|
+
# Shows the description for the block list.
|
3585
|
+
# @return [String]
|
3586
|
+
#
|
3587
|
+
# @!attribute [rw] status
|
3588
|
+
# Shows whether the current status of the block list is `ACTIVE` or
|
3589
|
+
# `INACTIVE`.
|
3590
|
+
# @return [String]
|
3591
|
+
#
|
3592
|
+
# @!attribute [rw] error_message
|
3593
|
+
# Shows the error message with details when there are issues in
|
3594
|
+
# processing the block list.
|
3595
|
+
# @return [String]
|
3596
|
+
#
|
3597
|
+
# @!attribute [rw] created_at
|
3598
|
+
# Shows the date-time a block list for query suggestions was last
|
3599
|
+
# created.
|
3600
|
+
# @return [Time]
|
3601
|
+
#
|
3602
|
+
# @!attribute [rw] updated_at
|
3603
|
+
# Shows the date-time a block list for query suggestions was last
|
3604
|
+
# updated.
|
3605
|
+
# @return [Time]
|
3606
|
+
#
|
3607
|
+
# @!attribute [rw] source_s3_path
|
3608
|
+
# Shows the current S3 path to your block list text file in your S3
|
3609
|
+
# bucket.
|
3610
|
+
#
|
3611
|
+
# Each block word or phrase should be on a separate line in a text
|
3612
|
+
# file.
|
3613
|
+
#
|
3614
|
+
# For information on the current quota limits for block lists, see
|
3615
|
+
# [Quotas for Amazon Kendra][1].
|
3616
|
+
#
|
3617
|
+
#
|
3618
|
+
#
|
3619
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
3620
|
+
# @return [Types::S3Path]
|
3621
|
+
#
|
3622
|
+
# @!attribute [rw] item_count
|
3623
|
+
# Shows the current number of valid, non-empty words or phrases in the
|
3624
|
+
# block list text file.
|
3625
|
+
# @return [Integer]
|
3626
|
+
#
|
3627
|
+
# @!attribute [rw] file_size_bytes
|
3628
|
+
# Shows the current size of the block list text file in S3.
|
3629
|
+
# @return [Integer]
|
3630
|
+
#
|
3631
|
+
# @!attribute [rw] role_arn
|
3632
|
+
# Shows the current IAM (Identity and Access Management) role used by
|
3633
|
+
# Amazon Kendra to access the block list text file in S3.
|
3634
|
+
#
|
3635
|
+
# The role needs S3 read permissions to your file in S3 and needs to
|
3636
|
+
# give STS (Security Token Service) assume role permissions to Amazon
|
3637
|
+
# Kendra.
|
3638
|
+
# @return [String]
|
3639
|
+
#
|
3640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListResponse AWS API Documentation
|
3641
|
+
#
|
3642
|
+
class DescribeQuerySuggestionsBlockListResponse < Struct.new(
|
3643
|
+
:index_id,
|
3644
|
+
:id,
|
3645
|
+
:name,
|
3646
|
+
:description,
|
3647
|
+
:status,
|
3648
|
+
:error_message,
|
3649
|
+
:created_at,
|
3650
|
+
:updated_at,
|
3651
|
+
:source_s3_path,
|
3652
|
+
:item_count,
|
3653
|
+
:file_size_bytes,
|
3654
|
+
:role_arn)
|
3655
|
+
SENSITIVE = []
|
3656
|
+
include Aws::Structure
|
3657
|
+
end
|
3658
|
+
|
3659
|
+
# @note When making an API call, you may pass DescribeQuerySuggestionsConfigRequest
|
3660
|
+
# data as a hash:
|
3661
|
+
#
|
3662
|
+
# {
|
3663
|
+
# index_id: "IndexId", # required
|
3664
|
+
# }
|
3665
|
+
#
|
3666
|
+
# @!attribute [rw] index_id
|
3667
|
+
# The identifier of the index you want to describe query suggestions
|
3668
|
+
# settings for.
|
3669
|
+
# @return [String]
|
3670
|
+
#
|
3671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
|
3672
|
+
#
|
3673
|
+
class DescribeQuerySuggestionsConfigRequest < Struct.new(
|
3674
|
+
:index_id)
|
3675
|
+
SENSITIVE = []
|
3676
|
+
include Aws::Structure
|
3677
|
+
end
|
3678
|
+
|
3679
|
+
# @!attribute [rw] mode
|
3680
|
+
# Shows whether query suggestions are currently in `ENABLED` mode or
|
3681
|
+
# `LEARN_ONLY` mode.
|
3682
|
+
#
|
3683
|
+
# By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
|
3684
|
+
# turns off query suggestions for your users. You can change the mode
|
3685
|
+
# using the [UpdateQuerySuggestionsConfig][1] operation.
|
3686
|
+
#
|
3687
|
+
#
|
3688
|
+
#
|
3689
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
|
3690
|
+
# @return [String]
|
3691
|
+
#
|
3692
|
+
# @!attribute [rw] status
|
3693
|
+
# Shows whether the status of query suggestions settings is currently
|
3694
|
+
# Active or Updating.
|
3695
|
+
#
|
3696
|
+
# Active means the current settings apply and Updating means your
|
3697
|
+
# changed settings are in the process of applying.
|
3698
|
+
# @return [String]
|
3699
|
+
#
|
3700
|
+
# @!attribute [rw] query_log_look_back_window_in_days
|
3701
|
+
# Shows how recent your queries are in your query log time window (in
|
3702
|
+
# days).
|
3703
|
+
# @return [Integer]
|
3704
|
+
#
|
3705
|
+
# @!attribute [rw] include_queries_without_user_information
|
3706
|
+
# Shows whether Amazon Kendra uses all queries or only uses queries
|
3707
|
+
# that include user information to generate query suggestions.
|
3708
|
+
# @return [Boolean]
|
3709
|
+
#
|
3710
|
+
# @!attribute [rw] minimum_number_of_querying_users
|
3711
|
+
# Shows the minimum number of unique users who must search a query in
|
3712
|
+
# order for the query to be eligible to suggest to your users.
|
3713
|
+
# @return [Integer]
|
3714
|
+
#
|
3715
|
+
# @!attribute [rw] minimum_query_count
|
3716
|
+
# Shows the minimum number of times a query must be searched in order
|
3717
|
+
# for the query to be eligible to suggest to your users.
|
3718
|
+
# @return [Integer]
|
3719
|
+
#
|
3720
|
+
# @!attribute [rw] last_suggestions_build_time
|
3721
|
+
# Shows the date-time query suggestions for an index was last updated.
|
3722
|
+
# @return [Time]
|
3723
|
+
#
|
3724
|
+
# @!attribute [rw] last_clear_time
|
3725
|
+
# Shows the date-time query suggestions for an index was last cleared.
|
3726
|
+
#
|
3727
|
+
# After you clear suggestions, Amazon Kendra learns new suggestions
|
3728
|
+
# based on new queries added to the query log from the time you
|
3729
|
+
# cleared suggestions. Amazon Kendra only considers re-occurences of a
|
3730
|
+
# query from the time you cleared suggestions.
|
3731
|
+
# @return [Time]
|
3732
|
+
#
|
3733
|
+
# @!attribute [rw] total_suggestions_count
|
3734
|
+
# Shows the current total count of query suggestions for an index.
|
3735
|
+
#
|
3736
|
+
# This count can change when you update your query suggestions
|
3737
|
+
# settings, if you filter out certain queries from suggestions using a
|
3738
|
+
# block list, and as the query log accumulates more queries for Amazon
|
3739
|
+
# Kendra to learn from.
|
3740
|
+
# @return [Integer]
|
3741
|
+
#
|
3742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigResponse AWS API Documentation
|
3743
|
+
#
|
3744
|
+
class DescribeQuerySuggestionsConfigResponse < Struct.new(
|
3745
|
+
:mode,
|
3746
|
+
:status,
|
3747
|
+
:query_log_look_back_window_in_days,
|
3748
|
+
:include_queries_without_user_information,
|
3749
|
+
:minimum_number_of_querying_users,
|
3750
|
+
:minimum_query_count,
|
3751
|
+
:last_suggestions_build_time,
|
3752
|
+
:last_clear_time,
|
3753
|
+
:total_suggestions_count)
|
3754
|
+
SENSITIVE = []
|
3755
|
+
include Aws::Structure
|
3756
|
+
end
|
3757
|
+
|
3758
|
+
# @note When making an API call, you may pass DescribeThesaurusRequest
|
3759
|
+
# data as a hash:
|
3760
|
+
#
|
3761
|
+
# {
|
3762
|
+
# id: "ThesaurusId", # required
|
3763
|
+
# index_id: "IndexId", # required
|
3764
|
+
# }
|
3765
|
+
#
|
3766
|
+
# @!attribute [rw] id
|
3767
|
+
# The identifier of the thesaurus to describe.
|
3768
|
+
# @return [String]
|
3769
|
+
#
|
3770
|
+
# @!attribute [rw] index_id
|
3771
|
+
# The identifier of the index associated with the thesaurus to
|
3772
|
+
# describe.
|
3773
|
+
# @return [String]
|
3774
|
+
#
|
3775
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
|
3776
|
+
#
|
3777
|
+
class DescribeThesaurusRequest < Struct.new(
|
3778
|
+
:id,
|
3779
|
+
:index_id)
|
3780
|
+
SENSITIVE = []
|
3781
|
+
include Aws::Structure
|
3782
|
+
end
|
3783
|
+
|
3784
|
+
# @!attribute [rw] id
|
3785
|
+
# The identifier of the thesaurus.
|
3140
3786
|
# @return [String]
|
3141
3787
|
#
|
3142
3788
|
# @!attribute [rw] index_id
|
@@ -3362,6 +4008,11 @@ module Aws::Kendra
|
|
3362
4008
|
#
|
3363
4009
|
# @!attribute [rw] date_value
|
3364
4010
|
# A date expressed as an ISO 8601 string.
|
4011
|
+
#
|
4012
|
+
# It is important for the time zone to be included in the ISO 8601
|
4013
|
+
# date-time format. For example, 20120325T123010+01:00 is the ISO 8601
|
4014
|
+
# date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in
|
4015
|
+
# Central European Time.
|
3365
4016
|
# @return [Time]
|
3366
4017
|
#
|
3367
4018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
|
@@ -3396,6 +4047,61 @@ module Aws::Kendra
|
|
3396
4047
|
include Aws::Structure
|
3397
4048
|
end
|
3398
4049
|
|
4050
|
+
# Identifies a document for which to retrieve status information
|
4051
|
+
#
|
4052
|
+
# @note When making an API call, you may pass DocumentInfo
|
4053
|
+
# data as a hash:
|
4054
|
+
#
|
4055
|
+
# {
|
4056
|
+
# document_id: "DocumentId", # required
|
4057
|
+
# attributes: [
|
4058
|
+
# {
|
4059
|
+
# key: "DocumentAttributeKey", # required
|
4060
|
+
# value: { # required
|
4061
|
+
# string_value: "DocumentAttributeStringValue",
|
4062
|
+
# string_list_value: ["String"],
|
4063
|
+
# long_value: 1,
|
4064
|
+
# date_value: Time.now,
|
4065
|
+
# },
|
4066
|
+
# },
|
4067
|
+
# ],
|
4068
|
+
# }
|
4069
|
+
#
|
4070
|
+
# @!attribute [rw] document_id
|
4071
|
+
# The unique identifier of the document.
|
4072
|
+
# @return [String]
|
4073
|
+
#
|
4074
|
+
# @!attribute [rw] attributes
|
4075
|
+
# Attributes that identify a specific version of a document to check.
|
4076
|
+
#
|
4077
|
+
# The only valid attributes are:
|
4078
|
+
#
|
4079
|
+
# * version
|
4080
|
+
#
|
4081
|
+
# * datasourceId
|
4082
|
+
#
|
4083
|
+
# * jobExecutionId
|
4084
|
+
#
|
4085
|
+
# The attributes follow these rules:
|
4086
|
+
#
|
4087
|
+
# * `dataSourceId` and `jobExecutionId` must be used together.
|
4088
|
+
#
|
4089
|
+
# * `version` is ignored if `dataSourceId` and `jobExecutionId` are
|
4090
|
+
# not provided.
|
4091
|
+
#
|
4092
|
+
# * If `dataSourceId` and `jobExecutionId` are provided, but `version`
|
4093
|
+
# is not, the version defaults to "0".
|
4094
|
+
# @return [Array<Types::DocumentAttribute>]
|
4095
|
+
#
|
4096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentInfo AWS API Documentation
|
4097
|
+
#
|
4098
|
+
class DocumentInfo < Struct.new(
|
4099
|
+
:document_id,
|
4100
|
+
:attributes)
|
4101
|
+
SENSITIVE = []
|
4102
|
+
include Aws::Structure
|
4103
|
+
end
|
4104
|
+
|
3399
4105
|
# Specifies the properties of a custom index field.
|
3400
4106
|
#
|
3401
4107
|
# @note When making an API call, you may pass DocumentMetadataConfiguration
|
@@ -3449,6 +4155,45 @@ module Aws::Kendra
|
|
3449
4155
|
include Aws::Structure
|
3450
4156
|
end
|
3451
4157
|
|
4158
|
+
# Overrides the document relevance properties of a custom index field.
|
4159
|
+
#
|
4160
|
+
# @note When making an API call, you may pass DocumentRelevanceConfiguration
|
4161
|
+
# data as a hash:
|
4162
|
+
#
|
4163
|
+
# {
|
4164
|
+
# name: "DocumentMetadataConfigurationName", # required
|
4165
|
+
# relevance: { # required
|
4166
|
+
# freshness: false,
|
4167
|
+
# importance: 1,
|
4168
|
+
# duration: "Duration",
|
4169
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4170
|
+
# value_importance_map: {
|
4171
|
+
# "ValueImportanceMapKey" => 1,
|
4172
|
+
# },
|
4173
|
+
# },
|
4174
|
+
# }
|
4175
|
+
#
|
4176
|
+
# @!attribute [rw] name
|
4177
|
+
# The name of the tuning configuration to override document relevance
|
4178
|
+
# at the index level.
|
4179
|
+
# @return [String]
|
4180
|
+
#
|
4181
|
+
# @!attribute [rw] relevance
|
4182
|
+
# Provides information for manually tuning the relevance of a field in
|
4183
|
+
# a search. When a query includes terms that match the field, the
|
4184
|
+
# results are given a boost in the response based on these tuning
|
4185
|
+
# parameters.
|
4186
|
+
# @return [Types::Relevance]
|
4187
|
+
#
|
4188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentRelevanceConfiguration AWS API Documentation
|
4189
|
+
#
|
4190
|
+
class DocumentRelevanceConfiguration < Struct.new(
|
4191
|
+
:name,
|
4192
|
+
:relevance)
|
4193
|
+
SENSITIVE = []
|
4194
|
+
include Aws::Structure
|
4195
|
+
end
|
4196
|
+
|
3452
4197
|
# Document metadata files that contain information such as the document
|
3453
4198
|
# access control information, source URI, document author, and custom
|
3454
4199
|
# attributes. Each metadata file contains metadata about a single
|
@@ -3582,6 +4327,63 @@ module Aws::Kendra
|
|
3582
4327
|
include Aws::Structure
|
3583
4328
|
end
|
3584
4329
|
|
4330
|
+
# @note When making an API call, you may pass GetQuerySuggestionsRequest
|
4331
|
+
# data as a hash:
|
4332
|
+
#
|
4333
|
+
# {
|
4334
|
+
# index_id: "IndexId", # required
|
4335
|
+
# query_text: "SuggestionQueryText", # required
|
4336
|
+
# max_suggestions_count: 1,
|
4337
|
+
# }
|
4338
|
+
#
|
4339
|
+
# @!attribute [rw] index_id
|
4340
|
+
# The identifier of the index you want to get query suggestions from.
|
4341
|
+
# @return [String]
|
4342
|
+
#
|
4343
|
+
# @!attribute [rw] query_text
|
4344
|
+
# The text of a user's query to generate query suggestions.
|
4345
|
+
#
|
4346
|
+
# A query is suggested if the query prefix matches what a user starts
|
4347
|
+
# to type as their query.
|
4348
|
+
#
|
4349
|
+
# Amazon Kendra does not show any suggestions if a user types fewer
|
4350
|
+
# than two characters or more than 60 characters. A query must also
|
4351
|
+
# have at least one search result and contain at least one word of
|
4352
|
+
# more than four characters.
|
4353
|
+
# @return [String]
|
4354
|
+
#
|
4355
|
+
# @!attribute [rw] max_suggestions_count
|
4356
|
+
# The maximum number of query suggestions you want to show to your
|
4357
|
+
# users.
|
4358
|
+
# @return [Integer]
|
4359
|
+
#
|
4360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsRequest AWS API Documentation
|
4361
|
+
#
|
4362
|
+
class GetQuerySuggestionsRequest < Struct.new(
|
4363
|
+
:index_id,
|
4364
|
+
:query_text,
|
4365
|
+
:max_suggestions_count)
|
4366
|
+
SENSITIVE = []
|
4367
|
+
include Aws::Structure
|
4368
|
+
end
|
4369
|
+
|
4370
|
+
# @!attribute [rw] query_suggestions_id
|
4371
|
+
# The unique identifier for a list of query suggestions for an index.
|
4372
|
+
# @return [String]
|
4373
|
+
#
|
4374
|
+
# @!attribute [rw] suggestions
|
4375
|
+
# A list of query suggestions for an index.
|
4376
|
+
# @return [Array<Types::Suggestion>]
|
4377
|
+
#
|
4378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsResponse AWS API Documentation
|
4379
|
+
#
|
4380
|
+
class GetQuerySuggestionsResponse < Struct.new(
|
4381
|
+
:query_suggestions_id,
|
4382
|
+
:suggestions)
|
4383
|
+
SENSITIVE = []
|
4384
|
+
include Aws::Structure
|
4385
|
+
end
|
4386
|
+
|
3585
4387
|
# Provides configuration information for data sources that connect to
|
3586
4388
|
# Google Drive.
|
3587
4389
|
#
|
@@ -4106,22 +4908,94 @@ module Aws::Kendra
|
|
4106
4908
|
include Aws::Structure
|
4107
4909
|
end
|
4108
4910
|
|
4109
|
-
# @note When making an API call, you may pass
|
4911
|
+
# @note When making an API call, you may pass ListQuerySuggestionsBlockListsRequest
|
4110
4912
|
# data as a hash:
|
4111
4913
|
#
|
4112
4914
|
# {
|
4113
|
-
#
|
4915
|
+
# index_id: "IndexId", # required
|
4916
|
+
# next_token: "NextToken",
|
4917
|
+
# max_results: 1,
|
4114
4918
|
# }
|
4115
4919
|
#
|
4116
|
-
# @!attribute [rw]
|
4117
|
-
# The
|
4118
|
-
#
|
4920
|
+
# @!attribute [rw] index_id
|
4921
|
+
# The identifier of the index for a list of all block lists that exist
|
4922
|
+
# for that index.
|
4923
|
+
#
|
4924
|
+
# For information on the current quota limits for block lists, see
|
4925
|
+
# [Quotas for Amazon Kendra][1].
|
4926
|
+
#
|
4927
|
+
#
|
4928
|
+
#
|
4929
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
4119
4930
|
# @return [String]
|
4120
4931
|
#
|
4121
|
-
#
|
4932
|
+
# @!attribute [rw] next_token
|
4933
|
+
# If the previous response was incomplete (because there is more data
|
4934
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
4935
|
+
# response. You can use this pagination token to retrieve the next set
|
4936
|
+
# of block lists (`BlockListSummaryItems`).
|
4937
|
+
# @return [String]
|
4122
4938
|
#
|
4123
|
-
|
4124
|
-
|
4939
|
+
# @!attribute [rw] max_results
|
4940
|
+
# The maximum number of block lists to return.
|
4941
|
+
# @return [Integer]
|
4942
|
+
#
|
4943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsRequest AWS API Documentation
|
4944
|
+
#
|
4945
|
+
class ListQuerySuggestionsBlockListsRequest < Struct.new(
|
4946
|
+
:index_id,
|
4947
|
+
:next_token,
|
4948
|
+
:max_results)
|
4949
|
+
SENSITIVE = []
|
4950
|
+
include Aws::Structure
|
4951
|
+
end
|
4952
|
+
|
4953
|
+
# @!attribute [rw] block_list_summary_items
|
4954
|
+
# Summary items for a block list.
|
4955
|
+
#
|
4956
|
+
# This includes summary items on the block list ID, block list name,
|
4957
|
+
# when the block list was created, when the block list was last
|
4958
|
+
# updated, and the count of block words/phrases in the block list.
|
4959
|
+
#
|
4960
|
+
# For information on the current quota limits for block lists, see
|
4961
|
+
# [Quotas for Amazon Kendra][1].
|
4962
|
+
#
|
4963
|
+
#
|
4964
|
+
#
|
4965
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
4966
|
+
# @return [Array<Types::QuerySuggestionsBlockListSummary>]
|
4967
|
+
#
|
4968
|
+
# @!attribute [rw] next_token
|
4969
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
4970
|
+
# you can use in the subsequent request to retrieve the next set of
|
4971
|
+
# block lists.
|
4972
|
+
# @return [String]
|
4973
|
+
#
|
4974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsResponse AWS API Documentation
|
4975
|
+
#
|
4976
|
+
class ListQuerySuggestionsBlockListsResponse < Struct.new(
|
4977
|
+
:block_list_summary_items,
|
4978
|
+
:next_token)
|
4979
|
+
SENSITIVE = []
|
4980
|
+
include Aws::Structure
|
4981
|
+
end
|
4982
|
+
|
4983
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
4984
|
+
# data as a hash:
|
4985
|
+
#
|
4986
|
+
# {
|
4987
|
+
# resource_arn: "AmazonResourceName", # required
|
4988
|
+
# }
|
4989
|
+
#
|
4990
|
+
# @!attribute [rw] resource_arn
|
4991
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
4992
|
+
# get a list of tags for.
|
4993
|
+
# @return [String]
|
4994
|
+
#
|
4995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceRequest AWS API Documentation
|
4996
|
+
#
|
4997
|
+
class ListTagsForResourceRequest < Struct.new(
|
4998
|
+
:resource_arn)
|
4125
4999
|
SENSITIVE = []
|
4126
5000
|
include Aws::Structure
|
4127
5001
|
end
|
@@ -4346,6 +5220,57 @@ module Aws::Kendra
|
|
4346
5220
|
include Aws::Structure
|
4347
5221
|
end
|
4348
5222
|
|
5223
|
+
# Provides the configuration information for a web proxy to connect to
|
5224
|
+
# website hosts.
|
5225
|
+
#
|
5226
|
+
# @note When making an API call, you may pass ProxyConfiguration
|
5227
|
+
# data as a hash:
|
5228
|
+
#
|
5229
|
+
# {
|
5230
|
+
# host: "Host", # required
|
5231
|
+
# port: 1, # required
|
5232
|
+
# credentials: "SecretArn",
|
5233
|
+
# }
|
5234
|
+
#
|
5235
|
+
# @!attribute [rw] host
|
5236
|
+
# The name of the website host you want to connect to via a web proxy
|
5237
|
+
# server.
|
5238
|
+
#
|
5239
|
+
# For example, the host name of https://a.example.com/page1.html is
|
5240
|
+
# "a.example.com".
|
5241
|
+
# @return [String]
|
5242
|
+
#
|
5243
|
+
# @!attribute [rw] port
|
5244
|
+
# The port number of the website host you want to connect to via a web
|
5245
|
+
# proxy server.
|
5246
|
+
#
|
5247
|
+
# For example, the port for https://a.example.com/page1.html is 443,
|
5248
|
+
# the standard port for HTTPS.
|
5249
|
+
# @return [Integer]
|
5250
|
+
#
|
5251
|
+
# @!attribute [rw] credentials
|
5252
|
+
# Your secret ARN, which you can create in [AWS Secrets Manager][1]
|
5253
|
+
#
|
5254
|
+
# The credentials are optional. You use a secret if web proxy
|
5255
|
+
# credentials are required to connect to a website host. Amazon Kendra
|
5256
|
+
# currently support basic authentication to connect to a web proxy
|
5257
|
+
# server. The secret stores your credentials.
|
5258
|
+
#
|
5259
|
+
#
|
5260
|
+
#
|
5261
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
|
5262
|
+
# @return [String]
|
5263
|
+
#
|
5264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ProxyConfiguration AWS API Documentation
|
5265
|
+
#
|
5266
|
+
class ProxyConfiguration < Struct.new(
|
5267
|
+
:host,
|
5268
|
+
:port,
|
5269
|
+
:credentials)
|
5270
|
+
SENSITIVE = []
|
5271
|
+
include Aws::Structure
|
5272
|
+
end
|
5273
|
+
|
4349
5274
|
# @note When making an API call, you may pass QueryRequest
|
4350
5275
|
# data as a hash:
|
4351
5276
|
#
|
@@ -4437,6 +5362,20 @@ module Aws::Kendra
|
|
4437
5362
|
# ],
|
4438
5363
|
# requested_document_attributes: ["DocumentAttributeKey"],
|
4439
5364
|
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
5365
|
+
# document_relevance_override_configurations: [
|
5366
|
+
# {
|
5367
|
+
# name: "DocumentMetadataConfigurationName", # required
|
5368
|
+
# relevance: { # required
|
5369
|
+
# freshness: false,
|
5370
|
+
# importance: 1,
|
5371
|
+
# duration: "Duration",
|
5372
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
5373
|
+
# value_importance_map: {
|
5374
|
+
# "ValueImportanceMapKey" => 1,
|
5375
|
+
# },
|
5376
|
+
# },
|
5377
|
+
# },
|
5378
|
+
# ],
|
4440
5379
|
# page_number: 1,
|
4441
5380
|
# page_size: 1,
|
4442
5381
|
# sorting_configuration: {
|
@@ -4486,6 +5425,25 @@ module Aws::Kendra
|
|
4486
5425
|
# are returned.
|
4487
5426
|
# @return [String]
|
4488
5427
|
#
|
5428
|
+
# @!attribute [rw] document_relevance_override_configurations
|
5429
|
+
# Overrides relevance tuning configurations of fields or attributes
|
5430
|
+
# set at the index level.
|
5431
|
+
#
|
5432
|
+
# If you use this API to override the relevance tuning configured at
|
5433
|
+
# the index level, but there is no relevance tuning configured at the
|
5434
|
+
# index level, then Amazon Kendra does not apply any relevance tuning.
|
5435
|
+
#
|
5436
|
+
# If there is relevance tuning configured at the index level, but you
|
5437
|
+
# do not use this API to override any relevance tuning in the index,
|
5438
|
+
# then Amazon Kendra uses the relevance tuning that is configured at
|
5439
|
+
# the index level.
|
5440
|
+
#
|
5441
|
+
# If there is relevance tuning configured for fields at the index
|
5442
|
+
# level, but you use this API to override only some of these fields,
|
5443
|
+
# then for the fields you did not override, the importance is set to
|
5444
|
+
# 1.
|
5445
|
+
# @return [Array<Types::DocumentRelevanceConfiguration>]
|
5446
|
+
#
|
4489
5447
|
# @!attribute [rw] page_number
|
4490
5448
|
# Query results are returned in pages the size of the `PageSize`
|
4491
5449
|
# parameter. By default, Amazon Kendra returns the first page of
|
@@ -4530,6 +5488,7 @@ module Aws::Kendra
|
|
4530
5488
|
:facets,
|
4531
5489
|
:requested_document_attributes,
|
4532
5490
|
:query_result_type_filter,
|
5491
|
+
:document_relevance_override_configurations,
|
4533
5492
|
:page_number,
|
4534
5493
|
:page_size,
|
4535
5494
|
:sorting_configuration,
|
@@ -4653,6 +5612,57 @@ module Aws::Kendra
|
|
4653
5612
|
include Aws::Structure
|
4654
5613
|
end
|
4655
5614
|
|
5615
|
+
# Summary information on a query suggestions block list.
|
5616
|
+
#
|
5617
|
+
# This includes information on the block list ID, block list name, when
|
5618
|
+
# the block list was created, when the block list was last updated, and
|
5619
|
+
# the count of block words/phrases in the block list.
|
5620
|
+
#
|
5621
|
+
# For information on the current quota limits for block lists, see
|
5622
|
+
# [Quotas for Amazon Kendra][1].
|
5623
|
+
#
|
5624
|
+
#
|
5625
|
+
#
|
5626
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
5627
|
+
#
|
5628
|
+
# @!attribute [rw] id
|
5629
|
+
# The identifier of a block list.
|
5630
|
+
# @return [String]
|
5631
|
+
#
|
5632
|
+
# @!attribute [rw] name
|
5633
|
+
# The name of the block list.
|
5634
|
+
# @return [String]
|
5635
|
+
#
|
5636
|
+
# @!attribute [rw] status
|
5637
|
+
# The status of the block list.
|
5638
|
+
# @return [String]
|
5639
|
+
#
|
5640
|
+
# @!attribute [rw] created_at
|
5641
|
+
# The date-time summary information for a query suggestions block list
|
5642
|
+
# was last created.
|
5643
|
+
# @return [Time]
|
5644
|
+
#
|
5645
|
+
# @!attribute [rw] updated_at
|
5646
|
+
# The date-time the block list was last updated.
|
5647
|
+
# @return [Time]
|
5648
|
+
#
|
5649
|
+
# @!attribute [rw] item_count
|
5650
|
+
# The number of items in the block list file.
|
5651
|
+
# @return [Integer]
|
5652
|
+
#
|
5653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuerySuggestionsBlockListSummary AWS API Documentation
|
5654
|
+
#
|
5655
|
+
class QuerySuggestionsBlockListSummary < Struct.new(
|
5656
|
+
:id,
|
5657
|
+
:name,
|
5658
|
+
:status,
|
5659
|
+
:created_at,
|
5660
|
+
:updated_at,
|
5661
|
+
:item_count)
|
5662
|
+
SENSITIVE = []
|
5663
|
+
include Aws::Structure
|
5664
|
+
end
|
5665
|
+
|
4656
5666
|
# Provides information for manually tuning the relevance of a field in a
|
4657
5667
|
# search. When a query includes terms that match the field, the results
|
4658
5668
|
# are given a boost in the response based on these tuning parameters.
|
@@ -4843,12 +5853,21 @@ module Aws::Kendra
|
|
4843
5853
|
# document that matches an inclusion pattern also matches an exclusion
|
4844
5854
|
# pattern, the document is not indexed.
|
4845
5855
|
#
|
4846
|
-
#
|
4847
|
-
# (programming)][1] in *Wikipedia*.
|
5856
|
+
# Some [examples][1] are:
|
4848
5857
|
#
|
5858
|
+
# * **.txt* will include all text files in a directory (files with
|
5859
|
+
# the extension .txt).
|
4849
5860
|
#
|
5861
|
+
# * ***/*.txt* will include all text files in a directory and its
|
5862
|
+
# subdirectories.
|
4850
5863
|
#
|
4851
|
-
#
|
5864
|
+
# * **tax** will include all files in a directory that contain
|
5865
|
+
# 'tax' in the file name, such as 'tax', 'taxes',
|
5866
|
+
# 'income\_tax'.
|
5867
|
+
#
|
5868
|
+
#
|
5869
|
+
#
|
5870
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
|
4852
5871
|
# @return [Array<String>]
|
4853
5872
|
#
|
4854
5873
|
# @!attribute [rw] exclusion_patterns
|
@@ -4856,12 +5875,21 @@ module Aws::Kendra
|
|
4856
5875
|
# a document that matches an inclusion prefix or inclusion pattern
|
4857
5876
|
# also matches an exclusion pattern, the document is not indexed.
|
4858
5877
|
#
|
4859
|
-
#
|
4860
|
-
#
|
5878
|
+
# Some [examples][1] are:
|
5879
|
+
#
|
5880
|
+
# * **.png , *.jpg* will exclude all PNG and JPEG image files in a
|
5881
|
+
# directory (files with the extensions .png and .jpg).
|
5882
|
+
#
|
5883
|
+
# * **internal** will exclude all files in a directory that contain
|
5884
|
+
# 'internal' in the file name, such as 'internal',
|
5885
|
+
# 'internal\_only', 'company\_internal'.
|
5886
|
+
#
|
5887
|
+
# * ***/*internal** will exclude all internal-related files in a
|
5888
|
+
# directory and its subdirectories.
|
4861
5889
|
#
|
4862
5890
|
#
|
4863
5891
|
#
|
4864
|
-
# [1]: https://
|
5892
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
|
4865
5893
|
# @return [Array<String>]
|
4866
5894
|
#
|
4867
5895
|
# @!attribute [rw] documents_metadata_configuration
|
@@ -4948,7 +5976,7 @@ module Aws::Kendra
|
|
4948
5976
|
# @!attribute [rw] document_title_field_name
|
4949
5977
|
# The name of the column in the Salesforce FeedItem table that
|
4950
5978
|
# contains the title of the document. This is typically the `Title`
|
4951
|
-
#
|
5979
|
+
# column.
|
4952
5980
|
# @return [String]
|
4953
5981
|
#
|
4954
5982
|
# @!attribute [rw] field_mappings
|
@@ -5448,6 +6476,59 @@ module Aws::Kendra
|
|
5448
6476
|
include Aws::Structure
|
5449
6477
|
end
|
5450
6478
|
|
6479
|
+
# Provides the configuration information of the seed or starting point
|
6480
|
+
# URLs to crawl.
|
6481
|
+
#
|
6482
|
+
# *When selecting websites to index, you must adhere to the [Amazon
|
6483
|
+
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
6484
|
+
# you must only use the Amazon Kendra web crawler to index your own
|
6485
|
+
# webpages, or webpages that you have authorization to index.*
|
6486
|
+
#
|
6487
|
+
#
|
6488
|
+
#
|
6489
|
+
# [1]: https://aws.amazon.com/aup/
|
6490
|
+
#
|
6491
|
+
# @note When making an API call, you may pass SeedUrlConfiguration
|
6492
|
+
# data as a hash:
|
6493
|
+
#
|
6494
|
+
# {
|
6495
|
+
# seed_urls: ["SeedUrl"], # required
|
6496
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
6497
|
+
# }
|
6498
|
+
#
|
6499
|
+
# @!attribute [rw] seed_urls
|
6500
|
+
# The list of seed or starting point URLs of the websites you want to
|
6501
|
+
# crawl.
|
6502
|
+
#
|
6503
|
+
# The list can include a maximum of 100 seed URLs.
|
6504
|
+
# @return [Array<String>]
|
6505
|
+
#
|
6506
|
+
# @!attribute [rw] web_crawler_mode
|
6507
|
+
# You can choose one of the following modes:
|
6508
|
+
#
|
6509
|
+
# * `HOST_ONLY` – crawl only the website host names. For example, if
|
6510
|
+
# the seed URL is "abc.example.com", then only URLs with host name
|
6511
|
+
# "abc.example.com" are crawled.
|
6512
|
+
#
|
6513
|
+
# * `SUBDOMAINS` – crawl the website host names with subdomains. For
|
6514
|
+
# example, if the seed URL is "abc.example.com", then
|
6515
|
+
# "a.abc.example.com" and "b.abc.example.com" are also crawled.
|
6516
|
+
#
|
6517
|
+
# * `EVERYTHING` – crawl the website host names with subdomains and
|
6518
|
+
# other domains that the webpages link to.
|
6519
|
+
#
|
6520
|
+
# The default mode is set to `HOST_ONLY`.
|
6521
|
+
# @return [String]
|
6522
|
+
#
|
6523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SeedUrlConfiguration AWS API Documentation
|
6524
|
+
#
|
6525
|
+
class SeedUrlConfiguration < Struct.new(
|
6526
|
+
:seed_urls,
|
6527
|
+
:web_crawler_mode)
|
6528
|
+
SENSITIVE = []
|
6529
|
+
include Aws::Structure
|
6530
|
+
end
|
6531
|
+
|
5451
6532
|
# Provides the identifier of the AWS KMS customer master key (CMK) used
|
5452
6533
|
# to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
|
5453
6534
|
# support asymmetric CMKs.
|
@@ -5747,7 +6828,7 @@ module Aws::Kendra
|
|
5747
6828
|
# data as a hash:
|
5748
6829
|
#
|
5749
6830
|
# {
|
5750
|
-
# share_point_version: "
|
6831
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
5751
6832
|
# urls: ["Url"], # required
|
5752
6833
|
# secret_arn: "SecretArn", # required
|
5753
6834
|
# crawl_attachments: false,
|
@@ -5767,6 +6848,10 @@ module Aws::Kendra
|
|
5767
6848
|
# ],
|
5768
6849
|
# document_title_field_name: "DataSourceFieldName",
|
5769
6850
|
# disable_local_groups: false,
|
6851
|
+
# ssl_certificate_s3_path: {
|
6852
|
+
# bucket: "S3BucketName", # required
|
6853
|
+
# key: "S3ObjectKey", # required
|
6854
|
+
# },
|
5770
6855
|
# }
|
5771
6856
|
#
|
5772
6857
|
# @!attribute [rw] share_point_version
|
@@ -5781,10 +6866,12 @@ module Aws::Kendra
|
|
5781
6866
|
#
|
5782
6867
|
# @!attribute [rw] secret_arn
|
5783
6868
|
# The Amazon Resource Name (ARN) of credentials stored in AWS Secrets
|
5784
|
-
# Manager. The credentials should be a user/password pair.
|
5785
|
-
#
|
5786
|
-
#
|
5787
|
-
#
|
6869
|
+
# Manager. The credentials should be a user/password pair. If you use
|
6870
|
+
# SharePoint Sever, you also need to provide the sever domain name as
|
6871
|
+
# part of the credentials. For more information, see [Using a
|
6872
|
+
# Microsoft SharePoint Data Source][1]. For more information about AWS
|
6873
|
+
# Secrets Manager, see [ What Is AWS Secrets Manager ][2] in the *AWS
|
6874
|
+
# Secrets Manager* user guide.
|
5788
6875
|
#
|
5789
6876
|
#
|
5790
6877
|
#
|
@@ -5852,6 +6939,10 @@ module Aws::Kendra
|
|
5852
6939
|
# (`True`) or enabled (`False`).
|
5853
6940
|
# @return [Boolean]
|
5854
6941
|
#
|
6942
|
+
# @!attribute [rw] ssl_certificate_s3_path
|
6943
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
6944
|
+
# @return [Types::S3Path]
|
6945
|
+
#
|
5855
6946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
|
5856
6947
|
#
|
5857
6948
|
class SharePointConfiguration < Struct.new(
|
@@ -5865,7 +6956,40 @@ module Aws::Kendra
|
|
5865
6956
|
:vpc_configuration,
|
5866
6957
|
:field_mappings,
|
5867
6958
|
:document_title_field_name,
|
5868
|
-
:disable_local_groups
|
6959
|
+
:disable_local_groups,
|
6960
|
+
:ssl_certificate_s3_path)
|
6961
|
+
SENSITIVE = []
|
6962
|
+
include Aws::Structure
|
6963
|
+
end
|
6964
|
+
|
6965
|
+
# Provides the configuration information of the sitemap URLs to crawl.
|
6966
|
+
#
|
6967
|
+
# *When selecting websites to index, you must adhere to the [Amazon
|
6968
|
+
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
6969
|
+
# you must only use the Amazon Kendra web crawler to index your own
|
6970
|
+
# webpages, or webpages that you have authorization to index.*
|
6971
|
+
#
|
6972
|
+
#
|
6973
|
+
#
|
6974
|
+
# [1]: https://aws.amazon.com/aup/
|
6975
|
+
#
|
6976
|
+
# @note When making an API call, you may pass SiteMapsConfiguration
|
6977
|
+
# data as a hash:
|
6978
|
+
#
|
6979
|
+
# {
|
6980
|
+
# site_maps: ["SiteMap"], # required
|
6981
|
+
# }
|
6982
|
+
#
|
6983
|
+
# @!attribute [rw] site_maps
|
6984
|
+
# The list of sitemap URLs of the websites you want to crawl.
|
6985
|
+
#
|
6986
|
+
# The list can include a maximum of three sitemap URLs.
|
6987
|
+
# @return [Array<String>]
|
6988
|
+
#
|
6989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SiteMapsConfiguration AWS API Documentation
|
6990
|
+
#
|
6991
|
+
class SiteMapsConfiguration < Struct.new(
|
6992
|
+
:site_maps)
|
5869
6993
|
SENSITIVE = []
|
5870
6994
|
include Aws::Structure
|
5871
6995
|
end
|
@@ -6001,6 +7125,41 @@ module Aws::Kendra
|
|
6001
7125
|
include Aws::Structure
|
6002
7126
|
end
|
6003
7127
|
|
7128
|
+
# Provides information about the status of documents submitted for
|
7129
|
+
# indexing.
|
7130
|
+
#
|
7131
|
+
# @!attribute [rw] document_id
|
7132
|
+
# The unique identifier of the document.
|
7133
|
+
# @return [String]
|
7134
|
+
#
|
7135
|
+
# @!attribute [rw] document_status
|
7136
|
+
# The current status of a document.
|
7137
|
+
#
|
7138
|
+
# If the document was submitted for deletion, the status is
|
7139
|
+
# `NOT_FOUND` after the document is deleted.
|
7140
|
+
# @return [String]
|
7141
|
+
#
|
7142
|
+
# @!attribute [rw] failure_code
|
7143
|
+
# Indicates the source of the error.
|
7144
|
+
# @return [String]
|
7145
|
+
#
|
7146
|
+
# @!attribute [rw] failure_reason
|
7147
|
+
# Provides detailed information about why the document couldn't be
|
7148
|
+
# indexed. Use this information to correct the error before you
|
7149
|
+
# resubmit the document for indexing.
|
7150
|
+
# @return [String]
|
7151
|
+
#
|
7152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Status AWS API Documentation
|
7153
|
+
#
|
7154
|
+
class Status < Struct.new(
|
7155
|
+
:document_id,
|
7156
|
+
:document_status,
|
7157
|
+
:failure_code,
|
7158
|
+
:failure_reason)
|
7159
|
+
SENSITIVE = []
|
7160
|
+
include Aws::Structure
|
7161
|
+
end
|
7162
|
+
|
6004
7163
|
# @note When making an API call, you may pass StopDataSourceSyncJobRequest
|
6005
7164
|
# data as a hash:
|
6006
7165
|
#
|
@@ -6078,6 +7237,86 @@ module Aws::Kendra
|
|
6078
7237
|
include Aws::Structure
|
6079
7238
|
end
|
6080
7239
|
|
7240
|
+
# A single query suggestion.
|
7241
|
+
#
|
7242
|
+
# @!attribute [rw] id
|
7243
|
+
# The unique UUID (universally unique identifier) of a single query
|
7244
|
+
# suggestion.
|
7245
|
+
# @return [String]
|
7246
|
+
#
|
7247
|
+
# @!attribute [rw] value
|
7248
|
+
# The value for the unique UUID (universally unique identifier) of a
|
7249
|
+
# single query suggestion.
|
7250
|
+
#
|
7251
|
+
# The value is the text string of a suggestion.
|
7252
|
+
# @return [Types::SuggestionValue]
|
7253
|
+
#
|
7254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Suggestion AWS API Documentation
|
7255
|
+
#
|
7256
|
+
class Suggestion < Struct.new(
|
7257
|
+
:id,
|
7258
|
+
:value)
|
7259
|
+
SENSITIVE = []
|
7260
|
+
include Aws::Structure
|
7261
|
+
end
|
7262
|
+
|
7263
|
+
# The text highlights for a single query suggestion.
|
7264
|
+
#
|
7265
|
+
# @!attribute [rw] begin_offset
|
7266
|
+
# The zero-based location in the response string where the highlight
|
7267
|
+
# starts.
|
7268
|
+
# @return [Integer]
|
7269
|
+
#
|
7270
|
+
# @!attribute [rw] end_offset
|
7271
|
+
# The zero-based location in the response string where the highlight
|
7272
|
+
# ends.
|
7273
|
+
# @return [Integer]
|
7274
|
+
#
|
7275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionHighlight AWS API Documentation
|
7276
|
+
#
|
7277
|
+
class SuggestionHighlight < Struct.new(
|
7278
|
+
:begin_offset,
|
7279
|
+
:end_offset)
|
7280
|
+
SENSITIVE = []
|
7281
|
+
include Aws::Structure
|
7282
|
+
end
|
7283
|
+
|
7284
|
+
# Provides text and information about where to highlight the query
|
7285
|
+
# suggestion text.
|
7286
|
+
#
|
7287
|
+
# @!attribute [rw] text
|
7288
|
+
# The query suggestion text to display to the user.
|
7289
|
+
# @return [String]
|
7290
|
+
#
|
7291
|
+
# @!attribute [rw] highlights
|
7292
|
+
# The beginning and end of the query suggestion text that should be
|
7293
|
+
# highlighted.
|
7294
|
+
# @return [Array<Types::SuggestionHighlight>]
|
7295
|
+
#
|
7296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionTextWithHighlights AWS API Documentation
|
7297
|
+
#
|
7298
|
+
class SuggestionTextWithHighlights < Struct.new(
|
7299
|
+
:text,
|
7300
|
+
:highlights)
|
7301
|
+
SENSITIVE = []
|
7302
|
+
include Aws::Structure
|
7303
|
+
end
|
7304
|
+
|
7305
|
+
# The `SuggestionTextWithHighlights` structure information.
|
7306
|
+
#
|
7307
|
+
# @!attribute [rw] text
|
7308
|
+
# The `SuggestionTextWithHighlights` structure that contains the query
|
7309
|
+
# suggestion text and highlights.
|
7310
|
+
# @return [Types::SuggestionTextWithHighlights]
|
7311
|
+
#
|
7312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionValue AWS API Documentation
|
7313
|
+
#
|
7314
|
+
class SuggestionValue < Struct.new(
|
7315
|
+
:text)
|
7316
|
+
SENSITIVE = []
|
7317
|
+
include Aws::Structure
|
7318
|
+
end
|
7319
|
+
|
6081
7320
|
# A list of key/value pairs that identify an index, FAQ, or data source.
|
6082
7321
|
# Tag keys and values can consist of Unicode letters, digits, white
|
6083
7322
|
# space, and any of the following symbols: \_ . : / = + - @.
|
@@ -6308,7 +7547,7 @@ module Aws::Kendra
|
|
6308
7547
|
# },
|
6309
7548
|
# },
|
6310
7549
|
# share_point_configuration: {
|
6311
|
-
# share_point_version: "
|
7550
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
6312
7551
|
# urls: ["Url"], # required
|
6313
7552
|
# secret_arn: "SecretArn", # required
|
6314
7553
|
# crawl_attachments: false,
|
@@ -6328,6 +7567,10 @@ module Aws::Kendra
|
|
6328
7567
|
# ],
|
6329
7568
|
# document_title_field_name: "DataSourceFieldName",
|
6330
7569
|
# disable_local_groups: false,
|
7570
|
+
# ssl_certificate_s3_path: {
|
7571
|
+
# bucket: "S3BucketName", # required
|
7572
|
+
# key: "S3ObjectKey", # required
|
7573
|
+
# },
|
6331
7574
|
# },
|
6332
7575
|
# database_configuration: {
|
6333
7576
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -6556,6 +7799,37 @@ module Aws::Kendra
|
|
6556
7799
|
# exclude_user_accounts: ["UserAccount"],
|
6557
7800
|
# exclude_shared_drives: ["SharedDriveId"],
|
6558
7801
|
# },
|
7802
|
+
# web_crawler_configuration: {
|
7803
|
+
# urls: { # required
|
7804
|
+
# seed_url_configuration: {
|
7805
|
+
# seed_urls: ["SeedUrl"], # required
|
7806
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
7807
|
+
# },
|
7808
|
+
# site_maps_configuration: {
|
7809
|
+
# site_maps: ["SiteMap"], # required
|
7810
|
+
# },
|
7811
|
+
# },
|
7812
|
+
# crawl_depth: 1,
|
7813
|
+
# max_links_per_page: 1,
|
7814
|
+
# max_content_size_per_page_in_mega_bytes: 1.0,
|
7815
|
+
# max_urls_per_minute_crawl_rate: 1,
|
7816
|
+
# url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
7817
|
+
# url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
7818
|
+
# proxy_configuration: {
|
7819
|
+
# host: "Host", # required
|
7820
|
+
# port: 1, # required
|
7821
|
+
# credentials: "SecretArn",
|
7822
|
+
# },
|
7823
|
+
# authentication_configuration: {
|
7824
|
+
# basic_authentication: [
|
7825
|
+
# {
|
7826
|
+
# host: "Host", # required
|
7827
|
+
# port: 1, # required
|
7828
|
+
# credentials: "SecretArn", # required
|
7829
|
+
# },
|
7830
|
+
# ],
|
7831
|
+
# },
|
7832
|
+
# },
|
6559
7833
|
# },
|
6560
7834
|
# description: "Description",
|
6561
7835
|
# schedule: "ScanSchedule",
|
@@ -6714,6 +7988,158 @@ module Aws::Kendra
|
|
6714
7988
|
include Aws::Structure
|
6715
7989
|
end
|
6716
7990
|
|
7991
|
+
# @note When making an API call, you may pass UpdateQuerySuggestionsBlockListRequest
|
7992
|
+
# data as a hash:
|
7993
|
+
#
|
7994
|
+
# {
|
7995
|
+
# index_id: "IndexId", # required
|
7996
|
+
# id: "QuerySuggestionsBlockListId", # required
|
7997
|
+
# name: "QuerySuggestionsBlockListName",
|
7998
|
+
# description: "Description",
|
7999
|
+
# source_s3_path: {
|
8000
|
+
# bucket: "S3BucketName", # required
|
8001
|
+
# key: "S3ObjectKey", # required
|
8002
|
+
# },
|
8003
|
+
# role_arn: "RoleArn",
|
8004
|
+
# }
|
8005
|
+
#
|
8006
|
+
# @!attribute [rw] index_id
|
8007
|
+
# The identifier of the index for a block list.
|
8008
|
+
# @return [String]
|
8009
|
+
#
|
8010
|
+
# @!attribute [rw] id
|
8011
|
+
# The unique identifier of a block list.
|
8012
|
+
# @return [String]
|
8013
|
+
#
|
8014
|
+
# @!attribute [rw] name
|
8015
|
+
# The name of a block list.
|
8016
|
+
# @return [String]
|
8017
|
+
#
|
8018
|
+
# @!attribute [rw] description
|
8019
|
+
# The description for a block list.
|
8020
|
+
# @return [String]
|
8021
|
+
#
|
8022
|
+
# @!attribute [rw] source_s3_path
|
8023
|
+
# The S3 path where your block list text file sits in S3.
|
8024
|
+
#
|
8025
|
+
# If you update your block list and provide the same path to the block
|
8026
|
+
# list text file in S3, then Amazon Kendra reloads the file to refresh
|
8027
|
+
# the block list. Amazon Kendra does not automatically refresh your
|
8028
|
+
# block list. You need to call the `UpdateQuerySuggestionsBlockList`
|
8029
|
+
# API to refresh you block list.
|
8030
|
+
#
|
8031
|
+
# If you update your block list, then Amazon Kendra asynchronously
|
8032
|
+
# refreshes all query suggestions with the latest content in the S3
|
8033
|
+
# file. This means changes might not take effect immediately.
|
8034
|
+
# @return [Types::S3Path]
|
8035
|
+
#
|
8036
|
+
# @!attribute [rw] role_arn
|
8037
|
+
# The IAM (Identity and Access Management) role used to access the
|
8038
|
+
# block list text file in S3.
|
8039
|
+
# @return [String]
|
8040
|
+
#
|
8041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockListRequest AWS API Documentation
|
8042
|
+
#
|
8043
|
+
class UpdateQuerySuggestionsBlockListRequest < Struct.new(
|
8044
|
+
:index_id,
|
8045
|
+
:id,
|
8046
|
+
:name,
|
8047
|
+
:description,
|
8048
|
+
:source_s3_path,
|
8049
|
+
:role_arn)
|
8050
|
+
SENSITIVE = []
|
8051
|
+
include Aws::Structure
|
8052
|
+
end
|
8053
|
+
|
8054
|
+
# @note When making an API call, you may pass UpdateQuerySuggestionsConfigRequest
|
8055
|
+
# data as a hash:
|
8056
|
+
#
|
8057
|
+
# {
|
8058
|
+
# index_id: "IndexId", # required
|
8059
|
+
# mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
|
8060
|
+
# query_log_look_back_window_in_days: 1,
|
8061
|
+
# include_queries_without_user_information: false,
|
8062
|
+
# minimum_number_of_querying_users: 1,
|
8063
|
+
# minimum_query_count: 1,
|
8064
|
+
# }
|
8065
|
+
#
|
8066
|
+
# @!attribute [rw] index_id
|
8067
|
+
# The identifier of the index you want to update query suggestions
|
8068
|
+
# settings for.
|
8069
|
+
# @return [String]
|
8070
|
+
#
|
8071
|
+
# @!attribute [rw] mode
|
8072
|
+
# Set the mode to `ENABLED` or `LEARN_ONLY`.
|
8073
|
+
#
|
8074
|
+
# By default, Amazon Kendra enables query suggestions. `LEARN_ONLY`
|
8075
|
+
# mode allows you to turn off query suggestions. You can to update
|
8076
|
+
# this at any time.
|
8077
|
+
#
|
8078
|
+
# In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
|
8079
|
+
# queries to keep suggestions up to date for when you are ready to
|
8080
|
+
# switch to ENABLED mode again.
|
8081
|
+
# @return [String]
|
8082
|
+
#
|
8083
|
+
# @!attribute [rw] query_log_look_back_window_in_days
|
8084
|
+
# How recent your queries are in your query log time window.
|
8085
|
+
#
|
8086
|
+
# The time window is the number of days from current day to past days.
|
8087
|
+
#
|
8088
|
+
# By default, Amazon Kendra sets this to 180.
|
8089
|
+
# @return [Integer]
|
8090
|
+
#
|
8091
|
+
# @!attribute [rw] include_queries_without_user_information
|
8092
|
+
# `TRUE` to include queries without user information (i.e. all
|
8093
|
+
# queries, irrespective of the user), otherwise `FALSE` to only
|
8094
|
+
# include queries with user information.
|
8095
|
+
#
|
8096
|
+
# If you pass user information to Amazon Kendra along with the
|
8097
|
+
# queries, you can set this flag to `FALSE` and instruct Amazon Kendra
|
8098
|
+
# to only consider queries with user information.
|
8099
|
+
#
|
8100
|
+
# If you set to `FALSE`, Amazon Kendra only considers queries searched
|
8101
|
+
# at least `MinimumQueryCount` times across
|
8102
|
+
# `MinimumNumberOfQueryingUsers` unique users for suggestions.
|
8103
|
+
#
|
8104
|
+
# If you set to `TRUE`, Amazon Kendra ignores all user information and
|
8105
|
+
# learns from all queries.
|
8106
|
+
# @return [Boolean]
|
8107
|
+
#
|
8108
|
+
# @!attribute [rw] minimum_number_of_querying_users
|
8109
|
+
# The minimum number of unique users who must search a query in order
|
8110
|
+
# for the query to be eligible to suggest to your users.
|
8111
|
+
#
|
8112
|
+
# Increasing this number might decrease the number of suggestions.
|
8113
|
+
# However, this ensures a query is searched by many users and is truly
|
8114
|
+
# popular to suggest to users.
|
8115
|
+
#
|
8116
|
+
# How you tune this setting depends on your specific needs.
|
8117
|
+
# @return [Integer]
|
8118
|
+
#
|
8119
|
+
# @!attribute [rw] minimum_query_count
|
8120
|
+
# The the minimum number of times a query must be searched in order to
|
8121
|
+
# be eligible to suggest to your users.
|
8122
|
+
#
|
8123
|
+
# Decreasing this number increases the number of suggestions. However,
|
8124
|
+
# this affects the quality of suggestions as it sets a low bar for a
|
8125
|
+
# query to be considered popular to suggest to users.
|
8126
|
+
#
|
8127
|
+
# How you tune this setting depends on your specific needs.
|
8128
|
+
# @return [Integer]
|
8129
|
+
#
|
8130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation
|
8131
|
+
#
|
8132
|
+
class UpdateQuerySuggestionsConfigRequest < Struct.new(
|
8133
|
+
:index_id,
|
8134
|
+
:mode,
|
8135
|
+
:query_log_look_back_window_in_days,
|
8136
|
+
:include_queries_without_user_information,
|
8137
|
+
:minimum_number_of_querying_users,
|
8138
|
+
:minimum_query_count)
|
8139
|
+
SENSITIVE = []
|
8140
|
+
include Aws::Structure
|
8141
|
+
end
|
8142
|
+
|
6717
8143
|
# @note When making an API call, you may pass UpdateThesaurusRequest
|
6718
8144
|
# data as a hash:
|
6719
8145
|
#
|
@@ -6766,6 +8192,58 @@ module Aws::Kendra
|
|
6766
8192
|
include Aws::Structure
|
6767
8193
|
end
|
6768
8194
|
|
8195
|
+
# Provides the configuration information of the URLs to crawl.
|
8196
|
+
#
|
8197
|
+
# *When selecting websites to index, you must adhere to the [Amazon
|
8198
|
+
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
8199
|
+
# you must only use the Amazon Kendra web crawler to index your own
|
8200
|
+
# webpages, or webpages that you have authorization to index.*
|
8201
|
+
#
|
8202
|
+
#
|
8203
|
+
#
|
8204
|
+
# [1]: https://aws.amazon.com/aup/
|
8205
|
+
#
|
8206
|
+
# @note When making an API call, you may pass Urls
|
8207
|
+
# data as a hash:
|
8208
|
+
#
|
8209
|
+
# {
|
8210
|
+
# seed_url_configuration: {
|
8211
|
+
# seed_urls: ["SeedUrl"], # required
|
8212
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
8213
|
+
# },
|
8214
|
+
# site_maps_configuration: {
|
8215
|
+
# site_maps: ["SiteMap"], # required
|
8216
|
+
# },
|
8217
|
+
# }
|
8218
|
+
#
|
8219
|
+
# @!attribute [rw] seed_url_configuration
|
8220
|
+
# Provides the configuration of the seed or starting point URLs of the
|
8221
|
+
# websites you want to crawl.
|
8222
|
+
#
|
8223
|
+
# You can choose to crawl only the website host names, or the website
|
8224
|
+
# host names with subdomains, or the website host names with
|
8225
|
+
# subdomains and other domains that the webpages link to.
|
8226
|
+
#
|
8227
|
+
# You can list up to 100 seed URLs.
|
8228
|
+
# @return [Types::SeedUrlConfiguration]
|
8229
|
+
#
|
8230
|
+
# @!attribute [rw] site_maps_configuration
|
8231
|
+
# Provides the configuration of the sitemap URLs of the websites you
|
8232
|
+
# want to crawl.
|
8233
|
+
#
|
8234
|
+
# Only URLs belonging to the same website host names are crawled. You
|
8235
|
+
# can list up to three sitemap URLs.
|
8236
|
+
# @return [Types::SiteMapsConfiguration]
|
8237
|
+
#
|
8238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Urls AWS API Documentation
|
8239
|
+
#
|
8240
|
+
class Urls < Struct.new(
|
8241
|
+
:seed_url_configuration,
|
8242
|
+
:site_maps_configuration)
|
8243
|
+
SENSITIVE = []
|
8244
|
+
include Aws::Structure
|
8245
|
+
end
|
8246
|
+
|
6769
8247
|
# Provides information about the user context for a Amazon Kendra index.
|
6770
8248
|
#
|
6771
8249
|
# @note When making an API call, you may pass UserContext
|
@@ -6836,5 +8314,167 @@ module Aws::Kendra
|
|
6836
8314
|
include Aws::Structure
|
6837
8315
|
end
|
6838
8316
|
|
8317
|
+
# Provides the configuration information required for Amazon Kendra web
|
8318
|
+
# crawler.
|
8319
|
+
#
|
8320
|
+
# @note When making an API call, you may pass WebCrawlerConfiguration
|
8321
|
+
# data as a hash:
|
8322
|
+
#
|
8323
|
+
# {
|
8324
|
+
# urls: { # required
|
8325
|
+
# seed_url_configuration: {
|
8326
|
+
# seed_urls: ["SeedUrl"], # required
|
8327
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
8328
|
+
# },
|
8329
|
+
# site_maps_configuration: {
|
8330
|
+
# site_maps: ["SiteMap"], # required
|
8331
|
+
# },
|
8332
|
+
# },
|
8333
|
+
# crawl_depth: 1,
|
8334
|
+
# max_links_per_page: 1,
|
8335
|
+
# max_content_size_per_page_in_mega_bytes: 1.0,
|
8336
|
+
# max_urls_per_minute_crawl_rate: 1,
|
8337
|
+
# url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
8338
|
+
# url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
8339
|
+
# proxy_configuration: {
|
8340
|
+
# host: "Host", # required
|
8341
|
+
# port: 1, # required
|
8342
|
+
# credentials: "SecretArn",
|
8343
|
+
# },
|
8344
|
+
# authentication_configuration: {
|
8345
|
+
# basic_authentication: [
|
8346
|
+
# {
|
8347
|
+
# host: "Host", # required
|
8348
|
+
# port: 1, # required
|
8349
|
+
# credentials: "SecretArn", # required
|
8350
|
+
# },
|
8351
|
+
# ],
|
8352
|
+
# },
|
8353
|
+
# }
|
8354
|
+
#
|
8355
|
+
# @!attribute [rw] urls
|
8356
|
+
# Specifies the seed or starting point URLs of the websites or the
|
8357
|
+
# sitemap URLs of the websites you want to crawl.
|
8358
|
+
#
|
8359
|
+
# You can include website subdomains. You can list up to 100 seed URLs
|
8360
|
+
# and up to three sitemap URLs.
|
8361
|
+
#
|
8362
|
+
# *When selecting websites to index, you must adhere to the [Amazon
|
8363
|
+
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
8364
|
+
# you must only use the Amazon Kendra web crawler to index your own
|
8365
|
+
# webpages, or webpages that you have authorization to index.*
|
8366
|
+
#
|
8367
|
+
#
|
8368
|
+
#
|
8369
|
+
# [1]: https://aws.amazon.com/aup/
|
8370
|
+
# @return [Types::Urls]
|
8371
|
+
#
|
8372
|
+
# @!attribute [rw] crawl_depth
|
8373
|
+
# Specifies the number of levels in a website that you want to crawl.
|
8374
|
+
#
|
8375
|
+
# The first level begins from the website seed or starting point URL.
|
8376
|
+
# For example, if a website has 3 levels – index level (i.e. seed in
|
8377
|
+
# this example), sections level, and subsections level – and you are
|
8378
|
+
# only interested in crawling information up to the sections level
|
8379
|
+
# (i.e. levels 0-1), you can set your depth to 1.
|
8380
|
+
#
|
8381
|
+
# The default crawl depth is set to 2.
|
8382
|
+
# @return [Integer]
|
8383
|
+
#
|
8384
|
+
# @!attribute [rw] max_links_per_page
|
8385
|
+
# The maximum number of URLs on a webpage to include when crawling a
|
8386
|
+
# website. This number is per webpage.
|
8387
|
+
#
|
8388
|
+
# As a website’s webpages are crawled, any URLs the webpages link to
|
8389
|
+
# are also crawled. URLs on a webpage are crawled in order of
|
8390
|
+
# appearance.
|
8391
|
+
#
|
8392
|
+
# The default maximum links per page is 100.
|
8393
|
+
# @return [Integer]
|
8394
|
+
#
|
8395
|
+
# @!attribute [rw] max_content_size_per_page_in_mega_bytes
|
8396
|
+
# The maximum size (in MB) of a webpage or attachment to crawl.
|
8397
|
+
#
|
8398
|
+
# Files larger than this size (in MB) are skipped/not crawled.
|
8399
|
+
#
|
8400
|
+
# The default maximum size of a webpage or attachment is set to 50 MB.
|
8401
|
+
# @return [Float]
|
8402
|
+
#
|
8403
|
+
# @!attribute [rw] max_urls_per_minute_crawl_rate
|
8404
|
+
# The maximum number of URLs crawled per website host per minute.
|
8405
|
+
#
|
8406
|
+
# A minimum of one URL is required.
|
8407
|
+
#
|
8408
|
+
# The default maximum number of URLs crawled per website host per
|
8409
|
+
# minute is 300.
|
8410
|
+
# @return [Integer]
|
8411
|
+
#
|
8412
|
+
# @!attribute [rw] url_inclusion_patterns
|
8413
|
+
# The regular expression pattern to include certain URLs to crawl.
|
8414
|
+
#
|
8415
|
+
# If there is a regular expression pattern to exclude certain URLs
|
8416
|
+
# that conflicts with the include pattern, the exclude pattern takes
|
8417
|
+
# precedence.
|
8418
|
+
# @return [Array<String>]
|
8419
|
+
#
|
8420
|
+
# @!attribute [rw] url_exclusion_patterns
|
8421
|
+
# The regular expression pattern to exclude certain URLs to crawl.
|
8422
|
+
#
|
8423
|
+
# If there is a regular expression pattern to include certain URLs
|
8424
|
+
# that conflicts with the exclude pattern, the exclude pattern takes
|
8425
|
+
# precedence.
|
8426
|
+
# @return [Array<String>]
|
8427
|
+
#
|
8428
|
+
# @!attribute [rw] proxy_configuration
|
8429
|
+
# Provides configuration information required to connect to your
|
8430
|
+
# internal websites via a web proxy.
|
8431
|
+
#
|
8432
|
+
# You must provide the website host name and port number. For example,
|
8433
|
+
# the host name of https://a.example.com/page1.html is
|
8434
|
+
# "a.example.com" and the port is 443, the standard port for HTTPS.
|
8435
|
+
#
|
8436
|
+
# Web proxy credentials are optional and you can use them to connect
|
8437
|
+
# to a web proxy server that requires basic authentication. To store
|
8438
|
+
# web proxy credentials, you use a secret in [AWS Secrets Manager][1].
|
8439
|
+
#
|
8440
|
+
#
|
8441
|
+
#
|
8442
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
|
8443
|
+
# @return [Types::ProxyConfiguration]
|
8444
|
+
#
|
8445
|
+
# @!attribute [rw] authentication_configuration
|
8446
|
+
# Provides configuration information required to connect to websites
|
8447
|
+
# using authentication.
|
8448
|
+
#
|
8449
|
+
# You can connect to websites using basic authentication of user name
|
8450
|
+
# and password.
|
8451
|
+
#
|
8452
|
+
# You must provide the website host name and port number. For example,
|
8453
|
+
# the host name of https://a.example.com/page1.html is
|
8454
|
+
# "a.example.com" and the port is 443, the standard port for HTTPS.
|
8455
|
+
# You use a secret in [AWS Secrets Manager][1] to store your
|
8456
|
+
# authentication credentials.
|
8457
|
+
#
|
8458
|
+
#
|
8459
|
+
#
|
8460
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html
|
8461
|
+
# @return [Types::AuthenticationConfiguration]
|
8462
|
+
#
|
8463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/WebCrawlerConfiguration AWS API Documentation
|
8464
|
+
#
|
8465
|
+
class WebCrawlerConfiguration < Struct.new(
|
8466
|
+
:urls,
|
8467
|
+
:crawl_depth,
|
8468
|
+
:max_links_per_page,
|
8469
|
+
:max_content_size_per_page_in_mega_bytes,
|
8470
|
+
:max_urls_per_minute_crawl_rate,
|
8471
|
+
:url_inclusion_patterns,
|
8472
|
+
:url_exclusion_patterns,
|
8473
|
+
:proxy_configuration,
|
8474
|
+
:authentication_configuration)
|
8475
|
+
SENSITIVE = []
|
8476
|
+
include Aws::Structure
|
8477
|
+
end
|
8478
|
+
|
6839
8479
|
end
|
6840
8480
|
end
|