aws-sdk-kendra 1.57.0 → 1.59.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +35 -36
- data/lib/aws-sdk-kendra/types.rb +101 -105
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 36a46ed1f9911716d2747edbe0d3923c18b853ea92e942fc7fb71051b7e99e2b
|
4
|
+
data.tar.gz: 1b677dc00271e6bd5da551834f323453bb0dd59fd3a75d71b50b7628e8d3a89b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 034d984b8828469a0d3393a9bae861a02597017aa91da25b778dc124ba7094817d091b2817cfe521621ecb4986c3958248667109fccb50c02a8b4ab614a03864
|
7
|
+
data.tar.gz: b7b01bcd909608676b711fc79ea5d7de765a32b2600e174e0fc48e5c7eb6215030ae0a840328e66f7b498bf8bcbee49144c7f2856d9c4c134f4d212c8c776a65
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.59.0 (2022-09-27)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - My AWS Service (placeholder) - Amazon Kendra now provides a data source connector for DropBox. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-dropbox.html
|
8
|
+
|
9
|
+
1.58.0 (2022-09-13)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release enables our customer to choose the option of Sharepoint 2019 for the on-premise Sharepoint connector.
|
13
|
+
|
4
14
|
1.57.0 (2022-08-19)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.59.0
|
@@ -361,7 +361,7 @@ module Aws::Kendra
|
|
361
361
|
|
362
362
|
# @!group API Operations
|
363
363
|
|
364
|
-
# Grants users or groups in your
|
364
|
+
# Grants users or groups in your IAM Identity Center identity source
|
365
365
|
# access to your Amazon Kendra experience. You can create an Amazon
|
366
366
|
# Kendra experience such as a search application. For more information
|
367
367
|
# on creating a search application experience, see [Building a search
|
@@ -378,7 +378,7 @@ module Aws::Kendra
|
|
378
378
|
# The identifier of the index for your Amazon Kendra experience.
|
379
379
|
#
|
380
380
|
# @option params [required, Array<Types::EntityConfiguration>] :entity_list
|
381
|
-
# Lists users or groups in your
|
381
|
+
# Lists users or groups in your IAM Identity Center identity source.
|
382
382
|
#
|
383
383
|
# @return [Types::AssociateEntitiesToExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
384
384
|
#
|
@@ -412,8 +412,8 @@ module Aws::Kendra
|
|
412
412
|
req.send_request(options)
|
413
413
|
end
|
414
414
|
|
415
|
-
# Defines the specific permissions of users or groups in your
|
416
|
-
#
|
415
|
+
# Defines the specific permissions of users or groups in your IAM
|
416
|
+
# Identity Center identity source with access to your Amazon Kendra
|
417
417
|
# experience. You can create an Amazon Kendra experience such as a
|
418
418
|
# search application. For more information on creating a search
|
419
419
|
# application experience, see [Building a search experience with no
|
@@ -431,10 +431,9 @@ module Aws::Kendra
|
|
431
431
|
#
|
432
432
|
# @option params [required, Array<Types::EntityPersonaConfiguration>] :personas
|
433
433
|
# The personas that define the specific permissions of users or groups
|
434
|
-
# in your
|
435
|
-
#
|
436
|
-
#
|
437
|
-
# page][1].
|
434
|
+
# in your IAM Identity Center identity source. The available personas or
|
435
|
+
# access roles are `Owner` and `Viewer`. For more information on these
|
436
|
+
# personas, see [Providing access to your search page][1].
|
438
437
|
#
|
439
438
|
#
|
440
439
|
#
|
@@ -1074,7 +1073,7 @@ module Aws::Kendra
|
|
1074
1073
|
# },
|
1075
1074
|
# },
|
1076
1075
|
# share_point_configuration: {
|
1077
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
1076
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
1078
1077
|
# urls: ["Url"], # required
|
1079
1078
|
# secret_arn: "SecretArn", # required
|
1080
1079
|
# crawl_attachments: false,
|
@@ -1793,8 +1792,8 @@ module Aws::Kendra
|
|
1793
1792
|
#
|
1794
1793
|
# @option params [String] :role_arn
|
1795
1794
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
1796
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
1797
|
-
#
|
1795
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM
|
1796
|
+
# Identity Center that stores your user and group information. For more
|
1798
1797
|
# information, see [IAM roles for Amazon Kendra][1].
|
1799
1798
|
#
|
1800
1799
|
#
|
@@ -2050,9 +2049,9 @@ module Aws::Kendra
|
|
2050
2049
|
# accessible to the user will be searchable and displayable.
|
2051
2050
|
#
|
2052
2051
|
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
2053
|
-
# Enables fetching access levels of groups and users from an
|
2054
|
-
#
|
2055
|
-
# [UserGroupResolutionConfiguration][1].
|
2052
|
+
# Enables fetching access levels of groups and users from an IAM
|
2053
|
+
# Identity Center (successor to Single Sign-On) identity source. To
|
2054
|
+
# configure this, see [UserGroupResolutionConfiguration][1].
|
2056
2055
|
#
|
2057
2056
|
#
|
2058
2057
|
#
|
@@ -2682,7 +2681,7 @@ module Aws::Kendra
|
|
2682
2681
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
2683
2682
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
2684
2683
|
# resp.configuration.s3_configuration.access_control_list_configuration.key_path #=> String
|
2685
|
-
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_2013", "SHAREPOINT_2016", "SHAREPOINT_ONLINE"
|
2684
|
+
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_2013", "SHAREPOINT_2016", "SHAREPOINT_ONLINE", "SHAREPOINT_2019"
|
2686
2685
|
# resp.configuration.share_point_configuration.urls #=> Array
|
2687
2686
|
# resp.configuration.share_point_configuration.urls[0] #=> String
|
2688
2687
|
# resp.configuration.share_point_configuration.secret_arn #=> String
|
@@ -3618,11 +3617,11 @@ module Aws::Kendra
|
|
3618
3617
|
req.send_request(options)
|
3619
3618
|
end
|
3620
3619
|
|
3621
|
-
# Prevents users or groups in your
|
3622
|
-
#
|
3623
|
-
#
|
3624
|
-
#
|
3625
|
-
#
|
3620
|
+
# Prevents users or groups in your IAM Identity Center identity source
|
3621
|
+
# from accessing your Amazon Kendra experience. You can create an Amazon
|
3622
|
+
# Kendra experience such as a search application. For more information
|
3623
|
+
# on creating a search application experience, see [Building a search
|
3624
|
+
# experience with no code][1].
|
3626
3625
|
#
|
3627
3626
|
#
|
3628
3627
|
#
|
@@ -3635,7 +3634,7 @@ module Aws::Kendra
|
|
3635
3634
|
# The identifier of the index for your Amazon Kendra experience.
|
3636
3635
|
#
|
3637
3636
|
# @option params [required, Array<Types::EntityConfiguration>] :entity_list
|
3638
|
-
# Lists users or groups in your
|
3637
|
+
# Lists users or groups in your IAM Identity Center identity source.
|
3639
3638
|
#
|
3640
3639
|
# @return [Types::DisassociateEntitiesFromExperienceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3641
3640
|
#
|
@@ -3669,8 +3668,8 @@ module Aws::Kendra
|
|
3669
3668
|
req.send_request(options)
|
3670
3669
|
end
|
3671
3670
|
|
3672
|
-
# Removes the specific permissions of users or groups in your
|
3673
|
-
#
|
3671
|
+
# Removes the specific permissions of users or groups in your IAM
|
3672
|
+
# Identity Center identity source with access to your Amazon Kendra
|
3674
3673
|
# experience. You can create an Amazon Kendra experience such as a
|
3675
3674
|
# search application. For more information on creating a search
|
3676
3675
|
# application experience, see [Building a search experience with no
|
@@ -3687,7 +3686,7 @@ module Aws::Kendra
|
|
3687
3686
|
# The identifier of the index for your Amazon Kendra experience.
|
3688
3687
|
#
|
3689
3688
|
# @option params [required, Array<String>] :entity_ids
|
3690
|
-
# The identifiers of users or groups in your
|
3689
|
+
# The identifiers of users or groups in your IAM Identity Center
|
3691
3690
|
# identity source. For example, user IDs could be user emails.
|
3692
3691
|
#
|
3693
3692
|
# @return [Types::DisassociatePersonasFromEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4084,11 +4083,11 @@ module Aws::Kendra
|
|
4084
4083
|
req.send_request(options)
|
4085
4084
|
end
|
4086
4085
|
|
4087
|
-
# Lists users or groups in your
|
4088
|
-
#
|
4089
|
-
#
|
4090
|
-
#
|
4091
|
-
#
|
4086
|
+
# Lists users or groups in your IAM Identity Center identity source that
|
4087
|
+
# are granted access to your Amazon Kendra experience. You can create an
|
4088
|
+
# Amazon Kendra experience such as a search application. For more
|
4089
|
+
# information on creating a search application experience, see [Building
|
4090
|
+
# a search experience with no code][1].
|
4092
4091
|
#
|
4093
4092
|
#
|
4094
4093
|
#
|
@@ -5295,7 +5294,7 @@ module Aws::Kendra
|
|
5295
5294
|
# },
|
5296
5295
|
# },
|
5297
5296
|
# share_point_configuration: {
|
5298
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
5297
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
5299
5298
|
# urls: ["Url"], # required
|
5300
5299
|
# secret_arn: "SecretArn", # required
|
5301
5300
|
# crawl_attachments: false,
|
@@ -6005,8 +6004,8 @@ module Aws::Kendra
|
|
6005
6004
|
#
|
6006
6005
|
# @option params [String] :role_arn
|
6007
6006
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
6008
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
6009
|
-
#
|
6007
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM
|
6008
|
+
# Identity Center that stores your user and group information. For more
|
6010
6009
|
# information, see [IAM roles for Amazon Kendra][1].
|
6011
6010
|
#
|
6012
6011
|
#
|
@@ -6088,9 +6087,9 @@ module Aws::Kendra
|
|
6088
6087
|
# The user context policy.
|
6089
6088
|
#
|
6090
6089
|
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
6091
|
-
# Enables fetching access levels of groups and users from an
|
6092
|
-
#
|
6093
|
-
# [UserGroupResolutionConfiguration][1].
|
6090
|
+
# Enables fetching access levels of groups and users from an IAM
|
6091
|
+
# Identity Center (successor to Single Sign-On) identity source. To
|
6092
|
+
# configure this, see [UserGroupResolutionConfiguration][1].
|
6094
6093
|
#
|
6095
6094
|
#
|
6096
6095
|
#
|
@@ -6387,7 +6386,7 @@ module Aws::Kendra
|
|
6387
6386
|
params: params,
|
6388
6387
|
config: config)
|
6389
6388
|
context[:gem_name] = 'aws-sdk-kendra'
|
6390
|
-
context[:gem_version] = '1.
|
6389
|
+
context[:gem_version] = '1.59.0'
|
6391
6390
|
Seahorse::Client::Request.new(handlers, context)
|
6392
6391
|
end
|
6393
6392
|
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -338,8 +338,7 @@ module Aws::Kendra
|
|
338
338
|
# @return [String]
|
339
339
|
#
|
340
340
|
# @!attribute [rw] entity_list
|
341
|
-
# Lists users or groups in your
|
342
|
-
# source.
|
341
|
+
# Lists users or groups in your IAM Identity Center identity source.
|
343
342
|
# @return [Array<Types::EntityConfiguration>]
|
344
343
|
#
|
345
344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AssociateEntitiesToExperienceRequest AWS API Documentation
|
@@ -353,7 +352,7 @@ module Aws::Kendra
|
|
353
352
|
end
|
354
353
|
|
355
354
|
# @!attribute [rw] failed_entity_list
|
356
|
-
# Lists the users or groups in your
|
355
|
+
# Lists the users or groups in your IAM Identity Center identity
|
357
356
|
# source that failed to properly configure with your Amazon Kendra
|
358
357
|
# experience.
|
359
358
|
# @return [Array<Types::FailedEntity>]
|
@@ -390,10 +389,9 @@ module Aws::Kendra
|
|
390
389
|
#
|
391
390
|
# @!attribute [rw] personas
|
392
391
|
# The personas that define the specific permissions of users or groups
|
393
|
-
# in your
|
394
|
-
#
|
395
|
-
#
|
396
|
-
# page][1].
|
392
|
+
# in your IAM Identity Center identity source. The available personas
|
393
|
+
# or access roles are `Owner` and `Viewer`. For more information on
|
394
|
+
# these personas, see [Providing access to your search page][1].
|
397
395
|
#
|
398
396
|
#
|
399
397
|
#
|
@@ -411,7 +409,7 @@ module Aws::Kendra
|
|
411
409
|
end
|
412
410
|
|
413
411
|
# @!attribute [rw] failed_entity_list
|
414
|
-
# Lists the users or groups in your
|
412
|
+
# Lists the users or groups in your IAM Identity Center identity
|
415
413
|
# source that failed to properly configure with your Amazon Kendra
|
416
414
|
# experience.
|
417
415
|
# @return [Array<Types::FailedEntity>]
|
@@ -424,7 +422,8 @@ module Aws::Kendra
|
|
424
422
|
include Aws::Structure
|
425
423
|
end
|
426
424
|
|
427
|
-
# Provides filtering the query results based on document attributes
|
425
|
+
# Provides filtering the query results based on document attributes or
|
426
|
+
# metadata fields.
|
428
427
|
#
|
429
428
|
# When you use the `AndAllFilters` or `OrAllFilters`, filters you can
|
430
429
|
# use 2 layers under the first attribute filter. For example, you can
|
@@ -757,39 +756,44 @@ module Aws::Kendra
|
|
757
756
|
# @return [Types::AttributeFilter]
|
758
757
|
#
|
759
758
|
# @!attribute [rw] equals_to
|
760
|
-
# Performs an equals operation on two document attributes
|
759
|
+
# Performs an equals operation on two document attributes or metadata
|
760
|
+
# fields.
|
761
761
|
# @return [Types::DocumentAttribute]
|
762
762
|
#
|
763
763
|
# @!attribute [rw] contains_all
|
764
764
|
# Returns true when a document contains all of the specified document
|
765
|
-
# attributes. This filter is only applicable to
|
766
|
-
# metadata.
|
765
|
+
# attributes or metadata fields. This filter is only applicable to
|
766
|
+
# `StringListValue` metadata.
|
767
767
|
# @return [Types::DocumentAttribute]
|
768
768
|
#
|
769
769
|
# @!attribute [rw] contains_any
|
770
770
|
# Returns true when a document contains any of the specified document
|
771
|
-
# attributes. This filter is only applicable to
|
772
|
-
# metadata.
|
771
|
+
# attributes or metadata fields. This filter is only applicable to
|
772
|
+
# `StringListValue` metadata.
|
773
773
|
# @return [Types::DocumentAttribute]
|
774
774
|
#
|
775
775
|
# @!attribute [rw] greater_than
|
776
|
-
# Performs a greater than operation on two document attributes
|
777
|
-
# with a document attribute of type `Date` or
|
776
|
+
# Performs a greater than operation on two document attributes or
|
777
|
+
# metadata fields. Use with a document attribute of type `Date` or
|
778
|
+
# `Long`.
|
778
779
|
# @return [Types::DocumentAttribute]
|
779
780
|
#
|
780
781
|
# @!attribute [rw] greater_than_or_equals
|
781
782
|
# Performs a greater or equals than operation on two document
|
782
|
-
# attributes. Use with a document attribute of type
|
783
|
+
# attributes or metadata fields. Use with a document attribute of type
|
784
|
+
# `Date` or `Long`.
|
783
785
|
# @return [Types::DocumentAttribute]
|
784
786
|
#
|
785
787
|
# @!attribute [rw] less_than
|
786
|
-
# Performs a less than operation on two document attributes
|
787
|
-
# a document attribute of type `Date` or
|
788
|
+
# Performs a less than operation on two document attributes or
|
789
|
+
# metadata fields. Use with a document attribute of type `Date` or
|
790
|
+
# `Long`.
|
788
791
|
# @return [Types::DocumentAttribute]
|
789
792
|
#
|
790
793
|
# @!attribute [rw] less_than_or_equals
|
791
|
-
# Performs a less than or equals operation on two document attributes
|
792
|
-
# Use with a document attribute of type `Date` or
|
794
|
+
# Performs a less than or equals operation on two document attributes
|
795
|
+
# or metadata fields. Use with a document attribute of type `Date` or
|
796
|
+
# `Long`.
|
793
797
|
# @return [Types::DocumentAttribute]
|
794
798
|
#
|
795
799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeFilter AWS API Documentation
|
@@ -2464,7 +2468,7 @@ module Aws::Kendra
|
|
2464
2468
|
# },
|
2465
2469
|
# },
|
2466
2470
|
# share_point_configuration: {
|
2467
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
2471
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
2468
2472
|
# urls: ["Url"], # required
|
2469
2473
|
# secret_arn: "SecretArn", # required
|
2470
2474
|
# crawl_attachments: false,
|
@@ -3321,9 +3325,9 @@ module Aws::Kendra
|
|
3321
3325
|
#
|
3322
3326
|
# @!attribute [rw] role_arn
|
3323
3327
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
3324
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
3325
|
-
#
|
3326
|
-
#
|
3328
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM
|
3329
|
+
# Identity Center that stores your user and group information. For
|
3330
|
+
# more information, see [IAM roles for Amazon Kendra][1].
|
3327
3331
|
#
|
3328
3332
|
#
|
3329
3333
|
#
|
@@ -3613,9 +3617,9 @@ module Aws::Kendra
|
|
3613
3617
|
# @return [String]
|
3614
3618
|
#
|
3615
3619
|
# @!attribute [rw] user_group_resolution_configuration
|
3616
|
-
# Enables fetching access levels of groups and users from an
|
3617
|
-
#
|
3618
|
-
# [UserGroupResolutionConfiguration][1].
|
3620
|
+
# Enables fetching access levels of groups and users from an IAM
|
3621
|
+
# Identity Center (successor to Single Sign-On) identity source. To
|
3622
|
+
# configure this, see [UserGroupResolutionConfiguration][1].
|
3619
3623
|
#
|
3620
3624
|
#
|
3621
3625
|
#
|
@@ -3981,7 +3985,7 @@ module Aws::Kendra
|
|
3981
3985
|
# },
|
3982
3986
|
# },
|
3983
3987
|
# share_point_configuration: {
|
3984
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
3988
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
3985
3989
|
# urls: ["Url"], # required
|
3986
3990
|
# secret_arn: "SecretArn", # required
|
3987
3991
|
# crawl_attachments: false,
|
@@ -5597,8 +5601,7 @@ module Aws::Kendra
|
|
5597
5601
|
# @!attribute [rw] role_arn
|
5598
5602
|
# Shows the Amazon Resource Name (ARN) of a role with permission to
|
5599
5603
|
# access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API,
|
5600
|
-
# and
|
5601
|
-
# information.
|
5604
|
+
# and IAM Identity Center that stores your user and group information.
|
5602
5605
|
# @return [String]
|
5603
5606
|
#
|
5604
5607
|
# @!attribute [rw] error_message
|
@@ -5825,8 +5828,8 @@ module Aws::Kendra
|
|
5825
5828
|
#
|
5826
5829
|
# @!attribute [rw] user_group_resolution_configuration
|
5827
5830
|
# Whether you have enabled the configuration for fetching access
|
5828
|
-
# levels of groups and users from an
|
5829
|
-
# On identity source.
|
5831
|
+
# levels of groups and users from an IAM Identity Center (successor to
|
5832
|
+
# Single Sign-On) identity source.
|
5830
5833
|
# @return [Types::UserGroupResolutionConfiguration]
|
5831
5834
|
#
|
5832
5835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
|
@@ -6270,8 +6273,7 @@ module Aws::Kendra
|
|
6270
6273
|
# @return [String]
|
6271
6274
|
#
|
6272
6275
|
# @!attribute [rw] entity_list
|
6273
|
-
# Lists users or groups in your
|
6274
|
-
# source.
|
6276
|
+
# Lists users or groups in your IAM Identity Center identity source.
|
6275
6277
|
# @return [Array<Types::EntityConfiguration>]
|
6276
6278
|
#
|
6277
6279
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperienceRequest AWS API Documentation
|
@@ -6285,7 +6287,7 @@ module Aws::Kendra
|
|
6285
6287
|
end
|
6286
6288
|
|
6287
6289
|
# @!attribute [rw] failed_entity_list
|
6288
|
-
# Lists the users or groups in your
|
6290
|
+
# Lists the users or groups in your IAM Identity Center identity
|
6289
6291
|
# source that failed to properly remove access to your Amazon Kendra
|
6290
6292
|
# experience.
|
6291
6293
|
# @return [Array<Types::FailedEntity>]
|
@@ -6316,7 +6318,7 @@ module Aws::Kendra
|
|
6316
6318
|
# @return [String]
|
6317
6319
|
#
|
6318
6320
|
# @!attribute [rw] entity_ids
|
6319
|
-
# The identifiers of users or groups in your
|
6321
|
+
# The identifiers of users or groups in your IAM Identity Center
|
6320
6322
|
# identity source. For example, user IDs could be user emails.
|
6321
6323
|
# @return [Array<String>]
|
6322
6324
|
#
|
@@ -6331,7 +6333,7 @@ module Aws::Kendra
|
|
6331
6333
|
end
|
6332
6334
|
|
6333
6335
|
# @!attribute [rw] failed_entity_list
|
6334
|
-
# Lists the users or groups in your
|
6336
|
+
# Lists the users or groups in your IAM Identity Center identity
|
6335
6337
|
# source that failed to properly remove access to your Amazon Kendra
|
6336
6338
|
# experience.
|
6337
6339
|
# @return [Array<Types::FailedEntity>]
|
@@ -6905,9 +6907,9 @@ module Aws::Kendra
|
|
6905
6907
|
include Aws::Structure
|
6906
6908
|
end
|
6907
6909
|
|
6908
|
-
# Provides the configuration information for users or groups in your
|
6909
|
-
#
|
6910
|
-
#
|
6910
|
+
# Provides the configuration information for users or groups in your IAM
|
6911
|
+
# Identity Center identity source to grant access your Amazon Kendra
|
6912
|
+
# experience.
|
6911
6913
|
#
|
6912
6914
|
# @note When making an API call, you may pass EntityConfiguration
|
6913
6915
|
# data as a hash:
|
@@ -6918,7 +6920,7 @@ module Aws::Kendra
|
|
6918
6920
|
# }
|
6919
6921
|
#
|
6920
6922
|
# @!attribute [rw] entity_id
|
6921
|
-
# The identifier of a user or group in your
|
6923
|
+
# The identifier of a user or group in your IAM Identity Center
|
6922
6924
|
# identity source. For example, a user ID could be an email.
|
6923
6925
|
# @return [String]
|
6924
6926
|
#
|
@@ -6969,10 +6971,10 @@ module Aws::Kendra
|
|
6969
6971
|
include Aws::Structure
|
6970
6972
|
end
|
6971
6973
|
|
6972
|
-
# Provides the configuration information for users or groups in your
|
6973
|
-
#
|
6974
|
-
#
|
6975
|
-
#
|
6974
|
+
# Provides the configuration information for users or groups in your IAM
|
6975
|
+
# Identity Center identity source for access to your Amazon Kendra
|
6976
|
+
# experience. Specific permissions are defined for each user or group
|
6977
|
+
# once they are granted access to your Amazon Kendra experience.
|
6976
6978
|
#
|
6977
6979
|
# @note When making an API call, you may pass EntityPersonaConfiguration
|
6978
6980
|
# data as a hash:
|
@@ -6983,13 +6985,13 @@ module Aws::Kendra
|
|
6983
6985
|
# }
|
6984
6986
|
#
|
6985
6987
|
# @!attribute [rw] entity_id
|
6986
|
-
# The identifier of a user or group in your
|
6988
|
+
# The identifier of a user or group in your IAM Identity Center
|
6987
6989
|
# identity source. For example, a user ID could be an email.
|
6988
6990
|
# @return [String]
|
6989
6991
|
#
|
6990
6992
|
# @!attribute [rw] persona
|
6991
6993
|
# The persona that defines the specific permissions of the user or
|
6992
|
-
# group in your
|
6994
|
+
# group in your IAM Identity Center identity source. The available
|
6993
6995
|
# personas or access roles are `Owner` and `Viewer`. For more
|
6994
6996
|
# information on these personas, see [Providing access to your search
|
6995
6997
|
# page][1].
|
@@ -7034,8 +7036,8 @@ module Aws::Kendra
|
|
7034
7036
|
# @return [Types::ContentSourceConfiguration]
|
7035
7037
|
#
|
7036
7038
|
# @!attribute [rw] user_identity_configuration
|
7037
|
-
# The
|
7038
|
-
#
|
7039
|
+
# The IAM Identity Center field name that contains the identifiers of
|
7040
|
+
# your users, such as their emails.
|
7039
7041
|
# @return [Types::UserIdentityConfiguration]
|
7040
7042
|
#
|
7041
7043
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExperienceConfiguration AWS API Documentation
|
@@ -7069,19 +7071,18 @@ module Aws::Kendra
|
|
7069
7071
|
include Aws::Structure
|
7070
7072
|
end
|
7071
7073
|
|
7072
|
-
# Summary information for users or groups in your
|
7073
|
-
#
|
7074
|
-
#
|
7075
|
-
#
|
7076
|
-
#
|
7077
|
-
# code][1].
|
7074
|
+
# Summary information for users or groups in your IAM Identity Center
|
7075
|
+
# identity source with granted access to your Amazon Kendra experience.
|
7076
|
+
# You can create an Amazon Kendra experience such as a search
|
7077
|
+
# application. For more information on creating a search application
|
7078
|
+
# experience, see [Building a search experience with no code][1].
|
7078
7079
|
#
|
7079
7080
|
#
|
7080
7081
|
#
|
7081
7082
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
7082
7083
|
#
|
7083
7084
|
# @!attribute [rw] entity_id
|
7084
|
-
# The identifier of a user or group in your
|
7085
|
+
# The identifier of a user or group in your IAM Identity Center
|
7085
7086
|
# identity source. For example, a user ID could be an email.
|
7086
7087
|
# @return [String]
|
7087
7088
|
#
|
@@ -7249,18 +7250,18 @@ module Aws::Kendra
|
|
7249
7250
|
include Aws::Structure
|
7250
7251
|
end
|
7251
7252
|
|
7252
|
-
# Information on the users or groups in your
|
7253
|
+
# Information on the users or groups in your IAM Identity Center
|
7253
7254
|
# identity source that failed to properly configure with your Amazon
|
7254
7255
|
# Kendra experience.
|
7255
7256
|
#
|
7256
7257
|
# @!attribute [rw] entity_id
|
7257
|
-
# The identifier of the user or group in your
|
7258
|
+
# The identifier of the user or group in your IAM Identity Center
|
7258
7259
|
# identity source. For example, a user ID could be an email.
|
7259
7260
|
# @return [String]
|
7260
7261
|
#
|
7261
7262
|
# @!attribute [rw] error_message
|
7262
|
-
# The reason the user or group in your
|
7263
|
-
#
|
7263
|
+
# The reason the user or group in your IAM Identity Center identity
|
7264
|
+
# source failed to properly configure with your Amazon Kendra
|
7264
7265
|
# experience.
|
7265
7266
|
# @return [String]
|
7266
7267
|
#
|
@@ -9764,8 +9765,8 @@ module Aws::Kendra
|
|
9764
9765
|
include Aws::Structure
|
9765
9766
|
end
|
9766
9767
|
|
9767
|
-
# Summary information for users or groups in your
|
9768
|
-
#
|
9768
|
+
# Summary information for users or groups in your IAM Identity Center
|
9769
|
+
# identity source. This applies to users and groups with specific
|
9769
9770
|
# permissions that define their level of access to your Amazon Kendra
|
9770
9771
|
# experience. You can create an Amazon Kendra experience such as a
|
9771
9772
|
# search application. For more information on creating a search
|
@@ -9777,13 +9778,13 @@ module Aws::Kendra
|
|
9777
9778
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
9778
9779
|
#
|
9779
9780
|
# @!attribute [rw] entity_id
|
9780
|
-
# The identifier of a user or group in your
|
9781
|
+
# The identifier of a user or group in your IAM Identity Center
|
9781
9782
|
# identity source. For example, a user ID could be an email.
|
9782
9783
|
# @return [String]
|
9783
9784
|
#
|
9784
9785
|
# @!attribute [rw] persona
|
9785
9786
|
# The persona that defines the specific permissions of the user or
|
9786
|
-
# group in your
|
9787
|
+
# group in your IAM Identity Center identity source. The available
|
9787
9788
|
# personas or access roles are `Owner` and `Viewer`. For more
|
9788
9789
|
# information on these personas, see [Providing access to your search
|
9789
9790
|
# page][1].
|
@@ -11868,7 +11869,7 @@ module Aws::Kendra
|
|
11868
11869
|
# data as a hash:
|
11869
11870
|
#
|
11870
11871
|
# {
|
11871
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
11872
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
11872
11873
|
# urls: ["Url"], # required
|
11873
11874
|
# secret_arn: "SecretArn", # required
|
11874
11875
|
# crawl_attachments: false,
|
@@ -12717,18 +12718,14 @@ module Aws::Kendra
|
|
12717
12718
|
# }
|
12718
12719
|
#
|
12719
12720
|
# @!attribute [rw] template
|
12720
|
-
# The template schema used for the data source
|
12721
|
+
# The template schema used for the data source, where templates
|
12722
|
+
# schemas are supported.
|
12721
12723
|
#
|
12722
|
-
#
|
12723
|
-
# templates are supported:
|
12724
|
+
# See [Data source template schemas][1].
|
12724
12725
|
#
|
12725
|
-
# * [Zendesk template schema][1]
|
12726
|
-
#
|
12727
|
-
# ^
|
12728
12726
|
#
|
12729
12727
|
#
|
12730
|
-
#
|
12731
|
-
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-zendesk.html#zendesk-template-schema
|
12728
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html
|
12732
12729
|
# @return [Hash,Array,String,Numeric,Boolean]
|
12733
12730
|
#
|
12734
12731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TemplateConfiguration AWS API Documentation
|
@@ -12981,7 +12978,7 @@ module Aws::Kendra
|
|
12981
12978
|
# },
|
12982
12979
|
# },
|
12983
12980
|
# share_point_configuration: {
|
12984
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
12981
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
12985
12982
|
# urls: ["Url"], # required
|
12986
12983
|
# secret_arn: "SecretArn", # required
|
12987
12984
|
# crawl_attachments: false,
|
@@ -13786,9 +13783,9 @@ module Aws::Kendra
|
|
13786
13783
|
#
|
13787
13784
|
# @!attribute [rw] role_arn
|
13788
13785
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
13789
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
13790
|
-
#
|
13791
|
-
#
|
13786
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM
|
13787
|
+
# Identity Center that stores your user and group information. For
|
13788
|
+
# more information, see [IAM roles for Amazon Kendra][1].
|
13792
13789
|
#
|
13793
13790
|
#
|
13794
13791
|
#
|
@@ -13916,9 +13913,9 @@ module Aws::Kendra
|
|
13916
13913
|
# @return [String]
|
13917
13914
|
#
|
13918
13915
|
# @!attribute [rw] user_group_resolution_configuration
|
13919
|
-
# Enables fetching access levels of groups and users from an
|
13920
|
-
#
|
13921
|
-
# [UserGroupResolutionConfiguration][1].
|
13916
|
+
# Enables fetching access levels of groups and users from an IAM
|
13917
|
+
# Identity Center (successor to Single Sign-On) identity source. To
|
13918
|
+
# configure this, see [UserGroupResolutionConfiguration][1].
|
13922
13919
|
#
|
13923
13920
|
#
|
13924
13921
|
#
|
@@ -14269,22 +14266,22 @@ module Aws::Kendra
|
|
14269
14266
|
end
|
14270
14267
|
|
14271
14268
|
# Provides the configuration information to fetch access levels of
|
14272
|
-
# groups and users from an
|
14273
|
-
# source. This is useful for user context filtering,
|
14274
|
-
# results are filtered based on the user or their group
|
14275
|
-
# documents. You can also use the [PutPrincipalMapping][1] API
|
14276
|
-
# users to their groups so that you only need to provide the user
|
14277
|
-
# when you issue the query.
|
14278
|
-
#
|
14279
|
-
# To set up an
|
14280
|
-
#
|
14281
|
-
#
|
14282
|
-
#
|
14283
|
-
#
|
14269
|
+
# groups and users from an IAM Identity Center (successor to Single
|
14270
|
+
# Sign-On) identity source. This is useful for user context filtering,
|
14271
|
+
# where search results are filtered based on the user or their group
|
14272
|
+
# access to documents. You can also use the [PutPrincipalMapping][1] API
|
14273
|
+
# to map users to their groups so that you only need to provide the user
|
14274
|
+
# ID when you issue the query.
|
14275
|
+
#
|
14276
|
+
# To set up an IAM Identity Center identity source in the console to use
|
14277
|
+
# with Amazon Kendra, see [Getting started with an IAM Identity Center
|
14278
|
+
# identity source][2]. You must also grant the required permissions to
|
14279
|
+
# use IAM Identity Center with Amazon Kendra. For more information, see
|
14280
|
+
# [IAM roles for IAM Identity Center][3].
|
14284
14281
|
#
|
14285
14282
|
# Amazon Kendra currently does not support using
|
14286
14283
|
# `UserGroupResolutionConfiguration` with an Amazon Web Services
|
14287
|
-
# organization member account for your
|
14284
|
+
# organization member account for your IAM Identity Center identify
|
14288
14285
|
# source. You must create your index in the management account for the
|
14289
14286
|
# organization in order to use `UserGroupResolutionConfiguration`.
|
14290
14287
|
#
|
@@ -14303,10 +14300,10 @@ module Aws::Kendra
|
|
14303
14300
|
#
|
14304
14301
|
# @!attribute [rw] user_group_resolution_mode
|
14305
14302
|
# The identity store provider (mode) you want to use to fetch access
|
14306
|
-
# levels of groups and users.
|
14307
|
-
# currently the only available mode. Your users and groups
|
14308
|
-
# in an
|
14309
|
-
# mode.
|
14303
|
+
# levels of groups and users. IAM Identity Center (successor to Single
|
14304
|
+
# Sign-On) is currently the only available mode. Your users and groups
|
14305
|
+
# must exist in an IAM Identity Center identity source in order to use
|
14306
|
+
# this mode.
|
14310
14307
|
# @return [String]
|
14311
14308
|
#
|
14312
14309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation
|
@@ -14328,14 +14325,13 @@ module Aws::Kendra
|
|
14328
14325
|
# }
|
14329
14326
|
#
|
14330
14327
|
# @!attribute [rw] identity_attribute_name
|
14331
|
-
# The
|
14332
|
-
#
|
14328
|
+
# The IAM Identity Center field name that contains the identifiers of
|
14329
|
+
# your users, such as their emails. This is used for [user context
|
14333
14330
|
# filtering][1] and for granting access to your Amazon Kendra
|
14334
|
-
# experience. You must set up
|
14335
|
-
#
|
14336
|
-
#
|
14337
|
-
#
|
14338
|
-
# identity source][2].
|
14331
|
+
# experience. You must set up IAM Identity Center with Amazon Kendra.
|
14332
|
+
# You must include your users and groups in your Access Control List
|
14333
|
+
# when you ingest documents into your index. For more information, see
|
14334
|
+
# [Getting started with an IAM Identity Center identity source][2].
|
14339
14335
|
#
|
14340
14336
|
#
|
14341
14337
|
#
|
data/lib/aws-sdk-kendra.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kendra
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.59.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-09-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|