aws-sdk-kendra 1.4.0 → 1.9.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kendra.rb +3 -1
- data/lib/aws-sdk-kendra/client.rb +585 -13
- data/lib/aws-sdk-kendra/client_api.rb +265 -0
- data/lib/aws-sdk-kendra/errors.rb +2 -0
- data/lib/aws-sdk-kendra/resource.rb +2 -0
- data/lib/aws-sdk-kendra/types.rb +1882 -101
- metadata +4 -4
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -25,6 +27,7 @@ module Aws::Kendra
|
|
25
27
|
#
|
26
28
|
class AccessControlListConfiguration < Struct.new(
|
27
29
|
:key_path)
|
30
|
+
SENSITIVE = []
|
28
31
|
include Aws::Structure
|
29
32
|
end
|
30
33
|
|
@@ -35,6 +38,7 @@ module Aws::Kendra
|
|
35
38
|
#
|
36
39
|
class AccessDeniedException < Struct.new(
|
37
40
|
:message)
|
41
|
+
SENSITIVE = []
|
38
42
|
include Aws::Structure
|
39
43
|
end
|
40
44
|
|
@@ -59,16 +63,22 @@ module Aws::Kendra
|
|
59
63
|
#
|
60
64
|
class AclConfiguration < Struct.new(
|
61
65
|
:allowed_groups_column_name)
|
66
|
+
SENSITIVE = []
|
62
67
|
include Aws::Structure
|
63
68
|
end
|
64
69
|
|
70
|
+
# An attribute returned from an index query.
|
71
|
+
#
|
65
72
|
# @!attribute [rw] key
|
73
|
+
# The key that identifies the attribute.
|
66
74
|
# @return [String]
|
67
75
|
#
|
68
76
|
# @!attribute [rw] value_type
|
77
|
+
# The data type of the `Value` property.
|
69
78
|
# @return [String]
|
70
79
|
#
|
71
80
|
# @!attribute [rw] value
|
81
|
+
# An object that contains the attribute value.
|
72
82
|
# @return [Types::AdditionalResultAttributeValue]
|
73
83
|
#
|
74
84
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AdditionalResultAttribute AWS API Documentation
|
@@ -77,6 +87,7 @@ module Aws::Kendra
|
|
77
87
|
:key,
|
78
88
|
:value_type,
|
79
89
|
:value)
|
90
|
+
SENSITIVE = []
|
80
91
|
include Aws::Structure
|
81
92
|
end
|
82
93
|
|
@@ -91,19 +102,25 @@ module Aws::Kendra
|
|
91
102
|
#
|
92
103
|
class AdditionalResultAttributeValue < Struct.new(
|
93
104
|
:text_with_highlights_value)
|
105
|
+
SENSITIVE = []
|
94
106
|
include Aws::Structure
|
95
107
|
end
|
96
108
|
|
97
109
|
# Provides filtering the query results based on document attributes.
|
98
110
|
#
|
99
111
|
# When you use the `AndAllFilters` or `OrAllFilters`, filters you can
|
100
|
-
# use
|
112
|
+
# use 2 layers under the first attribute filter. For example, you can
|
113
|
+
# use:
|
101
114
|
#
|
102
|
-
#
|
115
|
+
# `<AndAllFilters>`
|
103
116
|
#
|
104
|
-
#
|
117
|
+
# 1. ` <OrAllFilters>`
|
105
118
|
#
|
106
|
-
#
|
119
|
+
# 2. ` <EqualTo>`
|
120
|
+
#
|
121
|
+
# If you use more than 2 layers, you receive a `ValidationException`
|
122
|
+
# exception with the message "`AttributeFilter` cannot have a depth of
|
123
|
+
# more than 2."
|
107
124
|
#
|
108
125
|
# @note When making an API call, you may pass AttributeFilter
|
109
126
|
# data as a hash:
|
@@ -422,12 +439,14 @@ module Aws::Kendra
|
|
422
439
|
#
|
423
440
|
# @!attribute [rw] contains_all
|
424
441
|
# Returns true when a document contains all of the specified document
|
425
|
-
# attributes.
|
442
|
+
# attributes. This filter is only appicable to `StringListValue`
|
443
|
+
# metadata.
|
426
444
|
# @return [Types::DocumentAttribute]
|
427
445
|
#
|
428
446
|
# @!attribute [rw] contains_any
|
429
447
|
# Returns true when a document contains any of the specified document
|
430
|
-
# attributes.
|
448
|
+
# attributes.This filter is only appicable to `StringListValue`
|
449
|
+
# metadata.
|
431
450
|
# @return [Types::DocumentAttribute]
|
432
451
|
#
|
433
452
|
# @!attribute [rw] greater_than
|
@@ -464,6 +483,7 @@ module Aws::Kendra
|
|
464
483
|
:greater_than_or_equals,
|
465
484
|
:less_than,
|
466
485
|
:less_than_or_equals)
|
486
|
+
SENSITIVE = []
|
467
487
|
include Aws::Structure
|
468
488
|
end
|
469
489
|
|
@@ -473,6 +493,10 @@ module Aws::Kendra
|
|
473
493
|
# {
|
474
494
|
# index_id: "IndexId", # required
|
475
495
|
# document_id_list: ["DocumentId"], # required
|
496
|
+
# data_source_sync_job_metric_target: {
|
497
|
+
# data_source_id: "DataSourceId", # required
|
498
|
+
# data_source_sync_job_id: "DataSourceSyncJobId", # required
|
499
|
+
# },
|
476
500
|
# }
|
477
501
|
#
|
478
502
|
# @!attribute [rw] index_id
|
@@ -483,11 +507,17 @@ module Aws::Kendra
|
|
483
507
|
# One or more identifiers for documents to delete from the index.
|
484
508
|
# @return [Array<String>]
|
485
509
|
#
|
510
|
+
# @!attribute [rw] data_source_sync_job_metric_target
|
511
|
+
# Maps a particular data source sync job to a particular data source.
|
512
|
+
# @return [Types::DataSourceSyncJobMetricTarget]
|
513
|
+
#
|
486
514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteDocumentRequest AWS API Documentation
|
487
515
|
#
|
488
516
|
class BatchDeleteDocumentRequest < Struct.new(
|
489
517
|
:index_id,
|
490
|
-
:document_id_list
|
518
|
+
:document_id_list,
|
519
|
+
:data_source_sync_job_metric_target)
|
520
|
+
SENSITIVE = []
|
491
521
|
include Aws::Structure
|
492
522
|
end
|
493
523
|
|
@@ -501,6 +531,7 @@ module Aws::Kendra
|
|
501
531
|
#
|
502
532
|
class BatchDeleteDocumentResponse < Struct.new(
|
503
533
|
:failed_documents)
|
534
|
+
SENSITIVE = []
|
504
535
|
include Aws::Structure
|
505
536
|
end
|
506
537
|
|
@@ -528,6 +559,7 @@ module Aws::Kendra
|
|
528
559
|
:id,
|
529
560
|
:error_code,
|
530
561
|
:error_message)
|
562
|
+
SENSITIVE = []
|
531
563
|
include Aws::Structure
|
532
564
|
end
|
533
565
|
|
@@ -587,8 +619,20 @@ module Aws::Kendra
|
|
587
619
|
# @!attribute [rw] documents
|
588
620
|
# One or more documents to add to the index.
|
589
621
|
#
|
590
|
-
#
|
591
|
-
#
|
622
|
+
# Documents have the following file size limits.
|
623
|
+
#
|
624
|
+
# * 5 MB total size for inline documents
|
625
|
+
#
|
626
|
+
# * 50 MB total size for files from an S3 bucket
|
627
|
+
#
|
628
|
+
# * 5 MB extracted text for any file
|
629
|
+
#
|
630
|
+
# For more information about file size and transaction per second
|
631
|
+
# quotas, see [Quotas][1].
|
632
|
+
#
|
633
|
+
#
|
634
|
+
#
|
635
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
592
636
|
# @return [Array<Types::Document>]
|
593
637
|
#
|
594
638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentRequest AWS API Documentation
|
@@ -597,6 +641,7 @@ module Aws::Kendra
|
|
597
641
|
:index_id,
|
598
642
|
:role_arn,
|
599
643
|
:documents)
|
644
|
+
SENSITIVE = []
|
600
645
|
include Aws::Structure
|
601
646
|
end
|
602
647
|
|
@@ -607,13 +652,19 @@ module Aws::Kendra
|
|
607
652
|
# index.
|
608
653
|
#
|
609
654
|
# If there was an error adding a document to an index the error is
|
610
|
-
# reported in your AWS CloudWatch log.
|
655
|
+
# reported in your AWS CloudWatch log. For more information, see
|
656
|
+
# [Monitoring Amazon Kendra with Amazon CloudWatch Logs][1]
|
657
|
+
#
|
658
|
+
#
|
659
|
+
#
|
660
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html
|
611
661
|
# @return [Array<Types::BatchPutDocumentResponseFailedDocument>]
|
612
662
|
#
|
613
663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentResponse AWS API Documentation
|
614
664
|
#
|
615
665
|
class BatchPutDocumentResponse < Struct.new(
|
616
666
|
:failed_documents)
|
667
|
+
SENSITIVE = []
|
617
668
|
include Aws::Structure
|
618
669
|
end
|
619
670
|
|
@@ -637,6 +688,38 @@ module Aws::Kendra
|
|
637
688
|
:id,
|
638
689
|
:error_code,
|
639
690
|
:error_message)
|
691
|
+
SENSITIVE = []
|
692
|
+
include Aws::Structure
|
693
|
+
end
|
694
|
+
|
695
|
+
# Specifies capacity units configured for your index. You can add and
|
696
|
+
# remove capacity units to tune an index to your requirements.
|
697
|
+
#
|
698
|
+
# @note When making an API call, you may pass CapacityUnitsConfiguration
|
699
|
+
# data as a hash:
|
700
|
+
#
|
701
|
+
# {
|
702
|
+
# storage_capacity_units: 1, # required
|
703
|
+
# query_capacity_units: 1, # required
|
704
|
+
# }
|
705
|
+
#
|
706
|
+
# @!attribute [rw] storage_capacity_units
|
707
|
+
# The amount of extra storage capacity for an index. Each capacity
|
708
|
+
# unit provides 150 Gb of storage space or 500,000 documents,
|
709
|
+
# whichever is reached first.
|
710
|
+
# @return [Integer]
|
711
|
+
#
|
712
|
+
# @!attribute [rw] query_capacity_units
|
713
|
+
# The amount of extra query capacity for an index. Each capacity unit
|
714
|
+
# provides 0.5 queries per second and 40,000 queries per day.
|
715
|
+
# @return [Integer]
|
716
|
+
#
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CapacityUnitsConfiguration AWS API Documentation
|
718
|
+
#
|
719
|
+
class CapacityUnitsConfiguration < Struct.new(
|
720
|
+
:storage_capacity_units,
|
721
|
+
:query_capacity_units)
|
722
|
+
SENSITIVE = []
|
640
723
|
include Aws::Structure
|
641
724
|
end
|
642
725
|
|
@@ -657,7 +740,7 @@ module Aws::Kendra
|
|
657
740
|
# @return [String]
|
658
741
|
#
|
659
742
|
# @!attribute [rw] click_time
|
660
|
-
# The Unix timestamp of the
|
743
|
+
# The Unix timestamp of the date and time that the result was clicked.
|
661
744
|
# @return [Time]
|
662
745
|
#
|
663
746
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClickFeedback AWS API Documentation
|
@@ -665,6 +748,7 @@ module Aws::Kendra
|
|
665
748
|
class ClickFeedback < Struct.new(
|
666
749
|
:result_id,
|
667
750
|
:click_time)
|
751
|
+
SENSITIVE = []
|
668
752
|
include Aws::Structure
|
669
753
|
end
|
670
754
|
|
@@ -719,6 +803,7 @@ module Aws::Kendra
|
|
719
803
|
:document_title_column_name,
|
720
804
|
:field_mappings,
|
721
805
|
:change_detecting_columns)
|
806
|
+
SENSITIVE = []
|
722
807
|
include Aws::Structure
|
723
808
|
end
|
724
809
|
|
@@ -729,6 +814,7 @@ module Aws::Kendra
|
|
729
814
|
#
|
730
815
|
class ConflictException < Struct.new(
|
731
816
|
:message)
|
817
|
+
SENSITIVE = []
|
732
818
|
include Aws::Structure
|
733
819
|
end
|
734
820
|
|
@@ -783,6 +869,7 @@ module Aws::Kendra
|
|
783
869
|
:database_name,
|
784
870
|
:table_name,
|
785
871
|
:secret_arn)
|
872
|
+
SENSITIVE = []
|
786
873
|
include Aws::Structure
|
787
874
|
end
|
788
875
|
|
@@ -792,7 +879,7 @@ module Aws::Kendra
|
|
792
879
|
# {
|
793
880
|
# name: "DataSourceName", # required
|
794
881
|
# index_id: "IndexId", # required
|
795
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE
|
882
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
796
883
|
# configuration: { # required
|
797
884
|
# s3_configuration: {
|
798
885
|
# bucket_name: "S3BucketName", # required
|
@@ -855,11 +942,144 @@ module Aws::Kendra
|
|
855
942
|
# acl_configuration: {
|
856
943
|
# allowed_groups_column_name: "ColumnName", # required
|
857
944
|
# },
|
945
|
+
# sql_configuration: {
|
946
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
947
|
+
# },
|
948
|
+
# },
|
949
|
+
# salesforce_configuration: {
|
950
|
+
# server_url: "Url", # required
|
951
|
+
# secret_arn: "SecretArn", # required
|
952
|
+
# standard_object_configurations: [
|
953
|
+
# {
|
954
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
955
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
956
|
+
# document_title_field_name: "DataSourceFieldName",
|
957
|
+
# field_mappings: [
|
958
|
+
# {
|
959
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
960
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
961
|
+
# index_field_name: "IndexFieldName", # required
|
962
|
+
# },
|
963
|
+
# ],
|
964
|
+
# },
|
965
|
+
# ],
|
966
|
+
# knowledge_article_configuration: {
|
967
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
968
|
+
# standard_knowledge_article_type_configuration: {
|
969
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
970
|
+
# document_title_field_name: "DataSourceFieldName",
|
971
|
+
# field_mappings: [
|
972
|
+
# {
|
973
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
974
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
975
|
+
# index_field_name: "IndexFieldName", # required
|
976
|
+
# },
|
977
|
+
# ],
|
978
|
+
# },
|
979
|
+
# custom_knowledge_article_type_configurations: [
|
980
|
+
# {
|
981
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
982
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
983
|
+
# document_title_field_name: "DataSourceFieldName",
|
984
|
+
# field_mappings: [
|
985
|
+
# {
|
986
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
987
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
988
|
+
# index_field_name: "IndexFieldName", # required
|
989
|
+
# },
|
990
|
+
# ],
|
991
|
+
# },
|
992
|
+
# ],
|
993
|
+
# },
|
994
|
+
# chatter_feed_configuration: {
|
995
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
996
|
+
# document_title_field_name: "DataSourceFieldName",
|
997
|
+
# field_mappings: [
|
998
|
+
# {
|
999
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1000
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1001
|
+
# index_field_name: "IndexFieldName", # required
|
1002
|
+
# },
|
1003
|
+
# ],
|
1004
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
1005
|
+
# },
|
1006
|
+
# crawl_attachments: false,
|
1007
|
+
# standard_object_attachment_configuration: {
|
1008
|
+
# document_title_field_name: "DataSourceFieldName",
|
1009
|
+
# field_mappings: [
|
1010
|
+
# {
|
1011
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1012
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1013
|
+
# index_field_name: "IndexFieldName", # required
|
1014
|
+
# },
|
1015
|
+
# ],
|
1016
|
+
# },
|
1017
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1018
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1019
|
+
# },
|
1020
|
+
# one_drive_configuration: {
|
1021
|
+
# tenant_domain: "TenantDomain", # required
|
1022
|
+
# secret_arn: "SecretArn", # required
|
1023
|
+
# one_drive_users: { # required
|
1024
|
+
# one_drive_user_list: ["OneDriveUser"],
|
1025
|
+
# one_drive_user_s3_path: {
|
1026
|
+
# bucket: "S3BucketName", # required
|
1027
|
+
# key: "S3ObjectKey", # required
|
1028
|
+
# },
|
1029
|
+
# },
|
1030
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1031
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1032
|
+
# field_mappings: [
|
1033
|
+
# {
|
1034
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1035
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1036
|
+
# index_field_name: "IndexFieldName", # required
|
1037
|
+
# },
|
1038
|
+
# ],
|
1039
|
+
# },
|
1040
|
+
# service_now_configuration: {
|
1041
|
+
# host_url: "ServiceNowHostUrl", # required
|
1042
|
+
# secret_arn: "SecretArn", # required
|
1043
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
1044
|
+
# knowledge_article_configuration: {
|
1045
|
+
# crawl_attachments: false,
|
1046
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1047
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1048
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1049
|
+
# document_title_field_name: "DataSourceFieldName",
|
1050
|
+
# field_mappings: [
|
1051
|
+
# {
|
1052
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1053
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1054
|
+
# index_field_name: "IndexFieldName", # required
|
1055
|
+
# },
|
1056
|
+
# ],
|
1057
|
+
# },
|
1058
|
+
# service_catalog_configuration: {
|
1059
|
+
# crawl_attachments: false,
|
1060
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1061
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1062
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1063
|
+
# document_title_field_name: "DataSourceFieldName",
|
1064
|
+
# field_mappings: [
|
1065
|
+
# {
|
1066
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1067
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1068
|
+
# index_field_name: "IndexFieldName", # required
|
1069
|
+
# },
|
1070
|
+
# ],
|
1071
|
+
# },
|
858
1072
|
# },
|
859
1073
|
# },
|
860
1074
|
# description: "Description",
|
861
1075
|
# schedule: "ScanSchedule",
|
862
1076
|
# role_arn: "RoleArn", # required
|
1077
|
+
# tags: [
|
1078
|
+
# {
|
1079
|
+
# key: "TagKey", # required
|
1080
|
+
# value: "TagValue", # required
|
1081
|
+
# },
|
1082
|
+
# ],
|
863
1083
|
# }
|
864
1084
|
#
|
865
1085
|
# @!attribute [rw] name
|
@@ -902,6 +1122,12 @@ module Aws::Kendra
|
|
902
1122
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
903
1123
|
# @return [String]
|
904
1124
|
#
|
1125
|
+
# @!attribute [rw] tags
|
1126
|
+
# A list of key-value pairs that identify the data source. You can use
|
1127
|
+
# the tags to identify and organize your resources and to control
|
1128
|
+
# access to resources.
|
1129
|
+
# @return [Array<Types::Tag>]
|
1130
|
+
#
|
905
1131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceRequest AWS API Documentation
|
906
1132
|
#
|
907
1133
|
class CreateDataSourceRequest < Struct.new(
|
@@ -911,7 +1137,9 @@ module Aws::Kendra
|
|
911
1137
|
:configuration,
|
912
1138
|
:description,
|
913
1139
|
:schedule,
|
914
|
-
:role_arn
|
1140
|
+
:role_arn,
|
1141
|
+
:tags)
|
1142
|
+
SENSITIVE = []
|
915
1143
|
include Aws::Structure
|
916
1144
|
end
|
917
1145
|
|
@@ -923,6 +1151,7 @@ module Aws::Kendra
|
|
923
1151
|
#
|
924
1152
|
class CreateDataSourceResponse < Struct.new(
|
925
1153
|
:id)
|
1154
|
+
SENSITIVE = []
|
926
1155
|
include Aws::Structure
|
927
1156
|
end
|
928
1157
|
|
@@ -938,6 +1167,12 @@ module Aws::Kendra
|
|
938
1167
|
# key: "S3ObjectKey", # required
|
939
1168
|
# },
|
940
1169
|
# role_arn: "RoleArn", # required
|
1170
|
+
# tags: [
|
1171
|
+
# {
|
1172
|
+
# key: "TagKey", # required
|
1173
|
+
# value: "TagValue", # required
|
1174
|
+
# },
|
1175
|
+
# ],
|
941
1176
|
# }
|
942
1177
|
#
|
943
1178
|
# @!attribute [rw] index_id
|
@@ -966,6 +1201,12 @@ module Aws::Kendra
|
|
966
1201
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
967
1202
|
# @return [String]
|
968
1203
|
#
|
1204
|
+
# @!attribute [rw] tags
|
1205
|
+
# A list of key-value pairs that identify the FAQ. You can use the
|
1206
|
+
# tags to identify and organize your resources and to control access
|
1207
|
+
# to resources.
|
1208
|
+
# @return [Array<Types::Tag>]
|
1209
|
+
#
|
969
1210
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
|
970
1211
|
#
|
971
1212
|
class CreateFaqRequest < Struct.new(
|
@@ -973,7 +1214,9 @@ module Aws::Kendra
|
|
973
1214
|
:name,
|
974
1215
|
:description,
|
975
1216
|
:s3_path,
|
976
|
-
:role_arn
|
1217
|
+
:role_arn,
|
1218
|
+
:tags)
|
1219
|
+
SENSITIVE = []
|
977
1220
|
include Aws::Structure
|
978
1221
|
end
|
979
1222
|
|
@@ -985,6 +1228,7 @@ module Aws::Kendra
|
|
985
1228
|
#
|
986
1229
|
class CreateFaqResponse < Struct.new(
|
987
1230
|
:id)
|
1231
|
+
SENSITIVE = []
|
988
1232
|
include Aws::Structure
|
989
1233
|
end
|
990
1234
|
|
@@ -993,18 +1237,33 @@ module Aws::Kendra
|
|
993
1237
|
#
|
994
1238
|
# {
|
995
1239
|
# name: "IndexName", # required
|
1240
|
+
# edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
|
996
1241
|
# role_arn: "RoleArn", # required
|
997
1242
|
# server_side_encryption_configuration: {
|
998
1243
|
# kms_key_id: "KmsKeyId",
|
999
1244
|
# },
|
1000
1245
|
# description: "Description",
|
1001
1246
|
# client_token: "ClientTokenName",
|
1247
|
+
# tags: [
|
1248
|
+
# {
|
1249
|
+
# key: "TagKey", # required
|
1250
|
+
# value: "TagValue", # required
|
1251
|
+
# },
|
1252
|
+
# ],
|
1002
1253
|
# }
|
1003
1254
|
#
|
1004
1255
|
# @!attribute [rw] name
|
1005
1256
|
# The name for the new index.
|
1006
1257
|
# @return [String]
|
1007
1258
|
#
|
1259
|
+
# @!attribute [rw] edition
|
1260
|
+
# The Amazon Kendra edition to use for the index. Choose
|
1261
|
+
# `DEVELOPER_EDITION` for indexes intended for development, testing,
|
1262
|
+
# or proof of concept. Use `ENTERPRISE_EDITION` for your production
|
1263
|
+
# databases. Once you set the edition for an index, it can't be
|
1264
|
+
# changed.
|
1265
|
+
# @return [String]
|
1266
|
+
#
|
1008
1267
|
# @!attribute [rw] role_arn
|
1009
1268
|
# An IAM role that gives Amazon Kendra permissions to access your
|
1010
1269
|
# Amazon CloudWatch logs and metrics. This is also the role used when
|
@@ -1031,14 +1290,23 @@ module Aws::Kendra
|
|
1031
1290
|
# not need to pass this option.
|
1032
1291
|
# @return [String]
|
1033
1292
|
#
|
1293
|
+
# @!attribute [rw] tags
|
1294
|
+
# A list of key-value pairs that identify the index. You can use the
|
1295
|
+
# tags to identify and organize your resources and to control access
|
1296
|
+
# to resources.
|
1297
|
+
# @return [Array<Types::Tag>]
|
1298
|
+
#
|
1034
1299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
|
1035
1300
|
#
|
1036
1301
|
class CreateIndexRequest < Struct.new(
|
1037
1302
|
:name,
|
1303
|
+
:edition,
|
1038
1304
|
:role_arn,
|
1039
1305
|
:server_side_encryption_configuration,
|
1040
1306
|
:description,
|
1041
|
-
:client_token
|
1307
|
+
:client_token,
|
1308
|
+
:tags)
|
1309
|
+
SENSITIVE = []
|
1042
1310
|
include Aws::Structure
|
1043
1311
|
end
|
1044
1312
|
|
@@ -1051,6 +1319,7 @@ module Aws::Kendra
|
|
1051
1319
|
#
|
1052
1320
|
class CreateIndexResponse < Struct.new(
|
1053
1321
|
:id)
|
1322
|
+
SENSITIVE = []
|
1054
1323
|
include Aws::Structure
|
1055
1324
|
end
|
1056
1325
|
|
@@ -1121,6 +1390,133 @@ module Aws::Kendra
|
|
1121
1390
|
# acl_configuration: {
|
1122
1391
|
# allowed_groups_column_name: "ColumnName", # required
|
1123
1392
|
# },
|
1393
|
+
# sql_configuration: {
|
1394
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
1395
|
+
# },
|
1396
|
+
# },
|
1397
|
+
# salesforce_configuration: {
|
1398
|
+
# server_url: "Url", # required
|
1399
|
+
# secret_arn: "SecretArn", # required
|
1400
|
+
# standard_object_configurations: [
|
1401
|
+
# {
|
1402
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
1403
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1404
|
+
# document_title_field_name: "DataSourceFieldName",
|
1405
|
+
# field_mappings: [
|
1406
|
+
# {
|
1407
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1408
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1409
|
+
# index_field_name: "IndexFieldName", # required
|
1410
|
+
# },
|
1411
|
+
# ],
|
1412
|
+
# },
|
1413
|
+
# ],
|
1414
|
+
# knowledge_article_configuration: {
|
1415
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
1416
|
+
# standard_knowledge_article_type_configuration: {
|
1417
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1418
|
+
# document_title_field_name: "DataSourceFieldName",
|
1419
|
+
# field_mappings: [
|
1420
|
+
# {
|
1421
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1422
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1423
|
+
# index_field_name: "IndexFieldName", # required
|
1424
|
+
# },
|
1425
|
+
# ],
|
1426
|
+
# },
|
1427
|
+
# custom_knowledge_article_type_configurations: [
|
1428
|
+
# {
|
1429
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
1430
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1431
|
+
# document_title_field_name: "DataSourceFieldName",
|
1432
|
+
# field_mappings: [
|
1433
|
+
# {
|
1434
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1435
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1436
|
+
# index_field_name: "IndexFieldName", # required
|
1437
|
+
# },
|
1438
|
+
# ],
|
1439
|
+
# },
|
1440
|
+
# ],
|
1441
|
+
# },
|
1442
|
+
# chatter_feed_configuration: {
|
1443
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1444
|
+
# document_title_field_name: "DataSourceFieldName",
|
1445
|
+
# field_mappings: [
|
1446
|
+
# {
|
1447
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1448
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1449
|
+
# index_field_name: "IndexFieldName", # required
|
1450
|
+
# },
|
1451
|
+
# ],
|
1452
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
1453
|
+
# },
|
1454
|
+
# crawl_attachments: false,
|
1455
|
+
# standard_object_attachment_configuration: {
|
1456
|
+
# document_title_field_name: "DataSourceFieldName",
|
1457
|
+
# field_mappings: [
|
1458
|
+
# {
|
1459
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1460
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1461
|
+
# index_field_name: "IndexFieldName", # required
|
1462
|
+
# },
|
1463
|
+
# ],
|
1464
|
+
# },
|
1465
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1466
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1467
|
+
# },
|
1468
|
+
# one_drive_configuration: {
|
1469
|
+
# tenant_domain: "TenantDomain", # required
|
1470
|
+
# secret_arn: "SecretArn", # required
|
1471
|
+
# one_drive_users: { # required
|
1472
|
+
# one_drive_user_list: ["OneDriveUser"],
|
1473
|
+
# one_drive_user_s3_path: {
|
1474
|
+
# bucket: "S3BucketName", # required
|
1475
|
+
# key: "S3ObjectKey", # required
|
1476
|
+
# },
|
1477
|
+
# },
|
1478
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1479
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1480
|
+
# field_mappings: [
|
1481
|
+
# {
|
1482
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1483
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1484
|
+
# index_field_name: "IndexFieldName", # required
|
1485
|
+
# },
|
1486
|
+
# ],
|
1487
|
+
# },
|
1488
|
+
# service_now_configuration: {
|
1489
|
+
# host_url: "ServiceNowHostUrl", # required
|
1490
|
+
# secret_arn: "SecretArn", # required
|
1491
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
1492
|
+
# knowledge_article_configuration: {
|
1493
|
+
# crawl_attachments: false,
|
1494
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1495
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1496
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1497
|
+
# document_title_field_name: "DataSourceFieldName",
|
1498
|
+
# field_mappings: [
|
1499
|
+
# {
|
1500
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1501
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1502
|
+
# index_field_name: "IndexFieldName", # required
|
1503
|
+
# },
|
1504
|
+
# ],
|
1505
|
+
# },
|
1506
|
+
# service_catalog_configuration: {
|
1507
|
+
# crawl_attachments: false,
|
1508
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1509
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1510
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
1511
|
+
# document_title_field_name: "DataSourceFieldName",
|
1512
|
+
# field_mappings: [
|
1513
|
+
# {
|
1514
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
1515
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1516
|
+
# index_field_name: "IndexFieldName", # required
|
1517
|
+
# },
|
1518
|
+
# ],
|
1519
|
+
# },
|
1124
1520
|
# },
|
1125
1521
|
# }
|
1126
1522
|
#
|
@@ -1138,12 +1534,31 @@ module Aws::Kendra
|
|
1138
1534
|
# Provides information necessary to create a connector for a database.
|
1139
1535
|
# @return [Types::DatabaseConfiguration]
|
1140
1536
|
#
|
1537
|
+
# @!attribute [rw] salesforce_configuration
|
1538
|
+
# Provides configuration information for data sources that connect to
|
1539
|
+
# a Salesforce site.
|
1540
|
+
# @return [Types::SalesforceConfiguration]
|
1541
|
+
#
|
1542
|
+
# @!attribute [rw] one_drive_configuration
|
1543
|
+
# Provided configuration for data sources that connect to Microsoft
|
1544
|
+
# OneDrive.
|
1545
|
+
# @return [Types::OneDriveConfiguration]
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] service_now_configuration
|
1548
|
+
# Provides configuration for data sources that connect to ServiceNow
|
1549
|
+
# instances.
|
1550
|
+
# @return [Types::ServiceNowConfiguration]
|
1551
|
+
#
|
1141
1552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
1142
1553
|
#
|
1143
1554
|
class DataSourceConfiguration < Struct.new(
|
1144
1555
|
:s3_configuration,
|
1145
1556
|
:share_point_configuration,
|
1146
|
-
:database_configuration
|
1557
|
+
:database_configuration,
|
1558
|
+
:salesforce_configuration,
|
1559
|
+
:one_drive_configuration,
|
1560
|
+
:service_now_configuration)
|
1561
|
+
SENSITIVE = []
|
1147
1562
|
include Aws::Structure
|
1148
1563
|
end
|
1149
1564
|
|
@@ -1184,6 +1599,7 @@ module Aws::Kendra
|
|
1184
1599
|
:created_at,
|
1185
1600
|
:updated_at,
|
1186
1601
|
:status)
|
1602
|
+
SENSITIVE = []
|
1187
1603
|
include Aws::Structure
|
1188
1604
|
end
|
1189
1605
|
|
@@ -1225,6 +1641,12 @@ module Aws::Kendra
|
|
1225
1641
|
# identifies the error.
|
1226
1642
|
# @return [String]
|
1227
1643
|
#
|
1644
|
+
# @!attribute [rw] metrics
|
1645
|
+
# Maps a batch delete document request to a specific data source sync
|
1646
|
+
# job. This is optional and should only be supplied when documents are
|
1647
|
+
# deleted by a connector.
|
1648
|
+
# @return [Types::DataSourceSyncJobMetrics]
|
1649
|
+
#
|
1228
1650
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJob AWS API Documentation
|
1229
1651
|
#
|
1230
1652
|
class DataSourceSyncJob < Struct.new(
|
@@ -1234,7 +1656,77 @@ module Aws::Kendra
|
|
1234
1656
|
:status,
|
1235
1657
|
:error_message,
|
1236
1658
|
:error_code,
|
1237
|
-
:data_source_error_code
|
1659
|
+
:data_source_error_code,
|
1660
|
+
:metrics)
|
1661
|
+
SENSITIVE = []
|
1662
|
+
include Aws::Structure
|
1663
|
+
end
|
1664
|
+
|
1665
|
+
# Maps a particular data source sync job to a particular data source.
|
1666
|
+
#
|
1667
|
+
# @note When making an API call, you may pass DataSourceSyncJobMetricTarget
|
1668
|
+
# data as a hash:
|
1669
|
+
#
|
1670
|
+
# {
|
1671
|
+
# data_source_id: "DataSourceId", # required
|
1672
|
+
# data_source_sync_job_id: "DataSourceSyncJobId", # required
|
1673
|
+
# }
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] data_source_id
|
1676
|
+
# The ID of the data source that is running the sync job.
|
1677
|
+
# @return [String]
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] data_source_sync_job_id
|
1680
|
+
# The ID of the sync job that is running on the data source.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
|
1684
|
+
#
|
1685
|
+
class DataSourceSyncJobMetricTarget < Struct.new(
|
1686
|
+
:data_source_id,
|
1687
|
+
:data_source_sync_job_id)
|
1688
|
+
SENSITIVE = []
|
1689
|
+
include Aws::Structure
|
1690
|
+
end
|
1691
|
+
|
1692
|
+
# Maps a batch delete document request to a specific data source sync
|
1693
|
+
# job. This is optional and should only be supplied when documents are
|
1694
|
+
# deleted by a connector.
|
1695
|
+
#
|
1696
|
+
# @!attribute [rw] documents_added
|
1697
|
+
# The number of documents added from the data source up to now in the
|
1698
|
+
# data source sync.
|
1699
|
+
# @return [String]
|
1700
|
+
#
|
1701
|
+
# @!attribute [rw] documents_modified
|
1702
|
+
# The number of documents modified in the data source up to now in the
|
1703
|
+
# data source sync run.
|
1704
|
+
# @return [String]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] documents_deleted
|
1707
|
+
# The number of documents deleted from the data source up to now in
|
1708
|
+
# the data source sync run.
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] documents_failed
|
1712
|
+
# The number of documents that failed to sync from the data source up
|
1713
|
+
# to now in the data source sync run.
|
1714
|
+
# @return [String]
|
1715
|
+
#
|
1716
|
+
# @!attribute [rw] documents_scanned
|
1717
|
+
# The current number of documents crawled by the current sync job in
|
1718
|
+
# the data source.
|
1719
|
+
# @return [String]
|
1720
|
+
#
|
1721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetrics AWS API Documentation
|
1722
|
+
#
|
1723
|
+
class DataSourceSyncJobMetrics < Struct.new(
|
1724
|
+
:documents_added,
|
1725
|
+
:documents_modified,
|
1726
|
+
:documents_deleted,
|
1727
|
+
:documents_failed,
|
1728
|
+
:documents_scanned)
|
1729
|
+
SENSITIVE = []
|
1238
1730
|
include Aws::Structure
|
1239
1731
|
end
|
1240
1732
|
|
@@ -1269,6 +1761,7 @@ module Aws::Kendra
|
|
1269
1761
|
:data_source_field_name,
|
1270
1762
|
:date_field_format,
|
1271
1763
|
:index_field_name)
|
1764
|
+
SENSITIVE = []
|
1272
1765
|
include Aws::Structure
|
1273
1766
|
end
|
1274
1767
|
|
@@ -1299,6 +1792,7 @@ module Aws::Kendra
|
|
1299
1792
|
class DataSourceVpcConfiguration < Struct.new(
|
1300
1793
|
:subnet_ids,
|
1301
1794
|
:security_group_ids)
|
1795
|
+
SENSITIVE = []
|
1302
1796
|
include Aws::Structure
|
1303
1797
|
end
|
1304
1798
|
|
@@ -1336,6 +1830,9 @@ module Aws::Kendra
|
|
1336
1830
|
# acl_configuration: {
|
1337
1831
|
# allowed_groups_column_name: "ColumnName", # required
|
1338
1832
|
# },
|
1833
|
+
# sql_configuration: {
|
1834
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
1835
|
+
# },
|
1339
1836
|
# }
|
1340
1837
|
#
|
1341
1838
|
# @!attribute [rw] database_engine_type
|
@@ -1360,6 +1857,11 @@ module Aws::Kendra
|
|
1360
1857
|
# user context filtering.
|
1361
1858
|
# @return [Types::AclConfiguration]
|
1362
1859
|
#
|
1860
|
+
# @!attribute [rw] sql_configuration
|
1861
|
+
# Provides information about how Amazon Kendra uses quote marks around
|
1862
|
+
# SQL identifiers when querying a database data source.
|
1863
|
+
# @return [Types::SqlConfiguration]
|
1864
|
+
#
|
1363
1865
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DatabaseConfiguration AWS API Documentation
|
1364
1866
|
#
|
1365
1867
|
class DatabaseConfiguration < Struct.new(
|
@@ -1367,7 +1869,34 @@ module Aws::Kendra
|
|
1367
1869
|
:connection_configuration,
|
1368
1870
|
:vpc_configuration,
|
1369
1871
|
:column_configuration,
|
1370
|
-
:acl_configuration
|
1872
|
+
:acl_configuration,
|
1873
|
+
:sql_configuration)
|
1874
|
+
SENSITIVE = []
|
1875
|
+
include Aws::Structure
|
1876
|
+
end
|
1877
|
+
|
1878
|
+
# @note When making an API call, you may pass DeleteDataSourceRequest
|
1879
|
+
# data as a hash:
|
1880
|
+
#
|
1881
|
+
# {
|
1882
|
+
# id: "DataSourceId", # required
|
1883
|
+
# index_id: "IndexId", # required
|
1884
|
+
# }
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] id
|
1887
|
+
# The unique identifier of the data source to delete.
|
1888
|
+
# @return [String]
|
1889
|
+
#
|
1890
|
+
# @!attribute [rw] index_id
|
1891
|
+
# The unique identifier of the index associated with the data source.
|
1892
|
+
# @return [String]
|
1893
|
+
#
|
1894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
|
1895
|
+
#
|
1896
|
+
class DeleteDataSourceRequest < Struct.new(
|
1897
|
+
:id,
|
1898
|
+
:index_id)
|
1899
|
+
SENSITIVE = []
|
1371
1900
|
include Aws::Structure
|
1372
1901
|
end
|
1373
1902
|
|
@@ -1392,6 +1921,7 @@ module Aws::Kendra
|
|
1392
1921
|
class DeleteFaqRequest < Struct.new(
|
1393
1922
|
:id,
|
1394
1923
|
:index_id)
|
1924
|
+
SENSITIVE = []
|
1395
1925
|
include Aws::Structure
|
1396
1926
|
end
|
1397
1927
|
|
@@ -1410,6 +1940,7 @@ module Aws::Kendra
|
|
1410
1940
|
#
|
1411
1941
|
class DeleteIndexRequest < Struct.new(
|
1412
1942
|
:id)
|
1943
|
+
SENSITIVE = []
|
1413
1944
|
include Aws::Structure
|
1414
1945
|
end
|
1415
1946
|
|
@@ -1434,6 +1965,7 @@ module Aws::Kendra
|
|
1434
1965
|
class DescribeDataSourceRequest < Struct.new(
|
1435
1966
|
:id,
|
1436
1967
|
:index_id)
|
1968
|
+
SENSITIVE = []
|
1437
1969
|
include Aws::Structure
|
1438
1970
|
end
|
1439
1971
|
|
@@ -1508,6 +2040,7 @@ module Aws::Kendra
|
|
1508
2040
|
:schedule,
|
1509
2041
|
:role_arn,
|
1510
2042
|
:error_message)
|
2043
|
+
SENSITIVE = []
|
1511
2044
|
include Aws::Structure
|
1512
2045
|
end
|
1513
2046
|
|
@@ -1532,6 +2065,7 @@ module Aws::Kendra
|
|
1532
2065
|
class DescribeFaqRequest < Struct.new(
|
1533
2066
|
:id,
|
1534
2067
|
:index_id)
|
2068
|
+
SENSITIVE = []
|
1535
2069
|
include Aws::Structure
|
1536
2070
|
end
|
1537
2071
|
|
@@ -1591,6 +2125,7 @@ module Aws::Kendra
|
|
1591
2125
|
:status,
|
1592
2126
|
:role_arn,
|
1593
2127
|
:error_message)
|
2128
|
+
SENSITIVE = []
|
1594
2129
|
include Aws::Structure
|
1595
2130
|
end
|
1596
2131
|
|
@@ -1609,6 +2144,7 @@ module Aws::Kendra
|
|
1609
2144
|
#
|
1610
2145
|
class DescribeIndexRequest < Struct.new(
|
1611
2146
|
:id)
|
2147
|
+
SENSITIVE = []
|
1612
2148
|
include Aws::Structure
|
1613
2149
|
end
|
1614
2150
|
|
@@ -1620,6 +2156,11 @@ module Aws::Kendra
|
|
1620
2156
|
# the name of the index.
|
1621
2157
|
# @return [String]
|
1622
2158
|
#
|
2159
|
+
# @!attribute [rw] edition
|
2160
|
+
# The Amazon Kendra edition used for the index. You decide the edition
|
2161
|
+
# when you create the index.
|
2162
|
+
# @return [String]
|
2163
|
+
#
|
1623
2164
|
# @!attribute [rw] role_arn
|
1624
2165
|
# The Amazon Resource Name (ARN) of the IAM role that gives Amazon
|
1625
2166
|
# Kendra permission to write to your Amazon Cloudwatch logs.
|
@@ -1663,11 +2204,20 @@ module Aws::Kendra
|
|
1663
2204
|
# contains a message that explains why.
|
1664
2205
|
# @return [String]
|
1665
2206
|
#
|
2207
|
+
# @!attribute [rw] capacity_units
|
2208
|
+
# For enterprise edtion indexes, you can choose to use additional
|
2209
|
+
# capacity to meet the needs of your application. This contains the
|
2210
|
+
# capacity units used for the index. A 0 for the query capacity or the
|
2211
|
+
# storage capacity indicates that the index is using the default
|
2212
|
+
# capacity for the index.
|
2213
|
+
# @return [Types::CapacityUnitsConfiguration]
|
2214
|
+
#
|
1666
2215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
|
1667
2216
|
#
|
1668
2217
|
class DescribeIndexResponse < Struct.new(
|
1669
2218
|
:name,
|
1670
2219
|
:id,
|
2220
|
+
:edition,
|
1671
2221
|
:role_arn,
|
1672
2222
|
:server_side_encryption_configuration,
|
1673
2223
|
:status,
|
@@ -1676,7 +2226,9 @@ module Aws::Kendra
|
|
1676
2226
|
:updated_at,
|
1677
2227
|
:document_metadata_configurations,
|
1678
2228
|
:index_statistics,
|
1679
|
-
:error_message
|
2229
|
+
:error_message,
|
2230
|
+
:capacity_units)
|
2231
|
+
SENSITIVE = []
|
1680
2232
|
include Aws::Structure
|
1681
2233
|
end
|
1682
2234
|
|
@@ -1761,6 +2313,7 @@ module Aws::Kendra
|
|
1761
2313
|
:attributes,
|
1762
2314
|
:access_control_list,
|
1763
2315
|
:content_type)
|
2316
|
+
SENSITIVE = []
|
1764
2317
|
include Aws::Structure
|
1765
2318
|
end
|
1766
2319
|
|
@@ -1792,6 +2345,7 @@ module Aws::Kendra
|
|
1792
2345
|
class DocumentAttribute < Struct.new(
|
1793
2346
|
:key,
|
1794
2347
|
:value)
|
2348
|
+
SENSITIVE = []
|
1795
2349
|
include Aws::Structure
|
1796
2350
|
end
|
1797
2351
|
|
@@ -1821,7 +2375,7 @@ module Aws::Kendra
|
|
1821
2375
|
# @return [Integer]
|
1822
2376
|
#
|
1823
2377
|
# @!attribute [rw] date_value
|
1824
|
-
# A date
|
2378
|
+
# A date expressed as an ISO 8601 string.
|
1825
2379
|
# @return [Time]
|
1826
2380
|
#
|
1827
2381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
|
@@ -1831,6 +2385,7 @@ module Aws::Kendra
|
|
1831
2385
|
:string_list_value,
|
1832
2386
|
:long_value,
|
1833
2387
|
:date_value)
|
2388
|
+
SENSITIVE = []
|
1834
2389
|
include Aws::Structure
|
1835
2390
|
end
|
1836
2391
|
|
@@ -1851,6 +2406,7 @@ module Aws::Kendra
|
|
1851
2406
|
class DocumentAttributeValueCountPair < Struct.new(
|
1852
2407
|
:document_attribute_value,
|
1853
2408
|
:count)
|
2409
|
+
SENSITIVE = []
|
1854
2410
|
include Aws::Structure
|
1855
2411
|
end
|
1856
2412
|
|
@@ -1875,6 +2431,7 @@ module Aws::Kendra
|
|
1875
2431
|
# facetable: false,
|
1876
2432
|
# searchable: false,
|
1877
2433
|
# displayable: false,
|
2434
|
+
# sortable: false,
|
1878
2435
|
# },
|
1879
2436
|
# }
|
1880
2437
|
#
|
@@ -1902,6 +2459,7 @@ module Aws::Kendra
|
|
1902
2459
|
:type,
|
1903
2460
|
:relevance,
|
1904
2461
|
:search)
|
2462
|
+
SENSITIVE = []
|
1905
2463
|
include Aws::Structure
|
1906
2464
|
end
|
1907
2465
|
|
@@ -1927,10 +2485,11 @@ module Aws::Kendra
|
|
1927
2485
|
#
|
1928
2486
|
class DocumentsMetadataConfiguration < Struct.new(
|
1929
2487
|
:s3_prefix)
|
2488
|
+
SENSITIVE = []
|
1930
2489
|
include Aws::Structure
|
1931
2490
|
end
|
1932
2491
|
|
1933
|
-
# Information a document attribute
|
2492
|
+
# Information about a document attribute
|
1934
2493
|
#
|
1935
2494
|
# @note When making an API call, you may pass Facet
|
1936
2495
|
# data as a hash:
|
@@ -1947,6 +2506,7 @@ module Aws::Kendra
|
|
1947
2506
|
#
|
1948
2507
|
class Facet < Struct.new(
|
1949
2508
|
:document_attribute_key)
|
2509
|
+
SENSITIVE = []
|
1950
2510
|
include Aws::Structure
|
1951
2511
|
end
|
1952
2512
|
|
@@ -1968,6 +2528,7 @@ module Aws::Kendra
|
|
1968
2528
|
class FacetResult < Struct.new(
|
1969
2529
|
:document_attribute_key,
|
1970
2530
|
:document_attribute_value_count_pairs)
|
2531
|
+
SENSITIVE = []
|
1971
2532
|
include Aws::Structure
|
1972
2533
|
end
|
1973
2534
|
|
@@ -1983,6 +2544,7 @@ module Aws::Kendra
|
|
1983
2544
|
#
|
1984
2545
|
class FaqStatistics < Struct.new(
|
1985
2546
|
:indexed_question_answers_count)
|
2547
|
+
SENSITIVE = []
|
1986
2548
|
include Aws::Structure
|
1987
2549
|
end
|
1988
2550
|
|
@@ -2019,6 +2581,7 @@ module Aws::Kendra
|
|
2019
2581
|
:status,
|
2020
2582
|
:created_at,
|
2021
2583
|
:updated_at)
|
2584
|
+
SENSITIVE = []
|
2022
2585
|
include Aws::Structure
|
2023
2586
|
end
|
2024
2587
|
|
@@ -2046,6 +2609,7 @@ module Aws::Kendra
|
|
2046
2609
|
:begin_offset,
|
2047
2610
|
:end_offset,
|
2048
2611
|
:top_answer)
|
2612
|
+
SENSITIVE = []
|
2049
2613
|
include Aws::Structure
|
2050
2614
|
end
|
2051
2615
|
|
@@ -2061,6 +2625,11 @@ module Aws::Kendra
|
|
2061
2625
|
# `UpdateIndex`, and `DeleteIndex`.
|
2062
2626
|
# @return [String]
|
2063
2627
|
#
|
2628
|
+
# @!attribute [rw] edition
|
2629
|
+
# Indicates whether the index is a enterprise edition index or a
|
2630
|
+
# developer edition index.
|
2631
|
+
# @return [String]
|
2632
|
+
#
|
2064
2633
|
# @!attribute [rw] created_at
|
2065
2634
|
# The Unix timestamp when the index was created.
|
2066
2635
|
# @return [Time]
|
@@ -2080,9 +2649,11 @@ module Aws::Kendra
|
|
2080
2649
|
class IndexConfigurationSummary < Struct.new(
|
2081
2650
|
:name,
|
2082
2651
|
:id,
|
2652
|
+
:edition,
|
2083
2653
|
:created_at,
|
2084
2654
|
:updated_at,
|
2085
2655
|
:status)
|
2656
|
+
SENSITIVE = []
|
2086
2657
|
include Aws::Structure
|
2087
2658
|
end
|
2088
2659
|
|
@@ -2102,6 +2673,7 @@ module Aws::Kendra
|
|
2102
2673
|
class IndexStatistics < Struct.new(
|
2103
2674
|
:faq_statistics,
|
2104
2675
|
:text_document_statistics)
|
2676
|
+
SENSITIVE = []
|
2105
2677
|
include Aws::Structure
|
2106
2678
|
end
|
2107
2679
|
|
@@ -2112,6 +2684,7 @@ module Aws::Kendra
|
|
2112
2684
|
#
|
2113
2685
|
class InternalServerException < Struct.new(
|
2114
2686
|
:message)
|
2687
|
+
SENSITIVE = []
|
2115
2688
|
include Aws::Structure
|
2116
2689
|
end
|
2117
2690
|
|
@@ -2127,7 +2700,7 @@ module Aws::Kendra
|
|
2127
2700
|
# start_time: Time.now,
|
2128
2701
|
# end_time: Time.now,
|
2129
2702
|
# },
|
2130
|
-
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
|
2703
|
+
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
|
2131
2704
|
# }
|
2132
2705
|
#
|
2133
2706
|
# @!attribute [rw] id
|
@@ -2169,6 +2742,7 @@ module Aws::Kendra
|
|
2169
2742
|
:max_results,
|
2170
2743
|
:start_time_filter,
|
2171
2744
|
:status_filter)
|
2745
|
+
SENSITIVE = []
|
2172
2746
|
include Aws::Structure
|
2173
2747
|
end
|
2174
2748
|
|
@@ -2190,6 +2764,7 @@ module Aws::Kendra
|
|
2190
2764
|
class ListDataSourceSyncJobsResponse < Struct.new(
|
2191
2765
|
:history,
|
2192
2766
|
:next_token)
|
2767
|
+
SENSITIVE = []
|
2193
2768
|
include Aws::Structure
|
2194
2769
|
end
|
2195
2770
|
|
@@ -2223,6 +2798,7 @@ module Aws::Kendra
|
|
2223
2798
|
:index_id,
|
2224
2799
|
:next_token,
|
2225
2800
|
:max_results)
|
2801
|
+
SENSITIVE = []
|
2226
2802
|
include Aws::Structure
|
2227
2803
|
end
|
2228
2804
|
|
@@ -2241,6 +2817,7 @@ module Aws::Kendra
|
|
2241
2817
|
class ListDataSourcesResponse < Struct.new(
|
2242
2818
|
:summary_items,
|
2243
2819
|
:next_token)
|
2820
|
+
SENSITIVE = []
|
2244
2821
|
include Aws::Structure
|
2245
2822
|
end
|
2246
2823
|
|
@@ -2274,6 +2851,7 @@ module Aws::Kendra
|
|
2274
2851
|
:index_id,
|
2275
2852
|
:next_token,
|
2276
2853
|
:max_results)
|
2854
|
+
SENSITIVE = []
|
2277
2855
|
include Aws::Structure
|
2278
2856
|
end
|
2279
2857
|
|
@@ -2294,6 +2872,7 @@ module Aws::Kendra
|
|
2294
2872
|
class ListFaqsResponse < Struct.new(
|
2295
2873
|
:next_token,
|
2296
2874
|
:faq_summary_items)
|
2875
|
+
SENSITIVE = []
|
2297
2876
|
include Aws::Structure
|
2298
2877
|
end
|
2299
2878
|
|
@@ -2321,6 +2900,7 @@ module Aws::Kendra
|
|
2321
2900
|
class ListIndicesRequest < Struct.new(
|
2322
2901
|
:next_token,
|
2323
2902
|
:max_results)
|
2903
|
+
SENSITIVE = []
|
2324
2904
|
include Aws::Structure
|
2325
2905
|
end
|
2326
2906
|
|
@@ -2339,22 +2919,170 @@ module Aws::Kendra
|
|
2339
2919
|
class ListIndicesResponse < Struct.new(
|
2340
2920
|
:index_configuration_summary_items,
|
2341
2921
|
:next_token)
|
2922
|
+
SENSITIVE = []
|
2342
2923
|
include Aws::Structure
|
2343
2924
|
end
|
2344
2925
|
|
2345
|
-
#
|
2346
|
-
#
|
2347
|
-
# @note When making an API call, you may pass Principal
|
2926
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2348
2927
|
# data as a hash:
|
2349
2928
|
#
|
2350
2929
|
# {
|
2351
|
-
#
|
2352
|
-
# type: "USER", # required, accepts USER, GROUP
|
2353
|
-
# access: "ALLOW", # required, accepts ALLOW, DENY
|
2930
|
+
# resource_arn: "AmazonResourceName", # required
|
2354
2931
|
# }
|
2355
2932
|
#
|
2356
|
-
# @!attribute [rw]
|
2357
|
-
# The
|
2933
|
+
# @!attribute [rw] resource_arn
|
2934
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
2935
|
+
# get a list of tags for.
|
2936
|
+
# @return [String]
|
2937
|
+
#
|
2938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceRequest AWS API Documentation
|
2939
|
+
#
|
2940
|
+
class ListTagsForResourceRequest < Struct.new(
|
2941
|
+
:resource_arn)
|
2942
|
+
SENSITIVE = []
|
2943
|
+
include Aws::Structure
|
2944
|
+
end
|
2945
|
+
|
2946
|
+
# @!attribute [rw] tags
|
2947
|
+
# A list of tags associated with the index, FAQ, or data source.
|
2948
|
+
# @return [Array<Types::Tag>]
|
2949
|
+
#
|
2950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceResponse AWS API Documentation
|
2951
|
+
#
|
2952
|
+
class ListTagsForResourceResponse < Struct.new(
|
2953
|
+
:tags)
|
2954
|
+
SENSITIVE = []
|
2955
|
+
include Aws::Structure
|
2956
|
+
end
|
2957
|
+
|
2958
|
+
# Provides configuration information for data sources that connect to
|
2959
|
+
# OneDrive.
|
2960
|
+
#
|
2961
|
+
# @note When making an API call, you may pass OneDriveConfiguration
|
2962
|
+
# data as a hash:
|
2963
|
+
#
|
2964
|
+
# {
|
2965
|
+
# tenant_domain: "TenantDomain", # required
|
2966
|
+
# secret_arn: "SecretArn", # required
|
2967
|
+
# one_drive_users: { # required
|
2968
|
+
# one_drive_user_list: ["OneDriveUser"],
|
2969
|
+
# one_drive_user_s3_path: {
|
2970
|
+
# bucket: "S3BucketName", # required
|
2971
|
+
# key: "S3ObjectKey", # required
|
2972
|
+
# },
|
2973
|
+
# },
|
2974
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2975
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2976
|
+
# field_mappings: [
|
2977
|
+
# {
|
2978
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2979
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2980
|
+
# index_field_name: "IndexFieldName", # required
|
2981
|
+
# },
|
2982
|
+
# ],
|
2983
|
+
# }
|
2984
|
+
#
|
2985
|
+
# @!attribute [rw] tenant_domain
|
2986
|
+
# Tha Azure Active Directory domain of the organization.
|
2987
|
+
# @return [String]
|
2988
|
+
#
|
2989
|
+
# @!attribute [rw] secret_arn
|
2990
|
+
# The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that
|
2991
|
+
# contains the user name and password to connect to OneDrive. The user
|
2992
|
+
# namd should be the application ID for the OneDrive application, and
|
2993
|
+
# the password is the application key for the OneDrive application.
|
2994
|
+
# @return [String]
|
2995
|
+
#
|
2996
|
+
# @!attribute [rw] one_drive_users
|
2997
|
+
# A list of user accounts whose documents should be indexed.
|
2998
|
+
# @return [Types::OneDriveUsers]
|
2999
|
+
#
|
3000
|
+
# @!attribute [rw] inclusion_patterns
|
3001
|
+
# A list of regular expression patterns. Documents that match the
|
3002
|
+
# pattern are included in the index. Documents that don't match the
|
3003
|
+
# pattern are excluded from the index. If a document matches both an
|
3004
|
+
# inclusion pattern and an exclusion pattern, the document is not
|
3005
|
+
# included in the index.
|
3006
|
+
#
|
3007
|
+
# The exclusion pattern is applied to the file name.
|
3008
|
+
# @return [Array<String>]
|
3009
|
+
#
|
3010
|
+
# @!attribute [rw] exclusion_patterns
|
3011
|
+
# List of regular expressions applied to documents. Items that match
|
3012
|
+
# the exclusion pattern are not indexed. If you provide both an
|
3013
|
+
# inclusion pattern and an exclusion pattern, any item that matches
|
3014
|
+
# the exclusion pattern isn't indexed.
|
3015
|
+
#
|
3016
|
+
# The exclusion pattern is applied to the file name.
|
3017
|
+
# @return [Array<String>]
|
3018
|
+
#
|
3019
|
+
# @!attribute [rw] field_mappings
|
3020
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
|
3021
|
+
# OneDrive fields to custom fields in the Amazon Kendra index. You
|
3022
|
+
# must first create the index fields before you map OneDrive fields.
|
3023
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3024
|
+
#
|
3025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveConfiguration AWS API Documentation
|
3026
|
+
#
|
3027
|
+
class OneDriveConfiguration < Struct.new(
|
3028
|
+
:tenant_domain,
|
3029
|
+
:secret_arn,
|
3030
|
+
:one_drive_users,
|
3031
|
+
:inclusion_patterns,
|
3032
|
+
:exclusion_patterns,
|
3033
|
+
:field_mappings)
|
3034
|
+
SENSITIVE = []
|
3035
|
+
include Aws::Structure
|
3036
|
+
end
|
3037
|
+
|
3038
|
+
# User accounts whose documents should be indexed.
|
3039
|
+
#
|
3040
|
+
# @note When making an API call, you may pass OneDriveUsers
|
3041
|
+
# data as a hash:
|
3042
|
+
#
|
3043
|
+
# {
|
3044
|
+
# one_drive_user_list: ["OneDriveUser"],
|
3045
|
+
# one_drive_user_s3_path: {
|
3046
|
+
# bucket: "S3BucketName", # required
|
3047
|
+
# key: "S3ObjectKey", # required
|
3048
|
+
# },
|
3049
|
+
# }
|
3050
|
+
#
|
3051
|
+
# @!attribute [rw] one_drive_user_list
|
3052
|
+
# A list of users whose documents should be indexed. Specify the user
|
3053
|
+
# names in email format, for example, `username@tenantdomain`. If you
|
3054
|
+
# need to index the documents of more than 100 users, use the
|
3055
|
+
# `OneDriveUserS3Path` field to specify the location of a file
|
3056
|
+
# containing a list of users.
|
3057
|
+
# @return [Array<String>]
|
3058
|
+
#
|
3059
|
+
# @!attribute [rw] one_drive_user_s3_path
|
3060
|
+
# The S3 bucket location of a file containing a list of users whose
|
3061
|
+
# documents should be indexed.
|
3062
|
+
# @return [Types::S3Path]
|
3063
|
+
#
|
3064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveUsers AWS API Documentation
|
3065
|
+
#
|
3066
|
+
class OneDriveUsers < Struct.new(
|
3067
|
+
:one_drive_user_list,
|
3068
|
+
:one_drive_user_s3_path)
|
3069
|
+
SENSITIVE = []
|
3070
|
+
include Aws::Structure
|
3071
|
+
end
|
3072
|
+
|
3073
|
+
# Provides user and group information for document access filtering.
|
3074
|
+
#
|
3075
|
+
# @note When making an API call, you may pass Principal
|
3076
|
+
# data as a hash:
|
3077
|
+
#
|
3078
|
+
# {
|
3079
|
+
# name: "PrincipalName", # required
|
3080
|
+
# type: "USER", # required, accepts USER, GROUP
|
3081
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
3082
|
+
# }
|
3083
|
+
#
|
3084
|
+
# @!attribute [rw] name
|
3085
|
+
# The name of the user or group.
|
2358
3086
|
# @return [String]
|
2359
3087
|
#
|
2360
3088
|
# @!attribute [rw] type
|
@@ -2371,6 +3099,7 @@ module Aws::Kendra
|
|
2371
3099
|
:name,
|
2372
3100
|
:type,
|
2373
3101
|
:access)
|
3102
|
+
SENSITIVE = []
|
2374
3103
|
include Aws::Structure
|
2375
3104
|
end
|
2376
3105
|
|
@@ -2467,6 +3196,10 @@ module Aws::Kendra
|
|
2467
3196
|
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
2468
3197
|
# page_number: 1,
|
2469
3198
|
# page_size: 1,
|
3199
|
+
# sorting_configuration: {
|
3200
|
+
# document_attribute_key: "DocumentAttributeKey", # required
|
3201
|
+
# sort_order: "DESC", # required, accepts DESC, ASC
|
3202
|
+
# },
|
2470
3203
|
# }
|
2471
3204
|
#
|
2472
3205
|
# @!attribute [rw] index_id
|
@@ -2514,9 +3247,22 @@ module Aws::Kendra
|
|
2514
3247
|
#
|
2515
3248
|
# @!attribute [rw] page_size
|
2516
3249
|
# Sets the number of results that are returned in each page of
|
2517
|
-
# results. The default page size is
|
3250
|
+
# results. The default page size is 10. The maximum number of results
|
3251
|
+
# returned is 100. If you ask for more than 100 results, only 100 are
|
3252
|
+
# returned.
|
2518
3253
|
# @return [Integer]
|
2519
3254
|
#
|
3255
|
+
# @!attribute [rw] sorting_configuration
|
3256
|
+
# Provides information that determines how the results of the query
|
3257
|
+
# are sorted. You can set the field that Amazon Kendra should sort the
|
3258
|
+
# results on, and specify whether the results should be sorted in
|
3259
|
+
# ascending or descending order. In the case of ties in sorting the
|
3260
|
+
# results, the results are sorted by relevance.
|
3261
|
+
#
|
3262
|
+
# If you don't provide sorting configuration, the results are sorted
|
3263
|
+
# by the relevance that Amazon Kendra determines for the result.
|
3264
|
+
# @return [Types::SortingConfiguration]
|
3265
|
+
#
|
2520
3266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
2521
3267
|
#
|
2522
3268
|
class QueryRequest < Struct.new(
|
@@ -2527,7 +3273,9 @@ module Aws::Kendra
|
|
2527
3273
|
:requested_document_attributes,
|
2528
3274
|
:query_result_type_filter,
|
2529
3275
|
:page_number,
|
2530
|
-
:page_size
|
3276
|
+
:page_size,
|
3277
|
+
:sorting_configuration)
|
3278
|
+
SENSITIVE = []
|
2531
3279
|
include Aws::Structure
|
2532
3280
|
end
|
2533
3281
|
|
@@ -2558,6 +3306,7 @@ module Aws::Kendra
|
|
2558
3306
|
:result_items,
|
2559
3307
|
:facet_results,
|
2560
3308
|
:total_number_of_results)
|
3309
|
+
SENSITIVE = []
|
2561
3310
|
include Aws::Structure
|
2562
3311
|
end
|
2563
3312
|
|
@@ -2577,6 +3326,7 @@ module Aws::Kendra
|
|
2577
3326
|
# @return [String]
|
2578
3327
|
#
|
2579
3328
|
# @!attribute [rw] additional_attributes
|
3329
|
+
# One or more additional attribues associated with the query result.
|
2580
3330
|
# @return [Array<Types::AdditionalResultAttribute>]
|
2581
3331
|
#
|
2582
3332
|
# @!attribute [rw] document_id
|
@@ -2614,6 +3364,7 @@ module Aws::Kendra
|
|
2614
3364
|
:document_excerpt,
|
2615
3365
|
:document_uri,
|
2616
3366
|
:document_attributes)
|
3367
|
+
SENSITIVE = []
|
2617
3368
|
include Aws::Structure
|
2618
3369
|
end
|
2619
3370
|
|
@@ -2696,6 +3447,7 @@ module Aws::Kendra
|
|
2696
3447
|
:duration,
|
2697
3448
|
:rank_order,
|
2698
3449
|
:value_importance_map)
|
3450
|
+
SENSITIVE = []
|
2699
3451
|
include Aws::Structure
|
2700
3452
|
end
|
2701
3453
|
|
@@ -2725,6 +3477,7 @@ module Aws::Kendra
|
|
2725
3477
|
class RelevanceFeedback < Struct.new(
|
2726
3478
|
:result_id,
|
2727
3479
|
:relevance_value)
|
3480
|
+
SENSITIVE = []
|
2728
3481
|
include Aws::Structure
|
2729
3482
|
end
|
2730
3483
|
|
@@ -2735,6 +3488,7 @@ module Aws::Kendra
|
|
2735
3488
|
#
|
2736
3489
|
class ResourceAlreadyExistException < Struct.new(
|
2737
3490
|
:message)
|
3491
|
+
SENSITIVE = []
|
2738
3492
|
include Aws::Structure
|
2739
3493
|
end
|
2740
3494
|
|
@@ -2745,6 +3499,7 @@ module Aws::Kendra
|
|
2745
3499
|
#
|
2746
3500
|
class ResourceInUseException < Struct.new(
|
2747
3501
|
:message)
|
3502
|
+
SENSITIVE = []
|
2748
3503
|
include Aws::Structure
|
2749
3504
|
end
|
2750
3505
|
|
@@ -2755,6 +3510,7 @@ module Aws::Kendra
|
|
2755
3510
|
#
|
2756
3511
|
class ResourceNotFoundException < Struct.new(
|
2757
3512
|
:message)
|
3513
|
+
SENSITIVE = []
|
2758
3514
|
include Aws::Structure
|
2759
3515
|
end
|
2760
3516
|
|
@@ -2765,6 +3521,7 @@ module Aws::Kendra
|
|
2765
3521
|
#
|
2766
3522
|
class ResourceUnavailableException < Struct.new(
|
2767
3523
|
:message)
|
3524
|
+
SENSITIVE = []
|
2768
3525
|
include Aws::Structure
|
2769
3526
|
end
|
2770
3527
|
|
@@ -2805,7 +3562,7 @@ module Aws::Kendra
|
|
2805
3562
|
#
|
2806
3563
|
#
|
2807
3564
|
#
|
2808
|
-
# [1]:
|
3565
|
+
# [1]: https://en.wikipedia.org/wiki/Glob_(programming)
|
2809
3566
|
# @return [Array<String>]
|
2810
3567
|
#
|
2811
3568
|
# @!attribute [rw] documents_metadata_configuration
|
@@ -2828,6 +3585,7 @@ module Aws::Kendra
|
|
2828
3585
|
:exclusion_patterns,
|
2829
3586
|
:documents_metadata_configuration,
|
2830
3587
|
:access_control_list_configuration)
|
3588
|
+
SENSITIVE = []
|
2831
3589
|
include Aws::Structure
|
2832
3590
|
end
|
2833
3591
|
|
@@ -2854,100 +3612,243 @@ module Aws::Kendra
|
|
2854
3612
|
class S3Path < Struct.new(
|
2855
3613
|
:bucket,
|
2856
3614
|
:key)
|
3615
|
+
SENSITIVE = []
|
2857
3616
|
include Aws::Structure
|
2858
3617
|
end
|
2859
3618
|
|
2860
|
-
#
|
2861
|
-
#
|
3619
|
+
# Defines configuration for syncing a Salesforce chatter feed. The
|
3620
|
+
# contents of the object comes from the Salesforce FeedItem table.
|
2862
3621
|
#
|
2863
|
-
# @note When making an API call, you may pass
|
3622
|
+
# @note When making an API call, you may pass SalesforceChatterFeedConfiguration
|
2864
3623
|
# data as a hash:
|
2865
3624
|
#
|
2866
3625
|
# {
|
2867
|
-
#
|
2868
|
-
#
|
2869
|
-
#
|
3626
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3627
|
+
# document_title_field_name: "DataSourceFieldName",
|
3628
|
+
# field_mappings: [
|
3629
|
+
# {
|
3630
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3631
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3632
|
+
# index_field_name: "IndexFieldName", # required
|
3633
|
+
# },
|
3634
|
+
# ],
|
3635
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
2870
3636
|
# }
|
2871
3637
|
#
|
2872
|
-
# @!attribute [rw]
|
2873
|
-
#
|
2874
|
-
#
|
2875
|
-
#
|
2876
|
-
# @return [Boolean]
|
3638
|
+
# @!attribute [rw] document_data_field_name
|
3639
|
+
# The name of the column in the Salesforce FeedItem table that
|
3640
|
+
# contains the content to index. Typically this is the `Body` column.
|
3641
|
+
# @return [String]
|
2877
3642
|
#
|
2878
|
-
# @!attribute [rw]
|
2879
|
-
#
|
2880
|
-
#
|
2881
|
-
#
|
2882
|
-
#
|
3643
|
+
# @!attribute [rw] document_title_field_name
|
3644
|
+
# The name of the column in the Salesforce FeedItem table that
|
3645
|
+
# contains the title of the document. This is typically the `Title`
|
3646
|
+
# collumn.
|
3647
|
+
# @return [String]
|
3648
|
+
#
|
3649
|
+
# @!attribute [rw] field_mappings
|
3650
|
+
# Maps fields from a Salesforce chatter feed into Amazon Kendra index
|
2883
3651
|
# fields.
|
2884
|
-
# @return [
|
3652
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
2885
3653
|
#
|
2886
|
-
# @!attribute [rw]
|
2887
|
-
#
|
2888
|
-
#
|
2889
|
-
#
|
3654
|
+
# @!attribute [rw] include_filter_types
|
3655
|
+
# Filters the documents in the feed based on status of the user. When
|
3656
|
+
# you specify `ACTIVE_USERS` only documents from users who have an
|
3657
|
+
# active account are indexed. When you specify `STANDARD_USER` only
|
3658
|
+
# documents for Salesforce standard users are documented. You can
|
3659
|
+
# specify both.
|
3660
|
+
# @return [Array<String>]
|
2890
3661
|
#
|
2891
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/
|
3662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceChatterFeedConfiguration AWS API Documentation
|
2892
3663
|
#
|
2893
|
-
class
|
2894
|
-
:
|
2895
|
-
:
|
2896
|
-
:
|
3664
|
+
class SalesforceChatterFeedConfiguration < Struct.new(
|
3665
|
+
:document_data_field_name,
|
3666
|
+
:document_title_field_name,
|
3667
|
+
:field_mappings,
|
3668
|
+
:include_filter_types)
|
3669
|
+
SENSITIVE = []
|
2897
3670
|
include Aws::Structure
|
2898
3671
|
end
|
2899
3672
|
|
2900
|
-
# Provides
|
2901
|
-
#
|
2902
|
-
# support asymmetric CMKs.
|
3673
|
+
# Provides configuration information for connecting to a Salesforce data
|
3674
|
+
# source.
|
2903
3675
|
#
|
2904
|
-
# @note When making an API call, you may pass
|
3676
|
+
# @note When making an API call, you may pass SalesforceConfiguration
|
2905
3677
|
# data as a hash:
|
2906
3678
|
#
|
2907
3679
|
# {
|
2908
|
-
#
|
3680
|
+
# server_url: "Url", # required
|
3681
|
+
# secret_arn: "SecretArn", # required
|
3682
|
+
# standard_object_configurations: [
|
3683
|
+
# {
|
3684
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
3685
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3686
|
+
# document_title_field_name: "DataSourceFieldName",
|
3687
|
+
# field_mappings: [
|
3688
|
+
# {
|
3689
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3690
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3691
|
+
# index_field_name: "IndexFieldName", # required
|
3692
|
+
# },
|
3693
|
+
# ],
|
3694
|
+
# },
|
3695
|
+
# ],
|
3696
|
+
# knowledge_article_configuration: {
|
3697
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
3698
|
+
# standard_knowledge_article_type_configuration: {
|
3699
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3700
|
+
# document_title_field_name: "DataSourceFieldName",
|
3701
|
+
# field_mappings: [
|
3702
|
+
# {
|
3703
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3704
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3705
|
+
# index_field_name: "IndexFieldName", # required
|
3706
|
+
# },
|
3707
|
+
# ],
|
3708
|
+
# },
|
3709
|
+
# custom_knowledge_article_type_configurations: [
|
3710
|
+
# {
|
3711
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
3712
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3713
|
+
# document_title_field_name: "DataSourceFieldName",
|
3714
|
+
# field_mappings: [
|
3715
|
+
# {
|
3716
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3717
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3718
|
+
# index_field_name: "IndexFieldName", # required
|
3719
|
+
# },
|
3720
|
+
# ],
|
3721
|
+
# },
|
3722
|
+
# ],
|
3723
|
+
# },
|
3724
|
+
# chatter_feed_configuration: {
|
3725
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3726
|
+
# document_title_field_name: "DataSourceFieldName",
|
3727
|
+
# field_mappings: [
|
3728
|
+
# {
|
3729
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3730
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3731
|
+
# index_field_name: "IndexFieldName", # required
|
3732
|
+
# },
|
3733
|
+
# ],
|
3734
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
3735
|
+
# },
|
3736
|
+
# crawl_attachments: false,
|
3737
|
+
# standard_object_attachment_configuration: {
|
3738
|
+
# document_title_field_name: "DataSourceFieldName",
|
3739
|
+
# field_mappings: [
|
3740
|
+
# {
|
3741
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3742
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3743
|
+
# index_field_name: "IndexFieldName", # required
|
3744
|
+
# },
|
3745
|
+
# ],
|
3746
|
+
# },
|
3747
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3748
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2909
3749
|
# }
|
2910
3750
|
#
|
2911
|
-
# @!attribute [rw]
|
2912
|
-
# The
|
2913
|
-
# Kendra doesn't support asymmetric CMKs.
|
3751
|
+
# @!attribute [rw] server_url
|
3752
|
+
# The instance URL for the Salesforce site that you want to index.
|
2914
3753
|
# @return [String]
|
2915
3754
|
#
|
2916
|
-
#
|
3755
|
+
# @!attribute [rw] secret_arn
|
3756
|
+
# The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that
|
3757
|
+
# contains the key/value pairs required to connect to your Salesforce
|
3758
|
+
# instance. The secret must contain a JSON structure with the
|
3759
|
+
# following keys:
|
2917
3760
|
#
|
2918
|
-
|
2919
|
-
|
2920
|
-
|
2921
|
-
|
2922
|
-
|
2923
|
-
#
|
3761
|
+
# * authenticationUrl - The OAUTH endpoint that Amazon Kendra connects
|
3762
|
+
# to get an OAUTH token.
|
3763
|
+
#
|
3764
|
+
# * consumerKey - The application public key generated when you
|
3765
|
+
# created your Salesforce application.
|
3766
|
+
#
|
3767
|
+
# * consumerSecret - The application private key generated when you
|
3768
|
+
# created your Salesforce application.
|
3769
|
+
#
|
3770
|
+
# * password - The password associated with the user logging in to the
|
3771
|
+
# Salesforce instance.
|
3772
|
+
#
|
3773
|
+
# * securityToken - The token associated with the user account logging
|
3774
|
+
# in to the Salesforce instance.
|
3775
|
+
#
|
3776
|
+
# * username - The user name of the user logging in to the Salesforce
|
3777
|
+
# instance.
|
2924
3778
|
# @return [String]
|
2925
3779
|
#
|
2926
|
-
#
|
3780
|
+
# @!attribute [rw] standard_object_configurations
|
3781
|
+
# Specifies the Salesforce standard objects that Amazon Kendra
|
3782
|
+
# indexes.
|
3783
|
+
# @return [Array<Types::SalesforceStandardObjectConfiguration>]
|
2927
3784
|
#
|
2928
|
-
|
2929
|
-
|
3785
|
+
# @!attribute [rw] knowledge_article_configuration
|
3786
|
+
# Specifies configuration information for the knowlege article types
|
3787
|
+
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
3788
|
+
# articles and the standard fields of knowledge articles, or the
|
3789
|
+
# custom fields of custom knowledge articles, but not both.
|
3790
|
+
# @return [Types::SalesforceKnowledgeArticleConfiguration]
|
3791
|
+
#
|
3792
|
+
# @!attribute [rw] chatter_feed_configuration
|
3793
|
+
# Specifies configuration information for Salesforce chatter feeds.
|
3794
|
+
# @return [Types::SalesforceChatterFeedConfiguration]
|
3795
|
+
#
|
3796
|
+
# @!attribute [rw] crawl_attachments
|
3797
|
+
# Indicates whether Amazon Kendra should index attachments to
|
3798
|
+
# Salesforce objects.
|
3799
|
+
# @return [Boolean]
|
3800
|
+
#
|
3801
|
+
# @!attribute [rw] standard_object_attachment_configuration
|
3802
|
+
# Provides configuration information for processing attachments to
|
3803
|
+
# Salesforce standard objects.
|
3804
|
+
# @return [Types::SalesforceStandardObjectAttachmentConfiguration]
|
3805
|
+
#
|
3806
|
+
# @!attribute [rw] include_attachment_file_patterns
|
3807
|
+
# A list of regular expression patterns. Documents that match the
|
3808
|
+
# patterns are included in the index. Documents that don't match the
|
3809
|
+
# patterns are excluded from the index. If a document matches both an
|
3810
|
+
# inclusion pattern and an exclusion pattern, the document is not
|
3811
|
+
# included in the index.
|
3812
|
+
#
|
3813
|
+
# The regex is applied to the name of the attached file.
|
3814
|
+
# @return [Array<String>]
|
3815
|
+
#
|
3816
|
+
# @!attribute [rw] exclude_attachment_file_patterns
|
3817
|
+
# A list of regular expression patterns. Documents that match the
|
3818
|
+
# patterns are excluded from the index. Documents that don't match
|
3819
|
+
# the patterns are included in the index. If a document matches both
|
3820
|
+
# an exclusion pattern and an inclusion pattern, the document is not
|
3821
|
+
# included in the index.
|
3822
|
+
#
|
3823
|
+
# The regex is applied to the name of the attached file.
|
3824
|
+
# @return [Array<String>]
|
3825
|
+
#
|
3826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceConfiguration AWS API Documentation
|
3827
|
+
#
|
3828
|
+
class SalesforceConfiguration < Struct.new(
|
3829
|
+
:server_url,
|
3830
|
+
:secret_arn,
|
3831
|
+
:standard_object_configurations,
|
3832
|
+
:knowledge_article_configuration,
|
3833
|
+
:chatter_feed_configuration,
|
3834
|
+
:crawl_attachments,
|
3835
|
+
:standard_object_attachment_configuration,
|
3836
|
+
:include_attachment_file_patterns,
|
3837
|
+
:exclude_attachment_file_patterns)
|
3838
|
+
SENSITIVE = []
|
2930
3839
|
include Aws::Structure
|
2931
3840
|
end
|
2932
3841
|
|
2933
|
-
# Provides configuration information for
|
2934
|
-
#
|
3842
|
+
# Provides configuration information for indexing Salesforce custom
|
3843
|
+
# articles.
|
2935
3844
|
#
|
2936
|
-
# @note When making an API call, you may pass
|
3845
|
+
# @note When making an API call, you may pass SalesforceCustomKnowledgeArticleTypeConfiguration
|
2937
3846
|
# data as a hash:
|
2938
3847
|
#
|
2939
3848
|
# {
|
2940
|
-
#
|
2941
|
-
#
|
2942
|
-
#
|
2943
|
-
# crawl_attachments: false,
|
2944
|
-
# use_change_log: false,
|
2945
|
-
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2946
|
-
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2947
|
-
# vpc_configuration: {
|
2948
|
-
# subnet_ids: ["SubnetId"], # required
|
2949
|
-
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2950
|
-
# },
|
3849
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
3850
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3851
|
+
# document_title_field_name: "DataSourceFieldName",
|
2951
3852
|
# field_mappings: [
|
2952
3853
|
# {
|
2953
3854
|
# data_source_field_name: "DataSourceFieldName", # required
|
@@ -2955,18 +3856,559 @@ module Aws::Kendra
|
|
2955
3856
|
# index_field_name: "IndexFieldName", # required
|
2956
3857
|
# },
|
2957
3858
|
# ],
|
2958
|
-
# document_title_field_name: "DataSourceFieldName",
|
2959
3859
|
# }
|
2960
3860
|
#
|
2961
|
-
# @!attribute [rw]
|
2962
|
-
# The
|
2963
|
-
# source.
|
3861
|
+
# @!attribute [rw] name
|
3862
|
+
# The name of the configuration.
|
2964
3863
|
# @return [String]
|
2965
3864
|
#
|
2966
|
-
# @!attribute [rw]
|
2967
|
-
# The
|
2968
|
-
#
|
2969
|
-
# @return [
|
3865
|
+
# @!attribute [rw] document_data_field_name
|
3866
|
+
# The name of the field in the custom knowledge article that contains
|
3867
|
+
# the document data to index.
|
3868
|
+
# @return [String]
|
3869
|
+
#
|
3870
|
+
# @!attribute [rw] document_title_field_name
|
3871
|
+
# The name of the field in the custom knowledge article that contains
|
3872
|
+
# the document title.
|
3873
|
+
# @return [String]
|
3874
|
+
#
|
3875
|
+
# @!attribute [rw] field_mappings
|
3876
|
+
# One or more objects that map fields in the custom knowledge article
|
3877
|
+
# to fields in the Amazon Kendra index.
|
3878
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3879
|
+
#
|
3880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration AWS API Documentation
|
3881
|
+
#
|
3882
|
+
class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
|
3883
|
+
:name,
|
3884
|
+
:document_data_field_name,
|
3885
|
+
:document_title_field_name,
|
3886
|
+
:field_mappings)
|
3887
|
+
SENSITIVE = []
|
3888
|
+
include Aws::Structure
|
3889
|
+
end
|
3890
|
+
|
3891
|
+
# Specifies configuration information for the knowlege article types
|
3892
|
+
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
3893
|
+
# articles and the standard fields of knowledge articles, or the custom
|
3894
|
+
# fields of custom knowledge articles, but not both
|
3895
|
+
#
|
3896
|
+
# @note When making an API call, you may pass SalesforceKnowledgeArticleConfiguration
|
3897
|
+
# data as a hash:
|
3898
|
+
#
|
3899
|
+
# {
|
3900
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
3901
|
+
# standard_knowledge_article_type_configuration: {
|
3902
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3903
|
+
# document_title_field_name: "DataSourceFieldName",
|
3904
|
+
# field_mappings: [
|
3905
|
+
# {
|
3906
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3907
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3908
|
+
# index_field_name: "IndexFieldName", # required
|
3909
|
+
# },
|
3910
|
+
# ],
|
3911
|
+
# },
|
3912
|
+
# custom_knowledge_article_type_configurations: [
|
3913
|
+
# {
|
3914
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
3915
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3916
|
+
# document_title_field_name: "DataSourceFieldName",
|
3917
|
+
# field_mappings: [
|
3918
|
+
# {
|
3919
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3920
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3921
|
+
# index_field_name: "IndexFieldName", # required
|
3922
|
+
# },
|
3923
|
+
# ],
|
3924
|
+
# },
|
3925
|
+
# ],
|
3926
|
+
# }
|
3927
|
+
#
|
3928
|
+
# @!attribute [rw] included_states
|
3929
|
+
# Specifies the document states that should be included when Amazon
|
3930
|
+
# Kendra indexes knowledge articles. You must specify at least one
|
3931
|
+
# state.
|
3932
|
+
# @return [Array<String>]
|
3933
|
+
#
|
3934
|
+
# @!attribute [rw] standard_knowledge_article_type_configuration
|
3935
|
+
# Provides configuration information for standard Salesforce knowledge
|
3936
|
+
# articles.
|
3937
|
+
# @return [Types::SalesforceStandardKnowledgeArticleTypeConfiguration]
|
3938
|
+
#
|
3939
|
+
# @!attribute [rw] custom_knowledge_article_type_configurations
|
3940
|
+
# Provides configuration information for custom Salesforce knowledge
|
3941
|
+
# articles.
|
3942
|
+
# @return [Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>]
|
3943
|
+
#
|
3944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration AWS API Documentation
|
3945
|
+
#
|
3946
|
+
class SalesforceKnowledgeArticleConfiguration < Struct.new(
|
3947
|
+
:included_states,
|
3948
|
+
:standard_knowledge_article_type_configuration,
|
3949
|
+
:custom_knowledge_article_type_configurations)
|
3950
|
+
SENSITIVE = []
|
3951
|
+
include Aws::Structure
|
3952
|
+
end
|
3953
|
+
|
3954
|
+
# Provides configuration information for standard Salesforce knowledge
|
3955
|
+
# articles.
|
3956
|
+
#
|
3957
|
+
# @note When making an API call, you may pass SalesforceStandardKnowledgeArticleTypeConfiguration
|
3958
|
+
# data as a hash:
|
3959
|
+
#
|
3960
|
+
# {
|
3961
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
3962
|
+
# document_title_field_name: "DataSourceFieldName",
|
3963
|
+
# field_mappings: [
|
3964
|
+
# {
|
3965
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3966
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3967
|
+
# index_field_name: "IndexFieldName", # required
|
3968
|
+
# },
|
3969
|
+
# ],
|
3970
|
+
# }
|
3971
|
+
#
|
3972
|
+
# @!attribute [rw] document_data_field_name
|
3973
|
+
# The name of the field that contains the document data to index.
|
3974
|
+
# @return [String]
|
3975
|
+
#
|
3976
|
+
# @!attribute [rw] document_title_field_name
|
3977
|
+
# The name of the field that contains the document title.
|
3978
|
+
# @return [String]
|
3979
|
+
#
|
3980
|
+
# @!attribute [rw] field_mappings
|
3981
|
+
# One or more objects that map fields in the knowledge article to
|
3982
|
+
# Amazon Kendra index fields. The index field must exist before you
|
3983
|
+
# can map a Salesforce field to it.
|
3984
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3985
|
+
#
|
3986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration AWS API Documentation
|
3987
|
+
#
|
3988
|
+
class SalesforceStandardKnowledgeArticleTypeConfiguration < Struct.new(
|
3989
|
+
:document_data_field_name,
|
3990
|
+
:document_title_field_name,
|
3991
|
+
:field_mappings)
|
3992
|
+
SENSITIVE = []
|
3993
|
+
include Aws::Structure
|
3994
|
+
end
|
3995
|
+
|
3996
|
+
# Provides configuration information for processing attachments to
|
3997
|
+
# Salesforce standard objects.
|
3998
|
+
#
|
3999
|
+
# @note When making an API call, you may pass SalesforceStandardObjectAttachmentConfiguration
|
4000
|
+
# data as a hash:
|
4001
|
+
#
|
4002
|
+
# {
|
4003
|
+
# document_title_field_name: "DataSourceFieldName",
|
4004
|
+
# field_mappings: [
|
4005
|
+
# {
|
4006
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4007
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4008
|
+
# index_field_name: "IndexFieldName", # required
|
4009
|
+
# },
|
4010
|
+
# ],
|
4011
|
+
# }
|
4012
|
+
#
|
4013
|
+
# @!attribute [rw] document_title_field_name
|
4014
|
+
# The name of the field used for the document title.
|
4015
|
+
# @return [String]
|
4016
|
+
#
|
4017
|
+
# @!attribute [rw] field_mappings
|
4018
|
+
# One or more objects that map fields in attachments to Amazon Kendra
|
4019
|
+
# index fields.
|
4020
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
4021
|
+
#
|
4022
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectAttachmentConfiguration AWS API Documentation
|
4023
|
+
#
|
4024
|
+
class SalesforceStandardObjectAttachmentConfiguration < Struct.new(
|
4025
|
+
:document_title_field_name,
|
4026
|
+
:field_mappings)
|
4027
|
+
SENSITIVE = []
|
4028
|
+
include Aws::Structure
|
4029
|
+
end
|
4030
|
+
|
4031
|
+
# Specifies confguration information for indexing a single standard
|
4032
|
+
# object.
|
4033
|
+
#
|
4034
|
+
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
4035
|
+
# data as a hash:
|
4036
|
+
#
|
4037
|
+
# {
|
4038
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
4039
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4040
|
+
# document_title_field_name: "DataSourceFieldName",
|
4041
|
+
# field_mappings: [
|
4042
|
+
# {
|
4043
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4044
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4045
|
+
# index_field_name: "IndexFieldName", # required
|
4046
|
+
# },
|
4047
|
+
# ],
|
4048
|
+
# }
|
4049
|
+
#
|
4050
|
+
# @!attribute [rw] name
|
4051
|
+
# The name of the standard object.
|
4052
|
+
# @return [String]
|
4053
|
+
#
|
4054
|
+
# @!attribute [rw] document_data_field_name
|
4055
|
+
# The name of the field in the standard object table that contains the
|
4056
|
+
# document contents.
|
4057
|
+
# @return [String]
|
4058
|
+
#
|
4059
|
+
# @!attribute [rw] document_title_field_name
|
4060
|
+
# The name of the field in the standard object table that contains the
|
4061
|
+
# document titleB.
|
4062
|
+
# @return [String]
|
4063
|
+
#
|
4064
|
+
# @!attribute [rw] field_mappings
|
4065
|
+
# One or more objects that map fields in the standard object to Amazon
|
4066
|
+
# Kendra index fields. The index field must exist before you can map a
|
4067
|
+
# Salesforce field to it.
|
4068
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
4069
|
+
#
|
4070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectConfiguration AWS API Documentation
|
4071
|
+
#
|
4072
|
+
class SalesforceStandardObjectConfiguration < Struct.new(
|
4073
|
+
:name,
|
4074
|
+
:document_data_field_name,
|
4075
|
+
:document_title_field_name,
|
4076
|
+
:field_mappings)
|
4077
|
+
SENSITIVE = []
|
4078
|
+
include Aws::Structure
|
4079
|
+
end
|
4080
|
+
|
4081
|
+
# Provides information about how a custom index field is used during a
|
4082
|
+
# search.
|
4083
|
+
#
|
4084
|
+
# @note When making an API call, you may pass Search
|
4085
|
+
# data as a hash:
|
4086
|
+
#
|
4087
|
+
# {
|
4088
|
+
# facetable: false,
|
4089
|
+
# searchable: false,
|
4090
|
+
# displayable: false,
|
4091
|
+
# sortable: false,
|
4092
|
+
# }
|
4093
|
+
#
|
4094
|
+
# @!attribute [rw] facetable
|
4095
|
+
# Indicates that the field can be used to create search facets, a
|
4096
|
+
# count of results for each value in the field. The default is `false`
|
4097
|
+
# .
|
4098
|
+
# @return [Boolean]
|
4099
|
+
#
|
4100
|
+
# @!attribute [rw] searchable
|
4101
|
+
# Determines whether the field is used in the search. If the
|
4102
|
+
# `Searchable` field is `true`, you can use relevance tuning to
|
4103
|
+
# manually tune how Amazon Kendra weights the field in the search. The
|
4104
|
+
# default is `true` for string fields and `false` for number and date
|
4105
|
+
# fields.
|
4106
|
+
# @return [Boolean]
|
4107
|
+
#
|
4108
|
+
# @!attribute [rw] displayable
|
4109
|
+
# Determines whether the field is returned in the query response. The
|
4110
|
+
# default is `true`.
|
4111
|
+
# @return [Boolean]
|
4112
|
+
#
|
4113
|
+
# @!attribute [rw] sortable
|
4114
|
+
# Determines whether the field can be used to sort the results of a
|
4115
|
+
# query. If you specify sorting on a field that does not have
|
4116
|
+
# `Sortable` set to `true`, Amazon Kendra returns an exception. The
|
4117
|
+
# default is `false`.
|
4118
|
+
# @return [Boolean]
|
4119
|
+
#
|
4120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search AWS API Documentation
|
4121
|
+
#
|
4122
|
+
class Search < Struct.new(
|
4123
|
+
:facetable,
|
4124
|
+
:searchable,
|
4125
|
+
:displayable,
|
4126
|
+
:sortable)
|
4127
|
+
SENSITIVE = []
|
4128
|
+
include Aws::Structure
|
4129
|
+
end
|
4130
|
+
|
4131
|
+
# Provides the identifier of the AWS KMS customer master key (CMK) used
|
4132
|
+
# to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
|
4133
|
+
# support asymmetric CMKs.
|
4134
|
+
#
|
4135
|
+
# @note When making an API call, you may pass ServerSideEncryptionConfiguration
|
4136
|
+
# data as a hash:
|
4137
|
+
#
|
4138
|
+
# {
|
4139
|
+
# kms_key_id: "KmsKeyId",
|
4140
|
+
# }
|
4141
|
+
#
|
4142
|
+
# @!attribute [rw] kms_key_id
|
4143
|
+
# The identifier of the AWS KMS customer master key (CMK). Amazon
|
4144
|
+
# Kendra doesn't support asymmetric CMKs.
|
4145
|
+
# @return [String]
|
4146
|
+
#
|
4147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServerSideEncryptionConfiguration AWS API Documentation
|
4148
|
+
#
|
4149
|
+
class ServerSideEncryptionConfiguration < Struct.new(
|
4150
|
+
:kms_key_id)
|
4151
|
+
SENSITIVE = [:kms_key_id]
|
4152
|
+
include Aws::Structure
|
4153
|
+
end
|
4154
|
+
|
4155
|
+
# Provides configuration information required to connect to a ServiceNow
|
4156
|
+
# data source.
|
4157
|
+
#
|
4158
|
+
# @note When making an API call, you may pass ServiceNowConfiguration
|
4159
|
+
# data as a hash:
|
4160
|
+
#
|
4161
|
+
# {
|
4162
|
+
# host_url: "ServiceNowHostUrl", # required
|
4163
|
+
# secret_arn: "SecretArn", # required
|
4164
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
4165
|
+
# knowledge_article_configuration: {
|
4166
|
+
# crawl_attachments: false,
|
4167
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4168
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4169
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4170
|
+
# document_title_field_name: "DataSourceFieldName",
|
4171
|
+
# field_mappings: [
|
4172
|
+
# {
|
4173
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4174
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4175
|
+
# index_field_name: "IndexFieldName", # required
|
4176
|
+
# },
|
4177
|
+
# ],
|
4178
|
+
# },
|
4179
|
+
# service_catalog_configuration: {
|
4180
|
+
# crawl_attachments: false,
|
4181
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4182
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4183
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4184
|
+
# document_title_field_name: "DataSourceFieldName",
|
4185
|
+
# field_mappings: [
|
4186
|
+
# {
|
4187
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4188
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4189
|
+
# index_field_name: "IndexFieldName", # required
|
4190
|
+
# },
|
4191
|
+
# ],
|
4192
|
+
# },
|
4193
|
+
# }
|
4194
|
+
#
|
4195
|
+
# @!attribute [rw] host_url
|
4196
|
+
# The ServiceNow instance that the data source connects to. The host
|
4197
|
+
# endpoint should look like the following:
|
4198
|
+
# `\{instance\}.service-now.com.`
|
4199
|
+
# @return [String]
|
4200
|
+
#
|
4201
|
+
# @!attribute [rw] secret_arn
|
4202
|
+
# The Amazon Resource Name (ARN) of the AWS Secret Manager secret that
|
4203
|
+
# contains the user name and password required to connect to the
|
4204
|
+
# ServiceNow instance.
|
4205
|
+
# @return [String]
|
4206
|
+
#
|
4207
|
+
# @!attribute [rw] service_now_build_version
|
4208
|
+
# The identifier of the release that the ServiceNow host is running.
|
4209
|
+
# If the host is not running the `LONDON` release, use `OTHERS`.
|
4210
|
+
# @return [String]
|
4211
|
+
#
|
4212
|
+
# @!attribute [rw] knowledge_article_configuration
|
4213
|
+
# Provides configuration information for crawling knowledge articles
|
4214
|
+
# in the ServiceNow site.
|
4215
|
+
# @return [Types::ServiceNowKnowledgeArticleConfiguration]
|
4216
|
+
#
|
4217
|
+
# @!attribute [rw] service_catalog_configuration
|
4218
|
+
# Provides configuration information for crawling service catalogs in
|
4219
|
+
# the ServiceNow site.
|
4220
|
+
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
4221
|
+
#
|
4222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
|
4223
|
+
#
|
4224
|
+
class ServiceNowConfiguration < Struct.new(
|
4225
|
+
:host_url,
|
4226
|
+
:secret_arn,
|
4227
|
+
:service_now_build_version,
|
4228
|
+
:knowledge_article_configuration,
|
4229
|
+
:service_catalog_configuration)
|
4230
|
+
SENSITIVE = []
|
4231
|
+
include Aws::Structure
|
4232
|
+
end
|
4233
|
+
|
4234
|
+
# Provides configuration information for crawling knowledge articles in
|
4235
|
+
# the ServiceNow site.
|
4236
|
+
#
|
4237
|
+
# @note When making an API call, you may pass ServiceNowKnowledgeArticleConfiguration
|
4238
|
+
# data as a hash:
|
4239
|
+
#
|
4240
|
+
# {
|
4241
|
+
# crawl_attachments: false,
|
4242
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4243
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4244
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4245
|
+
# document_title_field_name: "DataSourceFieldName",
|
4246
|
+
# field_mappings: [
|
4247
|
+
# {
|
4248
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4249
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4250
|
+
# index_field_name: "IndexFieldName", # required
|
4251
|
+
# },
|
4252
|
+
# ],
|
4253
|
+
# }
|
4254
|
+
#
|
4255
|
+
# @!attribute [rw] crawl_attachments
|
4256
|
+
# Indicates whether Amazon Kendra should index attachments to
|
4257
|
+
# knowledge articles.
|
4258
|
+
# @return [Boolean]
|
4259
|
+
#
|
4260
|
+
# @!attribute [rw] include_attachment_file_patterns
|
4261
|
+
# List of regular expressions applied to knowledge articles. Items
|
4262
|
+
# that don't match the inclusion pattern are not indexed. The regex
|
4263
|
+
# is applied to the field specified in the `PatternTargetField`.
|
4264
|
+
# @return [Array<String>]
|
4265
|
+
#
|
4266
|
+
# @!attribute [rw] exclude_attachment_file_patterns
|
4267
|
+
# List of regular expressions applied to knowledge articles. Items
|
4268
|
+
# that don't match the inclusion pattern are not indexed. The regex
|
4269
|
+
# is applied to the field specified in the `PatternTargetField`
|
4270
|
+
# @return [Array<String>]
|
4271
|
+
#
|
4272
|
+
# @!attribute [rw] document_data_field_name
|
4273
|
+
# The name of the ServiceNow field that is mapped to the index
|
4274
|
+
# document contents field in the Amazon Kendra index.
|
4275
|
+
# @return [String]
|
4276
|
+
#
|
4277
|
+
# @!attribute [rw] document_title_field_name
|
4278
|
+
# The name of the ServiceNow field that is mapped to the index
|
4279
|
+
# document title field.
|
4280
|
+
# @return [String]
|
4281
|
+
#
|
4282
|
+
# @!attribute [rw] field_mappings
|
4283
|
+
# Mapping between ServiceNow fields and Amazon Kendra index fields.
|
4284
|
+
# You must create the index field before you map the field.
|
4285
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
4286
|
+
#
|
4287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
|
4288
|
+
#
|
4289
|
+
class ServiceNowKnowledgeArticleConfiguration < Struct.new(
|
4290
|
+
:crawl_attachments,
|
4291
|
+
:include_attachment_file_patterns,
|
4292
|
+
:exclude_attachment_file_patterns,
|
4293
|
+
:document_data_field_name,
|
4294
|
+
:document_title_field_name,
|
4295
|
+
:field_mappings)
|
4296
|
+
SENSITIVE = []
|
4297
|
+
include Aws::Structure
|
4298
|
+
end
|
4299
|
+
|
4300
|
+
# Provides configuration information for crawling service catalog items
|
4301
|
+
# in the ServiceNow site
|
4302
|
+
#
|
4303
|
+
# @note When making an API call, you may pass ServiceNowServiceCatalogConfiguration
|
4304
|
+
# data as a hash:
|
4305
|
+
#
|
4306
|
+
# {
|
4307
|
+
# crawl_attachments: false,
|
4308
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4309
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4310
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4311
|
+
# document_title_field_name: "DataSourceFieldName",
|
4312
|
+
# field_mappings: [
|
4313
|
+
# {
|
4314
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4315
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4316
|
+
# index_field_name: "IndexFieldName", # required
|
4317
|
+
# },
|
4318
|
+
# ],
|
4319
|
+
# }
|
4320
|
+
#
|
4321
|
+
# @!attribute [rw] crawl_attachments
|
4322
|
+
# Indicates whether Amazon Kendra should crawl attachments to the
|
4323
|
+
# service catalog items.
|
4324
|
+
# @return [Boolean]
|
4325
|
+
#
|
4326
|
+
# @!attribute [rw] include_attachment_file_patterns
|
4327
|
+
# Determines the types of file attachments that are included in the
|
4328
|
+
# index.
|
4329
|
+
# @return [Array<String>]
|
4330
|
+
#
|
4331
|
+
# @!attribute [rw] exclude_attachment_file_patterns
|
4332
|
+
# Determines the types of file attachments that are excluded from the
|
4333
|
+
# index.
|
4334
|
+
# @return [Array<String>]
|
4335
|
+
#
|
4336
|
+
# @!attribute [rw] document_data_field_name
|
4337
|
+
# The name of the ServiceNow field that is mapped to the index
|
4338
|
+
# document contents field in the Amazon Kendra index.
|
4339
|
+
# @return [String]
|
4340
|
+
#
|
4341
|
+
# @!attribute [rw] document_title_field_name
|
4342
|
+
# The name of the ServiceNow field that is mapped to the index
|
4343
|
+
# document title field.
|
4344
|
+
# @return [String]
|
4345
|
+
#
|
4346
|
+
# @!attribute [rw] field_mappings
|
4347
|
+
# Mapping between ServiceNow fields and Amazon Kendra index fields.
|
4348
|
+
# You must create the index field before you map the field.
|
4349
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
4350
|
+
#
|
4351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration AWS API Documentation
|
4352
|
+
#
|
4353
|
+
class ServiceNowServiceCatalogConfiguration < Struct.new(
|
4354
|
+
:crawl_attachments,
|
4355
|
+
:include_attachment_file_patterns,
|
4356
|
+
:exclude_attachment_file_patterns,
|
4357
|
+
:document_data_field_name,
|
4358
|
+
:document_title_field_name,
|
4359
|
+
:field_mappings)
|
4360
|
+
SENSITIVE = []
|
4361
|
+
include Aws::Structure
|
4362
|
+
end
|
4363
|
+
|
4364
|
+
# @!attribute [rw] message
|
4365
|
+
# @return [String]
|
4366
|
+
#
|
4367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceQuotaExceededException AWS API Documentation
|
4368
|
+
#
|
4369
|
+
class ServiceQuotaExceededException < Struct.new(
|
4370
|
+
:message)
|
4371
|
+
SENSITIVE = []
|
4372
|
+
include Aws::Structure
|
4373
|
+
end
|
4374
|
+
|
4375
|
+
# Provides configuration information for connecting to a Microsoft
|
4376
|
+
# SharePoint data source.
|
4377
|
+
#
|
4378
|
+
# @note When making an API call, you may pass SharePointConfiguration
|
4379
|
+
# data as a hash:
|
4380
|
+
#
|
4381
|
+
# {
|
4382
|
+
# share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
|
4383
|
+
# urls: ["Url"], # required
|
4384
|
+
# secret_arn: "SecretArn", # required
|
4385
|
+
# crawl_attachments: false,
|
4386
|
+
# use_change_log: false,
|
4387
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4388
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4389
|
+
# vpc_configuration: {
|
4390
|
+
# subnet_ids: ["SubnetId"], # required
|
4391
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4392
|
+
# },
|
4393
|
+
# field_mappings: [
|
4394
|
+
# {
|
4395
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4396
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4397
|
+
# index_field_name: "IndexFieldName", # required
|
4398
|
+
# },
|
4399
|
+
# ],
|
4400
|
+
# document_title_field_name: "DataSourceFieldName",
|
4401
|
+
# }
|
4402
|
+
#
|
4403
|
+
# @!attribute [rw] share_point_version
|
4404
|
+
# The version of Microsoft SharePoint that you are using as a data
|
4405
|
+
# source.
|
4406
|
+
# @return [String]
|
4407
|
+
#
|
4408
|
+
# @!attribute [rw] urls
|
4409
|
+
# The URLs of the Microsoft SharePoint site that contains the
|
4410
|
+
# documents that should be indexed.
|
4411
|
+
# @return [Array<String>]
|
2970
4412
|
#
|
2971
4413
|
# @!attribute [rw] secret_arn
|
2972
4414
|
# The Amazon Resource Name (ARN) of credentials stored in AWS Secrets
|
@@ -3049,6 +4491,87 @@ module Aws::Kendra
|
|
3049
4491
|
:vpc_configuration,
|
3050
4492
|
:field_mappings,
|
3051
4493
|
:document_title_field_name)
|
4494
|
+
SENSITIVE = []
|
4495
|
+
include Aws::Structure
|
4496
|
+
end
|
4497
|
+
|
4498
|
+
# Specifies the document attribute to use to sort the response to a
|
4499
|
+
# Amazon Kendra query. You can specify a single attribute for sorting.
|
4500
|
+
# The attribute must have the `Sortable` flag set to `true`, otherwise
|
4501
|
+
# Amazon Kendra returns an exception.
|
4502
|
+
#
|
4503
|
+
# @note When making an API call, you may pass SortingConfiguration
|
4504
|
+
# data as a hash:
|
4505
|
+
#
|
4506
|
+
# {
|
4507
|
+
# document_attribute_key: "DocumentAttributeKey", # required
|
4508
|
+
# sort_order: "DESC", # required, accepts DESC, ASC
|
4509
|
+
# }
|
4510
|
+
#
|
4511
|
+
# @!attribute [rw] document_attribute_key
|
4512
|
+
# The name of the document attribute used to sort the response. You
|
4513
|
+
# can use any field that has the `Sortable` flag set to true.
|
4514
|
+
#
|
4515
|
+
# You can also sort by any of the following built-in attributes:
|
4516
|
+
#
|
4517
|
+
# * \_category
|
4518
|
+
#
|
4519
|
+
# * \_created\_at
|
4520
|
+
#
|
4521
|
+
# * \_last\_updated\_at
|
4522
|
+
#
|
4523
|
+
# * \_version
|
4524
|
+
#
|
4525
|
+
# * \_view\_count
|
4526
|
+
# @return [String]
|
4527
|
+
#
|
4528
|
+
# @!attribute [rw] sort_order
|
4529
|
+
# The order that the results should be returned in. In case of ties,
|
4530
|
+
# the relevance assigned to the result by Amazon Kendra is used as the
|
4531
|
+
# tie-breaker.
|
4532
|
+
# @return [String]
|
4533
|
+
#
|
4534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SortingConfiguration AWS API Documentation
|
4535
|
+
#
|
4536
|
+
class SortingConfiguration < Struct.new(
|
4537
|
+
:document_attribute_key,
|
4538
|
+
:sort_order)
|
4539
|
+
SENSITIVE = []
|
4540
|
+
include Aws::Structure
|
4541
|
+
end
|
4542
|
+
|
4543
|
+
# Provides information that configures Amazon Kendra to use a SQL
|
4544
|
+
# database.
|
4545
|
+
#
|
4546
|
+
# @note When making an API call, you may pass SqlConfiguration
|
4547
|
+
# data as a hash:
|
4548
|
+
#
|
4549
|
+
# {
|
4550
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
4551
|
+
# }
|
4552
|
+
#
|
4553
|
+
# @!attribute [rw] query_identifiers_enclosing_option
|
4554
|
+
# Determines whether Amazon Kendra encloses SQL identifiers in double
|
4555
|
+
# quotes (") when making a database query.
|
4556
|
+
#
|
4557
|
+
# By default, Amazon Kendra passes SQL identifiers the way that they
|
4558
|
+
# are entered into the data source configuration. It does not change
|
4559
|
+
# the case of identifiers or enclose them in quotes.
|
4560
|
+
#
|
4561
|
+
# PostgreSQL internally converts uppercase characters to lower case
|
4562
|
+
# characters in identifiers unless they are quoted. Choosing this
|
4563
|
+
# option encloses identifiers in quotes so that PostgreSQL does not
|
4564
|
+
# convert the character's case.
|
4565
|
+
#
|
4566
|
+
# For MySQL databases, you must enable the `ansi_quotes` option when
|
4567
|
+
# you choose this option.
|
4568
|
+
# @return [String]
|
4569
|
+
#
|
4570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SqlConfiguration AWS API Documentation
|
4571
|
+
#
|
4572
|
+
class SqlConfiguration < Struct.new(
|
4573
|
+
:query_identifiers_enclosing_option)
|
4574
|
+
SENSITIVE = []
|
3052
4575
|
include Aws::Structure
|
3053
4576
|
end
|
3054
4577
|
|
@@ -3073,6 +4596,7 @@ module Aws::Kendra
|
|
3073
4596
|
class StartDataSourceSyncJobRequest < Struct.new(
|
3074
4597
|
:id,
|
3075
4598
|
:index_id)
|
4599
|
+
SENSITIVE = []
|
3076
4600
|
include Aws::Structure
|
3077
4601
|
end
|
3078
4602
|
|
@@ -3084,6 +4608,7 @@ module Aws::Kendra
|
|
3084
4608
|
#
|
3085
4609
|
class StartDataSourceSyncJobResponse < Struct.new(
|
3086
4610
|
:execution_id)
|
4611
|
+
SENSITIVE = []
|
3087
4612
|
include Aws::Structure
|
3088
4613
|
end
|
3089
4614
|
|
@@ -3109,6 +4634,7 @@ module Aws::Kendra
|
|
3109
4634
|
class StopDataSourceSyncJobRequest < Struct.new(
|
3110
4635
|
:id,
|
3111
4636
|
:index_id)
|
4637
|
+
SENSITIVE = []
|
3112
4638
|
include Aws::Structure
|
3113
4639
|
end
|
3114
4640
|
|
@@ -3158,19 +4684,94 @@ module Aws::Kendra
|
|
3158
4684
|
:query_id,
|
3159
4685
|
:click_feedback_items,
|
3160
4686
|
:relevance_feedback_items)
|
4687
|
+
SENSITIVE = []
|
4688
|
+
include Aws::Structure
|
4689
|
+
end
|
4690
|
+
|
4691
|
+
# A list of key/value pairs that identify an index, FAQ, or data source.
|
4692
|
+
# Tag keys and values can consist of Unicode letters, digits, white
|
4693
|
+
# space, and any of the following symbols: \_ . : / = + - @.
|
4694
|
+
#
|
4695
|
+
# @note When making an API call, you may pass Tag
|
4696
|
+
# data as a hash:
|
4697
|
+
#
|
4698
|
+
# {
|
4699
|
+
# key: "TagKey", # required
|
4700
|
+
# value: "TagValue", # required
|
4701
|
+
# }
|
4702
|
+
#
|
4703
|
+
# @!attribute [rw] key
|
4704
|
+
# The key for the tag. Keys are not case sensitive and must be unique
|
4705
|
+
# for the index, FAQ, or data source.
|
4706
|
+
# @return [String]
|
4707
|
+
#
|
4708
|
+
# @!attribute [rw] value
|
4709
|
+
# The value associated with the tag. The value may be an empty string
|
4710
|
+
# but it can't be null.
|
4711
|
+
# @return [String]
|
4712
|
+
#
|
4713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Tag AWS API Documentation
|
4714
|
+
#
|
4715
|
+
class Tag < Struct.new(
|
4716
|
+
:key,
|
4717
|
+
:value)
|
4718
|
+
SENSITIVE = []
|
3161
4719
|
include Aws::Structure
|
3162
4720
|
end
|
3163
4721
|
|
4722
|
+
# @note When making an API call, you may pass TagResourceRequest
|
4723
|
+
# data as a hash:
|
4724
|
+
#
|
4725
|
+
# {
|
4726
|
+
# resource_arn: "AmazonResourceName", # required
|
4727
|
+
# tags: [ # required
|
4728
|
+
# {
|
4729
|
+
# key: "TagKey", # required
|
4730
|
+
# value: "TagValue", # required
|
4731
|
+
# },
|
4732
|
+
# ],
|
4733
|
+
# }
|
4734
|
+
#
|
4735
|
+
# @!attribute [rw] resource_arn
|
4736
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
4737
|
+
# tag.
|
4738
|
+
# @return [String]
|
4739
|
+
#
|
4740
|
+
# @!attribute [rw] tags
|
4741
|
+
# A list of tag keys to add to the index, FAQ, or data source. If a
|
4742
|
+
# tag already exists, the existing value is replaced with the new
|
4743
|
+
# value.
|
4744
|
+
# @return [Array<Types::Tag>]
|
4745
|
+
#
|
4746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResourceRequest AWS API Documentation
|
4747
|
+
#
|
4748
|
+
class TagResourceRequest < Struct.new(
|
4749
|
+
:resource_arn,
|
4750
|
+
:tags)
|
4751
|
+
SENSITIVE = []
|
4752
|
+
include Aws::Structure
|
4753
|
+
end
|
4754
|
+
|
4755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResourceResponse AWS API Documentation
|
4756
|
+
#
|
4757
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
4758
|
+
|
3164
4759
|
# Provides information about text documents indexed in an index.
|
3165
4760
|
#
|
3166
4761
|
# @!attribute [rw] indexed_text_documents_count
|
3167
4762
|
# The number of text documents indexed.
|
3168
4763
|
# @return [Integer]
|
3169
4764
|
#
|
4765
|
+
# @!attribute [rw] indexed_text_bytes
|
4766
|
+
# The total size, in bytes, of the indexed documents.
|
4767
|
+
# @return [Integer]
|
4768
|
+
#
|
3170
4769
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TextDocumentStatistics AWS API Documentation
|
3171
4770
|
#
|
3172
4771
|
class TextDocumentStatistics < Struct.new(
|
3173
|
-
:indexed_text_documents_count
|
4772
|
+
:indexed_text_documents_count,
|
4773
|
+
:indexed_text_bytes)
|
4774
|
+
SENSITIVE = []
|
3174
4775
|
include Aws::Structure
|
3175
4776
|
end
|
3176
4777
|
|
@@ -3189,6 +4790,7 @@ module Aws::Kendra
|
|
3189
4790
|
class TextWithHighlights < Struct.new(
|
3190
4791
|
:text,
|
3191
4792
|
:highlights)
|
4793
|
+
SENSITIVE = []
|
3192
4794
|
include Aws::Structure
|
3193
4795
|
end
|
3194
4796
|
|
@@ -3199,6 +4801,7 @@ module Aws::Kendra
|
|
3199
4801
|
#
|
3200
4802
|
class ThrottlingException < Struct.new(
|
3201
4803
|
:message)
|
4804
|
+
SENSITIVE = []
|
3202
4805
|
include Aws::Structure
|
3203
4806
|
end
|
3204
4807
|
|
@@ -3225,9 +4828,41 @@ module Aws::Kendra
|
|
3225
4828
|
class TimeRange < Struct.new(
|
3226
4829
|
:start_time,
|
3227
4830
|
:end_time)
|
4831
|
+
SENSITIVE = []
|
3228
4832
|
include Aws::Structure
|
3229
4833
|
end
|
3230
4834
|
|
4835
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
4836
|
+
# data as a hash:
|
4837
|
+
#
|
4838
|
+
# {
|
4839
|
+
# resource_arn: "AmazonResourceName", # required
|
4840
|
+
# tag_keys: ["TagKey"], # required
|
4841
|
+
# }
|
4842
|
+
#
|
4843
|
+
# @!attribute [rw] resource_arn
|
4844
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
4845
|
+
# remove the tag from.
|
4846
|
+
# @return [String]
|
4847
|
+
#
|
4848
|
+
# @!attribute [rw] tag_keys
|
4849
|
+
# A list of tag keys to remove from the index, FAQ, or data source. If
|
4850
|
+
# a tag key does not exist on the resource, it is ignored.
|
4851
|
+
# @return [Array<String>]
|
4852
|
+
#
|
4853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResourceRequest AWS API Documentation
|
4854
|
+
#
|
4855
|
+
class UntagResourceRequest < Struct.new(
|
4856
|
+
:resource_arn,
|
4857
|
+
:tag_keys)
|
4858
|
+
SENSITIVE = []
|
4859
|
+
include Aws::Structure
|
4860
|
+
end
|
4861
|
+
|
4862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResourceResponse AWS API Documentation
|
4863
|
+
#
|
4864
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
4865
|
+
|
3231
4866
|
# @note When making an API call, you may pass UpdateDataSourceRequest
|
3232
4867
|
# data as a hash:
|
3233
4868
|
#
|
@@ -3297,6 +4932,133 @@ module Aws::Kendra
|
|
3297
4932
|
# acl_configuration: {
|
3298
4933
|
# allowed_groups_column_name: "ColumnName", # required
|
3299
4934
|
# },
|
4935
|
+
# sql_configuration: {
|
4936
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
4937
|
+
# },
|
4938
|
+
# },
|
4939
|
+
# salesforce_configuration: {
|
4940
|
+
# server_url: "Url", # required
|
4941
|
+
# secret_arn: "SecretArn", # required
|
4942
|
+
# standard_object_configurations: [
|
4943
|
+
# {
|
4944
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
4945
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4946
|
+
# document_title_field_name: "DataSourceFieldName",
|
4947
|
+
# field_mappings: [
|
4948
|
+
# {
|
4949
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4950
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4951
|
+
# index_field_name: "IndexFieldName", # required
|
4952
|
+
# },
|
4953
|
+
# ],
|
4954
|
+
# },
|
4955
|
+
# ],
|
4956
|
+
# knowledge_article_configuration: {
|
4957
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
4958
|
+
# standard_knowledge_article_type_configuration: {
|
4959
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4960
|
+
# document_title_field_name: "DataSourceFieldName",
|
4961
|
+
# field_mappings: [
|
4962
|
+
# {
|
4963
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4964
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4965
|
+
# index_field_name: "IndexFieldName", # required
|
4966
|
+
# },
|
4967
|
+
# ],
|
4968
|
+
# },
|
4969
|
+
# custom_knowledge_article_type_configurations: [
|
4970
|
+
# {
|
4971
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
4972
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4973
|
+
# document_title_field_name: "DataSourceFieldName",
|
4974
|
+
# field_mappings: [
|
4975
|
+
# {
|
4976
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4977
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4978
|
+
# index_field_name: "IndexFieldName", # required
|
4979
|
+
# },
|
4980
|
+
# ],
|
4981
|
+
# },
|
4982
|
+
# ],
|
4983
|
+
# },
|
4984
|
+
# chatter_feed_configuration: {
|
4985
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
4986
|
+
# document_title_field_name: "DataSourceFieldName",
|
4987
|
+
# field_mappings: [
|
4988
|
+
# {
|
4989
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4990
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4991
|
+
# index_field_name: "IndexFieldName", # required
|
4992
|
+
# },
|
4993
|
+
# ],
|
4994
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
4995
|
+
# },
|
4996
|
+
# crawl_attachments: false,
|
4997
|
+
# standard_object_attachment_configuration: {
|
4998
|
+
# document_title_field_name: "DataSourceFieldName",
|
4999
|
+
# field_mappings: [
|
5000
|
+
# {
|
5001
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5002
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5003
|
+
# index_field_name: "IndexFieldName", # required
|
5004
|
+
# },
|
5005
|
+
# ],
|
5006
|
+
# },
|
5007
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5008
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5009
|
+
# },
|
5010
|
+
# one_drive_configuration: {
|
5011
|
+
# tenant_domain: "TenantDomain", # required
|
5012
|
+
# secret_arn: "SecretArn", # required
|
5013
|
+
# one_drive_users: { # required
|
5014
|
+
# one_drive_user_list: ["OneDriveUser"],
|
5015
|
+
# one_drive_user_s3_path: {
|
5016
|
+
# bucket: "S3BucketName", # required
|
5017
|
+
# key: "S3ObjectKey", # required
|
5018
|
+
# },
|
5019
|
+
# },
|
5020
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5021
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5022
|
+
# field_mappings: [
|
5023
|
+
# {
|
5024
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5025
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5026
|
+
# index_field_name: "IndexFieldName", # required
|
5027
|
+
# },
|
5028
|
+
# ],
|
5029
|
+
# },
|
5030
|
+
# service_now_configuration: {
|
5031
|
+
# host_url: "ServiceNowHostUrl", # required
|
5032
|
+
# secret_arn: "SecretArn", # required
|
5033
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
5034
|
+
# knowledge_article_configuration: {
|
5035
|
+
# crawl_attachments: false,
|
5036
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5037
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5038
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
5039
|
+
# document_title_field_name: "DataSourceFieldName",
|
5040
|
+
# field_mappings: [
|
5041
|
+
# {
|
5042
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5043
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5044
|
+
# index_field_name: "IndexFieldName", # required
|
5045
|
+
# },
|
5046
|
+
# ],
|
5047
|
+
# },
|
5048
|
+
# service_catalog_configuration: {
|
5049
|
+
# crawl_attachments: false,
|
5050
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5051
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5052
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
5053
|
+
# document_title_field_name: "DataSourceFieldName",
|
5054
|
+
# field_mappings: [
|
5055
|
+
# {
|
5056
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5057
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5058
|
+
# index_field_name: "IndexFieldName", # required
|
5059
|
+
# },
|
5060
|
+
# ],
|
5061
|
+
# },
|
3300
5062
|
# },
|
3301
5063
|
# },
|
3302
5064
|
# description: "Description",
|
@@ -3345,6 +5107,7 @@ module Aws::Kendra
|
|
3345
5107
|
:description,
|
3346
5108
|
:schedule,
|
3347
5109
|
:role_arn)
|
5110
|
+
SENSITIVE = []
|
3348
5111
|
include Aws::Structure
|
3349
5112
|
end
|
3350
5113
|
|
@@ -3373,9 +5136,14 @@ module Aws::Kendra
|
|
3373
5136
|
# facetable: false,
|
3374
5137
|
# searchable: false,
|
3375
5138
|
# displayable: false,
|
5139
|
+
# sortable: false,
|
3376
5140
|
# },
|
3377
5141
|
# },
|
3378
5142
|
# ],
|
5143
|
+
# capacity_units: {
|
5144
|
+
# storage_capacity_units: 1, # required
|
5145
|
+
# query_capacity_units: 1, # required
|
5146
|
+
# },
|
3379
5147
|
# }
|
3380
5148
|
#
|
3381
5149
|
# @!attribute [rw] id
|
@@ -3399,6 +5167,16 @@ module Aws::Kendra
|
|
3399
5167
|
# The document metadata to update.
|
3400
5168
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
3401
5169
|
#
|
5170
|
+
# @!attribute [rw] capacity_units
|
5171
|
+
# Sets the number of addtional storage and query capacity units that
|
5172
|
+
# should be used by the index. You can change the capacity of the
|
5173
|
+
# index up to 5 times per day.
|
5174
|
+
#
|
5175
|
+
# If you are using extra storage units, you can't reduce the storage
|
5176
|
+
# capacity below that required to meet the storage needs for your
|
5177
|
+
# index.
|
5178
|
+
# @return [Types::CapacityUnitsConfiguration]
|
5179
|
+
#
|
3402
5180
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndexRequest AWS API Documentation
|
3403
5181
|
#
|
3404
5182
|
class UpdateIndexRequest < Struct.new(
|
@@ -3406,7 +5184,9 @@ module Aws::Kendra
|
|
3406
5184
|
:name,
|
3407
5185
|
:role_arn,
|
3408
5186
|
:description,
|
3409
|
-
:document_metadata_configuration_updates
|
5187
|
+
:document_metadata_configuration_updates,
|
5188
|
+
:capacity_units)
|
5189
|
+
SENSITIVE = []
|
3410
5190
|
include Aws::Structure
|
3411
5191
|
end
|
3412
5192
|
|
@@ -3417,6 +5197,7 @@ module Aws::Kendra
|
|
3417
5197
|
#
|
3418
5198
|
class ValidationException < Struct.new(
|
3419
5199
|
:message)
|
5200
|
+
SENSITIVE = []
|
3420
5201
|
include Aws::Structure
|
3421
5202
|
end
|
3422
5203
|
|