aws-sdk-kendra 1.38.0 → 1.42.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +1036 -13
- data/lib/aws-sdk-kendra/client_api.rb +501 -1
- data/lib/aws-sdk-kendra/errors.rb +16 -0
- data/lib/aws-sdk-kendra/types.rb +2035 -194
- data/lib/aws-sdk-kendra.rb +2 -2
- metadata +4 -4
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
33
|
|
@@ -73,6 +74,7 @@ module Aws::Kendra
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
80
|
|
@@ -119,7 +121,9 @@ module Aws::Kendra
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
126
|
+
# to true.
|
123
127
|
#
|
124
128
|
# @option options [required, String] :region
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +177,10 @@ module Aws::Kendra
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
179
|
#
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
183
|
+
#
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
178
186
|
# to default service endpoint when available.
|
@@ -305,7 +313,7 @@ module Aws::Kendra
|
|
305
313
|
# seconds to wait when opening a HTTP session before raising a
|
306
314
|
# `Timeout::Error`.
|
307
315
|
#
|
308
|
-
# @option options [
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
309
317
|
# number of seconds to wait for response data. This value can
|
310
318
|
# safely be set per-request on the session.
|
311
319
|
#
|
@@ -321,6 +329,9 @@ module Aws::Kendra
|
|
321
329
|
# disables this behaviour. This value can safely be set per
|
322
330
|
# request on the session.
|
323
331
|
#
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
333
|
+
# in seconds.
|
334
|
+
#
|
324
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
325
336
|
# HTTP debug output will be sent to the `:logger`.
|
326
337
|
#
|
@@ -346,6 +357,117 @@ module Aws::Kendra
|
|
346
357
|
|
347
358
|
# @!group API Operations
|
348
359
|
|
360
|
+
# Grants users or groups in your Amazon Web Services SSO identity source
|
361
|
+
# access to your Amazon Kendra experience. You can create an Amazon
|
362
|
+
# Kendra experience such as a search application. For more information
|
363
|
+
# on creating a search application experience, see [Building a search
|
364
|
+
# experience with no code][1].
|
365
|
+
#
|
366
|
+
#
|
367
|
+
#
|
368
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
369
|
+
#
|
370
|
+
# @option params [required, String] :id
|
371
|
+
# The identifier of your Amazon Kendra experience.
|
372
|
+
#
|
373
|
+
# @option params [required, String] :index_id
|
374
|
+
# The identifier of the index for your Amazon Kendra experience.
|
375
|
+
#
|
376
|
+
# @option params [required, Array<Types::EntityConfiguration>] :entity_list
|
377
|
+
# Lists users or groups in your Amazon Web Services SSO identity source.
|
378
|
+
#
|
379
|
+
# @return [Types::AssociateEntitiesToExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
380
|
+
#
|
381
|
+
# * {Types::AssociateEntitiesToExperienceResponse#failed_entity_list #failed_entity_list} => Array<Types::FailedEntity>
|
382
|
+
#
|
383
|
+
# @example Request syntax with placeholder values
|
384
|
+
#
|
385
|
+
# resp = client.associate_entities_to_experience({
|
386
|
+
# id: "ExperienceId", # required
|
387
|
+
# index_id: "IndexId", # required
|
388
|
+
# entity_list: [ # required
|
389
|
+
# {
|
390
|
+
# entity_id: "EntityId", # required
|
391
|
+
# entity_type: "USER", # required, accepts USER, GROUP
|
392
|
+
# },
|
393
|
+
# ],
|
394
|
+
# })
|
395
|
+
#
|
396
|
+
# @example Response structure
|
397
|
+
#
|
398
|
+
# resp.failed_entity_list #=> Array
|
399
|
+
# resp.failed_entity_list[0].entity_id #=> String
|
400
|
+
# resp.failed_entity_list[0].error_message #=> String
|
401
|
+
#
|
402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperience AWS API Documentation
|
403
|
+
#
|
404
|
+
# @overload associate_entities_to_experience(params = {})
|
405
|
+
# @param [Hash] params ({})
|
406
|
+
def associate_entities_to_experience(params = {}, options = {})
|
407
|
+
req = build_request(:associate_entities_to_experience, params)
|
408
|
+
req.send_request(options)
|
409
|
+
end
|
410
|
+
|
411
|
+
# Defines the specific permissions of users or groups in your Amazon Web
|
412
|
+
# Services SSO identity source with access to your Amazon Kendra
|
413
|
+
# experience. You can create an Amazon Kendra experience such as a
|
414
|
+
# search application. For more information on creating a search
|
415
|
+
# application experience, see [Building a search experience with no
|
416
|
+
# code][1].
|
417
|
+
#
|
418
|
+
#
|
419
|
+
#
|
420
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
421
|
+
#
|
422
|
+
# @option params [required, String] :id
|
423
|
+
# The identifier of your Amazon Kendra experience.
|
424
|
+
#
|
425
|
+
# @option params [required, String] :index_id
|
426
|
+
# The identifier of the index for your Amazon Kendra experience.
|
427
|
+
#
|
428
|
+
# @option params [required, Array<Types::EntityPersonaConfiguration>] :personas
|
429
|
+
# The personas that define the specific permissions of users or groups
|
430
|
+
# in your Amazon Web Services SSO identity source. The available
|
431
|
+
# personas or access roles are `Owner` and `Viewer`. For more
|
432
|
+
# information on these personas, see [Providing access to your search
|
433
|
+
# page][1].
|
434
|
+
#
|
435
|
+
#
|
436
|
+
#
|
437
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html#access-search-experience
|
438
|
+
#
|
439
|
+
# @return [Types::AssociatePersonasToEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
440
|
+
#
|
441
|
+
# * {Types::AssociatePersonasToEntitiesResponse#failed_entity_list #failed_entity_list} => Array<Types::FailedEntity>
|
442
|
+
#
|
443
|
+
# @example Request syntax with placeholder values
|
444
|
+
#
|
445
|
+
# resp = client.associate_personas_to_entities({
|
446
|
+
# id: "ExperienceId", # required
|
447
|
+
# index_id: "IndexId", # required
|
448
|
+
# personas: [ # required
|
449
|
+
# {
|
450
|
+
# entity_id: "EntityId", # required
|
451
|
+
# persona: "OWNER", # required, accepts OWNER, VIEWER
|
452
|
+
# },
|
453
|
+
# ],
|
454
|
+
# })
|
455
|
+
#
|
456
|
+
# @example Response structure
|
457
|
+
#
|
458
|
+
# resp.failed_entity_list #=> Array
|
459
|
+
# resp.failed_entity_list[0].entity_id #=> String
|
460
|
+
# resp.failed_entity_list[0].error_message #=> String
|
461
|
+
#
|
462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociatePersonasToEntities AWS API Documentation
|
463
|
+
#
|
464
|
+
# @overload associate_personas_to_entities(params = {})
|
465
|
+
# @param [Hash] params ({})
|
466
|
+
def associate_personas_to_entities(params = {}, options = {})
|
467
|
+
req = build_request(:associate_personas_to_entities, params)
|
468
|
+
req.send_request(options)
|
469
|
+
end
|
470
|
+
|
349
471
|
# Removes one or more documents from an index. The documents must have
|
350
472
|
# been added with the `BatchPutDocument` operation.
|
351
473
|
#
|
@@ -523,6 +645,20 @@ module Aws::Kendra
|
|
523
645
|
#
|
524
646
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
525
647
|
#
|
648
|
+
# @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
|
649
|
+
# Configuration information for altering your document metadata and
|
650
|
+
# content during the document ingestion process when you use the
|
651
|
+
# `BatchPutDocument` operation.
|
652
|
+
#
|
653
|
+
# For more information on how to create, modify and delete document
|
654
|
+
# metadata, or make other content alterations when you ingest documents
|
655
|
+
# into Amazon Kendra, see [Customizing document metadata during the
|
656
|
+
# ingestion process][1].
|
657
|
+
#
|
658
|
+
#
|
659
|
+
#
|
660
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
|
661
|
+
#
|
526
662
|
# @return [Types::BatchPutDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
527
663
|
#
|
528
664
|
# * {Types::BatchPutDocumentResponse#failed_documents #failed_documents} => Array<Types::BatchPutDocumentResponseFailedDocument>
|
@@ -575,6 +711,62 @@ module Aws::Kendra
|
|
575
711
|
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
576
712
|
# },
|
577
713
|
# ],
|
714
|
+
# custom_document_enrichment_configuration: {
|
715
|
+
# inline_configurations: [
|
716
|
+
# {
|
717
|
+
# condition: {
|
718
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
719
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
720
|
+
# condition_on_value: {
|
721
|
+
# string_value: "DocumentAttributeStringValue",
|
722
|
+
# string_list_value: ["String"],
|
723
|
+
# long_value: 1,
|
724
|
+
# date_value: Time.now,
|
725
|
+
# },
|
726
|
+
# },
|
727
|
+
# target: {
|
728
|
+
# target_document_attribute_key: "DocumentAttributeKey",
|
729
|
+
# target_document_attribute_value_deletion: false,
|
730
|
+
# target_document_attribute_value: {
|
731
|
+
# string_value: "DocumentAttributeStringValue",
|
732
|
+
# string_list_value: ["String"],
|
733
|
+
# long_value: 1,
|
734
|
+
# date_value: Time.now,
|
735
|
+
# },
|
736
|
+
# },
|
737
|
+
# document_content_deletion: false,
|
738
|
+
# },
|
739
|
+
# ],
|
740
|
+
# pre_extraction_hook_configuration: {
|
741
|
+
# invocation_condition: {
|
742
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
743
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
744
|
+
# condition_on_value: {
|
745
|
+
# string_value: "DocumentAttributeStringValue",
|
746
|
+
# string_list_value: ["String"],
|
747
|
+
# long_value: 1,
|
748
|
+
# date_value: Time.now,
|
749
|
+
# },
|
750
|
+
# },
|
751
|
+
# lambda_arn: "LambdaArn", # required
|
752
|
+
# s3_bucket: "S3BucketName", # required
|
753
|
+
# },
|
754
|
+
# post_extraction_hook_configuration: {
|
755
|
+
# invocation_condition: {
|
756
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
757
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
758
|
+
# condition_on_value: {
|
759
|
+
# string_value: "DocumentAttributeStringValue",
|
760
|
+
# string_list_value: ["String"],
|
761
|
+
# long_value: 1,
|
762
|
+
# date_value: Time.now,
|
763
|
+
# },
|
764
|
+
# },
|
765
|
+
# lambda_arn: "LambdaArn", # required
|
766
|
+
# s3_bucket: "S3BucketName", # required
|
767
|
+
# },
|
768
|
+
# role_arn: "RoleArn",
|
769
|
+
# },
|
578
770
|
# })
|
579
771
|
#
|
580
772
|
# @example Response structure
|
@@ -601,6 +793,9 @@ module Aws::Kendra
|
|
601
793
|
# suggestions. If you do not see any new suggestions, then please allow
|
602
794
|
# Amazon Kendra to collect enough queries to learn new suggestions.
|
603
795
|
#
|
796
|
+
# `ClearQuerySuggestions` is currently not supported in the Amazon Web
|
797
|
+
# Services GovCloud (US-West) region.
|
798
|
+
#
|
604
799
|
# @option params [required, String] :index_id
|
605
800
|
# The identifier of the index you want to clear query suggestions from.
|
606
801
|
#
|
@@ -632,6 +827,13 @@ module Aws::Kendra
|
|
632
827
|
# 200 if the data source was successfully created. Otherwise, an
|
633
828
|
# exception is raised.
|
634
829
|
#
|
830
|
+
# Amazon S3 and [custom][1] data sources are the only supported data
|
831
|
+
# sources in the Amazon Web Services GovCloud (US-West) region.
|
832
|
+
#
|
833
|
+
#
|
834
|
+
#
|
835
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html
|
836
|
+
#
|
635
837
|
# @option params [required, String] :name
|
636
838
|
# A unique name for the data source. A data source name can't be
|
637
839
|
# changed without deleting and recreating the data source.
|
@@ -704,6 +906,19 @@ module Aws::Kendra
|
|
704
906
|
#
|
705
907
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
706
908
|
#
|
909
|
+
# @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
|
910
|
+
# Configuration information for altering document metadata and content
|
911
|
+
# during the document ingestion process when you create a data source.
|
912
|
+
#
|
913
|
+
# For more information on how to create, modify and delete document
|
914
|
+
# metadata, or make other content alterations when you ingest documents
|
915
|
+
# into Amazon Kendra, see [Customizing document metadata during the
|
916
|
+
# ingestion process][1].
|
917
|
+
#
|
918
|
+
#
|
919
|
+
#
|
920
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
|
921
|
+
#
|
707
922
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
708
923
|
#
|
709
924
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -1037,6 +1252,62 @@ module Aws::Kendra
|
|
1037
1252
|
# ],
|
1038
1253
|
# client_token: "ClientTokenName",
|
1039
1254
|
# language_code: "LanguageCode",
|
1255
|
+
# custom_document_enrichment_configuration: {
|
1256
|
+
# inline_configurations: [
|
1257
|
+
# {
|
1258
|
+
# condition: {
|
1259
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
1260
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
1261
|
+
# condition_on_value: {
|
1262
|
+
# string_value: "DocumentAttributeStringValue",
|
1263
|
+
# string_list_value: ["String"],
|
1264
|
+
# long_value: 1,
|
1265
|
+
# date_value: Time.now,
|
1266
|
+
# },
|
1267
|
+
# },
|
1268
|
+
# target: {
|
1269
|
+
# target_document_attribute_key: "DocumentAttributeKey",
|
1270
|
+
# target_document_attribute_value_deletion: false,
|
1271
|
+
# target_document_attribute_value: {
|
1272
|
+
# string_value: "DocumentAttributeStringValue",
|
1273
|
+
# string_list_value: ["String"],
|
1274
|
+
# long_value: 1,
|
1275
|
+
# date_value: Time.now,
|
1276
|
+
# },
|
1277
|
+
# },
|
1278
|
+
# document_content_deletion: false,
|
1279
|
+
# },
|
1280
|
+
# ],
|
1281
|
+
# pre_extraction_hook_configuration: {
|
1282
|
+
# invocation_condition: {
|
1283
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
1284
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
1285
|
+
# condition_on_value: {
|
1286
|
+
# string_value: "DocumentAttributeStringValue",
|
1287
|
+
# string_list_value: ["String"],
|
1288
|
+
# long_value: 1,
|
1289
|
+
# date_value: Time.now,
|
1290
|
+
# },
|
1291
|
+
# },
|
1292
|
+
# lambda_arn: "LambdaArn", # required
|
1293
|
+
# s3_bucket: "S3BucketName", # required
|
1294
|
+
# },
|
1295
|
+
# post_extraction_hook_configuration: {
|
1296
|
+
# invocation_condition: {
|
1297
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
1298
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
1299
|
+
# condition_on_value: {
|
1300
|
+
# string_value: "DocumentAttributeStringValue",
|
1301
|
+
# string_list_value: ["String"],
|
1302
|
+
# long_value: 1,
|
1303
|
+
# date_value: Time.now,
|
1304
|
+
# },
|
1305
|
+
# },
|
1306
|
+
# lambda_arn: "LambdaArn", # required
|
1307
|
+
# s3_bucket: "S3BucketName", # required
|
1308
|
+
# },
|
1309
|
+
# role_arn: "RoleArn",
|
1310
|
+
# },
|
1040
1311
|
# })
|
1041
1312
|
#
|
1042
1313
|
# @example Response structure
|
@@ -1052,9 +1323,91 @@ module Aws::Kendra
|
|
1052
1323
|
req.send_request(options)
|
1053
1324
|
end
|
1054
1325
|
|
1326
|
+
# Creates an Amazon Kendra experience such as a search application. For
|
1327
|
+
# more information on creating a search application experience, see
|
1328
|
+
# [Building a search experience with no code][1].
|
1329
|
+
#
|
1330
|
+
#
|
1331
|
+
#
|
1332
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
1333
|
+
#
|
1334
|
+
# @option params [required, String] :name
|
1335
|
+
# A name for your Amazon Kendra experience.
|
1336
|
+
#
|
1337
|
+
# @option params [required, String] :index_id
|
1338
|
+
# The identifier of the index for your Amazon Kendra experience.
|
1339
|
+
#
|
1340
|
+
# @option params [String] :role_arn
|
1341
|
+
# The Amazon Resource Name (ARN) of a role with permission to access
|
1342
|
+
# `Query` operations, `QuerySuggestions` operations, `SubmitFeedback`
|
1343
|
+
# operations, and Amazon Web Services SSO that stores your user and
|
1344
|
+
# group information. For more information, see [IAM roles for Amazon
|
1345
|
+
# Kendra][1].
|
1346
|
+
#
|
1347
|
+
#
|
1348
|
+
#
|
1349
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
1350
|
+
#
|
1351
|
+
# @option params [Types::ExperienceConfiguration] :configuration
|
1352
|
+
# Provides the configuration information for your Amazon Kendra
|
1353
|
+
# experience. This includes `ContentSourceConfiguration`, which
|
1354
|
+
# specifies the data source IDs and/or FAQ IDs, and
|
1355
|
+
# `UserIdentityConfiguration`, which specifies the user or group
|
1356
|
+
# information to grant access to your Amazon Kendra experience.
|
1357
|
+
#
|
1358
|
+
# @option params [String] :description
|
1359
|
+
# A description for your Amazon Kendra experience.
|
1360
|
+
#
|
1361
|
+
# @option params [String] :client_token
|
1362
|
+
# A token that you provide to identify the request to create your Amazon
|
1363
|
+
# Kendra experience. Multiple calls to the `CreateExperience` operation
|
1364
|
+
# with the same client token creates only one Amazon Kendra experience.
|
1365
|
+
#
|
1366
|
+
# **A suitable default value is auto-generated.** You should normally
|
1367
|
+
# not need to pass this option.**
|
1368
|
+
#
|
1369
|
+
# @return [Types::CreateExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1370
|
+
#
|
1371
|
+
# * {Types::CreateExperienceResponse#id #id} => String
|
1372
|
+
#
|
1373
|
+
# @example Request syntax with placeholder values
|
1374
|
+
#
|
1375
|
+
# resp = client.create_experience({
|
1376
|
+
# name: "ExperienceName", # required
|
1377
|
+
# index_id: "IndexId", # required
|
1378
|
+
# role_arn: "RoleArn",
|
1379
|
+
# configuration: {
|
1380
|
+
# content_source_configuration: {
|
1381
|
+
# data_source_ids: ["DataSourceId"],
|
1382
|
+
# faq_ids: ["FaqId"],
|
1383
|
+
# direct_put_content: false,
|
1384
|
+
# },
|
1385
|
+
# user_identity_configuration: {
|
1386
|
+
# identity_attribute_name: "IdentityAttributeName",
|
1387
|
+
# },
|
1388
|
+
# },
|
1389
|
+
# description: "Description",
|
1390
|
+
# client_token: "ClientTokenName",
|
1391
|
+
# })
|
1392
|
+
#
|
1393
|
+
# @example Response structure
|
1394
|
+
#
|
1395
|
+
# resp.id #=> String
|
1396
|
+
#
|
1397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperience AWS API Documentation
|
1398
|
+
#
|
1399
|
+
# @overload create_experience(params = {})
|
1400
|
+
# @param [Hash] params ({})
|
1401
|
+
def create_experience(params = {}, options = {})
|
1402
|
+
req = build_request(:create_experience, params)
|
1403
|
+
req.send_request(options)
|
1404
|
+
end
|
1405
|
+
|
1055
1406
|
# Creates an new set of frequently asked question (FAQ) questions and
|
1056
1407
|
# answers.
|
1057
1408
|
#
|
1409
|
+
# Adding FAQs to an index is an asynchronous operation.
|
1410
|
+
#
|
1058
1411
|
# @option params [required, String] :index_id
|
1059
1412
|
# The identifier of the index that contains the FAQ.
|
1060
1413
|
#
|
@@ -1228,8 +1581,8 @@ module Aws::Kendra
|
|
1228
1581
|
# accessible to the user will be searchable and displayable.
|
1229
1582
|
#
|
1230
1583
|
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
1231
|
-
# Enables fetching access levels of groups and users from an
|
1232
|
-
# Sign
|
1584
|
+
# Enables fetching access levels of groups and users from an Amazon Web
|
1585
|
+
# Services Single Sign On identity source. To configure this, see
|
1233
1586
|
# [UserGroupResolutionConfiguration][1].
|
1234
1587
|
#
|
1235
1588
|
#
|
@@ -1305,6 +1658,9 @@ module Aws::Kendra
|
|
1305
1658
|
# For information on the current quota limits for block lists, see
|
1306
1659
|
# [Quotas for Amazon Kendra][1].
|
1307
1660
|
#
|
1661
|
+
# `CreateQuerySuggestionsBlockList` is currently not supported in the
|
1662
|
+
# Amazon Web Services GovCloud (US-West) region.
|
1663
|
+
#
|
1308
1664
|
#
|
1309
1665
|
#
|
1310
1666
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
@@ -1407,9 +1763,8 @@ module Aws::Kendra
|
|
1407
1763
|
# The description for the new thesaurus.
|
1408
1764
|
#
|
1409
1765
|
# @option params [required, String] :role_arn
|
1410
|
-
# An
|
1411
|
-
#
|
1412
|
-
# `SourceS3Path`.
|
1766
|
+
# An IAM role that gives Amazon Kendra permissions to access thesaurus
|
1767
|
+
# file specified in `SourceS3Path`.
|
1413
1768
|
#
|
1414
1769
|
# @option params [Array<Types::Tag>] :tags
|
1415
1770
|
# A list of key-value pairs that identify the thesaurus. You can use the
|
@@ -1498,6 +1853,39 @@ module Aws::Kendra
|
|
1498
1853
|
req.send_request(options)
|
1499
1854
|
end
|
1500
1855
|
|
1856
|
+
# Deletes your Amazon Kendra experience such as a search application.
|
1857
|
+
# For more information on creating a search application experience, see
|
1858
|
+
# [Building a search experience with no code][1].
|
1859
|
+
#
|
1860
|
+
#
|
1861
|
+
#
|
1862
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
1863
|
+
#
|
1864
|
+
# @option params [required, String] :id
|
1865
|
+
# The identifier of your Amazon Kendra experience you want to delete.
|
1866
|
+
#
|
1867
|
+
# @option params [required, String] :index_id
|
1868
|
+
# The identifier of the index for your Amazon Kendra experience you want
|
1869
|
+
# to delete.
|
1870
|
+
#
|
1871
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1872
|
+
#
|
1873
|
+
# @example Request syntax with placeholder values
|
1874
|
+
#
|
1875
|
+
# resp = client.delete_experience({
|
1876
|
+
# id: "ExperienceId", # required
|
1877
|
+
# index_id: "IndexId", # required
|
1878
|
+
# })
|
1879
|
+
#
|
1880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperience AWS API Documentation
|
1881
|
+
#
|
1882
|
+
# @overload delete_experience(params = {})
|
1883
|
+
# @param [Hash] params ({})
|
1884
|
+
def delete_experience(params = {}, options = {})
|
1885
|
+
req = build_request(:delete_experience, params)
|
1886
|
+
req.send_request(options)
|
1887
|
+
end
|
1888
|
+
|
1501
1889
|
# Removes an FAQ from an index.
|
1502
1890
|
#
|
1503
1891
|
# @option params [required, String] :id
|
@@ -1564,6 +1952,9 @@ module Aws::Kendra
|
|
1564
1952
|
# `PutPrincipalMapping`. You can update your internal list of users or
|
1565
1953
|
# sub groups and input this list when calling `PutPrincipalMapping`.
|
1566
1954
|
#
|
1955
|
+
# `DeletePrincipalMapping` is currently not supported in the Amazon Web
|
1956
|
+
# Services GovCloud (US-West) region.
|
1957
|
+
#
|
1567
1958
|
# @option params [required, String] :index_id
|
1568
1959
|
# The identifier of the index you want to delete a group from.
|
1569
1960
|
#
|
@@ -1627,6 +2018,9 @@ module Aws::Kendra
|
|
1627
2018
|
# needs to refresh the entire suggestions list to add back the queries
|
1628
2019
|
# that were previously blocked.
|
1629
2020
|
#
|
2021
|
+
# `DeleteQuerySuggestionsBlockList` is currently not supported in the
|
2022
|
+
# Amazon Web Services GovCloud (US-West) region.
|
2023
|
+
#
|
1630
2024
|
# @option params [required, String] :index_id
|
1631
2025
|
# The identifier of the you want to delete a block list from.
|
1632
2026
|
#
|
@@ -1700,6 +2094,7 @@ module Aws::Kendra
|
|
1700
2094
|
# * {Types::DescribeDataSourceResponse#role_arn #role_arn} => String
|
1701
2095
|
# * {Types::DescribeDataSourceResponse#error_message #error_message} => String
|
1702
2096
|
# * {Types::DescribeDataSourceResponse#language_code #language_code} => String
|
2097
|
+
# * {Types::DescribeDataSourceResponse#custom_document_enrichment_configuration #custom_document_enrichment_configuration} => Types::CustomDocumentEnrichmentConfiguration
|
1703
2098
|
#
|
1704
2099
|
# @example Request syntax with placeholder values
|
1705
2100
|
#
|
@@ -1940,6 +2335,41 @@ module Aws::Kendra
|
|
1940
2335
|
# resp.role_arn #=> String
|
1941
2336
|
# resp.error_message #=> String
|
1942
2337
|
# resp.language_code #=> String
|
2338
|
+
# resp.custom_document_enrichment_configuration.inline_configurations #=> Array
|
2339
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_document_attribute_key #=> String
|
2340
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.operator #=> String, one of "GreaterThan", "GreaterThanOrEquals", "LessThan", "LessThanOrEquals", "Equals", "NotEquals", "Contains", "NotContains", "Exists", "NotExists", "BeginsWith"
|
2341
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.string_value #=> String
|
2342
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.string_list_value #=> Array
|
2343
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.string_list_value[0] #=> String
|
2344
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.long_value #=> Integer
|
2345
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.date_value #=> Time
|
2346
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_key #=> String
|
2347
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value_deletion #=> Boolean
|
2348
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.string_value #=> String
|
2349
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.string_list_value #=> Array
|
2350
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.string_list_value[0] #=> String
|
2351
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.long_value #=> Integer
|
2352
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.date_value #=> Time
|
2353
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].document_content_deletion #=> Boolean
|
2354
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_document_attribute_key #=> String
|
2355
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.operator #=> String, one of "GreaterThan", "GreaterThanOrEquals", "LessThan", "LessThanOrEquals", "Equals", "NotEquals", "Contains", "NotContains", "Exists", "NotExists", "BeginsWith"
|
2356
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.string_value #=> String
|
2357
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value #=> Array
|
2358
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value[0] #=> String
|
2359
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.long_value #=> Integer
|
2360
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.date_value #=> Time
|
2361
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.lambda_arn #=> String
|
2362
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.s3_bucket #=> String
|
2363
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_document_attribute_key #=> String
|
2364
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.operator #=> String, one of "GreaterThan", "GreaterThanOrEquals", "LessThan", "LessThanOrEquals", "Equals", "NotEquals", "Contains", "NotContains", "Exists", "NotExists", "BeginsWith"
|
2365
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.string_value #=> String
|
2366
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value #=> Array
|
2367
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value[0] #=> String
|
2368
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.long_value #=> Integer
|
2369
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.date_value #=> Time
|
2370
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.lambda_arn #=> String
|
2371
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.s3_bucket #=> String
|
2372
|
+
# resp.custom_document_enrichment_configuration.role_arn #=> String
|
1943
2373
|
#
|
1944
2374
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource AWS API Documentation
|
1945
2375
|
#
|
@@ -1950,6 +2380,73 @@ module Aws::Kendra
|
|
1950
2380
|
req.send_request(options)
|
1951
2381
|
end
|
1952
2382
|
|
2383
|
+
# Gets information about your Amazon Kendra experience such as a search
|
2384
|
+
# application. For more information on creating a search application
|
2385
|
+
# experience, see [Building a search experience with no code][1].
|
2386
|
+
#
|
2387
|
+
#
|
2388
|
+
#
|
2389
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
2390
|
+
#
|
2391
|
+
# @option params [required, String] :id
|
2392
|
+
# The identifier of your Amazon Kendra experience you want to get
|
2393
|
+
# information on.
|
2394
|
+
#
|
2395
|
+
# @option params [required, String] :index_id
|
2396
|
+
# The identifier of the index for your Amazon Kendra experience you want
|
2397
|
+
# to get information on.
|
2398
|
+
#
|
2399
|
+
# @return [Types::DescribeExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2400
|
+
#
|
2401
|
+
# * {Types::DescribeExperienceResponse#id #id} => String
|
2402
|
+
# * {Types::DescribeExperienceResponse#index_id #index_id} => String
|
2403
|
+
# * {Types::DescribeExperienceResponse#name #name} => String
|
2404
|
+
# * {Types::DescribeExperienceResponse#endpoints #endpoints} => Array<Types::ExperienceEndpoint>
|
2405
|
+
# * {Types::DescribeExperienceResponse#configuration #configuration} => Types::ExperienceConfiguration
|
2406
|
+
# * {Types::DescribeExperienceResponse#created_at #created_at} => Time
|
2407
|
+
# * {Types::DescribeExperienceResponse#updated_at #updated_at} => Time
|
2408
|
+
# * {Types::DescribeExperienceResponse#description #description} => String
|
2409
|
+
# * {Types::DescribeExperienceResponse#status #status} => String
|
2410
|
+
# * {Types::DescribeExperienceResponse#role_arn #role_arn} => String
|
2411
|
+
# * {Types::DescribeExperienceResponse#error_message #error_message} => String
|
2412
|
+
#
|
2413
|
+
# @example Request syntax with placeholder values
|
2414
|
+
#
|
2415
|
+
# resp = client.describe_experience({
|
2416
|
+
# id: "ExperienceId", # required
|
2417
|
+
# index_id: "IndexId", # required
|
2418
|
+
# })
|
2419
|
+
#
|
2420
|
+
# @example Response structure
|
2421
|
+
#
|
2422
|
+
# resp.id #=> String
|
2423
|
+
# resp.index_id #=> String
|
2424
|
+
# resp.name #=> String
|
2425
|
+
# resp.endpoints #=> Array
|
2426
|
+
# resp.endpoints[0].endpoint_type #=> String, one of "HOME"
|
2427
|
+
# resp.endpoints[0].endpoint #=> String
|
2428
|
+
# resp.configuration.content_source_configuration.data_source_ids #=> Array
|
2429
|
+
# resp.configuration.content_source_configuration.data_source_ids[0] #=> String
|
2430
|
+
# resp.configuration.content_source_configuration.faq_ids #=> Array
|
2431
|
+
# resp.configuration.content_source_configuration.faq_ids[0] #=> String
|
2432
|
+
# resp.configuration.content_source_configuration.direct_put_content #=> Boolean
|
2433
|
+
# resp.configuration.user_identity_configuration.identity_attribute_name #=> String
|
2434
|
+
# resp.created_at #=> Time
|
2435
|
+
# resp.updated_at #=> Time
|
2436
|
+
# resp.description #=> String
|
2437
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
|
2438
|
+
# resp.role_arn #=> String
|
2439
|
+
# resp.error_message #=> String
|
2440
|
+
#
|
2441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperience AWS API Documentation
|
2442
|
+
#
|
2443
|
+
# @overload describe_experience(params = {})
|
2444
|
+
# @param [Hash] params ({})
|
2445
|
+
def describe_experience(params = {}, options = {})
|
2446
|
+
req = build_request(:describe_experience, params)
|
2447
|
+
req.send_request(options)
|
2448
|
+
end
|
2449
|
+
|
1953
2450
|
# Gets information about an FAQ list.
|
1954
2451
|
#
|
1955
2452
|
# @option params [required, String] :id
|
@@ -2094,6 +2591,9 @@ module Aws::Kendra
|
|
2094
2591
|
# action that should process and apply after other actions, and useful
|
2095
2592
|
# error messages if an action could not be processed.
|
2096
2593
|
#
|
2594
|
+
# `DescribePrincipalMapping` is currently not supported in the Amazon
|
2595
|
+
# Web Services GovCloud (US-West) region.
|
2596
|
+
#
|
2097
2597
|
# @option params [required, String] :index_id
|
2098
2598
|
# The identifier of the index required to check the processing of `PUT`
|
2099
2599
|
# and `DELETE` actions for mapping users to their groups.
|
@@ -2147,6 +2647,9 @@ module Aws::Kendra
|
|
2147
2647
|
# This is used to check the current settings that are applied to a block
|
2148
2648
|
# list.
|
2149
2649
|
#
|
2650
|
+
# `DescribeQuerySuggestionsBlockList` is currently not supported in the
|
2651
|
+
# Amazon Web Services GovCloud (US-West) region.
|
2652
|
+
#
|
2150
2653
|
# @option params [required, String] :index_id
|
2151
2654
|
# The identifier of the index for the block list.
|
2152
2655
|
#
|
@@ -2205,6 +2708,9 @@ module Aws::Kendra
|
|
2205
2708
|
# This is used to check the current settings applied to query
|
2206
2709
|
# suggestions.
|
2207
2710
|
#
|
2711
|
+
# `DescribeQuerySuggestionsConfig` is currently not supported in the
|
2712
|
+
# Amazon Web Services GovCloud (US-West) region.
|
2713
|
+
#
|
2208
2714
|
# @option params [required, String] :index_id
|
2209
2715
|
# The identifier of the index you want to describe query suggestions
|
2210
2716
|
# settings for.
|
@@ -2305,8 +2811,110 @@ module Aws::Kendra
|
|
2305
2811
|
req.send_request(options)
|
2306
2812
|
end
|
2307
2813
|
|
2814
|
+
# Prevents users or groups in your Amazon Web Services SSO identity
|
2815
|
+
# source from accessing your Amazon Kendra experience. You can create an
|
2816
|
+
# Amazon Kendra experience such as a search application. For more
|
2817
|
+
# information on creating a search application experience, see [Building
|
2818
|
+
# a search experience with no code][1].
|
2819
|
+
#
|
2820
|
+
#
|
2821
|
+
#
|
2822
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
2823
|
+
#
|
2824
|
+
# @option params [required, String] :id
|
2825
|
+
# The identifier of your Amazon Kendra experience.
|
2826
|
+
#
|
2827
|
+
# @option params [required, String] :index_id
|
2828
|
+
# The identifier of the index for your Amazon Kendra experience.
|
2829
|
+
#
|
2830
|
+
# @option params [required, Array<Types::EntityConfiguration>] :entity_list
|
2831
|
+
# Lists users or groups in your Amazon Web Services SSO identity source.
|
2832
|
+
#
|
2833
|
+
# @return [Types::DisassociateEntitiesFromExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2834
|
+
#
|
2835
|
+
# * {Types::DisassociateEntitiesFromExperienceResponse#failed_entity_list #failed_entity_list} => Array<Types::FailedEntity>
|
2836
|
+
#
|
2837
|
+
# @example Request syntax with placeholder values
|
2838
|
+
#
|
2839
|
+
# resp = client.disassociate_entities_from_experience({
|
2840
|
+
# id: "ExperienceId", # required
|
2841
|
+
# index_id: "IndexId", # required
|
2842
|
+
# entity_list: [ # required
|
2843
|
+
# {
|
2844
|
+
# entity_id: "EntityId", # required
|
2845
|
+
# entity_type: "USER", # required, accepts USER, GROUP
|
2846
|
+
# },
|
2847
|
+
# ],
|
2848
|
+
# })
|
2849
|
+
#
|
2850
|
+
# @example Response structure
|
2851
|
+
#
|
2852
|
+
# resp.failed_entity_list #=> Array
|
2853
|
+
# resp.failed_entity_list[0].entity_id #=> String
|
2854
|
+
# resp.failed_entity_list[0].error_message #=> String
|
2855
|
+
#
|
2856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperience AWS API Documentation
|
2857
|
+
#
|
2858
|
+
# @overload disassociate_entities_from_experience(params = {})
|
2859
|
+
# @param [Hash] params ({})
|
2860
|
+
def disassociate_entities_from_experience(params = {}, options = {})
|
2861
|
+
req = build_request(:disassociate_entities_from_experience, params)
|
2862
|
+
req.send_request(options)
|
2863
|
+
end
|
2864
|
+
|
2865
|
+
# Removes the specific permissions of users or groups in your Amazon Web
|
2866
|
+
# Services SSO identity source with access to your Amazon Kendra
|
2867
|
+
# experience. You can create an Amazon Kendra experience such as a
|
2868
|
+
# search application. For more information on creating a search
|
2869
|
+
# application experience, see [Building a search experience with no
|
2870
|
+
# code][1].
|
2871
|
+
#
|
2872
|
+
#
|
2873
|
+
#
|
2874
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
2875
|
+
#
|
2876
|
+
# @option params [required, String] :id
|
2877
|
+
# The identifier of your Amazon Kendra experience.
|
2878
|
+
#
|
2879
|
+
# @option params [required, String] :index_id
|
2880
|
+
# The identifier of the index for your Amazon Kendra experience.
|
2881
|
+
#
|
2882
|
+
# @option params [required, Array<String>] :entity_ids
|
2883
|
+
# The identifiers of users or groups in your Amazon Web Services SSO
|
2884
|
+
# identity source. For example, user IDs could be user emails.
|
2885
|
+
#
|
2886
|
+
# @return [Types::DisassociatePersonasFromEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2887
|
+
#
|
2888
|
+
# * {Types::DisassociatePersonasFromEntitiesResponse#failed_entity_list #failed_entity_list} => Array<Types::FailedEntity>
|
2889
|
+
#
|
2890
|
+
# @example Request syntax with placeholder values
|
2891
|
+
#
|
2892
|
+
# resp = client.disassociate_personas_from_entities({
|
2893
|
+
# id: "ExperienceId", # required
|
2894
|
+
# index_id: "IndexId", # required
|
2895
|
+
# entity_ids: ["EntityId"], # required
|
2896
|
+
# })
|
2897
|
+
#
|
2898
|
+
# @example Response structure
|
2899
|
+
#
|
2900
|
+
# resp.failed_entity_list #=> Array
|
2901
|
+
# resp.failed_entity_list[0].entity_id #=> String
|
2902
|
+
# resp.failed_entity_list[0].error_message #=> String
|
2903
|
+
#
|
2904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntities AWS API Documentation
|
2905
|
+
#
|
2906
|
+
# @overload disassociate_personas_from_entities(params = {})
|
2907
|
+
# @param [Hash] params ({})
|
2908
|
+
def disassociate_personas_from_entities(params = {}, options = {})
|
2909
|
+
req = build_request(:disassociate_personas_from_entities, params)
|
2910
|
+
req.send_request(options)
|
2911
|
+
end
|
2912
|
+
|
2308
2913
|
# Fetches the queries that are suggested to your users.
|
2309
2914
|
#
|
2915
|
+
# `GetQuerySuggestions` is currently not supported in the Amazon Web
|
2916
|
+
# Services GovCloud (US-West) region.
|
2917
|
+
#
|
2310
2918
|
# @option params [required, String] :index_id
|
2311
2919
|
# The identifier of the index you want to get query suggestions from.
|
2312
2920
|
#
|
@@ -2357,6 +2965,95 @@ module Aws::Kendra
|
|
2357
2965
|
req.send_request(options)
|
2358
2966
|
end
|
2359
2967
|
|
2968
|
+
# Retrieves search metrics data. The data provides a snapshot of how
|
2969
|
+
# your users interact with your search application and how effective the
|
2970
|
+
# application is.
|
2971
|
+
#
|
2972
|
+
# @option params [required, String] :index_id
|
2973
|
+
# The identifier of the index to get search metrics data.
|
2974
|
+
#
|
2975
|
+
# @option params [required, String] :interval
|
2976
|
+
# The time interval or time window to get search metrics data. The time
|
2977
|
+
# interval uses the time zone of your index. You can view data in the
|
2978
|
+
# following time windows:
|
2979
|
+
#
|
2980
|
+
# * `THIS_WEEK`\: The current week, starting on the Sunday and ending on
|
2981
|
+
# the day before the current date.
|
2982
|
+
#
|
2983
|
+
# * `ONE_WEEK_AGO`\: The previous week, starting on the Sunday and
|
2984
|
+
# ending on the following Saturday.
|
2985
|
+
#
|
2986
|
+
# * `TWO_WEEKS_AGO`\: The week before the previous week, starting on the
|
2987
|
+
# Sunday and ending on the following Saturday.
|
2988
|
+
#
|
2989
|
+
# * `THIS_MONTH`\: The current month, starting on the first day of the
|
2990
|
+
# month and ending on the day before the current date.
|
2991
|
+
#
|
2992
|
+
# * `ONE_MONTH_AGO`\: The previous month, starting on the first day of
|
2993
|
+
# the month and ending on the last day of the month.
|
2994
|
+
#
|
2995
|
+
# * `TWO_MONTHS_AGO`\: The month before the previous month, starting on
|
2996
|
+
# the first day of the month and ending on last day of the month.
|
2997
|
+
#
|
2998
|
+
# @option params [required, String] :metric_type
|
2999
|
+
# The metric you want to retrieve. You can specify only one metric per
|
3000
|
+
# call.
|
3001
|
+
#
|
3002
|
+
# For more information about the metrics you can view, see [Gaining
|
3003
|
+
# insights with search analytics][1].
|
3004
|
+
#
|
3005
|
+
#
|
3006
|
+
#
|
3007
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html
|
3008
|
+
#
|
3009
|
+
# @option params [String] :next_token
|
3010
|
+
# If the previous response was incomplete (because there is more data to
|
3011
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3012
|
+
# You can use this pagination token to retrieve the next set of search
|
3013
|
+
# metrics data.
|
3014
|
+
#
|
3015
|
+
# @option params [Integer] :max_results
|
3016
|
+
# The maximum number of returned data for the metric.
|
3017
|
+
#
|
3018
|
+
# @return [Types::GetSnapshotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3019
|
+
#
|
3020
|
+
# * {Types::GetSnapshotsResponse#snap_shot_time_filter #snap_shot_time_filter} => Types::TimeRange
|
3021
|
+
# * {Types::GetSnapshotsResponse#snapshots_data_header #snapshots_data_header} => Array<String>
|
3022
|
+
# * {Types::GetSnapshotsResponse#snapshots_data #snapshots_data} => Array<Array<String>>
|
3023
|
+
# * {Types::GetSnapshotsResponse#next_token #next_token} => String
|
3024
|
+
#
|
3025
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3026
|
+
#
|
3027
|
+
# @example Request syntax with placeholder values
|
3028
|
+
#
|
3029
|
+
# resp = client.get_snapshots({
|
3030
|
+
# index_id: "IndexId", # required
|
3031
|
+
# interval: "THIS_MONTH", # required, accepts THIS_MONTH, THIS_WEEK, ONE_WEEK_AGO, TWO_WEEKS_AGO, ONE_MONTH_AGO, TWO_MONTHS_AGO
|
3032
|
+
# metric_type: "QUERIES_BY_COUNT", # required, accepts QUERIES_BY_COUNT, QUERIES_BY_ZERO_CLICK_RATE, QUERIES_BY_ZERO_RESULT_RATE, DOCS_BY_CLICK_COUNT, AGG_QUERY_DOC_METRICS, TREND_QUERY_DOC_METRICS
|
3033
|
+
# next_token: "NextToken",
|
3034
|
+
# max_results: 1,
|
3035
|
+
# })
|
3036
|
+
#
|
3037
|
+
# @example Response structure
|
3038
|
+
#
|
3039
|
+
# resp.snap_shot_time_filter.start_time #=> Time
|
3040
|
+
# resp.snap_shot_time_filter.end_time #=> Time
|
3041
|
+
# resp.snapshots_data_header #=> Array
|
3042
|
+
# resp.snapshots_data_header[0] #=> String
|
3043
|
+
# resp.snapshots_data #=> Array
|
3044
|
+
# resp.snapshots_data[0] #=> Array
|
3045
|
+
# resp.snapshots_data[0][0] #=> String
|
3046
|
+
# resp.next_token #=> String
|
3047
|
+
#
|
3048
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshots AWS API Documentation
|
3049
|
+
#
|
3050
|
+
# @overload get_snapshots(params = {})
|
3051
|
+
# @param [Hash] params ({})
|
3052
|
+
def get_snapshots(params = {}, options = {})
|
3053
|
+
req = build_request(:get_snapshots, params)
|
3054
|
+
req.send_request(options)
|
3055
|
+
end
|
3056
|
+
|
2360
3057
|
# Gets statistics about synchronizing Amazon Kendra with a data source.
|
2361
3058
|
#
|
2362
3059
|
# @option params [required, String] :id
|
@@ -2480,6 +3177,173 @@ module Aws::Kendra
|
|
2480
3177
|
req.send_request(options)
|
2481
3178
|
end
|
2482
3179
|
|
3180
|
+
# Lists specific permissions of users and groups with access to your
|
3181
|
+
# Amazon Kendra experience.
|
3182
|
+
#
|
3183
|
+
# @option params [required, String] :id
|
3184
|
+
# The identifier of your Amazon Kendra experience.
|
3185
|
+
#
|
3186
|
+
# @option params [required, String] :index_id
|
3187
|
+
# The identifier of the index for your Amazon Kendra experience.
|
3188
|
+
#
|
3189
|
+
# @option params [String] :next_token
|
3190
|
+
# If the previous response was incomplete (because there is more data to
|
3191
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3192
|
+
# You can use this pagination token to retrieve the next set of users or
|
3193
|
+
# groups.
|
3194
|
+
#
|
3195
|
+
# @option params [Integer] :max_results
|
3196
|
+
# The maximum number of returned users or groups.
|
3197
|
+
#
|
3198
|
+
# @return [Types::ListEntityPersonasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3199
|
+
#
|
3200
|
+
# * {Types::ListEntityPersonasResponse#summary_items #summary_items} => Array<Types::PersonasSummary>
|
3201
|
+
# * {Types::ListEntityPersonasResponse#next_token #next_token} => String
|
3202
|
+
#
|
3203
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3204
|
+
#
|
3205
|
+
# @example Request syntax with placeholder values
|
3206
|
+
#
|
3207
|
+
# resp = client.list_entity_personas({
|
3208
|
+
# id: "ExperienceId", # required
|
3209
|
+
# index_id: "IndexId", # required
|
3210
|
+
# next_token: "NextToken",
|
3211
|
+
# max_results: 1,
|
3212
|
+
# })
|
3213
|
+
#
|
3214
|
+
# @example Response structure
|
3215
|
+
#
|
3216
|
+
# resp.summary_items #=> Array
|
3217
|
+
# resp.summary_items[0].entity_id #=> String
|
3218
|
+
# resp.summary_items[0].persona #=> String, one of "OWNER", "VIEWER"
|
3219
|
+
# resp.summary_items[0].created_at #=> Time
|
3220
|
+
# resp.summary_items[0].updated_at #=> Time
|
3221
|
+
# resp.next_token #=> String
|
3222
|
+
#
|
3223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonas AWS API Documentation
|
3224
|
+
#
|
3225
|
+
# @overload list_entity_personas(params = {})
|
3226
|
+
# @param [Hash] params ({})
|
3227
|
+
def list_entity_personas(params = {}, options = {})
|
3228
|
+
req = build_request(:list_entity_personas, params)
|
3229
|
+
req.send_request(options)
|
3230
|
+
end
|
3231
|
+
|
3232
|
+
# Lists users or groups in your Amazon Web Services SSO identity source
|
3233
|
+
# that are granted access to your Amazon Kendra experience. You can
|
3234
|
+
# create an Amazon Kendra experience such as a search application. For
|
3235
|
+
# more information on creating a search application experience, see
|
3236
|
+
# [Building a search experience with no code][1].
|
3237
|
+
#
|
3238
|
+
#
|
3239
|
+
#
|
3240
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
3241
|
+
#
|
3242
|
+
# @option params [required, String] :id
|
3243
|
+
# The identifier of your Amazon Kendra experience.
|
3244
|
+
#
|
3245
|
+
# @option params [required, String] :index_id
|
3246
|
+
# The identifier of the index for your Amazon Kendra experience.
|
3247
|
+
#
|
3248
|
+
# @option params [String] :next_token
|
3249
|
+
# If the previous response was incomplete (because there is more data to
|
3250
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3251
|
+
# You can use this pagination token to retrieve the next set of users or
|
3252
|
+
# groups.
|
3253
|
+
#
|
3254
|
+
# @return [Types::ListExperienceEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3255
|
+
#
|
3256
|
+
# * {Types::ListExperienceEntitiesResponse#summary_items #summary_items} => Array<Types::ExperienceEntitiesSummary>
|
3257
|
+
# * {Types::ListExperienceEntitiesResponse#next_token #next_token} => String
|
3258
|
+
#
|
3259
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3260
|
+
#
|
3261
|
+
# @example Request syntax with placeholder values
|
3262
|
+
#
|
3263
|
+
# resp = client.list_experience_entities({
|
3264
|
+
# id: "ExperienceId", # required
|
3265
|
+
# index_id: "IndexId", # required
|
3266
|
+
# next_token: "NextToken",
|
3267
|
+
# })
|
3268
|
+
#
|
3269
|
+
# @example Response structure
|
3270
|
+
#
|
3271
|
+
# resp.summary_items #=> Array
|
3272
|
+
# resp.summary_items[0].entity_id #=> String
|
3273
|
+
# resp.summary_items[0].entity_type #=> String, one of "USER", "GROUP"
|
3274
|
+
# resp.summary_items[0].display_data.user_name #=> String
|
3275
|
+
# resp.summary_items[0].display_data.group_name #=> String
|
3276
|
+
# resp.summary_items[0].display_data.identified_user_name #=> String
|
3277
|
+
# resp.summary_items[0].display_data.first_name #=> String
|
3278
|
+
# resp.summary_items[0].display_data.last_name #=> String
|
3279
|
+
# resp.next_token #=> String
|
3280
|
+
#
|
3281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntities AWS API Documentation
|
3282
|
+
#
|
3283
|
+
# @overload list_experience_entities(params = {})
|
3284
|
+
# @param [Hash] params ({})
|
3285
|
+
def list_experience_entities(params = {}, options = {})
|
3286
|
+
req = build_request(:list_experience_entities, params)
|
3287
|
+
req.send_request(options)
|
3288
|
+
end
|
3289
|
+
|
3290
|
+
# Lists one or more Amazon Kendra experiences. You can create an Amazon
|
3291
|
+
# Kendra experience such as a search application. For more information
|
3292
|
+
# on creating a search application experience, see [Building a search
|
3293
|
+
# experience with no code][1].
|
3294
|
+
#
|
3295
|
+
#
|
3296
|
+
#
|
3297
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
3298
|
+
#
|
3299
|
+
# @option params [required, String] :index_id
|
3300
|
+
# The identifier of the index for your Amazon Kendra experience.
|
3301
|
+
#
|
3302
|
+
# @option params [String] :next_token
|
3303
|
+
# If the previous response was incomplete (because there is more data to
|
3304
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3305
|
+
# You can use this pagination token to retrieve the next set of Amazon
|
3306
|
+
# Kendra experiences.
|
3307
|
+
#
|
3308
|
+
# @option params [Integer] :max_results
|
3309
|
+
# The maximum number of returned Amazon Kendra experiences.
|
3310
|
+
#
|
3311
|
+
# @return [Types::ListExperiencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3312
|
+
#
|
3313
|
+
# * {Types::ListExperiencesResponse#summary_items #summary_items} => Array<Types::ExperiencesSummary>
|
3314
|
+
# * {Types::ListExperiencesResponse#next_token #next_token} => String
|
3315
|
+
#
|
3316
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3317
|
+
#
|
3318
|
+
# @example Request syntax with placeholder values
|
3319
|
+
#
|
3320
|
+
# resp = client.list_experiences({
|
3321
|
+
# index_id: "IndexId", # required
|
3322
|
+
# next_token: "NextToken",
|
3323
|
+
# max_results: 1,
|
3324
|
+
# })
|
3325
|
+
#
|
3326
|
+
# @example Response structure
|
3327
|
+
#
|
3328
|
+
# resp.summary_items #=> Array
|
3329
|
+
# resp.summary_items[0].name #=> String
|
3330
|
+
# resp.summary_items[0].id #=> String
|
3331
|
+
# resp.summary_items[0].created_at #=> Time
|
3332
|
+
# resp.summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
|
3333
|
+
# resp.summary_items[0].endpoints #=> Array
|
3334
|
+
# resp.summary_items[0].endpoints[0].endpoint_type #=> String, one of "HOME"
|
3335
|
+
# resp.summary_items[0].endpoints[0].endpoint #=> String
|
3336
|
+
# resp.next_token #=> String
|
3337
|
+
#
|
3338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiences AWS API Documentation
|
3339
|
+
#
|
3340
|
+
# @overload list_experiences(params = {})
|
3341
|
+
# @param [Hash] params ({})
|
3342
|
+
def list_experiences(params = {}, options = {})
|
3343
|
+
req = build_request(:list_experiences, params)
|
3344
|
+
req.send_request(options)
|
3345
|
+
end
|
3346
|
+
|
2483
3347
|
# Gets a list of FAQ lists associated with an index.
|
2484
3348
|
#
|
2485
3349
|
# @option params [required, String] :index_id
|
@@ -2532,6 +3396,9 @@ module Aws::Kendra
|
|
2532
3396
|
# Provides a list of groups that are mapped to users before a given
|
2533
3397
|
# ordering or timestamp identifier.
|
2534
3398
|
#
|
3399
|
+
# `ListGroupsOlderThanOrderingId` is currently not supported in the
|
3400
|
+
# Amazon Web Services GovCloud (US-West) region.
|
3401
|
+
#
|
2535
3402
|
# @option params [required, String] :index_id
|
2536
3403
|
# The identifier of the index for getting a list of groups mapped to
|
2537
3404
|
# users before a given ordering or timestamp identifier.
|
@@ -2636,6 +3503,9 @@ module Aws::Kendra
|
|
2636
3503
|
# For information on the current quota limits for block lists, see
|
2637
3504
|
# [Quotas for Amazon Kendra][1].
|
2638
3505
|
#
|
3506
|
+
# `ListQuerySuggestionsBlockLists` is currently not supported in the
|
3507
|
+
# Amazon Web Services GovCloud (US-West) region.
|
3508
|
+
#
|
2639
3509
|
#
|
2640
3510
|
#
|
2641
3511
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
@@ -2790,6 +3660,9 @@ module Aws::Kendra
|
|
2790
3660
|
# If more than five `PUT` actions for a group are currently processing,
|
2791
3661
|
# a validation exception is thrown.
|
2792
3662
|
#
|
3663
|
+
# `PutPrincipalMapping` is currently not supported in the Amazon Web
|
3664
|
+
# Services GovCloud (US-West) region.
|
3665
|
+
#
|
2793
3666
|
#
|
2794
3667
|
#
|
2795
3668
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
|
@@ -2917,7 +3790,7 @@ module Aws::Kendra
|
|
2917
3790
|
# The unique identifier of the index to search. The identifier is
|
2918
3791
|
# returned in the response from the `CreateIndex` operation.
|
2919
3792
|
#
|
2920
|
-
# @option params [
|
3793
|
+
# @option params [String] :query_text
|
2921
3794
|
# The text to search for.
|
2922
3795
|
#
|
2923
3796
|
# @option params [Types::AttributeFilter] :attribute_filter
|
@@ -2996,12 +3869,13 @@ module Aws::Kendra
|
|
2996
3869
|
# * {Types::QueryResult#result_items #result_items} => Array<Types::QueryResultItem>
|
2997
3870
|
# * {Types::QueryResult#facet_results #facet_results} => Array<Types::FacetResult>
|
2998
3871
|
# * {Types::QueryResult#total_number_of_results #total_number_of_results} => Integer
|
3872
|
+
# * {Types::QueryResult#warnings #warnings} => Array<Types::Warning>
|
2999
3873
|
#
|
3000
3874
|
# @example Request syntax with placeholder values
|
3001
3875
|
#
|
3002
3876
|
# resp = client.query({
|
3003
3877
|
# index_id: "IndexId", # required
|
3004
|
-
# query_text: "QueryText",
|
3878
|
+
# query_text: "QueryText",
|
3005
3879
|
# attribute_filter: {
|
3006
3880
|
# and_all_filters: [
|
3007
3881
|
# {
|
@@ -3170,6 +4044,9 @@ module Aws::Kendra
|
|
3170
4044
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.date_value #=> Time
|
3171
4045
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].count #=> Integer
|
3172
4046
|
# resp.total_number_of_results #=> Integer
|
4047
|
+
# resp.warnings #=> Array
|
4048
|
+
# resp.warnings[0].message #=> String
|
4049
|
+
# resp.warnings[0].code #=> String, one of "QUERY_LANGUAGE_INVALID_SYNTAX"
|
3173
4050
|
#
|
3174
4051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query AWS API Documentation
|
3175
4052
|
#
|
@@ -3245,6 +4122,9 @@ module Aws::Kendra
|
|
3245
4122
|
# Enables you to provide feedback to Amazon Kendra to improve the
|
3246
4123
|
# performance of your index.
|
3247
4124
|
#
|
4125
|
+
# `SubmitFeedback` is currently not supported in the Amazon Web Services
|
4126
|
+
# GovCloud (US-West) region.
|
4127
|
+
#
|
3248
4128
|
# @option params [required, String] :index_id
|
3249
4129
|
# The identifier of the index that was queried.
|
3250
4130
|
#
|
@@ -3368,7 +4248,7 @@ module Aws::Kendra
|
|
3368
4248
|
# The identifier of the index that contains the data source to update.
|
3369
4249
|
#
|
3370
4250
|
# @option params [Types::DataSourceConfiguration] :configuration
|
3371
|
-
# Configuration information for
|
4251
|
+
# Configuration information for an Amazon Kendra data source.
|
3372
4252
|
#
|
3373
4253
|
# @option params [String] :description
|
3374
4254
|
# The new description for the data source.
|
@@ -3390,6 +4270,19 @@ module Aws::Kendra
|
|
3390
4270
|
#
|
3391
4271
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
3392
4272
|
#
|
4273
|
+
# @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
|
4274
|
+
# Configuration information for altering document metadata and content
|
4275
|
+
# during the document ingestion process when you update a data source.
|
4276
|
+
#
|
4277
|
+
# For more information on how to create, modify and delete document
|
4278
|
+
# metadata, or make other content alterations when you ingest documents
|
4279
|
+
# into Amazon Kendra, see [Customizing document metadata during the
|
4280
|
+
# ingestion process][1].
|
4281
|
+
#
|
4282
|
+
#
|
4283
|
+
#
|
4284
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
|
4285
|
+
#
|
3393
4286
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3394
4287
|
#
|
3395
4288
|
# @example Request syntax with placeholder values
|
@@ -3714,6 +4607,62 @@ module Aws::Kendra
|
|
3714
4607
|
# schedule: "ScanSchedule",
|
3715
4608
|
# role_arn: "RoleArn",
|
3716
4609
|
# language_code: "LanguageCode",
|
4610
|
+
# custom_document_enrichment_configuration: {
|
4611
|
+
# inline_configurations: [
|
4612
|
+
# {
|
4613
|
+
# condition: {
|
4614
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
4615
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
4616
|
+
# condition_on_value: {
|
4617
|
+
# string_value: "DocumentAttributeStringValue",
|
4618
|
+
# string_list_value: ["String"],
|
4619
|
+
# long_value: 1,
|
4620
|
+
# date_value: Time.now,
|
4621
|
+
# },
|
4622
|
+
# },
|
4623
|
+
# target: {
|
4624
|
+
# target_document_attribute_key: "DocumentAttributeKey",
|
4625
|
+
# target_document_attribute_value_deletion: false,
|
4626
|
+
# target_document_attribute_value: {
|
4627
|
+
# string_value: "DocumentAttributeStringValue",
|
4628
|
+
# string_list_value: ["String"],
|
4629
|
+
# long_value: 1,
|
4630
|
+
# date_value: Time.now,
|
4631
|
+
# },
|
4632
|
+
# },
|
4633
|
+
# document_content_deletion: false,
|
4634
|
+
# },
|
4635
|
+
# ],
|
4636
|
+
# pre_extraction_hook_configuration: {
|
4637
|
+
# invocation_condition: {
|
4638
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
4639
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
4640
|
+
# condition_on_value: {
|
4641
|
+
# string_value: "DocumentAttributeStringValue",
|
4642
|
+
# string_list_value: ["String"],
|
4643
|
+
# long_value: 1,
|
4644
|
+
# date_value: Time.now,
|
4645
|
+
# },
|
4646
|
+
# },
|
4647
|
+
# lambda_arn: "LambdaArn", # required
|
4648
|
+
# s3_bucket: "S3BucketName", # required
|
4649
|
+
# },
|
4650
|
+
# post_extraction_hook_configuration: {
|
4651
|
+
# invocation_condition: {
|
4652
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
4653
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
4654
|
+
# condition_on_value: {
|
4655
|
+
# string_value: "DocumentAttributeStringValue",
|
4656
|
+
# string_list_value: ["String"],
|
4657
|
+
# long_value: 1,
|
4658
|
+
# date_value: Time.now,
|
4659
|
+
# },
|
4660
|
+
# },
|
4661
|
+
# lambda_arn: "LambdaArn", # required
|
4662
|
+
# s3_bucket: "S3BucketName", # required
|
4663
|
+
# },
|
4664
|
+
# role_arn: "RoleArn",
|
4665
|
+
# },
|
3717
4666
|
# })
|
3718
4667
|
#
|
3719
4668
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource AWS API Documentation
|
@@ -3725,6 +4674,74 @@ module Aws::Kendra
|
|
3725
4674
|
req.send_request(options)
|
3726
4675
|
end
|
3727
4676
|
|
4677
|
+
# Updates your Amazon Kendra experience such as a search application.
|
4678
|
+
# For more information on creating a search application experience, see
|
4679
|
+
# [Building a search experience with no code][1].
|
4680
|
+
#
|
4681
|
+
#
|
4682
|
+
#
|
4683
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
4684
|
+
#
|
4685
|
+
# @option params [required, String] :id
|
4686
|
+
# The identifier of your Amazon Kendra experience you want to update.
|
4687
|
+
#
|
4688
|
+
# @option params [String] :name
|
4689
|
+
# The name of your Amazon Kendra experience you want to update.
|
4690
|
+
#
|
4691
|
+
# @option params [required, String] :index_id
|
4692
|
+
# The identifier of the index for your Amazon Kendra experience you want
|
4693
|
+
# to update.
|
4694
|
+
#
|
4695
|
+
# @option params [String] :role_arn
|
4696
|
+
# The Amazon Resource Name (ARN) of a role with permission to access
|
4697
|
+
# `Query` operations, `QuerySuggestions` operations, `SubmitFeedback`
|
4698
|
+
# operations, and Amazon Web Services SSO that stores your user and
|
4699
|
+
# group information. For more information, see [IAM roles for Amazon
|
4700
|
+
# Kendra][1].
|
4701
|
+
#
|
4702
|
+
#
|
4703
|
+
#
|
4704
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
4705
|
+
#
|
4706
|
+
# @option params [Types::ExperienceConfiguration] :configuration
|
4707
|
+
# Provides the user configuration information. This includes the Amazon
|
4708
|
+
# Web Services SSO field name that contains the identifiers of your
|
4709
|
+
# users, such as their emails.
|
4710
|
+
#
|
4711
|
+
# @option params [String] :description
|
4712
|
+
# The description of your Amazon Kendra experience you want to update.
|
4713
|
+
#
|
4714
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4715
|
+
#
|
4716
|
+
# @example Request syntax with placeholder values
|
4717
|
+
#
|
4718
|
+
# resp = client.update_experience({
|
4719
|
+
# id: "ExperienceId", # required
|
4720
|
+
# name: "ExperienceName",
|
4721
|
+
# index_id: "IndexId", # required
|
4722
|
+
# role_arn: "RoleArn",
|
4723
|
+
# configuration: {
|
4724
|
+
# content_source_configuration: {
|
4725
|
+
# data_source_ids: ["DataSourceId"],
|
4726
|
+
# faq_ids: ["FaqId"],
|
4727
|
+
# direct_put_content: false,
|
4728
|
+
# },
|
4729
|
+
# user_identity_configuration: {
|
4730
|
+
# identity_attribute_name: "IdentityAttributeName",
|
4731
|
+
# },
|
4732
|
+
# },
|
4733
|
+
# description: "Description",
|
4734
|
+
# })
|
4735
|
+
#
|
4736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperience AWS API Documentation
|
4737
|
+
#
|
4738
|
+
# @overload update_experience(params = {})
|
4739
|
+
# @param [Hash] params ({})
|
4740
|
+
def update_experience(params = {}, options = {})
|
4741
|
+
req = build_request(:update_experience, params)
|
4742
|
+
req.send_request(options)
|
4743
|
+
end
|
4744
|
+
|
3728
4745
|
# Updates an existing Amazon Kendra index.
|
3729
4746
|
#
|
3730
4747
|
# @option params [required, String] :id
|
@@ -3758,8 +4775,8 @@ module Aws::Kendra
|
|
3758
4775
|
# The user context policy.
|
3759
4776
|
#
|
3760
4777
|
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
3761
|
-
# Enables fetching access levels of groups and users from an
|
3762
|
-
# Sign
|
4778
|
+
# Enables fetching access levels of groups and users from an Amazon Web
|
4779
|
+
# Services Single Sign On identity source. To configure this, see
|
3763
4780
|
# [UserGroupResolutionConfiguration][1].
|
3764
4781
|
#
|
3765
4782
|
#
|
@@ -3845,6 +4862,9 @@ module Aws::Kendra
|
|
3845
4862
|
# Amazon Kendra supports partial updates, so you only need to provide
|
3846
4863
|
# the fields you want to update.
|
3847
4864
|
#
|
4865
|
+
# `UpdateQuerySuggestionsBlockList` is currently not supported in the
|
4866
|
+
# Amazon Web Services GovCloud (US-West) region.
|
4867
|
+
#
|
3848
4868
|
# @option params [required, String] :index_id
|
3849
4869
|
# The identifier of the index for a block list.
|
3850
4870
|
#
|
@@ -3913,6 +4933,9 @@ module Aws::Kendra
|
|
3913
4933
|
#
|
3914
4934
|
# You can still enable/disable query suggestions at any time.
|
3915
4935
|
#
|
4936
|
+
# `UpdateQuerySuggestionsConfig` is currently not supported in the
|
4937
|
+
# Amazon Web Services GovCloud (US-West) region.
|
4938
|
+
#
|
3916
4939
|
# @option params [required, String] :index_id
|
3917
4940
|
# The identifier of the index you want to update query suggestions
|
3918
4941
|
# settings for.
|
@@ -4051,7 +5074,7 @@ module Aws::Kendra
|
|
4051
5074
|
params: params,
|
4052
5075
|
config: config)
|
4053
5076
|
context[:gem_name] = 'aws-sdk-kendra'
|
4054
|
-
context[:gem_version] = '1.
|
5077
|
+
context[:gem_version] = '1.42.0'
|
4055
5078
|
Seahorse::Client::Request.new(handlers, context)
|
4056
5079
|
end
|
4057
5080
|
|