aws-sdk-kendra 1.58.0 → 1.60.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +51 -35
- data/lib/aws-sdk-kendra/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-kendra/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-kendra/endpoints.rb +855 -0
- data/lib/aws-sdk-kendra/plugins/endpoints.rb +188 -0
- data/lib/aws-sdk-kendra/types.rb +78 -88
- data/lib/aws-sdk-kendra.rb +5 -1
- metadata +8 -4
@@ -0,0 +1,188 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
|
11
|
+
module Aws::Kendra
|
12
|
+
module Plugins
|
13
|
+
class Endpoints < Seahorse::Client::Plugin
|
14
|
+
option(
|
15
|
+
:endpoint_provider,
|
16
|
+
doc_type: 'Aws::Kendra::EndpointProvider',
|
17
|
+
docstring: 'The endpoint provider used to resolve endpoints. Any '\
|
18
|
+
'object that responds to `#resolve_endpoint(parameters)` '\
|
19
|
+
'where `parameters` is a Struct similar to '\
|
20
|
+
'`Aws::Kendra::EndpointParameters`'
|
21
|
+
) do |cfg|
|
22
|
+
Aws::Kendra::EndpointProvider.new
|
23
|
+
end
|
24
|
+
|
25
|
+
# @api private
|
26
|
+
class Handler < Seahorse::Client::Handler
|
27
|
+
def call(context)
|
28
|
+
# If endpoint was discovered, do not resolve or apply the endpoint.
|
29
|
+
unless context[:discovered_endpoint]
|
30
|
+
params = parameters_for_operation(context)
|
31
|
+
endpoint = context.config.endpoint_provider.resolve_endpoint(params)
|
32
|
+
|
33
|
+
context.http_request.endpoint = endpoint.url
|
34
|
+
apply_endpoint_headers(context, endpoint.headers)
|
35
|
+
end
|
36
|
+
|
37
|
+
context[:endpoint_params] = params
|
38
|
+
context[:auth_scheme] =
|
39
|
+
Aws::Endpoints.resolve_auth_scheme(context, endpoint)
|
40
|
+
|
41
|
+
@handler.call(context)
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
def apply_endpoint_headers(context, headers)
|
47
|
+
headers.each do |key, values|
|
48
|
+
value = values
|
49
|
+
.compact
|
50
|
+
.map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
|
51
|
+
.join(',')
|
52
|
+
|
53
|
+
context.http_request.headers[key] = value
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
def parameters_for_operation(context)
|
58
|
+
case context.operation_name
|
59
|
+
when :associate_entities_to_experience
|
60
|
+
Aws::Kendra::Endpoints::AssociateEntitiesToExperience.build(context)
|
61
|
+
when :associate_personas_to_entities
|
62
|
+
Aws::Kendra::Endpoints::AssociatePersonasToEntities.build(context)
|
63
|
+
when :batch_delete_document
|
64
|
+
Aws::Kendra::Endpoints::BatchDeleteDocument.build(context)
|
65
|
+
when :batch_get_document_status
|
66
|
+
Aws::Kendra::Endpoints::BatchGetDocumentStatus.build(context)
|
67
|
+
when :batch_put_document
|
68
|
+
Aws::Kendra::Endpoints::BatchPutDocument.build(context)
|
69
|
+
when :clear_query_suggestions
|
70
|
+
Aws::Kendra::Endpoints::ClearQuerySuggestions.build(context)
|
71
|
+
when :create_access_control_configuration
|
72
|
+
Aws::Kendra::Endpoints::CreateAccessControlConfiguration.build(context)
|
73
|
+
when :create_data_source
|
74
|
+
Aws::Kendra::Endpoints::CreateDataSource.build(context)
|
75
|
+
when :create_experience
|
76
|
+
Aws::Kendra::Endpoints::CreateExperience.build(context)
|
77
|
+
when :create_faq
|
78
|
+
Aws::Kendra::Endpoints::CreateFaq.build(context)
|
79
|
+
when :create_index
|
80
|
+
Aws::Kendra::Endpoints::CreateIndex.build(context)
|
81
|
+
when :create_query_suggestions_block_list
|
82
|
+
Aws::Kendra::Endpoints::CreateQuerySuggestionsBlockList.build(context)
|
83
|
+
when :create_thesaurus
|
84
|
+
Aws::Kendra::Endpoints::CreateThesaurus.build(context)
|
85
|
+
when :delete_access_control_configuration
|
86
|
+
Aws::Kendra::Endpoints::DeleteAccessControlConfiguration.build(context)
|
87
|
+
when :delete_data_source
|
88
|
+
Aws::Kendra::Endpoints::DeleteDataSource.build(context)
|
89
|
+
when :delete_experience
|
90
|
+
Aws::Kendra::Endpoints::DeleteExperience.build(context)
|
91
|
+
when :delete_faq
|
92
|
+
Aws::Kendra::Endpoints::DeleteFaq.build(context)
|
93
|
+
when :delete_index
|
94
|
+
Aws::Kendra::Endpoints::DeleteIndex.build(context)
|
95
|
+
when :delete_principal_mapping
|
96
|
+
Aws::Kendra::Endpoints::DeletePrincipalMapping.build(context)
|
97
|
+
when :delete_query_suggestions_block_list
|
98
|
+
Aws::Kendra::Endpoints::DeleteQuerySuggestionsBlockList.build(context)
|
99
|
+
when :delete_thesaurus
|
100
|
+
Aws::Kendra::Endpoints::DeleteThesaurus.build(context)
|
101
|
+
when :describe_access_control_configuration
|
102
|
+
Aws::Kendra::Endpoints::DescribeAccessControlConfiguration.build(context)
|
103
|
+
when :describe_data_source
|
104
|
+
Aws::Kendra::Endpoints::DescribeDataSource.build(context)
|
105
|
+
when :describe_experience
|
106
|
+
Aws::Kendra::Endpoints::DescribeExperience.build(context)
|
107
|
+
when :describe_faq
|
108
|
+
Aws::Kendra::Endpoints::DescribeFaq.build(context)
|
109
|
+
when :describe_index
|
110
|
+
Aws::Kendra::Endpoints::DescribeIndex.build(context)
|
111
|
+
when :describe_principal_mapping
|
112
|
+
Aws::Kendra::Endpoints::DescribePrincipalMapping.build(context)
|
113
|
+
when :describe_query_suggestions_block_list
|
114
|
+
Aws::Kendra::Endpoints::DescribeQuerySuggestionsBlockList.build(context)
|
115
|
+
when :describe_query_suggestions_config
|
116
|
+
Aws::Kendra::Endpoints::DescribeQuerySuggestionsConfig.build(context)
|
117
|
+
when :describe_thesaurus
|
118
|
+
Aws::Kendra::Endpoints::DescribeThesaurus.build(context)
|
119
|
+
when :disassociate_entities_from_experience
|
120
|
+
Aws::Kendra::Endpoints::DisassociateEntitiesFromExperience.build(context)
|
121
|
+
when :disassociate_personas_from_entities
|
122
|
+
Aws::Kendra::Endpoints::DisassociatePersonasFromEntities.build(context)
|
123
|
+
when :get_query_suggestions
|
124
|
+
Aws::Kendra::Endpoints::GetQuerySuggestions.build(context)
|
125
|
+
when :get_snapshots
|
126
|
+
Aws::Kendra::Endpoints::GetSnapshots.build(context)
|
127
|
+
when :list_access_control_configurations
|
128
|
+
Aws::Kendra::Endpoints::ListAccessControlConfigurations.build(context)
|
129
|
+
when :list_data_source_sync_jobs
|
130
|
+
Aws::Kendra::Endpoints::ListDataSourceSyncJobs.build(context)
|
131
|
+
when :list_data_sources
|
132
|
+
Aws::Kendra::Endpoints::ListDataSources.build(context)
|
133
|
+
when :list_entity_personas
|
134
|
+
Aws::Kendra::Endpoints::ListEntityPersonas.build(context)
|
135
|
+
when :list_experience_entities
|
136
|
+
Aws::Kendra::Endpoints::ListExperienceEntities.build(context)
|
137
|
+
when :list_experiences
|
138
|
+
Aws::Kendra::Endpoints::ListExperiences.build(context)
|
139
|
+
when :list_faqs
|
140
|
+
Aws::Kendra::Endpoints::ListFaqs.build(context)
|
141
|
+
when :list_groups_older_than_ordering_id
|
142
|
+
Aws::Kendra::Endpoints::ListGroupsOlderThanOrderingId.build(context)
|
143
|
+
when :list_indices
|
144
|
+
Aws::Kendra::Endpoints::ListIndices.build(context)
|
145
|
+
when :list_query_suggestions_block_lists
|
146
|
+
Aws::Kendra::Endpoints::ListQuerySuggestionsBlockLists.build(context)
|
147
|
+
when :list_tags_for_resource
|
148
|
+
Aws::Kendra::Endpoints::ListTagsForResource.build(context)
|
149
|
+
when :list_thesauri
|
150
|
+
Aws::Kendra::Endpoints::ListThesauri.build(context)
|
151
|
+
when :put_principal_mapping
|
152
|
+
Aws::Kendra::Endpoints::PutPrincipalMapping.build(context)
|
153
|
+
when :query
|
154
|
+
Aws::Kendra::Endpoints::Query.build(context)
|
155
|
+
when :start_data_source_sync_job
|
156
|
+
Aws::Kendra::Endpoints::StartDataSourceSyncJob.build(context)
|
157
|
+
when :stop_data_source_sync_job
|
158
|
+
Aws::Kendra::Endpoints::StopDataSourceSyncJob.build(context)
|
159
|
+
when :submit_feedback
|
160
|
+
Aws::Kendra::Endpoints::SubmitFeedback.build(context)
|
161
|
+
when :tag_resource
|
162
|
+
Aws::Kendra::Endpoints::TagResource.build(context)
|
163
|
+
when :untag_resource
|
164
|
+
Aws::Kendra::Endpoints::UntagResource.build(context)
|
165
|
+
when :update_access_control_configuration
|
166
|
+
Aws::Kendra::Endpoints::UpdateAccessControlConfiguration.build(context)
|
167
|
+
when :update_data_source
|
168
|
+
Aws::Kendra::Endpoints::UpdateDataSource.build(context)
|
169
|
+
when :update_experience
|
170
|
+
Aws::Kendra::Endpoints::UpdateExperience.build(context)
|
171
|
+
when :update_index
|
172
|
+
Aws::Kendra::Endpoints::UpdateIndex.build(context)
|
173
|
+
when :update_query_suggestions_block_list
|
174
|
+
Aws::Kendra::Endpoints::UpdateQuerySuggestionsBlockList.build(context)
|
175
|
+
when :update_query_suggestions_config
|
176
|
+
Aws::Kendra::Endpoints::UpdateQuerySuggestionsConfig.build(context)
|
177
|
+
when :update_thesaurus
|
178
|
+
Aws::Kendra::Endpoints::UpdateThesaurus.build(context)
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
182
|
+
|
183
|
+
def add_handlers(handlers, _config)
|
184
|
+
handlers.add(Handler, step: :build, priority: 75)
|
185
|
+
end
|
186
|
+
end
|
187
|
+
end
|
188
|
+
end
|
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>]
|
@@ -3327,9 +3325,9 @@ module Aws::Kendra
|
|
3327
3325
|
#
|
3328
3326
|
# @!attribute [rw] role_arn
|
3329
3327
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
3330
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
3331
|
-
#
|
3332
|
-
#
|
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].
|
3333
3331
|
#
|
3334
3332
|
#
|
3335
3333
|
#
|
@@ -3619,9 +3617,9 @@ module Aws::Kendra
|
|
3619
3617
|
# @return [String]
|
3620
3618
|
#
|
3621
3619
|
# @!attribute [rw] user_group_resolution_configuration
|
3622
|
-
# Enables fetching access levels of groups and users from an
|
3623
|
-
#
|
3624
|
-
# [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].
|
3625
3623
|
#
|
3626
3624
|
#
|
3627
3625
|
#
|
@@ -5603,8 +5601,7 @@ module Aws::Kendra
|
|
5603
5601
|
# @!attribute [rw] role_arn
|
5604
5602
|
# Shows the Amazon Resource Name (ARN) of a role with permission to
|
5605
5603
|
# access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API,
|
5606
|
-
# and
|
5607
|
-
# information.
|
5604
|
+
# and IAM Identity Center that stores your user and group information.
|
5608
5605
|
# @return [String]
|
5609
5606
|
#
|
5610
5607
|
# @!attribute [rw] error_message
|
@@ -5831,8 +5828,8 @@ module Aws::Kendra
|
|
5831
5828
|
#
|
5832
5829
|
# @!attribute [rw] user_group_resolution_configuration
|
5833
5830
|
# Whether you have enabled the configuration for fetching access
|
5834
|
-
# levels of groups and users from an
|
5835
|
-
# On identity source.
|
5831
|
+
# levels of groups and users from an IAM Identity Center (successor to
|
5832
|
+
# Single Sign-On) identity source.
|
5836
5833
|
# @return [Types::UserGroupResolutionConfiguration]
|
5837
5834
|
#
|
5838
5835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
|
@@ -6276,8 +6273,7 @@ module Aws::Kendra
|
|
6276
6273
|
# @return [String]
|
6277
6274
|
#
|
6278
6275
|
# @!attribute [rw] entity_list
|
6279
|
-
# Lists users or groups in your
|
6280
|
-
# source.
|
6276
|
+
# Lists users or groups in your IAM Identity Center identity source.
|
6281
6277
|
# @return [Array<Types::EntityConfiguration>]
|
6282
6278
|
#
|
6283
6279
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DisassociateEntitiesFromExperienceRequest AWS API Documentation
|
@@ -6291,7 +6287,7 @@ module Aws::Kendra
|
|
6291
6287
|
end
|
6292
6288
|
|
6293
6289
|
# @!attribute [rw] failed_entity_list
|
6294
|
-
# Lists the users or groups in your
|
6290
|
+
# Lists the users or groups in your IAM Identity Center identity
|
6295
6291
|
# source that failed to properly remove access to your Amazon Kendra
|
6296
6292
|
# experience.
|
6297
6293
|
# @return [Array<Types::FailedEntity>]
|
@@ -6322,7 +6318,7 @@ module Aws::Kendra
|
|
6322
6318
|
# @return [String]
|
6323
6319
|
#
|
6324
6320
|
# @!attribute [rw] entity_ids
|
6325
|
-
# The identifiers of users or groups in your
|
6321
|
+
# The identifiers of users or groups in your IAM Identity Center
|
6326
6322
|
# identity source. For example, user IDs could be user emails.
|
6327
6323
|
# @return [Array<String>]
|
6328
6324
|
#
|
@@ -6337,7 +6333,7 @@ module Aws::Kendra
|
|
6337
6333
|
end
|
6338
6334
|
|
6339
6335
|
# @!attribute [rw] failed_entity_list
|
6340
|
-
# Lists the users or groups in your
|
6336
|
+
# Lists the users or groups in your IAM Identity Center identity
|
6341
6337
|
# source that failed to properly remove access to your Amazon Kendra
|
6342
6338
|
# experience.
|
6343
6339
|
# @return [Array<Types::FailedEntity>]
|
@@ -6911,9 +6907,9 @@ module Aws::Kendra
|
|
6911
6907
|
include Aws::Structure
|
6912
6908
|
end
|
6913
6909
|
|
6914
|
-
# Provides the configuration information for users or groups in your
|
6915
|
-
#
|
6916
|
-
#
|
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.
|
6917
6913
|
#
|
6918
6914
|
# @note When making an API call, you may pass EntityConfiguration
|
6919
6915
|
# data as a hash:
|
@@ -6924,7 +6920,7 @@ module Aws::Kendra
|
|
6924
6920
|
# }
|
6925
6921
|
#
|
6926
6922
|
# @!attribute [rw] entity_id
|
6927
|
-
# The identifier of a user or group in your
|
6923
|
+
# The identifier of a user or group in your IAM Identity Center
|
6928
6924
|
# identity source. For example, a user ID could be an email.
|
6929
6925
|
# @return [String]
|
6930
6926
|
#
|
@@ -6975,10 +6971,10 @@ module Aws::Kendra
|
|
6975
6971
|
include Aws::Structure
|
6976
6972
|
end
|
6977
6973
|
|
6978
|
-
# Provides the configuration information for users or groups in your
|
6979
|
-
#
|
6980
|
-
#
|
6981
|
-
#
|
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.
|
6982
6978
|
#
|
6983
6979
|
# @note When making an API call, you may pass EntityPersonaConfiguration
|
6984
6980
|
# data as a hash:
|
@@ -6989,13 +6985,13 @@ module Aws::Kendra
|
|
6989
6985
|
# }
|
6990
6986
|
#
|
6991
6987
|
# @!attribute [rw] entity_id
|
6992
|
-
# The identifier of a user or group in your
|
6988
|
+
# The identifier of a user or group in your IAM Identity Center
|
6993
6989
|
# identity source. For example, a user ID could be an email.
|
6994
6990
|
# @return [String]
|
6995
6991
|
#
|
6996
6992
|
# @!attribute [rw] persona
|
6997
6993
|
# The persona that defines the specific permissions of the user or
|
6998
|
-
# group in your
|
6994
|
+
# group in your IAM Identity Center identity source. The available
|
6999
6995
|
# personas or access roles are `Owner` and `Viewer`. For more
|
7000
6996
|
# information on these personas, see [Providing access to your search
|
7001
6997
|
# page][1].
|
@@ -7040,8 +7036,8 @@ module Aws::Kendra
|
|
7040
7036
|
# @return [Types::ContentSourceConfiguration]
|
7041
7037
|
#
|
7042
7038
|
# @!attribute [rw] user_identity_configuration
|
7043
|
-
# The
|
7044
|
-
#
|
7039
|
+
# The IAM Identity Center field name that contains the identifiers of
|
7040
|
+
# your users, such as their emails.
|
7045
7041
|
# @return [Types::UserIdentityConfiguration]
|
7046
7042
|
#
|
7047
7043
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExperienceConfiguration AWS API Documentation
|
@@ -7075,19 +7071,18 @@ module Aws::Kendra
|
|
7075
7071
|
include Aws::Structure
|
7076
7072
|
end
|
7077
7073
|
|
7078
|
-
# Summary information for users or groups in your
|
7079
|
-
#
|
7080
|
-
#
|
7081
|
-
#
|
7082
|
-
#
|
7083
|
-
# 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].
|
7084
7079
|
#
|
7085
7080
|
#
|
7086
7081
|
#
|
7087
7082
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
7088
7083
|
#
|
7089
7084
|
# @!attribute [rw] entity_id
|
7090
|
-
# The identifier of a user or group in your
|
7085
|
+
# The identifier of a user or group in your IAM Identity Center
|
7091
7086
|
# identity source. For example, a user ID could be an email.
|
7092
7087
|
# @return [String]
|
7093
7088
|
#
|
@@ -7255,18 +7250,18 @@ module Aws::Kendra
|
|
7255
7250
|
include Aws::Structure
|
7256
7251
|
end
|
7257
7252
|
|
7258
|
-
# Information on the users or groups in your
|
7253
|
+
# Information on the users or groups in your IAM Identity Center
|
7259
7254
|
# identity source that failed to properly configure with your Amazon
|
7260
7255
|
# Kendra experience.
|
7261
7256
|
#
|
7262
7257
|
# @!attribute [rw] entity_id
|
7263
|
-
# The identifier of the user or group in your
|
7258
|
+
# The identifier of the user or group in your IAM Identity Center
|
7264
7259
|
# identity source. For example, a user ID could be an email.
|
7265
7260
|
# @return [String]
|
7266
7261
|
#
|
7267
7262
|
# @!attribute [rw] error_message
|
7268
|
-
# The reason the user or group in your
|
7269
|
-
#
|
7263
|
+
# The reason the user or group in your IAM Identity Center identity
|
7264
|
+
# source failed to properly configure with your Amazon Kendra
|
7270
7265
|
# experience.
|
7271
7266
|
# @return [String]
|
7272
7267
|
#
|
@@ -9770,8 +9765,8 @@ module Aws::Kendra
|
|
9770
9765
|
include Aws::Structure
|
9771
9766
|
end
|
9772
9767
|
|
9773
|
-
# Summary information for users or groups in your
|
9774
|
-
#
|
9768
|
+
# Summary information for users or groups in your IAM Identity Center
|
9769
|
+
# identity source. This applies to users and groups with specific
|
9775
9770
|
# permissions that define their level of access to your Amazon Kendra
|
9776
9771
|
# experience. You can create an Amazon Kendra experience such as a
|
9777
9772
|
# search application. For more information on creating a search
|
@@ -9783,13 +9778,13 @@ module Aws::Kendra
|
|
9783
9778
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html
|
9784
9779
|
#
|
9785
9780
|
# @!attribute [rw] entity_id
|
9786
|
-
# The identifier of a user or group in your
|
9781
|
+
# The identifier of a user or group in your IAM Identity Center
|
9787
9782
|
# identity source. For example, a user ID could be an email.
|
9788
9783
|
# @return [String]
|
9789
9784
|
#
|
9790
9785
|
# @!attribute [rw] persona
|
9791
9786
|
# The persona that defines the specific permissions of the user or
|
9792
|
-
# group in your
|
9787
|
+
# group in your IAM Identity Center identity source. The available
|
9793
9788
|
# personas or access roles are `Owner` and `Viewer`. For more
|
9794
9789
|
# information on these personas, see [Providing access to your search
|
9795
9790
|
# page][1].
|
@@ -12723,18 +12718,14 @@ module Aws::Kendra
|
|
12723
12718
|
# }
|
12724
12719
|
#
|
12725
12720
|
# @!attribute [rw] template
|
12726
|
-
# The template schema used for the data source
|
12721
|
+
# The template schema used for the data source, where templates
|
12722
|
+
# schemas are supported.
|
12727
12723
|
#
|
12728
|
-
#
|
12729
|
-
# templates are supported:
|
12724
|
+
# See [Data source template schemas][1].
|
12730
12725
|
#
|
12731
|
-
# * [Zendesk template schema][1]
|
12732
12726
|
#
|
12733
|
-
# ^
|
12734
12727
|
#
|
12735
|
-
#
|
12736
|
-
#
|
12737
|
-
# [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
|
12738
12729
|
# @return [Hash,Array,String,Numeric,Boolean]
|
12739
12730
|
#
|
12740
12731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TemplateConfiguration AWS API Documentation
|
@@ -13792,9 +13783,9 @@ module Aws::Kendra
|
|
13792
13783
|
#
|
13793
13784
|
# @!attribute [rw] role_arn
|
13794
13785
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
13795
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
13796
|
-
#
|
13797
|
-
#
|
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].
|
13798
13789
|
#
|
13799
13790
|
#
|
13800
13791
|
#
|
@@ -13922,9 +13913,9 @@ module Aws::Kendra
|
|
13922
13913
|
# @return [String]
|
13923
13914
|
#
|
13924
13915
|
# @!attribute [rw] user_group_resolution_configuration
|
13925
|
-
# Enables fetching access levels of groups and users from an
|
13926
|
-
#
|
13927
|
-
# [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].
|
13928
13919
|
#
|
13929
13920
|
#
|
13930
13921
|
#
|
@@ -14275,22 +14266,22 @@ module Aws::Kendra
|
|
14275
14266
|
end
|
14276
14267
|
|
14277
14268
|
# Provides the configuration information to fetch access levels of
|
14278
|
-
# groups and users from an
|
14279
|
-
# source. This is useful for user context filtering,
|
14280
|
-
# results are filtered based on the user or their group
|
14281
|
-
# documents. You can also use the [PutPrincipalMapping][1] API
|
14282
|
-
# users to their groups so that you only need to provide the user
|
14283
|
-
# when you issue the query.
|
14284
|
-
#
|
14285
|
-
# To set up an
|
14286
|
-
#
|
14287
|
-
#
|
14288
|
-
#
|
14289
|
-
#
|
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].
|
14290
14281
|
#
|
14291
14282
|
# Amazon Kendra currently does not support using
|
14292
14283
|
# `UserGroupResolutionConfiguration` with an Amazon Web Services
|
14293
|
-
# organization member account for your
|
14284
|
+
# organization member account for your IAM Identity Center identify
|
14294
14285
|
# source. You must create your index in the management account for the
|
14295
14286
|
# organization in order to use `UserGroupResolutionConfiguration`.
|
14296
14287
|
#
|
@@ -14309,10 +14300,10 @@ module Aws::Kendra
|
|
14309
14300
|
#
|
14310
14301
|
# @!attribute [rw] user_group_resolution_mode
|
14311
14302
|
# The identity store provider (mode) you want to use to fetch access
|
14312
|
-
# levels of groups and users.
|
14313
|
-
# currently the only available mode. Your users and groups
|
14314
|
-
# in an
|
14315
|
-
# 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.
|
14316
14307
|
# @return [String]
|
14317
14308
|
#
|
14318
14309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation
|
@@ -14334,14 +14325,13 @@ module Aws::Kendra
|
|
14334
14325
|
# }
|
14335
14326
|
#
|
14336
14327
|
# @!attribute [rw] identity_attribute_name
|
14337
|
-
# The
|
14338
|
-
#
|
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
|
14339
14330
|
# filtering][1] and for granting access to your Amazon Kendra
|
14340
|
-
# experience. You must set up
|
14341
|
-
#
|
14342
|
-
#
|
14343
|
-
#
|
14344
|
-
# 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].
|
14345
14335
|
#
|
14346
14336
|
#
|
14347
14337
|
#
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -13,9 +13,13 @@ require 'aws-sigv4'
|
|
13
13
|
|
14
14
|
require_relative 'aws-sdk-kendra/types'
|
15
15
|
require_relative 'aws-sdk-kendra/client_api'
|
16
|
+
require_relative 'aws-sdk-kendra/plugins/endpoints.rb'
|
16
17
|
require_relative 'aws-sdk-kendra/client'
|
17
18
|
require_relative 'aws-sdk-kendra/errors'
|
18
19
|
require_relative 'aws-sdk-kendra/resource'
|
20
|
+
require_relative 'aws-sdk-kendra/endpoint_parameters'
|
21
|
+
require_relative 'aws-sdk-kendra/endpoint_provider'
|
22
|
+
require_relative 'aws-sdk-kendra/endpoints'
|
19
23
|
require_relative 'aws-sdk-kendra/customizations'
|
20
24
|
|
21
25
|
# This module provides support for AWSKendraFrontendService. This module is available in the
|
@@ -48,6 +52,6 @@ require_relative 'aws-sdk-kendra/customizations'
|
|
48
52
|
# @!group service
|
49
53
|
module Aws::Kendra
|
50
54
|
|
51
|
-
GEM_VERSION = '1.
|
55
|
+
GEM_VERSION = '1.60.0'
|
52
56
|
|
53
57
|
end
|
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.60.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-10-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.165.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.165.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -59,7 +59,11 @@ files:
|
|
59
59
|
- lib/aws-sdk-kendra/client.rb
|
60
60
|
- lib/aws-sdk-kendra/client_api.rb
|
61
61
|
- lib/aws-sdk-kendra/customizations.rb
|
62
|
+
- lib/aws-sdk-kendra/endpoint_parameters.rb
|
63
|
+
- lib/aws-sdk-kendra/endpoint_provider.rb
|
64
|
+
- lib/aws-sdk-kendra/endpoints.rb
|
62
65
|
- lib/aws-sdk-kendra/errors.rb
|
66
|
+
- lib/aws-sdk-kendra/plugins/endpoints.rb
|
63
67
|
- lib/aws-sdk-kendra/resource.rb
|
64
68
|
- lib/aws-sdk-kendra/types.rb
|
65
69
|
homepage: https://github.com/aws/aws-sdk-ruby
|