aws-sdk-kendra 1.3.0 → 1.8.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.
@@ -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:
@@ -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:
@@ -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 a total of 3 layers. For example, you can use:
112
+ # use 2 layers under the first attribute filter. For example, you can
113
+ # use:
101
114
  #
102
- # 1. `<AndAllFilters>`
115
+ # `<AndAllFilters>`
103
116
  #
104
- # 2. ` <OrAllFilters>`
117
+ # 1. ` <OrAllFilters>`
105
118
  #
106
- # 3. ` <EqualTo>`
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
- # Each document is limited to 5 Mb, the total size of the list is
591
- # limited to 50 Mb.
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 data and time that the result was clicked.
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
@@ -856,10 +943,140 @@ module Aws::Kendra
856
943
  # allowed_groups_column_name: "ColumnName", # required
857
944
  # },
858
945
  # },
946
+ # salesforce_configuration: {
947
+ # server_url: "Url", # required
948
+ # secret_arn: "SecretArn", # required
949
+ # standard_object_configurations: [
950
+ # {
951
+ # name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
952
+ # document_data_field_name: "DataSourceFieldName", # required
953
+ # document_title_field_name: "DataSourceFieldName",
954
+ # field_mappings: [
955
+ # {
956
+ # data_source_field_name: "DataSourceFieldName", # required
957
+ # date_field_format: "DataSourceDateFieldFormat",
958
+ # index_field_name: "IndexFieldName", # required
959
+ # },
960
+ # ],
961
+ # },
962
+ # ],
963
+ # knowledge_article_configuration: {
964
+ # included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
965
+ # standard_knowledge_article_type_configuration: {
966
+ # document_data_field_name: "DataSourceFieldName", # required
967
+ # document_title_field_name: "DataSourceFieldName",
968
+ # field_mappings: [
969
+ # {
970
+ # data_source_field_name: "DataSourceFieldName", # required
971
+ # date_field_format: "DataSourceDateFieldFormat",
972
+ # index_field_name: "IndexFieldName", # required
973
+ # },
974
+ # ],
975
+ # },
976
+ # custom_knowledge_article_type_configurations: [
977
+ # {
978
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
979
+ # document_data_field_name: "DataSourceFieldName", # required
980
+ # document_title_field_name: "DataSourceFieldName",
981
+ # field_mappings: [
982
+ # {
983
+ # data_source_field_name: "DataSourceFieldName", # required
984
+ # date_field_format: "DataSourceDateFieldFormat",
985
+ # index_field_name: "IndexFieldName", # required
986
+ # },
987
+ # ],
988
+ # },
989
+ # ],
990
+ # },
991
+ # chatter_feed_configuration: {
992
+ # document_data_field_name: "DataSourceFieldName", # required
993
+ # document_title_field_name: "DataSourceFieldName",
994
+ # field_mappings: [
995
+ # {
996
+ # data_source_field_name: "DataSourceFieldName", # required
997
+ # date_field_format: "DataSourceDateFieldFormat",
998
+ # index_field_name: "IndexFieldName", # required
999
+ # },
1000
+ # ],
1001
+ # include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
1002
+ # },
1003
+ # crawl_attachments: false,
1004
+ # standard_object_attachment_configuration: {
1005
+ # document_title_field_name: "DataSourceFieldName",
1006
+ # field_mappings: [
1007
+ # {
1008
+ # data_source_field_name: "DataSourceFieldName", # required
1009
+ # date_field_format: "DataSourceDateFieldFormat",
1010
+ # index_field_name: "IndexFieldName", # required
1011
+ # },
1012
+ # ],
1013
+ # },
1014
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1015
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1016
+ # },
1017
+ # one_drive_configuration: {
1018
+ # tenant_domain: "TenantDomain", # required
1019
+ # secret_arn: "SecretArn", # required
1020
+ # one_drive_users: { # required
1021
+ # one_drive_user_list: ["OneDriveUser"],
1022
+ # one_drive_user_s3_path: {
1023
+ # bucket: "S3BucketName", # required
1024
+ # key: "S3ObjectKey", # required
1025
+ # },
1026
+ # },
1027
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1028
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1029
+ # field_mappings: [
1030
+ # {
1031
+ # data_source_field_name: "DataSourceFieldName", # required
1032
+ # date_field_format: "DataSourceDateFieldFormat",
1033
+ # index_field_name: "IndexFieldName", # required
1034
+ # },
1035
+ # ],
1036
+ # },
1037
+ # service_now_configuration: {
1038
+ # host_url: "ServiceNowHostUrl", # required
1039
+ # secret_arn: "SecretArn", # required
1040
+ # service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
1041
+ # knowledge_article_configuration: {
1042
+ # crawl_attachments: false,
1043
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1044
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1045
+ # document_data_field_name: "DataSourceFieldName", # required
1046
+ # document_title_field_name: "DataSourceFieldName",
1047
+ # field_mappings: [
1048
+ # {
1049
+ # data_source_field_name: "DataSourceFieldName", # required
1050
+ # date_field_format: "DataSourceDateFieldFormat",
1051
+ # index_field_name: "IndexFieldName", # required
1052
+ # },
1053
+ # ],
1054
+ # },
1055
+ # service_catalog_configuration: {
1056
+ # crawl_attachments: false,
1057
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1058
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1059
+ # document_data_field_name: "DataSourceFieldName", # required
1060
+ # document_title_field_name: "DataSourceFieldName",
1061
+ # field_mappings: [
1062
+ # {
1063
+ # data_source_field_name: "DataSourceFieldName", # required
1064
+ # date_field_format: "DataSourceDateFieldFormat",
1065
+ # index_field_name: "IndexFieldName", # required
1066
+ # },
1067
+ # ],
1068
+ # },
1069
+ # },
859
1070
  # },
860
1071
  # description: "Description",
861
1072
  # schedule: "ScanSchedule",
862
1073
  # role_arn: "RoleArn", # required
1074
+ # tags: [
1075
+ # {
1076
+ # key: "TagKey", # required
1077
+ # value: "TagValue", # required
1078
+ # },
1079
+ # ],
863
1080
  # }
864
1081
  #
865
1082
  # @!attribute [rw] name
@@ -902,6 +1119,12 @@ module Aws::Kendra
902
1119
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
903
1120
  # @return [String]
904
1121
  #
1122
+ # @!attribute [rw] tags
1123
+ # A list of key-value pairs that identify the data source. You can use
1124
+ # the tags to identify and organize your resources and to control
1125
+ # access to resources.
1126
+ # @return [Array<Types::Tag>]
1127
+ #
905
1128
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceRequest AWS API Documentation
906
1129
  #
907
1130
  class CreateDataSourceRequest < Struct.new(
@@ -911,7 +1134,9 @@ module Aws::Kendra
911
1134
  :configuration,
912
1135
  :description,
913
1136
  :schedule,
914
- :role_arn)
1137
+ :role_arn,
1138
+ :tags)
1139
+ SENSITIVE = []
915
1140
  include Aws::Structure
916
1141
  end
917
1142
 
@@ -923,6 +1148,7 @@ module Aws::Kendra
923
1148
  #
924
1149
  class CreateDataSourceResponse < Struct.new(
925
1150
  :id)
1151
+ SENSITIVE = []
926
1152
  include Aws::Structure
927
1153
  end
928
1154
 
@@ -938,6 +1164,12 @@ module Aws::Kendra
938
1164
  # key: "S3ObjectKey", # required
939
1165
  # },
940
1166
  # role_arn: "RoleArn", # required
1167
+ # tags: [
1168
+ # {
1169
+ # key: "TagKey", # required
1170
+ # value: "TagValue", # required
1171
+ # },
1172
+ # ],
941
1173
  # }
942
1174
  #
943
1175
  # @!attribute [rw] index_id
@@ -966,6 +1198,12 @@ module Aws::Kendra
966
1198
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
967
1199
  # @return [String]
968
1200
  #
1201
+ # @!attribute [rw] tags
1202
+ # A list of key-value pairs that identify the FAQ. You can use the
1203
+ # tags to identify and organize your resources and to control access
1204
+ # to resources.
1205
+ # @return [Array<Types::Tag>]
1206
+ #
969
1207
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
970
1208
  #
971
1209
  class CreateFaqRequest < Struct.new(
@@ -973,7 +1211,9 @@ module Aws::Kendra
973
1211
  :name,
974
1212
  :description,
975
1213
  :s3_path,
976
- :role_arn)
1214
+ :role_arn,
1215
+ :tags)
1216
+ SENSITIVE = []
977
1217
  include Aws::Structure
978
1218
  end
979
1219
 
@@ -985,6 +1225,7 @@ module Aws::Kendra
985
1225
  #
986
1226
  class CreateFaqResponse < Struct.new(
987
1227
  :id)
1228
+ SENSITIVE = []
988
1229
  include Aws::Structure
989
1230
  end
990
1231
 
@@ -993,18 +1234,33 @@ module Aws::Kendra
993
1234
  #
994
1235
  # {
995
1236
  # name: "IndexName", # required
1237
+ # edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
996
1238
  # role_arn: "RoleArn", # required
997
1239
  # server_side_encryption_configuration: {
998
1240
  # kms_key_id: "KmsKeyId",
999
1241
  # },
1000
1242
  # description: "Description",
1001
1243
  # client_token: "ClientTokenName",
1244
+ # tags: [
1245
+ # {
1246
+ # key: "TagKey", # required
1247
+ # value: "TagValue", # required
1248
+ # },
1249
+ # ],
1002
1250
  # }
1003
1251
  #
1004
1252
  # @!attribute [rw] name
1005
1253
  # The name for the new index.
1006
1254
  # @return [String]
1007
1255
  #
1256
+ # @!attribute [rw] edition
1257
+ # The Amazon Kendra edition to use for the index. Choose
1258
+ # `DEVELOPER_EDITION` for indexes intended for development, testing,
1259
+ # or proof of concept. Use `ENTERPRISE_EDITION` for your production
1260
+ # databases. Once you set the edition for an index, it can't be
1261
+ # changed.
1262
+ # @return [String]
1263
+ #
1008
1264
  # @!attribute [rw] role_arn
1009
1265
  # An IAM role that gives Amazon Kendra permissions to access your
1010
1266
  # Amazon CloudWatch logs and metrics. This is also the role used when
@@ -1031,14 +1287,23 @@ module Aws::Kendra
1031
1287
  # not need to pass this option.
1032
1288
  # @return [String]
1033
1289
  #
1290
+ # @!attribute [rw] tags
1291
+ # A list of key-value pairs that identify the index. You can use the
1292
+ # tags to identify and organize your resources and to control access
1293
+ # to resources.
1294
+ # @return [Array<Types::Tag>]
1295
+ #
1034
1296
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
1035
1297
  #
1036
1298
  class CreateIndexRequest < Struct.new(
1037
1299
  :name,
1300
+ :edition,
1038
1301
  :role_arn,
1039
1302
  :server_side_encryption_configuration,
1040
1303
  :description,
1041
- :client_token)
1304
+ :client_token,
1305
+ :tags)
1306
+ SENSITIVE = []
1042
1307
  include Aws::Structure
1043
1308
  end
1044
1309
 
@@ -1051,6 +1316,7 @@ module Aws::Kendra
1051
1316
  #
1052
1317
  class CreateIndexResponse < Struct.new(
1053
1318
  :id)
1319
+ SENSITIVE = []
1054
1320
  include Aws::Structure
1055
1321
  end
1056
1322
 
@@ -1122,6 +1388,130 @@ module Aws::Kendra
1122
1388
  # allowed_groups_column_name: "ColumnName", # required
1123
1389
  # },
1124
1390
  # },
1391
+ # salesforce_configuration: {
1392
+ # server_url: "Url", # required
1393
+ # secret_arn: "SecretArn", # required
1394
+ # standard_object_configurations: [
1395
+ # {
1396
+ # name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
1397
+ # document_data_field_name: "DataSourceFieldName", # required
1398
+ # document_title_field_name: "DataSourceFieldName",
1399
+ # field_mappings: [
1400
+ # {
1401
+ # data_source_field_name: "DataSourceFieldName", # required
1402
+ # date_field_format: "DataSourceDateFieldFormat",
1403
+ # index_field_name: "IndexFieldName", # required
1404
+ # },
1405
+ # ],
1406
+ # },
1407
+ # ],
1408
+ # knowledge_article_configuration: {
1409
+ # included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
1410
+ # standard_knowledge_article_type_configuration: {
1411
+ # document_data_field_name: "DataSourceFieldName", # required
1412
+ # document_title_field_name: "DataSourceFieldName",
1413
+ # field_mappings: [
1414
+ # {
1415
+ # data_source_field_name: "DataSourceFieldName", # required
1416
+ # date_field_format: "DataSourceDateFieldFormat",
1417
+ # index_field_name: "IndexFieldName", # required
1418
+ # },
1419
+ # ],
1420
+ # },
1421
+ # custom_knowledge_article_type_configurations: [
1422
+ # {
1423
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
1424
+ # document_data_field_name: "DataSourceFieldName", # required
1425
+ # document_title_field_name: "DataSourceFieldName",
1426
+ # field_mappings: [
1427
+ # {
1428
+ # data_source_field_name: "DataSourceFieldName", # required
1429
+ # date_field_format: "DataSourceDateFieldFormat",
1430
+ # index_field_name: "IndexFieldName", # required
1431
+ # },
1432
+ # ],
1433
+ # },
1434
+ # ],
1435
+ # },
1436
+ # chatter_feed_configuration: {
1437
+ # document_data_field_name: "DataSourceFieldName", # required
1438
+ # document_title_field_name: "DataSourceFieldName",
1439
+ # field_mappings: [
1440
+ # {
1441
+ # data_source_field_name: "DataSourceFieldName", # required
1442
+ # date_field_format: "DataSourceDateFieldFormat",
1443
+ # index_field_name: "IndexFieldName", # required
1444
+ # },
1445
+ # ],
1446
+ # include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
1447
+ # },
1448
+ # crawl_attachments: false,
1449
+ # standard_object_attachment_configuration: {
1450
+ # document_title_field_name: "DataSourceFieldName",
1451
+ # field_mappings: [
1452
+ # {
1453
+ # data_source_field_name: "DataSourceFieldName", # required
1454
+ # date_field_format: "DataSourceDateFieldFormat",
1455
+ # index_field_name: "IndexFieldName", # required
1456
+ # },
1457
+ # ],
1458
+ # },
1459
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1460
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1461
+ # },
1462
+ # one_drive_configuration: {
1463
+ # tenant_domain: "TenantDomain", # required
1464
+ # secret_arn: "SecretArn", # required
1465
+ # one_drive_users: { # required
1466
+ # one_drive_user_list: ["OneDriveUser"],
1467
+ # one_drive_user_s3_path: {
1468
+ # bucket: "S3BucketName", # required
1469
+ # key: "S3ObjectKey", # required
1470
+ # },
1471
+ # },
1472
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1473
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1474
+ # field_mappings: [
1475
+ # {
1476
+ # data_source_field_name: "DataSourceFieldName", # required
1477
+ # date_field_format: "DataSourceDateFieldFormat",
1478
+ # index_field_name: "IndexFieldName", # required
1479
+ # },
1480
+ # ],
1481
+ # },
1482
+ # service_now_configuration: {
1483
+ # host_url: "ServiceNowHostUrl", # required
1484
+ # secret_arn: "SecretArn", # required
1485
+ # service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
1486
+ # knowledge_article_configuration: {
1487
+ # crawl_attachments: false,
1488
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1489
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1490
+ # document_data_field_name: "DataSourceFieldName", # required
1491
+ # document_title_field_name: "DataSourceFieldName",
1492
+ # field_mappings: [
1493
+ # {
1494
+ # data_source_field_name: "DataSourceFieldName", # required
1495
+ # date_field_format: "DataSourceDateFieldFormat",
1496
+ # index_field_name: "IndexFieldName", # required
1497
+ # },
1498
+ # ],
1499
+ # },
1500
+ # service_catalog_configuration: {
1501
+ # crawl_attachments: false,
1502
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1503
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1504
+ # document_data_field_name: "DataSourceFieldName", # required
1505
+ # document_title_field_name: "DataSourceFieldName",
1506
+ # field_mappings: [
1507
+ # {
1508
+ # data_source_field_name: "DataSourceFieldName", # required
1509
+ # date_field_format: "DataSourceDateFieldFormat",
1510
+ # index_field_name: "IndexFieldName", # required
1511
+ # },
1512
+ # ],
1513
+ # },
1514
+ # },
1125
1515
  # }
1126
1516
  #
1127
1517
  # @!attribute [rw] s3_configuration
@@ -1138,12 +1528,31 @@ module Aws::Kendra
1138
1528
  # Provides information necessary to create a connector for a database.
1139
1529
  # @return [Types::DatabaseConfiguration]
1140
1530
  #
1531
+ # @!attribute [rw] salesforce_configuration
1532
+ # Provides configuration information for data sources that connect to
1533
+ # a Salesforce site.
1534
+ # @return [Types::SalesforceConfiguration]
1535
+ #
1536
+ # @!attribute [rw] one_drive_configuration
1537
+ # Provided configuration for data sources that connect to Microsoft
1538
+ # OneDrive.
1539
+ # @return [Types::OneDriveConfiguration]
1540
+ #
1541
+ # @!attribute [rw] service_now_configuration
1542
+ # Provides configuration for data sources that connect to ServiceNow
1543
+ # instances.
1544
+ # @return [Types::ServiceNowConfiguration]
1545
+ #
1141
1546
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
1142
1547
  #
1143
1548
  class DataSourceConfiguration < Struct.new(
1144
1549
  :s3_configuration,
1145
1550
  :share_point_configuration,
1146
- :database_configuration)
1551
+ :database_configuration,
1552
+ :salesforce_configuration,
1553
+ :one_drive_configuration,
1554
+ :service_now_configuration)
1555
+ SENSITIVE = []
1147
1556
  include Aws::Structure
1148
1557
  end
1149
1558
 
@@ -1184,6 +1593,7 @@ module Aws::Kendra
1184
1593
  :created_at,
1185
1594
  :updated_at,
1186
1595
  :status)
1596
+ SENSITIVE = []
1187
1597
  include Aws::Structure
1188
1598
  end
1189
1599
 
@@ -1225,6 +1635,12 @@ module Aws::Kendra
1225
1635
  # identifies the error.
1226
1636
  # @return [String]
1227
1637
  #
1638
+ # @!attribute [rw] metrics
1639
+ # Maps a batch delete document request to a specific data source sync
1640
+ # job. This is optional and should only be supplied when documents are
1641
+ # deleted by a connector.
1642
+ # @return [Types::DataSourceSyncJobMetrics]
1643
+ #
1228
1644
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJob AWS API Documentation
1229
1645
  #
1230
1646
  class DataSourceSyncJob < Struct.new(
@@ -1234,7 +1650,77 @@ module Aws::Kendra
1234
1650
  :status,
1235
1651
  :error_message,
1236
1652
  :error_code,
1237
- :data_source_error_code)
1653
+ :data_source_error_code,
1654
+ :metrics)
1655
+ SENSITIVE = []
1656
+ include Aws::Structure
1657
+ end
1658
+
1659
+ # Maps a particular data source sync job to a particular data source.
1660
+ #
1661
+ # @note When making an API call, you may pass DataSourceSyncJobMetricTarget
1662
+ # data as a hash:
1663
+ #
1664
+ # {
1665
+ # data_source_id: "DataSourceId", # required
1666
+ # data_source_sync_job_id: "DataSourceSyncJobId", # required
1667
+ # }
1668
+ #
1669
+ # @!attribute [rw] data_source_id
1670
+ # The ID of the data source that is running the sync job.
1671
+ # @return [String]
1672
+ #
1673
+ # @!attribute [rw] data_source_sync_job_id
1674
+ # The ID of the sync job that is running on the data source.
1675
+ # @return [String]
1676
+ #
1677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
1678
+ #
1679
+ class DataSourceSyncJobMetricTarget < Struct.new(
1680
+ :data_source_id,
1681
+ :data_source_sync_job_id)
1682
+ SENSITIVE = []
1683
+ include Aws::Structure
1684
+ end
1685
+
1686
+ # Maps a batch delete document request to a specific data source sync
1687
+ # job. This is optional and should only be supplied when documents are
1688
+ # deleted by a connector.
1689
+ #
1690
+ # @!attribute [rw] documents_added
1691
+ # The number of documents added from the data source up to now in the
1692
+ # data source sync.
1693
+ # @return [String]
1694
+ #
1695
+ # @!attribute [rw] documents_modified
1696
+ # The number of documents modified in the data source up to now in the
1697
+ # data source sync run.
1698
+ # @return [String]
1699
+ #
1700
+ # @!attribute [rw] documents_deleted
1701
+ # The number of documents deleted from the data source up to now in
1702
+ # the data source sync run.
1703
+ # @return [String]
1704
+ #
1705
+ # @!attribute [rw] documents_failed
1706
+ # The number of documents that failed to sync from the data source up
1707
+ # to now in the data source sync run.
1708
+ # @return [String]
1709
+ #
1710
+ # @!attribute [rw] documents_scanned
1711
+ # The current number of documents crawled by the current sync job in
1712
+ # the data source.
1713
+ # @return [String]
1714
+ #
1715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetrics AWS API Documentation
1716
+ #
1717
+ class DataSourceSyncJobMetrics < Struct.new(
1718
+ :documents_added,
1719
+ :documents_modified,
1720
+ :documents_deleted,
1721
+ :documents_failed,
1722
+ :documents_scanned)
1723
+ SENSITIVE = []
1238
1724
  include Aws::Structure
1239
1725
  end
1240
1726
 
@@ -1269,6 +1755,7 @@ module Aws::Kendra
1269
1755
  :data_source_field_name,
1270
1756
  :date_field_format,
1271
1757
  :index_field_name)
1758
+ SENSITIVE = []
1272
1759
  include Aws::Structure
1273
1760
  end
1274
1761
 
@@ -1299,6 +1786,7 @@ module Aws::Kendra
1299
1786
  class DataSourceVpcConfiguration < Struct.new(
1300
1787
  :subnet_ids,
1301
1788
  :security_group_ids)
1789
+ SENSITIVE = []
1302
1790
  include Aws::Structure
1303
1791
  end
1304
1792
 
@@ -1368,6 +1856,32 @@ module Aws::Kendra
1368
1856
  :vpc_configuration,
1369
1857
  :column_configuration,
1370
1858
  :acl_configuration)
1859
+ SENSITIVE = []
1860
+ include Aws::Structure
1861
+ end
1862
+
1863
+ # @note When making an API call, you may pass DeleteDataSourceRequest
1864
+ # data as a hash:
1865
+ #
1866
+ # {
1867
+ # id: "DataSourceId", # required
1868
+ # index_id: "IndexId", # required
1869
+ # }
1870
+ #
1871
+ # @!attribute [rw] id
1872
+ # The unique identifier of the data source to delete.
1873
+ # @return [String]
1874
+ #
1875
+ # @!attribute [rw] index_id
1876
+ # The unique identifier of the index associated with the data source.
1877
+ # @return [String]
1878
+ #
1879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
1880
+ #
1881
+ class DeleteDataSourceRequest < Struct.new(
1882
+ :id,
1883
+ :index_id)
1884
+ SENSITIVE = []
1371
1885
  include Aws::Structure
1372
1886
  end
1373
1887
 
@@ -1392,6 +1906,7 @@ module Aws::Kendra
1392
1906
  class DeleteFaqRequest < Struct.new(
1393
1907
  :id,
1394
1908
  :index_id)
1909
+ SENSITIVE = []
1395
1910
  include Aws::Structure
1396
1911
  end
1397
1912
 
@@ -1410,6 +1925,7 @@ module Aws::Kendra
1410
1925
  #
1411
1926
  class DeleteIndexRequest < Struct.new(
1412
1927
  :id)
1928
+ SENSITIVE = []
1413
1929
  include Aws::Structure
1414
1930
  end
1415
1931
 
@@ -1434,6 +1950,7 @@ module Aws::Kendra
1434
1950
  class DescribeDataSourceRequest < Struct.new(
1435
1951
  :id,
1436
1952
  :index_id)
1953
+ SENSITIVE = []
1437
1954
  include Aws::Structure
1438
1955
  end
1439
1956
 
@@ -1508,6 +2025,7 @@ module Aws::Kendra
1508
2025
  :schedule,
1509
2026
  :role_arn,
1510
2027
  :error_message)
2028
+ SENSITIVE = []
1511
2029
  include Aws::Structure
1512
2030
  end
1513
2031
 
@@ -1532,6 +2050,7 @@ module Aws::Kendra
1532
2050
  class DescribeFaqRequest < Struct.new(
1533
2051
  :id,
1534
2052
  :index_id)
2053
+ SENSITIVE = []
1535
2054
  include Aws::Structure
1536
2055
  end
1537
2056
 
@@ -1591,6 +2110,7 @@ module Aws::Kendra
1591
2110
  :status,
1592
2111
  :role_arn,
1593
2112
  :error_message)
2113
+ SENSITIVE = []
1594
2114
  include Aws::Structure
1595
2115
  end
1596
2116
 
@@ -1609,6 +2129,7 @@ module Aws::Kendra
1609
2129
  #
1610
2130
  class DescribeIndexRequest < Struct.new(
1611
2131
  :id)
2132
+ SENSITIVE = []
1612
2133
  include Aws::Structure
1613
2134
  end
1614
2135
 
@@ -1620,6 +2141,11 @@ module Aws::Kendra
1620
2141
  # the name of the index.
1621
2142
  # @return [String]
1622
2143
  #
2144
+ # @!attribute [rw] edition
2145
+ # The Amazon Kendra edition used for the index. You decide the edition
2146
+ # when you create the index.
2147
+ # @return [String]
2148
+ #
1623
2149
  # @!attribute [rw] role_arn
1624
2150
  # The Amazon Resource Name (ARN) of the IAM role that gives Amazon
1625
2151
  # Kendra permission to write to your Amazon Cloudwatch logs.
@@ -1663,11 +2189,20 @@ module Aws::Kendra
1663
2189
  # contains a message that explains why.
1664
2190
  # @return [String]
1665
2191
  #
2192
+ # @!attribute [rw] capacity_units
2193
+ # For enterprise edtion indexes, you can choose to use additional
2194
+ # capacity to meet the needs of your application. This contains the
2195
+ # capacity units used for the index. A 0 for the query capacity or the
2196
+ # storage capacity indicates that the index is using the default
2197
+ # capacity for the index.
2198
+ # @return [Types::CapacityUnitsConfiguration]
2199
+ #
1666
2200
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
1667
2201
  #
1668
2202
  class DescribeIndexResponse < Struct.new(
1669
2203
  :name,
1670
2204
  :id,
2205
+ :edition,
1671
2206
  :role_arn,
1672
2207
  :server_side_encryption_configuration,
1673
2208
  :status,
@@ -1676,7 +2211,9 @@ module Aws::Kendra
1676
2211
  :updated_at,
1677
2212
  :document_metadata_configurations,
1678
2213
  :index_statistics,
1679
- :error_message)
2214
+ :error_message,
2215
+ :capacity_units)
2216
+ SENSITIVE = []
1680
2217
  include Aws::Structure
1681
2218
  end
1682
2219
 
@@ -1761,6 +2298,7 @@ module Aws::Kendra
1761
2298
  :attributes,
1762
2299
  :access_control_list,
1763
2300
  :content_type)
2301
+ SENSITIVE = []
1764
2302
  include Aws::Structure
1765
2303
  end
1766
2304
 
@@ -1792,6 +2330,7 @@ module Aws::Kendra
1792
2330
  class DocumentAttribute < Struct.new(
1793
2331
  :key,
1794
2332
  :value)
2333
+ SENSITIVE = []
1795
2334
  include Aws::Structure
1796
2335
  end
1797
2336
 
@@ -1831,6 +2370,7 @@ module Aws::Kendra
1831
2370
  :string_list_value,
1832
2371
  :long_value,
1833
2372
  :date_value)
2373
+ SENSITIVE = []
1834
2374
  include Aws::Structure
1835
2375
  end
1836
2376
 
@@ -1851,6 +2391,7 @@ module Aws::Kendra
1851
2391
  class DocumentAttributeValueCountPair < Struct.new(
1852
2392
  :document_attribute_value,
1853
2393
  :count)
2394
+ SENSITIVE = []
1854
2395
  include Aws::Structure
1855
2396
  end
1856
2397
 
@@ -1902,6 +2443,7 @@ module Aws::Kendra
1902
2443
  :type,
1903
2444
  :relevance,
1904
2445
  :search)
2446
+ SENSITIVE = []
1905
2447
  include Aws::Structure
1906
2448
  end
1907
2449
 
@@ -1927,10 +2469,11 @@ module Aws::Kendra
1927
2469
  #
1928
2470
  class DocumentsMetadataConfiguration < Struct.new(
1929
2471
  :s3_prefix)
2472
+ SENSITIVE = []
1930
2473
  include Aws::Structure
1931
2474
  end
1932
2475
 
1933
- # Information a document attribute
2476
+ # Information about a document attribute
1934
2477
  #
1935
2478
  # @note When making an API call, you may pass Facet
1936
2479
  # data as a hash:
@@ -1947,6 +2490,7 @@ module Aws::Kendra
1947
2490
  #
1948
2491
  class Facet < Struct.new(
1949
2492
  :document_attribute_key)
2493
+ SENSITIVE = []
1950
2494
  include Aws::Structure
1951
2495
  end
1952
2496
 
@@ -1968,6 +2512,7 @@ module Aws::Kendra
1968
2512
  class FacetResult < Struct.new(
1969
2513
  :document_attribute_key,
1970
2514
  :document_attribute_value_count_pairs)
2515
+ SENSITIVE = []
1971
2516
  include Aws::Structure
1972
2517
  end
1973
2518
 
@@ -1983,6 +2528,7 @@ module Aws::Kendra
1983
2528
  #
1984
2529
  class FaqStatistics < Struct.new(
1985
2530
  :indexed_question_answers_count)
2531
+ SENSITIVE = []
1986
2532
  include Aws::Structure
1987
2533
  end
1988
2534
 
@@ -2019,6 +2565,7 @@ module Aws::Kendra
2019
2565
  :status,
2020
2566
  :created_at,
2021
2567
  :updated_at)
2568
+ SENSITIVE = []
2022
2569
  include Aws::Structure
2023
2570
  end
2024
2571
 
@@ -2046,6 +2593,7 @@ module Aws::Kendra
2046
2593
  :begin_offset,
2047
2594
  :end_offset,
2048
2595
  :top_answer)
2596
+ SENSITIVE = []
2049
2597
  include Aws::Structure
2050
2598
  end
2051
2599
 
@@ -2061,6 +2609,11 @@ module Aws::Kendra
2061
2609
  # `UpdateIndex`, and `DeleteIndex`.
2062
2610
  # @return [String]
2063
2611
  #
2612
+ # @!attribute [rw] edition
2613
+ # Indicates whether the index is a enterprise edition index or a
2614
+ # developer edition index.
2615
+ # @return [String]
2616
+ #
2064
2617
  # @!attribute [rw] created_at
2065
2618
  # The Unix timestamp when the index was created.
2066
2619
  # @return [Time]
@@ -2080,9 +2633,11 @@ module Aws::Kendra
2080
2633
  class IndexConfigurationSummary < Struct.new(
2081
2634
  :name,
2082
2635
  :id,
2636
+ :edition,
2083
2637
  :created_at,
2084
2638
  :updated_at,
2085
2639
  :status)
2640
+ SENSITIVE = []
2086
2641
  include Aws::Structure
2087
2642
  end
2088
2643
 
@@ -2102,6 +2657,7 @@ module Aws::Kendra
2102
2657
  class IndexStatistics < Struct.new(
2103
2658
  :faq_statistics,
2104
2659
  :text_document_statistics)
2660
+ SENSITIVE = []
2105
2661
  include Aws::Structure
2106
2662
  end
2107
2663
 
@@ -2112,6 +2668,7 @@ module Aws::Kendra
2112
2668
  #
2113
2669
  class InternalServerException < Struct.new(
2114
2670
  :message)
2671
+ SENSITIVE = []
2115
2672
  include Aws::Structure
2116
2673
  end
2117
2674
 
@@ -2127,7 +2684,7 @@ module Aws::Kendra
2127
2684
  # start_time: Time.now,
2128
2685
  # end_time: Time.now,
2129
2686
  # },
2130
- # status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
2687
+ # status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
2131
2688
  # }
2132
2689
  #
2133
2690
  # @!attribute [rw] id
@@ -2169,6 +2726,7 @@ module Aws::Kendra
2169
2726
  :max_results,
2170
2727
  :start_time_filter,
2171
2728
  :status_filter)
2729
+ SENSITIVE = []
2172
2730
  include Aws::Structure
2173
2731
  end
2174
2732
 
@@ -2190,6 +2748,7 @@ module Aws::Kendra
2190
2748
  class ListDataSourceSyncJobsResponse < Struct.new(
2191
2749
  :history,
2192
2750
  :next_token)
2751
+ SENSITIVE = []
2193
2752
  include Aws::Structure
2194
2753
  end
2195
2754
 
@@ -2223,6 +2782,7 @@ module Aws::Kendra
2223
2782
  :index_id,
2224
2783
  :next_token,
2225
2784
  :max_results)
2785
+ SENSITIVE = []
2226
2786
  include Aws::Structure
2227
2787
  end
2228
2788
 
@@ -2241,6 +2801,7 @@ module Aws::Kendra
2241
2801
  class ListDataSourcesResponse < Struct.new(
2242
2802
  :summary_items,
2243
2803
  :next_token)
2804
+ SENSITIVE = []
2244
2805
  include Aws::Structure
2245
2806
  end
2246
2807
 
@@ -2274,6 +2835,7 @@ module Aws::Kendra
2274
2835
  :index_id,
2275
2836
  :next_token,
2276
2837
  :max_results)
2838
+ SENSITIVE = []
2277
2839
  include Aws::Structure
2278
2840
  end
2279
2841
 
@@ -2294,6 +2856,7 @@ module Aws::Kendra
2294
2856
  class ListFaqsResponse < Struct.new(
2295
2857
  :next_token,
2296
2858
  :faq_summary_items)
2859
+ SENSITIVE = []
2297
2860
  include Aws::Structure
2298
2861
  end
2299
2862
 
@@ -2321,6 +2884,7 @@ module Aws::Kendra
2321
2884
  class ListIndicesRequest < Struct.new(
2322
2885
  :next_token,
2323
2886
  :max_results)
2887
+ SENSITIVE = []
2324
2888
  include Aws::Structure
2325
2889
  end
2326
2890
 
@@ -2339,29 +2903,177 @@ module Aws::Kendra
2339
2903
  class ListIndicesResponse < Struct.new(
2340
2904
  :index_configuration_summary_items,
2341
2905
  :next_token)
2906
+ SENSITIVE = []
2342
2907
  include Aws::Structure
2343
2908
  end
2344
2909
 
2345
- # Provides user and group information for document access filtering.
2346
- #
2347
- # @note When making an API call, you may pass Principal
2910
+ # @note When making an API call, you may pass ListTagsForResourceRequest
2348
2911
  # data as a hash:
2349
2912
  #
2350
2913
  # {
2351
- # name: "PrincipalName", # required
2352
- # type: "USER", # required, accepts USER, GROUP
2353
- # access: "ALLOW", # required, accepts ALLOW, DENY
2914
+ # resource_arn: "AmazonResourceName", # required
2354
2915
  # }
2355
2916
  #
2356
- # @!attribute [rw] name
2357
- # The name of the user or group.
2917
+ # @!attribute [rw] resource_arn
2918
+ # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
2919
+ # get a list of tags for.
2358
2920
  # @return [String]
2359
2921
  #
2360
- # @!attribute [rw] type
2361
- # The type of principal.
2362
- # @return [String]
2922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceRequest AWS API Documentation
2363
2923
  #
2364
- # @!attribute [rw] access
2924
+ class ListTagsForResourceRequest < Struct.new(
2925
+ :resource_arn)
2926
+ SENSITIVE = []
2927
+ include Aws::Structure
2928
+ end
2929
+
2930
+ # @!attribute [rw] tags
2931
+ # A list of tags associated with the index, FAQ, or data source.
2932
+ # @return [Array<Types::Tag>]
2933
+ #
2934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceResponse AWS API Documentation
2935
+ #
2936
+ class ListTagsForResourceResponse < Struct.new(
2937
+ :tags)
2938
+ SENSITIVE = []
2939
+ include Aws::Structure
2940
+ end
2941
+
2942
+ # Provides configuration information for data sources that connect to
2943
+ # OneDrive.
2944
+ #
2945
+ # @note When making an API call, you may pass OneDriveConfiguration
2946
+ # data as a hash:
2947
+ #
2948
+ # {
2949
+ # tenant_domain: "TenantDomain", # required
2950
+ # secret_arn: "SecretArn", # required
2951
+ # one_drive_users: { # required
2952
+ # one_drive_user_list: ["OneDriveUser"],
2953
+ # one_drive_user_s3_path: {
2954
+ # bucket: "S3BucketName", # required
2955
+ # key: "S3ObjectKey", # required
2956
+ # },
2957
+ # },
2958
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2959
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2960
+ # field_mappings: [
2961
+ # {
2962
+ # data_source_field_name: "DataSourceFieldName", # required
2963
+ # date_field_format: "DataSourceDateFieldFormat",
2964
+ # index_field_name: "IndexFieldName", # required
2965
+ # },
2966
+ # ],
2967
+ # }
2968
+ #
2969
+ # @!attribute [rw] tenant_domain
2970
+ # Tha Azure Active Directory domain of the organization.
2971
+ # @return [String]
2972
+ #
2973
+ # @!attribute [rw] secret_arn
2974
+ # The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that
2975
+ # contains the user name and password to connect to OneDrive. The user
2976
+ # namd should be the application ID for the OneDrive application, and
2977
+ # the password is the application key for the OneDrive application.
2978
+ # @return [String]
2979
+ #
2980
+ # @!attribute [rw] one_drive_users
2981
+ # A list of user accounts whose documents should be indexed.
2982
+ # @return [Types::OneDriveUsers]
2983
+ #
2984
+ # @!attribute [rw] inclusion_patterns
2985
+ # A list of regular expression patterns. Documents that match the
2986
+ # pattern are included in the index. Documents that don't match the
2987
+ # pattern are excluded from the index. If a document matches both an
2988
+ # inclusion pattern and an exclusion pattern, the document is not
2989
+ # included in the index.
2990
+ #
2991
+ # The exclusion pattern is applied to the file name.
2992
+ # @return [Array<String>]
2993
+ #
2994
+ # @!attribute [rw] exclusion_patterns
2995
+ # List of regular expressions applied to documents. Items that match
2996
+ # the exclusion pattern are not indexed. If you provide both an
2997
+ # inclusion pattern and an exclusion pattern, any item that matches
2998
+ # the exclusion pattern isn't indexed.
2999
+ #
3000
+ # The exclusion pattern is applied to the file name.
3001
+ # @return [Array<String>]
3002
+ #
3003
+ # @!attribute [rw] field_mappings
3004
+ # A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
3005
+ # OneDrive fields to custom fields in the Amazon Kendra index. You
3006
+ # must first create the index fields before you map OneDrive fields.
3007
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
3008
+ #
3009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveConfiguration AWS API Documentation
3010
+ #
3011
+ class OneDriveConfiguration < Struct.new(
3012
+ :tenant_domain,
3013
+ :secret_arn,
3014
+ :one_drive_users,
3015
+ :inclusion_patterns,
3016
+ :exclusion_patterns,
3017
+ :field_mappings)
3018
+ SENSITIVE = []
3019
+ include Aws::Structure
3020
+ end
3021
+
3022
+ # User accounts whose documents should be indexed.
3023
+ #
3024
+ # @note When making an API call, you may pass OneDriveUsers
3025
+ # data as a hash:
3026
+ #
3027
+ # {
3028
+ # one_drive_user_list: ["OneDriveUser"],
3029
+ # one_drive_user_s3_path: {
3030
+ # bucket: "S3BucketName", # required
3031
+ # key: "S3ObjectKey", # required
3032
+ # },
3033
+ # }
3034
+ #
3035
+ # @!attribute [rw] one_drive_user_list
3036
+ # A list of users whose documents should be indexed. Specify the user
3037
+ # names in email format, for example, `username@tenantdomain`. If you
3038
+ # need to index the documents of more than 100 users, use the
3039
+ # `OneDriveUserS3Path` field to specify the location of a file
3040
+ # containing a list of users.
3041
+ # @return [Array<String>]
3042
+ #
3043
+ # @!attribute [rw] one_drive_user_s3_path
3044
+ # The S3 bucket location of a file containing a list of users whose
3045
+ # documents should be indexed.
3046
+ # @return [Types::S3Path]
3047
+ #
3048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveUsers AWS API Documentation
3049
+ #
3050
+ class OneDriveUsers < Struct.new(
3051
+ :one_drive_user_list,
3052
+ :one_drive_user_s3_path)
3053
+ SENSITIVE = []
3054
+ include Aws::Structure
3055
+ end
3056
+
3057
+ # Provides user and group information for document access filtering.
3058
+ #
3059
+ # @note When making an API call, you may pass Principal
3060
+ # data as a hash:
3061
+ #
3062
+ # {
3063
+ # name: "PrincipalName", # required
3064
+ # type: "USER", # required, accepts USER, GROUP
3065
+ # access: "ALLOW", # required, accepts ALLOW, DENY
3066
+ # }
3067
+ #
3068
+ # @!attribute [rw] name
3069
+ # The name of the user or group.
3070
+ # @return [String]
3071
+ #
3072
+ # @!attribute [rw] type
3073
+ # The type of principal.
3074
+ # @return [String]
3075
+ #
3076
+ # @!attribute [rw] access
2365
3077
  # Whether to allow or deny access to the principal.
2366
3078
  # @return [String]
2367
3079
  #
@@ -2371,6 +3083,7 @@ module Aws::Kendra
2371
3083
  :name,
2372
3084
  :type,
2373
3085
  :access)
3086
+ SENSITIVE = []
2374
3087
  include Aws::Structure
2375
3088
  end
2376
3089
 
@@ -2514,7 +3227,9 @@ module Aws::Kendra
2514
3227
  #
2515
3228
  # @!attribute [rw] page_size
2516
3229
  # Sets the number of results that are returned in each page of
2517
- # results. The default page size is 100.
3230
+ # results. The default page size is 10. The maximum number of results
3231
+ # returned is 100. If you ask for more than 100 results, only 100 are
3232
+ # returned.
2518
3233
  # @return [Integer]
2519
3234
  #
2520
3235
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
@@ -2528,6 +3243,7 @@ module Aws::Kendra
2528
3243
  :query_result_type_filter,
2529
3244
  :page_number,
2530
3245
  :page_size)
3246
+ SENSITIVE = []
2531
3247
  include Aws::Structure
2532
3248
  end
2533
3249
 
@@ -2558,6 +3274,7 @@ module Aws::Kendra
2558
3274
  :result_items,
2559
3275
  :facet_results,
2560
3276
  :total_number_of_results)
3277
+ SENSITIVE = []
2561
3278
  include Aws::Structure
2562
3279
  end
2563
3280
 
@@ -2577,6 +3294,7 @@ module Aws::Kendra
2577
3294
  # @return [String]
2578
3295
  #
2579
3296
  # @!attribute [rw] additional_attributes
3297
+ # One or more additional attribues associated with the query result.
2580
3298
  # @return [Array<Types::AdditionalResultAttribute>]
2581
3299
  #
2582
3300
  # @!attribute [rw] document_id
@@ -2614,6 +3332,7 @@ module Aws::Kendra
2614
3332
  :document_excerpt,
2615
3333
  :document_uri,
2616
3334
  :document_attributes)
3335
+ SENSITIVE = []
2617
3336
  include Aws::Structure
2618
3337
  end
2619
3338
 
@@ -2696,6 +3415,7 @@ module Aws::Kendra
2696
3415
  :duration,
2697
3416
  :rank_order,
2698
3417
  :value_importance_map)
3418
+ SENSITIVE = []
2699
3419
  include Aws::Structure
2700
3420
  end
2701
3421
 
@@ -2725,6 +3445,7 @@ module Aws::Kendra
2725
3445
  class RelevanceFeedback < Struct.new(
2726
3446
  :result_id,
2727
3447
  :relevance_value)
3448
+ SENSITIVE = []
2728
3449
  include Aws::Structure
2729
3450
  end
2730
3451
 
@@ -2735,6 +3456,7 @@ module Aws::Kendra
2735
3456
  #
2736
3457
  class ResourceAlreadyExistException < Struct.new(
2737
3458
  :message)
3459
+ SENSITIVE = []
2738
3460
  include Aws::Structure
2739
3461
  end
2740
3462
 
@@ -2745,6 +3467,7 @@ module Aws::Kendra
2745
3467
  #
2746
3468
  class ResourceInUseException < Struct.new(
2747
3469
  :message)
3470
+ SENSITIVE = []
2748
3471
  include Aws::Structure
2749
3472
  end
2750
3473
 
@@ -2755,6 +3478,7 @@ module Aws::Kendra
2755
3478
  #
2756
3479
  class ResourceNotFoundException < Struct.new(
2757
3480
  :message)
3481
+ SENSITIVE = []
2758
3482
  include Aws::Structure
2759
3483
  end
2760
3484
 
@@ -2765,6 +3489,7 @@ module Aws::Kendra
2765
3489
  #
2766
3490
  class ResourceUnavailableException < Struct.new(
2767
3491
  :message)
3492
+ SENSITIVE = []
2768
3493
  include Aws::Structure
2769
3494
  end
2770
3495
 
@@ -2805,7 +3530,7 @@ module Aws::Kendra
2805
3530
  #
2806
3531
  #
2807
3532
  #
2808
- # [1]: http://wikipedia.org/wiki/Glob_%28programming%29
3533
+ # [1]: https://en.wikipedia.org/wiki/Glob_(programming)
2809
3534
  # @return [Array<String>]
2810
3535
  #
2811
3536
  # @!attribute [rw] documents_metadata_configuration
@@ -2828,32 +3553,496 @@ module Aws::Kendra
2828
3553
  :exclusion_patterns,
2829
3554
  :documents_metadata_configuration,
2830
3555
  :access_control_list_configuration)
3556
+ SENSITIVE = []
3557
+ include Aws::Structure
3558
+ end
3559
+
3560
+ # Information required to find a specific file in an Amazon S3 bucket.
3561
+ #
3562
+ # @note When making an API call, you may pass S3Path
3563
+ # data as a hash:
3564
+ #
3565
+ # {
3566
+ # bucket: "S3BucketName", # required
3567
+ # key: "S3ObjectKey", # required
3568
+ # }
3569
+ #
3570
+ # @!attribute [rw] bucket
3571
+ # The name of the S3 bucket that contains the file.
3572
+ # @return [String]
3573
+ #
3574
+ # @!attribute [rw] key
3575
+ # The name of the file.
3576
+ # @return [String]
3577
+ #
3578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3Path AWS API Documentation
3579
+ #
3580
+ class S3Path < Struct.new(
3581
+ :bucket,
3582
+ :key)
3583
+ SENSITIVE = []
3584
+ include Aws::Structure
3585
+ end
3586
+
3587
+ # Defines configuration for syncing a Salesforce chatter feed. The
3588
+ # contents of the object comes from the Salesforce FeedItem table.
3589
+ #
3590
+ # @note When making an API call, you may pass SalesforceChatterFeedConfiguration
3591
+ # data as a hash:
3592
+ #
3593
+ # {
3594
+ # document_data_field_name: "DataSourceFieldName", # required
3595
+ # document_title_field_name: "DataSourceFieldName",
3596
+ # field_mappings: [
3597
+ # {
3598
+ # data_source_field_name: "DataSourceFieldName", # required
3599
+ # date_field_format: "DataSourceDateFieldFormat",
3600
+ # index_field_name: "IndexFieldName", # required
3601
+ # },
3602
+ # ],
3603
+ # include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
3604
+ # }
3605
+ #
3606
+ # @!attribute [rw] document_data_field_name
3607
+ # The name of the column in the Salesforce FeedItem table that
3608
+ # contains the content to index. Typically this is the `Body` column.
3609
+ # @return [String]
3610
+ #
3611
+ # @!attribute [rw] document_title_field_name
3612
+ # The name of the column in the Salesforce FeedItem table that
3613
+ # contains the title of the document. This is typically the `Title`
3614
+ # collumn.
3615
+ # @return [String]
3616
+ #
3617
+ # @!attribute [rw] field_mappings
3618
+ # Maps fields from a Salesforce chatter feed into Amazon Kendra index
3619
+ # fields.
3620
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
3621
+ #
3622
+ # @!attribute [rw] include_filter_types
3623
+ # Filters the documents in the feed based on status of the user. When
3624
+ # you specify `ACTIVE_USERS` only documents from users who have an
3625
+ # active account are indexed. When you specify `STANDARD_USER` only
3626
+ # documents for Salesforce standard users are documented. You can
3627
+ # specify both.
3628
+ # @return [Array<String>]
3629
+ #
3630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceChatterFeedConfiguration AWS API Documentation
3631
+ #
3632
+ class SalesforceChatterFeedConfiguration < Struct.new(
3633
+ :document_data_field_name,
3634
+ :document_title_field_name,
3635
+ :field_mappings,
3636
+ :include_filter_types)
3637
+ SENSITIVE = []
3638
+ include Aws::Structure
3639
+ end
3640
+
3641
+ # Provides configuration information for connecting to a Salesforce data
3642
+ # source.
3643
+ #
3644
+ # @note When making an API call, you may pass SalesforceConfiguration
3645
+ # data as a hash:
3646
+ #
3647
+ # {
3648
+ # server_url: "Url", # required
3649
+ # secret_arn: "SecretArn", # required
3650
+ # standard_object_configurations: [
3651
+ # {
3652
+ # name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
3653
+ # document_data_field_name: "DataSourceFieldName", # required
3654
+ # document_title_field_name: "DataSourceFieldName",
3655
+ # field_mappings: [
3656
+ # {
3657
+ # data_source_field_name: "DataSourceFieldName", # required
3658
+ # date_field_format: "DataSourceDateFieldFormat",
3659
+ # index_field_name: "IndexFieldName", # required
3660
+ # },
3661
+ # ],
3662
+ # },
3663
+ # ],
3664
+ # knowledge_article_configuration: {
3665
+ # included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
3666
+ # standard_knowledge_article_type_configuration: {
3667
+ # document_data_field_name: "DataSourceFieldName", # required
3668
+ # document_title_field_name: "DataSourceFieldName",
3669
+ # field_mappings: [
3670
+ # {
3671
+ # data_source_field_name: "DataSourceFieldName", # required
3672
+ # date_field_format: "DataSourceDateFieldFormat",
3673
+ # index_field_name: "IndexFieldName", # required
3674
+ # },
3675
+ # ],
3676
+ # },
3677
+ # custom_knowledge_article_type_configurations: [
3678
+ # {
3679
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
3680
+ # document_data_field_name: "DataSourceFieldName", # required
3681
+ # document_title_field_name: "DataSourceFieldName",
3682
+ # field_mappings: [
3683
+ # {
3684
+ # data_source_field_name: "DataSourceFieldName", # required
3685
+ # date_field_format: "DataSourceDateFieldFormat",
3686
+ # index_field_name: "IndexFieldName", # required
3687
+ # },
3688
+ # ],
3689
+ # },
3690
+ # ],
3691
+ # },
3692
+ # chatter_feed_configuration: {
3693
+ # document_data_field_name: "DataSourceFieldName", # required
3694
+ # document_title_field_name: "DataSourceFieldName",
3695
+ # field_mappings: [
3696
+ # {
3697
+ # data_source_field_name: "DataSourceFieldName", # required
3698
+ # date_field_format: "DataSourceDateFieldFormat",
3699
+ # index_field_name: "IndexFieldName", # required
3700
+ # },
3701
+ # ],
3702
+ # include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
3703
+ # },
3704
+ # crawl_attachments: false,
3705
+ # standard_object_attachment_configuration: {
3706
+ # document_title_field_name: "DataSourceFieldName",
3707
+ # field_mappings: [
3708
+ # {
3709
+ # data_source_field_name: "DataSourceFieldName", # required
3710
+ # date_field_format: "DataSourceDateFieldFormat",
3711
+ # index_field_name: "IndexFieldName", # required
3712
+ # },
3713
+ # ],
3714
+ # },
3715
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3716
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3717
+ # }
3718
+ #
3719
+ # @!attribute [rw] server_url
3720
+ # The instance URL for the Salesforce site that you want to index.
3721
+ # @return [String]
3722
+ #
3723
+ # @!attribute [rw] secret_arn
3724
+ # The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that
3725
+ # contains the key/value pairs required to connect to your Salesforce
3726
+ # instance. The secret must contain a JSON structure with the
3727
+ # following keys:
3728
+ #
3729
+ # * authenticationUrl - The OAUTH endpoint that Amazon Kendra connects
3730
+ # to get an OAUTH token.
3731
+ #
3732
+ # * consumerKey - The application public key generated when you
3733
+ # created your Salesforce application.
3734
+ #
3735
+ # * consumerSecret - The application private key generated when you
3736
+ # created your Salesforce application.
3737
+ #
3738
+ # * password - The password associated with the user logging in to the
3739
+ # Salesforce instance.
3740
+ #
3741
+ # * securityToken - The token associated with the user account logging
3742
+ # in to the Salesforce instance.
3743
+ #
3744
+ # * username - The user name of the user logging in to the Salesforce
3745
+ # instance.
3746
+ # @return [String]
3747
+ #
3748
+ # @!attribute [rw] standard_object_configurations
3749
+ # Specifies the Salesforce standard objects that Amazon Kendra
3750
+ # indexes.
3751
+ # @return [Array<Types::SalesforceStandardObjectConfiguration>]
3752
+ #
3753
+ # @!attribute [rw] knowledge_article_configuration
3754
+ # Specifies configuration information for the knowlege article types
3755
+ # that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
3756
+ # articles and the standard fields of knowledge articles, or the
3757
+ # custom fields of custom knowledge articles, but not both.
3758
+ # @return [Types::SalesforceKnowledgeArticleConfiguration]
3759
+ #
3760
+ # @!attribute [rw] chatter_feed_configuration
3761
+ # Specifies configuration information for Salesforce chatter feeds.
3762
+ # @return [Types::SalesforceChatterFeedConfiguration]
3763
+ #
3764
+ # @!attribute [rw] crawl_attachments
3765
+ # Indicates whether Amazon Kendra should index attachments to
3766
+ # Salesforce objects.
3767
+ # @return [Boolean]
3768
+ #
3769
+ # @!attribute [rw] standard_object_attachment_configuration
3770
+ # Provides configuration information for processing attachments to
3771
+ # Salesforce standard objects.
3772
+ # @return [Types::SalesforceStandardObjectAttachmentConfiguration]
3773
+ #
3774
+ # @!attribute [rw] include_attachment_file_patterns
3775
+ # A list of regular expression patterns. Documents that match the
3776
+ # patterns are included in the index. Documents that don't match the
3777
+ # patterns are excluded from the index. If a document matches both an
3778
+ # inclusion pattern and an exclusion pattern, the document is not
3779
+ # included in the index.
3780
+ #
3781
+ # The regex is applied to the name of the attached file.
3782
+ # @return [Array<String>]
3783
+ #
3784
+ # @!attribute [rw] exclude_attachment_file_patterns
3785
+ # A list of regular expression patterns. Documents that match the
3786
+ # patterns are excluded from the index. Documents that don't match
3787
+ # the patterns are included in the index. If a document matches both
3788
+ # an exclusion pattern and an inclusion pattern, the document is not
3789
+ # included in the index.
3790
+ #
3791
+ # The regex is applied to the name of the attached file.
3792
+ # @return [Array<String>]
3793
+ #
3794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceConfiguration AWS API Documentation
3795
+ #
3796
+ class SalesforceConfiguration < Struct.new(
3797
+ :server_url,
3798
+ :secret_arn,
3799
+ :standard_object_configurations,
3800
+ :knowledge_article_configuration,
3801
+ :chatter_feed_configuration,
3802
+ :crawl_attachments,
3803
+ :standard_object_attachment_configuration,
3804
+ :include_attachment_file_patterns,
3805
+ :exclude_attachment_file_patterns)
3806
+ SENSITIVE = []
3807
+ include Aws::Structure
3808
+ end
3809
+
3810
+ # Provides configuration information for indexing Salesforce custom
3811
+ # articles.
3812
+ #
3813
+ # @note When making an API call, you may pass SalesforceCustomKnowledgeArticleTypeConfiguration
3814
+ # data as a hash:
3815
+ #
3816
+ # {
3817
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
3818
+ # document_data_field_name: "DataSourceFieldName", # required
3819
+ # document_title_field_name: "DataSourceFieldName",
3820
+ # field_mappings: [
3821
+ # {
3822
+ # data_source_field_name: "DataSourceFieldName", # required
3823
+ # date_field_format: "DataSourceDateFieldFormat",
3824
+ # index_field_name: "IndexFieldName", # required
3825
+ # },
3826
+ # ],
3827
+ # }
3828
+ #
3829
+ # @!attribute [rw] name
3830
+ # The name of the configuration.
3831
+ # @return [String]
3832
+ #
3833
+ # @!attribute [rw] document_data_field_name
3834
+ # The name of the field in the custom knowledge article that contains
3835
+ # the document data to index.
3836
+ # @return [String]
3837
+ #
3838
+ # @!attribute [rw] document_title_field_name
3839
+ # The name of the field in the custom knowledge article that contains
3840
+ # the document title.
3841
+ # @return [String]
3842
+ #
3843
+ # @!attribute [rw] field_mappings
3844
+ # One or more objects that map fields in the custom knowledge article
3845
+ # to fields in the Amazon Kendra index.
3846
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
3847
+ #
3848
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration AWS API Documentation
3849
+ #
3850
+ class SalesforceCustomKnowledgeArticleTypeConfiguration < Struct.new(
3851
+ :name,
3852
+ :document_data_field_name,
3853
+ :document_title_field_name,
3854
+ :field_mappings)
3855
+ SENSITIVE = []
3856
+ include Aws::Structure
3857
+ end
3858
+
3859
+ # Specifies configuration information for the knowlege article types
3860
+ # that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
3861
+ # articles and the standard fields of knowledge articles, or the custom
3862
+ # fields of custom knowledge articles, but not both
3863
+ #
3864
+ # @note When making an API call, you may pass SalesforceKnowledgeArticleConfiguration
3865
+ # data as a hash:
3866
+ #
3867
+ # {
3868
+ # included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
3869
+ # standard_knowledge_article_type_configuration: {
3870
+ # document_data_field_name: "DataSourceFieldName", # required
3871
+ # document_title_field_name: "DataSourceFieldName",
3872
+ # field_mappings: [
3873
+ # {
3874
+ # data_source_field_name: "DataSourceFieldName", # required
3875
+ # date_field_format: "DataSourceDateFieldFormat",
3876
+ # index_field_name: "IndexFieldName", # required
3877
+ # },
3878
+ # ],
3879
+ # },
3880
+ # custom_knowledge_article_type_configurations: [
3881
+ # {
3882
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
3883
+ # document_data_field_name: "DataSourceFieldName", # required
3884
+ # document_title_field_name: "DataSourceFieldName",
3885
+ # field_mappings: [
3886
+ # {
3887
+ # data_source_field_name: "DataSourceFieldName", # required
3888
+ # date_field_format: "DataSourceDateFieldFormat",
3889
+ # index_field_name: "IndexFieldName", # required
3890
+ # },
3891
+ # ],
3892
+ # },
3893
+ # ],
3894
+ # }
3895
+ #
3896
+ # @!attribute [rw] included_states
3897
+ # Specifies the document states that should be included when Amazon
3898
+ # Kendra indexes knowledge articles. You must specify at least one
3899
+ # state.
3900
+ # @return [Array<String>]
3901
+ #
3902
+ # @!attribute [rw] standard_knowledge_article_type_configuration
3903
+ # Provides configuration information for standard Salesforce knowledge
3904
+ # articles.
3905
+ # @return [Types::SalesforceStandardKnowledgeArticleTypeConfiguration]
3906
+ #
3907
+ # @!attribute [rw] custom_knowledge_article_type_configurations
3908
+ # Provides configuration information for custom Salesforce knowledge
3909
+ # articles.
3910
+ # @return [Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>]
3911
+ #
3912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration AWS API Documentation
3913
+ #
3914
+ class SalesforceKnowledgeArticleConfiguration < Struct.new(
3915
+ :included_states,
3916
+ :standard_knowledge_article_type_configuration,
3917
+ :custom_knowledge_article_type_configurations)
3918
+ SENSITIVE = []
3919
+ include Aws::Structure
3920
+ end
3921
+
3922
+ # Provides configuration information for standard Salesforce knowledge
3923
+ # articles.
3924
+ #
3925
+ # @note When making an API call, you may pass SalesforceStandardKnowledgeArticleTypeConfiguration
3926
+ # data as a hash:
3927
+ #
3928
+ # {
3929
+ # document_data_field_name: "DataSourceFieldName", # required
3930
+ # document_title_field_name: "DataSourceFieldName",
3931
+ # field_mappings: [
3932
+ # {
3933
+ # data_source_field_name: "DataSourceFieldName", # required
3934
+ # date_field_format: "DataSourceDateFieldFormat",
3935
+ # index_field_name: "IndexFieldName", # required
3936
+ # },
3937
+ # ],
3938
+ # }
3939
+ #
3940
+ # @!attribute [rw] document_data_field_name
3941
+ # The name of the field that contains the document data to index.
3942
+ # @return [String]
3943
+ #
3944
+ # @!attribute [rw] document_title_field_name
3945
+ # The name of the field that contains the document title.
3946
+ # @return [String]
3947
+ #
3948
+ # @!attribute [rw] field_mappings
3949
+ # One or more objects that map fields in the knowledge article to
3950
+ # Amazon Kendra index fields. The index field must exist before you
3951
+ # can map a Salesforce field to it.
3952
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
3953
+ #
3954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration AWS API Documentation
3955
+ #
3956
+ class SalesforceStandardKnowledgeArticleTypeConfiguration < Struct.new(
3957
+ :document_data_field_name,
3958
+ :document_title_field_name,
3959
+ :field_mappings)
3960
+ SENSITIVE = []
3961
+ include Aws::Structure
3962
+ end
3963
+
3964
+ # Provides configuration information for processing attachments to
3965
+ # Salesforce standard objects.
3966
+ #
3967
+ # @note When making an API call, you may pass SalesforceStandardObjectAttachmentConfiguration
3968
+ # data as a hash:
3969
+ #
3970
+ # {
3971
+ # document_title_field_name: "DataSourceFieldName",
3972
+ # field_mappings: [
3973
+ # {
3974
+ # data_source_field_name: "DataSourceFieldName", # required
3975
+ # date_field_format: "DataSourceDateFieldFormat",
3976
+ # index_field_name: "IndexFieldName", # required
3977
+ # },
3978
+ # ],
3979
+ # }
3980
+ #
3981
+ # @!attribute [rw] document_title_field_name
3982
+ # The name of the field used for the document title.
3983
+ # @return [String]
3984
+ #
3985
+ # @!attribute [rw] field_mappings
3986
+ # One or more objects that map fields in attachments to Amazon Kendra
3987
+ # index fields.
3988
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
3989
+ #
3990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectAttachmentConfiguration AWS API Documentation
3991
+ #
3992
+ class SalesforceStandardObjectAttachmentConfiguration < Struct.new(
3993
+ :document_title_field_name,
3994
+ :field_mappings)
3995
+ SENSITIVE = []
2831
3996
  include Aws::Structure
2832
3997
  end
2833
3998
 
2834
- # Information required to find a specific file in an Amazon S3 bucket.
3999
+ # Specifies confguration information for indexing a single standard
4000
+ # object.
2835
4001
  #
2836
- # @note When making an API call, you may pass S3Path
4002
+ # @note When making an API call, you may pass SalesforceStandardObjectConfiguration
2837
4003
  # data as a hash:
2838
4004
  #
2839
4005
  # {
2840
- # bucket: "S3BucketName", # required
2841
- # key: "S3ObjectKey", # required
4006
+ # name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
4007
+ # document_data_field_name: "DataSourceFieldName", # required
4008
+ # document_title_field_name: "DataSourceFieldName",
4009
+ # field_mappings: [
4010
+ # {
4011
+ # data_source_field_name: "DataSourceFieldName", # required
4012
+ # date_field_format: "DataSourceDateFieldFormat",
4013
+ # index_field_name: "IndexFieldName", # required
4014
+ # },
4015
+ # ],
2842
4016
  # }
2843
4017
  #
2844
- # @!attribute [rw] bucket
2845
- # The name of the S3 bucket that contains the file.
4018
+ # @!attribute [rw] name
4019
+ # The name of the standard object.
2846
4020
  # @return [String]
2847
4021
  #
2848
- # @!attribute [rw] key
2849
- # The name of the file.
4022
+ # @!attribute [rw] document_data_field_name
4023
+ # The name of the field in the standard object table that contains the
4024
+ # document contents.
2850
4025
  # @return [String]
2851
4026
  #
2852
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/S3Path AWS API Documentation
4027
+ # @!attribute [rw] document_title_field_name
4028
+ # The name of the field in the standard object table that contains the
4029
+ # document titleB.
4030
+ # @return [String]
2853
4031
  #
2854
- class S3Path < Struct.new(
2855
- :bucket,
2856
- :key)
4032
+ # @!attribute [rw] field_mappings
4033
+ # One or more objects that map fields in the standard object to Amazon
4034
+ # Kendra index fields. The index field must exist before you can map a
4035
+ # Salesforce field to it.
4036
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
4037
+ #
4038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectConfiguration AWS API Documentation
4039
+ #
4040
+ class SalesforceStandardObjectConfiguration < Struct.new(
4041
+ :name,
4042
+ :document_data_field_name,
4043
+ :document_title_field_name,
4044
+ :field_mappings)
4045
+ SENSITIVE = []
2857
4046
  include Aws::Structure
2858
4047
  end
2859
4048
 
@@ -2894,6 +4083,7 @@ module Aws::Kendra
2894
4083
  :facetable,
2895
4084
  :searchable,
2896
4085
  :displayable)
4086
+ SENSITIVE = []
2897
4087
  include Aws::Structure
2898
4088
  end
2899
4089
 
@@ -2917,6 +4107,216 @@ module Aws::Kendra
2917
4107
  #
2918
4108
  class ServerSideEncryptionConfiguration < Struct.new(
2919
4109
  :kms_key_id)
4110
+ SENSITIVE = [:kms_key_id]
4111
+ include Aws::Structure
4112
+ end
4113
+
4114
+ # Provides configuration information required to connect to a ServiceNow
4115
+ # data source.
4116
+ #
4117
+ # @note When making an API call, you may pass ServiceNowConfiguration
4118
+ # data as a hash:
4119
+ #
4120
+ # {
4121
+ # host_url: "ServiceNowHostUrl", # required
4122
+ # secret_arn: "SecretArn", # required
4123
+ # service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
4124
+ # knowledge_article_configuration: {
4125
+ # crawl_attachments: false,
4126
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4127
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4128
+ # document_data_field_name: "DataSourceFieldName", # required
4129
+ # document_title_field_name: "DataSourceFieldName",
4130
+ # field_mappings: [
4131
+ # {
4132
+ # data_source_field_name: "DataSourceFieldName", # required
4133
+ # date_field_format: "DataSourceDateFieldFormat",
4134
+ # index_field_name: "IndexFieldName", # required
4135
+ # },
4136
+ # ],
4137
+ # },
4138
+ # service_catalog_configuration: {
4139
+ # crawl_attachments: false,
4140
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4141
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4142
+ # document_data_field_name: "DataSourceFieldName", # required
4143
+ # document_title_field_name: "DataSourceFieldName",
4144
+ # field_mappings: [
4145
+ # {
4146
+ # data_source_field_name: "DataSourceFieldName", # required
4147
+ # date_field_format: "DataSourceDateFieldFormat",
4148
+ # index_field_name: "IndexFieldName", # required
4149
+ # },
4150
+ # ],
4151
+ # },
4152
+ # }
4153
+ #
4154
+ # @!attribute [rw] host_url
4155
+ # The ServiceNow instance that the data source connects to. The host
4156
+ # endpoint should look like the following:
4157
+ # `\{instance\}.service-now.com.`
4158
+ # @return [String]
4159
+ #
4160
+ # @!attribute [rw] secret_arn
4161
+ # The Amazon Resource Name (ARN) of the AWS Secret Manager secret that
4162
+ # contains the user name and password required to connect to the
4163
+ # ServiceNow instance.
4164
+ # @return [String]
4165
+ #
4166
+ # @!attribute [rw] service_now_build_version
4167
+ # The identifier of the release that the ServiceNow host is running.
4168
+ # If the host is not running the `LONDON` release, use `OTHERS`.
4169
+ # @return [String]
4170
+ #
4171
+ # @!attribute [rw] knowledge_article_configuration
4172
+ # Provides configuration information for crawling knowledge articles
4173
+ # in the ServiceNow site.
4174
+ # @return [Types::ServiceNowKnowledgeArticleConfiguration]
4175
+ #
4176
+ # @!attribute [rw] service_catalog_configuration
4177
+ # Provides configuration information for crawling service catalogs in
4178
+ # the ServiceNow site.
4179
+ # @return [Types::ServiceNowServiceCatalogConfiguration]
4180
+ #
4181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
4182
+ #
4183
+ class ServiceNowConfiguration < Struct.new(
4184
+ :host_url,
4185
+ :secret_arn,
4186
+ :service_now_build_version,
4187
+ :knowledge_article_configuration,
4188
+ :service_catalog_configuration)
4189
+ SENSITIVE = []
4190
+ include Aws::Structure
4191
+ end
4192
+
4193
+ # Provides configuration information for crawling knowledge articles in
4194
+ # the ServiceNow site.
4195
+ #
4196
+ # @note When making an API call, you may pass ServiceNowKnowledgeArticleConfiguration
4197
+ # data as a hash:
4198
+ #
4199
+ # {
4200
+ # crawl_attachments: false,
4201
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4202
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4203
+ # document_data_field_name: "DataSourceFieldName", # required
4204
+ # document_title_field_name: "DataSourceFieldName",
4205
+ # field_mappings: [
4206
+ # {
4207
+ # data_source_field_name: "DataSourceFieldName", # required
4208
+ # date_field_format: "DataSourceDateFieldFormat",
4209
+ # index_field_name: "IndexFieldName", # required
4210
+ # },
4211
+ # ],
4212
+ # }
4213
+ #
4214
+ # @!attribute [rw] crawl_attachments
4215
+ # Indicates whether Amazon Kendra should index attachments to
4216
+ # knowledge articles.
4217
+ # @return [Boolean]
4218
+ #
4219
+ # @!attribute [rw] include_attachment_file_patterns
4220
+ # List of regular expressions applied to knowledge articles. Items
4221
+ # that don't match the inclusion pattern are not indexed. The regex
4222
+ # is applied to the field specified in the `PatternTargetField`.
4223
+ # @return [Array<String>]
4224
+ #
4225
+ # @!attribute [rw] exclude_attachment_file_patterns
4226
+ # List of regular expressions applied to knowledge articles. Items
4227
+ # that don't match the inclusion pattern are not indexed. The regex
4228
+ # is applied to the field specified in the `PatternTargetField`
4229
+ # @return [Array<String>]
4230
+ #
4231
+ # @!attribute [rw] document_data_field_name
4232
+ # The name of the ServiceNow field that is mapped to the index
4233
+ # document contents field in the Amazon Kendra index.
4234
+ # @return [String]
4235
+ #
4236
+ # @!attribute [rw] document_title_field_name
4237
+ # The name of the ServiceNow field that is mapped to the index
4238
+ # document title field.
4239
+ # @return [String]
4240
+ #
4241
+ # @!attribute [rw] field_mappings
4242
+ # Mapping between ServiceNow fields and Amazon Kendra index fields.
4243
+ # You must create the index field before you map the field.
4244
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
4245
+ #
4246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
4247
+ #
4248
+ class ServiceNowKnowledgeArticleConfiguration < Struct.new(
4249
+ :crawl_attachments,
4250
+ :include_attachment_file_patterns,
4251
+ :exclude_attachment_file_patterns,
4252
+ :document_data_field_name,
4253
+ :document_title_field_name,
4254
+ :field_mappings)
4255
+ SENSITIVE = []
4256
+ include Aws::Structure
4257
+ end
4258
+
4259
+ # Provides configuration information for crawling service catalog items
4260
+ # in the ServiceNow site
4261
+ #
4262
+ # @note When making an API call, you may pass ServiceNowServiceCatalogConfiguration
4263
+ # data as a hash:
4264
+ #
4265
+ # {
4266
+ # crawl_attachments: false,
4267
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4268
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4269
+ # document_data_field_name: "DataSourceFieldName", # required
4270
+ # document_title_field_name: "DataSourceFieldName",
4271
+ # field_mappings: [
4272
+ # {
4273
+ # data_source_field_name: "DataSourceFieldName", # required
4274
+ # date_field_format: "DataSourceDateFieldFormat",
4275
+ # index_field_name: "IndexFieldName", # required
4276
+ # },
4277
+ # ],
4278
+ # }
4279
+ #
4280
+ # @!attribute [rw] crawl_attachments
4281
+ # Indicates whether Amazon Kendra should crawl attachments to the
4282
+ # service catalog items.
4283
+ # @return [Boolean]
4284
+ #
4285
+ # @!attribute [rw] include_attachment_file_patterns
4286
+ # Determines the types of file attachments that are included in the
4287
+ # index.
4288
+ # @return [Array<String>]
4289
+ #
4290
+ # @!attribute [rw] exclude_attachment_file_patterns
4291
+ # Determines the types of file attachments that are excluded from the
4292
+ # index.
4293
+ # @return [Array<String>]
4294
+ #
4295
+ # @!attribute [rw] document_data_field_name
4296
+ # The name of the ServiceNow field that is mapped to the index
4297
+ # document contents field in the Amazon Kendra index.
4298
+ # @return [String]
4299
+ #
4300
+ # @!attribute [rw] document_title_field_name
4301
+ # The name of the ServiceNow field that is mapped to the index
4302
+ # document title field.
4303
+ # @return [String]
4304
+ #
4305
+ # @!attribute [rw] field_mappings
4306
+ # Mapping between ServiceNow fields and Amazon Kendra index fields.
4307
+ # You must create the index field before you map the field.
4308
+ # @return [Array<Types::DataSourceToIndexFieldMapping>]
4309
+ #
4310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration AWS API Documentation
4311
+ #
4312
+ class ServiceNowServiceCatalogConfiguration < Struct.new(
4313
+ :crawl_attachments,
4314
+ :include_attachment_file_patterns,
4315
+ :exclude_attachment_file_patterns,
4316
+ :document_data_field_name,
4317
+ :document_title_field_name,
4318
+ :field_mappings)
4319
+ SENSITIVE = []
2920
4320
  include Aws::Structure
2921
4321
  end
2922
4322
 
@@ -2927,6 +4327,7 @@ module Aws::Kendra
2927
4327
  #
2928
4328
  class ServiceQuotaExceededException < Struct.new(
2929
4329
  :message)
4330
+ SENSITIVE = []
2930
4331
  include Aws::Structure
2931
4332
  end
2932
4333
 
@@ -3006,7 +4407,7 @@ module Aws::Kendra
3006
4407
  # @return [Array<String>]
3007
4408
  #
3008
4409
  # @!attribute [rw] exclusion_patterns
3009
- # A list of regular expression patterns. Documents that match the
4410
+ # A list of regulary expression patterns. Documents that match the
3010
4411
  # patterns are excluded from the index. Documents that don't match
3011
4412
  # the patterns are included in the index. If a document matches both
3012
4413
  # an exclusion pattern and an inclusion pattern, the document is not
@@ -3049,6 +4450,7 @@ module Aws::Kendra
3049
4450
  :vpc_configuration,
3050
4451
  :field_mappings,
3051
4452
  :document_title_field_name)
4453
+ SENSITIVE = []
3052
4454
  include Aws::Structure
3053
4455
  end
3054
4456
 
@@ -3073,6 +4475,7 @@ module Aws::Kendra
3073
4475
  class StartDataSourceSyncJobRequest < Struct.new(
3074
4476
  :id,
3075
4477
  :index_id)
4478
+ SENSITIVE = []
3076
4479
  include Aws::Structure
3077
4480
  end
3078
4481
 
@@ -3084,6 +4487,7 @@ module Aws::Kendra
3084
4487
  #
3085
4488
  class StartDataSourceSyncJobResponse < Struct.new(
3086
4489
  :execution_id)
4490
+ SENSITIVE = []
3087
4491
  include Aws::Structure
3088
4492
  end
3089
4493
 
@@ -3109,6 +4513,7 @@ module Aws::Kendra
3109
4513
  class StopDataSourceSyncJobRequest < Struct.new(
3110
4514
  :id,
3111
4515
  :index_id)
4516
+ SENSITIVE = []
3112
4517
  include Aws::Structure
3113
4518
  end
3114
4519
 
@@ -3158,19 +4563,94 @@ module Aws::Kendra
3158
4563
  :query_id,
3159
4564
  :click_feedback_items,
3160
4565
  :relevance_feedback_items)
4566
+ SENSITIVE = []
4567
+ include Aws::Structure
4568
+ end
4569
+
4570
+ # A list of key/value pairs that identify an index, FAQ, or data source.
4571
+ # Tag keys and values can consist of Unicode letters, digits, white
4572
+ # space, and any of the following symbols: \_ . : / = + - @.
4573
+ #
4574
+ # @note When making an API call, you may pass Tag
4575
+ # data as a hash:
4576
+ #
4577
+ # {
4578
+ # key: "TagKey", # required
4579
+ # value: "TagValue", # required
4580
+ # }
4581
+ #
4582
+ # @!attribute [rw] key
4583
+ # The key for the tag. Keys are not case sensitive and must be unique
4584
+ # for the index, FAQ, or data source.
4585
+ # @return [String]
4586
+ #
4587
+ # @!attribute [rw] value
4588
+ # The value associated with the tag. The value may be an empty string
4589
+ # but it can't be null.
4590
+ # @return [String]
4591
+ #
4592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Tag AWS API Documentation
4593
+ #
4594
+ class Tag < Struct.new(
4595
+ :key,
4596
+ :value)
4597
+ SENSITIVE = []
3161
4598
  include Aws::Structure
3162
4599
  end
3163
4600
 
4601
+ # @note When making an API call, you may pass TagResourceRequest
4602
+ # data as a hash:
4603
+ #
4604
+ # {
4605
+ # resource_arn: "AmazonResourceName", # required
4606
+ # tags: [ # required
4607
+ # {
4608
+ # key: "TagKey", # required
4609
+ # value: "TagValue", # required
4610
+ # },
4611
+ # ],
4612
+ # }
4613
+ #
4614
+ # @!attribute [rw] resource_arn
4615
+ # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
4616
+ # tag.
4617
+ # @return [String]
4618
+ #
4619
+ # @!attribute [rw] tags
4620
+ # A list of tag keys to add to the index, FAQ, or data source. If a
4621
+ # tag already exists, the existing value is replaced with the new
4622
+ # value.
4623
+ # @return [Array<Types::Tag>]
4624
+ #
4625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResourceRequest AWS API Documentation
4626
+ #
4627
+ class TagResourceRequest < Struct.new(
4628
+ :resource_arn,
4629
+ :tags)
4630
+ SENSITIVE = []
4631
+ include Aws::Structure
4632
+ end
4633
+
4634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResourceResponse AWS API Documentation
4635
+ #
4636
+ class TagResourceResponse < Aws::EmptyStructure; end
4637
+
3164
4638
  # Provides information about text documents indexed in an index.
3165
4639
  #
3166
4640
  # @!attribute [rw] indexed_text_documents_count
3167
4641
  # The number of text documents indexed.
3168
4642
  # @return [Integer]
3169
4643
  #
4644
+ # @!attribute [rw] indexed_text_bytes
4645
+ # The total size, in bytes, of the indexed documents.
4646
+ # @return [Integer]
4647
+ #
3170
4648
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TextDocumentStatistics AWS API Documentation
3171
4649
  #
3172
4650
  class TextDocumentStatistics < Struct.new(
3173
- :indexed_text_documents_count)
4651
+ :indexed_text_documents_count,
4652
+ :indexed_text_bytes)
4653
+ SENSITIVE = []
3174
4654
  include Aws::Structure
3175
4655
  end
3176
4656
 
@@ -3189,6 +4669,7 @@ module Aws::Kendra
3189
4669
  class TextWithHighlights < Struct.new(
3190
4670
  :text,
3191
4671
  :highlights)
4672
+ SENSITIVE = []
3192
4673
  include Aws::Structure
3193
4674
  end
3194
4675
 
@@ -3199,6 +4680,7 @@ module Aws::Kendra
3199
4680
  #
3200
4681
  class ThrottlingException < Struct.new(
3201
4682
  :message)
4683
+ SENSITIVE = []
3202
4684
  include Aws::Structure
3203
4685
  end
3204
4686
 
@@ -3225,9 +4707,41 @@ module Aws::Kendra
3225
4707
  class TimeRange < Struct.new(
3226
4708
  :start_time,
3227
4709
  :end_time)
4710
+ SENSITIVE = []
4711
+ include Aws::Structure
4712
+ end
4713
+
4714
+ # @note When making an API call, you may pass UntagResourceRequest
4715
+ # data as a hash:
4716
+ #
4717
+ # {
4718
+ # resource_arn: "AmazonResourceName", # required
4719
+ # tag_keys: ["TagKey"], # required
4720
+ # }
4721
+ #
4722
+ # @!attribute [rw] resource_arn
4723
+ # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
4724
+ # remove the tag from.
4725
+ # @return [String]
4726
+ #
4727
+ # @!attribute [rw] tag_keys
4728
+ # A list of tag keys to remove from the index, FAQ, or data source. If
4729
+ # a tag key does not exist on the resource, it is ignored.
4730
+ # @return [Array<String>]
4731
+ #
4732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResourceRequest AWS API Documentation
4733
+ #
4734
+ class UntagResourceRequest < Struct.new(
4735
+ :resource_arn,
4736
+ :tag_keys)
4737
+ SENSITIVE = []
3228
4738
  include Aws::Structure
3229
4739
  end
3230
4740
 
4741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResourceResponse AWS API Documentation
4742
+ #
4743
+ class UntagResourceResponse < Aws::EmptyStructure; end
4744
+
3231
4745
  # @note When making an API call, you may pass UpdateDataSourceRequest
3232
4746
  # data as a hash:
3233
4747
  #
@@ -3298,6 +4812,130 @@ module Aws::Kendra
3298
4812
  # allowed_groups_column_name: "ColumnName", # required
3299
4813
  # },
3300
4814
  # },
4815
+ # salesforce_configuration: {
4816
+ # server_url: "Url", # required
4817
+ # secret_arn: "SecretArn", # required
4818
+ # standard_object_configurations: [
4819
+ # {
4820
+ # name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
4821
+ # document_data_field_name: "DataSourceFieldName", # required
4822
+ # document_title_field_name: "DataSourceFieldName",
4823
+ # field_mappings: [
4824
+ # {
4825
+ # data_source_field_name: "DataSourceFieldName", # required
4826
+ # date_field_format: "DataSourceDateFieldFormat",
4827
+ # index_field_name: "IndexFieldName", # required
4828
+ # },
4829
+ # ],
4830
+ # },
4831
+ # ],
4832
+ # knowledge_article_configuration: {
4833
+ # included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
4834
+ # standard_knowledge_article_type_configuration: {
4835
+ # document_data_field_name: "DataSourceFieldName", # required
4836
+ # document_title_field_name: "DataSourceFieldName",
4837
+ # field_mappings: [
4838
+ # {
4839
+ # data_source_field_name: "DataSourceFieldName", # required
4840
+ # date_field_format: "DataSourceDateFieldFormat",
4841
+ # index_field_name: "IndexFieldName", # required
4842
+ # },
4843
+ # ],
4844
+ # },
4845
+ # custom_knowledge_article_type_configurations: [
4846
+ # {
4847
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
4848
+ # document_data_field_name: "DataSourceFieldName", # required
4849
+ # document_title_field_name: "DataSourceFieldName",
4850
+ # field_mappings: [
4851
+ # {
4852
+ # data_source_field_name: "DataSourceFieldName", # required
4853
+ # date_field_format: "DataSourceDateFieldFormat",
4854
+ # index_field_name: "IndexFieldName", # required
4855
+ # },
4856
+ # ],
4857
+ # },
4858
+ # ],
4859
+ # },
4860
+ # chatter_feed_configuration: {
4861
+ # document_data_field_name: "DataSourceFieldName", # required
4862
+ # document_title_field_name: "DataSourceFieldName",
4863
+ # field_mappings: [
4864
+ # {
4865
+ # data_source_field_name: "DataSourceFieldName", # required
4866
+ # date_field_format: "DataSourceDateFieldFormat",
4867
+ # index_field_name: "IndexFieldName", # required
4868
+ # },
4869
+ # ],
4870
+ # include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
4871
+ # },
4872
+ # crawl_attachments: false,
4873
+ # standard_object_attachment_configuration: {
4874
+ # document_title_field_name: "DataSourceFieldName",
4875
+ # field_mappings: [
4876
+ # {
4877
+ # data_source_field_name: "DataSourceFieldName", # required
4878
+ # date_field_format: "DataSourceDateFieldFormat",
4879
+ # index_field_name: "IndexFieldName", # required
4880
+ # },
4881
+ # ],
4882
+ # },
4883
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4884
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4885
+ # },
4886
+ # one_drive_configuration: {
4887
+ # tenant_domain: "TenantDomain", # required
4888
+ # secret_arn: "SecretArn", # required
4889
+ # one_drive_users: { # required
4890
+ # one_drive_user_list: ["OneDriveUser"],
4891
+ # one_drive_user_s3_path: {
4892
+ # bucket: "S3BucketName", # required
4893
+ # key: "S3ObjectKey", # required
4894
+ # },
4895
+ # },
4896
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4897
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4898
+ # field_mappings: [
4899
+ # {
4900
+ # data_source_field_name: "DataSourceFieldName", # required
4901
+ # date_field_format: "DataSourceDateFieldFormat",
4902
+ # index_field_name: "IndexFieldName", # required
4903
+ # },
4904
+ # ],
4905
+ # },
4906
+ # service_now_configuration: {
4907
+ # host_url: "ServiceNowHostUrl", # required
4908
+ # secret_arn: "SecretArn", # required
4909
+ # service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
4910
+ # knowledge_article_configuration: {
4911
+ # crawl_attachments: false,
4912
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4913
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4914
+ # document_data_field_name: "DataSourceFieldName", # required
4915
+ # document_title_field_name: "DataSourceFieldName",
4916
+ # field_mappings: [
4917
+ # {
4918
+ # data_source_field_name: "DataSourceFieldName", # required
4919
+ # date_field_format: "DataSourceDateFieldFormat",
4920
+ # index_field_name: "IndexFieldName", # required
4921
+ # },
4922
+ # ],
4923
+ # },
4924
+ # service_catalog_configuration: {
4925
+ # crawl_attachments: false,
4926
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4927
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4928
+ # document_data_field_name: "DataSourceFieldName", # required
4929
+ # document_title_field_name: "DataSourceFieldName",
4930
+ # field_mappings: [
4931
+ # {
4932
+ # data_source_field_name: "DataSourceFieldName", # required
4933
+ # date_field_format: "DataSourceDateFieldFormat",
4934
+ # index_field_name: "IndexFieldName", # required
4935
+ # },
4936
+ # ],
4937
+ # },
4938
+ # },
3301
4939
  # },
3302
4940
  # description: "Description",
3303
4941
  # schedule: "ScanSchedule",
@@ -3345,6 +4983,7 @@ module Aws::Kendra
3345
4983
  :description,
3346
4984
  :schedule,
3347
4985
  :role_arn)
4986
+ SENSITIVE = []
3348
4987
  include Aws::Structure
3349
4988
  end
3350
4989
 
@@ -3376,6 +5015,10 @@ module Aws::Kendra
3376
5015
  # },
3377
5016
  # },
3378
5017
  # ],
5018
+ # capacity_units: {
5019
+ # storage_capacity_units: 1, # required
5020
+ # query_capacity_units: 1, # required
5021
+ # },
3379
5022
  # }
3380
5023
  #
3381
5024
  # @!attribute [rw] id
@@ -3399,6 +5042,16 @@ module Aws::Kendra
3399
5042
  # The document metadata to update.
3400
5043
  # @return [Array<Types::DocumentMetadataConfiguration>]
3401
5044
  #
5045
+ # @!attribute [rw] capacity_units
5046
+ # Sets the number of addtional storage and query capacity units that
5047
+ # should be used by the index. You can change the capacity of the
5048
+ # index up to 5 times per day.
5049
+ #
5050
+ # If you are using extra storage units, you can't reduce the storage
5051
+ # capacity below that required to meet the storage needs for your
5052
+ # index.
5053
+ # @return [Types::CapacityUnitsConfiguration]
5054
+ #
3402
5055
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndexRequest AWS API Documentation
3403
5056
  #
3404
5057
  class UpdateIndexRequest < Struct.new(
@@ -3406,7 +5059,9 @@ module Aws::Kendra
3406
5059
  :name,
3407
5060
  :role_arn,
3408
5061
  :description,
3409
- :document_metadata_configuration_updates)
5062
+ :document_metadata_configuration_updates,
5063
+ :capacity_units)
5064
+ SENSITIVE = []
3410
5065
  include Aws::Structure
3411
5066
  end
3412
5067
 
@@ -3417,6 +5072,7 @@ module Aws::Kendra
3417
5072
  #
3418
5073
  class ValidationException < Struct.new(
3419
5074
  :message)
5075
+ SENSITIVE = []
3420
5076
  include Aws::Structure
3421
5077
  end
3422
5078