aws-sdk-kendra 1.13.0 → 1.18.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 +276 -15
- data/lib/aws-sdk-kendra/client_api.rb +128 -2
- data/lib/aws-sdk-kendra/types.rb +975 -21
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a8ebb2b5b56b9898e08dda8db191a2bc4351bad70c534529db7940dab11ae498
|
4
|
+
data.tar.gz: 0d80ae94eaff1e769e39e7b68277008204131b228338d8155a33269025928c7a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 695c605f0c0f1628b3885a70683fb2b15af4259263c14ab3689e7b1fed6d3cb3e1334a63cf2e703a7313bf5f7a044533965a7b0b0c5fbd6ef501808923d5e0cd
|
7
|
+
data.tar.gz: 8fc5de58b97da0b2c8331b01460de2e786ae98e97ec92632203d0cb1eae16ff9f7bbb0ae5ac23f5ad40d288c676da58d070add5412620f2346932fe03d776056
|
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
|
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,69 @@ 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
|
+
# },
|
736
815
|
# },
|
737
816
|
# description: "Description",
|
738
817
|
# schedule: "ScanSchedule",
|
739
|
-
# role_arn: "RoleArn",
|
818
|
+
# role_arn: "RoleArn",
|
740
819
|
# tags: [
|
741
820
|
# {
|
742
821
|
# key: "TagKey", # required
|
743
822
|
# value: "TagValue", # required
|
744
823
|
# },
|
745
824
|
# ],
|
825
|
+
# client_token: "ClientTokenName",
|
746
826
|
# })
|
747
827
|
#
|
748
828
|
# @example Response structure
|
@@ -801,6 +881,14 @@ module Aws::Kendra
|
|
801
881
|
#
|
802
882
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
|
803
883
|
#
|
884
|
+
# @option params [String] :client_token
|
885
|
+
# A token that you provide to identify the request to create a FAQ.
|
886
|
+
# Multiple calls to the `CreateFaqRequest` operation with the same
|
887
|
+
# client token will create only one FAQ.
|
888
|
+
#
|
889
|
+
# **A suitable default value is auto-generated.** You should normally
|
890
|
+
# not need to pass this option.**
|
891
|
+
#
|
804
892
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
805
893
|
#
|
806
894
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -823,6 +911,7 @@ module Aws::Kendra
|
|
823
911
|
# },
|
824
912
|
# ],
|
825
913
|
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
914
|
+
# client_token: "ClientTokenName",
|
826
915
|
# })
|
827
916
|
#
|
828
917
|
# @example Response structure
|
@@ -860,10 +949,10 @@ module Aws::Kendra
|
|
860
949
|
# default is `ENTERPRISE_EDITION`.
|
861
950
|
#
|
862
951
|
# @option params [required, String] :role_arn
|
863
|
-
# An
|
864
|
-
#
|
865
|
-
#
|
866
|
-
# bucket.
|
952
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
953
|
+
# Kendra permissions to access your Amazon CloudWatch logs and metrics.
|
954
|
+
# This is also the role used when you use the `BatchPutDocument`
|
955
|
+
# operation to index documents from an Amazon S3 bucket.
|
867
956
|
#
|
868
957
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
869
958
|
# The identifier of the AWS KMS customer managed key (CMK) to use to
|
@@ -876,7 +965,7 @@ module Aws::Kendra
|
|
876
965
|
# @option params [String] :client_token
|
877
966
|
# A token that you provide to identify the request to create an index.
|
878
967
|
# Multiple calls to the `CreateIndex` operation with the same client
|
879
|
-
# token will create only one index
|
968
|
+
# token will create only one index.
|
880
969
|
#
|
881
970
|
# **A suitable default value is auto-generated.** You should normally
|
882
971
|
# not need to pass this option.**
|
@@ -886,6 +975,24 @@ module Aws::Kendra
|
|
886
975
|
# tags to identify and organize your resources and to control access to
|
887
976
|
# resources.
|
888
977
|
#
|
978
|
+
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
979
|
+
# The user token configuration.
|
980
|
+
#
|
981
|
+
# @option params [String] :user_context_policy
|
982
|
+
# The user context policy.
|
983
|
+
#
|
984
|
+
# ATTRIBUTE\_FILTER
|
985
|
+
#
|
986
|
+
# : All indexed content is searchable and displayable for all users. If
|
987
|
+
# there is an access control list, it is ignored. You can filter on
|
988
|
+
# user and group attributes.
|
989
|
+
#
|
990
|
+
# USER\_TOKEN
|
991
|
+
#
|
992
|
+
# : Enables SSO and token-based user access control. All documents with
|
993
|
+
# no access control and all documents accessible to the user will be
|
994
|
+
# searchable and displayable.
|
995
|
+
#
|
889
996
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
890
997
|
#
|
891
998
|
# * {Types::CreateIndexResponse#id #id} => String
|
@@ -907,6 +1014,24 @@ module Aws::Kendra
|
|
907
1014
|
# value: "TagValue", # required
|
908
1015
|
# },
|
909
1016
|
# ],
|
1017
|
+
# user_token_configurations: [
|
1018
|
+
# {
|
1019
|
+
# jwt_token_type_configuration: {
|
1020
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
1021
|
+
# url: "Url",
|
1022
|
+
# secret_manager_arn: "RoleArn",
|
1023
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
1024
|
+
# group_attribute_field: "GroupAttributeField",
|
1025
|
+
# issuer: "Issuer",
|
1026
|
+
# claim_regex: "ClaimRegex",
|
1027
|
+
# },
|
1028
|
+
# json_token_type_configuration: {
|
1029
|
+
# user_name_attribute_field: "String", # required
|
1030
|
+
# group_attribute_field: "String", # required
|
1031
|
+
# },
|
1032
|
+
# },
|
1033
|
+
# ],
|
1034
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
910
1035
|
# })
|
911
1036
|
#
|
912
1037
|
# @example Response structure
|
@@ -1042,10 +1167,12 @@ module Aws::Kendra
|
|
1042
1167
|
# resp.id #=> String
|
1043
1168
|
# resp.index_id #=> String
|
1044
1169
|
# resp.name #=> String
|
1045
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1170
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
1046
1171
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
1047
1172
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
1048
1173
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
1174
|
+
# resp.configuration.s3_configuration.inclusion_patterns #=> Array
|
1175
|
+
# resp.configuration.s3_configuration.inclusion_patterns[0] #=> String
|
1049
1176
|
# resp.configuration.s3_configuration.exclusion_patterns #=> Array
|
1050
1177
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
1051
1178
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
@@ -1069,6 +1196,7 @@ module Aws::Kendra
|
|
1069
1196
|
# resp.configuration.share_point_configuration.field_mappings[0].date_field_format #=> String
|
1070
1197
|
# resp.configuration.share_point_configuration.field_mappings[0].index_field_name #=> String
|
1071
1198
|
# resp.configuration.share_point_configuration.document_title_field_name #=> String
|
1199
|
+
# resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
|
1072
1200
|
# resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
|
1073
1201
|
# resp.configuration.database_configuration.connection_configuration.database_host #=> String
|
1074
1202
|
# resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
|
@@ -1148,6 +1276,7 @@ module Aws::Kendra
|
|
1148
1276
|
# resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
1149
1277
|
# resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
|
1150
1278
|
# resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
|
1279
|
+
# resp.configuration.one_drive_configuration.disable_local_groups #=> Boolean
|
1151
1280
|
# resp.configuration.service_now_configuration.host_url #=> String
|
1152
1281
|
# resp.configuration.service_now_configuration.secret_arn #=> String
|
1153
1282
|
# resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
|
@@ -1173,6 +1302,40 @@ module Aws::Kendra
|
|
1173
1302
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1174
1303
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1175
1304
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
1305
|
+
# resp.configuration.confluence_configuration.server_url #=> String
|
1306
|
+
# resp.configuration.confluence_configuration.secret_arn #=> String
|
1307
|
+
# resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
|
1308
|
+
# resp.configuration.confluence_configuration.space_configuration.crawl_personal_spaces #=> Boolean
|
1309
|
+
# resp.configuration.confluence_configuration.space_configuration.crawl_archived_spaces #=> Boolean
|
1310
|
+
# resp.configuration.confluence_configuration.space_configuration.include_spaces #=> Array
|
1311
|
+
# resp.configuration.confluence_configuration.space_configuration.include_spaces[0] #=> String
|
1312
|
+
# resp.configuration.confluence_configuration.space_configuration.exclude_spaces #=> Array
|
1313
|
+
# resp.configuration.confluence_configuration.space_configuration.exclude_spaces[0] #=> String
|
1314
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings #=> Array
|
1315
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].data_source_field_name #=> String, one of "DISPLAY_URL", "ITEM_TYPE", "SPACE_KEY", "URL"
|
1316
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].date_field_format #=> String
|
1317
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].index_field_name #=> String
|
1318
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings #=> Array
|
1319
|
+
# 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"
|
1320
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].date_field_format #=> String
|
1321
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].index_field_name #=> String
|
1322
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings #=> Array
|
1323
|
+
# 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"
|
1324
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].date_field_format #=> String
|
1325
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].index_field_name #=> String
|
1326
|
+
# resp.configuration.confluence_configuration.attachment_configuration.crawl_attachments #=> Boolean
|
1327
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings #=> Array
|
1328
|
+
# 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"
|
1329
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].date_field_format #=> String
|
1330
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].index_field_name #=> String
|
1331
|
+
# resp.configuration.confluence_configuration.vpc_configuration.subnet_ids #=> Array
|
1332
|
+
# resp.configuration.confluence_configuration.vpc_configuration.subnet_ids[0] #=> String
|
1333
|
+
# resp.configuration.confluence_configuration.vpc_configuration.security_group_ids #=> Array
|
1334
|
+
# resp.configuration.confluence_configuration.vpc_configuration.security_group_ids[0] #=> String
|
1335
|
+
# resp.configuration.confluence_configuration.inclusion_patterns #=> Array
|
1336
|
+
# resp.configuration.confluence_configuration.inclusion_patterns[0] #=> String
|
1337
|
+
# resp.configuration.confluence_configuration.exclusion_patterns #=> Array
|
1338
|
+
# resp.configuration.confluence_configuration.exclusion_patterns[0] #=> String
|
1176
1339
|
# resp.created_at #=> Time
|
1177
1340
|
# resp.updated_at #=> Time
|
1178
1341
|
# resp.description #=> String
|
@@ -1263,6 +1426,8 @@ module Aws::Kendra
|
|
1263
1426
|
# * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
1264
1427
|
# * {Types::DescribeIndexResponse#error_message #error_message} => String
|
1265
1428
|
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
1429
|
+
# * {Types::DescribeIndexResponse#user_token_configurations #user_token_configurations} => Array<Types::UserTokenConfiguration>
|
1430
|
+
# * {Types::DescribeIndexResponse#user_context_policy #user_context_policy} => String
|
1266
1431
|
#
|
1267
1432
|
# @example Request syntax with placeholder values
|
1268
1433
|
#
|
@@ -1300,6 +1465,17 @@ module Aws::Kendra
|
|
1300
1465
|
# resp.error_message #=> String
|
1301
1466
|
# resp.capacity_units.storage_capacity_units #=> Integer
|
1302
1467
|
# resp.capacity_units.query_capacity_units #=> Integer
|
1468
|
+
# resp.user_token_configurations #=> Array
|
1469
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.key_location #=> String, one of "URL", "SECRET_MANAGER"
|
1470
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.url #=> String
|
1471
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.secret_manager_arn #=> String
|
1472
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.user_name_attribute_field #=> String
|
1473
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.group_attribute_field #=> String
|
1474
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.issuer #=> String
|
1475
|
+
# resp.user_token_configurations[0].jwt_token_type_configuration.claim_regex #=> String
|
1476
|
+
# resp.user_token_configurations[0].json_token_type_configuration.user_name_attribute_field #=> String
|
1477
|
+
# resp.user_token_configurations[0].json_token_type_configuration.group_attribute_field #=> String
|
1478
|
+
# resp.user_context_policy #=> String, one of "ATTRIBUTE_FILTER", "USER_TOKEN"
|
1303
1479
|
#
|
1304
1480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
1305
1481
|
#
|
@@ -1416,7 +1592,7 @@ module Aws::Kendra
|
|
1416
1592
|
# resp.summary_items #=> Array
|
1417
1593
|
# resp.summary_items[0].name #=> String
|
1418
1594
|
# resp.summary_items[0].id #=> String
|
1419
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1595
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
1420
1596
|
# resp.summary_items[0].created_at #=> Time
|
1421
1597
|
# resp.summary_items[0].updated_at #=> Time
|
1422
1598
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1628,6 +1804,9 @@ module Aws::Kendra
|
|
1628
1804
|
# If you don't provide sorting configuration, the results are sorted by
|
1629
1805
|
# the relevance that Amazon Kendra determines for the result.
|
1630
1806
|
#
|
1807
|
+
# @option params [Types::UserContext] :user_context
|
1808
|
+
# The user context token.
|
1809
|
+
#
|
1631
1810
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1632
1811
|
#
|
1633
1812
|
# * {Types::QueryResult#query_id #query_id} => String
|
@@ -1731,6 +1910,9 @@ module Aws::Kendra
|
|
1731
1910
|
# document_attribute_key: "DocumentAttributeKey", # required
|
1732
1911
|
# sort_order: "DESC", # required, accepts DESC, ASC
|
1733
1912
|
# },
|
1913
|
+
# user_context: {
|
1914
|
+
# token: "Token",
|
1915
|
+
# },
|
1734
1916
|
# })
|
1735
1917
|
#
|
1736
1918
|
# @example Response structure
|
@@ -1999,6 +2181,7 @@ module Aws::Kendra
|
|
1999
2181
|
# s3_configuration: {
|
2000
2182
|
# bucket_name: "S3BucketName", # required
|
2001
2183
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
2184
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2002
2185
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2003
2186
|
# documents_metadata_configuration: {
|
2004
2187
|
# s3_prefix: "S3ObjectKey",
|
@@ -2027,6 +2210,7 @@ module Aws::Kendra
|
|
2027
2210
|
# },
|
2028
2211
|
# ],
|
2029
2212
|
# document_title_field_name: "DataSourceFieldName",
|
2213
|
+
# disable_local_groups: false,
|
2030
2214
|
# },
|
2031
2215
|
# database_configuration: {
|
2032
2216
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -2151,6 +2335,7 @@ module Aws::Kendra
|
|
2151
2335
|
# index_field_name: "IndexFieldName", # required
|
2152
2336
|
# },
|
2153
2337
|
# ],
|
2338
|
+
# disable_local_groups: false,
|
2154
2339
|
# },
|
2155
2340
|
# service_now_configuration: {
|
2156
2341
|
# host_url: "ServiceNowHostUrl", # required
|
@@ -2185,6 +2370,58 @@ module Aws::Kendra
|
|
2185
2370
|
# ],
|
2186
2371
|
# },
|
2187
2372
|
# },
|
2373
|
+
# confluence_configuration: {
|
2374
|
+
# server_url: "Url", # required
|
2375
|
+
# secret_arn: "SecretArn", # required
|
2376
|
+
# version: "CLOUD", # required, accepts CLOUD, SERVER
|
2377
|
+
# space_configuration: {
|
2378
|
+
# crawl_personal_spaces: false,
|
2379
|
+
# crawl_archived_spaces: false,
|
2380
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
2381
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
2382
|
+
# space_field_mappings: [
|
2383
|
+
# {
|
2384
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
2385
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2386
|
+
# index_field_name: "IndexFieldName",
|
2387
|
+
# },
|
2388
|
+
# ],
|
2389
|
+
# },
|
2390
|
+
# page_configuration: {
|
2391
|
+
# page_field_mappings: [
|
2392
|
+
# {
|
2393
|
+
# 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
|
2394
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2395
|
+
# index_field_name: "IndexFieldName",
|
2396
|
+
# },
|
2397
|
+
# ],
|
2398
|
+
# },
|
2399
|
+
# blog_configuration: {
|
2400
|
+
# blog_field_mappings: [
|
2401
|
+
# {
|
2402
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2403
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2404
|
+
# index_field_name: "IndexFieldName",
|
2405
|
+
# },
|
2406
|
+
# ],
|
2407
|
+
# },
|
2408
|
+
# attachment_configuration: {
|
2409
|
+
# crawl_attachments: false,
|
2410
|
+
# attachment_field_mappings: [
|
2411
|
+
# {
|
2412
|
+
# 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
|
2413
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2414
|
+
# index_field_name: "IndexFieldName",
|
2415
|
+
# },
|
2416
|
+
# ],
|
2417
|
+
# },
|
2418
|
+
# vpc_configuration: {
|
2419
|
+
# subnet_ids: ["SubnetId"], # required
|
2420
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2421
|
+
# },
|
2422
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2423
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2424
|
+
# },
|
2188
2425
|
# },
|
2189
2426
|
# description: "Description",
|
2190
2427
|
# schedule: "ScanSchedule",
|
@@ -2226,6 +2463,12 @@ module Aws::Kendra
|
|
2226
2463
|
# If you are using extra storage units, you can't reduce the storage
|
2227
2464
|
# capacity below that required to meet the storage needs for your index.
|
2228
2465
|
#
|
2466
|
+
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
2467
|
+
# The user token configuration.
|
2468
|
+
#
|
2469
|
+
# @option params [String] :user_context_policy
|
2470
|
+
# The user user token context policy.
|
2471
|
+
#
|
2229
2472
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2230
2473
|
#
|
2231
2474
|
# @example Request syntax with placeholder values
|
@@ -2260,6 +2503,24 @@ module Aws::Kendra
|
|
2260
2503
|
# storage_capacity_units: 1, # required
|
2261
2504
|
# query_capacity_units: 1, # required
|
2262
2505
|
# },
|
2506
|
+
# user_token_configurations: [
|
2507
|
+
# {
|
2508
|
+
# jwt_token_type_configuration: {
|
2509
|
+
# key_location: "URL", # required, accepts URL, SECRET_MANAGER
|
2510
|
+
# url: "Url",
|
2511
|
+
# secret_manager_arn: "RoleArn",
|
2512
|
+
# user_name_attribute_field: "UserNameAttributeField",
|
2513
|
+
# group_attribute_field: "GroupAttributeField",
|
2514
|
+
# issuer: "Issuer",
|
2515
|
+
# claim_regex: "ClaimRegex",
|
2516
|
+
# },
|
2517
|
+
# json_token_type_configuration: {
|
2518
|
+
# user_name_attribute_field: "String", # required
|
2519
|
+
# group_attribute_field: "String", # required
|
2520
|
+
# },
|
2521
|
+
# },
|
2522
|
+
# ],
|
2523
|
+
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
2263
2524
|
# })
|
2264
2525
|
#
|
2265
2526
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
@@ -2284,7 +2545,7 @@ module Aws::Kendra
|
|
2284
2545
|
params: params,
|
2285
2546
|
config: config)
|
2286
2547
|
context[:gem_name] = 'aws-sdk-kendra'
|
2287
|
-
context[:gem_version] = '1.
|
2548
|
+
context[:gem_version] = '1.18.0'
|
2288
2549
|
Seahorse::Client::Request.new(handlers, context)
|
2289
2550
|
end
|
2290
2551
|
|