aws-sdk-kendra 1.2.0 → 1.7.1
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 +1 -1
- data/lib/aws-sdk-kendra/client.rb +607 -31
- data/lib/aws-sdk-kendra/client_api.rb +255 -0
- data/lib/aws-sdk-kendra/resource.rb +1 -7
- data/lib/aws-sdk-kendra/types.rb +1721 -103
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 529b08466475f295428bc9fb53752bc008d538d641b56b97389a3f04cd4d6379
|
4
|
+
data.tar.gz: 2e2926eff5de34b3bff834b0daf77ffac50f083fe14f7a9057d6e7385f253a8c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 942f055cdb21898759db3c7b3a6c16b95c421cc67f7043f27c4543e6fb32c63fb8cd6b65b6a4f4c67032259104cc65fd29a29ec70aa0462db90a7bd89848d69d
|
7
|
+
data.tar.gz: 6cf3f9e590a9f330d5a8c9001ccc94ab51f1de2a0b583910e61d1b30a18e975b7e32d7c658fc34e686ca4147fc713377552490798f62d883b747a26da4bdbcb0
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
30
|
|
@@ -32,11 +33,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:kendra)
|
|
32
33
|
module Aws::Kendra
|
33
34
|
# An API client for Kendra. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
35
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
36
|
+
# client = Aws::Kendra::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
40
41
|
#
|
41
42
|
# For details on configuring region and credentials see
|
42
43
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -69,6 +70,7 @@ module Aws::Kendra
|
|
69
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
75
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
74
76
|
|
@@ -105,7 +107,7 @@ module Aws::Kendra
|
|
105
107
|
# @option options [required, String] :region
|
106
108
|
# The AWS region to connect to. The configured `:region` is
|
107
109
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
109
111
|
#
|
110
112
|
# * `Aws.config[:region]`
|
111
113
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +163,7 @@ module Aws::Kendra
|
|
161
163
|
# @option options [String] :endpoint
|
162
164
|
# The client endpoint is normally constructed from the `:region`
|
163
165
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
167
|
#
|
166
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +178,7 @@ module Aws::Kendra
|
|
176
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
179
|
#
|
178
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
182
|
#
|
181
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
184
|
# The log formatter.
|
@@ -229,15 +231,19 @@ module Aws::Kendra
|
|
229
231
|
#
|
230
232
|
# @option options [String] :retry_mode ("legacy")
|
231
233
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
241
247
|
#
|
242
248
|
# @option options [String] :secret_access_key
|
243
249
|
#
|
@@ -275,8 +281,7 @@ module Aws::Kendra
|
|
275
281
|
#
|
276
282
|
# @option options [Integer] :http_read_timeout (60) The default
|
277
283
|
# number of seconds to wait for response data. This value can
|
278
|
-
# safely be set
|
279
|
-
# per-request on the session yielded by {#session_for}.
|
284
|
+
# safely be set per-request on the session.
|
280
285
|
#
|
281
286
|
# @option options [Float] :http_idle_timeout (5) The number of
|
282
287
|
# seconds a connection is allowed to sit idle before it is
|
@@ -288,7 +293,7 @@ module Aws::Kendra
|
|
288
293
|
# request body. This option has no effect unless the request has
|
289
294
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
290
295
|
# disables this behaviour. This value can safely be set per
|
291
|
-
# request on the session
|
296
|
+
# request on the session.
|
292
297
|
#
|
293
298
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
294
299
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -328,6 +333,9 @@ module Aws::Kendra
|
|
328
333
|
# @option params [required, Array<String>] :document_id_list
|
329
334
|
# One or more identifiers for documents to delete from the index.
|
330
335
|
#
|
336
|
+
# @option params [Types::DataSourceSyncJobMetricTarget] :data_source_sync_job_metric_target
|
337
|
+
# Maps a particular data source sync job to a particular data source.
|
338
|
+
#
|
331
339
|
# @return [Types::BatchDeleteDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
332
340
|
#
|
333
341
|
# * {Types::BatchDeleteDocumentResponse#failed_documents #failed_documents} => Array<Types::BatchDeleteDocumentResponseFailedDocument>
|
@@ -337,6 +345,10 @@ module Aws::Kendra
|
|
337
345
|
# resp = client.batch_delete_document({
|
338
346
|
# index_id: "IndexId", # required
|
339
347
|
# document_id_list: ["DocumentId"], # required
|
348
|
+
# data_source_sync_job_metric_target: {
|
349
|
+
# data_source_id: "DataSourceId", # required
|
350
|
+
# data_source_sync_job_id: "DataSourceSyncJobId", # required
|
351
|
+
# },
|
340
352
|
# })
|
341
353
|
#
|
342
354
|
# @example Response structure
|
@@ -383,8 +395,20 @@ module Aws::Kendra
|
|
383
395
|
# @option params [required, Array<Types::Document>] :documents
|
384
396
|
# One or more documents to add to the index.
|
385
397
|
#
|
386
|
-
#
|
387
|
-
#
|
398
|
+
# Documents have the following file size limits.
|
399
|
+
#
|
400
|
+
# * 5 MB total size for inline documents
|
401
|
+
#
|
402
|
+
# * 50 MB total size for files from an S3 bucket
|
403
|
+
#
|
404
|
+
# * 5 MB extracted text for any file
|
405
|
+
#
|
406
|
+
# For more information about file size and transaction per second
|
407
|
+
# quotas, see [Quotas][1].
|
408
|
+
#
|
409
|
+
#
|
410
|
+
#
|
411
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
388
412
|
#
|
389
413
|
# @return [Types::BatchPutDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
390
414
|
#
|
@@ -489,6 +513,11 @@ module Aws::Kendra
|
|
489
513
|
#
|
490
514
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
491
515
|
#
|
516
|
+
# @option params [Array<Types::Tag>] :tags
|
517
|
+
# A list of key-value pairs that identify the data source. You can use
|
518
|
+
# the tags to identify and organize your resources and to control access
|
519
|
+
# to resources.
|
520
|
+
#
|
492
521
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
493
522
|
#
|
494
523
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -498,7 +527,7 @@ module Aws::Kendra
|
|
498
527
|
# resp = client.create_data_source({
|
499
528
|
# name: "DataSourceName", # required
|
500
529
|
# index_id: "IndexId", # required
|
501
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE
|
530
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
502
531
|
# configuration: { # required
|
503
532
|
# s3_configuration: {
|
504
533
|
# bucket_name: "S3BucketName", # required
|
@@ -516,6 +545,9 @@ module Aws::Kendra
|
|
516
545
|
# urls: ["Url"], # required
|
517
546
|
# secret_arn: "SecretArn", # required
|
518
547
|
# crawl_attachments: false,
|
548
|
+
# use_change_log: false,
|
549
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
550
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
519
551
|
# vpc_configuration: {
|
520
552
|
# subnet_ids: ["SubnetId"], # required
|
521
553
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
@@ -559,10 +591,140 @@ module Aws::Kendra
|
|
559
591
|
# allowed_groups_column_name: "ColumnName", # required
|
560
592
|
# },
|
561
593
|
# },
|
594
|
+
# salesforce_configuration: {
|
595
|
+
# server_url: "Url", # required
|
596
|
+
# secret_arn: "SecretArn", # required
|
597
|
+
# standard_object_configurations: [
|
598
|
+
# {
|
599
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
600
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
601
|
+
# document_title_field_name: "DataSourceFieldName",
|
602
|
+
# field_mappings: [
|
603
|
+
# {
|
604
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
605
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
606
|
+
# index_field_name: "IndexFieldName", # required
|
607
|
+
# },
|
608
|
+
# ],
|
609
|
+
# },
|
610
|
+
# ],
|
611
|
+
# knowledge_article_configuration: {
|
612
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
613
|
+
# standard_knowledge_article_type_configuration: {
|
614
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
615
|
+
# document_title_field_name: "DataSourceFieldName",
|
616
|
+
# field_mappings: [
|
617
|
+
# {
|
618
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
619
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
620
|
+
# index_field_name: "IndexFieldName", # required
|
621
|
+
# },
|
622
|
+
# ],
|
623
|
+
# },
|
624
|
+
# custom_knowledge_article_type_configurations: [
|
625
|
+
# {
|
626
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
627
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
628
|
+
# document_title_field_name: "DataSourceFieldName",
|
629
|
+
# field_mappings: [
|
630
|
+
# {
|
631
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
632
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
633
|
+
# index_field_name: "IndexFieldName", # required
|
634
|
+
# },
|
635
|
+
# ],
|
636
|
+
# },
|
637
|
+
# ],
|
638
|
+
# },
|
639
|
+
# chatter_feed_configuration: {
|
640
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
641
|
+
# document_title_field_name: "DataSourceFieldName",
|
642
|
+
# field_mappings: [
|
643
|
+
# {
|
644
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
645
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
646
|
+
# index_field_name: "IndexFieldName", # required
|
647
|
+
# },
|
648
|
+
# ],
|
649
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
650
|
+
# },
|
651
|
+
# crawl_attachments: false,
|
652
|
+
# standard_object_attachment_configuration: {
|
653
|
+
# document_title_field_name: "DataSourceFieldName",
|
654
|
+
# field_mappings: [
|
655
|
+
# {
|
656
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
657
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
658
|
+
# index_field_name: "IndexFieldName", # required
|
659
|
+
# },
|
660
|
+
# ],
|
661
|
+
# },
|
662
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
663
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
664
|
+
# },
|
665
|
+
# one_drive_configuration: {
|
666
|
+
# tenant_domain: "TenantDomain", # required
|
667
|
+
# secret_arn: "SecretArn", # required
|
668
|
+
# one_drive_users: { # required
|
669
|
+
# one_drive_user_list: ["OneDriveUser"],
|
670
|
+
# one_drive_user_s3_path: {
|
671
|
+
# bucket: "S3BucketName", # required
|
672
|
+
# key: "S3ObjectKey", # required
|
673
|
+
# },
|
674
|
+
# },
|
675
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
676
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
677
|
+
# field_mappings: [
|
678
|
+
# {
|
679
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
680
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
681
|
+
# index_field_name: "IndexFieldName", # required
|
682
|
+
# },
|
683
|
+
# ],
|
684
|
+
# },
|
685
|
+
# service_now_configuration: {
|
686
|
+
# host_url: "ServiceNowHostUrl", # required
|
687
|
+
# secret_arn: "SecretArn", # required
|
688
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
689
|
+
# knowledge_article_configuration: {
|
690
|
+
# crawl_attachments: false,
|
691
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
692
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
693
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
694
|
+
# document_title_field_name: "DataSourceFieldName",
|
695
|
+
# field_mappings: [
|
696
|
+
# {
|
697
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
698
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
699
|
+
# index_field_name: "IndexFieldName", # required
|
700
|
+
# },
|
701
|
+
# ],
|
702
|
+
# },
|
703
|
+
# service_catalog_configuration: {
|
704
|
+
# crawl_attachments: false,
|
705
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
706
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
707
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
708
|
+
# document_title_field_name: "DataSourceFieldName",
|
709
|
+
# field_mappings: [
|
710
|
+
# {
|
711
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
712
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
713
|
+
# index_field_name: "IndexFieldName", # required
|
714
|
+
# },
|
715
|
+
# ],
|
716
|
+
# },
|
717
|
+
# },
|
562
718
|
# },
|
563
719
|
# description: "Description",
|
564
720
|
# schedule: "ScanSchedule",
|
565
721
|
# role_arn: "RoleArn", # required
|
722
|
+
# tags: [
|
723
|
+
# {
|
724
|
+
# key: "TagKey", # required
|
725
|
+
# value: "TagValue", # required
|
726
|
+
# },
|
727
|
+
# ],
|
566
728
|
# })
|
567
729
|
#
|
568
730
|
# @example Response structure
|
@@ -602,6 +764,11 @@ module Aws::Kendra
|
|
602
764
|
#
|
603
765
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
604
766
|
#
|
767
|
+
# @option params [Array<Types::Tag>] :tags
|
768
|
+
# A list of key-value pairs that identify the FAQ. You can use the tags
|
769
|
+
# to identify and organize your resources and to control access to
|
770
|
+
# resources.
|
771
|
+
#
|
605
772
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
606
773
|
#
|
607
774
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -617,6 +784,12 @@ module Aws::Kendra
|
|
617
784
|
# key: "S3ObjectKey", # required
|
618
785
|
# },
|
619
786
|
# role_arn: "RoleArn", # required
|
787
|
+
# tags: [
|
788
|
+
# {
|
789
|
+
# key: "TagKey", # required
|
790
|
+
# value: "TagValue", # required
|
791
|
+
# },
|
792
|
+
# ],
|
620
793
|
# })
|
621
794
|
#
|
622
795
|
# @example Response structure
|
@@ -643,6 +816,13 @@ module Aws::Kendra
|
|
643
816
|
# @option params [required, String] :name
|
644
817
|
# The name for the new index.
|
645
818
|
#
|
819
|
+
# @option params [String] :edition
|
820
|
+
# The Amazon Kendra edition to use for the index. Choose
|
821
|
+
# `DEVELOPER_EDITION` for indexes intended for development, testing, or
|
822
|
+
# proof of concept. Use `ENTERPRISE_EDITION` for your production
|
823
|
+
# databases. Once you set the edition for an index, it can't be
|
824
|
+
# changed.
|
825
|
+
#
|
646
826
|
# @option params [required, String] :role_arn
|
647
827
|
# An IAM role that gives Amazon Kendra permissions to access your Amazon
|
648
828
|
# CloudWatch logs and metrics. This is also the role used when you use
|
@@ -657,6 +837,19 @@ module Aws::Kendra
|
|
657
837
|
# @option params [String] :description
|
658
838
|
# A description for the index.
|
659
839
|
#
|
840
|
+
# @option params [String] :client_token
|
841
|
+
# A token that you provide to identify the request to create an index.
|
842
|
+
# Multiple calls to the `CreateIndex` operation with the same client
|
843
|
+
# token will create only one index.”
|
844
|
+
#
|
845
|
+
# **A suitable default value is auto-generated.** You should normally
|
846
|
+
# not need to pass this option.**
|
847
|
+
#
|
848
|
+
# @option params [Array<Types::Tag>] :tags
|
849
|
+
# A list of key-value pairs that identify the index. You can use the
|
850
|
+
# tags to identify and organize your resources and to control access to
|
851
|
+
# resources.
|
852
|
+
#
|
660
853
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
661
854
|
#
|
662
855
|
# * {Types::CreateIndexResponse#id #id} => String
|
@@ -665,11 +858,19 @@ module Aws::Kendra
|
|
665
858
|
#
|
666
859
|
# resp = client.create_index({
|
667
860
|
# name: "IndexName", # required
|
861
|
+
# edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
|
668
862
|
# role_arn: "RoleArn", # required
|
669
863
|
# server_side_encryption_configuration: {
|
670
864
|
# kms_key_id: "KmsKeyId",
|
671
865
|
# },
|
672
866
|
# description: "Description",
|
867
|
+
# client_token: "ClientTokenName",
|
868
|
+
# tags: [
|
869
|
+
# {
|
870
|
+
# key: "TagKey", # required
|
871
|
+
# value: "TagValue", # required
|
872
|
+
# },
|
873
|
+
# ],
|
673
874
|
# })
|
674
875
|
#
|
675
876
|
# @example Response structure
|
@@ -685,6 +886,40 @@ module Aws::Kendra
|
|
685
886
|
req.send_request(options)
|
686
887
|
end
|
687
888
|
|
889
|
+
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
890
|
+
# the data source is already being deleted. While the data source is
|
891
|
+
# being deleted, the `Status` field returned by a call to the operation
|
892
|
+
# is set to `DELETING`. For more information, see [Deleting Data
|
893
|
+
# Sources][1].
|
894
|
+
#
|
895
|
+
#
|
896
|
+
#
|
897
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
|
898
|
+
#
|
899
|
+
# @option params [required, String] :id
|
900
|
+
# The unique identifier of the data source to delete.
|
901
|
+
#
|
902
|
+
# @option params [required, String] :index_id
|
903
|
+
# The unique identifier of the index associated with the data source.
|
904
|
+
#
|
905
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
906
|
+
#
|
907
|
+
# @example Request syntax with placeholder values
|
908
|
+
#
|
909
|
+
# resp = client.delete_data_source({
|
910
|
+
# id: "DataSourceId", # required
|
911
|
+
# index_id: "IndexId", # required
|
912
|
+
# })
|
913
|
+
#
|
914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource AWS API Documentation
|
915
|
+
#
|
916
|
+
# @overload delete_data_source(params = {})
|
917
|
+
# @param [Hash] params ({})
|
918
|
+
def delete_data_source(params = {}, options = {})
|
919
|
+
req = build_request(:delete_data_source, params)
|
920
|
+
req.send_request(options)
|
921
|
+
end
|
922
|
+
|
688
923
|
# Removes an FAQ from an index.
|
689
924
|
#
|
690
925
|
# @option params [required, String] :id
|
@@ -771,7 +1006,7 @@ module Aws::Kendra
|
|
771
1006
|
# resp.id #=> String
|
772
1007
|
# resp.index_id #=> String
|
773
1008
|
# resp.name #=> String
|
774
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1009
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
775
1010
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
776
1011
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
777
1012
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -784,6 +1019,11 @@ module Aws::Kendra
|
|
784
1019
|
# resp.configuration.share_point_configuration.urls[0] #=> String
|
785
1020
|
# resp.configuration.share_point_configuration.secret_arn #=> String
|
786
1021
|
# resp.configuration.share_point_configuration.crawl_attachments #=> Boolean
|
1022
|
+
# resp.configuration.share_point_configuration.use_change_log #=> Boolean
|
1023
|
+
# resp.configuration.share_point_configuration.inclusion_patterns #=> Array
|
1024
|
+
# resp.configuration.share_point_configuration.inclusion_patterns[0] #=> String
|
1025
|
+
# resp.configuration.share_point_configuration.exclusion_patterns #=> Array
|
1026
|
+
# resp.configuration.share_point_configuration.exclusion_patterns[0] #=> String
|
787
1027
|
# resp.configuration.share_point_configuration.vpc_configuration.subnet_ids #=> Array
|
788
1028
|
# resp.configuration.share_point_configuration.vpc_configuration.subnet_ids[0] #=> String
|
789
1029
|
# resp.configuration.share_point_configuration.vpc_configuration.security_group_ids #=> Array
|
@@ -813,6 +1053,89 @@ module Aws::Kendra
|
|
813
1053
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
|
814
1054
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
|
815
1055
|
# resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
|
1056
|
+
# resp.configuration.salesforce_configuration.server_url #=> String
|
1057
|
+
# resp.configuration.salesforce_configuration.secret_arn #=> String
|
1058
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
|
1059
|
+
# 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"
|
1060
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_data_field_name #=> String
|
1061
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_title_field_name #=> String
|
1062
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings #=> Array
|
1063
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1064
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].date_field_format #=> String
|
1065
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].index_field_name #=> String
|
1066
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states #=> Array
|
1067
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states[0] #=> String, one of "DRAFT", "PUBLISHED", "ARCHIVED"
|
1068
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_data_field_name #=> String
|
1069
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_title_field_name #=> String
|
1070
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings #=> Array
|
1071
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].data_source_field_name #=> String
|
1072
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].date_field_format #=> String
|
1073
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].index_field_name #=> String
|
1074
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations #=> Array
|
1075
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].name #=> String
|
1076
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_data_field_name #=> String
|
1077
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_title_field_name #=> String
|
1078
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings #=> Array
|
1079
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1080
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].date_field_format #=> String
|
1081
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].index_field_name #=> String
|
1082
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_data_field_name #=> String
|
1083
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_title_field_name #=> String
|
1084
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings #=> Array
|
1085
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].data_source_field_name #=> String
|
1086
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].date_field_format #=> String
|
1087
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].index_field_name #=> String
|
1088
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types #=> Array
|
1089
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types[0] #=> String, one of "ACTIVE_USER", "STANDARD_USER"
|
1090
|
+
# resp.configuration.salesforce_configuration.crawl_attachments #=> Boolean
|
1091
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.document_title_field_name #=> String
|
1092
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings #=> Array
|
1093
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].data_source_field_name #=> String
|
1094
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].date_field_format #=> String
|
1095
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].index_field_name #=> String
|
1096
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns #=> Array
|
1097
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns[0] #=> String
|
1098
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns #=> Array
|
1099
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns[0] #=> String
|
1100
|
+
# resp.configuration.one_drive_configuration.tenant_domain #=> String
|
1101
|
+
# resp.configuration.one_drive_configuration.secret_arn #=> String
|
1102
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list #=> Array
|
1103
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list[0] #=> String
|
1104
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.bucket #=> String
|
1105
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.key #=> String
|
1106
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns #=> Array
|
1107
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns[0] #=> String
|
1108
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns #=> Array
|
1109
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns[0] #=> String
|
1110
|
+
# resp.configuration.one_drive_configuration.field_mappings #=> Array
|
1111
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
1112
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
|
1113
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
|
1114
|
+
# resp.configuration.service_now_configuration.host_url #=> String
|
1115
|
+
# resp.configuration.service_now_configuration.secret_arn #=> String
|
1116
|
+
# resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
|
1117
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.crawl_attachments #=> Boolean
|
1118
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns #=> Array
|
1119
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns[0] #=> String
|
1120
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns #=> Array
|
1121
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns[0] #=> String
|
1122
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_data_field_name #=> String
|
1123
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_title_field_name #=> String
|
1124
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings #=> Array
|
1125
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
|
1126
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
|
1127
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
|
1128
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
|
1129
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
|
1130
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
|
1131
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns #=> Array
|
1132
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns[0] #=> String
|
1133
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_data_field_name #=> String
|
1134
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_title_field_name #=> String
|
1135
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings #=> Array
|
1136
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1137
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1138
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
816
1139
|
# resp.created_at #=> Time
|
817
1140
|
# resp.updated_at #=> Time
|
818
1141
|
# resp.description #=> String
|
@@ -890,6 +1213,7 @@ module Aws::Kendra
|
|
890
1213
|
#
|
891
1214
|
# * {Types::DescribeIndexResponse#name #name} => String
|
892
1215
|
# * {Types::DescribeIndexResponse#id #id} => String
|
1216
|
+
# * {Types::DescribeIndexResponse#edition #edition} => String
|
893
1217
|
# * {Types::DescribeIndexResponse#role_arn #role_arn} => String
|
894
1218
|
# * {Types::DescribeIndexResponse#server_side_encryption_configuration #server_side_encryption_configuration} => Types::ServerSideEncryptionConfiguration
|
895
1219
|
# * {Types::DescribeIndexResponse#status #status} => String
|
@@ -899,6 +1223,7 @@ module Aws::Kendra
|
|
899
1223
|
# * {Types::DescribeIndexResponse#document_metadata_configurations #document_metadata_configurations} => Array<Types::DocumentMetadataConfiguration>
|
900
1224
|
# * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
901
1225
|
# * {Types::DescribeIndexResponse#error_message #error_message} => String
|
1226
|
+
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
902
1227
|
#
|
903
1228
|
# @example Request syntax with placeholder values
|
904
1229
|
#
|
@@ -910,9 +1235,10 @@ module Aws::Kendra
|
|
910
1235
|
#
|
911
1236
|
# resp.name #=> String
|
912
1237
|
# resp.id #=> String
|
1238
|
+
# resp.edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
913
1239
|
# resp.role_arn #=> String
|
914
1240
|
# resp.server_side_encryption_configuration.kms_key_id #=> String
|
915
|
-
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
|
1241
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
916
1242
|
# resp.description #=> String
|
917
1243
|
# resp.created_at #=> Time
|
918
1244
|
# resp.updated_at #=> Time
|
@@ -930,7 +1256,10 @@ module Aws::Kendra
|
|
930
1256
|
# resp.document_metadata_configurations[0].search.displayable #=> Boolean
|
931
1257
|
# resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
|
932
1258
|
# resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
|
1259
|
+
# resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
|
933
1260
|
# resp.error_message #=> String
|
1261
|
+
# resp.capacity_units.storage_capacity_units #=> Integer
|
1262
|
+
# resp.capacity_units.query_capacity_units #=> Integer
|
934
1263
|
#
|
935
1264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
936
1265
|
#
|
@@ -971,6 +1300,8 @@ module Aws::Kendra
|
|
971
1300
|
# * {Types::ListDataSourceSyncJobsResponse#history #history} => Array<Types::DataSourceSyncJob>
|
972
1301
|
# * {Types::ListDataSourceSyncJobsResponse#next_token #next_token} => String
|
973
1302
|
#
|
1303
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1304
|
+
#
|
974
1305
|
# @example Request syntax with placeholder values
|
975
1306
|
#
|
976
1307
|
# resp = client.list_data_source_sync_jobs({
|
@@ -982,7 +1313,7 @@ module Aws::Kendra
|
|
982
1313
|
# start_time: Time.now,
|
983
1314
|
# end_time: Time.now,
|
984
1315
|
# },
|
985
|
-
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
|
1316
|
+
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
|
986
1317
|
# })
|
987
1318
|
#
|
988
1319
|
# @example Response structure
|
@@ -991,10 +1322,15 @@ module Aws::Kendra
|
|
991
1322
|
# resp.history[0].execution_id #=> String
|
992
1323
|
# resp.history[0].start_time #=> Time
|
993
1324
|
# resp.history[0].end_time #=> Time
|
994
|
-
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED"
|
1325
|
+
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"
|
995
1326
|
# resp.history[0].error_message #=> String
|
996
1327
|
# resp.history[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
997
1328
|
# resp.history[0].data_source_error_code #=> String
|
1329
|
+
# resp.history[0].metrics.documents_added #=> String
|
1330
|
+
# resp.history[0].metrics.documents_modified #=> String
|
1331
|
+
# resp.history[0].metrics.documents_deleted #=> String
|
1332
|
+
# resp.history[0].metrics.documents_failed #=> String
|
1333
|
+
# resp.history[0].metrics.documents_scanned #=> String
|
998
1334
|
# resp.next_token #=> String
|
999
1335
|
#
|
1000
1336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs AWS API Documentation
|
@@ -1025,6 +1361,8 @@ module Aws::Kendra
|
|
1025
1361
|
# * {Types::ListDataSourcesResponse#summary_items #summary_items} => Array<Types::DataSourceSummary>
|
1026
1362
|
# * {Types::ListDataSourcesResponse#next_token #next_token} => String
|
1027
1363
|
#
|
1364
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1365
|
+
#
|
1028
1366
|
# @example Request syntax with placeholder values
|
1029
1367
|
#
|
1030
1368
|
# resp = client.list_data_sources({
|
@@ -1038,7 +1376,7 @@ module Aws::Kendra
|
|
1038
1376
|
# resp.summary_items #=> Array
|
1039
1377
|
# resp.summary_items[0].name #=> String
|
1040
1378
|
# resp.summary_items[0].id #=> String
|
1041
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1379
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1042
1380
|
# resp.summary_items[0].created_at #=> Time
|
1043
1381
|
# resp.summary_items[0].updated_at #=> Time
|
1044
1382
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1115,6 +1453,8 @@ module Aws::Kendra
|
|
1115
1453
|
# * {Types::ListIndicesResponse#index_configuration_summary_items #index_configuration_summary_items} => Array<Types::IndexConfigurationSummary>
|
1116
1454
|
# * {Types::ListIndicesResponse#next_token #next_token} => String
|
1117
1455
|
#
|
1456
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1457
|
+
#
|
1118
1458
|
# @example Request syntax with placeholder values
|
1119
1459
|
#
|
1120
1460
|
# resp = client.list_indices({
|
@@ -1127,9 +1467,10 @@ module Aws::Kendra
|
|
1127
1467
|
# resp.index_configuration_summary_items #=> Array
|
1128
1468
|
# resp.index_configuration_summary_items[0].name #=> String
|
1129
1469
|
# resp.index_configuration_summary_items[0].id #=> String
|
1470
|
+
# resp.index_configuration_summary_items[0].edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
1130
1471
|
# resp.index_configuration_summary_items[0].created_at #=> Time
|
1131
1472
|
# resp.index_configuration_summary_items[0].updated_at #=> Time
|
1132
|
-
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
|
1473
|
+
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
1133
1474
|
# resp.next_token #=> String
|
1134
1475
|
#
|
1135
1476
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices AWS API Documentation
|
@@ -1141,6 +1482,38 @@ module Aws::Kendra
|
|
1141
1482
|
req.send_request(options)
|
1142
1483
|
end
|
1143
1484
|
|
1485
|
+
# Gets a list of tags associated with a specified resource. Indexes,
|
1486
|
+
# FAQs, and data sources can have tags associated with them.
|
1487
|
+
#
|
1488
|
+
# @option params [required, String] :resource_arn
|
1489
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1490
|
+
# get a list of tags for.
|
1491
|
+
#
|
1492
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1493
|
+
#
|
1494
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1495
|
+
#
|
1496
|
+
# @example Request syntax with placeholder values
|
1497
|
+
#
|
1498
|
+
# resp = client.list_tags_for_resource({
|
1499
|
+
# resource_arn: "AmazonResourceName", # required
|
1500
|
+
# })
|
1501
|
+
#
|
1502
|
+
# @example Response structure
|
1503
|
+
#
|
1504
|
+
# resp.tags #=> Array
|
1505
|
+
# resp.tags[0].key #=> String
|
1506
|
+
# resp.tags[0].value #=> String
|
1507
|
+
#
|
1508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource AWS API Documentation
|
1509
|
+
#
|
1510
|
+
# @overload list_tags_for_resource(params = {})
|
1511
|
+
# @param [Hash] params ({})
|
1512
|
+
def list_tags_for_resource(params = {}, options = {})
|
1513
|
+
req = build_request(:list_tags_for_resource, params)
|
1514
|
+
req.send_request(options)
|
1515
|
+
end
|
1516
|
+
|
1144
1517
|
# Searches an active index. Use this API to search your documents using
|
1145
1518
|
# query. The `Query` operation enables to do faceted search and to
|
1146
1519
|
# filter results based on document attributes.
|
@@ -1199,7 +1572,8 @@ module Aws::Kendra
|
|
1199
1572
|
#
|
1200
1573
|
# @option params [Integer] :page_size
|
1201
1574
|
# Sets the number of results that are returned in each page of results.
|
1202
|
-
# The default page size is
|
1575
|
+
# The default page size is 10. The maximum number of results returned is
|
1576
|
+
# 100. If you ask for more than 100 results, only 100 are returned.
|
1203
1577
|
#
|
1204
1578
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1205
1579
|
#
|
@@ -1465,6 +1839,69 @@ module Aws::Kendra
|
|
1465
1839
|
req.send_request(options)
|
1466
1840
|
end
|
1467
1841
|
|
1842
|
+
# Adds the specified tag to the specified index, FAQ, or data source
|
1843
|
+
# resource. If the tag already exists, the existing value is replaced
|
1844
|
+
# with the new value.
|
1845
|
+
#
|
1846
|
+
# @option params [required, String] :resource_arn
|
1847
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1848
|
+
# tag.
|
1849
|
+
#
|
1850
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1851
|
+
# A list of tag keys to add to the index, FAQ, or data source. If a tag
|
1852
|
+
# already exists, the existing value is replaced with the new value.
|
1853
|
+
#
|
1854
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1855
|
+
#
|
1856
|
+
# @example Request syntax with placeholder values
|
1857
|
+
#
|
1858
|
+
# resp = client.tag_resource({
|
1859
|
+
# resource_arn: "AmazonResourceName", # required
|
1860
|
+
# tags: [ # required
|
1861
|
+
# {
|
1862
|
+
# key: "TagKey", # required
|
1863
|
+
# value: "TagValue", # required
|
1864
|
+
# },
|
1865
|
+
# ],
|
1866
|
+
# })
|
1867
|
+
#
|
1868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource AWS API Documentation
|
1869
|
+
#
|
1870
|
+
# @overload tag_resource(params = {})
|
1871
|
+
# @param [Hash] params ({})
|
1872
|
+
def tag_resource(params = {}, options = {})
|
1873
|
+
req = build_request(:tag_resource, params)
|
1874
|
+
req.send_request(options)
|
1875
|
+
end
|
1876
|
+
|
1877
|
+
# Removes a tag from an index, FAQ, or a data source.
|
1878
|
+
#
|
1879
|
+
# @option params [required, String] :resource_arn
|
1880
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1881
|
+
# remove the tag from.
|
1882
|
+
#
|
1883
|
+
# @option params [required, Array<String>] :tag_keys
|
1884
|
+
# A list of tag keys to remove from the index, FAQ, or data source. If a
|
1885
|
+
# tag key does not exist on the resource, it is ignored.
|
1886
|
+
#
|
1887
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1888
|
+
#
|
1889
|
+
# @example Request syntax with placeholder values
|
1890
|
+
#
|
1891
|
+
# resp = client.untag_resource({
|
1892
|
+
# resource_arn: "AmazonResourceName", # required
|
1893
|
+
# tag_keys: ["TagKey"], # required
|
1894
|
+
# })
|
1895
|
+
#
|
1896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource AWS API Documentation
|
1897
|
+
#
|
1898
|
+
# @overload untag_resource(params = {})
|
1899
|
+
# @param [Hash] params ({})
|
1900
|
+
def untag_resource(params = {}, options = {})
|
1901
|
+
req = build_request(:untag_resource, params)
|
1902
|
+
req.send_request(options)
|
1903
|
+
end
|
1904
|
+
|
1468
1905
|
# Updates an existing Amazon Kendra data source.
|
1469
1906
|
#
|
1470
1907
|
# @option params [required, String] :id
|
@@ -1516,6 +1953,9 @@ module Aws::Kendra
|
|
1516
1953
|
# urls: ["Url"], # required
|
1517
1954
|
# secret_arn: "SecretArn", # required
|
1518
1955
|
# crawl_attachments: false,
|
1956
|
+
# use_change_log: false,
|
1957
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1958
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1519
1959
|
# vpc_configuration: {
|
1520
1960
|
# subnet_ids: ["SubnetId"], # required
|
1521
1961
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
@@ -1559,6 +1999,130 @@ module Aws::Kendra
|
|
1559
1999
|
# allowed_groups_column_name: "ColumnName", # required
|
1560
2000
|
# },
|
1561
2001
|
# },
|
2002
|
+
# salesforce_configuration: {
|
2003
|
+
# server_url: "Url", # required
|
2004
|
+
# secret_arn: "SecretArn", # required
|
2005
|
+
# standard_object_configurations: [
|
2006
|
+
# {
|
2007
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
2008
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2009
|
+
# document_title_field_name: "DataSourceFieldName",
|
2010
|
+
# field_mappings: [
|
2011
|
+
# {
|
2012
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2013
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2014
|
+
# index_field_name: "IndexFieldName", # required
|
2015
|
+
# },
|
2016
|
+
# ],
|
2017
|
+
# },
|
2018
|
+
# ],
|
2019
|
+
# knowledge_article_configuration: {
|
2020
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
2021
|
+
# standard_knowledge_article_type_configuration: {
|
2022
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2023
|
+
# document_title_field_name: "DataSourceFieldName",
|
2024
|
+
# field_mappings: [
|
2025
|
+
# {
|
2026
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2027
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2028
|
+
# index_field_name: "IndexFieldName", # required
|
2029
|
+
# },
|
2030
|
+
# ],
|
2031
|
+
# },
|
2032
|
+
# custom_knowledge_article_type_configurations: [
|
2033
|
+
# {
|
2034
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
2035
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2036
|
+
# document_title_field_name: "DataSourceFieldName",
|
2037
|
+
# field_mappings: [
|
2038
|
+
# {
|
2039
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2040
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2041
|
+
# index_field_name: "IndexFieldName", # required
|
2042
|
+
# },
|
2043
|
+
# ],
|
2044
|
+
# },
|
2045
|
+
# ],
|
2046
|
+
# },
|
2047
|
+
# chatter_feed_configuration: {
|
2048
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2049
|
+
# document_title_field_name: "DataSourceFieldName",
|
2050
|
+
# field_mappings: [
|
2051
|
+
# {
|
2052
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2053
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2054
|
+
# index_field_name: "IndexFieldName", # required
|
2055
|
+
# },
|
2056
|
+
# ],
|
2057
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
2058
|
+
# },
|
2059
|
+
# crawl_attachments: false,
|
2060
|
+
# standard_object_attachment_configuration: {
|
2061
|
+
# document_title_field_name: "DataSourceFieldName",
|
2062
|
+
# field_mappings: [
|
2063
|
+
# {
|
2064
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2065
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2066
|
+
# index_field_name: "IndexFieldName", # required
|
2067
|
+
# },
|
2068
|
+
# ],
|
2069
|
+
# },
|
2070
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2071
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2072
|
+
# },
|
2073
|
+
# one_drive_configuration: {
|
2074
|
+
# tenant_domain: "TenantDomain", # required
|
2075
|
+
# secret_arn: "SecretArn", # required
|
2076
|
+
# one_drive_users: { # required
|
2077
|
+
# one_drive_user_list: ["OneDriveUser"],
|
2078
|
+
# one_drive_user_s3_path: {
|
2079
|
+
# bucket: "S3BucketName", # required
|
2080
|
+
# key: "S3ObjectKey", # required
|
2081
|
+
# },
|
2082
|
+
# },
|
2083
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2084
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2085
|
+
# field_mappings: [
|
2086
|
+
# {
|
2087
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2088
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2089
|
+
# index_field_name: "IndexFieldName", # required
|
2090
|
+
# },
|
2091
|
+
# ],
|
2092
|
+
# },
|
2093
|
+
# service_now_configuration: {
|
2094
|
+
# host_url: "ServiceNowHostUrl", # required
|
2095
|
+
# secret_arn: "SecretArn", # required
|
2096
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
2097
|
+
# knowledge_article_configuration: {
|
2098
|
+
# crawl_attachments: false,
|
2099
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2100
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2101
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2102
|
+
# document_title_field_name: "DataSourceFieldName",
|
2103
|
+
# field_mappings: [
|
2104
|
+
# {
|
2105
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2106
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2107
|
+
# index_field_name: "IndexFieldName", # required
|
2108
|
+
# },
|
2109
|
+
# ],
|
2110
|
+
# },
|
2111
|
+
# service_catalog_configuration: {
|
2112
|
+
# crawl_attachments: false,
|
2113
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2114
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2115
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2116
|
+
# document_title_field_name: "DataSourceFieldName",
|
2117
|
+
# field_mappings: [
|
2118
|
+
# {
|
2119
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2120
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2121
|
+
# index_field_name: "IndexFieldName", # required
|
2122
|
+
# },
|
2123
|
+
# ],
|
2124
|
+
# },
|
2125
|
+
# },
|
1562
2126
|
# },
|
1563
2127
|
# description: "Description",
|
1564
2128
|
# schedule: "ScanSchedule",
|
@@ -1592,6 +2156,14 @@ module Aws::Kendra
|
|
1592
2156
|
# @option params [Array<Types::DocumentMetadataConfiguration>] :document_metadata_configuration_updates
|
1593
2157
|
# The document metadata to update.
|
1594
2158
|
#
|
2159
|
+
# @option params [Types::CapacityUnitsConfiguration] :capacity_units
|
2160
|
+
# Sets the number of addtional storage and query capacity units that
|
2161
|
+
# should be used by the index. You can change the capacity of the index
|
2162
|
+
# up to 5 times per day.
|
2163
|
+
#
|
2164
|
+
# If you are using extra storage units, you can't reduce the storage
|
2165
|
+
# capacity below that required to meet the storage needs for your index.
|
2166
|
+
#
|
1595
2167
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1596
2168
|
#
|
1597
2169
|
# @example Request syntax with placeholder values
|
@@ -1621,6 +2193,10 @@ module Aws::Kendra
|
|
1621
2193
|
# },
|
1622
2194
|
# },
|
1623
2195
|
# ],
|
2196
|
+
# capacity_units: {
|
2197
|
+
# storage_capacity_units: 1, # required
|
2198
|
+
# query_capacity_units: 1, # required
|
2199
|
+
# },
|
1624
2200
|
# })
|
1625
2201
|
#
|
1626
2202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
@@ -1645,7 +2221,7 @@ module Aws::Kendra
|
|
1645
2221
|
params: params,
|
1646
2222
|
config: config)
|
1647
2223
|
context[:gem_name] = 'aws-sdk-kendra'
|
1648
|
-
context[:gem_version] = '1.
|
2224
|
+
context[:gem_version] = '1.7.1'
|
1649
2225
|
Seahorse::Client::Request.new(handlers, context)
|
1650
2226
|
end
|
1651
2227
|
|