aws-sdk-kendra 1.14.0 → 1.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +329 -15
- data/lib/aws-sdk-kendra/client_api.rb +155 -2
- data/lib/aws-sdk-kendra/types.rb +1158 -26
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 27025edb758f765772fdad0d00fbac9bc77db5476e1142aaed59814631b0b84e
|
4
|
+
data.tar.gz: 49fd84b84696847381dc9f54d521c2feb98ae5fdd112e5e3c64c3a02e465908e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1b81863b3388684a2f0b21590fae0c70cdd1c9b13c5487102174a365287e85a3e9b4cef76dceb9f0c55283167a01be137ee3279d8da007a663e8c1c88cf9a01c
|
7
|
+
data.tar.gz: 9aa3b59165778e48e1e6d4640019a612248dd68f305bc16c053dc0b2050f87980566a91078f1e0393d606c7297e7742d51ef892eae121143aff78460dadb5379
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -506,9 +506,15 @@ module Aws::Kendra
|
|
506
506
|
# @option params [required, String] :type
|
507
507
|
# The type of repository that contains the data source.
|
508
508
|
#
|
509
|
-
# @option params [
|
510
|
-
# The
|
511
|
-
#
|
509
|
+
# @option params [Types::DataSourceConfiguration] :configuration
|
510
|
+
# The connector configuration information that is required to access the
|
511
|
+
# repository.
|
512
|
+
#
|
513
|
+
# You can't specify the `Configuration` parameter when the `Type`
|
514
|
+
# parameter is set to `CUSTOM`. If you do, you receive a
|
515
|
+
# `ValidationException` exception.
|
516
|
+
#
|
517
|
+
# The `Configuration` parameter is required for all other data sources.
|
512
518
|
#
|
513
519
|
# @option params [String] :description
|
514
520
|
# A description for the data source.
|
@@ -519,11 +525,21 @@ module Aws::Kendra
|
|
519
525
|
# Kendra will not periodically update the index. You can call the
|
520
526
|
# `StartDataSourceSyncJob` operation to update the index.
|
521
527
|
#
|
522
|
-
#
|
528
|
+
# You can't specify the `Schedule` parameter when the `Type` parameter
|
529
|
+
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
530
|
+
# exception.
|
531
|
+
#
|
532
|
+
# @option params [String] :role_arn
|
523
533
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
524
534
|
# data source. For more information, see [IAM Roles for Amazon
|
525
535
|
# Kendra][1].
|
526
536
|
#
|
537
|
+
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
538
|
+
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
539
|
+
# exception.
|
540
|
+
#
|
541
|
+
# The `RoleArn` parameter is required for all other data sources.
|
542
|
+
#
|
527
543
|
#
|
528
544
|
#
|
529
545
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
@@ -533,6 +549,14 @@ module Aws::Kendra
|
|
533
549
|
# the tags to identify and organize your resources and to control access
|
534
550
|
# to resources.
|
535
551
|
#
|
552
|
+
# @option params [String] :client_token
|
553
|
+
# A token that you provide to identify the request to create a data
|
554
|
+
# source. Multiple calls to the `CreateDataSource` operation with the
|
555
|
+
# same client token will create only one data source.
|
556
|
+
#
|
557
|
+
# **A suitable default value is auto-generated.** You should normally
|
558
|
+
# not need to pass this option.**
|
559
|
+
#
|
536
560
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
537
561
|
#
|
538
562
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -542,11 +566,12 @@ module Aws::Kendra
|
|
542
566
|
# resp = client.create_data_source({
|
543
567
|
# name: "DataSourceName", # required
|
544
568
|
# index_id: "IndexId", # required
|
545
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
546
|
-
# configuration: {
|
569
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
|
570
|
+
# configuration: {
|
547
571
|
# s3_configuration: {
|
548
572
|
# bucket_name: "S3BucketName", # required
|
549
573
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
574
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
550
575
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
551
576
|
# documents_metadata_configuration: {
|
552
577
|
# s3_prefix: "S3ObjectKey",
|
@@ -575,6 +600,7 @@ module Aws::Kendra
|
|
575
600
|
# },
|
576
601
|
# ],
|
577
602
|
# document_title_field_name: "DataSourceFieldName",
|
603
|
+
# disable_local_groups: false,
|
578
604
|
# },
|
579
605
|
# database_configuration: {
|
580
606
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -699,6 +725,7 @@ module Aws::Kendra
|
|
699
725
|
# index_field_name: "IndexFieldName", # required
|
700
726
|
# },
|
701
727
|
# ],
|
728
|
+
# disable_local_groups: false,
|
702
729
|
# },
|
703
730
|
# service_now_configuration: {
|
704
731
|
# host_url: "ServiceNowHostUrl", # required
|
@@ -733,16 +760,84 @@ module Aws::Kendra
|
|
733
760
|
# ],
|
734
761
|
# },
|
735
762
|
# },
|
763
|
+
# confluence_configuration: {
|
764
|
+
# server_url: "Url", # required
|
765
|
+
# secret_arn: "SecretArn", # required
|
766
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
767
|
+
# space_configuration: {
|
768
|
+
# crawl_personal_spaces: false,
|
769
|
+
# crawl_archived_spaces: false,
|
770
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
771
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
772
|
+
# space_field_mappings: [
|
773
|
+
# {
|
774
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
775
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
776
|
+
# index_field_name: "IndexFieldName",
|
777
|
+
# },
|
778
|
+
# ],
|
779
|
+
# },
|
780
|
+
# page_configuration: {
|
781
|
+
# page_field_mappings: [
|
782
|
+
# {
|
783
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
784
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
785
|
+
# index_field_name: "IndexFieldName",
|
786
|
+
# },
|
787
|
+
# ],
|
788
|
+
# },
|
789
|
+
# blog_configuration: {
|
790
|
+
# blog_field_mappings: [
|
791
|
+
# {
|
792
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
793
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
794
|
+
# index_field_name: "IndexFieldName",
|
795
|
+
# },
|
796
|
+
# ],
|
797
|
+
# },
|
798
|
+
# attachment_configuration: {
|
799
|
+
# crawl_attachments: false,
|
800
|
+
# attachment_field_mappings: [
|
801
|
+
# {
|
802
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
803
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
804
|
+
# index_field_name: "IndexFieldName",
|
805
|
+
# },
|
806
|
+
# ],
|
807
|
+
# },
|
808
|
+
# vpc_configuration: {
|
809
|
+
# subnet_ids: ["SubnetId"], # required
|
810
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
811
|
+
# },
|
812
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
813
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
814
|
+
# },
|
815
|
+
# google_drive_configuration: {
|
816
|
+
# secret_arn: "SecretArn", # required
|
817
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
818
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
819
|
+
# field_mappings: [
|
820
|
+
# {
|
821
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
822
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
823
|
+
# index_field_name: "IndexFieldName", # required
|
824
|
+
# },
|
825
|
+
# ],
|
826
|
+
# exclude_mime_types: ["MimeType"],
|
827
|
+
# exclude_user_accounts: ["UserAccount"],
|
828
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
829
|
+
# },
|
736
830
|
# },
|
737
831
|
# description: "Description",
|
738
832
|
# schedule: "ScanSchedule",
|
739
|
-
# role_arn: "RoleArn",
|
833
|
+
# role_arn: "RoleArn",
|
740
834
|
# tags: [
|
741
835
|
# {
|
742
836
|
# key: "TagKey", # required
|
743
837
|
# value: "TagValue", # required
|
744
838
|
# },
|
745
839
|
# ],
|
840
|
+
# client_token: "ClientTokenName",
|
746
841
|
# })
|
747
842
|
#
|
748
843
|
# @example Response structure
|
@@ -801,6 +896,14 @@ module Aws::Kendra
|
|
801
896
|
#
|
802
897
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
|
803
898
|
#
|
899
|
+
# @option params [String] :client_token
|
900
|
+
# A token that you provide to identify the request to create a FAQ.
|
901
|
+
# Multiple calls to the `CreateFaqRequest` operation with the same
|
902
|
+
# client token will create only one FAQ.
|
903
|
+
#
|
904
|
+
# **A suitable default value is auto-generated.** You should normally
|
905
|
+
# not need to pass this option.**
|
906
|
+
#
|
804
907
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
805
908
|
#
|
806
909
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -823,6 +926,7 @@ module Aws::Kendra
|
|
823
926
|
# },
|
824
927
|
# ],
|
825
928
|
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
929
|
+
# client_token: "ClientTokenName",
|
826
930
|
# })
|
827
931
|
#
|
828
932
|
# @example Response structure
|
@@ -860,10 +964,10 @@ module Aws::Kendra
|
|
860
964
|
# default is `ENTERPRISE_EDITION`.
|
861
965
|
#
|
862
966
|
# @option params [required, String] :role_arn
|
863
|
-
# An
|
864
|
-
#
|
865
|
-
#
|
866
|
-
# bucket.
|
967
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
968
|
+
# Kendra permissions to access your Amazon CloudWatch logs and metrics.
|
969
|
+
# This is also the role used when you use the `BatchPutDocument`
|
970
|
+
# operation to index documents from an Amazon S3 bucket.
|
867
971
|
#
|
868
972
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
869
973
|
# The identifier of the AWS KMS customer managed key (CMK) to use to
|
@@ -876,7 +980,7 @@ module Aws::Kendra
|
|
876
980
|
# @option params [String] :client_token
|
877
981
|
# A token that you provide to identify the request to create an index.
|
878
982
|
# Multiple calls to the `CreateIndex` operation with the same client
|
879
|
-
# token will create only one index
|
983
|
+
# token will create only one index.
|
880
984
|
#
|
881
985
|
# **A suitable default value is auto-generated.** You should normally
|
882
986
|
# not need to pass this option.**
|
@@ -886,6 +990,24 @@ module Aws::Kendra
|
|
886
990
|
# tags to identify and organize your resources and to control access to
|
887
991
|
# resources.
|
888
992
|
#
|
993
|
+
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
994
|
+
# The user token configuration.
|
995
|
+
#
|
996
|
+
# @option params [String] :user_context_policy
|
997
|
+
# The user context policy.
|
998
|
+
#
|
999
|
+
# ATTRIBUTE\_FILTER
|
1000
|
+
#
|
1001
|
+
# : All indexed content is searchable and displayable for all users. If
|
1002
|
+
# there is an access control list, it is ignored. You can filter on
|
1003
|
+
# user and group attributes.
|
1004
|
+
#
|
1005
|
+
# USER\_TOKEN
|
1006
|
+
#
|
1007
|
+
# : Enables SSO and token-based user access control. All documents with
|
1008
|
+
# no access control and all documents accessible to the user will be
|
1009
|
+
# searchable and displayable.
|
1010
|
+
#
|
889
1011
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
890
1012
|
#
|
891
1013
|
# * {Types::CreateIndexResponse#id #id} => String
|
@@ -907,6 +1029,24 @@ module Aws::Kendra
|
|
907
1029
|
# value: "TagValue", # required
|
908
1030
|
# },
|
909
1031
|
# ],
|
1032
|
+
# user_token_configurations: [
|
1033
|
+
# {
|
1034
|
+
# jwt_token_type_configuration: {
|
1035
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
1036
|
+
# url: "Url",
|
1037
|
+
# secret_manager_arn: "RoleArn",
|
1038
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
1039
|
+
# group_attribute_field: "GroupAttributeField",
|
1040
|
+
# issuer: "Issuer",
|
1041
|
+
# claim_regex: "ClaimRegex",
|
1042
|
+
# },
|
1043
|
+
# json_token_type_configuration: {
|
1044
|
+
# user_name_attribute_field: "String", # required
|
1045
|
+
# group_attribute_field: "String", # required
|
1046
|
+
# },
|
1047
|
+
# },
|
1048
|
+
# ],
|
1049
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
910
1050
|
# })
|
911
1051
|
#
|
912
1052
|
# @example Response structure
|
@@ -1042,10 +1182,12 @@ module Aws::Kendra
|
|
1042
1182
|
# resp.id #=> String
|
1043
1183
|
# resp.index_id #=> String
|
1044
1184
|
# resp.name #=> String
|
1045
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1185
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
1046
1186
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
1047
1187
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
1048
1188
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
1189
|
+
# resp.configuration.s3_configuration.inclusion_patterns #=> Array
|
1190
|
+
# resp.configuration.s3_configuration.inclusion_patterns[0] #=> String
|
1049
1191
|
# resp.configuration.s3_configuration.exclusion_patterns #=> Array
|
1050
1192
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
1051
1193
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
@@ -1069,6 +1211,7 @@ module Aws::Kendra
|
|
1069
1211
|
# resp.configuration.share_point_configuration.field_mappings[0].date_field_format #=> String
|
1070
1212
|
# resp.configuration.share_point_configuration.field_mappings[0].index_field_name #=> String
|
1071
1213
|
# resp.configuration.share_point_configuration.document_title_field_name #=> String
|
1214
|
+
# resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
|
1072
1215
|
# resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
|
1073
1216
|
# resp.configuration.database_configuration.connection_configuration.database_host #=> String
|
1074
1217
|
# resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
|
@@ -1148,6 +1291,7 @@ module Aws::Kendra
|
|
1148
1291
|
# resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
1149
1292
|
# resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
|
1150
1293
|
# resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
|
1294
|
+
# resp.configuration.one_drive_configuration.disable_local_groups #=> Boolean
|
1151
1295
|
# resp.configuration.service_now_configuration.host_url #=> String
|
1152
1296
|
# resp.configuration.service_now_configuration.secret_arn #=> String
|
1153
1297
|
# resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
|
@@ -1173,6 +1317,55 @@ module Aws::Kendra
|
|
1173
1317
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1174
1318
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1175
1319
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
1320
|
+
# resp.configuration.confluence_configuration.server_url #=> String
|
1321
|
+
# resp.configuration.confluence_configuration.secret_arn #=> String
|
1322
|
+
# resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
|
1323
|
+
# resp.configuration.confluence_configuration.space_configuration.crawl_personal_spaces #=> Boolean
|
1324
|
+
# resp.configuration.confluence_configuration.space_configuration.crawl_archived_spaces #=> Boolean
|
1325
|
+
# resp.configuration.confluence_configuration.space_configuration.include_spaces #=> Array
|
1326
|
+
# resp.configuration.confluence_configuration.space_configuration.include_spaces[0] #=> String
|
1327
|
+
# resp.configuration.confluence_configuration.space_configuration.exclude_spaces #=> Array
|
1328
|
+
# resp.configuration.confluence_configuration.space_configuration.exclude_spaces[0] #=> String
|
1329
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings #=> Array
|
1330
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].data_source_field_name #=> String, one of "DISPLAY_URL", "ITEM_TYPE", "SPACE_KEY", "URL"
|
1331
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].date_field_format #=> String
|
1332
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].index_field_name #=> String
|
1333
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings #=> Array
|
1334
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].data_source_field_name #=> String, one of "AUTHOR", "CONTENT_STATUS", "CREATED_DATE", "DISPLAY_URL", "ITEM_TYPE", "LABELS", "MODIFIED_DATE", "PARENT_ID", "SPACE_KEY", "SPACE_NAME", "URL", "VERSION"
|
1335
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].date_field_format #=> String
|
1336
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].index_field_name #=> String
|
1337
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings #=> Array
|
1338
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].data_source_field_name #=> String, one of "AUTHOR", "DISPLAY_URL", "ITEM_TYPE", "LABELS", "PUBLISH_DATE", "SPACE_KEY", "SPACE_NAME", "URL", "VERSION"
|
1339
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].date_field_format #=> String
|
1340
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].index_field_name #=> String
|
1341
|
+
# resp.configuration.confluence_configuration.attachment_configuration.crawl_attachments #=> Boolean
|
1342
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings #=> Array
|
1343
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].data_source_field_name #=> String, one of "AUTHOR", "CONTENT_TYPE", "CREATED_DATE", "DISPLAY_URL", "FILE_SIZE", "ITEM_TYPE", "PARENT_ID", "SPACE_KEY", "SPACE_NAME", "URL", "VERSION"
|
1344
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].date_field_format #=> String
|
1345
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].index_field_name #=> String
|
1346
|
+
# resp.configuration.confluence_configuration.vpc_configuration.subnet_ids #=> Array
|
1347
|
+
# resp.configuration.confluence_configuration.vpc_configuration.subnet_ids[0] #=> String
|
1348
|
+
# resp.configuration.confluence_configuration.vpc_configuration.security_group_ids #=> Array
|
1349
|
+
# resp.configuration.confluence_configuration.vpc_configuration.security_group_ids[0] #=> String
|
1350
|
+
# resp.configuration.confluence_configuration.inclusion_patterns #=> Array
|
1351
|
+
# resp.configuration.confluence_configuration.inclusion_patterns[0] #=> String
|
1352
|
+
# resp.configuration.confluence_configuration.exclusion_patterns #=> Array
|
1353
|
+
# resp.configuration.confluence_configuration.exclusion_patterns[0] #=> String
|
1354
|
+
# resp.configuration.google_drive_configuration.secret_arn #=> String
|
1355
|
+
# resp.configuration.google_drive_configuration.inclusion_patterns #=> Array
|
1356
|
+
# resp.configuration.google_drive_configuration.inclusion_patterns[0] #=> String
|
1357
|
+
# resp.configuration.google_drive_configuration.exclusion_patterns #=> Array
|
1358
|
+
# resp.configuration.google_drive_configuration.exclusion_patterns[0] #=> String
|
1359
|
+
# resp.configuration.google_drive_configuration.field_mappings #=> Array
|
1360
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
1361
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].date_field_format #=> String
|
1362
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].index_field_name #=> String
|
1363
|
+
# resp.configuration.google_drive_configuration.exclude_mime_types #=> Array
|
1364
|
+
# resp.configuration.google_drive_configuration.exclude_mime_types[0] #=> String
|
1365
|
+
# resp.configuration.google_drive_configuration.exclude_user_accounts #=> Array
|
1366
|
+
# resp.configuration.google_drive_configuration.exclude_user_accounts[0] #=> String
|
1367
|
+
# resp.configuration.google_drive_configuration.exclude_shared_drives #=> Array
|
1368
|
+
# resp.configuration.google_drive_configuration.exclude_shared_drives[0] #=> String
|
1176
1369
|
# resp.created_at #=> Time
|
1177
1370
|
# resp.updated_at #=> Time
|
1178
1371
|
# resp.description #=> String
|
@@ -1263,6 +1456,8 @@ module Aws::Kendra
|
|
1263
1456
|
# * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
1264
1457
|
# * {Types::DescribeIndexResponse#error_message #error_message} => String
|
1265
1458
|
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
1459
|
+
# * {Types::DescribeIndexResponse#user_token_configurations #user_token_configurations} => Array<Types::UserTokenConfiguration>
|
1460
|
+
# * {Types::DescribeIndexResponse#user_context_policy #user_context_policy} => String
|
1266
1461
|
#
|
1267
1462
|
# @example Request syntax with placeholder values
|
1268
1463
|
#
|
@@ -1300,6 +1495,17 @@ module Aws::Kendra
|
|
1300
1495
|
# resp.error_message #=> String
|
1301
1496
|
# resp.capacity_units.storage_capacity_units #=> Integer
|
1302
1497
|
# resp.capacity_units.query_capacity_units #=> Integer
|
1498
|
+
# resp.user_token_configurations #=> Array
|
1499
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.key_location #=> String, one of "URL", "SECRET_MANAGER"
|
1500
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.url #=> String
|
1501
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.secret_manager_arn #=> String
|
1502
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.user_name_attribute_field #=> String
|
1503
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.group_attribute_field #=> String
|
1504
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.issuer #=> String
|
1505
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.claim_regex #=> String
|
1506
|
+
# resp.user_token_configurations[0].json_token_type_configuration.user_name_attribute_field #=> String
|
1507
|
+
# resp.user_token_configurations[0].json_token_type_configuration.group_attribute_field #=> String
|
1508
|
+
# resp.user_context_policy #=> String, one of "ATTRIBUTE_FILTER", "USER_TOKEN"
|
1303
1509
|
#
|
1304
1510
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
1305
1511
|
#
|
@@ -1416,7 +1622,7 @@ module Aws::Kendra
|
|
1416
1622
|
# resp.summary_items #=> Array
|
1417
1623
|
# resp.summary_items[0].name #=> String
|
1418
1624
|
# resp.summary_items[0].id #=> String
|
1419
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1625
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
1420
1626
|
# resp.summary_items[0].created_at #=> Time
|
1421
1627
|
# resp.summary_items[0].updated_at #=> Time
|
1422
1628
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1628,6 +1834,15 @@ module Aws::Kendra
|
|
1628
1834
|
# If you don't provide sorting configuration, the results are sorted by
|
1629
1835
|
# the relevance that Amazon Kendra determines for the result.
|
1630
1836
|
#
|
1837
|
+
# @option params [Types::UserContext] :user_context
|
1838
|
+
# The user context token.
|
1839
|
+
#
|
1840
|
+
# @option params [String] :visitor_id
|
1841
|
+
# Provides an identifier for a specific user. The `VisitorId` should be
|
1842
|
+
# a unique identifier, such as a GUID. Don't use personally
|
1843
|
+
# identifiable information, such as the user's email address, as the
|
1844
|
+
# `VisitorId`.
|
1845
|
+
#
|
1631
1846
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1632
1847
|
#
|
1633
1848
|
# * {Types::QueryResult#query_id #query_id} => String
|
@@ -1731,6 +1946,10 @@ module Aws::Kendra
|
|
1731
1946
|
# document_attribute_key: "DocumentAttributeKey", # required
|
1732
1947
|
# sort_order: "DESC", # required, accepts DESC, ASC
|
1733
1948
|
# },
|
1949
|
+
# user_context: {
|
1950
|
+
# token: "Token",
|
1951
|
+
# },
|
1952
|
+
# visitor_id: "VisitorId",
|
1734
1953
|
# })
|
1735
1954
|
#
|
1736
1955
|
# @example Response structure
|
@@ -1767,6 +1986,7 @@ module Aws::Kendra
|
|
1767
1986
|
# resp.result_items[0].document_attributes[0].value.long_value #=> Integer
|
1768
1987
|
# resp.result_items[0].document_attributes[0].value.date_value #=> Time
|
1769
1988
|
# resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
|
1989
|
+
# resp.result_items[0].feedback_token #=> String
|
1770
1990
|
# resp.facet_results #=> Array
|
1771
1991
|
# resp.facet_results[0].document_attribute_key #=> String
|
1772
1992
|
# resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
|
@@ -1999,6 +2219,7 @@ module Aws::Kendra
|
|
1999
2219
|
# s3_configuration: {
|
2000
2220
|
# bucket_name: "S3BucketName", # required
|
2001
2221
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
2222
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2002
2223
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2003
2224
|
# documents_metadata_configuration: {
|
2004
2225
|
# s3_prefix: "S3ObjectKey",
|
@@ -2027,6 +2248,7 @@ module Aws::Kendra
|
|
2027
2248
|
# },
|
2028
2249
|
# ],
|
2029
2250
|
# document_title_field_name: "DataSourceFieldName",
|
2251
|
+
# disable_local_groups: false,
|
2030
2252
|
# },
|
2031
2253
|
# database_configuration: {
|
2032
2254
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -2151,6 +2373,7 @@ module Aws::Kendra
|
|
2151
2373
|
# index_field_name: "IndexFieldName", # required
|
2152
2374
|
# },
|
2153
2375
|
# ],
|
2376
|
+
# disable_local_groups: false,
|
2154
2377
|
# },
|
2155
2378
|
# service_now_configuration: {
|
2156
2379
|
# host_url: "ServiceNowHostUrl", # required
|
@@ -2185,6 +2408,73 @@ module Aws::Kendra
|
|
2185
2408
|
# ],
|
2186
2409
|
# },
|
2187
2410
|
# },
|
2411
|
+
# confluence_configuration: {
|
2412
|
+
# server_url: "Url", # required
|
2413
|
+
# secret_arn: "SecretArn", # required
|
2414
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
2415
|
+
# space_configuration: {
|
2416
|
+
# crawl_personal_spaces: false,
|
2417
|
+
# crawl_archived_spaces: false,
|
2418
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
2419
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
2420
|
+
# space_field_mappings: [
|
2421
|
+
# {
|
2422
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
2423
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2424
|
+
# index_field_name: "IndexFieldName",
|
2425
|
+
# },
|
2426
|
+
# ],
|
2427
|
+
# },
|
2428
|
+
# page_configuration: {
|
2429
|
+
# page_field_mappings: [
|
2430
|
+
# {
|
2431
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2432
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2433
|
+
# index_field_name: "IndexFieldName",
|
2434
|
+
# },
|
2435
|
+
# ],
|
2436
|
+
# },
|
2437
|
+
# blog_configuration: {
|
2438
|
+
# blog_field_mappings: [
|
2439
|
+
# {
|
2440
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2441
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2442
|
+
# index_field_name: "IndexFieldName",
|
2443
|
+
# },
|
2444
|
+
# ],
|
2445
|
+
# },
|
2446
|
+
# attachment_configuration: {
|
2447
|
+
# crawl_attachments: false,
|
2448
|
+
# attachment_field_mappings: [
|
2449
|
+
# {
|
2450
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2451
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2452
|
+
# index_field_name: "IndexFieldName",
|
2453
|
+
# },
|
2454
|
+
# ],
|
2455
|
+
# },
|
2456
|
+
# vpc_configuration: {
|
2457
|
+
# subnet_ids: ["SubnetId"], # required
|
2458
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2459
|
+
# },
|
2460
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2461
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2462
|
+
# },
|
2463
|
+
# google_drive_configuration: {
|
2464
|
+
# secret_arn: "SecretArn", # required
|
2465
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2466
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2467
|
+
# field_mappings: [
|
2468
|
+
# {
|
2469
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2470
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2471
|
+
# index_field_name: "IndexFieldName", # required
|
2472
|
+
# },
|
2473
|
+
# ],
|
2474
|
+
# exclude_mime_types: ["MimeType"],
|
2475
|
+
# exclude_user_accounts: ["UserAccount"],
|
2476
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
2477
|
+
# },
|
2188
2478
|
# },
|
2189
2479
|
# description: "Description",
|
2190
2480
|
# schedule: "ScanSchedule",
|
@@ -2226,6 +2516,12 @@ module Aws::Kendra
|
|
2226
2516
|
# If you are using extra storage units, you can't reduce the storage
|
2227
2517
|
# capacity below that required to meet the storage needs for your index.
|
2228
2518
|
#
|
2519
|
+
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
2520
|
+
# The user token configuration.
|
2521
|
+
#
|
2522
|
+
# @option params [String] :user_context_policy
|
2523
|
+
# The user user token context policy.
|
2524
|
+
#
|
2229
2525
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2230
2526
|
#
|
2231
2527
|
# @example Request syntax with placeholder values
|
@@ -2260,6 +2556,24 @@ module Aws::Kendra
|
|
2260
2556
|
# storage_capacity_units: 1, # required
|
2261
2557
|
# query_capacity_units: 1, # required
|
2262
2558
|
# },
|
2559
|
+
# user_token_configurations: [
|
2560
|
+
# {
|
2561
|
+
# jwt_token_type_configuration: {
|
2562
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
2563
|
+
# url: "Url",
|
2564
|
+
# secret_manager_arn: "RoleArn",
|
2565
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
2566
|
+
# group_attribute_field: "GroupAttributeField",
|
2567
|
+
# issuer: "Issuer",
|
2568
|
+
# claim_regex: "ClaimRegex",
|
2569
|
+
# },
|
2570
|
+
# json_token_type_configuration: {
|
2571
|
+
# user_name_attribute_field: "String", # required
|
2572
|
+
# group_attribute_field: "String", # required
|
2573
|
+
# },
|
2574
|
+
# },
|
2575
|
+
# ],
|
2576
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
2263
2577
|
# })
|
2264
2578
|
#
|
2265
2579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
@@ -2284,7 +2598,7 @@ module Aws::Kendra
|
|
2284
2598
|
params: params,
|
2285
2599
|
config: config)
|
2286
2600
|
context[:gem_name] = 'aws-sdk-kendra'
|
2287
|
-
context[:gem_version] = '1.
|
2601
|
+
context[:gem_version] = '1.19.0'
|
2288
2602
|
Seahorse::Client::Request.new(handlers, context)
|
2289
2603
|
end
|
2290
2604
|
|