aws-sdk-kendra 1.53.0 → 1.56.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
  #
@@ -25,8 +40,7 @@ module Aws::Kendra
25
40
  # }
26
41
  #
27
42
  # @!attribute [rw] key_path
28
- # Path to the Amazon Web Services S3 bucket that contains the ACL
29
- # files.
43
+ # Path to the Amazon S3 bucket that contains the ACL files.
30
44
  # @return [String]
31
45
  #
32
46
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessControlListConfiguration AWS API Documentation
@@ -115,6 +129,16 @@ module Aws::Kendra
115
129
  # Provides the configuration information to connect to Alfresco as your
116
130
  # data source.
117
131
  #
132
+ # <note markdown="1"> Alfresco data source connector is currently in preview mode. Basic
133
+ # authentication is currently supported. If you would like to use
134
+ # Alfresco connector in production, contact [Support][1].
135
+ #
136
+ # </note>
137
+ #
138
+ #
139
+ #
140
+ # [1]: http://aws.amazon.com/contact-us/
141
+ #
118
142
  # @note When making an API call, you may pass AlfrescoConfiguration
119
143
  # data as a hash:
120
144
  #
@@ -187,7 +211,7 @@ module Aws::Kendra
187
211
  # @return [Boolean]
188
212
  #
189
213
  # @!attribute [rw] crawl_comments
190
- # `TRUE` to index comments of wikis and blogs.
214
+ # `TRUE` to index comments of blogs and other content.
191
215
  # @return [Boolean]
192
216
  #
193
217
  # @!attribute [rw] entity_filter
@@ -1077,6 +1101,7 @@ module Aws::Kendra
1077
1101
  # },
1078
1102
  # ],
1079
1103
  # content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
1104
+ # access_control_configuration_id: "AccessControlConfigurationId",
1080
1105
  # },
1081
1106
  # ],
1082
1107
  # custom_document_enrichment_configuration: {
@@ -1850,6 +1875,11 @@ module Aws::Kendra
1850
1875
  # },
1851
1876
  # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1852
1877
  # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1878
+ # proxy_configuration: {
1879
+ # host: "Host", # required
1880
+ # port: 1, # required
1881
+ # credentials: "SecretArn",
1882
+ # },
1853
1883
  # }
1854
1884
  #
1855
1885
  # @!attribute [rw] server_url
@@ -1863,7 +1893,7 @@ module Aws::Kendra
1863
1893
  # contains the user name and password required to connect to the
1864
1894
  # Confluence instance. If you use Confluence cloud, you use a
1865
1895
  # generated API token as the password. For more information, see
1866
- # [Using a Confluemce data source][1].
1896
+ # [Using a Confluence data source][1].
1867
1897
  #
1868
1898
  #
1869
1899
  #
@@ -1871,8 +1901,7 @@ module Aws::Kendra
1871
1901
  # @return [String]
1872
1902
  #
1873
1903
  # @!attribute [rw] version
1874
- # The version or the type of the Confluence installation to connect
1875
- # to.
1904
+ # The version or the type of Confluence installation to connect to.
1876
1905
  # @return [String]
1877
1906
  #
1878
1907
  # @!attribute [rw] space_configuration
@@ -1922,6 +1951,28 @@ module Aws::Kendra
1922
1951
  # index.
1923
1952
  # @return [Array<String>]
1924
1953
  #
1954
+ # @!attribute [rw] proxy_configuration
1955
+ # Configuration information to connect to your Confluence URL instance
1956
+ # via a web proxy. You can use this option for Confluence Server.
1957
+ #
1958
+ # You must provide the website host name and port number. For example,
1959
+ # the host name of *https://a.example.com/page1.html* is
1960
+ # "a.example.com" and the port is 443, the standard port for HTTPS.
1961
+ #
1962
+ # Web proxy credentials are optional and you can use them to connect
1963
+ # to a web proxy server that requires basic authentication of user
1964
+ # name and password. To store web proxy credentials, you use a secret
1965
+ # in Secrets Manager.
1966
+ #
1967
+ # It is recommended that you follow best security practices when
1968
+ # configuring your web proxy. This includes setting up throttling,
1969
+ # setting up logging and monitoring, and applying security patches on
1970
+ # a regular basis. If you use your web proxy with multiple data
1971
+ # sources, sync jobs that occur at the same time could strain the load
1972
+ # on your proxy. It is recommended you prepare your proxy beforehand
1973
+ # for any security and load requirements.
1974
+ # @return [Types::ProxyConfiguration]
1975
+ #
1925
1976
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation
1926
1977
  #
1927
1978
  class ConfluenceConfiguration < Struct.new(
@@ -1934,7 +1985,8 @@ module Aws::Kendra
1934
1985
  :attachment_configuration,
1935
1986
  :vpc_configuration,
1936
1987
  :inclusion_patterns,
1937
- :exclusion_patterns)
1988
+ :exclusion_patterns,
1989
+ :proxy_configuration)
1938
1990
  SENSITIVE = []
1939
1991
  include Aws::Structure
1940
1992
  end
@@ -2274,13 +2326,108 @@ module Aws::Kendra
2274
2326
  include Aws::Structure
2275
2327
  end
2276
2328
 
2329
+ # @note When making an API call, you may pass CreateAccessControlConfigurationRequest
2330
+ # data as a hash:
2331
+ #
2332
+ # {
2333
+ # index_id: "IndexId", # required
2334
+ # name: "AccessControlConfigurationName", # required
2335
+ # description: "Description",
2336
+ # access_control_list: [
2337
+ # {
2338
+ # name: "PrincipalName", # required
2339
+ # type: "USER", # required, accepts USER, GROUP
2340
+ # access: "ALLOW", # required, accepts ALLOW, DENY
2341
+ # data_source_id: "DataSourceId",
2342
+ # },
2343
+ # ],
2344
+ # hierarchical_access_control_list: [
2345
+ # {
2346
+ # principal_list: [ # required
2347
+ # {
2348
+ # name: "PrincipalName", # required
2349
+ # type: "USER", # required, accepts USER, GROUP
2350
+ # access: "ALLOW", # required, accepts ALLOW, DENY
2351
+ # data_source_id: "DataSourceId",
2352
+ # },
2353
+ # ],
2354
+ # },
2355
+ # ],
2356
+ # client_token: "ClientTokenName",
2357
+ # }
2358
+ #
2359
+ # @!attribute [rw] index_id
2360
+ # The identifier of the index to create an access control
2361
+ # configuration for your documents.
2362
+ # @return [String]
2363
+ #
2364
+ # @!attribute [rw] name
2365
+ # A name for the access control configuration.
2366
+ # @return [String]
2367
+ #
2368
+ # @!attribute [rw] description
2369
+ # A description for the access control configuration.
2370
+ # @return [String]
2371
+ #
2372
+ # @!attribute [rw] access_control_list
2373
+ # Information on principals (users and/or groups) and which documents
2374
+ # they should have access to. This is useful for user context
2375
+ # filtering, where search results are filtered based on the user or
2376
+ # their group access to documents.
2377
+ # @return [Array<Types::Principal>]
2378
+ #
2379
+ # @!attribute [rw] hierarchical_access_control_list
2380
+ # The list of [principal][1] lists that define the hierarchy for which
2381
+ # documents users should have access to.
2382
+ #
2383
+ #
2384
+ #
2385
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
2386
+ # @return [Array<Types::HierarchicalPrincipal>]
2387
+ #
2388
+ # @!attribute [rw] client_token
2389
+ # A token that you provide to identify the request to create an access
2390
+ # control configuration. Multiple calls to the
2391
+ # `CreateAccessControlConfiguration` API with the same client token
2392
+ # will create only one access control configuration.
2393
+ #
2394
+ # **A suitable default value is auto-generated.** You should normally
2395
+ # not need to pass this option.
2396
+ # @return [String]
2397
+ #
2398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationRequest AWS API Documentation
2399
+ #
2400
+ class CreateAccessControlConfigurationRequest < Struct.new(
2401
+ :index_id,
2402
+ :name,
2403
+ :description,
2404
+ :access_control_list,
2405
+ :hierarchical_access_control_list,
2406
+ :client_token)
2407
+ SENSITIVE = []
2408
+ include Aws::Structure
2409
+ end
2410
+
2411
+ # @!attribute [rw] id
2412
+ # The identifier of the access control configuration for your
2413
+ # documents in an index.
2414
+ # @return [String]
2415
+ #
2416
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationResponse AWS API Documentation
2417
+ #
2418
+ class CreateAccessControlConfigurationResponse < Struct.new(
2419
+ :id)
2420
+ SENSITIVE = []
2421
+ include Aws::Structure
2422
+ end
2423
+
2277
2424
  # @note When making an API call, you may pass CreateDataSourceRequest
2278
2425
  # data as a hash:
2279
2426
  #
2280
2427
  # {
2281
2428
  # name: "DataSourceName", # required
2282
2429
  # index_id: "IndexId", # required
2283
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO
2430
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO, TEMPLATE
2284
2431
  # configuration: {
2285
2432
  # s3_configuration: {
2286
2433
  # bucket_name: "S3BucketName", # required
@@ -2319,6 +2466,12 @@ module Aws::Kendra
2319
2466
  # bucket: "S3BucketName", # required
2320
2467
  # key: "S3ObjectKey", # required
2321
2468
  # },
2469
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
2470
+ # proxy_configuration: {
2471
+ # host: "Host", # required
2472
+ # port: 1, # required
2473
+ # credentials: "SecretArn",
2474
+ # },
2322
2475
  # },
2323
2476
  # database_configuration: {
2324
2477
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -2531,6 +2684,11 @@ module Aws::Kendra
2531
2684
  # },
2532
2685
  # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2533
2686
  # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2687
+ # proxy_configuration: {
2688
+ # host: "Host", # required
2689
+ # port: 1, # required
2690
+ # credentials: "SecretArn",
2691
+ # },
2534
2692
  # },
2535
2693
  # google_drive_configuration: {
2536
2694
  # secret_arn: "SecretArn", # required
@@ -2894,6 +3052,14 @@ module Aws::Kendra
2894
3052
  # security_group_ids: ["VpcSecurityGroupId"], # required
2895
3053
  # },
2896
3054
  # },
3055
+ # template_configuration: {
3056
+ # template: {
3057
+ # },
3058
+ # },
3059
+ # },
3060
+ # vpc_configuration: {
3061
+ # subnet_ids: ["SubnetId"], # required
3062
+ # security_group_ids: ["VpcSecurityGroupId"], # required
2897
3063
  # },
2898
3064
  # description: "Description",
2899
3065
  # schedule: "ScanSchedule",
@@ -2965,22 +3131,20 @@ module Aws::Kendra
2965
3131
  # }
2966
3132
  #
2967
3133
  # @!attribute [rw] name
2968
- # A unique name for the data source. A data source name can't be
2969
- # changed without deleting and recreating the data source.
3134
+ # A name for the data source connector.
2970
3135
  # @return [String]
2971
3136
  #
2972
3137
  # @!attribute [rw] index_id
2973
- # The identifier of the index that should be associated with this data
2974
- # source.
3138
+ # The identifier of the index you want to use with the data source
3139
+ # connector.
2975
3140
  # @return [String]
2976
3141
  #
2977
3142
  # @!attribute [rw] type
2978
- # The type of repository that contains the data source.
3143
+ # The type of data source repository. For example, `SHAREPOINT`.
2979
3144
  # @return [String]
2980
3145
  #
2981
3146
  # @!attribute [rw] configuration
2982
- # Configuration information that is required to access the data source
2983
- # repository.
3147
+ # Configuration information to connect to your data source repository.
2984
3148
  #
2985
3149
  # You can't specify the `Configuration` parameter when the `Type`
2986
3150
  # parameter is set to `CUSTOM`. If you do, you receive a
@@ -2990,15 +3154,25 @@ module Aws::Kendra
2990
3154
  # sources.
2991
3155
  # @return [Types::DataSourceConfiguration]
2992
3156
  #
3157
+ # @!attribute [rw] vpc_configuration
3158
+ # Configuration information for an Amazon Virtual Private Cloud to
3159
+ # connect to your data source. For more information, see [Configuring
3160
+ # a VPC][1].
3161
+ #
3162
+ #
3163
+ #
3164
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
3165
+ # @return [Types::DataSourceVpcConfiguration]
3166
+ #
2993
3167
  # @!attribute [rw] description
2994
- # A description for the data source.
3168
+ # A description for the data source connector.
2995
3169
  # @return [String]
2996
3170
  #
2997
3171
  # @!attribute [rw] schedule
2998
3172
  # Sets the frequency for Amazon Kendra to check the documents in your
2999
- # repository and update the index. If you don't set a schedule Amazon
3000
- # Kendra will not periodically update the index. You can call the
3001
- # `StartDataSourceSyncJob` API to update the index.
3173
+ # data source repository and update the index. If you don't set a
3174
+ # schedule Amazon Kendra will not periodically update the index. You
3175
+ # can call the `StartDataSourceSyncJob` API to update the index.
3002
3176
  #
3003
3177
  # You can't specify the `Schedule` parameter when the `Type`
3004
3178
  # parameter is set to `CUSTOM`. If you do, you receive a
@@ -3007,8 +3181,8 @@ module Aws::Kendra
3007
3181
  #
3008
3182
  # @!attribute [rw] role_arn
3009
3183
  # The Amazon Resource Name (ARN) of a role with permission to access
3010
- # the data source. For more information, see [IAM Roles for Amazon
3011
- # Kendra][1].
3184
+ # the data source connector. For more information, see [IAM Roles for
3185
+ # Amazon Kendra][1].
3012
3186
  #
3013
3187
  # You can't specify the `RoleArn` parameter when the `Type` parameter
3014
3188
  # is set to `CUSTOM`. If you do, you receive a `ValidationException`
@@ -3022,15 +3196,15 @@ module Aws::Kendra
3022
3196
  # @return [String]
3023
3197
  #
3024
3198
  # @!attribute [rw] tags
3025
- # A list of key-value pairs that identify the data source. You can use
3026
- # the tags to identify and organize your resources and to control
3027
- # access to resources.
3199
+ # A list of key-value pairs that identify the data source connector.
3200
+ # You can use the tags to identify and organize your resources and to
3201
+ # control access to resources.
3028
3202
  # @return [Array<Types::Tag>]
3029
3203
  #
3030
3204
  # @!attribute [rw] client_token
3031
3205
  # A token that you provide to identify the request to create a data
3032
- # source. Multiple calls to the `CreateDataSource` API with the same
3033
- # client token will create only one data source.
3206
+ # source connector. Multiple calls to the `CreateDataSource` API with
3207
+ # the same client token will create only one data source connector.
3034
3208
  #
3035
3209
  # **A suitable default value is auto-generated.** You should normally
3036
3210
  # not need to pass this option.
@@ -3038,9 +3212,9 @@ module Aws::Kendra
3038
3212
  #
3039
3213
  # @!attribute [rw] language_code
3040
3214
  # The code for a language. This allows you to support a language for
3041
- # all documents when creating the data source. English is supported by
3042
- # default. For more information on supported languages, including
3043
- # their codes, see [Adding documents in languages other than
3215
+ # all documents when creating the data source connector. English is
3216
+ # supported by default. For more information on supported languages,
3217
+ # including their codes, see [Adding documents in languages other than
3044
3218
  # English][1].
3045
3219
  #
3046
3220
  #
@@ -3050,7 +3224,7 @@ module Aws::Kendra
3050
3224
  #
3051
3225
  # @!attribute [rw] custom_document_enrichment_configuration
3052
3226
  # Configuration information for altering document metadata and content
3053
- # during the document ingestion process when you create a data source.
3227
+ # during the document ingestion process.
3054
3228
  #
3055
3229
  # For more information on how to create, modify and delete document
3056
3230
  # metadata, or make other content alterations when you ingest
@@ -3069,6 +3243,7 @@ module Aws::Kendra
3069
3243
  :index_id,
3070
3244
  :type,
3071
3245
  :configuration,
3246
+ :vpc_configuration,
3072
3247
  :description,
3073
3248
  :schedule,
3074
3249
  :role_arn,
@@ -3081,7 +3256,7 @@ module Aws::Kendra
3081
3256
  end
3082
3257
 
3083
3258
  # @!attribute [rw] id
3084
- # A unique identifier for the data source.
3259
+ # The identifier of the data source connector.
3085
3260
  # @return [String]
3086
3261
  #
3087
3262
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceResponse AWS API Documentation
@@ -3203,19 +3378,19 @@ module Aws::Kendra
3203
3378
  # }
3204
3379
  #
3205
3380
  # @!attribute [rw] index_id
3206
- # The identifier of the index that contains the FAQ.
3381
+ # The identifier of the index for the FAQ.
3207
3382
  # @return [String]
3208
3383
  #
3209
3384
  # @!attribute [rw] name
3210
- # The name that should be associated with the FAQ.
3385
+ # A name for the FAQ.
3211
3386
  # @return [String]
3212
3387
  #
3213
3388
  # @!attribute [rw] description
3214
- # A description of the FAQ.
3389
+ # A description for the FAQ.
3215
3390
  # @return [String]
3216
3391
  #
3217
3392
  # @!attribute [rw] s3_path
3218
- # The S3 location of the FAQ input data.
3393
+ # The path to the FAQ file in S3.
3219
3394
  # @return [Types::S3Path]
3220
3395
  #
3221
3396
  # @!attribute [rw] role_arn
@@ -3235,7 +3410,7 @@ module Aws::Kendra
3235
3410
  # @return [Array<Types::Tag>]
3236
3411
  #
3237
3412
  # @!attribute [rw] file_format
3238
- # The format of the input file. You can choose between a basic CSV
3413
+ # The format of the FAQ input file. You can choose between a basic CSV
3239
3414
  # format, a CSV format that includes customs attributes in a header,
3240
3415
  # and a JSON format that includes custom attributes.
3241
3416
  #
@@ -3339,7 +3514,7 @@ module Aws::Kendra
3339
3514
  # }
3340
3515
  #
3341
3516
  # @!attribute [rw] name
3342
- # The name for the new index.
3517
+ # A name for the index.
3343
3518
  # @return [String]
3344
3519
  #
3345
3520
  # @!attribute [rw] edition
@@ -3580,15 +3755,15 @@ module Aws::Kendra
3580
3755
  # }
3581
3756
  #
3582
3757
  # @!attribute [rw] index_id
3583
- # The unique identifier of the index for the new thesaurus.
3758
+ # The identifier of the index for the thesaurus.
3584
3759
  # @return [String]
3585
3760
  #
3586
3761
  # @!attribute [rw] name
3587
- # The name for the new thesaurus.
3762
+ # A name for the thesaurus.
3588
3763
  # @return [String]
3589
3764
  #
3590
3765
  # @!attribute [rw] description
3591
- # The description for the new thesaurus.
3766
+ # A description for the thesaurus.
3592
3767
  # @return [String]
3593
3768
  #
3594
3769
  # @!attribute [rw] role_arn
@@ -3603,7 +3778,7 @@ module Aws::Kendra
3603
3778
  # @return [Array<Types::Tag>]
3604
3779
  #
3605
3780
  # @!attribute [rw] source_s3_path
3606
- # The thesaurus file Amazon S3 source path.
3781
+ # The path to the thesaurus file in S3.
3607
3782
  # @return [Types::S3Path]
3608
3783
  #
3609
3784
  # @!attribute [rw] client_token
@@ -3807,6 +3982,12 @@ module Aws::Kendra
3807
3982
  # bucket: "S3BucketName", # required
3808
3983
  # key: "S3ObjectKey", # required
3809
3984
  # },
3985
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
3986
+ # proxy_configuration: {
3987
+ # host: "Host", # required
3988
+ # port: 1, # required
3989
+ # credentials: "SecretArn",
3990
+ # },
3810
3991
  # },
3811
3992
  # database_configuration: {
3812
3993
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -4019,6 +4200,11 @@ module Aws::Kendra
4019
4200
  # },
4020
4201
  # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4021
4202
  # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
4203
+ # proxy_configuration: {
4204
+ # host: "Host", # required
4205
+ # port: 1, # required
4206
+ # credentials: "SecretArn",
4207
+ # },
4022
4208
  # },
4023
4209
  # google_drive_configuration: {
4024
4210
  # secret_arn: "SecretArn", # required
@@ -4382,6 +4568,10 @@ module Aws::Kendra
4382
4568
  # security_group_ids: ["VpcSecurityGroupId"], # required
4383
4569
  # },
4384
4570
  # },
4571
+ # template_configuration: {
4572
+ # template: {
4573
+ # },
4574
+ # },
4385
4575
  # }
4386
4576
  #
4387
4577
  # @!attribute [rw] s3_configuration
@@ -4469,6 +4659,11 @@ module Aws::Kendra
4469
4659
  # your data source.
4470
4660
  # @return [Types::AlfrescoConfiguration]
4471
4661
  #
4662
+ # @!attribute [rw] template_configuration
4663
+ # Provides a template for the configuration information to connect to
4664
+ # your data source.
4665
+ # @return [Types::TemplateConfiguration]
4666
+ #
4472
4667
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
4473
4668
  #
4474
4669
  class DataSourceConfiguration < Struct.new(
@@ -4488,7 +4683,8 @@ module Aws::Kendra
4488
4683
  :quip_configuration,
4489
4684
  :jira_configuration,
4490
4685
  :git_hub_configuration,
4491
- :alfresco_configuration)
4686
+ :alfresco_configuration,
4687
+ :template_configuration)
4492
4688
  SENSITIVE = []
4493
4689
  include Aws::Structure
4494
4690
  end
@@ -4857,6 +5053,36 @@ module Aws::Kendra
4857
5053
  include Aws::Structure
4858
5054
  end
4859
5055
 
5056
+ # @note When making an API call, you may pass DeleteAccessControlConfigurationRequest
5057
+ # data as a hash:
5058
+ #
5059
+ # {
5060
+ # index_id: "IndexId", # required
5061
+ # id: "AccessControlConfigurationId", # required
5062
+ # }
5063
+ #
5064
+ # @!attribute [rw] index_id
5065
+ # The identifier of the index for an access control configuration.
5066
+ # @return [String]
5067
+ #
5068
+ # @!attribute [rw] id
5069
+ # The identifier of the access control configuration you want to
5070
+ # delete.
5071
+ # @return [String]
5072
+ #
5073
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationRequest AWS API Documentation
5074
+ #
5075
+ class DeleteAccessControlConfigurationRequest < Struct.new(
5076
+ :index_id,
5077
+ :id)
5078
+ SENSITIVE = []
5079
+ include Aws::Structure
5080
+ end
5081
+
5082
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationResponse AWS API Documentation
5083
+ #
5084
+ class DeleteAccessControlConfigurationResponse < Aws::EmptyStructure; end
5085
+
4860
5086
  # @note When making an API call, you may pass DeleteDataSourceRequest
4861
5087
  # data as a hash:
4862
5088
  #
@@ -4866,11 +5092,11 @@ module Aws::Kendra
4866
5092
  # }
4867
5093
  #
4868
5094
  # @!attribute [rw] id
4869
- # The unique identifier of the data source to delete.
5095
+ # The identifier of the data source you want to delete.
4870
5096
  # @return [String]
4871
5097
  #
4872
5098
  # @!attribute [rw] index_id
4873
- # The unique identifier of the index associated with the data source.
5099
+ # The identifier of the index used with the data source.
4874
5100
  # @return [String]
4875
5101
  #
4876
5102
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
@@ -4895,8 +5121,7 @@ module Aws::Kendra
4895
5121
  # @return [String]
4896
5122
  #
4897
5123
  # @!attribute [rw] index_id
4898
- # The identifier of the index for your Amazon Kendra experience you
4899
- # want to delete.
5124
+ # The identifier of the index for your Amazon Kendra experience.
4900
5125
  # @return [String]
4901
5126
  #
4902
5127
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperienceRequest AWS API Documentation
@@ -4921,11 +5146,11 @@ module Aws::Kendra
4921
5146
  # }
4922
5147
  #
4923
5148
  # @!attribute [rw] id
4924
- # The identifier of the FAQ to remove.
5149
+ # The identifier of the FAQ you want to remove.
4925
5150
  # @return [String]
4926
5151
  #
4927
5152
  # @!attribute [rw] index_id
4928
- # The index to remove the FAQ from.
5153
+ # The identifier of the index for the FAQ.
4929
5154
  # @return [String]
4930
5155
  #
4931
5156
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaqRequest AWS API Documentation
@@ -4945,7 +5170,7 @@ module Aws::Kendra
4945
5170
  # }
4946
5171
  #
4947
5172
  # @!attribute [rw] id
4948
- # The identifier of the index to delete.
5173
+ # The identifier of the index you want to delete.
4949
5174
  # @return [String]
4950
5175
  #
4951
5176
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndexRequest AWS API Documentation
@@ -4973,15 +5198,15 @@ module Aws::Kendra
4973
5198
  # @!attribute [rw] data_source_id
4974
5199
  # The identifier of the data source you want to delete a group from.
4975
5200
  #
4976
- # This is useful if a group is tied to multiple data sources and you
4977
- # want to delete a group from accessing documents in a certain data
4978
- # source. For example, the groups "Research", "Engineering", and
4979
- # "Sales and Marketing" are all tied to the company's documents
4980
- # stored in the data sources Confluence and Salesforce. You want to
4981
- # delete "Research" and "Engineering" groups from Salesforce, so
4982
- # that these groups cannot access customer-related documents stored in
4983
- # Salesforce. Only "Sales and Marketing" should access documents in
4984
- # the Salesforce data source.
5201
+ # A group can be tied to multiple data sources. You can delete a group
5202
+ # from accessing documents in a certain data source. For example, the
5203
+ # groups "Research", "Engineering", and "Sales and Marketing"
5204
+ # are all tied to the company's documents stored in the data sources
5205
+ # Confluence and Salesforce. You want to delete "Research" and
5206
+ # "Engineering" groups from Salesforce, so that these groups cannot
5207
+ # access customer-related documents stored in Salesforce. Only "Sales
5208
+ # and Marketing" should access documents in the Salesforce data
5209
+ # source.
4985
5210
  # @return [String]
4986
5211
  #
4987
5212
  # @!attribute [rw] group_id
@@ -5027,11 +5252,11 @@ module Aws::Kendra
5027
5252
  # }
5028
5253
  #
5029
5254
  # @!attribute [rw] index_id
5030
- # The identifier of the you want to delete a block list from.
5255
+ # The identifier of the index for the block list.
5031
5256
  # @return [String]
5032
5257
  #
5033
5258
  # @!attribute [rw] id
5034
- # The unique identifier of the block list that needs to be deleted.
5259
+ # The identifier of the block list you want to delete.
5035
5260
  # @return [String]
5036
5261
  #
5037
5262
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
@@ -5052,11 +5277,11 @@ module Aws::Kendra
5052
5277
  # }
5053
5278
  #
5054
5279
  # @!attribute [rw] id
5055
- # The identifier of the thesaurus to delete.
5280
+ # The identifier of the thesaurus you want to delete.
5056
5281
  # @return [String]
5057
5282
  #
5058
5283
  # @!attribute [rw] index_id
5059
- # The identifier of the index associated with the thesaurus to delete.
5284
+ # The identifier of the index for the thesaurus.
5060
5285
  # @return [String]
5061
5286
  #
5062
5287
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurusRequest AWS API Documentation
@@ -5068,6 +5293,73 @@ module Aws::Kendra
5068
5293
  include Aws::Structure
5069
5294
  end
5070
5295
 
5296
+ # @note When making an API call, you may pass DescribeAccessControlConfigurationRequest
5297
+ # data as a hash:
5298
+ #
5299
+ # {
5300
+ # index_id: "IndexId", # required
5301
+ # id: "AccessControlConfigurationId", # required
5302
+ # }
5303
+ #
5304
+ # @!attribute [rw] index_id
5305
+ # The identifier of the index for an access control configuration.
5306
+ # @return [String]
5307
+ #
5308
+ # @!attribute [rw] id
5309
+ # The identifier of the access control configuration you want to get
5310
+ # information on.
5311
+ # @return [String]
5312
+ #
5313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationRequest AWS API Documentation
5314
+ #
5315
+ class DescribeAccessControlConfigurationRequest < Struct.new(
5316
+ :index_id,
5317
+ :id)
5318
+ SENSITIVE = []
5319
+ include Aws::Structure
5320
+ end
5321
+
5322
+ # @!attribute [rw] name
5323
+ # The name for the access control configuration.
5324
+ # @return [String]
5325
+ #
5326
+ # @!attribute [rw] description
5327
+ # The description for the access control configuration.
5328
+ # @return [String]
5329
+ #
5330
+ # @!attribute [rw] error_message
5331
+ # The error message containing details if there are issues processing
5332
+ # the access control configuration.
5333
+ # @return [String]
5334
+ #
5335
+ # @!attribute [rw] access_control_list
5336
+ # Information on principals (users and/or groups) and which documents
5337
+ # they should have access to. This is useful for user context
5338
+ # filtering, where search results are filtered based on the user or
5339
+ # their group access to documents.
5340
+ # @return [Array<Types::Principal>]
5341
+ #
5342
+ # @!attribute [rw] hierarchical_access_control_list
5343
+ # The list of [principal][1] lists that define the hierarchy for which
5344
+ # documents users should have access to.
5345
+ #
5346
+ #
5347
+ #
5348
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
5349
+ # @return [Array<Types::HierarchicalPrincipal>]
5350
+ #
5351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationResponse AWS API Documentation
5352
+ #
5353
+ class DescribeAccessControlConfigurationResponse < Struct.new(
5354
+ :name,
5355
+ :description,
5356
+ :error_message,
5357
+ :access_control_list,
5358
+ :hierarchical_access_control_list)
5359
+ SENSITIVE = []
5360
+ include Aws::Structure
5361
+ end
5362
+
5071
5363
  # @note When making an API call, you may pass DescribeDataSourceRequest
5072
5364
  # data as a hash:
5073
5365
  #
@@ -5077,11 +5369,11 @@ module Aws::Kendra
5077
5369
  # }
5078
5370
  #
5079
5371
  # @!attribute [rw] id
5080
- # The unique identifier of the data source to describe.
5372
+ # The identifier of the data source.
5081
5373
  # @return [String]
5082
5374
  #
5083
5375
  # @!attribute [rw] index_id
5084
- # The identifier of the index that contains the data source.
5376
+ # The identifier of the index used with the data source.
5085
5377
  # @return [String]
5086
5378
  #
5087
5379
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceRequest AWS API Documentation
@@ -5102,7 +5394,7 @@ module Aws::Kendra
5102
5394
  # @return [String]
5103
5395
  #
5104
5396
  # @!attribute [rw] name
5105
- # The name that you gave the data source when it was created.
5397
+ # The name for the data source.
5106
5398
  # @return [String]
5107
5399
  #
5108
5400
  # @!attribute [rw] type
@@ -5110,10 +5402,21 @@ module Aws::Kendra
5110
5402
  # @return [String]
5111
5403
  #
5112
5404
  # @!attribute [rw] configuration
5113
- # Describes how the data source is configured. The specific
5114
- # information in the description depends on the data source provider.
5405
+ # Configuration details for the data source. This shows how the data
5406
+ # source is configured. The configuration options for a data source
5407
+ # depend on the data source provider.
5115
5408
  # @return [Types::DataSourceConfiguration]
5116
5409
  #
5410
+ # @!attribute [rw] vpc_configuration
5411
+ # Configuration information for an Amazon Virtual Private Cloud to
5412
+ # connect to your data source. For more information, see [Configuring
5413
+ # a VPC][1].
5414
+ #
5415
+ #
5416
+ #
5417
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
5418
+ # @return [Types::DataSourceVpcConfiguration]
5419
+ #
5117
5420
  # @!attribute [rw] created_at
5118
5421
  # The Unix timestamp of when the data source was created.
5119
5422
  # @return [Time]
@@ -5123,7 +5426,7 @@ module Aws::Kendra
5123
5426
  # @return [Time]
5124
5427
  #
5125
5428
  # @!attribute [rw] description
5126
- # The description of the data source.
5429
+ # The description for the data source.
5127
5430
  # @return [String]
5128
5431
  #
5129
5432
  # @!attribute [rw] status
@@ -5182,6 +5485,7 @@ module Aws::Kendra
5182
5485
  :name,
5183
5486
  :type,
5184
5487
  :configuration,
5488
+ :vpc_configuration,
5185
5489
  :created_at,
5186
5490
  :updated_at,
5187
5491
  :description,
@@ -5209,8 +5513,7 @@ module Aws::Kendra
5209
5513
  # @return [String]
5210
5514
  #
5211
5515
  # @!attribute [rw] index_id
5212
- # The identifier of the index for your Amazon Kendra experience you
5213
- # want to get information on.
5516
+ # The identifier of the index for your Amazon Kendra experience.
5214
5517
  # @return [String]
5215
5518
  #
5216
5519
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperienceRequest AWS API Documentation
@@ -5304,11 +5607,11 @@ module Aws::Kendra
5304
5607
  # }
5305
5608
  #
5306
5609
  # @!attribute [rw] id
5307
- # The unique identifier of the FAQ.
5610
+ # The identifier of the FAQ you want to get information on.
5308
5611
  # @return [String]
5309
5612
  #
5310
5613
  # @!attribute [rw] index_id
5311
- # The identifier of the index that contains the FAQ.
5614
+ # The identifier of the index for the FAQ.
5312
5615
  # @return [String]
5313
5616
  #
5314
5617
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqRequest AWS API Documentation
@@ -5325,7 +5628,7 @@ module Aws::Kendra
5325
5628
  # @return [String]
5326
5629
  #
5327
5630
  # @!attribute [rw] index_id
5328
- # The identifier of the index that contains the FAQ.
5631
+ # The identifier of the index for the FAQ.
5329
5632
  # @return [String]
5330
5633
  #
5331
5634
  # @!attribute [rw] name
@@ -5405,7 +5708,7 @@ module Aws::Kendra
5405
5708
  # }
5406
5709
  #
5407
5710
  # @!attribute [rw] id
5408
- # The identifier of the index to describe.
5711
+ # The identifier of the index you want to get information on.
5409
5712
  # @return [String]
5410
5713
  #
5411
5714
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexRequest AWS API Documentation
@@ -5458,8 +5761,10 @@ module Aws::Kendra
5458
5761
  # @return [Time]
5459
5762
  #
5460
5763
  # @!attribute [rw] document_metadata_configurations
5461
- # Configuration settings for any metadata applied to the documents in
5462
- # the index.
5764
+ # Configuration information for document metadata or fields. Document
5765
+ # metadata are fields or attributes associated with your documents.
5766
+ # For example, the company department name associated with each
5767
+ # document.
5463
5768
  # @return [Array<Types::DocumentMetadataConfiguration>]
5464
5769
  #
5465
5770
  # @!attribute [rw] index_statistics
@@ -5494,7 +5799,7 @@ module Aws::Kendra
5494
5799
  # @return [String]
5495
5800
  #
5496
5801
  # @!attribute [rw] user_group_resolution_configuration
5497
- # Shows whether you have enabled the configuration for fetching access
5802
+ # Whether you have enabled the configuration for fetching access
5498
5803
  # levels of groups and users from an Amazon Web Services Single Sign
5499
5804
  # On identity source.
5500
5805
  # @return [Types::UserGroupResolutionConfiguration]
@@ -5615,7 +5920,7 @@ module Aws::Kendra
5615
5920
  # @return [String]
5616
5921
  #
5617
5922
  # @!attribute [rw] id
5618
- # The unique identifier of the block list.
5923
+ # The identifier of the block list you want to get information on.
5619
5924
  # @return [String]
5620
5925
  #
5621
5926
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
@@ -5628,38 +5933,37 @@ module Aws::Kendra
5628
5933
  end
5629
5934
 
5630
5935
  # @!attribute [rw] index_id
5631
- # Shows the identifier of the index for the block list.
5936
+ # The identifier of the index for the block list.
5632
5937
  # @return [String]
5633
5938
  #
5634
5939
  # @!attribute [rw] id
5635
- # Shows the unique identifier of the block list.
5940
+ # The identifier of the block list.
5636
5941
  # @return [String]
5637
5942
  #
5638
5943
  # @!attribute [rw] name
5639
- # Shows the name of the block list.
5944
+ # The name of the block list.
5640
5945
  # @return [String]
5641
5946
  #
5642
5947
  # @!attribute [rw] description
5643
- # Shows the description for the block list.
5948
+ # The description for the block list.
5644
5949
  # @return [String]
5645
5950
  #
5646
5951
  # @!attribute [rw] status
5647
- # Shows whether the current status of the block list is `ACTIVE` or
5648
- # `INACTIVE`.
5952
+ # The current status of the block list. When the value is `ACTIVE`,
5953
+ # the block list is ready for use.
5649
5954
  # @return [String]
5650
5955
  #
5651
5956
  # @!attribute [rw] error_message
5652
- # Shows the error message with details when there are issues in
5653
- # processing the block list.
5957
+ # The error message containing details if there are issues processing
5958
+ # the block list.
5654
5959
  # @return [String]
5655
5960
  #
5656
5961
  # @!attribute [rw] created_at
5657
- # Shows the date-time a block list for query suggestions was created.
5962
+ # The date-time a block list for query suggestions was created.
5658
5963
  # @return [Time]
5659
5964
  #
5660
5965
  # @!attribute [rw] updated_at
5661
- # Shows the date-time a block list for query suggestions was last
5662
- # updated.
5966
+ # The date-time a block list for query suggestions was last updated.
5663
5967
  # @return [Time]
5664
5968
  #
5665
5969
  # @!attribute [rw] source_s3_path
@@ -5678,17 +5982,17 @@ module Aws::Kendra
5678
5982
  # @return [Types::S3Path]
5679
5983
  #
5680
5984
  # @!attribute [rw] item_count
5681
- # Shows the current number of valid, non-empty words or phrases in the
5682
- # block list text file.
5985
+ # The current number of valid, non-empty words or phrases in the block
5986
+ # list text file.
5683
5987
  # @return [Integer]
5684
5988
  #
5685
5989
  # @!attribute [rw] file_size_bytes
5686
- # Shows the current size of the block list text file in S3.
5990
+ # The current size of the block list text file in S3.
5687
5991
  # @return [Integer]
5688
5992
  #
5689
5993
  # @!attribute [rw] role_arn
5690
- # Shows the current IAM (Identity and Access Management) role used by
5691
- # Amazon Kendra to access the block list text file in S3.
5994
+ # The IAM (Identity and Access Management) role used by Amazon Kendra
5995
+ # to access the block list text file in S3.
5692
5996
  #
5693
5997
  # The role needs S3 read permissions to your file in S3 and needs to
5694
5998
  # give STS (Security Token Service) assume role permissions to Amazon
@@ -5722,8 +6026,8 @@ module Aws::Kendra
5722
6026
  # }
5723
6027
  #
5724
6028
  # @!attribute [rw] index_id
5725
- # The identifier of the index you want to describe query suggestions
5726
- # settings for.
6029
+ # The identifier of the index with query suggestions that you want to
6030
+ # get information on.
5727
6031
  # @return [String]
5728
6032
  #
5729
6033
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
@@ -5735,7 +6039,7 @@ module Aws::Kendra
5735
6039
  end
5736
6040
 
5737
6041
  # @!attribute [rw] mode
5738
- # Shows whether query suggestions are currently in `ENABLED` mode or
6042
+ # Whether query suggestions are currently in `ENABLED` mode or
5739
6043
  # `LEARN_ONLY` mode.
5740
6044
  #
5741
6045
  # By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
@@ -5748,39 +6052,38 @@ module Aws::Kendra
5748
6052
  # @return [String]
5749
6053
  #
5750
6054
  # @!attribute [rw] status
5751
- # Shows whether the status of query suggestions settings is currently
5752
- # Active or Updating.
6055
+ # Whether the status of query suggestions settings is currently
6056
+ # `ACTIVE` or `UPDATING`.
5753
6057
  #
5754
6058
  # Active means the current settings apply and Updating means your
5755
6059
  # changed settings are in the process of applying.
5756
6060
  # @return [String]
5757
6061
  #
5758
6062
  # @!attribute [rw] query_log_look_back_window_in_days
5759
- # Shows how recent your queries are in your query log time window (in
5760
- # days).
6063
+ # How recent your queries are in your query log time window (in days).
5761
6064
  # @return [Integer]
5762
6065
  #
5763
6066
  # @!attribute [rw] include_queries_without_user_information
5764
- # Shows whether Amazon Kendra uses all queries or only uses queries
5765
- # that include user information to generate query suggestions.
6067
+ # `TRUE` to use all queries, otherwise use only queries that include
6068
+ # user information to generate the query suggestions.
5766
6069
  # @return [Boolean]
5767
6070
  #
5768
6071
  # @!attribute [rw] minimum_number_of_querying_users
5769
- # Shows the minimum number of unique users who must search a query in
5770
- # order for the query to be eligible to suggest to your users.
6072
+ # The minimum number of unique users who must search a query in order
6073
+ # for the query to be eligible to suggest to your users.
5771
6074
  # @return [Integer]
5772
6075
  #
5773
6076
  # @!attribute [rw] minimum_query_count
5774
- # Shows the minimum number of times a query must be searched in order
5775
- # for the query to be eligible to suggest to your users.
6077
+ # The minimum number of times a query must be searched in order for
6078
+ # the query to be eligible to suggest to your users.
5776
6079
  # @return [Integer]
5777
6080
  #
5778
6081
  # @!attribute [rw] last_suggestions_build_time
5779
- # Shows the date-time query suggestions for an index was last updated.
6082
+ # The date-time query suggestions for an index was last updated.
5780
6083
  # @return [Time]
5781
6084
  #
5782
6085
  # @!attribute [rw] last_clear_time
5783
- # Shows the date-time query suggestions for an index was last cleared.
6086
+ # The date-time query suggestions for an index was last cleared.
5784
6087
  #
5785
6088
  # After you clear suggestions, Amazon Kendra learns new suggestions
5786
6089
  # based on new queries added to the query log from the time you
@@ -5789,7 +6092,7 @@ module Aws::Kendra
5789
6092
  # @return [Time]
5790
6093
  #
5791
6094
  # @!attribute [rw] total_suggestions_count
5792
- # Shows the current total count of query suggestions for an index.
6095
+ # The current total count of query suggestions for an index.
5793
6096
  #
5794
6097
  # This count can change when you update your query suggestions
5795
6098
  # settings, if you filter out certain queries from suggestions using a
@@ -5822,12 +6125,11 @@ module Aws::Kendra
5822
6125
  # }
5823
6126
  #
5824
6127
  # @!attribute [rw] id
5825
- # The identifier of the thesaurus to describe.
6128
+ # The identifier of the thesaurus you want to get information on.
5826
6129
  # @return [String]
5827
6130
  #
5828
6131
  # @!attribute [rw] index_id
5829
- # The identifier of the index associated with the thesaurus to
5830
- # describe.
6132
+ # The identifier of the index for the thesaurus.
5831
6133
  # @return [String]
5832
6134
  #
5833
6135
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
@@ -5844,8 +6146,7 @@ module Aws::Kendra
5844
6146
  # @return [String]
5845
6147
  #
5846
6148
  # @!attribute [rw] index_id
5847
- # The identifier of the index associated with the thesaurus to
5848
- # describe.
6149
+ # The identifier of the index for the thesaurus.
5849
6150
  # @return [String]
5850
6151
  #
5851
6152
  # @!attribute [rw] name
@@ -6063,6 +6364,7 @@ module Aws::Kendra
6063
6364
  # },
6064
6365
  # ],
6065
6366
  # content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
6367
+ # access_control_configuration_id: "AccessControlConfigurationId",
6066
6368
  # }
6067
6369
  #
6068
6370
  # @!attribute [rw] id
@@ -6107,8 +6409,10 @@ module Aws::Kendra
6107
6409
  # @return [Array<Types::DocumentAttribute>]
6108
6410
  #
6109
6411
  # @!attribute [rw] access_control_list
6110
- # Information on user and group access rights, which is used for user
6111
- # context filtering.
6412
+ # Information on principals (users and/or groups) and which documents
6413
+ # they should have access to. This is useful for user context
6414
+ # filtering, where search results are filtered based on the user or
6415
+ # their group access to documents.
6112
6416
  # @return [Array<Types::Principal>]
6113
6417
  #
6114
6418
  # @!attribute [rw] hierarchical_access_control_list
@@ -6124,6 +6428,11 @@ module Aws::Kendra
6124
6428
  # The file type of the document in the `Blob` field.
6125
6429
  # @return [String]
6126
6430
  #
6431
+ # @!attribute [rw] access_control_configuration_id
6432
+ # The identifier of the access control configuration that you want to
6433
+ # apply to the document.
6434
+ # @return [String]
6435
+ #
6127
6436
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Document AWS API Documentation
6128
6437
  #
6129
6438
  class Document < Struct.new(
@@ -6134,7 +6443,8 @@ module Aws::Kendra
6134
6443
  :attributes,
6135
6444
  :access_control_list,
6136
6445
  :hierarchical_access_control_list,
6137
- :content_type)
6446
+ :content_type,
6447
+ :access_control_configuration_id)
6138
6448
  SENSITIVE = []
6139
6449
  include Aws::Structure
6140
6450
  end
@@ -6451,7 +6761,8 @@ module Aws::Kendra
6451
6761
  include Aws::Structure
6452
6762
  end
6453
6763
 
6454
- # Specifies the properties of a custom index field.
6764
+ # Specifies the properties, such as relevance tuning and searchability,
6765
+ # of an index field.
6455
6766
  #
6456
6767
  # @note When making an API call, you may pass DocumentMetadataConfiguration
6457
6768
  # data as a hash:
@@ -6485,8 +6796,8 @@ module Aws::Kendra
6485
6796
  # @return [String]
6486
6797
  #
6487
6798
  # @!attribute [rw] relevance
6488
- # Provides manual tuning parameters to determine how the field affects
6489
- # the search results.
6799
+ # Provides tuning parameters to determine how the field affects the
6800
+ # search results.
6490
6801
  # @return [Types::Relevance]
6491
6802
  #
6492
6803
  # @!attribute [rw] search
@@ -6523,13 +6834,12 @@ module Aws::Kendra
6523
6834
  # }
6524
6835
  #
6525
6836
  # @!attribute [rw] name
6526
- # The name of the tuning configuration to override document relevance
6527
- # at the index level.
6837
+ # The name of the index field.
6528
6838
  # @return [String]
6529
6839
  #
6530
6840
  # @!attribute [rw] relevance
6531
- # Provides information for manually tuning the relevance of a field in
6532
- # a search. When a query includes terms that match the field, the
6841
+ # Provides information for tuning the relevance of a field in a
6842
+ # search. When a query includes terms that match the field, the
6533
6843
  # results are given a boost in the response based on these tuning
6534
6844
  # parameters.
6535
6845
  # @return [Types::Relevance]
@@ -6954,8 +7264,8 @@ module Aws::Kendra
6954
7264
  include Aws::Structure
6955
7265
  end
6956
7266
 
6957
- # Provides information about a frequently asked questions and answer
6958
- # contained in an index.
7267
+ # Summary information for frequently asked questions and answers
7268
+ # included in an index.
6959
7269
  #
6960
7270
  # @!attribute [rw] id
6961
7271
  # The unique identifier of the FAQ.
@@ -7789,9 +8099,9 @@ module Aws::Kendra
7789
8099
  include Aws::Structure
7790
8100
  end
7791
8101
 
7792
- # A list of users or sub groups that belong to a group. Users and groups
7793
- # are useful for filtering search results to different users based on
7794
- # their group's access to documents.
8102
+ # A list of users or sub groups that belong to a group. This is useful
8103
+ # for user context filtering, where search results are filtered based on
8104
+ # the user or their group access to documents.
7795
8105
  #
7796
8106
  # @note When making an API call, you may pass GroupMembers
7797
8107
  # data as a hash:
@@ -7852,8 +8162,8 @@ module Aws::Kendra
7852
8162
  include Aws::Structure
7853
8163
  end
7854
8164
 
7855
- # Information on the processing of `PUT` and `DELETE` actions for
7856
- # mapping users to their groups.
8165
+ # Summary information on the processing of `PUT` and `DELETE` actions
8166
+ # for mapping users to their groups.
7857
8167
  #
7858
8168
  # @!attribute [rw] status
7859
8169
  # The current processing status of actions for mapping users to their
@@ -7893,7 +8203,7 @@ module Aws::Kendra
7893
8203
  include Aws::Structure
7894
8204
  end
7895
8205
 
7896
- # Group summary information.
8206
+ # Summary information for groups.
7897
8207
  #
7898
8208
  # @!attribute [rw] group_id
7899
8209
  # The identifier of the group you want group summary information on.
@@ -8057,7 +8367,7 @@ module Aws::Kendra
8057
8367
  include Aws::Structure
8058
8368
  end
8059
8369
 
8060
- # A summary of information on the configuration of an index.
8370
+ # Summary information on the configuration of an index.
8061
8371
  #
8062
8372
  # @!attribute [rw] name
8063
8373
  # The identifier of the index.
@@ -8513,6 +8823,59 @@ module Aws::Kendra
8513
8823
  include Aws::Structure
8514
8824
  end
8515
8825
 
8826
+ # @note When making an API call, you may pass ListAccessControlConfigurationsRequest
8827
+ # data as a hash:
8828
+ #
8829
+ # {
8830
+ # index_id: "IndexId", # required
8831
+ # next_token: "String",
8832
+ # max_results: 1,
8833
+ # }
8834
+ #
8835
+ # @!attribute [rw] index_id
8836
+ # The identifier of the index for the access control configuration.
8837
+ # @return [String]
8838
+ #
8839
+ # @!attribute [rw] next_token
8840
+ # If the previous response was incomplete (because there's more data
8841
+ # to retrieve), Amazon Kendra returns a pagination token in the
8842
+ # response. You can use this pagination token to retrieve the next set
8843
+ # of access control configurations.
8844
+ # @return [String]
8845
+ #
8846
+ # @!attribute [rw] max_results
8847
+ # The maximum number of access control configurations to return.
8848
+ # @return [Integer]
8849
+ #
8850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsRequest AWS API Documentation
8851
+ #
8852
+ class ListAccessControlConfigurationsRequest < Struct.new(
8853
+ :index_id,
8854
+ :next_token,
8855
+ :max_results)
8856
+ SENSITIVE = []
8857
+ include Aws::Structure
8858
+ end
8859
+
8860
+ # @!attribute [rw] next_token
8861
+ # If the response is truncated, Amazon Kendra returns this token,
8862
+ # which you can use in the subsequent request to retrieve the next set
8863
+ # of access control configurations.
8864
+ # @return [String]
8865
+ #
8866
+ # @!attribute [rw] access_control_configurations
8867
+ # The details of your access control configurations.
8868
+ # @return [Array<Types::AccessControlConfigurationSummary>]
8869
+ #
8870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsResponse AWS API Documentation
8871
+ #
8872
+ class ListAccessControlConfigurationsResponse < Struct.new(
8873
+ :next_token,
8874
+ :access_control_configurations)
8875
+ SENSITIVE = []
8876
+ include Aws::Structure
8877
+ end
8878
+
8516
8879
  # @note When making an API call, you may pass ListDataSourceSyncJobsRequest
8517
8880
  # data as a hash:
8518
8881
  #
@@ -8533,7 +8896,7 @@ module Aws::Kendra
8533
8896
  # @return [String]
8534
8897
  #
8535
8898
  # @!attribute [rw] index_id
8536
- # The identifier of the index that contains the data source.
8899
+ # The identifier of the index used with the data source.
8537
8900
  # @return [String]
8538
8901
  #
8539
8902
  # @!attribute [rw] next_token
@@ -8601,7 +8964,7 @@ module Aws::Kendra
8601
8964
  # }
8602
8965
  #
8603
8966
  # @!attribute [rw] index_id
8604
- # The identifier of the index that contains the data source.
8967
+ # The identifier of the index used with one or more data sources.
8605
8968
  # @return [String]
8606
8969
  #
8607
8970
  # @!attribute [rw] next_token
@@ -9099,7 +9462,7 @@ module Aws::Kendra
9099
9462
  # }
9100
9463
  #
9101
9464
  # @!attribute [rw] index_id
9102
- # The identifier of the index associated with the thesaurus to list.
9465
+ # The identifier of the index with one or more thesauri.
9103
9466
  # @return [String]
9104
9467
  #
9105
9468
  # @!attribute [rw] next_token
@@ -9413,7 +9776,11 @@ module Aws::Kendra
9413
9776
  include Aws::Structure
9414
9777
  end
9415
9778
 
9416
- # Provides user and group information for document access filtering.
9779
+ # Provides user and group information for [user context filtering][1].
9780
+ #
9781
+ #
9782
+ #
9783
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
9417
9784
  #
9418
9785
  # @note When making an API call, you may pass Principal
9419
9786
  # data as a hash:
@@ -9434,7 +9801,7 @@ module Aws::Kendra
9434
9801
  # @return [String]
9435
9802
  #
9436
9803
  # @!attribute [rw] access
9437
- # Whether to allow or deny access to the principal.
9804
+ # Whether to allow or deny document access to the principal.
9438
9805
  # @return [String]
9439
9806
  #
9440
9807
  # @!attribute [rw] data_source_id
@@ -10119,7 +10486,9 @@ module Aws::Kendra
10119
10486
  # @return [Boolean]
10120
10487
  #
10121
10488
  # @!attribute [rw] folder_ids
10122
- # The identifier of the Quip folders you want to index.
10489
+ # The identifiers of the Quip folders you want to index. You can find
10490
+ # in your browser URL when you access your folder in Quip. For
10491
+ # example, *https://quip-company.com/zlLuOVNSarTL/folder-name*.
10123
10492
  # @return [Array<String>]
10124
10493
  #
10125
10494
  # @!attribute [rw] thread_field_mappings
@@ -10208,9 +10577,9 @@ module Aws::Kendra
10208
10577
  include Aws::Structure
10209
10578
  end
10210
10579
 
10211
- # Provides information for manually tuning the relevance of a field in a
10212
- # search. When a query includes terms that match the field, the results
10213
- # are given a boost in the response based on these tuning parameters.
10580
+ # Provides information for tuning the relevance of a field in a search.
10581
+ # When a query includes terms that match the field, the results are
10582
+ # given a boost in the response based on these tuning parameters.
10214
10583
  #
10215
10584
  # @note When making an API call, you may pass Relevance
10216
10585
  # data as a hash:
@@ -11232,10 +11601,9 @@ module Aws::Kendra
11232
11601
  # The type of authentication used to connect to the ServiceNow
11233
11602
  # instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated
11234
11603
  # using the user name and password provided in the Secrets Manager
11235
- # secret in the `SecretArn` field. When you choose `OAUTH2`, Amazon
11236
- # Kendra is authenticated using the OAuth token and secret provided in
11237
- # the Secrets Manager secret, and the user name and password are used
11238
- # to determine which information Amazon Kendra has access to.
11604
+ # secret in the `SecretArn` field. If you choose `OAUTH2`, Amazon
11605
+ # Kendra is authenticated using the credentials of client ID, client
11606
+ # secret, user name and password.
11239
11607
  #
11240
11608
  # When you use `OAUTH2` authentication, you must generate a token and
11241
11609
  # a client secret using the ServiceNow console. For more information,
@@ -11282,8 +11650,7 @@ module Aws::Kendra
11282
11650
  # }
11283
11651
  #
11284
11652
  # @!attribute [rw] crawl_attachments
11285
- # Indicates whether Amazon Kendra should index attachments to
11286
- # knowledge articles.
11653
+ # `TRUE` to index attachments to knowledge articles.
11287
11654
  # @return [Boolean]
11288
11655
  #
11289
11656
  # @!attribute [rw] include_attachment_file_patterns
@@ -11383,8 +11750,7 @@ module Aws::Kendra
11383
11750
  # }
11384
11751
  #
11385
11752
  # @!attribute [rw] crawl_attachments
11386
- # Indicates whether Amazon Kendra should crawl attachments to the
11387
- # service catalog items.
11753
+ # `TRUE` to index attachments to service catalog items.
11388
11754
  # @return [Boolean]
11389
11755
  #
11390
11756
  # @!attribute [rw] include_attachment_file_patterns
@@ -11486,6 +11852,12 @@ module Aws::Kendra
11486
11852
  # bucket: "S3BucketName", # required
11487
11853
  # key: "S3ObjectKey", # required
11488
11854
  # },
11855
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
11856
+ # proxy_configuration: {
11857
+ # host: "Host", # required
11858
+ # port: 1, # required
11859
+ # credentials: "SecretArn",
11860
+ # },
11489
11861
  # }
11490
11862
  #
11491
11863
  # @!attribute [rw] share_point_version
@@ -11504,9 +11876,14 @@ module Aws::Kendra
11504
11876
  # provide the sever domain name as part of the credentials. For more
11505
11877
  # information, see [Using a Microsoft SharePoint Data Source][1].
11506
11878
  #
11879
+ # You can also provide OAuth authentication credentials of user name,
11880
+ # password, client ID, and client secret. For more information, see
11881
+ # [Authentication for a SharePoint data source][2].
11882
+ #
11507
11883
  #
11508
11884
  #
11509
11885
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
11886
+ # [2]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html#sharepoint-authentication
11510
11887
  # @return [String]
11511
11888
  #
11512
11889
  # @!attribute [rw] crawl_attachments
@@ -11579,6 +11956,36 @@ module Aws::Kendra
11579
11956
  # use this to connect to SharePoint.
11580
11957
  # @return [Types::S3Path]
11581
11958
  #
11959
+ # @!attribute [rw] authentication_type
11960
+ # Whether you want to connect to SharePoint using basic authentication
11961
+ # of user name and password, or OAuth authentication of user name,
11962
+ # password, client ID, and client secret. You can use OAuth
11963
+ # authentication for SharePoint Online.
11964
+ # @return [String]
11965
+ #
11966
+ # @!attribute [rw] proxy_configuration
11967
+ # Configuration information to connect to your Microsoft SharePoint
11968
+ # site URLs via instance via a web proxy. You can use this option for
11969
+ # SharePoint Server.
11970
+ #
11971
+ # You must provide the website host name and port number. For example,
11972
+ # the host name of *https://a.example.com/page1.html* is
11973
+ # "a.example.com" and the port is 443, the standard port for HTTPS.
11974
+ #
11975
+ # Web proxy credentials are optional and you can use them to connect
11976
+ # to a web proxy server that requires basic authentication of user
11977
+ # name and password. To store web proxy credentials, you use a secret
11978
+ # in Secrets Manager.
11979
+ #
11980
+ # It is recommended that you follow best security practices when
11981
+ # configuring your web proxy. This includes setting up throttling,
11982
+ # setting up logging and monitoring, and applying security patches on
11983
+ # a regular basis. If you use your web proxy with multiple data
11984
+ # sources, sync jobs that occur at the same time could strain the load
11985
+ # on your proxy. It is recommended you prepare your proxy beforehand
11986
+ # for any security and load requirements.
11987
+ # @return [Types::ProxyConfiguration]
11988
+ #
11582
11989
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
11583
11990
  #
11584
11991
  class SharePointConfiguration < Struct.new(
@@ -11593,7 +12000,9 @@ module Aws::Kendra
11593
12000
  :field_mappings,
11594
12001
  :document_title_field_name,
11595
12002
  :disable_local_groups,
11596
- :ssl_certificate_s3_path)
12003
+ :ssl_certificate_s3_path,
12004
+ :authentication_type,
12005
+ :proxy_configuration)
11597
12006
  SENSITIVE = []
11598
12007
  include Aws::Structure
11599
12008
  end
@@ -12247,6 +12656,40 @@ module Aws::Kendra
12247
12656
  #
12248
12657
  class TagResourceResponse < Aws::EmptyStructure; end
12249
12658
 
12659
+ # Provides a template for the configuration information to connect to
12660
+ # your data source.
12661
+ #
12662
+ # @note When making an API call, you may pass TemplateConfiguration
12663
+ # data as a hash:
12664
+ #
12665
+ # {
12666
+ # template: {
12667
+ # },
12668
+ # }
12669
+ #
12670
+ # @!attribute [rw] template
12671
+ # The template schema used for the data source.
12672
+ #
12673
+ # The following links to the template schema for data sources where
12674
+ # templates are supported:
12675
+ #
12676
+ # * [Zendesk template schema][1]
12677
+ #
12678
+ # ^
12679
+ #
12680
+ #
12681
+ #
12682
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-zendesk.html#zendesk-template-schema
12683
+ # @return [Hash,Array,String,Numeric,Boolean]
12684
+ #
12685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TemplateConfiguration AWS API Documentation
12686
+ #
12687
+ class TemplateConfiguration < Struct.new(
12688
+ :template)
12689
+ SENSITIVE = []
12690
+ include Aws::Structure
12691
+ end
12692
+
12250
12693
  # Provides information about text documents indexed in an index.
12251
12694
  #
12252
12695
  # @!attribute [rw] indexed_text_documents_count
@@ -12388,6 +12831,86 @@ module Aws::Kendra
12388
12831
  #
12389
12832
  class UntagResourceResponse < Aws::EmptyStructure; end
12390
12833
 
12834
+ # @note When making an API call, you may pass UpdateAccessControlConfigurationRequest
12835
+ # data as a hash:
12836
+ #
12837
+ # {
12838
+ # index_id: "IndexId", # required
12839
+ # id: "AccessControlConfigurationId", # required
12840
+ # name: "AccessControlConfigurationName",
12841
+ # description: "Description",
12842
+ # access_control_list: [
12843
+ # {
12844
+ # name: "PrincipalName", # required
12845
+ # type: "USER", # required, accepts USER, GROUP
12846
+ # access: "ALLOW", # required, accepts ALLOW, DENY
12847
+ # data_source_id: "DataSourceId",
12848
+ # },
12849
+ # ],
12850
+ # hierarchical_access_control_list: [
12851
+ # {
12852
+ # principal_list: [ # required
12853
+ # {
12854
+ # name: "PrincipalName", # required
12855
+ # type: "USER", # required, accepts USER, GROUP
12856
+ # access: "ALLOW", # required, accepts ALLOW, DENY
12857
+ # data_source_id: "DataSourceId",
12858
+ # },
12859
+ # ],
12860
+ # },
12861
+ # ],
12862
+ # }
12863
+ #
12864
+ # @!attribute [rw] index_id
12865
+ # The identifier of the index for an access control configuration.
12866
+ # @return [String]
12867
+ #
12868
+ # @!attribute [rw] id
12869
+ # The identifier of the access control configuration you want to
12870
+ # update.
12871
+ # @return [String]
12872
+ #
12873
+ # @!attribute [rw] name
12874
+ # A new name for the access control configuration.
12875
+ # @return [String]
12876
+ #
12877
+ # @!attribute [rw] description
12878
+ # A new description for the access control configuration.
12879
+ # @return [String]
12880
+ #
12881
+ # @!attribute [rw] access_control_list
12882
+ # Information you want to update on principals (users and/or groups)
12883
+ # and which documents they should have access to. This is useful for
12884
+ # user context filtering, where search results are filtered based on
12885
+ # the user or their group access to documents.
12886
+ # @return [Array<Types::Principal>]
12887
+ #
12888
+ # @!attribute [rw] hierarchical_access_control_list
12889
+ # The updated list of [principal][1] lists that define the hierarchy
12890
+ # for which documents users should have access to.
12891
+ #
12892
+ #
12893
+ #
12894
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
12895
+ # @return [Array<Types::HierarchicalPrincipal>]
12896
+ #
12897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationRequest AWS API Documentation
12898
+ #
12899
+ class UpdateAccessControlConfigurationRequest < Struct.new(
12900
+ :index_id,
12901
+ :id,
12902
+ :name,
12903
+ :description,
12904
+ :access_control_list,
12905
+ :hierarchical_access_control_list)
12906
+ SENSITIVE = []
12907
+ include Aws::Structure
12908
+ end
12909
+
12910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationResponse AWS API Documentation
12911
+ #
12912
+ class UpdateAccessControlConfigurationResponse < Aws::EmptyStructure; end
12913
+
12391
12914
  # @note When making an API call, you may pass UpdateDataSourceRequest
12392
12915
  # data as a hash:
12393
12916
  #
@@ -12433,6 +12956,12 @@ module Aws::Kendra
12433
12956
  # bucket: "S3BucketName", # required
12434
12957
  # key: "S3ObjectKey", # required
12435
12958
  # },
12959
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
12960
+ # proxy_configuration: {
12961
+ # host: "Host", # required
12962
+ # port: 1, # required
12963
+ # credentials: "SecretArn",
12964
+ # },
12436
12965
  # },
12437
12966
  # database_configuration: {
12438
12967
  # database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
@@ -12645,6 +13174,11 @@ module Aws::Kendra
12645
13174
  # },
12646
13175
  # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
12647
13176
  # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
13177
+ # proxy_configuration: {
13178
+ # host: "Host", # required
13179
+ # port: 1, # required
13180
+ # credentials: "SecretArn",
13181
+ # },
12648
13182
  # },
12649
13183
  # google_drive_configuration: {
12650
13184
  # secret_arn: "SecretArn", # required
@@ -13008,6 +13542,14 @@ module Aws::Kendra
13008
13542
  # security_group_ids: ["VpcSecurityGroupId"], # required
13009
13543
  # },
13010
13544
  # },
13545
+ # template_configuration: {
13546
+ # template: {
13547
+ # },
13548
+ # },
13549
+ # },
13550
+ # vpc_configuration: {
13551
+ # subnet_ids: ["SubnetId"], # required
13552
+ # security_group_ids: ["VpcSecurityGroupId"], # required
13011
13553
  # },
13012
13554
  # description: "Description",
13013
13555
  # schedule: "ScanSchedule",
@@ -13072,43 +13614,56 @@ module Aws::Kendra
13072
13614
  # }
13073
13615
  #
13074
13616
  # @!attribute [rw] id
13075
- # The unique identifier of the data source to update.
13617
+ # The identifier of the data source you want to update.
13076
13618
  # @return [String]
13077
13619
  #
13078
13620
  # @!attribute [rw] name
13079
- # The name of the data source to update. The name of the data source
13080
- # can't be updated. To rename a data source you must delete the data
13081
- # source and re-create it.
13621
+ # A new name for the data source connector.
13082
13622
  # @return [String]
13083
13623
  #
13084
13624
  # @!attribute [rw] index_id
13085
- # The identifier of the index that contains the data source to update.
13625
+ # The identifier of the index used with the data source connector.
13086
13626
  # @return [String]
13087
13627
  #
13088
13628
  # @!attribute [rw] configuration
13089
- # Configuration information for an Amazon Kendra data source you want
13090
- # to update.
13629
+ # Configuration information you want to update for the data source
13630
+ # connector.
13091
13631
  # @return [Types::DataSourceConfiguration]
13092
13632
  #
13633
+ # @!attribute [rw] vpc_configuration
13634
+ # Configuration information for an Amazon Virtual Private Cloud to
13635
+ # connect to your data source. For more information, see [Configuring
13636
+ # a VPC][1].
13637
+ #
13638
+ #
13639
+ #
13640
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
13641
+ # @return [Types::DataSourceVpcConfiguration]
13642
+ #
13093
13643
  # @!attribute [rw] description
13094
- # The new description for the data source.
13644
+ # A new description for the data source connector.
13095
13645
  # @return [String]
13096
13646
  #
13097
13647
  # @!attribute [rw] schedule
13098
- # The new update schedule for the data source.
13648
+ # The sync schedule you want to update for the data source connector.
13099
13649
  # @return [String]
13100
13650
  #
13101
13651
  # @!attribute [rw] role_arn
13102
- # The Amazon Resource Name (ARN) of the new role to use when the data
13103
- # source is accessing resources on your behalf.
13652
+ # The Amazon Resource Name (ARN) of a role with permission to access
13653
+ # the data source. For more information, see [IAM Roles for Amazon
13654
+ # Kendra][1].
13655
+ #
13656
+ #
13657
+ #
13658
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
13104
13659
  # @return [String]
13105
13660
  #
13106
13661
  # @!attribute [rw] language_code
13107
- # The code for a language. This allows you to support a language for
13108
- # all documents when updating the data source. English is supported by
13109
- # default. For more information on supported languages, including
13110
- # their codes, see [Adding documents in languages other than
13111
- # English][1].
13662
+ # The code for a language you want to update for the data source
13663
+ # connector. This allows you to support a language for all documents
13664
+ # when updating the data source. English is supported by default. For
13665
+ # more information on supported languages, including their codes, see
13666
+ # [Adding documents in languages other than English][1].
13112
13667
  #
13113
13668
  #
13114
13669
  #
@@ -13116,8 +13671,8 @@ module Aws::Kendra
13116
13671
  # @return [String]
13117
13672
  #
13118
13673
  # @!attribute [rw] custom_document_enrichment_configuration
13119
- # Configuration information for altering document metadata and content
13120
- # during the document ingestion process when you update a data source.
13674
+ # Configuration information you want to update for altering document
13675
+ # metadata and content during the document ingestion process.
13121
13676
  #
13122
13677
  # For more information on how to create, modify and delete document
13123
13678
  # metadata, or make other content alterations when you ingest
@@ -13136,6 +13691,7 @@ module Aws::Kendra
13136
13691
  :name,
13137
13692
  :index_id,
13138
13693
  :configuration,
13694
+ :vpc_configuration,
13139
13695
  :description,
13140
13696
  :schedule,
13141
13697
  :role_arn,
@@ -13171,12 +13727,11 @@ module Aws::Kendra
13171
13727
  # @return [String]
13172
13728
  #
13173
13729
  # @!attribute [rw] name
13174
- # The name of your Amazon Kendra experience you want to update.
13730
+ # A new name for your Amazon Kendra experience.
13175
13731
  # @return [String]
13176
13732
  #
13177
13733
  # @!attribute [rw] index_id
13178
- # The identifier of the index for your Amazon Kendra experience you
13179
- # want to update.
13734
+ # The identifier of the index for your Amazon Kendra experience.
13180
13735
  # @return [String]
13181
13736
  #
13182
13737
  # @!attribute [rw] role_arn
@@ -13191,11 +13746,12 @@ module Aws::Kendra
13191
13746
  # @return [String]
13192
13747
  #
13193
13748
  # @!attribute [rw] configuration
13194
- # Configuration information for your Amazon Kendra you want to update.
13749
+ # Configuration information you want to update for your Amazon Kendra
13750
+ # experience.
13195
13751
  # @return [Types::ExperienceConfiguration]
13196
13752
  #
13197
13753
  # @!attribute [rw] description
13198
- # The description of your Amazon Kendra experience you want to update.
13754
+ # A new description for your Amazon Kendra experience.
13199
13755
  # @return [String]
13200
13756
  #
13201
13757
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperienceRequest AWS API Documentation
@@ -13268,16 +13824,16 @@ module Aws::Kendra
13268
13824
  # }
13269
13825
  #
13270
13826
  # @!attribute [rw] id
13271
- # The identifier of the index to update.
13827
+ # The identifier of the index you want to update.
13272
13828
  # @return [String]
13273
13829
  #
13274
13830
  # @!attribute [rw] name
13275
- # The name of the index to update.
13831
+ # The name of the index you want to update.
13276
13832
  # @return [String]
13277
13833
  #
13278
13834
  # @!attribute [rw] role_arn
13279
- # A new IAM role that gives Amazon Kendra permission to access your
13280
- # Amazon CloudWatch logs.
13835
+ # An Identity and Access Management (IAM) role that gives Amazon
13836
+ # Kendra permission to access Amazon CloudWatch logs and metrics.
13281
13837
  # @return [String]
13282
13838
  #
13283
13839
  # @!attribute [rw] description
@@ -13285,7 +13841,10 @@ module Aws::Kendra
13285
13841
  # @return [String]
13286
13842
  #
13287
13843
  # @!attribute [rw] document_metadata_configuration_updates
13288
- # The document metadata you want to update.
13844
+ # The document metadata configuration you want to update for the
13845
+ # index. Document metadata are fields or attributes associated with
13846
+ # your documents. For example, the company department name associated
13847
+ # with each document.
13289
13848
  # @return [Array<Types::DocumentMetadataConfiguration>]
13290
13849
  #
13291
13850
  # @!attribute [rw] capacity_units
@@ -13348,19 +13907,19 @@ module Aws::Kendra
13348
13907
  # }
13349
13908
  #
13350
13909
  # @!attribute [rw] index_id
13351
- # The identifier of the index for a block list.
13910
+ # The identifier of the index for the block list.
13352
13911
  # @return [String]
13353
13912
  #
13354
13913
  # @!attribute [rw] id
13355
- # The unique identifier of a block list.
13914
+ # The identifier of the block list you want to update.
13356
13915
  # @return [String]
13357
13916
  #
13358
13917
  # @!attribute [rw] name
13359
- # The name of a block list.
13918
+ # A new name for the block list.
13360
13919
  # @return [String]
13361
13920
  #
13362
13921
  # @!attribute [rw] description
13363
- # The description for a block list.
13922
+ # A new description for the block list.
13364
13923
  # @return [String]
13365
13924
  #
13366
13925
  # @!attribute [rw] source_s3_path
@@ -13408,8 +13967,8 @@ module Aws::Kendra
13408
13967
  # }
13409
13968
  #
13410
13969
  # @!attribute [rw] index_id
13411
- # The identifier of the index you want to update query suggestions
13412
- # settings for.
13970
+ # The identifier of the index with query suggestions you want to
13971
+ # update.
13413
13972
  # @return [String]
13414
13973
  #
13415
13974
  # @!attribute [rw] mode
@@ -13500,23 +14059,24 @@ module Aws::Kendra
13500
14059
  # }
13501
14060
  #
13502
14061
  # @!attribute [rw] id
13503
- # The identifier of the thesaurus to update.
14062
+ # The identifier of the thesaurus you want to update.
13504
14063
  # @return [String]
13505
14064
  #
13506
14065
  # @!attribute [rw] name
13507
- # The updated name of the thesaurus.
14066
+ # A new name for the thesaurus.
13508
14067
  # @return [String]
13509
14068
  #
13510
14069
  # @!attribute [rw] index_id
13511
- # The identifier of the index associated with the thesaurus to update.
14070
+ # The identifier of the index for the thesaurus.
13512
14071
  # @return [String]
13513
14072
  #
13514
14073
  # @!attribute [rw] description
13515
- # The updated description of the thesaurus.
14074
+ # A new description for the thesaurus.
13516
14075
  # @return [String]
13517
14076
  #
13518
14077
  # @!attribute [rw] role_arn
13519
- # The updated role ARN of the thesaurus.
14078
+ # An IAM role that gives Amazon Kendra permissions to access thesaurus
14079
+ # file specified in `SourceS3Path`.
13520
14080
  # @return [String]
13521
14081
  #
13522
14082
  # @!attribute [rw] source_s3_path
@@ -13595,8 +14155,13 @@ module Aws::Kendra
13595
14155
  # Provides information about the user context for an Amazon Kendra
13596
14156
  # index.
13597
14157
  #
13598
- # This is used for filtering search results for different users based on
13599
- # their access to documents.
14158
+ # User context filtering is a kind of personalized search with the
14159
+ # benefit of controlling access to documents. For example, not all teams
14160
+ # that search the company portal for information should access
14161
+ # top-secret company documents, nor are these documents relevant to all
14162
+ # users. Only specific users or groups of teams given access to
14163
+ # top-secret documents should see these documents in their search
14164
+ # results.
13600
14165
  #
13601
14166
  # You provide one of the following:
13602
14167
  #
@@ -13655,11 +14220,11 @@ module Aws::Kendra
13655
14220
 
13656
14221
  # Provides the configuration information to fetch access levels of
13657
14222
  # groups and users from an Amazon Web Services Single Sign On identity
13658
- # source. This is useful for setting up user context filtering, where
13659
- # Amazon Kendra filters search results for different users based on
13660
- # their group's access to documents. You can also map your users to
13661
- # their groups for user context filtering using the [PutPrincipalMapping
13662
- # API][1].
14223
+ # source. This is useful for user context filtering, where search
14224
+ # results are filtered based on the user or their group access to
14225
+ # documents. You can also use the [PutPrincipalMapping][1] API to map
14226
+ # users to their groups so that you only need to provide the user ID
14227
+ # when you issue the query.
13663
14228
  #
13664
14229
  # To set up an Amazon Web Services SSO identity source in the console to
13665
14230
  # use with Amazon Kendra, see [Getting started with an Amazon Web
@@ -13944,13 +14509,12 @@ module Aws::Kendra
13944
14509
  # authentication.
13945
14510
  #
13946
14511
  # You can connect to websites using basic authentication of user name
13947
- # and password.
14512
+ # and password. You use a secret in [Secrets Manager][1] to store your
14513
+ # authentication credentials.
13948
14514
  #
13949
14515
  # You must provide the website host name and port number. For example,
13950
14516
  # the host name of https://a.example.com/page1.html is
13951
14517
  # "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
14518
  #
13955
14519
  #
13956
14520
  #