aws-sdk-kendra 1.3.0 → 1.8.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 +3 -1
- data/lib/aws-sdk-kendra/client.rb +563 -14
- data/lib/aws-sdk-kendra/client_api.rb +251 -0
- data/lib/aws-sdk-kendra/errors.rb +2 -0
- data/lib/aws-sdk-kendra/resource.rb +2 -0
- data/lib/aws-sdk-kendra/types.rb +1705 -49
- 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: 85405515fd60d8582ec6e77da776ad2f56d5b4d61c70f0e21a147b280485c7de
|
4
|
+
data.tar.gz: f368c2afdbf681b8a342c50282249794e223b810463742c7d94b2f5659a05d4d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f60098a6ae9b6e4543fd03c8a9fb32b6e3931a74ba0d319fd927c5ce9732667575351353f307cd3b777821db85feedc99218157b1df2b5433ccdd020a5d01e16
|
7
|
+
data.tar.gz: 5ab1998965d531150fe2915d8c8042d6d80c05b181b26c77191b1d9969d3c014aecb1a5a1e003fda16284cbf74f09bebc415b0ea9289348e331d4d7b6c2f3bdd
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-kendra/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::Kendra
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.8.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
32
|
|
@@ -69,6 +72,7 @@ module Aws::Kendra
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
74
78
|
|
@@ -105,7 +109,7 @@ module Aws::Kendra
|
|
105
109
|
# @option options [required, String] :region
|
106
110
|
# The AWS region to connect to. The configured `:region` is
|
107
111
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
112
|
+
# a default `:region` is searched for in the following locations:
|
109
113
|
#
|
110
114
|
# * `Aws.config[:region]`
|
111
115
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +165,7 @@ module Aws::Kendra
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::Kendra
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -331,6 +335,9 @@ module Aws::Kendra
|
|
331
335
|
# @option params [required, Array<String>] :document_id_list
|
332
336
|
# One or more identifiers for documents to delete from the index.
|
333
337
|
#
|
338
|
+
# @option params [Types::DataSourceSyncJobMetricTarget] :data_source_sync_job_metric_target
|
339
|
+
# Maps a particular data source sync job to a particular data source.
|
340
|
+
#
|
334
341
|
# @return [Types::BatchDeleteDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
335
342
|
#
|
336
343
|
# * {Types::BatchDeleteDocumentResponse#failed_documents #failed_documents} => Array<Types::BatchDeleteDocumentResponseFailedDocument>
|
@@ -340,6 +347,10 @@ module Aws::Kendra
|
|
340
347
|
# resp = client.batch_delete_document({
|
341
348
|
# index_id: "IndexId", # required
|
342
349
|
# document_id_list: ["DocumentId"], # required
|
350
|
+
# data_source_sync_job_metric_target: {
|
351
|
+
# data_source_id: "DataSourceId", # required
|
352
|
+
# data_source_sync_job_id: "DataSourceSyncJobId", # required
|
353
|
+
# },
|
343
354
|
# })
|
344
355
|
#
|
345
356
|
# @example Response structure
|
@@ -386,8 +397,20 @@ module Aws::Kendra
|
|
386
397
|
# @option params [required, Array<Types::Document>] :documents
|
387
398
|
# One or more documents to add to the index.
|
388
399
|
#
|
389
|
-
#
|
390
|
-
#
|
400
|
+
# Documents have the following file size limits.
|
401
|
+
#
|
402
|
+
# * 5 MB total size for inline documents
|
403
|
+
#
|
404
|
+
# * 50 MB total size for files from an S3 bucket
|
405
|
+
#
|
406
|
+
# * 5 MB extracted text for any file
|
407
|
+
#
|
408
|
+
# For more information about file size and transaction per second
|
409
|
+
# quotas, see [Quotas][1].
|
410
|
+
#
|
411
|
+
#
|
412
|
+
#
|
413
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
391
414
|
#
|
392
415
|
# @return [Types::BatchPutDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
393
416
|
#
|
@@ -492,6 +515,11 @@ module Aws::Kendra
|
|
492
515
|
#
|
493
516
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
494
517
|
#
|
518
|
+
# @option params [Array<Types::Tag>] :tags
|
519
|
+
# A list of key-value pairs that identify the data source. You can use
|
520
|
+
# the tags to identify and organize your resources and to control access
|
521
|
+
# to resources.
|
522
|
+
#
|
495
523
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
496
524
|
#
|
497
525
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -501,7 +529,7 @@ module Aws::Kendra
|
|
501
529
|
# resp = client.create_data_source({
|
502
530
|
# name: "DataSourceName", # required
|
503
531
|
# index_id: "IndexId", # required
|
504
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE
|
532
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
505
533
|
# configuration: { # required
|
506
534
|
# s3_configuration: {
|
507
535
|
# bucket_name: "S3BucketName", # required
|
@@ -565,10 +593,140 @@ module Aws::Kendra
|
|
565
593
|
# allowed_groups_column_name: "ColumnName", # required
|
566
594
|
# },
|
567
595
|
# },
|
596
|
+
# salesforce_configuration: {
|
597
|
+
# server_url: "Url", # required
|
598
|
+
# secret_arn: "SecretArn", # required
|
599
|
+
# standard_object_configurations: [
|
600
|
+
# {
|
601
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
602
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
603
|
+
# document_title_field_name: "DataSourceFieldName",
|
604
|
+
# field_mappings: [
|
605
|
+
# {
|
606
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
607
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
608
|
+
# index_field_name: "IndexFieldName", # required
|
609
|
+
# },
|
610
|
+
# ],
|
611
|
+
# },
|
612
|
+
# ],
|
613
|
+
# knowledge_article_configuration: {
|
614
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
615
|
+
# standard_knowledge_article_type_configuration: {
|
616
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
617
|
+
# document_title_field_name: "DataSourceFieldName",
|
618
|
+
# field_mappings: [
|
619
|
+
# {
|
620
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
621
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
622
|
+
# index_field_name: "IndexFieldName", # required
|
623
|
+
# },
|
624
|
+
# ],
|
625
|
+
# },
|
626
|
+
# custom_knowledge_article_type_configurations: [
|
627
|
+
# {
|
628
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
629
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
630
|
+
# document_title_field_name: "DataSourceFieldName",
|
631
|
+
# field_mappings: [
|
632
|
+
# {
|
633
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
634
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
635
|
+
# index_field_name: "IndexFieldName", # required
|
636
|
+
# },
|
637
|
+
# ],
|
638
|
+
# },
|
639
|
+
# ],
|
640
|
+
# },
|
641
|
+
# chatter_feed_configuration: {
|
642
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
643
|
+
# document_title_field_name: "DataSourceFieldName",
|
644
|
+
# field_mappings: [
|
645
|
+
# {
|
646
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
647
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
648
|
+
# index_field_name: "IndexFieldName", # required
|
649
|
+
# },
|
650
|
+
# ],
|
651
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
652
|
+
# },
|
653
|
+
# crawl_attachments: false,
|
654
|
+
# standard_object_attachment_configuration: {
|
655
|
+
# document_title_field_name: "DataSourceFieldName",
|
656
|
+
# field_mappings: [
|
657
|
+
# {
|
658
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
659
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
660
|
+
# index_field_name: "IndexFieldName", # required
|
661
|
+
# },
|
662
|
+
# ],
|
663
|
+
# },
|
664
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
665
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
666
|
+
# },
|
667
|
+
# one_drive_configuration: {
|
668
|
+
# tenant_domain: "TenantDomain", # required
|
669
|
+
# secret_arn: "SecretArn", # required
|
670
|
+
# one_drive_users: { # required
|
671
|
+
# one_drive_user_list: ["OneDriveUser"],
|
672
|
+
# one_drive_user_s3_path: {
|
673
|
+
# bucket: "S3BucketName", # required
|
674
|
+
# key: "S3ObjectKey", # required
|
675
|
+
# },
|
676
|
+
# },
|
677
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
678
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
679
|
+
# field_mappings: [
|
680
|
+
# {
|
681
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
682
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
683
|
+
# index_field_name: "IndexFieldName", # required
|
684
|
+
# },
|
685
|
+
# ],
|
686
|
+
# },
|
687
|
+
# service_now_configuration: {
|
688
|
+
# host_url: "ServiceNowHostUrl", # required
|
689
|
+
# secret_arn: "SecretArn", # required
|
690
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
691
|
+
# knowledge_article_configuration: {
|
692
|
+
# crawl_attachments: false,
|
693
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
694
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
695
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
696
|
+
# document_title_field_name: "DataSourceFieldName",
|
697
|
+
# field_mappings: [
|
698
|
+
# {
|
699
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
700
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
701
|
+
# index_field_name: "IndexFieldName", # required
|
702
|
+
# },
|
703
|
+
# ],
|
704
|
+
# },
|
705
|
+
# service_catalog_configuration: {
|
706
|
+
# crawl_attachments: false,
|
707
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
708
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
709
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
710
|
+
# document_title_field_name: "DataSourceFieldName",
|
711
|
+
# field_mappings: [
|
712
|
+
# {
|
713
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
714
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
715
|
+
# index_field_name: "IndexFieldName", # required
|
716
|
+
# },
|
717
|
+
# ],
|
718
|
+
# },
|
719
|
+
# },
|
568
720
|
# },
|
569
721
|
# description: "Description",
|
570
722
|
# schedule: "ScanSchedule",
|
571
723
|
# role_arn: "RoleArn", # required
|
724
|
+
# tags: [
|
725
|
+
# {
|
726
|
+
# key: "TagKey", # required
|
727
|
+
# value: "TagValue", # required
|
728
|
+
# },
|
729
|
+
# ],
|
572
730
|
# })
|
573
731
|
#
|
574
732
|
# @example Response structure
|
@@ -608,6 +766,11 @@ module Aws::Kendra
|
|
608
766
|
#
|
609
767
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
610
768
|
#
|
769
|
+
# @option params [Array<Types::Tag>] :tags
|
770
|
+
# A list of key-value pairs that identify the FAQ. You can use the tags
|
771
|
+
# to identify and organize your resources and to control access to
|
772
|
+
# resources.
|
773
|
+
#
|
611
774
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
612
775
|
#
|
613
776
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -623,6 +786,12 @@ module Aws::Kendra
|
|
623
786
|
# key: "S3ObjectKey", # required
|
624
787
|
# },
|
625
788
|
# role_arn: "RoleArn", # required
|
789
|
+
# tags: [
|
790
|
+
# {
|
791
|
+
# key: "TagKey", # required
|
792
|
+
# value: "TagValue", # required
|
793
|
+
# },
|
794
|
+
# ],
|
626
795
|
# })
|
627
796
|
#
|
628
797
|
# @example Response structure
|
@@ -649,6 +818,13 @@ module Aws::Kendra
|
|
649
818
|
# @option params [required, String] :name
|
650
819
|
# The name for the new index.
|
651
820
|
#
|
821
|
+
# @option params [String] :edition
|
822
|
+
# The Amazon Kendra edition to use for the index. Choose
|
823
|
+
# `DEVELOPER_EDITION` for indexes intended for development, testing, or
|
824
|
+
# proof of concept. Use `ENTERPRISE_EDITION` for your production
|
825
|
+
# databases. Once you set the edition for an index, it can't be
|
826
|
+
# changed.
|
827
|
+
#
|
652
828
|
# @option params [required, String] :role_arn
|
653
829
|
# An IAM role that gives Amazon Kendra permissions to access your Amazon
|
654
830
|
# CloudWatch logs and metrics. This is also the role used when you use
|
@@ -671,6 +847,11 @@ module Aws::Kendra
|
|
671
847
|
# **A suitable default value is auto-generated.** You should normally
|
672
848
|
# not need to pass this option.**
|
673
849
|
#
|
850
|
+
# @option params [Array<Types::Tag>] :tags
|
851
|
+
# A list of key-value pairs that identify the index. You can use the
|
852
|
+
# tags to identify and organize your resources and to control access to
|
853
|
+
# resources.
|
854
|
+
#
|
674
855
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
675
856
|
#
|
676
857
|
# * {Types::CreateIndexResponse#id #id} => String
|
@@ -679,12 +860,19 @@ module Aws::Kendra
|
|
679
860
|
#
|
680
861
|
# resp = client.create_index({
|
681
862
|
# name: "IndexName", # required
|
863
|
+
# edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
|
682
864
|
# role_arn: "RoleArn", # required
|
683
865
|
# server_side_encryption_configuration: {
|
684
866
|
# kms_key_id: "KmsKeyId",
|
685
867
|
# },
|
686
868
|
# description: "Description",
|
687
869
|
# client_token: "ClientTokenName",
|
870
|
+
# tags: [
|
871
|
+
# {
|
872
|
+
# key: "TagKey", # required
|
873
|
+
# value: "TagValue", # required
|
874
|
+
# },
|
875
|
+
# ],
|
688
876
|
# })
|
689
877
|
#
|
690
878
|
# @example Response structure
|
@@ -700,6 +888,40 @@ module Aws::Kendra
|
|
700
888
|
req.send_request(options)
|
701
889
|
end
|
702
890
|
|
891
|
+
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
892
|
+
# the data source is already being deleted. While the data source is
|
893
|
+
# being deleted, the `Status` field returned by a call to the operation
|
894
|
+
# is set to `DELETING`. For more information, see [Deleting Data
|
895
|
+
# Sources][1].
|
896
|
+
#
|
897
|
+
#
|
898
|
+
#
|
899
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
|
900
|
+
#
|
901
|
+
# @option params [required, String] :id
|
902
|
+
# The unique identifier of the data source to delete.
|
903
|
+
#
|
904
|
+
# @option params [required, String] :index_id
|
905
|
+
# The unique identifier of the index associated with the data source.
|
906
|
+
#
|
907
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
908
|
+
#
|
909
|
+
# @example Request syntax with placeholder values
|
910
|
+
#
|
911
|
+
# resp = client.delete_data_source({
|
912
|
+
# id: "DataSourceId", # required
|
913
|
+
# index_id: "IndexId", # required
|
914
|
+
# })
|
915
|
+
#
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource AWS API Documentation
|
917
|
+
#
|
918
|
+
# @overload delete_data_source(params = {})
|
919
|
+
# @param [Hash] params ({})
|
920
|
+
def delete_data_source(params = {}, options = {})
|
921
|
+
req = build_request(:delete_data_source, params)
|
922
|
+
req.send_request(options)
|
923
|
+
end
|
924
|
+
|
703
925
|
# Removes an FAQ from an index.
|
704
926
|
#
|
705
927
|
# @option params [required, String] :id
|
@@ -786,7 +1008,7 @@ module Aws::Kendra
|
|
786
1008
|
# resp.id #=> String
|
787
1009
|
# resp.index_id #=> String
|
788
1010
|
# resp.name #=> String
|
789
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1011
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
790
1012
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
791
1013
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
792
1014
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -833,6 +1055,89 @@ module Aws::Kendra
|
|
833
1055
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
|
834
1056
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
|
835
1057
|
# resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
|
1058
|
+
# resp.configuration.salesforce_configuration.server_url #=> String
|
1059
|
+
# resp.configuration.salesforce_configuration.secret_arn #=> String
|
1060
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
|
1061
|
+
# 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"
|
1062
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_data_field_name #=> String
|
1063
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_title_field_name #=> String
|
1064
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings #=> Array
|
1065
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1066
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].date_field_format #=> String
|
1067
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].index_field_name #=> String
|
1068
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states #=> Array
|
1069
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states[0] #=> String, one of "DRAFT", "PUBLISHED", "ARCHIVED"
|
1070
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_data_field_name #=> String
|
1071
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_title_field_name #=> String
|
1072
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings #=> Array
|
1073
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].data_source_field_name #=> String
|
1074
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].date_field_format #=> String
|
1075
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].index_field_name #=> String
|
1076
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations #=> Array
|
1077
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].name #=> String
|
1078
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_data_field_name #=> String
|
1079
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_title_field_name #=> String
|
1080
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings #=> Array
|
1081
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1082
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].date_field_format #=> String
|
1083
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].index_field_name #=> String
|
1084
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_data_field_name #=> String
|
1085
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_title_field_name #=> String
|
1086
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings #=> Array
|
1087
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].data_source_field_name #=> String
|
1088
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].date_field_format #=> String
|
1089
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].index_field_name #=> String
|
1090
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types #=> Array
|
1091
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types[0] #=> String, one of "ACTIVE_USER", "STANDARD_USER"
|
1092
|
+
# resp.configuration.salesforce_configuration.crawl_attachments #=> Boolean
|
1093
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.document_title_field_name #=> String
|
1094
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings #=> Array
|
1095
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].data_source_field_name #=> String
|
1096
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].date_field_format #=> String
|
1097
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].index_field_name #=> String
|
1098
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns #=> Array
|
1099
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns[0] #=> String
|
1100
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns #=> Array
|
1101
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns[0] #=> String
|
1102
|
+
# resp.configuration.one_drive_configuration.tenant_domain #=> String
|
1103
|
+
# resp.configuration.one_drive_configuration.secret_arn #=> String
|
1104
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list #=> Array
|
1105
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list[0] #=> String
|
1106
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.bucket #=> String
|
1107
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.key #=> String
|
1108
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns #=> Array
|
1109
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns[0] #=> String
|
1110
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns #=> Array
|
1111
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns[0] #=> String
|
1112
|
+
# resp.configuration.one_drive_configuration.field_mappings #=> Array
|
1113
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
1114
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
|
1115
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
|
1116
|
+
# resp.configuration.service_now_configuration.host_url #=> String
|
1117
|
+
# resp.configuration.service_now_configuration.secret_arn #=> String
|
1118
|
+
# resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
|
1119
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.crawl_attachments #=> Boolean
|
1120
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns #=> Array
|
1121
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns[0] #=> String
|
1122
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns #=> Array
|
1123
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns[0] #=> String
|
1124
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_data_field_name #=> String
|
1125
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_title_field_name #=> String
|
1126
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings #=> Array
|
1127
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
|
1128
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
|
1129
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
|
1130
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
|
1131
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
|
1132
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
|
1133
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns #=> Array
|
1134
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns[0] #=> String
|
1135
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_data_field_name #=> String
|
1136
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_title_field_name #=> String
|
1137
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings #=> Array
|
1138
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1139
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1140
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
836
1141
|
# resp.created_at #=> Time
|
837
1142
|
# resp.updated_at #=> Time
|
838
1143
|
# resp.description #=> String
|
@@ -910,6 +1215,7 @@ module Aws::Kendra
|
|
910
1215
|
#
|
911
1216
|
# * {Types::DescribeIndexResponse#name #name} => String
|
912
1217
|
# * {Types::DescribeIndexResponse#id #id} => String
|
1218
|
+
# * {Types::DescribeIndexResponse#edition #edition} => String
|
913
1219
|
# * {Types::DescribeIndexResponse#role_arn #role_arn} => String
|
914
1220
|
# * {Types::DescribeIndexResponse#server_side_encryption_configuration #server_side_encryption_configuration} => Types::ServerSideEncryptionConfiguration
|
915
1221
|
# * {Types::DescribeIndexResponse#status #status} => String
|
@@ -919,6 +1225,7 @@ module Aws::Kendra
|
|
919
1225
|
# * {Types::DescribeIndexResponse#document_metadata_configurations #document_metadata_configurations} => Array<Types::DocumentMetadataConfiguration>
|
920
1226
|
# * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
921
1227
|
# * {Types::DescribeIndexResponse#error_message #error_message} => String
|
1228
|
+
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
922
1229
|
#
|
923
1230
|
# @example Request syntax with placeholder values
|
924
1231
|
#
|
@@ -930,9 +1237,10 @@ module Aws::Kendra
|
|
930
1237
|
#
|
931
1238
|
# resp.name #=> String
|
932
1239
|
# resp.id #=> String
|
1240
|
+
# resp.edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
933
1241
|
# resp.role_arn #=> String
|
934
1242
|
# resp.server_side_encryption_configuration.kms_key_id #=> String
|
935
|
-
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
|
1243
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
936
1244
|
# resp.description #=> String
|
937
1245
|
# resp.created_at #=> Time
|
938
1246
|
# resp.updated_at #=> Time
|
@@ -950,7 +1258,10 @@ module Aws::Kendra
|
|
950
1258
|
# resp.document_metadata_configurations[0].search.displayable #=> Boolean
|
951
1259
|
# resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
|
952
1260
|
# resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
|
1261
|
+
# resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
|
953
1262
|
# resp.error_message #=> String
|
1263
|
+
# resp.capacity_units.storage_capacity_units #=> Integer
|
1264
|
+
# resp.capacity_units.query_capacity_units #=> Integer
|
954
1265
|
#
|
955
1266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
956
1267
|
#
|
@@ -1004,7 +1315,7 @@ module Aws::Kendra
|
|
1004
1315
|
# start_time: Time.now,
|
1005
1316
|
# end_time: Time.now,
|
1006
1317
|
# },
|
1007
|
-
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
|
1318
|
+
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
|
1008
1319
|
# })
|
1009
1320
|
#
|
1010
1321
|
# @example Response structure
|
@@ -1013,10 +1324,15 @@ module Aws::Kendra
|
|
1013
1324
|
# resp.history[0].execution_id #=> String
|
1014
1325
|
# resp.history[0].start_time #=> Time
|
1015
1326
|
# resp.history[0].end_time #=> Time
|
1016
|
-
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED"
|
1327
|
+
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"
|
1017
1328
|
# resp.history[0].error_message #=> String
|
1018
1329
|
# resp.history[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
1019
1330
|
# resp.history[0].data_source_error_code #=> String
|
1331
|
+
# resp.history[0].metrics.documents_added #=> String
|
1332
|
+
# resp.history[0].metrics.documents_modified #=> String
|
1333
|
+
# resp.history[0].metrics.documents_deleted #=> String
|
1334
|
+
# resp.history[0].metrics.documents_failed #=> String
|
1335
|
+
# resp.history[0].metrics.documents_scanned #=> String
|
1020
1336
|
# resp.next_token #=> String
|
1021
1337
|
#
|
1022
1338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs AWS API Documentation
|
@@ -1062,7 +1378,7 @@ module Aws::Kendra
|
|
1062
1378
|
# resp.summary_items #=> Array
|
1063
1379
|
# resp.summary_items[0].name #=> String
|
1064
1380
|
# resp.summary_items[0].id #=> String
|
1065
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1381
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1066
1382
|
# resp.summary_items[0].created_at #=> Time
|
1067
1383
|
# resp.summary_items[0].updated_at #=> Time
|
1068
1384
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1153,9 +1469,10 @@ module Aws::Kendra
|
|
1153
1469
|
# resp.index_configuration_summary_items #=> Array
|
1154
1470
|
# resp.index_configuration_summary_items[0].name #=> String
|
1155
1471
|
# resp.index_configuration_summary_items[0].id #=> String
|
1472
|
+
# resp.index_configuration_summary_items[0].edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
1156
1473
|
# resp.index_configuration_summary_items[0].created_at #=> Time
|
1157
1474
|
# resp.index_configuration_summary_items[0].updated_at #=> Time
|
1158
|
-
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
|
1475
|
+
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
1159
1476
|
# resp.next_token #=> String
|
1160
1477
|
#
|
1161
1478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices AWS API Documentation
|
@@ -1167,6 +1484,38 @@ module Aws::Kendra
|
|
1167
1484
|
req.send_request(options)
|
1168
1485
|
end
|
1169
1486
|
|
1487
|
+
# Gets a list of tags associated with a specified resource. Indexes,
|
1488
|
+
# FAQs, and data sources can have tags associated with them.
|
1489
|
+
#
|
1490
|
+
# @option params [required, String] :resource_arn
|
1491
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1492
|
+
# get a list of tags for.
|
1493
|
+
#
|
1494
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1495
|
+
#
|
1496
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1497
|
+
#
|
1498
|
+
# @example Request syntax with placeholder values
|
1499
|
+
#
|
1500
|
+
# resp = client.list_tags_for_resource({
|
1501
|
+
# resource_arn: "AmazonResourceName", # required
|
1502
|
+
# })
|
1503
|
+
#
|
1504
|
+
# @example Response structure
|
1505
|
+
#
|
1506
|
+
# resp.tags #=> Array
|
1507
|
+
# resp.tags[0].key #=> String
|
1508
|
+
# resp.tags[0].value #=> String
|
1509
|
+
#
|
1510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource AWS API Documentation
|
1511
|
+
#
|
1512
|
+
# @overload list_tags_for_resource(params = {})
|
1513
|
+
# @param [Hash] params ({})
|
1514
|
+
def list_tags_for_resource(params = {}, options = {})
|
1515
|
+
req = build_request(:list_tags_for_resource, params)
|
1516
|
+
req.send_request(options)
|
1517
|
+
end
|
1518
|
+
|
1170
1519
|
# Searches an active index. Use this API to search your documents using
|
1171
1520
|
# query. The `Query` operation enables to do faceted search and to
|
1172
1521
|
# filter results based on document attributes.
|
@@ -1225,7 +1574,8 @@ module Aws::Kendra
|
|
1225
1574
|
#
|
1226
1575
|
# @option params [Integer] :page_size
|
1227
1576
|
# Sets the number of results that are returned in each page of results.
|
1228
|
-
# The default page size is
|
1577
|
+
# The default page size is 10. The maximum number of results returned is
|
1578
|
+
# 100. If you ask for more than 100 results, only 100 are returned.
|
1229
1579
|
#
|
1230
1580
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1231
1581
|
#
|
@@ -1491,6 +1841,69 @@ module Aws::Kendra
|
|
1491
1841
|
req.send_request(options)
|
1492
1842
|
end
|
1493
1843
|
|
1844
|
+
# Adds the specified tag to the specified index, FAQ, or data source
|
1845
|
+
# resource. If the tag already exists, the existing value is replaced
|
1846
|
+
# with the new value.
|
1847
|
+
#
|
1848
|
+
# @option params [required, String] :resource_arn
|
1849
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1850
|
+
# tag.
|
1851
|
+
#
|
1852
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1853
|
+
# A list of tag keys to add to the index, FAQ, or data source. If a tag
|
1854
|
+
# already exists, the existing value is replaced with the new value.
|
1855
|
+
#
|
1856
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1857
|
+
#
|
1858
|
+
# @example Request syntax with placeholder values
|
1859
|
+
#
|
1860
|
+
# resp = client.tag_resource({
|
1861
|
+
# resource_arn: "AmazonResourceName", # required
|
1862
|
+
# tags: [ # required
|
1863
|
+
# {
|
1864
|
+
# key: "TagKey", # required
|
1865
|
+
# value: "TagValue", # required
|
1866
|
+
# },
|
1867
|
+
# ],
|
1868
|
+
# })
|
1869
|
+
#
|
1870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource AWS API Documentation
|
1871
|
+
#
|
1872
|
+
# @overload tag_resource(params = {})
|
1873
|
+
# @param [Hash] params ({})
|
1874
|
+
def tag_resource(params = {}, options = {})
|
1875
|
+
req = build_request(:tag_resource, params)
|
1876
|
+
req.send_request(options)
|
1877
|
+
end
|
1878
|
+
|
1879
|
+
# Removes a tag from an index, FAQ, or a data source.
|
1880
|
+
#
|
1881
|
+
# @option params [required, String] :resource_arn
|
1882
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1883
|
+
# remove the tag from.
|
1884
|
+
#
|
1885
|
+
# @option params [required, Array<String>] :tag_keys
|
1886
|
+
# A list of tag keys to remove from the index, FAQ, or data source. If a
|
1887
|
+
# tag key does not exist on the resource, it is ignored.
|
1888
|
+
#
|
1889
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1890
|
+
#
|
1891
|
+
# @example Request syntax with placeholder values
|
1892
|
+
#
|
1893
|
+
# resp = client.untag_resource({
|
1894
|
+
# resource_arn: "AmazonResourceName", # required
|
1895
|
+
# tag_keys: ["TagKey"], # required
|
1896
|
+
# })
|
1897
|
+
#
|
1898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource AWS API Documentation
|
1899
|
+
#
|
1900
|
+
# @overload untag_resource(params = {})
|
1901
|
+
# @param [Hash] params ({})
|
1902
|
+
def untag_resource(params = {}, options = {})
|
1903
|
+
req = build_request(:untag_resource, params)
|
1904
|
+
req.send_request(options)
|
1905
|
+
end
|
1906
|
+
|
1494
1907
|
# Updates an existing Amazon Kendra data source.
|
1495
1908
|
#
|
1496
1909
|
# @option params [required, String] :id
|
@@ -1588,6 +2001,130 @@ module Aws::Kendra
|
|
1588
2001
|
# allowed_groups_column_name: "ColumnName", # required
|
1589
2002
|
# },
|
1590
2003
|
# },
|
2004
|
+
# salesforce_configuration: {
|
2005
|
+
# server_url: "Url", # required
|
2006
|
+
# secret_arn: "SecretArn", # required
|
2007
|
+
# standard_object_configurations: [
|
2008
|
+
# {
|
2009
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
2010
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2011
|
+
# document_title_field_name: "DataSourceFieldName",
|
2012
|
+
# field_mappings: [
|
2013
|
+
# {
|
2014
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2015
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2016
|
+
# index_field_name: "IndexFieldName", # required
|
2017
|
+
# },
|
2018
|
+
# ],
|
2019
|
+
# },
|
2020
|
+
# ],
|
2021
|
+
# knowledge_article_configuration: {
|
2022
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
2023
|
+
# standard_knowledge_article_type_configuration: {
|
2024
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2025
|
+
# document_title_field_name: "DataSourceFieldName",
|
2026
|
+
# field_mappings: [
|
2027
|
+
# {
|
2028
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2029
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2030
|
+
# index_field_name: "IndexFieldName", # required
|
2031
|
+
# },
|
2032
|
+
# ],
|
2033
|
+
# },
|
2034
|
+
# custom_knowledge_article_type_configurations: [
|
2035
|
+
# {
|
2036
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
2037
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2038
|
+
# document_title_field_name: "DataSourceFieldName",
|
2039
|
+
# field_mappings: [
|
2040
|
+
# {
|
2041
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2042
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2043
|
+
# index_field_name: "IndexFieldName", # required
|
2044
|
+
# },
|
2045
|
+
# ],
|
2046
|
+
# },
|
2047
|
+
# ],
|
2048
|
+
# },
|
2049
|
+
# chatter_feed_configuration: {
|
2050
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2051
|
+
# document_title_field_name: "DataSourceFieldName",
|
2052
|
+
# field_mappings: [
|
2053
|
+
# {
|
2054
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2055
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2056
|
+
# index_field_name: "IndexFieldName", # required
|
2057
|
+
# },
|
2058
|
+
# ],
|
2059
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
2060
|
+
# },
|
2061
|
+
# crawl_attachments: false,
|
2062
|
+
# standard_object_attachment_configuration: {
|
2063
|
+
# document_title_field_name: "DataSourceFieldName",
|
2064
|
+
# field_mappings: [
|
2065
|
+
# {
|
2066
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2067
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2068
|
+
# index_field_name: "IndexFieldName", # required
|
2069
|
+
# },
|
2070
|
+
# ],
|
2071
|
+
# },
|
2072
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2073
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2074
|
+
# },
|
2075
|
+
# one_drive_configuration: {
|
2076
|
+
# tenant_domain: "TenantDomain", # required
|
2077
|
+
# secret_arn: "SecretArn", # required
|
2078
|
+
# one_drive_users: { # required
|
2079
|
+
# one_drive_user_list: ["OneDriveUser"],
|
2080
|
+
# one_drive_user_s3_path: {
|
2081
|
+
# bucket: "S3BucketName", # required
|
2082
|
+
# key: "S3ObjectKey", # required
|
2083
|
+
# },
|
2084
|
+
# },
|
2085
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2086
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2087
|
+
# field_mappings: [
|
2088
|
+
# {
|
2089
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2090
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2091
|
+
# index_field_name: "IndexFieldName", # required
|
2092
|
+
# },
|
2093
|
+
# ],
|
2094
|
+
# },
|
2095
|
+
# service_now_configuration: {
|
2096
|
+
# host_url: "ServiceNowHostUrl", # required
|
2097
|
+
# secret_arn: "SecretArn", # required
|
2098
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
2099
|
+
# knowledge_article_configuration: {
|
2100
|
+
# crawl_attachments: false,
|
2101
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2102
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2103
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2104
|
+
# document_title_field_name: "DataSourceFieldName",
|
2105
|
+
# field_mappings: [
|
2106
|
+
# {
|
2107
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2108
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2109
|
+
# index_field_name: "IndexFieldName", # required
|
2110
|
+
# },
|
2111
|
+
# ],
|
2112
|
+
# },
|
2113
|
+
# service_catalog_configuration: {
|
2114
|
+
# crawl_attachments: false,
|
2115
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2116
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2117
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2118
|
+
# document_title_field_name: "DataSourceFieldName",
|
2119
|
+
# field_mappings: [
|
2120
|
+
# {
|
2121
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2122
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2123
|
+
# index_field_name: "IndexFieldName", # required
|
2124
|
+
# },
|
2125
|
+
# ],
|
2126
|
+
# },
|
2127
|
+
# },
|
1591
2128
|
# },
|
1592
2129
|
# description: "Description",
|
1593
2130
|
# schedule: "ScanSchedule",
|
@@ -1621,6 +2158,14 @@ module Aws::Kendra
|
|
1621
2158
|
# @option params [Array<Types::DocumentMetadataConfiguration>] :document_metadata_configuration_updates
|
1622
2159
|
# The document metadata to update.
|
1623
2160
|
#
|
2161
|
+
# @option params [Types::CapacityUnitsConfiguration] :capacity_units
|
2162
|
+
# Sets the number of addtional storage and query capacity units that
|
2163
|
+
# should be used by the index. You can change the capacity of the index
|
2164
|
+
# up to 5 times per day.
|
2165
|
+
#
|
2166
|
+
# If you are using extra storage units, you can't reduce the storage
|
2167
|
+
# capacity below that required to meet the storage needs for your index.
|
2168
|
+
#
|
1624
2169
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1625
2170
|
#
|
1626
2171
|
# @example Request syntax with placeholder values
|
@@ -1650,6 +2195,10 @@ module Aws::Kendra
|
|
1650
2195
|
# },
|
1651
2196
|
# },
|
1652
2197
|
# ],
|
2198
|
+
# capacity_units: {
|
2199
|
+
# storage_capacity_units: 1, # required
|
2200
|
+
# query_capacity_units: 1, # required
|
2201
|
+
# },
|
1653
2202
|
# })
|
1654
2203
|
#
|
1655
2204
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
@@ -1674,7 +2223,7 @@ module Aws::Kendra
|
|
1674
2223
|
params: params,
|
1675
2224
|
config: config)
|
1676
2225
|
context[:gem_name] = 'aws-sdk-kendra'
|
1677
|
-
context[:gem_version] = '1.
|
2226
|
+
context[:gem_version] = '1.8.0'
|
1678
2227
|
Seahorse::Client::Request.new(handlers, context)
|
1679
2228
|
end
|
1680
2229
|
|