aws-sdk-kendra 1.53.0 → 1.54.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +465 -120
- data/lib/aws-sdk-kendra/client_api.rb +144 -0
- data/lib/aws-sdk-kendra/types.rb +563 -194
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -10,6 +10,21 @@
|
|
10
10
|
module Aws::Kendra
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Summary information on an access control configuration that you
|
14
|
+
# created for your documents in an index.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] id
|
17
|
+
# The identifier of the access control configuration.
|
18
|
+
# @return [String]
|
19
|
+
#
|
20
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessControlConfigurationSummary AWS API Documentation
|
21
|
+
#
|
22
|
+
class AccessControlConfigurationSummary < Struct.new(
|
23
|
+
:id)
|
24
|
+
SENSITIVE = []
|
25
|
+
include Aws::Structure
|
26
|
+
end
|
27
|
+
|
13
28
|
# Access Control List files for the documents in a data source. For the
|
14
29
|
# format of the file, see [Access control for S3 data sources][1].
|
15
30
|
#
|
@@ -115,6 +130,16 @@ module Aws::Kendra
|
|
115
130
|
# Provides the configuration information to connect to Alfresco as your
|
116
131
|
# data source.
|
117
132
|
#
|
133
|
+
# <note markdown="1"> Alfresco data source connector is currently in preview mode. Basic
|
134
|
+
# authentication is currently supported. If you would like to use
|
135
|
+
# Alfresco connector in production, contact [Support][1].
|
136
|
+
#
|
137
|
+
# </note>
|
138
|
+
#
|
139
|
+
#
|
140
|
+
#
|
141
|
+
# [1]: http://aws.amazon.com/contact-us/
|
142
|
+
#
|
118
143
|
# @note When making an API call, you may pass AlfrescoConfiguration
|
119
144
|
# data as a hash:
|
120
145
|
#
|
@@ -187,7 +212,7 @@ module Aws::Kendra
|
|
187
212
|
# @return [Boolean]
|
188
213
|
#
|
189
214
|
# @!attribute [rw] crawl_comments
|
190
|
-
# `TRUE` to index comments of
|
215
|
+
# `TRUE` to index comments of blogs and other content.
|
191
216
|
# @return [Boolean]
|
192
217
|
#
|
193
218
|
# @!attribute [rw] entity_filter
|
@@ -1077,6 +1102,7 @@ module Aws::Kendra
|
|
1077
1102
|
# },
|
1078
1103
|
# ],
|
1079
1104
|
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
1105
|
+
# access_control_configuration_id: "AccessControlConfigurationId",
|
1080
1106
|
# },
|
1081
1107
|
# ],
|
1082
1108
|
# custom_document_enrichment_configuration: {
|
@@ -1863,7 +1889,7 @@ module Aws::Kendra
|
|
1863
1889
|
# contains the user name and password required to connect to the
|
1864
1890
|
# Confluence instance. If you use Confluence cloud, you use a
|
1865
1891
|
# generated API token as the password. For more information, see
|
1866
|
-
# [Using a
|
1892
|
+
# [Using a Confluence data source][1].
|
1867
1893
|
#
|
1868
1894
|
#
|
1869
1895
|
#
|
@@ -1871,8 +1897,7 @@ module Aws::Kendra
|
|
1871
1897
|
# @return [String]
|
1872
1898
|
#
|
1873
1899
|
# @!attribute [rw] version
|
1874
|
-
# The version or the type of
|
1875
|
-
# to.
|
1900
|
+
# The version or the type of Confluence installation to connect to.
|
1876
1901
|
# @return [String]
|
1877
1902
|
#
|
1878
1903
|
# @!attribute [rw] space_configuration
|
@@ -2274,6 +2299,101 @@ module Aws::Kendra
|
|
2274
2299
|
include Aws::Structure
|
2275
2300
|
end
|
2276
2301
|
|
2302
|
+
# @note When making an API call, you may pass CreateAccessControlConfigurationRequest
|
2303
|
+
# data as a hash:
|
2304
|
+
#
|
2305
|
+
# {
|
2306
|
+
# index_id: "IndexId", # required
|
2307
|
+
# name: "AccessControlConfigurationName", # required
|
2308
|
+
# description: "Description",
|
2309
|
+
# access_control_list: [
|
2310
|
+
# {
|
2311
|
+
# name: "PrincipalName", # required
|
2312
|
+
# type: "USER", # required, accepts USER, GROUP
|
2313
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
2314
|
+
# data_source_id: "DataSourceId",
|
2315
|
+
# },
|
2316
|
+
# ],
|
2317
|
+
# hierarchical_access_control_list: [
|
2318
|
+
# {
|
2319
|
+
# principal_list: [ # required
|
2320
|
+
# {
|
2321
|
+
# name: "PrincipalName", # required
|
2322
|
+
# type: "USER", # required, accepts USER, GROUP
|
2323
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
2324
|
+
# data_source_id: "DataSourceId",
|
2325
|
+
# },
|
2326
|
+
# ],
|
2327
|
+
# },
|
2328
|
+
# ],
|
2329
|
+
# client_token: "ClientTokenName",
|
2330
|
+
# }
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] index_id
|
2333
|
+
# The identifier of the index to create an access control
|
2334
|
+
# configuration for your documents.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @!attribute [rw] name
|
2338
|
+
# A name for the access control configuration.
|
2339
|
+
# @return [String]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] description
|
2342
|
+
# A description for the access control configuration.
|
2343
|
+
# @return [String]
|
2344
|
+
#
|
2345
|
+
# @!attribute [rw] access_control_list
|
2346
|
+
# Information on principals (users and/or groups) and which documents
|
2347
|
+
# they should have access to. This is useful for user context
|
2348
|
+
# filtering, where search results are filtered based on the user or
|
2349
|
+
# their group access to documents.
|
2350
|
+
# @return [Array<Types::Principal>]
|
2351
|
+
#
|
2352
|
+
# @!attribute [rw] hierarchical_access_control_list
|
2353
|
+
# The list of [principal][1] lists that define the hierarchy for which
|
2354
|
+
# documents users should have access to.
|
2355
|
+
#
|
2356
|
+
#
|
2357
|
+
#
|
2358
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
|
2359
|
+
# @return [Array<Types::HierarchicalPrincipal>]
|
2360
|
+
#
|
2361
|
+
# @!attribute [rw] client_token
|
2362
|
+
# A token that you provide to identify the request to create an access
|
2363
|
+
# control configuration. Multiple calls to the
|
2364
|
+
# `CreateAccessControlConfiguration` API with the same client token
|
2365
|
+
# will create only one access control configuration.
|
2366
|
+
#
|
2367
|
+
# **A suitable default value is auto-generated.** You should normally
|
2368
|
+
# not need to pass this option.
|
2369
|
+
# @return [String]
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationRequest AWS API Documentation
|
2372
|
+
#
|
2373
|
+
class CreateAccessControlConfigurationRequest < Struct.new(
|
2374
|
+
:index_id,
|
2375
|
+
:name,
|
2376
|
+
:description,
|
2377
|
+
:access_control_list,
|
2378
|
+
:hierarchical_access_control_list,
|
2379
|
+
:client_token)
|
2380
|
+
SENSITIVE = []
|
2381
|
+
include Aws::Structure
|
2382
|
+
end
|
2383
|
+
|
2384
|
+
# @!attribute [rw] id
|
2385
|
+
# The identifier of the access control configuration for your
|
2386
|
+
# documents in an index.
|
2387
|
+
# @return [String]
|
2388
|
+
#
|
2389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationResponse AWS API Documentation
|
2390
|
+
#
|
2391
|
+
class CreateAccessControlConfigurationResponse < Struct.new(
|
2392
|
+
:id)
|
2393
|
+
SENSITIVE = []
|
2394
|
+
include Aws::Structure
|
2395
|
+
end
|
2396
|
+
|
2277
2397
|
# @note When making an API call, you may pass CreateDataSourceRequest
|
2278
2398
|
# data as a hash:
|
2279
2399
|
#
|
@@ -2965,22 +3085,22 @@ module Aws::Kendra
|
|
2965
3085
|
# }
|
2966
3086
|
#
|
2967
3087
|
# @!attribute [rw] name
|
2968
|
-
# A unique name for the data source. A data source name
|
2969
|
-
# changed without deleting and recreating the data source
|
3088
|
+
# A unique name for the data source connector. A data source name
|
3089
|
+
# can't be changed without deleting and recreating the data source
|
3090
|
+
# connector.
|
2970
3091
|
# @return [String]
|
2971
3092
|
#
|
2972
3093
|
# @!attribute [rw] index_id
|
2973
|
-
# The identifier of the index
|
2974
|
-
#
|
3094
|
+
# The identifier of the index you want to use with the data source
|
3095
|
+
# connector.
|
2975
3096
|
# @return [String]
|
2976
3097
|
#
|
2977
3098
|
# @!attribute [rw] type
|
2978
|
-
# The type of
|
3099
|
+
# The type of data source repository. For example, `SHAREPOINT`.
|
2979
3100
|
# @return [String]
|
2980
3101
|
#
|
2981
3102
|
# @!attribute [rw] configuration
|
2982
|
-
# Configuration information
|
2983
|
-
# repository.
|
3103
|
+
# Configuration information to connect to your data source repository.
|
2984
3104
|
#
|
2985
3105
|
# You can't specify the `Configuration` parameter when the `Type`
|
2986
3106
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
@@ -2991,14 +3111,14 @@ module Aws::Kendra
|
|
2991
3111
|
# @return [Types::DataSourceConfiguration]
|
2992
3112
|
#
|
2993
3113
|
# @!attribute [rw] description
|
2994
|
-
# A description for the data source.
|
3114
|
+
# A description for the data source connector.
|
2995
3115
|
# @return [String]
|
2996
3116
|
#
|
2997
3117
|
# @!attribute [rw] schedule
|
2998
3118
|
# Sets the frequency for Amazon Kendra to check the documents in your
|
2999
|
-
# repository and update the index. If you don't set a
|
3000
|
-
# Kendra will not periodically update the index. You
|
3001
|
-
# `StartDataSourceSyncJob` API to update the index.
|
3119
|
+
# data source repository and update the index. If you don't set a
|
3120
|
+
# schedule Amazon Kendra will not periodically update the index. You
|
3121
|
+
# can call the `StartDataSourceSyncJob` API to update the index.
|
3002
3122
|
#
|
3003
3123
|
# You can't specify the `Schedule` parameter when the `Type`
|
3004
3124
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
@@ -3007,8 +3127,8 @@ module Aws::Kendra
|
|
3007
3127
|
#
|
3008
3128
|
# @!attribute [rw] role_arn
|
3009
3129
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
3010
|
-
# the data source. For more information, see [IAM Roles for
|
3011
|
-
# Kendra][1].
|
3130
|
+
# the data source connector. For more information, see [IAM Roles for
|
3131
|
+
# Amazon Kendra][1].
|
3012
3132
|
#
|
3013
3133
|
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
3014
3134
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -3022,15 +3142,15 @@ module Aws::Kendra
|
|
3022
3142
|
# @return [String]
|
3023
3143
|
#
|
3024
3144
|
# @!attribute [rw] tags
|
3025
|
-
# A list of key-value pairs that identify the data source.
|
3026
|
-
# the tags to identify and organize your resources and to
|
3027
|
-
# access to resources.
|
3145
|
+
# A list of key-value pairs that identify the data source connector.
|
3146
|
+
# You can use the tags to identify and organize your resources and to
|
3147
|
+
# control access to resources.
|
3028
3148
|
# @return [Array<Types::Tag>]
|
3029
3149
|
#
|
3030
3150
|
# @!attribute [rw] client_token
|
3031
3151
|
# A token that you provide to identify the request to create a data
|
3032
|
-
# source. Multiple calls to the `CreateDataSource` API with
|
3033
|
-
# client token will create only one data source.
|
3152
|
+
# source connector. Multiple calls to the `CreateDataSource` API with
|
3153
|
+
# the same client token will create only one data source connector.
|
3034
3154
|
#
|
3035
3155
|
# **A suitable default value is auto-generated.** You should normally
|
3036
3156
|
# not need to pass this option.
|
@@ -3038,9 +3158,9 @@ module Aws::Kendra
|
|
3038
3158
|
#
|
3039
3159
|
# @!attribute [rw] language_code
|
3040
3160
|
# The code for a language. This allows you to support a language for
|
3041
|
-
# all documents when creating the data source. English is
|
3042
|
-
# default. For more information on supported languages,
|
3043
|
-
# their codes, see [Adding documents in languages other than
|
3161
|
+
# all documents when creating the data source connector. English is
|
3162
|
+
# supported by default. For more information on supported languages,
|
3163
|
+
# including their codes, see [Adding documents in languages other than
|
3044
3164
|
# English][1].
|
3045
3165
|
#
|
3046
3166
|
#
|
@@ -3050,7 +3170,7 @@ module Aws::Kendra
|
|
3050
3170
|
#
|
3051
3171
|
# @!attribute [rw] custom_document_enrichment_configuration
|
3052
3172
|
# Configuration information for altering document metadata and content
|
3053
|
-
# during the document ingestion process
|
3173
|
+
# during the document ingestion process.
|
3054
3174
|
#
|
3055
3175
|
# For more information on how to create, modify and delete document
|
3056
3176
|
# metadata, or make other content alterations when you ingest
|
@@ -3081,7 +3201,7 @@ module Aws::Kendra
|
|
3081
3201
|
end
|
3082
3202
|
|
3083
3203
|
# @!attribute [rw] id
|
3084
|
-
#
|
3204
|
+
# The identifier of the data source connector.
|
3085
3205
|
# @return [String]
|
3086
3206
|
#
|
3087
3207
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceResponse AWS API Documentation
|
@@ -3203,19 +3323,19 @@ module Aws::Kendra
|
|
3203
3323
|
# }
|
3204
3324
|
#
|
3205
3325
|
# @!attribute [rw] index_id
|
3206
|
-
# The identifier of the index
|
3326
|
+
# The identifier of the index for the FAQ.
|
3207
3327
|
# @return [String]
|
3208
3328
|
#
|
3209
3329
|
# @!attribute [rw] name
|
3210
|
-
#
|
3330
|
+
# A name for the FAQ.
|
3211
3331
|
# @return [String]
|
3212
3332
|
#
|
3213
3333
|
# @!attribute [rw] description
|
3214
|
-
# A description
|
3334
|
+
# A description for the FAQ.
|
3215
3335
|
# @return [String]
|
3216
3336
|
#
|
3217
3337
|
# @!attribute [rw] s3_path
|
3218
|
-
# The
|
3338
|
+
# The path to the FAQ file in S3.
|
3219
3339
|
# @return [Types::S3Path]
|
3220
3340
|
#
|
3221
3341
|
# @!attribute [rw] role_arn
|
@@ -3235,7 +3355,7 @@ module Aws::Kendra
|
|
3235
3355
|
# @return [Array<Types::Tag>]
|
3236
3356
|
#
|
3237
3357
|
# @!attribute [rw] file_format
|
3238
|
-
# The format of the input file. You can choose between a basic CSV
|
3358
|
+
# The format of the FAQ input file. You can choose between a basic CSV
|
3239
3359
|
# format, a CSV format that includes customs attributes in a header,
|
3240
3360
|
# and a JSON format that includes custom attributes.
|
3241
3361
|
#
|
@@ -3339,7 +3459,7 @@ module Aws::Kendra
|
|
3339
3459
|
# }
|
3340
3460
|
#
|
3341
3461
|
# @!attribute [rw] name
|
3342
|
-
#
|
3462
|
+
# A name for the index.
|
3343
3463
|
# @return [String]
|
3344
3464
|
#
|
3345
3465
|
# @!attribute [rw] edition
|
@@ -3580,15 +3700,15 @@ module Aws::Kendra
|
|
3580
3700
|
# }
|
3581
3701
|
#
|
3582
3702
|
# @!attribute [rw] index_id
|
3583
|
-
# The
|
3703
|
+
# The identifier of the index for the thesaurus.
|
3584
3704
|
# @return [String]
|
3585
3705
|
#
|
3586
3706
|
# @!attribute [rw] name
|
3587
|
-
#
|
3707
|
+
# A name for the thesaurus.
|
3588
3708
|
# @return [String]
|
3589
3709
|
#
|
3590
3710
|
# @!attribute [rw] description
|
3591
|
-
#
|
3711
|
+
# A description for the thesaurus.
|
3592
3712
|
# @return [String]
|
3593
3713
|
#
|
3594
3714
|
# @!attribute [rw] role_arn
|
@@ -3603,7 +3723,7 @@ module Aws::Kendra
|
|
3603
3723
|
# @return [Array<Types::Tag>]
|
3604
3724
|
#
|
3605
3725
|
# @!attribute [rw] source_s3_path
|
3606
|
-
# The thesaurus file
|
3726
|
+
# The path to the thesaurus file in S3.
|
3607
3727
|
# @return [Types::S3Path]
|
3608
3728
|
#
|
3609
3729
|
# @!attribute [rw] client_token
|
@@ -4857,6 +4977,36 @@ module Aws::Kendra
|
|
4857
4977
|
include Aws::Structure
|
4858
4978
|
end
|
4859
4979
|
|
4980
|
+
# @note When making an API call, you may pass DeleteAccessControlConfigurationRequest
|
4981
|
+
# data as a hash:
|
4982
|
+
#
|
4983
|
+
# {
|
4984
|
+
# index_id: "IndexId", # required
|
4985
|
+
# id: "AccessControlConfigurationId", # required
|
4986
|
+
# }
|
4987
|
+
#
|
4988
|
+
# @!attribute [rw] index_id
|
4989
|
+
# The identifier of the index for an access control configuration.
|
4990
|
+
# @return [String]
|
4991
|
+
#
|
4992
|
+
# @!attribute [rw] id
|
4993
|
+
# The identifier of the access control configuration you want to
|
4994
|
+
# delete.
|
4995
|
+
# @return [String]
|
4996
|
+
#
|
4997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationRequest AWS API Documentation
|
4998
|
+
#
|
4999
|
+
class DeleteAccessControlConfigurationRequest < Struct.new(
|
5000
|
+
:index_id,
|
5001
|
+
:id)
|
5002
|
+
SENSITIVE = []
|
5003
|
+
include Aws::Structure
|
5004
|
+
end
|
5005
|
+
|
5006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationResponse AWS API Documentation
|
5007
|
+
#
|
5008
|
+
class DeleteAccessControlConfigurationResponse < Aws::EmptyStructure; end
|
5009
|
+
|
4860
5010
|
# @note When making an API call, you may pass DeleteDataSourceRequest
|
4861
5011
|
# data as a hash:
|
4862
5012
|
#
|
@@ -4866,11 +5016,11 @@ module Aws::Kendra
|
|
4866
5016
|
# }
|
4867
5017
|
#
|
4868
5018
|
# @!attribute [rw] id
|
4869
|
-
# The
|
5019
|
+
# The identifier of the data source you want to delete.
|
4870
5020
|
# @return [String]
|
4871
5021
|
#
|
4872
5022
|
# @!attribute [rw] index_id
|
4873
|
-
# The
|
5023
|
+
# The identifier of the index used with the data source.
|
4874
5024
|
# @return [String]
|
4875
5025
|
#
|
4876
5026
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
|
@@ -4895,8 +5045,7 @@ module Aws::Kendra
|
|
4895
5045
|
# @return [String]
|
4896
5046
|
#
|
4897
5047
|
# @!attribute [rw] index_id
|
4898
|
-
# The identifier of the index for your Amazon Kendra experience
|
4899
|
-
# want to delete.
|
5048
|
+
# The identifier of the index for your Amazon Kendra experience.
|
4900
5049
|
# @return [String]
|
4901
5050
|
#
|
4902
5051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperienceRequest AWS API Documentation
|
@@ -4921,11 +5070,11 @@ module Aws::Kendra
|
|
4921
5070
|
# }
|
4922
5071
|
#
|
4923
5072
|
# @!attribute [rw] id
|
4924
|
-
# The identifier of the FAQ to remove.
|
5073
|
+
# The identifier of the FAQ you want to remove.
|
4925
5074
|
# @return [String]
|
4926
5075
|
#
|
4927
5076
|
# @!attribute [rw] index_id
|
4928
|
-
# The index
|
5077
|
+
# The identifier of the index for the FAQ.
|
4929
5078
|
# @return [String]
|
4930
5079
|
#
|
4931
5080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaqRequest AWS API Documentation
|
@@ -4945,7 +5094,7 @@ module Aws::Kendra
|
|
4945
5094
|
# }
|
4946
5095
|
#
|
4947
5096
|
# @!attribute [rw] id
|
4948
|
-
# The identifier of the index to delete.
|
5097
|
+
# The identifier of the index you want to delete.
|
4949
5098
|
# @return [String]
|
4950
5099
|
#
|
4951
5100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndexRequest AWS API Documentation
|
@@ -4973,15 +5122,15 @@ module Aws::Kendra
|
|
4973
5122
|
# @!attribute [rw] data_source_id
|
4974
5123
|
# The identifier of the data source you want to delete a group from.
|
4975
5124
|
#
|
4976
|
-
#
|
4977
|
-
#
|
4978
|
-
#
|
4979
|
-
#
|
4980
|
-
#
|
4981
|
-
#
|
4982
|
-
#
|
4983
|
-
#
|
4984
|
-
#
|
5125
|
+
# A group can be tied to multiple data sources. You can delete a group
|
5126
|
+
# from accessing documents in a certain data source. For example, the
|
5127
|
+
# groups "Research", "Engineering", and "Sales and Marketing"
|
5128
|
+
# are all tied to the company's documents stored in the data sources
|
5129
|
+
# Confluence and Salesforce. You want to delete "Research" and
|
5130
|
+
# "Engineering" groups from Salesforce, so that these groups cannot
|
5131
|
+
# access customer-related documents stored in Salesforce. Only "Sales
|
5132
|
+
# and Marketing" should access documents in the Salesforce data
|
5133
|
+
# source.
|
4985
5134
|
# @return [String]
|
4986
5135
|
#
|
4987
5136
|
# @!attribute [rw] group_id
|
@@ -5027,11 +5176,11 @@ module Aws::Kendra
|
|
5027
5176
|
# }
|
5028
5177
|
#
|
5029
5178
|
# @!attribute [rw] index_id
|
5030
|
-
# The identifier of the
|
5179
|
+
# The identifier of the index for the block list.
|
5031
5180
|
# @return [String]
|
5032
5181
|
#
|
5033
5182
|
# @!attribute [rw] id
|
5034
|
-
# The
|
5183
|
+
# The identifier of the block list you want to delete.
|
5035
5184
|
# @return [String]
|
5036
5185
|
#
|
5037
5186
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
|
@@ -5052,11 +5201,11 @@ module Aws::Kendra
|
|
5052
5201
|
# }
|
5053
5202
|
#
|
5054
5203
|
# @!attribute [rw] id
|
5055
|
-
# The identifier of the thesaurus to delete.
|
5204
|
+
# The identifier of the thesaurus you want to delete.
|
5056
5205
|
# @return [String]
|
5057
5206
|
#
|
5058
5207
|
# @!attribute [rw] index_id
|
5059
|
-
# The identifier of the index
|
5208
|
+
# The identifier of the index for the thesaurus.
|
5060
5209
|
# @return [String]
|
5061
5210
|
#
|
5062
5211
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurusRequest AWS API Documentation
|
@@ -5068,6 +5217,73 @@ module Aws::Kendra
|
|
5068
5217
|
include Aws::Structure
|
5069
5218
|
end
|
5070
5219
|
|
5220
|
+
# @note When making an API call, you may pass DescribeAccessControlConfigurationRequest
|
5221
|
+
# data as a hash:
|
5222
|
+
#
|
5223
|
+
# {
|
5224
|
+
# index_id: "IndexId", # required
|
5225
|
+
# id: "AccessControlConfigurationId", # required
|
5226
|
+
# }
|
5227
|
+
#
|
5228
|
+
# @!attribute [rw] index_id
|
5229
|
+
# The identifier of the index for an access control configuration.
|
5230
|
+
# @return [String]
|
5231
|
+
#
|
5232
|
+
# @!attribute [rw] id
|
5233
|
+
# The identifier of the access control configuration you want to get
|
5234
|
+
# information on.
|
5235
|
+
# @return [String]
|
5236
|
+
#
|
5237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationRequest AWS API Documentation
|
5238
|
+
#
|
5239
|
+
class DescribeAccessControlConfigurationRequest < Struct.new(
|
5240
|
+
:index_id,
|
5241
|
+
:id)
|
5242
|
+
SENSITIVE = []
|
5243
|
+
include Aws::Structure
|
5244
|
+
end
|
5245
|
+
|
5246
|
+
# @!attribute [rw] name
|
5247
|
+
# The name for the access control configuration.
|
5248
|
+
# @return [String]
|
5249
|
+
#
|
5250
|
+
# @!attribute [rw] description
|
5251
|
+
# The description for the access control configuration.
|
5252
|
+
# @return [String]
|
5253
|
+
#
|
5254
|
+
# @!attribute [rw] error_message
|
5255
|
+
# The error message containing details if there are issues processing
|
5256
|
+
# the access control configuration.
|
5257
|
+
# @return [String]
|
5258
|
+
#
|
5259
|
+
# @!attribute [rw] access_control_list
|
5260
|
+
# Information on principals (users and/or groups) and which documents
|
5261
|
+
# they should have access to. This is useful for user context
|
5262
|
+
# filtering, where search results are filtered based on the user or
|
5263
|
+
# their group access to documents.
|
5264
|
+
# @return [Array<Types::Principal>]
|
5265
|
+
#
|
5266
|
+
# @!attribute [rw] hierarchical_access_control_list
|
5267
|
+
# The list of [principal][1] lists that define the hierarchy for which
|
5268
|
+
# documents users should have access to.
|
5269
|
+
#
|
5270
|
+
#
|
5271
|
+
#
|
5272
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
|
5273
|
+
# @return [Array<Types::HierarchicalPrincipal>]
|
5274
|
+
#
|
5275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationResponse AWS API Documentation
|
5276
|
+
#
|
5277
|
+
class DescribeAccessControlConfigurationResponse < Struct.new(
|
5278
|
+
:name,
|
5279
|
+
:description,
|
5280
|
+
:error_message,
|
5281
|
+
:access_control_list,
|
5282
|
+
:hierarchical_access_control_list)
|
5283
|
+
SENSITIVE = []
|
5284
|
+
include Aws::Structure
|
5285
|
+
end
|
5286
|
+
|
5071
5287
|
# @note When making an API call, you may pass DescribeDataSourceRequest
|
5072
5288
|
# data as a hash:
|
5073
5289
|
#
|
@@ -5077,11 +5293,11 @@ module Aws::Kendra
|
|
5077
5293
|
# }
|
5078
5294
|
#
|
5079
5295
|
# @!attribute [rw] id
|
5080
|
-
# The
|
5296
|
+
# The identifier of the data source.
|
5081
5297
|
# @return [String]
|
5082
5298
|
#
|
5083
5299
|
# @!attribute [rw] index_id
|
5084
|
-
# The identifier of the index
|
5300
|
+
# The identifier of the index used with the data source.
|
5085
5301
|
# @return [String]
|
5086
5302
|
#
|
5087
5303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceRequest AWS API Documentation
|
@@ -5110,8 +5326,9 @@ module Aws::Kendra
|
|
5110
5326
|
# @return [String]
|
5111
5327
|
#
|
5112
5328
|
# @!attribute [rw] configuration
|
5113
|
-
#
|
5114
|
-
#
|
5329
|
+
# Configuration details for the data source. This shows how the data
|
5330
|
+
# source is configured. The configuration options for a data source
|
5331
|
+
# depend on the data source provider.
|
5115
5332
|
# @return [Types::DataSourceConfiguration]
|
5116
5333
|
#
|
5117
5334
|
# @!attribute [rw] created_at
|
@@ -5123,7 +5340,7 @@ module Aws::Kendra
|
|
5123
5340
|
# @return [Time]
|
5124
5341
|
#
|
5125
5342
|
# @!attribute [rw] description
|
5126
|
-
# The description
|
5343
|
+
# The description for the data source.
|
5127
5344
|
# @return [String]
|
5128
5345
|
#
|
5129
5346
|
# @!attribute [rw] status
|
@@ -5209,8 +5426,7 @@ module Aws::Kendra
|
|
5209
5426
|
# @return [String]
|
5210
5427
|
#
|
5211
5428
|
# @!attribute [rw] index_id
|
5212
|
-
# The identifier of the index for your Amazon Kendra experience
|
5213
|
-
# want to get information on.
|
5429
|
+
# The identifier of the index for your Amazon Kendra experience.
|
5214
5430
|
# @return [String]
|
5215
5431
|
#
|
5216
5432
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperienceRequest AWS API Documentation
|
@@ -5304,11 +5520,11 @@ module Aws::Kendra
|
|
5304
5520
|
# }
|
5305
5521
|
#
|
5306
5522
|
# @!attribute [rw] id
|
5307
|
-
# The
|
5523
|
+
# The identifier of the FAQ you want to get information on.
|
5308
5524
|
# @return [String]
|
5309
5525
|
#
|
5310
5526
|
# @!attribute [rw] index_id
|
5311
|
-
# The identifier of the index
|
5527
|
+
# The identifier of the index for the FAQ.
|
5312
5528
|
# @return [String]
|
5313
5529
|
#
|
5314
5530
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqRequest AWS API Documentation
|
@@ -5325,7 +5541,7 @@ module Aws::Kendra
|
|
5325
5541
|
# @return [String]
|
5326
5542
|
#
|
5327
5543
|
# @!attribute [rw] index_id
|
5328
|
-
# The identifier of the index
|
5544
|
+
# The identifier of the index for the FAQ.
|
5329
5545
|
# @return [String]
|
5330
5546
|
#
|
5331
5547
|
# @!attribute [rw] name
|
@@ -5405,7 +5621,7 @@ module Aws::Kendra
|
|
5405
5621
|
# }
|
5406
5622
|
#
|
5407
5623
|
# @!attribute [rw] id
|
5408
|
-
# The identifier of the index to
|
5624
|
+
# The identifier of the index you want to get information on.
|
5409
5625
|
# @return [String]
|
5410
5626
|
#
|
5411
5627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexRequest AWS API Documentation
|
@@ -5458,8 +5674,10 @@ module Aws::Kendra
|
|
5458
5674
|
# @return [Time]
|
5459
5675
|
#
|
5460
5676
|
# @!attribute [rw] document_metadata_configurations
|
5461
|
-
# Configuration
|
5462
|
-
#
|
5677
|
+
# Configuration information for document metadata or fields. Document
|
5678
|
+
# metadata are fields or attributes associated with your documents.
|
5679
|
+
# For example, the company department name associated with each
|
5680
|
+
# document.
|
5463
5681
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
5464
5682
|
#
|
5465
5683
|
# @!attribute [rw] index_statistics
|
@@ -5494,7 +5712,7 @@ module Aws::Kendra
|
|
5494
5712
|
# @return [String]
|
5495
5713
|
#
|
5496
5714
|
# @!attribute [rw] user_group_resolution_configuration
|
5497
|
-
#
|
5715
|
+
# Whether you have enabled the configuration for fetching access
|
5498
5716
|
# levels of groups and users from an Amazon Web Services Single Sign
|
5499
5717
|
# On identity source.
|
5500
5718
|
# @return [Types::UserGroupResolutionConfiguration]
|
@@ -5615,7 +5833,7 @@ module Aws::Kendra
|
|
5615
5833
|
# @return [String]
|
5616
5834
|
#
|
5617
5835
|
# @!attribute [rw] id
|
5618
|
-
# The
|
5836
|
+
# The identifier of the block list you want to get information on.
|
5619
5837
|
# @return [String]
|
5620
5838
|
#
|
5621
5839
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
|
@@ -5628,38 +5846,37 @@ module Aws::Kendra
|
|
5628
5846
|
end
|
5629
5847
|
|
5630
5848
|
# @!attribute [rw] index_id
|
5631
|
-
#
|
5849
|
+
# The identifier of the index for the block list.
|
5632
5850
|
# @return [String]
|
5633
5851
|
#
|
5634
5852
|
# @!attribute [rw] id
|
5635
|
-
#
|
5853
|
+
# The identifier of the block list.
|
5636
5854
|
# @return [String]
|
5637
5855
|
#
|
5638
5856
|
# @!attribute [rw] name
|
5639
|
-
#
|
5857
|
+
# The name of the block list.
|
5640
5858
|
# @return [String]
|
5641
5859
|
#
|
5642
5860
|
# @!attribute [rw] description
|
5643
|
-
#
|
5861
|
+
# The description for the block list.
|
5644
5862
|
# @return [String]
|
5645
5863
|
#
|
5646
5864
|
# @!attribute [rw] status
|
5647
|
-
#
|
5648
|
-
#
|
5865
|
+
# The current status of the block list. When the value is `ACTIVE`,
|
5866
|
+
# the block list is ready for use.
|
5649
5867
|
# @return [String]
|
5650
5868
|
#
|
5651
5869
|
# @!attribute [rw] error_message
|
5652
|
-
#
|
5653
|
-
#
|
5870
|
+
# The error message containing details if there are issues processing
|
5871
|
+
# the block list.
|
5654
5872
|
# @return [String]
|
5655
5873
|
#
|
5656
5874
|
# @!attribute [rw] created_at
|
5657
|
-
#
|
5875
|
+
# The date-time a block list for query suggestions was created.
|
5658
5876
|
# @return [Time]
|
5659
5877
|
#
|
5660
5878
|
# @!attribute [rw] updated_at
|
5661
|
-
#
|
5662
|
-
# updated.
|
5879
|
+
# The date-time a block list for query suggestions was last updated.
|
5663
5880
|
# @return [Time]
|
5664
5881
|
#
|
5665
5882
|
# @!attribute [rw] source_s3_path
|
@@ -5678,17 +5895,17 @@ module Aws::Kendra
|
|
5678
5895
|
# @return [Types::S3Path]
|
5679
5896
|
#
|
5680
5897
|
# @!attribute [rw] item_count
|
5681
|
-
#
|
5682
|
-
#
|
5898
|
+
# The current number of valid, non-empty words or phrases in the block
|
5899
|
+
# list text file.
|
5683
5900
|
# @return [Integer]
|
5684
5901
|
#
|
5685
5902
|
# @!attribute [rw] file_size_bytes
|
5686
|
-
#
|
5903
|
+
# The current size of the block list text file in S3.
|
5687
5904
|
# @return [Integer]
|
5688
5905
|
#
|
5689
5906
|
# @!attribute [rw] role_arn
|
5690
|
-
#
|
5691
|
-
#
|
5907
|
+
# The IAM (Identity and Access Management) role used by Amazon Kendra
|
5908
|
+
# to access the block list text file in S3.
|
5692
5909
|
#
|
5693
5910
|
# The role needs S3 read permissions to your file in S3 and needs to
|
5694
5911
|
# give STS (Security Token Service) assume role permissions to Amazon
|
@@ -5722,8 +5939,8 @@ module Aws::Kendra
|
|
5722
5939
|
# }
|
5723
5940
|
#
|
5724
5941
|
# @!attribute [rw] index_id
|
5725
|
-
# The identifier of the index you want to
|
5726
|
-
#
|
5942
|
+
# The identifier of the index with query suggestions that you want to
|
5943
|
+
# get information on.
|
5727
5944
|
# @return [String]
|
5728
5945
|
#
|
5729
5946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
|
@@ -5735,7 +5952,7 @@ module Aws::Kendra
|
|
5735
5952
|
end
|
5736
5953
|
|
5737
5954
|
# @!attribute [rw] mode
|
5738
|
-
#
|
5955
|
+
# Whether query suggestions are currently in `ENABLED` mode or
|
5739
5956
|
# `LEARN_ONLY` mode.
|
5740
5957
|
#
|
5741
5958
|
# By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
|
@@ -5748,39 +5965,38 @@ module Aws::Kendra
|
|
5748
5965
|
# @return [String]
|
5749
5966
|
#
|
5750
5967
|
# @!attribute [rw] status
|
5751
|
-
#
|
5752
|
-
#
|
5968
|
+
# Whether the status of query suggestions settings is currently
|
5969
|
+
# `ACTIVE` or `UPDATING`.
|
5753
5970
|
#
|
5754
5971
|
# Active means the current settings apply and Updating means your
|
5755
5972
|
# changed settings are in the process of applying.
|
5756
5973
|
# @return [String]
|
5757
5974
|
#
|
5758
5975
|
# @!attribute [rw] query_log_look_back_window_in_days
|
5759
|
-
#
|
5760
|
-
# days).
|
5976
|
+
# How recent your queries are in your query log time window (in days).
|
5761
5977
|
# @return [Integer]
|
5762
5978
|
#
|
5763
5979
|
# @!attribute [rw] include_queries_without_user_information
|
5764
|
-
#
|
5765
|
-
#
|
5980
|
+
# `TRUE` to use all queries, otherwise use only queries that include
|
5981
|
+
# user information to generate the query suggestions.
|
5766
5982
|
# @return [Boolean]
|
5767
5983
|
#
|
5768
5984
|
# @!attribute [rw] minimum_number_of_querying_users
|
5769
|
-
#
|
5770
|
-
#
|
5985
|
+
# The minimum number of unique users who must search a query in order
|
5986
|
+
# for the query to be eligible to suggest to your users.
|
5771
5987
|
# @return [Integer]
|
5772
5988
|
#
|
5773
5989
|
# @!attribute [rw] minimum_query_count
|
5774
|
-
#
|
5775
|
-
#
|
5990
|
+
# The minimum number of times a query must be searched in order for
|
5991
|
+
# the query to be eligible to suggest to your users.
|
5776
5992
|
# @return [Integer]
|
5777
5993
|
#
|
5778
5994
|
# @!attribute [rw] last_suggestions_build_time
|
5779
|
-
#
|
5995
|
+
# The date-time query suggestions for an index was last updated.
|
5780
5996
|
# @return [Time]
|
5781
5997
|
#
|
5782
5998
|
# @!attribute [rw] last_clear_time
|
5783
|
-
#
|
5999
|
+
# The date-time query suggestions for an index was last cleared.
|
5784
6000
|
#
|
5785
6001
|
# After you clear suggestions, Amazon Kendra learns new suggestions
|
5786
6002
|
# based on new queries added to the query log from the time you
|
@@ -5789,7 +6005,7 @@ module Aws::Kendra
|
|
5789
6005
|
# @return [Time]
|
5790
6006
|
#
|
5791
6007
|
# @!attribute [rw] total_suggestions_count
|
5792
|
-
#
|
6008
|
+
# The current total count of query suggestions for an index.
|
5793
6009
|
#
|
5794
6010
|
# This count can change when you update your query suggestions
|
5795
6011
|
# settings, if you filter out certain queries from suggestions using a
|
@@ -5822,12 +6038,11 @@ module Aws::Kendra
|
|
5822
6038
|
# }
|
5823
6039
|
#
|
5824
6040
|
# @!attribute [rw] id
|
5825
|
-
# The identifier of the thesaurus to
|
6041
|
+
# The identifier of the thesaurus you want to get information on.
|
5826
6042
|
# @return [String]
|
5827
6043
|
#
|
5828
6044
|
# @!attribute [rw] index_id
|
5829
|
-
# The identifier of the index
|
5830
|
-
# describe.
|
6045
|
+
# The identifier of the index for the thesaurus.
|
5831
6046
|
# @return [String]
|
5832
6047
|
#
|
5833
6048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
|
@@ -5844,8 +6059,7 @@ module Aws::Kendra
|
|
5844
6059
|
# @return [String]
|
5845
6060
|
#
|
5846
6061
|
# @!attribute [rw] index_id
|
5847
|
-
# The identifier of the index
|
5848
|
-
# describe.
|
6062
|
+
# The identifier of the index for the thesaurus.
|
5849
6063
|
# @return [String]
|
5850
6064
|
#
|
5851
6065
|
# @!attribute [rw] name
|
@@ -6063,6 +6277,7 @@ module Aws::Kendra
|
|
6063
6277
|
# },
|
6064
6278
|
# ],
|
6065
6279
|
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
6280
|
+
# access_control_configuration_id: "AccessControlConfigurationId",
|
6066
6281
|
# }
|
6067
6282
|
#
|
6068
6283
|
# @!attribute [rw] id
|
@@ -6107,8 +6322,10 @@ module Aws::Kendra
|
|
6107
6322
|
# @return [Array<Types::DocumentAttribute>]
|
6108
6323
|
#
|
6109
6324
|
# @!attribute [rw] access_control_list
|
6110
|
-
# Information on
|
6111
|
-
#
|
6325
|
+
# Information on principals (users and/or groups) and which documents
|
6326
|
+
# they should have access to. This is useful for user context
|
6327
|
+
# filtering, where search results are filtered based on the user or
|
6328
|
+
# their group access to documents.
|
6112
6329
|
# @return [Array<Types::Principal>]
|
6113
6330
|
#
|
6114
6331
|
# @!attribute [rw] hierarchical_access_control_list
|
@@ -6124,6 +6341,11 @@ module Aws::Kendra
|
|
6124
6341
|
# The file type of the document in the `Blob` field.
|
6125
6342
|
# @return [String]
|
6126
6343
|
#
|
6344
|
+
# @!attribute [rw] access_control_configuration_id
|
6345
|
+
# The identifier of the access control configuration that you want to
|
6346
|
+
# apply to the document.
|
6347
|
+
# @return [String]
|
6348
|
+
#
|
6127
6349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Document AWS API Documentation
|
6128
6350
|
#
|
6129
6351
|
class Document < Struct.new(
|
@@ -6134,7 +6356,8 @@ module Aws::Kendra
|
|
6134
6356
|
:attributes,
|
6135
6357
|
:access_control_list,
|
6136
6358
|
:hierarchical_access_control_list,
|
6137
|
-
:content_type
|
6359
|
+
:content_type,
|
6360
|
+
:access_control_configuration_id)
|
6138
6361
|
SENSITIVE = []
|
6139
6362
|
include Aws::Structure
|
6140
6363
|
end
|
@@ -6451,7 +6674,8 @@ module Aws::Kendra
|
|
6451
6674
|
include Aws::Structure
|
6452
6675
|
end
|
6453
6676
|
|
6454
|
-
# Specifies the properties
|
6677
|
+
# Specifies the properties, such as relevance tuning and searchability,
|
6678
|
+
# of an index field.
|
6455
6679
|
#
|
6456
6680
|
# @note When making an API call, you may pass DocumentMetadataConfiguration
|
6457
6681
|
# data as a hash:
|
@@ -6485,8 +6709,8 @@ module Aws::Kendra
|
|
6485
6709
|
# @return [String]
|
6486
6710
|
#
|
6487
6711
|
# @!attribute [rw] relevance
|
6488
|
-
# Provides
|
6489
|
-
#
|
6712
|
+
# Provides tuning parameters to determine how the field affects the
|
6713
|
+
# search results.
|
6490
6714
|
# @return [Types::Relevance]
|
6491
6715
|
#
|
6492
6716
|
# @!attribute [rw] search
|
@@ -6523,13 +6747,12 @@ module Aws::Kendra
|
|
6523
6747
|
# }
|
6524
6748
|
#
|
6525
6749
|
# @!attribute [rw] name
|
6526
|
-
# The name of the
|
6527
|
-
# at the index level.
|
6750
|
+
# The name of the index field.
|
6528
6751
|
# @return [String]
|
6529
6752
|
#
|
6530
6753
|
# @!attribute [rw] relevance
|
6531
|
-
# Provides information for
|
6532
|
-
#
|
6754
|
+
# Provides information for tuning the relevance of a field in a
|
6755
|
+
# search. When a query includes terms that match the field, the
|
6533
6756
|
# results are given a boost in the response based on these tuning
|
6534
6757
|
# parameters.
|
6535
6758
|
# @return [Types::Relevance]
|
@@ -6954,8 +7177,8 @@ module Aws::Kendra
|
|
6954
7177
|
include Aws::Structure
|
6955
7178
|
end
|
6956
7179
|
|
6957
|
-
#
|
6958
|
-
#
|
7180
|
+
# Summary information for frequently asked questions and answers
|
7181
|
+
# included in an index.
|
6959
7182
|
#
|
6960
7183
|
# @!attribute [rw] id
|
6961
7184
|
# The unique identifier of the FAQ.
|
@@ -7789,9 +8012,9 @@ module Aws::Kendra
|
|
7789
8012
|
include Aws::Structure
|
7790
8013
|
end
|
7791
8014
|
|
7792
|
-
# A list of users or sub groups that belong to a group.
|
7793
|
-
#
|
7794
|
-
# their group
|
8015
|
+
# A list of users or sub groups that belong to a group. This is useful
|
8016
|
+
# for user context filtering, where search results are filtered based on
|
8017
|
+
# the user or their group access to documents.
|
7795
8018
|
#
|
7796
8019
|
# @note When making an API call, you may pass GroupMembers
|
7797
8020
|
# data as a hash:
|
@@ -7852,8 +8075,8 @@ module Aws::Kendra
|
|
7852
8075
|
include Aws::Structure
|
7853
8076
|
end
|
7854
8077
|
|
7855
|
-
#
|
7856
|
-
# mapping users to their groups.
|
8078
|
+
# Summary information on the processing of `PUT` and `DELETE` actions
|
8079
|
+
# for mapping users to their groups.
|
7857
8080
|
#
|
7858
8081
|
# @!attribute [rw] status
|
7859
8082
|
# The current processing status of actions for mapping users to their
|
@@ -7893,7 +8116,7 @@ module Aws::Kendra
|
|
7893
8116
|
include Aws::Structure
|
7894
8117
|
end
|
7895
8118
|
|
7896
|
-
#
|
8119
|
+
# Summary information for groups.
|
7897
8120
|
#
|
7898
8121
|
# @!attribute [rw] group_id
|
7899
8122
|
# The identifier of the group you want group summary information on.
|
@@ -8057,7 +8280,7 @@ module Aws::Kendra
|
|
8057
8280
|
include Aws::Structure
|
8058
8281
|
end
|
8059
8282
|
|
8060
|
-
#
|
8283
|
+
# Summary information on the configuration of an index.
|
8061
8284
|
#
|
8062
8285
|
# @!attribute [rw] name
|
8063
8286
|
# The identifier of the index.
|
@@ -8513,6 +8736,59 @@ module Aws::Kendra
|
|
8513
8736
|
include Aws::Structure
|
8514
8737
|
end
|
8515
8738
|
|
8739
|
+
# @note When making an API call, you may pass ListAccessControlConfigurationsRequest
|
8740
|
+
# data as a hash:
|
8741
|
+
#
|
8742
|
+
# {
|
8743
|
+
# index_id: "IndexId", # required
|
8744
|
+
# next_token: "String",
|
8745
|
+
# max_results: 1,
|
8746
|
+
# }
|
8747
|
+
#
|
8748
|
+
# @!attribute [rw] index_id
|
8749
|
+
# The identifier of the index for the access control configuration.
|
8750
|
+
# @return [String]
|
8751
|
+
#
|
8752
|
+
# @!attribute [rw] next_token
|
8753
|
+
# If the previous response was incomplete (because there is more data
|
8754
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
8755
|
+
# response. You can use this pagination token to retrieve the next set
|
8756
|
+
# of access control configurations.
|
8757
|
+
# @return [String]
|
8758
|
+
#
|
8759
|
+
# @!attribute [rw] max_results
|
8760
|
+
# The maximum number of access control configurations to return.
|
8761
|
+
# @return [Integer]
|
8762
|
+
#
|
8763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsRequest AWS API Documentation
|
8764
|
+
#
|
8765
|
+
class ListAccessControlConfigurationsRequest < Struct.new(
|
8766
|
+
:index_id,
|
8767
|
+
:next_token,
|
8768
|
+
:max_results)
|
8769
|
+
SENSITIVE = []
|
8770
|
+
include Aws::Structure
|
8771
|
+
end
|
8772
|
+
|
8773
|
+
# @!attribute [rw] next_token
|
8774
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
8775
|
+
# you can use in the subsequent request to retrieve the next set of
|
8776
|
+
# access control configurations.
|
8777
|
+
# @return [String]
|
8778
|
+
#
|
8779
|
+
# @!attribute [rw] access_control_configurations
|
8780
|
+
# The details of your access control configurations.
|
8781
|
+
# @return [Array<Types::AccessControlConfigurationSummary>]
|
8782
|
+
#
|
8783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsResponse AWS API Documentation
|
8784
|
+
#
|
8785
|
+
class ListAccessControlConfigurationsResponse < Struct.new(
|
8786
|
+
:next_token,
|
8787
|
+
:access_control_configurations)
|
8788
|
+
SENSITIVE = []
|
8789
|
+
include Aws::Structure
|
8790
|
+
end
|
8791
|
+
|
8516
8792
|
# @note When making an API call, you may pass ListDataSourceSyncJobsRequest
|
8517
8793
|
# data as a hash:
|
8518
8794
|
#
|
@@ -8533,7 +8809,7 @@ module Aws::Kendra
|
|
8533
8809
|
# @return [String]
|
8534
8810
|
#
|
8535
8811
|
# @!attribute [rw] index_id
|
8536
|
-
# The identifier of the index
|
8812
|
+
# The identifier of the index used with the data source.
|
8537
8813
|
# @return [String]
|
8538
8814
|
#
|
8539
8815
|
# @!attribute [rw] next_token
|
@@ -8601,7 +8877,7 @@ module Aws::Kendra
|
|
8601
8877
|
# }
|
8602
8878
|
#
|
8603
8879
|
# @!attribute [rw] index_id
|
8604
|
-
# The identifier of the index
|
8880
|
+
# The identifier of the index used with one or more data sources.
|
8605
8881
|
# @return [String]
|
8606
8882
|
#
|
8607
8883
|
# @!attribute [rw] next_token
|
@@ -9099,7 +9375,7 @@ module Aws::Kendra
|
|
9099
9375
|
# }
|
9100
9376
|
#
|
9101
9377
|
# @!attribute [rw] index_id
|
9102
|
-
# The identifier of the index
|
9378
|
+
# The identifier of the index with one or more thesauri.
|
9103
9379
|
# @return [String]
|
9104
9380
|
#
|
9105
9381
|
# @!attribute [rw] next_token
|
@@ -9413,7 +9689,11 @@ module Aws::Kendra
|
|
9413
9689
|
include Aws::Structure
|
9414
9690
|
end
|
9415
9691
|
|
9416
|
-
# Provides user and group information for
|
9692
|
+
# Provides user and group information for [user context filtering][1].
|
9693
|
+
#
|
9694
|
+
#
|
9695
|
+
#
|
9696
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
|
9417
9697
|
#
|
9418
9698
|
# @note When making an API call, you may pass Principal
|
9419
9699
|
# data as a hash:
|
@@ -9434,7 +9714,7 @@ module Aws::Kendra
|
|
9434
9714
|
# @return [String]
|
9435
9715
|
#
|
9436
9716
|
# @!attribute [rw] access
|
9437
|
-
# Whether to allow or deny access to the principal.
|
9717
|
+
# Whether to allow or deny document access to the principal.
|
9438
9718
|
# @return [String]
|
9439
9719
|
#
|
9440
9720
|
# @!attribute [rw] data_source_id
|
@@ -10119,7 +10399,7 @@ module Aws::Kendra
|
|
10119
10399
|
# @return [Boolean]
|
10120
10400
|
#
|
10121
10401
|
# @!attribute [rw] folder_ids
|
10122
|
-
# The
|
10402
|
+
# The identifiers of the Quip folders you want to index.
|
10123
10403
|
# @return [Array<String>]
|
10124
10404
|
#
|
10125
10405
|
# @!attribute [rw] thread_field_mappings
|
@@ -10208,9 +10488,9 @@ module Aws::Kendra
|
|
10208
10488
|
include Aws::Structure
|
10209
10489
|
end
|
10210
10490
|
|
10211
|
-
# Provides information for
|
10212
|
-
#
|
10213
|
-
#
|
10491
|
+
# Provides information for tuning the relevance of a field in a search.
|
10492
|
+
# When a query includes terms that match the field, the results are
|
10493
|
+
# given a boost in the response based on these tuning parameters.
|
10214
10494
|
#
|
10215
10495
|
# @note When making an API call, you may pass Relevance
|
10216
10496
|
# data as a hash:
|
@@ -11232,10 +11512,9 @@ module Aws::Kendra
|
|
11232
11512
|
# The type of authentication used to connect to the ServiceNow
|
11233
11513
|
# instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated
|
11234
11514
|
# using the user name and password provided in the Secrets Manager
|
11235
|
-
# secret in the `SecretArn` field.
|
11236
|
-
# Kendra is authenticated using the
|
11237
|
-
#
|
11238
|
-
# to determine which information Amazon Kendra has access to.
|
11515
|
+
# secret in the `SecretArn` field. If you choose `OAUTH2`, Amazon
|
11516
|
+
# Kendra is authenticated using the credentials of client ID, client
|
11517
|
+
# secret, user name and password.
|
11239
11518
|
#
|
11240
11519
|
# When you use `OAUTH2` authentication, you must generate a token and
|
11241
11520
|
# a client secret using the ServiceNow console. For more information,
|
@@ -11282,8 +11561,7 @@ module Aws::Kendra
|
|
11282
11561
|
# }
|
11283
11562
|
#
|
11284
11563
|
# @!attribute [rw] crawl_attachments
|
11285
|
-
#
|
11286
|
-
# knowledge articles.
|
11564
|
+
# `TRUE` to index attachments to knowledge articles.
|
11287
11565
|
# @return [Boolean]
|
11288
11566
|
#
|
11289
11567
|
# @!attribute [rw] include_attachment_file_patterns
|
@@ -11383,8 +11661,7 @@ module Aws::Kendra
|
|
11383
11661
|
# }
|
11384
11662
|
#
|
11385
11663
|
# @!attribute [rw] crawl_attachments
|
11386
|
-
#
|
11387
|
-
# service catalog items.
|
11664
|
+
# `TRUE` to index attachments to service catalog items.
|
11388
11665
|
# @return [Boolean]
|
11389
11666
|
#
|
11390
11667
|
# @!attribute [rw] include_attachment_file_patterns
|
@@ -12388,6 +12665,86 @@ module Aws::Kendra
|
|
12388
12665
|
#
|
12389
12666
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
12390
12667
|
|
12668
|
+
# @note When making an API call, you may pass UpdateAccessControlConfigurationRequest
|
12669
|
+
# data as a hash:
|
12670
|
+
#
|
12671
|
+
# {
|
12672
|
+
# index_id: "IndexId", # required
|
12673
|
+
# id: "AccessControlConfigurationId", # required
|
12674
|
+
# name: "AccessControlConfigurationName",
|
12675
|
+
# description: "Description",
|
12676
|
+
# access_control_list: [
|
12677
|
+
# {
|
12678
|
+
# name: "PrincipalName", # required
|
12679
|
+
# type: "USER", # required, accepts USER, GROUP
|
12680
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
12681
|
+
# data_source_id: "DataSourceId",
|
12682
|
+
# },
|
12683
|
+
# ],
|
12684
|
+
# hierarchical_access_control_list: [
|
12685
|
+
# {
|
12686
|
+
# principal_list: [ # required
|
12687
|
+
# {
|
12688
|
+
# name: "PrincipalName", # required
|
12689
|
+
# type: "USER", # required, accepts USER, GROUP
|
12690
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
12691
|
+
# data_source_id: "DataSourceId",
|
12692
|
+
# },
|
12693
|
+
# ],
|
12694
|
+
# },
|
12695
|
+
# ],
|
12696
|
+
# }
|
12697
|
+
#
|
12698
|
+
# @!attribute [rw] index_id
|
12699
|
+
# The identifier of the index for an access control configuration.
|
12700
|
+
# @return [String]
|
12701
|
+
#
|
12702
|
+
# @!attribute [rw] id
|
12703
|
+
# The identifier of the access control configuration you want to
|
12704
|
+
# update.
|
12705
|
+
# @return [String]
|
12706
|
+
#
|
12707
|
+
# @!attribute [rw] name
|
12708
|
+
# A new name for the access control configuration.
|
12709
|
+
# @return [String]
|
12710
|
+
#
|
12711
|
+
# @!attribute [rw] description
|
12712
|
+
# A new description for the access control configuration.
|
12713
|
+
# @return [String]
|
12714
|
+
#
|
12715
|
+
# @!attribute [rw] access_control_list
|
12716
|
+
# Information you want to update on principals (users and/or groups)
|
12717
|
+
# and which documents they should have access to. This is useful for
|
12718
|
+
# user context filtering, where search results are filtered based on
|
12719
|
+
# the user or their group access to documents.
|
12720
|
+
# @return [Array<Types::Principal>]
|
12721
|
+
#
|
12722
|
+
# @!attribute [rw] hierarchical_access_control_list
|
12723
|
+
# The updated list of [principal][1] lists that define the hierarchy
|
12724
|
+
# for which documents users should have access to.
|
12725
|
+
#
|
12726
|
+
#
|
12727
|
+
#
|
12728
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
|
12729
|
+
# @return [Array<Types::HierarchicalPrincipal>]
|
12730
|
+
#
|
12731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationRequest AWS API Documentation
|
12732
|
+
#
|
12733
|
+
class UpdateAccessControlConfigurationRequest < Struct.new(
|
12734
|
+
:index_id,
|
12735
|
+
:id,
|
12736
|
+
:name,
|
12737
|
+
:description,
|
12738
|
+
:access_control_list,
|
12739
|
+
:hierarchical_access_control_list)
|
12740
|
+
SENSITIVE = []
|
12741
|
+
include Aws::Structure
|
12742
|
+
end
|
12743
|
+
|
12744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationResponse AWS API Documentation
|
12745
|
+
#
|
12746
|
+
class UpdateAccessControlConfigurationResponse < Aws::EmptyStructure; end
|
12747
|
+
|
12391
12748
|
# @note When making an API call, you may pass UpdateDataSourceRequest
|
12392
12749
|
# data as a hash:
|
12393
12750
|
#
|
@@ -13072,43 +13429,47 @@ module Aws::Kendra
|
|
13072
13429
|
# }
|
13073
13430
|
#
|
13074
13431
|
# @!attribute [rw] id
|
13075
|
-
# The
|
13432
|
+
# The identifier of the data source you want to update.
|
13076
13433
|
# @return [String]
|
13077
13434
|
#
|
13078
13435
|
# @!attribute [rw] name
|
13079
|
-
#
|
13080
|
-
#
|
13081
|
-
# source and re-create it.
|
13436
|
+
# A new name for the data source connector. You must first delete the
|
13437
|
+
# data source and re-create it to change the name of the data source.
|
13082
13438
|
# @return [String]
|
13083
13439
|
#
|
13084
13440
|
# @!attribute [rw] index_id
|
13085
|
-
# The identifier of the index
|
13441
|
+
# The identifier of the index used with the data source connector.
|
13086
13442
|
# @return [String]
|
13087
13443
|
#
|
13088
13444
|
# @!attribute [rw] configuration
|
13089
|
-
# Configuration information
|
13090
|
-
#
|
13445
|
+
# Configuration information you want to update for the data source
|
13446
|
+
# connector.
|
13091
13447
|
# @return [Types::DataSourceConfiguration]
|
13092
13448
|
#
|
13093
13449
|
# @!attribute [rw] description
|
13094
|
-
#
|
13450
|
+
# A new description for the data source connector.
|
13095
13451
|
# @return [String]
|
13096
13452
|
#
|
13097
13453
|
# @!attribute [rw] schedule
|
13098
|
-
# The
|
13454
|
+
# The sync schedule you want to update for the data source connector.
|
13099
13455
|
# @return [String]
|
13100
13456
|
#
|
13101
13457
|
# @!attribute [rw] role_arn
|
13102
|
-
# The Amazon Resource Name (ARN) of
|
13103
|
-
# source
|
13458
|
+
# The Amazon Resource Name (ARN) of a role with permission to access
|
13459
|
+
# the data source. For more information, see [IAM Roles for Amazon
|
13460
|
+
# Kendra][1].
|
13461
|
+
#
|
13462
|
+
#
|
13463
|
+
#
|
13464
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
13104
13465
|
# @return [String]
|
13105
13466
|
#
|
13106
13467
|
# @!attribute [rw] language_code
|
13107
|
-
# The code for a language
|
13108
|
-
#
|
13109
|
-
#
|
13110
|
-
#
|
13111
|
-
# English][1].
|
13468
|
+
# The code for a language you want to update for the data source
|
13469
|
+
# connector. This allows you to support a language for all documents
|
13470
|
+
# when updating the data source. English is supported by default. For
|
13471
|
+
# more information on supported languages, including their codes, see
|
13472
|
+
# [Adding documents in languages other than English][1].
|
13112
13473
|
#
|
13113
13474
|
#
|
13114
13475
|
#
|
@@ -13116,8 +13477,8 @@ module Aws::Kendra
|
|
13116
13477
|
# @return [String]
|
13117
13478
|
#
|
13118
13479
|
# @!attribute [rw] custom_document_enrichment_configuration
|
13119
|
-
# Configuration information for altering document
|
13120
|
-
# during the document ingestion process
|
13480
|
+
# Configuration information you want to update for altering document
|
13481
|
+
# metadata and content during the document ingestion process.
|
13121
13482
|
#
|
13122
13483
|
# For more information on how to create, modify and delete document
|
13123
13484
|
# metadata, or make other content alterations when you ingest
|
@@ -13171,12 +13532,11 @@ module Aws::Kendra
|
|
13171
13532
|
# @return [String]
|
13172
13533
|
#
|
13173
13534
|
# @!attribute [rw] name
|
13174
|
-
#
|
13535
|
+
# A new name for your Amazon Kendra experience.
|
13175
13536
|
# @return [String]
|
13176
13537
|
#
|
13177
13538
|
# @!attribute [rw] index_id
|
13178
|
-
# The identifier of the index for your Amazon Kendra experience
|
13179
|
-
# want to update.
|
13539
|
+
# The identifier of the index for your Amazon Kendra experience.
|
13180
13540
|
# @return [String]
|
13181
13541
|
#
|
13182
13542
|
# @!attribute [rw] role_arn
|
@@ -13191,11 +13551,12 @@ module Aws::Kendra
|
|
13191
13551
|
# @return [String]
|
13192
13552
|
#
|
13193
13553
|
# @!attribute [rw] configuration
|
13194
|
-
# Configuration information for your Amazon Kendra
|
13554
|
+
# Configuration information you want to update for your Amazon Kendra
|
13555
|
+
# experience.
|
13195
13556
|
# @return [Types::ExperienceConfiguration]
|
13196
13557
|
#
|
13197
13558
|
# @!attribute [rw] description
|
13198
|
-
#
|
13559
|
+
# A new description for your Amazon Kendra experience.
|
13199
13560
|
# @return [String]
|
13200
13561
|
#
|
13201
13562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperienceRequest AWS API Documentation
|
@@ -13268,16 +13629,16 @@ module Aws::Kendra
|
|
13268
13629
|
# }
|
13269
13630
|
#
|
13270
13631
|
# @!attribute [rw] id
|
13271
|
-
# The identifier of the index to update.
|
13632
|
+
# The identifier of the index you want to update.
|
13272
13633
|
# @return [String]
|
13273
13634
|
#
|
13274
13635
|
# @!attribute [rw] name
|
13275
|
-
# The name of the index to update.
|
13636
|
+
# The name of the index you want to update.
|
13276
13637
|
# @return [String]
|
13277
13638
|
#
|
13278
13639
|
# @!attribute [rw] role_arn
|
13279
|
-
#
|
13280
|
-
# Amazon CloudWatch logs.
|
13640
|
+
# An Identity and Access Management (IAM) role that gives Amazon
|
13641
|
+
# Kendra permission to access Amazon CloudWatch logs and metrics.
|
13281
13642
|
# @return [String]
|
13282
13643
|
#
|
13283
13644
|
# @!attribute [rw] description
|
@@ -13285,7 +13646,10 @@ module Aws::Kendra
|
|
13285
13646
|
# @return [String]
|
13286
13647
|
#
|
13287
13648
|
# @!attribute [rw] document_metadata_configuration_updates
|
13288
|
-
# The document metadata you want to update
|
13649
|
+
# The document metadata configuration you want to update for the
|
13650
|
+
# index. Document metadata are fields or attributes associated with
|
13651
|
+
# your documents. For example, the company department name associated
|
13652
|
+
# with each document.
|
13289
13653
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
13290
13654
|
#
|
13291
13655
|
# @!attribute [rw] capacity_units
|
@@ -13348,19 +13712,19 @@ module Aws::Kendra
|
|
13348
13712
|
# }
|
13349
13713
|
#
|
13350
13714
|
# @!attribute [rw] index_id
|
13351
|
-
# The identifier of the index for
|
13715
|
+
# The identifier of the index for the block list.
|
13352
13716
|
# @return [String]
|
13353
13717
|
#
|
13354
13718
|
# @!attribute [rw] id
|
13355
|
-
# The
|
13719
|
+
# The identifier of the block list you want to update.
|
13356
13720
|
# @return [String]
|
13357
13721
|
#
|
13358
13722
|
# @!attribute [rw] name
|
13359
|
-
#
|
13723
|
+
# A new name for the block list.
|
13360
13724
|
# @return [String]
|
13361
13725
|
#
|
13362
13726
|
# @!attribute [rw] description
|
13363
|
-
#
|
13727
|
+
# A new description for the block list.
|
13364
13728
|
# @return [String]
|
13365
13729
|
#
|
13366
13730
|
# @!attribute [rw] source_s3_path
|
@@ -13408,8 +13772,8 @@ module Aws::Kendra
|
|
13408
13772
|
# }
|
13409
13773
|
#
|
13410
13774
|
# @!attribute [rw] index_id
|
13411
|
-
# The identifier of the index you want to
|
13412
|
-
#
|
13775
|
+
# The identifier of the index with query suggestions you want to
|
13776
|
+
# update.
|
13413
13777
|
# @return [String]
|
13414
13778
|
#
|
13415
13779
|
# @!attribute [rw] mode
|
@@ -13500,23 +13864,24 @@ module Aws::Kendra
|
|
13500
13864
|
# }
|
13501
13865
|
#
|
13502
13866
|
# @!attribute [rw] id
|
13503
|
-
# The identifier of the thesaurus to update.
|
13867
|
+
# The identifier of the thesaurus you want to update.
|
13504
13868
|
# @return [String]
|
13505
13869
|
#
|
13506
13870
|
# @!attribute [rw] name
|
13507
|
-
#
|
13871
|
+
# A new name for the thesaurus.
|
13508
13872
|
# @return [String]
|
13509
13873
|
#
|
13510
13874
|
# @!attribute [rw] index_id
|
13511
|
-
# The identifier of the index
|
13875
|
+
# The identifier of the index for the thesaurus.
|
13512
13876
|
# @return [String]
|
13513
13877
|
#
|
13514
13878
|
# @!attribute [rw] description
|
13515
|
-
#
|
13879
|
+
# A new description for the thesaurus.
|
13516
13880
|
# @return [String]
|
13517
13881
|
#
|
13518
13882
|
# @!attribute [rw] role_arn
|
13519
|
-
#
|
13883
|
+
# An IAM role that gives Amazon Kendra permissions to access thesaurus
|
13884
|
+
# file specified in `SourceS3Path`.
|
13520
13885
|
# @return [String]
|
13521
13886
|
#
|
13522
13887
|
# @!attribute [rw] source_s3_path
|
@@ -13595,8 +13960,13 @@ module Aws::Kendra
|
|
13595
13960
|
# Provides information about the user context for an Amazon Kendra
|
13596
13961
|
# index.
|
13597
13962
|
#
|
13598
|
-
#
|
13599
|
-
#
|
13963
|
+
# User context filtering is a kind of personalized search with the
|
13964
|
+
# benefit of controlling access to documents. For example, not all teams
|
13965
|
+
# that search the company portal for information should access
|
13966
|
+
# top-secret company documents, nor are these documents relevant to all
|
13967
|
+
# users. Only specific users or groups of teams given access to
|
13968
|
+
# top-secret documents should see these documents in their search
|
13969
|
+
# results.
|
13600
13970
|
#
|
13601
13971
|
# You provide one of the following:
|
13602
13972
|
#
|
@@ -13655,11 +14025,11 @@ module Aws::Kendra
|
|
13655
14025
|
|
13656
14026
|
# Provides the configuration information to fetch access levels of
|
13657
14027
|
# groups and users from an Amazon Web Services Single Sign On identity
|
13658
|
-
# source. This is useful for
|
13659
|
-
#
|
13660
|
-
#
|
13661
|
-
# their groups
|
13662
|
-
#
|
14028
|
+
# source. This is useful for user context filtering, where search
|
14029
|
+
# results are filtered based on the user or their group access to
|
14030
|
+
# documents. You can also use the [PutPrincipalMapping][1] API to map
|
14031
|
+
# users to their groups so that you only need to provide the user ID
|
14032
|
+
# when you issue the query.
|
13663
14033
|
#
|
13664
14034
|
# To set up an Amazon Web Services SSO identity source in the console to
|
13665
14035
|
# use with Amazon Kendra, see [Getting started with an Amazon Web
|
@@ -13944,13 +14314,12 @@ module Aws::Kendra
|
|
13944
14314
|
# authentication.
|
13945
14315
|
#
|
13946
14316
|
# You can connect to websites using basic authentication of user name
|
13947
|
-
# and password.
|
14317
|
+
# and password. You use a secret in [Secrets Manager][1] to store your
|
14318
|
+
# authentication credentials.
|
13948
14319
|
#
|
13949
14320
|
# You must provide the website host name and port number. For example,
|
13950
14321
|
# the host name of https://a.example.com/page1.html is
|
13951
14322
|
# "a.example.com" and the port is 443, the standard port for HTTPS.
|
13952
|
-
# You use a secret in [Secrets Manager][1] to store your
|
13953
|
-
# authentication credentials.
|
13954
14323
|
#
|
13955
14324
|
#
|
13956
14325
|
#
|