aws-sdk-kendra 1.37.0 → 1.41.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 +1035 -11
- data/lib/aws-sdk-kendra/client_api.rb +483 -0
- data/lib/aws-sdk-kendra/errors.rb +16 -0
- data/lib/aws-sdk-kendra/types.rb +1898 -102
- 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.
|
@@ -285,6 +293,15 @@ module Aws::Kendra
|
|
285
293
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
294
|
# requests are made, and retries are disabled.
|
287
295
|
#
|
296
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
297
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
298
|
+
# will be used if available.
|
299
|
+
#
|
300
|
+
# @option options [Boolean] :use_fips_endpoint
|
301
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
302
|
+
# When a `fips` region is used, the region is normalized and this config
|
303
|
+
# is set to `true`.
|
304
|
+
#
|
288
305
|
# @option options [Boolean] :validate_params (true)
|
289
306
|
# When `true`, request parameters are validated before
|
290
307
|
# sending the request.
|
@@ -296,7 +313,7 @@ module Aws::Kendra
|
|
296
313
|
# seconds to wait when opening a HTTP session before raising a
|
297
314
|
# `Timeout::Error`.
|
298
315
|
#
|
299
|
-
# @option options [
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
300
317
|
# number of seconds to wait for response data. This value can
|
301
318
|
# safely be set per-request on the session.
|
302
319
|
#
|
@@ -312,6 +329,9 @@ module Aws::Kendra
|
|
312
329
|
# disables this behaviour. This value can safely be set per
|
313
330
|
# request on the session.
|
314
331
|
#
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
333
|
+
# in seconds.
|
334
|
+
#
|
315
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
336
|
# HTTP debug output will be sent to the `:logger`.
|
317
337
|
#
|
@@ -337,6 +357,117 @@ module Aws::Kendra
|
|
337
357
|
|
338
358
|
# @!group API Operations
|
339
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
|
+
|
340
471
|
# Removes one or more documents from an index. The documents must have
|
341
472
|
# been added with the `BatchPutDocument` operation.
|
342
473
|
#
|
@@ -514,6 +645,20 @@ module Aws::Kendra
|
|
514
645
|
#
|
515
646
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
516
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
|
+
#
|
517
662
|
# @return [Types::BatchPutDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
518
663
|
#
|
519
664
|
# * {Types::BatchPutDocumentResponse#failed_documents #failed_documents} => Array<Types::BatchPutDocumentResponseFailedDocument>
|
@@ -566,6 +711,62 @@ module Aws::Kendra
|
|
566
711
|
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
567
712
|
# },
|
568
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
|
+
# },
|
569
770
|
# })
|
570
771
|
#
|
571
772
|
# @example Response structure
|
@@ -592,6 +793,9 @@ module Aws::Kendra
|
|
592
793
|
# suggestions. If you do not see any new suggestions, then please allow
|
593
794
|
# Amazon Kendra to collect enough queries to learn new suggestions.
|
594
795
|
#
|
796
|
+
# `ClearQuerySuggestions` is currently not supported in the Amazon Web
|
797
|
+
# Services GovCloud (US-West) region.
|
798
|
+
#
|
595
799
|
# @option params [required, String] :index_id
|
596
800
|
# The identifier of the index you want to clear query suggestions from.
|
597
801
|
#
|
@@ -623,6 +827,13 @@ module Aws::Kendra
|
|
623
827
|
# 200 if the data source was successfully created. Otherwise, an
|
624
828
|
# exception is raised.
|
625
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
|
+
#
|
626
837
|
# @option params [required, String] :name
|
627
838
|
# A unique name for the data source. A data source name can't be
|
628
839
|
# changed without deleting and recreating the data source.
|
@@ -695,6 +906,19 @@ module Aws::Kendra
|
|
695
906
|
#
|
696
907
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
697
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
|
+
#
|
698
922
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
699
923
|
#
|
700
924
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -1028,6 +1252,62 @@ module Aws::Kendra
|
|
1028
1252
|
# ],
|
1029
1253
|
# client_token: "ClientTokenName",
|
1030
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
|
+
# },
|
1031
1311
|
# })
|
1032
1312
|
#
|
1033
1313
|
# @example Response structure
|
@@ -1043,6 +1323,86 @@ module Aws::Kendra
|
|
1043
1323
|
req.send_request(options)
|
1044
1324
|
end
|
1045
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
|
+
|
1046
1406
|
# Creates an new set of frequently asked question (FAQ) questions and
|
1047
1407
|
# answers.
|
1048
1408
|
#
|
@@ -1219,8 +1579,8 @@ module Aws::Kendra
|
|
1219
1579
|
# accessible to the user will be searchable and displayable.
|
1220
1580
|
#
|
1221
1581
|
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
1222
|
-
# Enables fetching access levels of groups and users from an
|
1223
|
-
# Sign
|
1582
|
+
# Enables fetching access levels of groups and users from an Amazon Web
|
1583
|
+
# Services Single Sign On identity source. To configure this, see
|
1224
1584
|
# [UserGroupResolutionConfiguration][1].
|
1225
1585
|
#
|
1226
1586
|
#
|
@@ -1296,6 +1656,9 @@ module Aws::Kendra
|
|
1296
1656
|
# For information on the current quota limits for block lists, see
|
1297
1657
|
# [Quotas for Amazon Kendra][1].
|
1298
1658
|
#
|
1659
|
+
# `CreateQuerySuggestionsBlockList` is currently not supported in the
|
1660
|
+
# Amazon Web Services GovCloud (US-West) region.
|
1661
|
+
#
|
1299
1662
|
#
|
1300
1663
|
#
|
1301
1664
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
@@ -1398,9 +1761,8 @@ module Aws::Kendra
|
|
1398
1761
|
# The description for the new thesaurus.
|
1399
1762
|
#
|
1400
1763
|
# @option params [required, String] :role_arn
|
1401
|
-
# An
|
1402
|
-
#
|
1403
|
-
# `SourceS3Path`.
|
1764
|
+
# An IAM role that gives Amazon Kendra permissions to access thesaurus
|
1765
|
+
# file specified in `SourceS3Path`.
|
1404
1766
|
#
|
1405
1767
|
# @option params [Array<Types::Tag>] :tags
|
1406
1768
|
# A list of key-value pairs that identify the thesaurus. You can use the
|
@@ -1489,6 +1851,39 @@ module Aws::Kendra
|
|
1489
1851
|
req.send_request(options)
|
1490
1852
|
end
|
1491
1853
|
|
1854
|
+
# Deletes your Amazon Kendra experience such as a search application.
|
1855
|
+
# For more information on creating a search application experience, see
|
1856
|
+
# [Building a search experience with no code][1].
|
1857
|
+
#
|
1858
|
+
#
|
1859
|
+
#
|
1860
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
1861
|
+
#
|
1862
|
+
# @option params [required, String] :id
|
1863
|
+
# The identifier of your Amazon Kendra experience you want to delete.
|
1864
|
+
#
|
1865
|
+
# @option params [required, String] :index_id
|
1866
|
+
# The identifier of the index for your Amazon Kendra experience you want
|
1867
|
+
# to delete.
|
1868
|
+
#
|
1869
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1870
|
+
#
|
1871
|
+
# @example Request syntax with placeholder values
|
1872
|
+
#
|
1873
|
+
# resp = client.delete_experience({
|
1874
|
+
# id: "ExperienceId", # required
|
1875
|
+
# index_id: "IndexId", # required
|
1876
|
+
# })
|
1877
|
+
#
|
1878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperience AWS API Documentation
|
1879
|
+
#
|
1880
|
+
# @overload delete_experience(params = {})
|
1881
|
+
# @param [Hash] params ({})
|
1882
|
+
def delete_experience(params = {}, options = {})
|
1883
|
+
req = build_request(:delete_experience, params)
|
1884
|
+
req.send_request(options)
|
1885
|
+
end
|
1886
|
+
|
1492
1887
|
# Removes an FAQ from an index.
|
1493
1888
|
#
|
1494
1889
|
# @option params [required, String] :id
|
@@ -1555,6 +1950,9 @@ module Aws::Kendra
|
|
1555
1950
|
# `PutPrincipalMapping`. You can update your internal list of users or
|
1556
1951
|
# sub groups and input this list when calling `PutPrincipalMapping`.
|
1557
1952
|
#
|
1953
|
+
# `DeletePrincipalMapping` is currently not supported in the Amazon Web
|
1954
|
+
# Services GovCloud (US-West) region.
|
1955
|
+
#
|
1558
1956
|
# @option params [required, String] :index_id
|
1559
1957
|
# The identifier of the index you want to delete a group from.
|
1560
1958
|
#
|
@@ -1618,6 +2016,9 @@ module Aws::Kendra
|
|
1618
2016
|
# needs to refresh the entire suggestions list to add back the queries
|
1619
2017
|
# that were previously blocked.
|
1620
2018
|
#
|
2019
|
+
# `DeleteQuerySuggestionsBlockList` is currently not supported in the
|
2020
|
+
# Amazon Web Services GovCloud (US-West) region.
|
2021
|
+
#
|
1621
2022
|
# @option params [required, String] :index_id
|
1622
2023
|
# The identifier of the you want to delete a block list from.
|
1623
2024
|
#
|
@@ -1691,6 +2092,7 @@ module Aws::Kendra
|
|
1691
2092
|
# * {Types::DescribeDataSourceResponse#role_arn #role_arn} => String
|
1692
2093
|
# * {Types::DescribeDataSourceResponse#error_message #error_message} => String
|
1693
2094
|
# * {Types::DescribeDataSourceResponse#language_code #language_code} => String
|
2095
|
+
# * {Types::DescribeDataSourceResponse#custom_document_enrichment_configuration #custom_document_enrichment_configuration} => Types::CustomDocumentEnrichmentConfiguration
|
1694
2096
|
#
|
1695
2097
|
# @example Request syntax with placeholder values
|
1696
2098
|
#
|
@@ -1931,6 +2333,41 @@ module Aws::Kendra
|
|
1931
2333
|
# resp.role_arn #=> String
|
1932
2334
|
# resp.error_message #=> String
|
1933
2335
|
# resp.language_code #=> String
|
2336
|
+
# resp.custom_document_enrichment_configuration.inline_configurations #=> Array
|
2337
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_document_attribute_key #=> String
|
2338
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.operator #=> String, one of "GreaterThan", "GreaterThanOrEquals", "LessThan", "LessThanOrEquals", "Equals", "NotEquals", "Contains", "NotContains", "Exists", "NotExists", "BeginsWith"
|
2339
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.string_value #=> String
|
2340
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.string_list_value #=> Array
|
2341
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.string_list_value[0] #=> String
|
2342
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.long_value #=> Integer
|
2343
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].condition.condition_on_value.date_value #=> Time
|
2344
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_key #=> String
|
2345
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value_deletion #=> Boolean
|
2346
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.string_value #=> String
|
2347
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.string_list_value #=> Array
|
2348
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.string_list_value[0] #=> String
|
2349
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.long_value #=> Integer
|
2350
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].target.target_document_attribute_value.date_value #=> Time
|
2351
|
+
# resp.custom_document_enrichment_configuration.inline_configurations[0].document_content_deletion #=> Boolean
|
2352
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_document_attribute_key #=> String
|
2353
|
+
# 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"
|
2354
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.string_value #=> String
|
2355
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value #=> Array
|
2356
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value[0] #=> String
|
2357
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.long_value #=> Integer
|
2358
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.invocation_condition.condition_on_value.date_value #=> Time
|
2359
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.lambda_arn #=> String
|
2360
|
+
# resp.custom_document_enrichment_configuration.pre_extraction_hook_configuration.s3_bucket #=> String
|
2361
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_document_attribute_key #=> String
|
2362
|
+
# 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"
|
2363
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.string_value #=> String
|
2364
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value #=> Array
|
2365
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.string_list_value[0] #=> String
|
2366
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.long_value #=> Integer
|
2367
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition.condition_on_value.date_value #=> Time
|
2368
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.lambda_arn #=> String
|
2369
|
+
# resp.custom_document_enrichment_configuration.post_extraction_hook_configuration.s3_bucket #=> String
|
2370
|
+
# resp.custom_document_enrichment_configuration.role_arn #=> String
|
1934
2371
|
#
|
1935
2372
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource AWS API Documentation
|
1936
2373
|
#
|
@@ -1941,6 +2378,73 @@ module Aws::Kendra
|
|
1941
2378
|
req.send_request(options)
|
1942
2379
|
end
|
1943
2380
|
|
2381
|
+
# Gets information about your Amazon Kendra experience such as a search
|
2382
|
+
# application. For more information on creating a search application
|
2383
|
+
# experience, see [Building a search experience with no code][1].
|
2384
|
+
#
|
2385
|
+
#
|
2386
|
+
#
|
2387
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
2388
|
+
#
|
2389
|
+
# @option params [required, String] :id
|
2390
|
+
# The identifier of your Amazon Kendra experience you want to get
|
2391
|
+
# information on.
|
2392
|
+
#
|
2393
|
+
# @option params [required, String] :index_id
|
2394
|
+
# The identifier of the index for your Amazon Kendra experience you want
|
2395
|
+
# to get information on.
|
2396
|
+
#
|
2397
|
+
# @return [Types::DescribeExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2398
|
+
#
|
2399
|
+
# * {Types::DescribeExperienceResponse#id #id} => String
|
2400
|
+
# * {Types::DescribeExperienceResponse#index_id #index_id} => String
|
2401
|
+
# * {Types::DescribeExperienceResponse#name #name} => String
|
2402
|
+
# * {Types::DescribeExperienceResponse#endpoints #endpoints} => Array<Types::ExperienceEndpoint>
|
2403
|
+
# * {Types::DescribeExperienceResponse#configuration #configuration} => Types::ExperienceConfiguration
|
2404
|
+
# * {Types::DescribeExperienceResponse#created_at #created_at} => Time
|
2405
|
+
# * {Types::DescribeExperienceResponse#updated_at #updated_at} => Time
|
2406
|
+
# * {Types::DescribeExperienceResponse#description #description} => String
|
2407
|
+
# * {Types::DescribeExperienceResponse#status #status} => String
|
2408
|
+
# * {Types::DescribeExperienceResponse#role_arn #role_arn} => String
|
2409
|
+
# * {Types::DescribeExperienceResponse#error_message #error_message} => String
|
2410
|
+
#
|
2411
|
+
# @example Request syntax with placeholder values
|
2412
|
+
#
|
2413
|
+
# resp = client.describe_experience({
|
2414
|
+
# id: "ExperienceId", # required
|
2415
|
+
# index_id: "IndexId", # required
|
2416
|
+
# })
|
2417
|
+
#
|
2418
|
+
# @example Response structure
|
2419
|
+
#
|
2420
|
+
# resp.id #=> String
|
2421
|
+
# resp.index_id #=> String
|
2422
|
+
# resp.name #=> String
|
2423
|
+
# resp.endpoints #=> Array
|
2424
|
+
# resp.endpoints[0].endpoint_type #=> String, one of "HOME"
|
2425
|
+
# resp.endpoints[0].endpoint #=> String
|
2426
|
+
# resp.configuration.content_source_configuration.data_source_ids #=> Array
|
2427
|
+
# resp.configuration.content_source_configuration.data_source_ids[0] #=> String
|
2428
|
+
# resp.configuration.content_source_configuration.faq_ids #=> Array
|
2429
|
+
# resp.configuration.content_source_configuration.faq_ids[0] #=> String
|
2430
|
+
# resp.configuration.content_source_configuration.direct_put_content #=> Boolean
|
2431
|
+
# resp.configuration.user_identity_configuration.identity_attribute_name #=> String
|
2432
|
+
# resp.created_at #=> Time
|
2433
|
+
# resp.updated_at #=> Time
|
2434
|
+
# resp.description #=> String
|
2435
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
|
2436
|
+
# resp.role_arn #=> String
|
2437
|
+
# resp.error_message #=> String
|
2438
|
+
#
|
2439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperience AWS API Documentation
|
2440
|
+
#
|
2441
|
+
# @overload describe_experience(params = {})
|
2442
|
+
# @param [Hash] params ({})
|
2443
|
+
def describe_experience(params = {}, options = {})
|
2444
|
+
req = build_request(:describe_experience, params)
|
2445
|
+
req.send_request(options)
|
2446
|
+
end
|
2447
|
+
|
1944
2448
|
# Gets information about an FAQ list.
|
1945
2449
|
#
|
1946
2450
|
# @option params [required, String] :id
|
@@ -2085,6 +2589,9 @@ module Aws::Kendra
|
|
2085
2589
|
# action that should process and apply after other actions, and useful
|
2086
2590
|
# error messages if an action could not be processed.
|
2087
2591
|
#
|
2592
|
+
# `DescribePrincipalMapping` is currently not supported in the Amazon
|
2593
|
+
# Web Services GovCloud (US-West) region.
|
2594
|
+
#
|
2088
2595
|
# @option params [required, String] :index_id
|
2089
2596
|
# The identifier of the index required to check the processing of `PUT`
|
2090
2597
|
# and `DELETE` actions for mapping users to their groups.
|
@@ -2138,6 +2645,9 @@ module Aws::Kendra
|
|
2138
2645
|
# This is used to check the current settings that are applied to a block
|
2139
2646
|
# list.
|
2140
2647
|
#
|
2648
|
+
# `DescribeQuerySuggestionsBlockList` is currently not supported in the
|
2649
|
+
# Amazon Web Services GovCloud (US-West) region.
|
2650
|
+
#
|
2141
2651
|
# @option params [required, String] :index_id
|
2142
2652
|
# The identifier of the index for the block list.
|
2143
2653
|
#
|
@@ -2196,6 +2706,9 @@ module Aws::Kendra
|
|
2196
2706
|
# This is used to check the current settings applied to query
|
2197
2707
|
# suggestions.
|
2198
2708
|
#
|
2709
|
+
# `DescribeQuerySuggestionsConfig` is currently not supported in the
|
2710
|
+
# Amazon Web Services GovCloud (US-West) region.
|
2711
|
+
#
|
2199
2712
|
# @option params [required, String] :index_id
|
2200
2713
|
# The identifier of the index you want to describe query suggestions
|
2201
2714
|
# settings for.
|
@@ -2296,8 +2809,110 @@ module Aws::Kendra
|
|
2296
2809
|
req.send_request(options)
|
2297
2810
|
end
|
2298
2811
|
|
2812
|
+
# Prevents users or groups in your Amazon Web Services SSO identity
|
2813
|
+
# source from accessing your Amazon Kendra experience. You can create an
|
2814
|
+
# Amazon Kendra experience such as a search application. For more
|
2815
|
+
# information on creating a search application experience, see [Building
|
2816
|
+
# a search experience with no code][1].
|
2817
|
+
#
|
2818
|
+
#
|
2819
|
+
#
|
2820
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
2821
|
+
#
|
2822
|
+
# @option params [required, String] :id
|
2823
|
+
# The identifier of your Amazon Kendra experience.
|
2824
|
+
#
|
2825
|
+
# @option params [required, String] :index_id
|
2826
|
+
# The identifier of the index for your Amazon Kendra experience.
|
2827
|
+
#
|
2828
|
+
# @option params [required, Array<Types::EntityConfiguration>] :entity_list
|
2829
|
+
# Lists users or groups in your Amazon Web Services SSO identity source.
|
2830
|
+
#
|
2831
|
+
# @return [Types::DisassociateEntitiesFromExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2832
|
+
#
|
2833
|
+
# * {Types::DisassociateEntitiesFromExperienceResponse#failed_entity_list #failed_entity_list} => Array<Types::FailedEntity>
|
2834
|
+
#
|
2835
|
+
# @example Request syntax with placeholder values
|
2836
|
+
#
|
2837
|
+
# resp = client.disassociate_entities_from_experience({
|
2838
|
+
# id: "ExperienceId", # required
|
2839
|
+
# index_id: "IndexId", # required
|
2840
|
+
# entity_list: [ # required
|
2841
|
+
# {
|
2842
|
+
# entity_id: "EntityId", # required
|
2843
|
+
# entity_type: "USER", # required, accepts USER, GROUP
|
2844
|
+
# },
|
2845
|
+
# ],
|
2846
|
+
# })
|
2847
|
+
#
|
2848
|
+
# @example Response structure
|
2849
|
+
#
|
2850
|
+
# resp.failed_entity_list #=> Array
|
2851
|
+
# resp.failed_entity_list[0].entity_id #=> String
|
2852
|
+
# resp.failed_entity_list[0].error_message #=> String
|
2853
|
+
#
|
2854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperience AWS API Documentation
|
2855
|
+
#
|
2856
|
+
# @overload disassociate_entities_from_experience(params = {})
|
2857
|
+
# @param [Hash] params ({})
|
2858
|
+
def disassociate_entities_from_experience(params = {}, options = {})
|
2859
|
+
req = build_request(:disassociate_entities_from_experience, params)
|
2860
|
+
req.send_request(options)
|
2861
|
+
end
|
2862
|
+
|
2863
|
+
# Removes the specific permissions of users or groups in your Amazon Web
|
2864
|
+
# Services SSO identity source with access to your Amazon Kendra
|
2865
|
+
# experience. You can create an Amazon Kendra experience such as a
|
2866
|
+
# search application. For more information on creating a search
|
2867
|
+
# application experience, see [Building a search experience with no
|
2868
|
+
# code][1].
|
2869
|
+
#
|
2870
|
+
#
|
2871
|
+
#
|
2872
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
2873
|
+
#
|
2874
|
+
# @option params [required, String] :id
|
2875
|
+
# The identifier of your Amazon Kendra experience.
|
2876
|
+
#
|
2877
|
+
# @option params [required, String] :index_id
|
2878
|
+
# The identifier of the index for your Amazon Kendra experience.
|
2879
|
+
#
|
2880
|
+
# @option params [required, Array<String>] :entity_ids
|
2881
|
+
# The identifiers of users or groups in your Amazon Web Services SSO
|
2882
|
+
# identity source. For example, user IDs could be user emails.
|
2883
|
+
#
|
2884
|
+
# @return [Types::DisassociatePersonasFromEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2885
|
+
#
|
2886
|
+
# * {Types::DisassociatePersonasFromEntitiesResponse#failed_entity_list #failed_entity_list} => Array<Types::FailedEntity>
|
2887
|
+
#
|
2888
|
+
# @example Request syntax with placeholder values
|
2889
|
+
#
|
2890
|
+
# resp = client.disassociate_personas_from_entities({
|
2891
|
+
# id: "ExperienceId", # required
|
2892
|
+
# index_id: "IndexId", # required
|
2893
|
+
# entity_ids: ["EntityId"], # required
|
2894
|
+
# })
|
2895
|
+
#
|
2896
|
+
# @example Response structure
|
2897
|
+
#
|
2898
|
+
# resp.failed_entity_list #=> Array
|
2899
|
+
# resp.failed_entity_list[0].entity_id #=> String
|
2900
|
+
# resp.failed_entity_list[0].error_message #=> String
|
2901
|
+
#
|
2902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociatePersonasFromEntities AWS API Documentation
|
2903
|
+
#
|
2904
|
+
# @overload disassociate_personas_from_entities(params = {})
|
2905
|
+
# @param [Hash] params ({})
|
2906
|
+
def disassociate_personas_from_entities(params = {}, options = {})
|
2907
|
+
req = build_request(:disassociate_personas_from_entities, params)
|
2908
|
+
req.send_request(options)
|
2909
|
+
end
|
2910
|
+
|
2299
2911
|
# Fetches the queries that are suggested to your users.
|
2300
2912
|
#
|
2913
|
+
# `GetQuerySuggestions` is currently not supported in the Amazon Web
|
2914
|
+
# Services GovCloud (US-West) region.
|
2915
|
+
#
|
2301
2916
|
# @option params [required, String] :index_id
|
2302
2917
|
# The identifier of the index you want to get query suggestions from.
|
2303
2918
|
#
|
@@ -2348,6 +2963,93 @@ module Aws::Kendra
|
|
2348
2963
|
req.send_request(options)
|
2349
2964
|
end
|
2350
2965
|
|
2966
|
+
# Retrieves search metrics data. The data provides a snapshot of how
|
2967
|
+
# your users interact with your search application and how effective the
|
2968
|
+
# application is.
|
2969
|
+
#
|
2970
|
+
# @option params [required, String] :index_id
|
2971
|
+
# The identifier of the index to get search metrics data.
|
2972
|
+
#
|
2973
|
+
# @option params [required, String] :interval
|
2974
|
+
# The time interval or time window to get search metrics data. The time
|
2975
|
+
# interval uses the time zone of your index. You can view data in the
|
2976
|
+
# following time windows:
|
2977
|
+
#
|
2978
|
+
# * `THIS_WEEK`\: The current week, starting on the Sunday and ending on
|
2979
|
+
# the day before the current date.
|
2980
|
+
#
|
2981
|
+
# * `ONE_WEEK_AGO`\: The previous week, starting on the Sunday and
|
2982
|
+
# ending on the following Saturday.
|
2983
|
+
#
|
2984
|
+
# * `TWO_WEEKS_AGO`\: The week before the previous week, starting on the
|
2985
|
+
# Sunday and ending on the following Saturday.
|
2986
|
+
#
|
2987
|
+
# * `THIS_MONTH`\: The current month, starting on the first day of the
|
2988
|
+
# month and ending on the day before the current date.
|
2989
|
+
#
|
2990
|
+
# * `ONE_MONTH_AGO`\: The previous month, starting on the first day of
|
2991
|
+
# the month and ending on the last day of the month.
|
2992
|
+
#
|
2993
|
+
# * `TWO_MONTHS_AGO`\: The month before the previous month, starting on
|
2994
|
+
# the first day of the month and ending on last day of the month.
|
2995
|
+
#
|
2996
|
+
# @option params [required, String] :metric_type
|
2997
|
+
# The metric you want to retrieve. You can specify only one metric per
|
2998
|
+
# call.
|
2999
|
+
#
|
3000
|
+
# For more information about the metrics you can view, see [Gaining
|
3001
|
+
# insights with search analytics][1].
|
3002
|
+
#
|
3003
|
+
#
|
3004
|
+
#
|
3005
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/search-analytics.html
|
3006
|
+
#
|
3007
|
+
# @option params [String] :next_token
|
3008
|
+
# If the previous response was incomplete (because there is more data to
|
3009
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3010
|
+
# You can use this pagination token to retrieve the next set of search
|
3011
|
+
# metrics data.
|
3012
|
+
#
|
3013
|
+
# @option params [Integer] :max_results
|
3014
|
+
# The maximum number of returned data for the metric.
|
3015
|
+
#
|
3016
|
+
# @return [Types::GetSnapshotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3017
|
+
#
|
3018
|
+
# * {Types::GetSnapshotsResponse#snap_shot_time_filter #snap_shot_time_filter} => Types::TimeRange
|
3019
|
+
# * {Types::GetSnapshotsResponse#snapshots_data_header #snapshots_data_header} => Array<String>
|
3020
|
+
# * {Types::GetSnapshotsResponse#snapshots_data #snapshots_data} => Array<Array<String>>
|
3021
|
+
# * {Types::GetSnapshotsResponse#next_token #next_token} => String
|
3022
|
+
#
|
3023
|
+
# @example Request syntax with placeholder values
|
3024
|
+
#
|
3025
|
+
# resp = client.get_snapshots({
|
3026
|
+
# index_id: "IndexId", # required
|
3027
|
+
# interval: "THIS_MONTH", # required, accepts THIS_MONTH, THIS_WEEK, ONE_WEEK_AGO, TWO_WEEKS_AGO, ONE_MONTH_AGO, TWO_MONTHS_AGO
|
3028
|
+
# 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
|
3029
|
+
# next_token: "NextToken",
|
3030
|
+
# max_results: 1,
|
3031
|
+
# })
|
3032
|
+
#
|
3033
|
+
# @example Response structure
|
3034
|
+
#
|
3035
|
+
# resp.snap_shot_time_filter.start_time #=> Time
|
3036
|
+
# resp.snap_shot_time_filter.end_time #=> Time
|
3037
|
+
# resp.snapshots_data_header #=> Array
|
3038
|
+
# resp.snapshots_data_header[0] #=> String
|
3039
|
+
# resp.snapshots_data #=> Array
|
3040
|
+
# resp.snapshots_data[0] #=> Array
|
3041
|
+
# resp.snapshots_data[0][0] #=> String
|
3042
|
+
# resp.next_token #=> String
|
3043
|
+
#
|
3044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetSnapshots AWS API Documentation
|
3045
|
+
#
|
3046
|
+
# @overload get_snapshots(params = {})
|
3047
|
+
# @param [Hash] params ({})
|
3048
|
+
def get_snapshots(params = {}, options = {})
|
3049
|
+
req = build_request(:get_snapshots, params)
|
3050
|
+
req.send_request(options)
|
3051
|
+
end
|
3052
|
+
|
2351
3053
|
# Gets statistics about synchronizing Amazon Kendra with a data source.
|
2352
3054
|
#
|
2353
3055
|
# @option params [required, String] :id
|
@@ -2471,6 +3173,173 @@ module Aws::Kendra
|
|
2471
3173
|
req.send_request(options)
|
2472
3174
|
end
|
2473
3175
|
|
3176
|
+
# Lists specific permissions of users and groups with access to your
|
3177
|
+
# Amazon Kendra experience.
|
3178
|
+
#
|
3179
|
+
# @option params [required, String] :id
|
3180
|
+
# The identifier of your Amazon Kendra experience.
|
3181
|
+
#
|
3182
|
+
# @option params [required, String] :index_id
|
3183
|
+
# The identifier of the index for your Amazon Kendra experience.
|
3184
|
+
#
|
3185
|
+
# @option params [String] :next_token
|
3186
|
+
# If the previous response was incomplete (because there is more data to
|
3187
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3188
|
+
# You can use this pagination token to retrieve the next set of users or
|
3189
|
+
# groups.
|
3190
|
+
#
|
3191
|
+
# @option params [Integer] :max_results
|
3192
|
+
# The maximum number of returned users or groups.
|
3193
|
+
#
|
3194
|
+
# @return [Types::ListEntityPersonasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3195
|
+
#
|
3196
|
+
# * {Types::ListEntityPersonasResponse#summary_items #summary_items} => Array<Types::PersonasSummary>
|
3197
|
+
# * {Types::ListEntityPersonasResponse#next_token #next_token} => String
|
3198
|
+
#
|
3199
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3200
|
+
#
|
3201
|
+
# @example Request syntax with placeholder values
|
3202
|
+
#
|
3203
|
+
# resp = client.list_entity_personas({
|
3204
|
+
# id: "ExperienceId", # required
|
3205
|
+
# index_id: "IndexId", # required
|
3206
|
+
# next_token: "NextToken",
|
3207
|
+
# max_results: 1,
|
3208
|
+
# })
|
3209
|
+
#
|
3210
|
+
# @example Response structure
|
3211
|
+
#
|
3212
|
+
# resp.summary_items #=> Array
|
3213
|
+
# resp.summary_items[0].entity_id #=> String
|
3214
|
+
# resp.summary_items[0].persona #=> String, one of "OWNER", "VIEWER"
|
3215
|
+
# resp.summary_items[0].created_at #=> Time
|
3216
|
+
# resp.summary_items[0].updated_at #=> Time
|
3217
|
+
# resp.next_token #=> String
|
3218
|
+
#
|
3219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListEntityPersonas AWS API Documentation
|
3220
|
+
#
|
3221
|
+
# @overload list_entity_personas(params = {})
|
3222
|
+
# @param [Hash] params ({})
|
3223
|
+
def list_entity_personas(params = {}, options = {})
|
3224
|
+
req = build_request(:list_entity_personas, params)
|
3225
|
+
req.send_request(options)
|
3226
|
+
end
|
3227
|
+
|
3228
|
+
# Lists users or groups in your Amazon Web Services SSO identity source
|
3229
|
+
# that are granted access to your Amazon Kendra experience. You can
|
3230
|
+
# create an Amazon Kendra experience such as a search application. For
|
3231
|
+
# more information on creating a search application experience, see
|
3232
|
+
# [Building a search experience with no code][1].
|
3233
|
+
#
|
3234
|
+
#
|
3235
|
+
#
|
3236
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
3237
|
+
#
|
3238
|
+
# @option params [required, String] :id
|
3239
|
+
# The identifier of your Amazon Kendra experience.
|
3240
|
+
#
|
3241
|
+
# @option params [required, String] :index_id
|
3242
|
+
# The identifier of the index for your Amazon Kendra experience.
|
3243
|
+
#
|
3244
|
+
# @option params [String] :next_token
|
3245
|
+
# If the previous response was incomplete (because there is more data to
|
3246
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3247
|
+
# You can use this pagination token to retrieve the next set of users or
|
3248
|
+
# groups.
|
3249
|
+
#
|
3250
|
+
# @return [Types::ListExperienceEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3251
|
+
#
|
3252
|
+
# * {Types::ListExperienceEntitiesResponse#summary_items #summary_items} => Array<Types::ExperienceEntitiesSummary>
|
3253
|
+
# * {Types::ListExperienceEntitiesResponse#next_token #next_token} => String
|
3254
|
+
#
|
3255
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3256
|
+
#
|
3257
|
+
# @example Request syntax with placeholder values
|
3258
|
+
#
|
3259
|
+
# resp = client.list_experience_entities({
|
3260
|
+
# id: "ExperienceId", # required
|
3261
|
+
# index_id: "IndexId", # required
|
3262
|
+
# next_token: "NextToken",
|
3263
|
+
# })
|
3264
|
+
#
|
3265
|
+
# @example Response structure
|
3266
|
+
#
|
3267
|
+
# resp.summary_items #=> Array
|
3268
|
+
# resp.summary_items[0].entity_id #=> String
|
3269
|
+
# resp.summary_items[0].entity_type #=> String, one of "USER", "GROUP"
|
3270
|
+
# resp.summary_items[0].display_data.user_name #=> String
|
3271
|
+
# resp.summary_items[0].display_data.group_name #=> String
|
3272
|
+
# resp.summary_items[0].display_data.identified_user_name #=> String
|
3273
|
+
# resp.summary_items[0].display_data.first_name #=> String
|
3274
|
+
# resp.summary_items[0].display_data.last_name #=> String
|
3275
|
+
# resp.next_token #=> String
|
3276
|
+
#
|
3277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperienceEntities AWS API Documentation
|
3278
|
+
#
|
3279
|
+
# @overload list_experience_entities(params = {})
|
3280
|
+
# @param [Hash] params ({})
|
3281
|
+
def list_experience_entities(params = {}, options = {})
|
3282
|
+
req = build_request(:list_experience_entities, params)
|
3283
|
+
req.send_request(options)
|
3284
|
+
end
|
3285
|
+
|
3286
|
+
# Lists one or more Amazon Kendra experiences. You can create an Amazon
|
3287
|
+
# Kendra experience such as a search application. For more information
|
3288
|
+
# on creating a search application experience, see [Building a search
|
3289
|
+
# experience with no code][1].
|
3290
|
+
#
|
3291
|
+
#
|
3292
|
+
#
|
3293
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
3294
|
+
#
|
3295
|
+
# @option params [required, String] :index_id
|
3296
|
+
# The identifier of the index for your Amazon Kendra experience.
|
3297
|
+
#
|
3298
|
+
# @option params [String] :next_token
|
3299
|
+
# If the previous response was incomplete (because there is more data to
|
3300
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3301
|
+
# You can use this pagination token to retrieve the next set of Amazon
|
3302
|
+
# Kendra experiences.
|
3303
|
+
#
|
3304
|
+
# @option params [Integer] :max_results
|
3305
|
+
# The maximum number of returned Amazon Kendra experiences.
|
3306
|
+
#
|
3307
|
+
# @return [Types::ListExperiencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3308
|
+
#
|
3309
|
+
# * {Types::ListExperiencesResponse#summary_items #summary_items} => Array<Types::ExperiencesSummary>
|
3310
|
+
# * {Types::ListExperiencesResponse#next_token #next_token} => String
|
3311
|
+
#
|
3312
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3313
|
+
#
|
3314
|
+
# @example Request syntax with placeholder values
|
3315
|
+
#
|
3316
|
+
# resp = client.list_experiences({
|
3317
|
+
# index_id: "IndexId", # required
|
3318
|
+
# next_token: "NextToken",
|
3319
|
+
# max_results: 1,
|
3320
|
+
# })
|
3321
|
+
#
|
3322
|
+
# @example Response structure
|
3323
|
+
#
|
3324
|
+
# resp.summary_items #=> Array
|
3325
|
+
# resp.summary_items[0].name #=> String
|
3326
|
+
# resp.summary_items[0].id #=> String
|
3327
|
+
# resp.summary_items[0].created_at #=> Time
|
3328
|
+
# resp.summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED"
|
3329
|
+
# resp.summary_items[0].endpoints #=> Array
|
3330
|
+
# resp.summary_items[0].endpoints[0].endpoint_type #=> String, one of "HOME"
|
3331
|
+
# resp.summary_items[0].endpoints[0].endpoint #=> String
|
3332
|
+
# resp.next_token #=> String
|
3333
|
+
#
|
3334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListExperiences AWS API Documentation
|
3335
|
+
#
|
3336
|
+
# @overload list_experiences(params = {})
|
3337
|
+
# @param [Hash] params ({})
|
3338
|
+
def list_experiences(params = {}, options = {})
|
3339
|
+
req = build_request(:list_experiences, params)
|
3340
|
+
req.send_request(options)
|
3341
|
+
end
|
3342
|
+
|
2474
3343
|
# Gets a list of FAQ lists associated with an index.
|
2475
3344
|
#
|
2476
3345
|
# @option params [required, String] :index_id
|
@@ -2523,6 +3392,9 @@ module Aws::Kendra
|
|
2523
3392
|
# Provides a list of groups that are mapped to users before a given
|
2524
3393
|
# ordering or timestamp identifier.
|
2525
3394
|
#
|
3395
|
+
# `ListGroupsOlderThanOrderingId` is currently not supported in the
|
3396
|
+
# Amazon Web Services GovCloud (US-West) region.
|
3397
|
+
#
|
2526
3398
|
# @option params [required, String] :index_id
|
2527
3399
|
# The identifier of the index for getting a list of groups mapped to
|
2528
3400
|
# users before a given ordering or timestamp identifier.
|
@@ -2627,6 +3499,9 @@ module Aws::Kendra
|
|
2627
3499
|
# For information on the current quota limits for block lists, see
|
2628
3500
|
# [Quotas for Amazon Kendra][1].
|
2629
3501
|
#
|
3502
|
+
# `ListQuerySuggestionsBlockLists` is currently not supported in the
|
3503
|
+
# Amazon Web Services GovCloud (US-West) region.
|
3504
|
+
#
|
2630
3505
|
#
|
2631
3506
|
#
|
2632
3507
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
@@ -2781,6 +3656,9 @@ module Aws::Kendra
|
|
2781
3656
|
# If more than five `PUT` actions for a group are currently processing,
|
2782
3657
|
# a validation exception is thrown.
|
2783
3658
|
#
|
3659
|
+
# `PutPrincipalMapping` is currently not supported in the Amazon Web
|
3660
|
+
# Services GovCloud (US-West) region.
|
3661
|
+
#
|
2784
3662
|
#
|
2785
3663
|
#
|
2786
3664
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
|
@@ -3236,6 +4114,9 @@ module Aws::Kendra
|
|
3236
4114
|
# Enables you to provide feedback to Amazon Kendra to improve the
|
3237
4115
|
# performance of your index.
|
3238
4116
|
#
|
4117
|
+
# `SubmitFeedback` is currently not supported in the Amazon Web Services
|
4118
|
+
# GovCloud (US-West) region.
|
4119
|
+
#
|
3239
4120
|
# @option params [required, String] :index_id
|
3240
4121
|
# The identifier of the index that was queried.
|
3241
4122
|
#
|
@@ -3359,7 +4240,7 @@ module Aws::Kendra
|
|
3359
4240
|
# The identifier of the index that contains the data source to update.
|
3360
4241
|
#
|
3361
4242
|
# @option params [Types::DataSourceConfiguration] :configuration
|
3362
|
-
# Configuration information for
|
4243
|
+
# Configuration information for an Amazon Kendra data source.
|
3363
4244
|
#
|
3364
4245
|
# @option params [String] :description
|
3365
4246
|
# The new description for the data source.
|
@@ -3381,6 +4262,19 @@ module Aws::Kendra
|
|
3381
4262
|
#
|
3382
4263
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
3383
4264
|
#
|
4265
|
+
# @option params [Types::CustomDocumentEnrichmentConfiguration] :custom_document_enrichment_configuration
|
4266
|
+
# Configuration information for altering document metadata and content
|
4267
|
+
# during the document ingestion process when you update a data source.
|
4268
|
+
#
|
4269
|
+
# For more information on how to create, modify and delete document
|
4270
|
+
# metadata, or make other content alterations when you ingest documents
|
4271
|
+
# into Amazon Kendra, see [Customizing document metadata during the
|
4272
|
+
# ingestion process][1].
|
4273
|
+
#
|
4274
|
+
#
|
4275
|
+
#
|
4276
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html
|
4277
|
+
#
|
3384
4278
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3385
4279
|
#
|
3386
4280
|
# @example Request syntax with placeholder values
|
@@ -3705,6 +4599,62 @@ module Aws::Kendra
|
|
3705
4599
|
# schedule: "ScanSchedule",
|
3706
4600
|
# role_arn: "RoleArn",
|
3707
4601
|
# language_code: "LanguageCode",
|
4602
|
+
# custom_document_enrichment_configuration: {
|
4603
|
+
# inline_configurations: [
|
4604
|
+
# {
|
4605
|
+
# condition: {
|
4606
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
4607
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
4608
|
+
# condition_on_value: {
|
4609
|
+
# string_value: "DocumentAttributeStringValue",
|
4610
|
+
# string_list_value: ["String"],
|
4611
|
+
# long_value: 1,
|
4612
|
+
# date_value: Time.now,
|
4613
|
+
# },
|
4614
|
+
# },
|
4615
|
+
# target: {
|
4616
|
+
# target_document_attribute_key: "DocumentAttributeKey",
|
4617
|
+
# target_document_attribute_value_deletion: false,
|
4618
|
+
# target_document_attribute_value: {
|
4619
|
+
# string_value: "DocumentAttributeStringValue",
|
4620
|
+
# string_list_value: ["String"],
|
4621
|
+
# long_value: 1,
|
4622
|
+
# date_value: Time.now,
|
4623
|
+
# },
|
4624
|
+
# },
|
4625
|
+
# document_content_deletion: false,
|
4626
|
+
# },
|
4627
|
+
# ],
|
4628
|
+
# pre_extraction_hook_configuration: {
|
4629
|
+
# invocation_condition: {
|
4630
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
4631
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
4632
|
+
# condition_on_value: {
|
4633
|
+
# string_value: "DocumentAttributeStringValue",
|
4634
|
+
# string_list_value: ["String"],
|
4635
|
+
# long_value: 1,
|
4636
|
+
# date_value: Time.now,
|
4637
|
+
# },
|
4638
|
+
# },
|
4639
|
+
# lambda_arn: "LambdaArn", # required
|
4640
|
+
# s3_bucket: "S3BucketName", # required
|
4641
|
+
# },
|
4642
|
+
# post_extraction_hook_configuration: {
|
4643
|
+
# invocation_condition: {
|
4644
|
+
# condition_document_attribute_key: "DocumentAttributeKey", # required
|
4645
|
+
# operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
|
4646
|
+
# condition_on_value: {
|
4647
|
+
# string_value: "DocumentAttributeStringValue",
|
4648
|
+
# string_list_value: ["String"],
|
4649
|
+
# long_value: 1,
|
4650
|
+
# date_value: Time.now,
|
4651
|
+
# },
|
4652
|
+
# },
|
4653
|
+
# lambda_arn: "LambdaArn", # required
|
4654
|
+
# s3_bucket: "S3BucketName", # required
|
4655
|
+
# },
|
4656
|
+
# role_arn: "RoleArn",
|
4657
|
+
# },
|
3708
4658
|
# })
|
3709
4659
|
#
|
3710
4660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource AWS API Documentation
|
@@ -3716,6 +4666,74 @@ module Aws::Kendra
|
|
3716
4666
|
req.send_request(options)
|
3717
4667
|
end
|
3718
4668
|
|
4669
|
+
# Updates your Amazon Kendra experience such as a search application.
|
4670
|
+
# For more information on creating a search application experience, see
|
4671
|
+
# [Building a search experience with no code][1].
|
4672
|
+
#
|
4673
|
+
#
|
4674
|
+
#
|
4675
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
4676
|
+
#
|
4677
|
+
# @option params [required, String] :id
|
4678
|
+
# The identifier of your Amazon Kendra experience you want to update.
|
4679
|
+
#
|
4680
|
+
# @option params [String] :name
|
4681
|
+
# The name of your Amazon Kendra experience you want to update.
|
4682
|
+
#
|
4683
|
+
# @option params [required, String] :index_id
|
4684
|
+
# The identifier of the index for your Amazon Kendra experience you want
|
4685
|
+
# to update.
|
4686
|
+
#
|
4687
|
+
# @option params [String] :role_arn
|
4688
|
+
# The Amazon Resource Name (ARN) of a role with permission to access
|
4689
|
+
# `Query` operations, `QuerySuggestions` operations, `SubmitFeedback`
|
4690
|
+
# operations, and Amazon Web Services SSO that stores your user and
|
4691
|
+
# group information. For more information, see [IAM roles for Amazon
|
4692
|
+
# Kendra][1].
|
4693
|
+
#
|
4694
|
+
#
|
4695
|
+
#
|
4696
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
4697
|
+
#
|
4698
|
+
# @option params [Types::ExperienceConfiguration] :configuration
|
4699
|
+
# Provides the user configuration information. This includes the Amazon
|
4700
|
+
# Web Services SSO field name that contains the identifiers of your
|
4701
|
+
# users, such as their emails.
|
4702
|
+
#
|
4703
|
+
# @option params [String] :description
|
4704
|
+
# The description of your Amazon Kendra experience you want to update.
|
4705
|
+
#
|
4706
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4707
|
+
#
|
4708
|
+
# @example Request syntax with placeholder values
|
4709
|
+
#
|
4710
|
+
# resp = client.update_experience({
|
4711
|
+
# id: "ExperienceId", # required
|
4712
|
+
# name: "ExperienceName",
|
4713
|
+
# index_id: "IndexId", # required
|
4714
|
+
# role_arn: "RoleArn",
|
4715
|
+
# configuration: {
|
4716
|
+
# content_source_configuration: {
|
4717
|
+
# data_source_ids: ["DataSourceId"],
|
4718
|
+
# faq_ids: ["FaqId"],
|
4719
|
+
# direct_put_content: false,
|
4720
|
+
# },
|
4721
|
+
# user_identity_configuration: {
|
4722
|
+
# identity_attribute_name: "IdentityAttributeName",
|
4723
|
+
# },
|
4724
|
+
# },
|
4725
|
+
# description: "Description",
|
4726
|
+
# })
|
4727
|
+
#
|
4728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperience AWS API Documentation
|
4729
|
+
#
|
4730
|
+
# @overload update_experience(params = {})
|
4731
|
+
# @param [Hash] params ({})
|
4732
|
+
def update_experience(params = {}, options = {})
|
4733
|
+
req = build_request(:update_experience, params)
|
4734
|
+
req.send_request(options)
|
4735
|
+
end
|
4736
|
+
|
3719
4737
|
# Updates an existing Amazon Kendra index.
|
3720
4738
|
#
|
3721
4739
|
# @option params [required, String] :id
|
@@ -3749,8 +4767,8 @@ module Aws::Kendra
|
|
3749
4767
|
# The user context policy.
|
3750
4768
|
#
|
3751
4769
|
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
3752
|
-
# Enables fetching access levels of groups and users from an
|
3753
|
-
# Sign
|
4770
|
+
# Enables fetching access levels of groups and users from an Amazon Web
|
4771
|
+
# Services Single Sign On identity source. To configure this, see
|
3754
4772
|
# [UserGroupResolutionConfiguration][1].
|
3755
4773
|
#
|
3756
4774
|
#
|
@@ -3836,6 +4854,9 @@ module Aws::Kendra
|
|
3836
4854
|
# Amazon Kendra supports partial updates, so you only need to provide
|
3837
4855
|
# the fields you want to update.
|
3838
4856
|
#
|
4857
|
+
# `UpdateQuerySuggestionsBlockList` is currently not supported in the
|
4858
|
+
# Amazon Web Services GovCloud (US-West) region.
|
4859
|
+
#
|
3839
4860
|
# @option params [required, String] :index_id
|
3840
4861
|
# The identifier of the index for a block list.
|
3841
4862
|
#
|
@@ -3904,6 +4925,9 @@ module Aws::Kendra
|
|
3904
4925
|
#
|
3905
4926
|
# You can still enable/disable query suggestions at any time.
|
3906
4927
|
#
|
4928
|
+
# `UpdateQuerySuggestionsConfig` is currently not supported in the
|
4929
|
+
# Amazon Web Services GovCloud (US-West) region.
|
4930
|
+
#
|
3907
4931
|
# @option params [required, String] :index_id
|
3908
4932
|
# The identifier of the index you want to update query suggestions
|
3909
4933
|
# settings for.
|
@@ -4042,7 +5066,7 @@ module Aws::Kendra
|
|
4042
5066
|
params: params,
|
4043
5067
|
config: config)
|
4044
5068
|
context[:gem_name] = 'aws-sdk-kendra'
|
4045
|
-
context[:gem_version] = '1.
|
5069
|
+
context[:gem_version] = '1.41.0'
|
4046
5070
|
Seahorse::Client::Request.new(handlers, context)
|
4047
5071
|
end
|
4048
5072
|
|