aws-sdk-kendra 1.1.0 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-kendra.rb +7 -4
- data/lib/aws-sdk-kendra/client.rb +649 -24
- data/lib/aws-sdk-kendra/client_api.rb +255 -0
- data/lib/aws-sdk-kendra/errors.rb +32 -10
- data/lib/aws-sdk-kendra/resource.rb +1 -0
- data/lib/aws-sdk-kendra/types.rb +1721 -103
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: c065805bbd863e000e77fb894b0b1bdad1b3887de5c64c3c50a39940b42bd35d
|
4
|
+
data.tar.gz: 56438bd0a9ad0773cabb0efdeb7fb7ea655334d5573672024dc78e990f3ee81f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7edac96e82fb4204d12e7dd06de7383c7b81108598c9a529875256f3c9aae437174a748b35fe8947a7b56ed80c866b8fc8058bc6e7b456a568478b34337fa34f
|
7
|
+
data.tar.gz: 8b974a9d4872f480825bd966b385deedba47ff5273b25e9793621d7488765bf02df9338fead7722faaddf86f7c4245ff2bf1a8993de0d2c436f3424d1a464fef
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-kendra/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# kendra = Aws::Kendra::Client.new
|
28
|
+
# resp = kendra.batch_delete_document(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWSKendraFrontendService
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWSKendraFrontendService are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Kendra::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWSKendraFrontendService API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-kendra/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Kendra
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.6.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:kendra)
|
31
31
|
|
32
32
|
module Aws::Kendra
|
33
|
+
# An API client for Kendra. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Kendra::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Kendra
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Kendra
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Kendra
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Kendra
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Kendra
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Kendra
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Kendra
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::Kendra
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::Kendra
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -277,6 +331,9 @@ module Aws::Kendra
|
|
277
331
|
# @option params [required, Array<String>] :document_id_list
|
278
332
|
# One or more identifiers for documents to delete from the index.
|
279
333
|
#
|
334
|
+
# @option params [Types::DataSourceSyncJobMetricTarget] :data_source_sync_job_metric_target
|
335
|
+
# Maps a particular data source sync job to a particular data source.
|
336
|
+
#
|
280
337
|
# @return [Types::BatchDeleteDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
281
338
|
#
|
282
339
|
# * {Types::BatchDeleteDocumentResponse#failed_documents #failed_documents} => Array<Types::BatchDeleteDocumentResponseFailedDocument>
|
@@ -286,6 +343,10 @@ module Aws::Kendra
|
|
286
343
|
# resp = client.batch_delete_document({
|
287
344
|
# index_id: "IndexId", # required
|
288
345
|
# document_id_list: ["DocumentId"], # required
|
346
|
+
# data_source_sync_job_metric_target: {
|
347
|
+
# data_source_id: "DataSourceId", # required
|
348
|
+
# data_source_sync_job_id: "DataSourceSyncJobId", # required
|
349
|
+
# },
|
289
350
|
# })
|
290
351
|
#
|
291
352
|
# @example Response structure
|
@@ -332,8 +393,20 @@ module Aws::Kendra
|
|
332
393
|
# @option params [required, Array<Types::Document>] :documents
|
333
394
|
# One or more documents to add to the index.
|
334
395
|
#
|
335
|
-
#
|
336
|
-
#
|
396
|
+
# Documents have the following file size limits.
|
397
|
+
#
|
398
|
+
# * 5 MB total size for inline documents
|
399
|
+
#
|
400
|
+
# * 50 MB total size for files from an S3 bucket
|
401
|
+
#
|
402
|
+
# * 5 MB extracted text for any file
|
403
|
+
#
|
404
|
+
# For more information about file size and transaction per second
|
405
|
+
# quotas, see [Quotas][1].
|
406
|
+
#
|
407
|
+
#
|
408
|
+
#
|
409
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
337
410
|
#
|
338
411
|
# @return [Types::BatchPutDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
339
412
|
#
|
@@ -438,6 +511,11 @@ module Aws::Kendra
|
|
438
511
|
#
|
439
512
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
440
513
|
#
|
514
|
+
# @option params [Array<Types::Tag>] :tags
|
515
|
+
# A list of key-value pairs that identify the data source. You can use
|
516
|
+
# the tags to identify and organize your resources and to control access
|
517
|
+
# to resources.
|
518
|
+
#
|
441
519
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
442
520
|
#
|
443
521
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -447,7 +525,7 @@ module Aws::Kendra
|
|
447
525
|
# resp = client.create_data_source({
|
448
526
|
# name: "DataSourceName", # required
|
449
527
|
# index_id: "IndexId", # required
|
450
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE
|
528
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
451
529
|
# configuration: { # required
|
452
530
|
# s3_configuration: {
|
453
531
|
# bucket_name: "S3BucketName", # required
|
@@ -465,6 +543,9 @@ module Aws::Kendra
|
|
465
543
|
# urls: ["Url"], # required
|
466
544
|
# secret_arn: "SecretArn", # required
|
467
545
|
# crawl_attachments: false,
|
546
|
+
# use_change_log: false,
|
547
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
548
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
468
549
|
# vpc_configuration: {
|
469
550
|
# subnet_ids: ["SubnetId"], # required
|
470
551
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
@@ -508,10 +589,140 @@ module Aws::Kendra
|
|
508
589
|
# allowed_groups_column_name: "ColumnName", # required
|
509
590
|
# },
|
510
591
|
# },
|
592
|
+
# salesforce_configuration: {
|
593
|
+
# server_url: "Url", # required
|
594
|
+
# secret_arn: "SecretArn", # required
|
595
|
+
# standard_object_configurations: [
|
596
|
+
# {
|
597
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
598
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
599
|
+
# document_title_field_name: "DataSourceFieldName",
|
600
|
+
# field_mappings: [
|
601
|
+
# {
|
602
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
603
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
604
|
+
# index_field_name: "IndexFieldName", # required
|
605
|
+
# },
|
606
|
+
# ],
|
607
|
+
# },
|
608
|
+
# ],
|
609
|
+
# knowledge_article_configuration: {
|
610
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
611
|
+
# standard_knowledge_article_type_configuration: {
|
612
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
613
|
+
# document_title_field_name: "DataSourceFieldName",
|
614
|
+
# field_mappings: [
|
615
|
+
# {
|
616
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
617
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
618
|
+
# index_field_name: "IndexFieldName", # required
|
619
|
+
# },
|
620
|
+
# ],
|
621
|
+
# },
|
622
|
+
# custom_knowledge_article_type_configurations: [
|
623
|
+
# {
|
624
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
625
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
626
|
+
# document_title_field_name: "DataSourceFieldName",
|
627
|
+
# field_mappings: [
|
628
|
+
# {
|
629
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
630
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
631
|
+
# index_field_name: "IndexFieldName", # required
|
632
|
+
# },
|
633
|
+
# ],
|
634
|
+
# },
|
635
|
+
# ],
|
636
|
+
# },
|
637
|
+
# chatter_feed_configuration: {
|
638
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
639
|
+
# document_title_field_name: "DataSourceFieldName",
|
640
|
+
# field_mappings: [
|
641
|
+
# {
|
642
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
643
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
644
|
+
# index_field_name: "IndexFieldName", # required
|
645
|
+
# },
|
646
|
+
# ],
|
647
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
648
|
+
# },
|
649
|
+
# crawl_attachments: false,
|
650
|
+
# standard_object_attachment_configuration: {
|
651
|
+
# document_title_field_name: "DataSourceFieldName",
|
652
|
+
# field_mappings: [
|
653
|
+
# {
|
654
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
655
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
656
|
+
# index_field_name: "IndexFieldName", # required
|
657
|
+
# },
|
658
|
+
# ],
|
659
|
+
# },
|
660
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
661
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
662
|
+
# },
|
663
|
+
# one_drive_configuration: {
|
664
|
+
# tenant_domain: "TenantDomain", # required
|
665
|
+
# secret_arn: "SecretArn", # required
|
666
|
+
# one_drive_users: { # required
|
667
|
+
# one_drive_user_list: ["OneDriveUser"],
|
668
|
+
# one_drive_user_s3_path: {
|
669
|
+
# bucket: "S3BucketName", # required
|
670
|
+
# key: "S3ObjectKey", # required
|
671
|
+
# },
|
672
|
+
# },
|
673
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
674
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
675
|
+
# field_mappings: [
|
676
|
+
# {
|
677
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
678
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
679
|
+
# index_field_name: "IndexFieldName", # required
|
680
|
+
# },
|
681
|
+
# ],
|
682
|
+
# },
|
683
|
+
# service_now_configuration: {
|
684
|
+
# host_url: "ServiceNowHostUrl", # required
|
685
|
+
# secret_arn: "SecretArn", # required
|
686
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
687
|
+
# knowledge_article_configuration: {
|
688
|
+
# crawl_attachments: false,
|
689
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
690
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
691
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
692
|
+
# document_title_field_name: "DataSourceFieldName",
|
693
|
+
# field_mappings: [
|
694
|
+
# {
|
695
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
696
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
697
|
+
# index_field_name: "IndexFieldName", # required
|
698
|
+
# },
|
699
|
+
# ],
|
700
|
+
# },
|
701
|
+
# service_catalog_configuration: {
|
702
|
+
# crawl_attachments: false,
|
703
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
704
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
705
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
706
|
+
# document_title_field_name: "DataSourceFieldName",
|
707
|
+
# field_mappings: [
|
708
|
+
# {
|
709
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
710
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
711
|
+
# index_field_name: "IndexFieldName", # required
|
712
|
+
# },
|
713
|
+
# ],
|
714
|
+
# },
|
715
|
+
# },
|
511
716
|
# },
|
512
717
|
# description: "Description",
|
513
718
|
# schedule: "ScanSchedule",
|
514
719
|
# role_arn: "RoleArn", # required
|
720
|
+
# tags: [
|
721
|
+
# {
|
722
|
+
# key: "TagKey", # required
|
723
|
+
# value: "TagValue", # required
|
724
|
+
# },
|
725
|
+
# ],
|
515
726
|
# })
|
516
727
|
#
|
517
728
|
# @example Response structure
|
@@ -551,6 +762,11 @@ module Aws::Kendra
|
|
551
762
|
#
|
552
763
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
553
764
|
#
|
765
|
+
# @option params [Array<Types::Tag>] :tags
|
766
|
+
# A list of key-value pairs that identify the FAQ. You can use the tags
|
767
|
+
# to identify and organize your resources and to control access to
|
768
|
+
# resources.
|
769
|
+
#
|
554
770
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
555
771
|
#
|
556
772
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -566,6 +782,12 @@ module Aws::Kendra
|
|
566
782
|
# key: "S3ObjectKey", # required
|
567
783
|
# },
|
568
784
|
# role_arn: "RoleArn", # required
|
785
|
+
# tags: [
|
786
|
+
# {
|
787
|
+
# key: "TagKey", # required
|
788
|
+
# value: "TagValue", # required
|
789
|
+
# },
|
790
|
+
# ],
|
569
791
|
# })
|
570
792
|
#
|
571
793
|
# @example Response structure
|
@@ -592,6 +814,13 @@ module Aws::Kendra
|
|
592
814
|
# @option params [required, String] :name
|
593
815
|
# The name for the new index.
|
594
816
|
#
|
817
|
+
# @option params [String] :edition
|
818
|
+
# The Amazon Kendra edition to use for the index. Choose
|
819
|
+
# `DEVELOPER_EDITION` for indexes intended for development, testing, or
|
820
|
+
# proof of concept. Use `ENTERPRISE_EDITION` for your production
|
821
|
+
# databases. Once you set the edition for an index, it can't be
|
822
|
+
# changed.
|
823
|
+
#
|
595
824
|
# @option params [required, String] :role_arn
|
596
825
|
# An IAM role that gives Amazon Kendra permissions to access your Amazon
|
597
826
|
# CloudWatch logs and metrics. This is also the role used when you use
|
@@ -606,6 +835,19 @@ module Aws::Kendra
|
|
606
835
|
# @option params [String] :description
|
607
836
|
# A description for the index.
|
608
837
|
#
|
838
|
+
# @option params [String] :client_token
|
839
|
+
# A token that you provide to identify the request to create an index.
|
840
|
+
# Multiple calls to the `CreateIndex` operation with the same client
|
841
|
+
# token will create only one index.”
|
842
|
+
#
|
843
|
+
# **A suitable default value is auto-generated.** You should normally
|
844
|
+
# not need to pass this option.**
|
845
|
+
#
|
846
|
+
# @option params [Array<Types::Tag>] :tags
|
847
|
+
# A list of key-value pairs that identify the index. You can use the
|
848
|
+
# tags to identify and organize your resources and to control access to
|
849
|
+
# resources.
|
850
|
+
#
|
609
851
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
610
852
|
#
|
611
853
|
# * {Types::CreateIndexResponse#id #id} => String
|
@@ -614,11 +856,19 @@ module Aws::Kendra
|
|
614
856
|
#
|
615
857
|
# resp = client.create_index({
|
616
858
|
# name: "IndexName", # required
|
859
|
+
# edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
|
617
860
|
# role_arn: "RoleArn", # required
|
618
861
|
# server_side_encryption_configuration: {
|
619
862
|
# kms_key_id: "KmsKeyId",
|
620
863
|
# },
|
621
864
|
# description: "Description",
|
865
|
+
# client_token: "ClientTokenName",
|
866
|
+
# tags: [
|
867
|
+
# {
|
868
|
+
# key: "TagKey", # required
|
869
|
+
# value: "TagValue", # required
|
870
|
+
# },
|
871
|
+
# ],
|
622
872
|
# })
|
623
873
|
#
|
624
874
|
# @example Response structure
|
@@ -634,6 +884,40 @@ module Aws::Kendra
|
|
634
884
|
req.send_request(options)
|
635
885
|
end
|
636
886
|
|
887
|
+
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
888
|
+
# the data source is already being deleted. While the data source is
|
889
|
+
# being deleted, the `Status` field returned by a call to the operation
|
890
|
+
# is set to `DELETING`. For more information, see [Deleting Data
|
891
|
+
# Sources][1].
|
892
|
+
#
|
893
|
+
#
|
894
|
+
#
|
895
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
|
896
|
+
#
|
897
|
+
# @option params [required, String] :id
|
898
|
+
# The unique identifier of the data source to delete.
|
899
|
+
#
|
900
|
+
# @option params [required, String] :index_id
|
901
|
+
# The unique identifier of the index associated with the data source.
|
902
|
+
#
|
903
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
904
|
+
#
|
905
|
+
# @example Request syntax with placeholder values
|
906
|
+
#
|
907
|
+
# resp = client.delete_data_source({
|
908
|
+
# id: "DataSourceId", # required
|
909
|
+
# index_id: "IndexId", # required
|
910
|
+
# })
|
911
|
+
#
|
912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource AWS API Documentation
|
913
|
+
#
|
914
|
+
# @overload delete_data_source(params = {})
|
915
|
+
# @param [Hash] params ({})
|
916
|
+
def delete_data_source(params = {}, options = {})
|
917
|
+
req = build_request(:delete_data_source, params)
|
918
|
+
req.send_request(options)
|
919
|
+
end
|
920
|
+
|
637
921
|
# Removes an FAQ from an index.
|
638
922
|
#
|
639
923
|
# @option params [required, String] :id
|
@@ -720,7 +1004,7 @@ module Aws::Kendra
|
|
720
1004
|
# resp.id #=> String
|
721
1005
|
# resp.index_id #=> String
|
722
1006
|
# resp.name #=> String
|
723
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1007
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
724
1008
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
725
1009
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
726
1010
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -733,6 +1017,11 @@ module Aws::Kendra
|
|
733
1017
|
# resp.configuration.share_point_configuration.urls[0] #=> String
|
734
1018
|
# resp.configuration.share_point_configuration.secret_arn #=> String
|
735
1019
|
# resp.configuration.share_point_configuration.crawl_attachments #=> Boolean
|
1020
|
+
# resp.configuration.share_point_configuration.use_change_log #=> Boolean
|
1021
|
+
# resp.configuration.share_point_configuration.inclusion_patterns #=> Array
|
1022
|
+
# resp.configuration.share_point_configuration.inclusion_patterns[0] #=> String
|
1023
|
+
# resp.configuration.share_point_configuration.exclusion_patterns #=> Array
|
1024
|
+
# resp.configuration.share_point_configuration.exclusion_patterns[0] #=> String
|
736
1025
|
# resp.configuration.share_point_configuration.vpc_configuration.subnet_ids #=> Array
|
737
1026
|
# resp.configuration.share_point_configuration.vpc_configuration.subnet_ids[0] #=> String
|
738
1027
|
# resp.configuration.share_point_configuration.vpc_configuration.security_group_ids #=> Array
|
@@ -762,6 +1051,89 @@ module Aws::Kendra
|
|
762
1051
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
|
763
1052
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
|
764
1053
|
# resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
|
1054
|
+
# resp.configuration.salesforce_configuration.server_url #=> String
|
1055
|
+
# resp.configuration.salesforce_configuration.secret_arn #=> String
|
1056
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
|
1057
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].name #=> String, one of "ACCOUNT", "CAMPAIGN", "CASE", "CONTACT", "CONTRACT", "DOCUMENT", "GROUP", "IDEA", "LEAD", "OPPORTUNITY", "PARTNER", "PRICEBOOK", "PRODUCT", "PROFILE", "SOLUTION", "TASK", "USER"
|
1058
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_data_field_name #=> String
|
1059
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_title_field_name #=> String
|
1060
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings #=> Array
|
1061
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1062
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].date_field_format #=> String
|
1063
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].index_field_name #=> String
|
1064
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states #=> Array
|
1065
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states[0] #=> String, one of "DRAFT", "PUBLISHED", "ARCHIVED"
|
1066
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_data_field_name #=> String
|
1067
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_title_field_name #=> String
|
1068
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings #=> Array
|
1069
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].data_source_field_name #=> String
|
1070
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].date_field_format #=> String
|
1071
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].index_field_name #=> String
|
1072
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations #=> Array
|
1073
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].name #=> String
|
1074
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_data_field_name #=> String
|
1075
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_title_field_name #=> String
|
1076
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings #=> Array
|
1077
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1078
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].date_field_format #=> String
|
1079
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].index_field_name #=> String
|
1080
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_data_field_name #=> String
|
1081
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_title_field_name #=> String
|
1082
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings #=> Array
|
1083
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].data_source_field_name #=> String
|
1084
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].date_field_format #=> String
|
1085
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].index_field_name #=> String
|
1086
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types #=> Array
|
1087
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types[0] #=> String, one of "ACTIVE_USER", "STANDARD_USER"
|
1088
|
+
# resp.configuration.salesforce_configuration.crawl_attachments #=> Boolean
|
1089
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.document_title_field_name #=> String
|
1090
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings #=> Array
|
1091
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].data_source_field_name #=> String
|
1092
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].date_field_format #=> String
|
1093
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].index_field_name #=> String
|
1094
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns #=> Array
|
1095
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns[0] #=> String
|
1096
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns #=> Array
|
1097
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns[0] #=> String
|
1098
|
+
# resp.configuration.one_drive_configuration.tenant_domain #=> String
|
1099
|
+
# resp.configuration.one_drive_configuration.secret_arn #=> String
|
1100
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list #=> Array
|
1101
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list[0] #=> String
|
1102
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.bucket #=> String
|
1103
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.key #=> String
|
1104
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns #=> Array
|
1105
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns[0] #=> String
|
1106
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns #=> Array
|
1107
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns[0] #=> String
|
1108
|
+
# resp.configuration.one_drive_configuration.field_mappings #=> Array
|
1109
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
1110
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
|
1111
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
|
1112
|
+
# resp.configuration.service_now_configuration.host_url #=> String
|
1113
|
+
# resp.configuration.service_now_configuration.secret_arn #=> String
|
1114
|
+
# resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
|
1115
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.crawl_attachments #=> Boolean
|
1116
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns #=> Array
|
1117
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns[0] #=> String
|
1118
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns #=> Array
|
1119
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns[0] #=> String
|
1120
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_data_field_name #=> String
|
1121
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_title_field_name #=> String
|
1122
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings #=> Array
|
1123
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
|
1124
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
|
1125
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
|
1126
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
|
1127
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
|
1128
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
|
1129
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns #=> Array
|
1130
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns[0] #=> String
|
1131
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_data_field_name #=> String
|
1132
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_title_field_name #=> String
|
1133
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings #=> Array
|
1134
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1135
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1136
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
765
1137
|
# resp.created_at #=> Time
|
766
1138
|
# resp.updated_at #=> Time
|
767
1139
|
# resp.description #=> String
|
@@ -839,6 +1211,7 @@ module Aws::Kendra
|
|
839
1211
|
#
|
840
1212
|
# * {Types::DescribeIndexResponse#name #name} => String
|
841
1213
|
# * {Types::DescribeIndexResponse#id #id} => String
|
1214
|
+
# * {Types::DescribeIndexResponse#edition #edition} => String
|
842
1215
|
# * {Types::DescribeIndexResponse#role_arn #role_arn} => String
|
843
1216
|
# * {Types::DescribeIndexResponse#server_side_encryption_configuration #server_side_encryption_configuration} => Types::ServerSideEncryptionConfiguration
|
844
1217
|
# * {Types::DescribeIndexResponse#status #status} => String
|
@@ -848,6 +1221,7 @@ module Aws::Kendra
|
|
848
1221
|
# * {Types::DescribeIndexResponse#document_metadata_configurations #document_metadata_configurations} => Array<Types::DocumentMetadataConfiguration>
|
849
1222
|
# * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
850
1223
|
# * {Types::DescribeIndexResponse#error_message #error_message} => String
|
1224
|
+
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
851
1225
|
#
|
852
1226
|
# @example Request syntax with placeholder values
|
853
1227
|
#
|
@@ -859,9 +1233,10 @@ module Aws::Kendra
|
|
859
1233
|
#
|
860
1234
|
# resp.name #=> String
|
861
1235
|
# resp.id #=> String
|
1236
|
+
# resp.edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
862
1237
|
# resp.role_arn #=> String
|
863
1238
|
# resp.server_side_encryption_configuration.kms_key_id #=> String
|
864
|
-
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
|
1239
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
865
1240
|
# resp.description #=> String
|
866
1241
|
# resp.created_at #=> Time
|
867
1242
|
# resp.updated_at #=> Time
|
@@ -879,7 +1254,10 @@ module Aws::Kendra
|
|
879
1254
|
# resp.document_metadata_configurations[0].search.displayable #=> Boolean
|
880
1255
|
# resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
|
881
1256
|
# resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
|
1257
|
+
# resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
|
882
1258
|
# resp.error_message #=> String
|
1259
|
+
# resp.capacity_units.storage_capacity_units #=> Integer
|
1260
|
+
# resp.capacity_units.query_capacity_units #=> Integer
|
883
1261
|
#
|
884
1262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
885
1263
|
#
|
@@ -920,6 +1298,8 @@ module Aws::Kendra
|
|
920
1298
|
# * {Types::ListDataSourceSyncJobsResponse#history #history} => Array<Types::DataSourceSyncJob>
|
921
1299
|
# * {Types::ListDataSourceSyncJobsResponse#next_token #next_token} => String
|
922
1300
|
#
|
1301
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1302
|
+
#
|
923
1303
|
# @example Request syntax with placeholder values
|
924
1304
|
#
|
925
1305
|
# resp = client.list_data_source_sync_jobs({
|
@@ -931,7 +1311,7 @@ module Aws::Kendra
|
|
931
1311
|
# start_time: Time.now,
|
932
1312
|
# end_time: Time.now,
|
933
1313
|
# },
|
934
|
-
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
|
1314
|
+
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
|
935
1315
|
# })
|
936
1316
|
#
|
937
1317
|
# @example Response structure
|
@@ -940,10 +1320,15 @@ module Aws::Kendra
|
|
940
1320
|
# resp.history[0].execution_id #=> String
|
941
1321
|
# resp.history[0].start_time #=> Time
|
942
1322
|
# resp.history[0].end_time #=> Time
|
943
|
-
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED"
|
1323
|
+
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"
|
944
1324
|
# resp.history[0].error_message #=> String
|
945
1325
|
# resp.history[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
946
1326
|
# resp.history[0].data_source_error_code #=> String
|
1327
|
+
# resp.history[0].metrics.documents_added #=> String
|
1328
|
+
# resp.history[0].metrics.documents_modified #=> String
|
1329
|
+
# resp.history[0].metrics.documents_deleted #=> String
|
1330
|
+
# resp.history[0].metrics.documents_failed #=> String
|
1331
|
+
# resp.history[0].metrics.documents_scanned #=> String
|
947
1332
|
# resp.next_token #=> String
|
948
1333
|
#
|
949
1334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs AWS API Documentation
|
@@ -974,6 +1359,8 @@ module Aws::Kendra
|
|
974
1359
|
# * {Types::ListDataSourcesResponse#summary_items #summary_items} => Array<Types::DataSourceSummary>
|
975
1360
|
# * {Types::ListDataSourcesResponse#next_token #next_token} => String
|
976
1361
|
#
|
1362
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1363
|
+
#
|
977
1364
|
# @example Request syntax with placeholder values
|
978
1365
|
#
|
979
1366
|
# resp = client.list_data_sources({
|
@@ -987,7 +1374,7 @@ module Aws::Kendra
|
|
987
1374
|
# resp.summary_items #=> Array
|
988
1375
|
# resp.summary_items[0].name #=> String
|
989
1376
|
# resp.summary_items[0].id #=> String
|
990
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1377
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
991
1378
|
# resp.summary_items[0].created_at #=> Time
|
992
1379
|
# resp.summary_items[0].updated_at #=> Time
|
993
1380
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1064,6 +1451,8 @@ module Aws::Kendra
|
|
1064
1451
|
# * {Types::ListIndicesResponse#index_configuration_summary_items #index_configuration_summary_items} => Array<Types::IndexConfigurationSummary>
|
1065
1452
|
# * {Types::ListIndicesResponse#next_token #next_token} => String
|
1066
1453
|
#
|
1454
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1455
|
+
#
|
1067
1456
|
# @example Request syntax with placeholder values
|
1068
1457
|
#
|
1069
1458
|
# resp = client.list_indices({
|
@@ -1076,9 +1465,10 @@ module Aws::Kendra
|
|
1076
1465
|
# resp.index_configuration_summary_items #=> Array
|
1077
1466
|
# resp.index_configuration_summary_items[0].name #=> String
|
1078
1467
|
# resp.index_configuration_summary_items[0].id #=> String
|
1468
|
+
# resp.index_configuration_summary_items[0].edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
1079
1469
|
# resp.index_configuration_summary_items[0].created_at #=> Time
|
1080
1470
|
# resp.index_configuration_summary_items[0].updated_at #=> Time
|
1081
|
-
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
|
1471
|
+
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
1082
1472
|
# resp.next_token #=> String
|
1083
1473
|
#
|
1084
1474
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices AWS API Documentation
|
@@ -1090,6 +1480,38 @@ module Aws::Kendra
|
|
1090
1480
|
req.send_request(options)
|
1091
1481
|
end
|
1092
1482
|
|
1483
|
+
# Gets a list of tags associated with a specified resource. Indexes,
|
1484
|
+
# FAQs, and data sources can have tags associated with them.
|
1485
|
+
#
|
1486
|
+
# @option params [required, String] :resource_arn
|
1487
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1488
|
+
# get a list of tags for.
|
1489
|
+
#
|
1490
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1491
|
+
#
|
1492
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1493
|
+
#
|
1494
|
+
# @example Request syntax with placeholder values
|
1495
|
+
#
|
1496
|
+
# resp = client.list_tags_for_resource({
|
1497
|
+
# resource_arn: "AmazonResourceName", # required
|
1498
|
+
# })
|
1499
|
+
#
|
1500
|
+
# @example Response structure
|
1501
|
+
#
|
1502
|
+
# resp.tags #=> Array
|
1503
|
+
# resp.tags[0].key #=> String
|
1504
|
+
# resp.tags[0].value #=> String
|
1505
|
+
#
|
1506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource AWS API Documentation
|
1507
|
+
#
|
1508
|
+
# @overload list_tags_for_resource(params = {})
|
1509
|
+
# @param [Hash] params ({})
|
1510
|
+
def list_tags_for_resource(params = {}, options = {})
|
1511
|
+
req = build_request(:list_tags_for_resource, params)
|
1512
|
+
req.send_request(options)
|
1513
|
+
end
|
1514
|
+
|
1093
1515
|
# Searches an active index. Use this API to search your documents using
|
1094
1516
|
# query. The `Query` operation enables to do faceted search and to
|
1095
1517
|
# filter results based on document attributes.
|
@@ -1148,7 +1570,8 @@ module Aws::Kendra
|
|
1148
1570
|
#
|
1149
1571
|
# @option params [Integer] :page_size
|
1150
1572
|
# Sets the number of results that are returned in each page of results.
|
1151
|
-
# The default page size is
|
1573
|
+
# The default page size is 10. The maximum number of results returned is
|
1574
|
+
# 100. If you ask for more than 100 results, only 100 are returned.
|
1152
1575
|
#
|
1153
1576
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1154
1577
|
#
|
@@ -1414,6 +1837,69 @@ module Aws::Kendra
|
|
1414
1837
|
req.send_request(options)
|
1415
1838
|
end
|
1416
1839
|
|
1840
|
+
# Adds the specified tag to the specified index, FAQ, or data source
|
1841
|
+
# resource. If the tag already exists, the existing value is replaced
|
1842
|
+
# with the new value.
|
1843
|
+
#
|
1844
|
+
# @option params [required, String] :resource_arn
|
1845
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1846
|
+
# tag.
|
1847
|
+
#
|
1848
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1849
|
+
# A list of tag keys to add to the index, FAQ, or data source. If a tag
|
1850
|
+
# already exists, the existing value is replaced with the new value.
|
1851
|
+
#
|
1852
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1853
|
+
#
|
1854
|
+
# @example Request syntax with placeholder values
|
1855
|
+
#
|
1856
|
+
# resp = client.tag_resource({
|
1857
|
+
# resource_arn: "AmazonResourceName", # required
|
1858
|
+
# tags: [ # required
|
1859
|
+
# {
|
1860
|
+
# key: "TagKey", # required
|
1861
|
+
# value: "TagValue", # required
|
1862
|
+
# },
|
1863
|
+
# ],
|
1864
|
+
# })
|
1865
|
+
#
|
1866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource AWS API Documentation
|
1867
|
+
#
|
1868
|
+
# @overload tag_resource(params = {})
|
1869
|
+
# @param [Hash] params ({})
|
1870
|
+
def tag_resource(params = {}, options = {})
|
1871
|
+
req = build_request(:tag_resource, params)
|
1872
|
+
req.send_request(options)
|
1873
|
+
end
|
1874
|
+
|
1875
|
+
# Removes a tag from an index, FAQ, or a data source.
|
1876
|
+
#
|
1877
|
+
# @option params [required, String] :resource_arn
|
1878
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1879
|
+
# remove the tag from.
|
1880
|
+
#
|
1881
|
+
# @option params [required, Array<String>] :tag_keys
|
1882
|
+
# A list of tag keys to remove from the index, FAQ, or data source. If a
|
1883
|
+
# tag key does not exist on the resource, it is ignored.
|
1884
|
+
#
|
1885
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1886
|
+
#
|
1887
|
+
# @example Request syntax with placeholder values
|
1888
|
+
#
|
1889
|
+
# resp = client.untag_resource({
|
1890
|
+
# resource_arn: "AmazonResourceName", # required
|
1891
|
+
# tag_keys: ["TagKey"], # required
|
1892
|
+
# })
|
1893
|
+
#
|
1894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource AWS API Documentation
|
1895
|
+
#
|
1896
|
+
# @overload untag_resource(params = {})
|
1897
|
+
# @param [Hash] params ({})
|
1898
|
+
def untag_resource(params = {}, options = {})
|
1899
|
+
req = build_request(:untag_resource, params)
|
1900
|
+
req.send_request(options)
|
1901
|
+
end
|
1902
|
+
|
1417
1903
|
# Updates an existing Amazon Kendra data source.
|
1418
1904
|
#
|
1419
1905
|
# @option params [required, String] :id
|
@@ -1465,6 +1951,9 @@ module Aws::Kendra
|
|
1465
1951
|
# urls: ["Url"], # required
|
1466
1952
|
# secret_arn: "SecretArn", # required
|
1467
1953
|
# crawl_attachments: false,
|
1954
|
+
# use_change_log: false,
|
1955
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1956
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1468
1957
|
# vpc_configuration: {
|
1469
1958
|
# subnet_ids: ["SubnetId"], # required
|
1470
1959
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
@@ -1508,6 +1997,130 @@ module Aws::Kendra
|
|
1508
1997
|
# allowed_groups_column_name: "ColumnName", # required
|
1509
1998
|
# },
|
1510
1999
|
# },
|
2000
|
+
# salesforce_configuration: {
|
2001
|
+
# server_url: "Url", # required
|
2002
|
+
# secret_arn: "SecretArn", # required
|
2003
|
+
# standard_object_configurations: [
|
2004
|
+
# {
|
2005
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
2006
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2007
|
+
# document_title_field_name: "DataSourceFieldName",
|
2008
|
+
# field_mappings: [
|
2009
|
+
# {
|
2010
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2011
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2012
|
+
# index_field_name: "IndexFieldName", # required
|
2013
|
+
# },
|
2014
|
+
# ],
|
2015
|
+
# },
|
2016
|
+
# ],
|
2017
|
+
# knowledge_article_configuration: {
|
2018
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
2019
|
+
# standard_knowledge_article_type_configuration: {
|
2020
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2021
|
+
# document_title_field_name: "DataSourceFieldName",
|
2022
|
+
# field_mappings: [
|
2023
|
+
# {
|
2024
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2025
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2026
|
+
# index_field_name: "IndexFieldName", # required
|
2027
|
+
# },
|
2028
|
+
# ],
|
2029
|
+
# },
|
2030
|
+
# custom_knowledge_article_type_configurations: [
|
2031
|
+
# {
|
2032
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
2033
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2034
|
+
# document_title_field_name: "DataSourceFieldName",
|
2035
|
+
# field_mappings: [
|
2036
|
+
# {
|
2037
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2038
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2039
|
+
# index_field_name: "IndexFieldName", # required
|
2040
|
+
# },
|
2041
|
+
# ],
|
2042
|
+
# },
|
2043
|
+
# ],
|
2044
|
+
# },
|
2045
|
+
# chatter_feed_configuration: {
|
2046
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2047
|
+
# document_title_field_name: "DataSourceFieldName",
|
2048
|
+
# field_mappings: [
|
2049
|
+
# {
|
2050
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2051
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2052
|
+
# index_field_name: "IndexFieldName", # required
|
2053
|
+
# },
|
2054
|
+
# ],
|
2055
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
2056
|
+
# },
|
2057
|
+
# crawl_attachments: false,
|
2058
|
+
# standard_object_attachment_configuration: {
|
2059
|
+
# document_title_field_name: "DataSourceFieldName",
|
2060
|
+
# field_mappings: [
|
2061
|
+
# {
|
2062
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2063
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2064
|
+
# index_field_name: "IndexFieldName", # required
|
2065
|
+
# },
|
2066
|
+
# ],
|
2067
|
+
# },
|
2068
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2069
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2070
|
+
# },
|
2071
|
+
# one_drive_configuration: {
|
2072
|
+
# tenant_domain: "TenantDomain", # required
|
2073
|
+
# secret_arn: "SecretArn", # required
|
2074
|
+
# one_drive_users: { # required
|
2075
|
+
# one_drive_user_list: ["OneDriveUser"],
|
2076
|
+
# one_drive_user_s3_path: {
|
2077
|
+
# bucket: "S3BucketName", # required
|
2078
|
+
# key: "S3ObjectKey", # required
|
2079
|
+
# },
|
2080
|
+
# },
|
2081
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2082
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2083
|
+
# field_mappings: [
|
2084
|
+
# {
|
2085
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2086
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2087
|
+
# index_field_name: "IndexFieldName", # required
|
2088
|
+
# },
|
2089
|
+
# ],
|
2090
|
+
# },
|
2091
|
+
# service_now_configuration: {
|
2092
|
+
# host_url: "ServiceNowHostUrl", # required
|
2093
|
+
# secret_arn: "SecretArn", # required
|
2094
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
2095
|
+
# knowledge_article_configuration: {
|
2096
|
+
# crawl_attachments: false,
|
2097
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2098
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2099
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2100
|
+
# document_title_field_name: "DataSourceFieldName",
|
2101
|
+
# field_mappings: [
|
2102
|
+
# {
|
2103
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2104
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2105
|
+
# index_field_name: "IndexFieldName", # required
|
2106
|
+
# },
|
2107
|
+
# ],
|
2108
|
+
# },
|
2109
|
+
# service_catalog_configuration: {
|
2110
|
+
# crawl_attachments: false,
|
2111
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2112
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2113
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2114
|
+
# document_title_field_name: "DataSourceFieldName",
|
2115
|
+
# field_mappings: [
|
2116
|
+
# {
|
2117
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2118
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2119
|
+
# index_field_name: "IndexFieldName", # required
|
2120
|
+
# },
|
2121
|
+
# ],
|
2122
|
+
# },
|
2123
|
+
# },
|
1511
2124
|
# },
|
1512
2125
|
# description: "Description",
|
1513
2126
|
# schedule: "ScanSchedule",
|
@@ -1541,6 +2154,14 @@ module Aws::Kendra
|
|
1541
2154
|
# @option params [Array<Types::DocumentMetadataConfiguration>] :document_metadata_configuration_updates
|
1542
2155
|
# The document metadata to update.
|
1543
2156
|
#
|
2157
|
+
# @option params [Types::CapacityUnitsConfiguration] :capacity_units
|
2158
|
+
# Sets the number of addtional storage and query capacity units that
|
2159
|
+
# should be used by the index. You can change the capacity of the index
|
2160
|
+
# up to 5 times per day.
|
2161
|
+
#
|
2162
|
+
# If you are using extra storage units, you can't reduce the storage
|
2163
|
+
# capacity below that required to meet the storage needs for your index.
|
2164
|
+
#
|
1544
2165
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1545
2166
|
#
|
1546
2167
|
# @example Request syntax with placeholder values
|
@@ -1570,6 +2191,10 @@ module Aws::Kendra
|
|
1570
2191
|
# },
|
1571
2192
|
# },
|
1572
2193
|
# ],
|
2194
|
+
# capacity_units: {
|
2195
|
+
# storage_capacity_units: 1, # required
|
2196
|
+
# query_capacity_units: 1, # required
|
2197
|
+
# },
|
1573
2198
|
# })
|
1574
2199
|
#
|
1575
2200
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
@@ -1594,7 +2219,7 @@ module Aws::Kendra
|
|
1594
2219
|
params: params,
|
1595
2220
|
config: config)
|
1596
2221
|
context[:gem_name] = 'aws-sdk-kendra'
|
1597
|
-
context[:gem_version] = '1.
|
2222
|
+
context[:gem_version] = '1.6.0'
|
1598
2223
|
Seahorse::Client::Request.new(handlers, context)
|
1599
2224
|
end
|
1600
2225
|
|