aws-sdk-kendra 1.4.0 → 1.9.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 +4 -4
- data/lib/aws-sdk-kendra.rb +3 -1
- data/lib/aws-sdk-kendra/client.rb +585 -13
- data/lib/aws-sdk-kendra/client_api.rb +265 -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 +1882 -101
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ca0c4ed0efc6c1e08201507353f1b6edb0bc92cf0e99befefa76a1341e840caf
|
4
|
+
data.tar.gz: 000c145ddfcf960c317d7e8a8c20aa1118215f60da5ef766b1bedb500c5abecb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2518b211b329d7c1c3708bca80100366ccdf8f4b7ac199d02173afa391ce97db529e61d1463837bd3c61d883676dd6fd409f6ae8376b06075d8dd2333262f01d
|
7
|
+
data.tar.gz: cebff54087acbb01288a4d5dad7fdf7b45ff0b5fe3e3d7ec69303dadc472f1d2da4881b52f21aa47e7a3d1d7de565f3029dfdc1d41cf98696d3340de49d9c91f
|
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.9.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
|
|
@@ -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 a valid HTTP(S) URI.
|
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
|
@@ -564,11 +592,144 @@ module Aws::Kendra
|
|
564
592
|
# acl_configuration: {
|
565
593
|
# allowed_groups_column_name: "ColumnName", # required
|
566
594
|
# },
|
595
|
+
# sql_configuration: {
|
596
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
597
|
+
# },
|
598
|
+
# },
|
599
|
+
# salesforce_configuration: {
|
600
|
+
# server_url: "Url", # required
|
601
|
+
# secret_arn: "SecretArn", # required
|
602
|
+
# standard_object_configurations: [
|
603
|
+
# {
|
604
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
605
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
606
|
+
# document_title_field_name: "DataSourceFieldName",
|
607
|
+
# field_mappings: [
|
608
|
+
# {
|
609
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
610
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
611
|
+
# index_field_name: "IndexFieldName", # required
|
612
|
+
# },
|
613
|
+
# ],
|
614
|
+
# },
|
615
|
+
# ],
|
616
|
+
# knowledge_article_configuration: {
|
617
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
618
|
+
# standard_knowledge_article_type_configuration: {
|
619
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
620
|
+
# document_title_field_name: "DataSourceFieldName",
|
621
|
+
# field_mappings: [
|
622
|
+
# {
|
623
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
624
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
625
|
+
# index_field_name: "IndexFieldName", # required
|
626
|
+
# },
|
627
|
+
# ],
|
628
|
+
# },
|
629
|
+
# custom_knowledge_article_type_configurations: [
|
630
|
+
# {
|
631
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
632
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
633
|
+
# document_title_field_name: "DataSourceFieldName",
|
634
|
+
# field_mappings: [
|
635
|
+
# {
|
636
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
637
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
638
|
+
# index_field_name: "IndexFieldName", # required
|
639
|
+
# },
|
640
|
+
# ],
|
641
|
+
# },
|
642
|
+
# ],
|
643
|
+
# },
|
644
|
+
# chatter_feed_configuration: {
|
645
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
646
|
+
# document_title_field_name: "DataSourceFieldName",
|
647
|
+
# field_mappings: [
|
648
|
+
# {
|
649
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
650
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
651
|
+
# index_field_name: "IndexFieldName", # required
|
652
|
+
# },
|
653
|
+
# ],
|
654
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
655
|
+
# },
|
656
|
+
# crawl_attachments: false,
|
657
|
+
# standard_object_attachment_configuration: {
|
658
|
+
# document_title_field_name: "DataSourceFieldName",
|
659
|
+
# field_mappings: [
|
660
|
+
# {
|
661
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
662
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
663
|
+
# index_field_name: "IndexFieldName", # required
|
664
|
+
# },
|
665
|
+
# ],
|
666
|
+
# },
|
667
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
668
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
669
|
+
# },
|
670
|
+
# one_drive_configuration: {
|
671
|
+
# tenant_domain: "TenantDomain", # required
|
672
|
+
# secret_arn: "SecretArn", # required
|
673
|
+
# one_drive_users: { # required
|
674
|
+
# one_drive_user_list: ["OneDriveUser"],
|
675
|
+
# one_drive_user_s3_path: {
|
676
|
+
# bucket: "S3BucketName", # required
|
677
|
+
# key: "S3ObjectKey", # required
|
678
|
+
# },
|
679
|
+
# },
|
680
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
681
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
682
|
+
# field_mappings: [
|
683
|
+
# {
|
684
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
685
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
686
|
+
# index_field_name: "IndexFieldName", # required
|
687
|
+
# },
|
688
|
+
# ],
|
689
|
+
# },
|
690
|
+
# service_now_configuration: {
|
691
|
+
# host_url: "ServiceNowHostUrl", # required
|
692
|
+
# secret_arn: "SecretArn", # required
|
693
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
694
|
+
# knowledge_article_configuration: {
|
695
|
+
# crawl_attachments: false,
|
696
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
697
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
698
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
699
|
+
# document_title_field_name: "DataSourceFieldName",
|
700
|
+
# field_mappings: [
|
701
|
+
# {
|
702
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
703
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
704
|
+
# index_field_name: "IndexFieldName", # required
|
705
|
+
# },
|
706
|
+
# ],
|
707
|
+
# },
|
708
|
+
# service_catalog_configuration: {
|
709
|
+
# crawl_attachments: false,
|
710
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
711
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
712
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
713
|
+
# document_title_field_name: "DataSourceFieldName",
|
714
|
+
# field_mappings: [
|
715
|
+
# {
|
716
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
717
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
718
|
+
# index_field_name: "IndexFieldName", # required
|
719
|
+
# },
|
720
|
+
# ],
|
721
|
+
# },
|
567
722
|
# },
|
568
723
|
# },
|
569
724
|
# description: "Description",
|
570
725
|
# schedule: "ScanSchedule",
|
571
726
|
# role_arn: "RoleArn", # required
|
727
|
+
# tags: [
|
728
|
+
# {
|
729
|
+
# key: "TagKey", # required
|
730
|
+
# value: "TagValue", # required
|
731
|
+
# },
|
732
|
+
# ],
|
572
733
|
# })
|
573
734
|
#
|
574
735
|
# @example Response structure
|
@@ -608,6 +769,11 @@ module Aws::Kendra
|
|
608
769
|
#
|
609
770
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
610
771
|
#
|
772
|
+
# @option params [Array<Types::Tag>] :tags
|
773
|
+
# A list of key-value pairs that identify the FAQ. You can use the tags
|
774
|
+
# to identify and organize your resources and to control access to
|
775
|
+
# resources.
|
776
|
+
#
|
611
777
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
612
778
|
#
|
613
779
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -623,6 +789,12 @@ module Aws::Kendra
|
|
623
789
|
# key: "S3ObjectKey", # required
|
624
790
|
# },
|
625
791
|
# role_arn: "RoleArn", # required
|
792
|
+
# tags: [
|
793
|
+
# {
|
794
|
+
# key: "TagKey", # required
|
795
|
+
# value: "TagValue", # required
|
796
|
+
# },
|
797
|
+
# ],
|
626
798
|
# })
|
627
799
|
#
|
628
800
|
# @example Response structure
|
@@ -649,6 +821,13 @@ module Aws::Kendra
|
|
649
821
|
# @option params [required, String] :name
|
650
822
|
# The name for the new index.
|
651
823
|
#
|
824
|
+
# @option params [String] :edition
|
825
|
+
# The Amazon Kendra edition to use for the index. Choose
|
826
|
+
# `DEVELOPER_EDITION` for indexes intended for development, testing, or
|
827
|
+
# proof of concept. Use `ENTERPRISE_EDITION` for your production
|
828
|
+
# databases. Once you set the edition for an index, it can't be
|
829
|
+
# changed.
|
830
|
+
#
|
652
831
|
# @option params [required, String] :role_arn
|
653
832
|
# An IAM role that gives Amazon Kendra permissions to access your Amazon
|
654
833
|
# CloudWatch logs and metrics. This is also the role used when you use
|
@@ -671,6 +850,11 @@ module Aws::Kendra
|
|
671
850
|
# **A suitable default value is auto-generated.** You should normally
|
672
851
|
# not need to pass this option.**
|
673
852
|
#
|
853
|
+
# @option params [Array<Types::Tag>] :tags
|
854
|
+
# A list of key-value pairs that identify the index. You can use the
|
855
|
+
# tags to identify and organize your resources and to control access to
|
856
|
+
# resources.
|
857
|
+
#
|
674
858
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
675
859
|
#
|
676
860
|
# * {Types::CreateIndexResponse#id #id} => String
|
@@ -679,12 +863,19 @@ module Aws::Kendra
|
|
679
863
|
#
|
680
864
|
# resp = client.create_index({
|
681
865
|
# name: "IndexName", # required
|
866
|
+
# edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
|
682
867
|
# role_arn: "RoleArn", # required
|
683
868
|
# server_side_encryption_configuration: {
|
684
869
|
# kms_key_id: "KmsKeyId",
|
685
870
|
# },
|
686
871
|
# description: "Description",
|
687
872
|
# client_token: "ClientTokenName",
|
873
|
+
# tags: [
|
874
|
+
# {
|
875
|
+
# key: "TagKey", # required
|
876
|
+
# value: "TagValue", # required
|
877
|
+
# },
|
878
|
+
# ],
|
688
879
|
# })
|
689
880
|
#
|
690
881
|
# @example Response structure
|
@@ -700,6 +891,40 @@ module Aws::Kendra
|
|
700
891
|
req.send_request(options)
|
701
892
|
end
|
702
893
|
|
894
|
+
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
895
|
+
# the data source is already being deleted. While the data source is
|
896
|
+
# being deleted, the `Status` field returned by a call to the operation
|
897
|
+
# is set to `DELETING`. For more information, see [Deleting Data
|
898
|
+
# Sources][1].
|
899
|
+
#
|
900
|
+
#
|
901
|
+
#
|
902
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
|
903
|
+
#
|
904
|
+
# @option params [required, String] :id
|
905
|
+
# The unique identifier of the data source to delete.
|
906
|
+
#
|
907
|
+
# @option params [required, String] :index_id
|
908
|
+
# The unique identifier of the index associated with the data source.
|
909
|
+
#
|
910
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
911
|
+
#
|
912
|
+
# @example Request syntax with placeholder values
|
913
|
+
#
|
914
|
+
# resp = client.delete_data_source({
|
915
|
+
# id: "DataSourceId", # required
|
916
|
+
# index_id: "IndexId", # required
|
917
|
+
# })
|
918
|
+
#
|
919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource AWS API Documentation
|
920
|
+
#
|
921
|
+
# @overload delete_data_source(params = {})
|
922
|
+
# @param [Hash] params ({})
|
923
|
+
def delete_data_source(params = {}, options = {})
|
924
|
+
req = build_request(:delete_data_source, params)
|
925
|
+
req.send_request(options)
|
926
|
+
end
|
927
|
+
|
703
928
|
# Removes an FAQ from an index.
|
704
929
|
#
|
705
930
|
# @option params [required, String] :id
|
@@ -786,7 +1011,7 @@ module Aws::Kendra
|
|
786
1011
|
# resp.id #=> String
|
787
1012
|
# resp.index_id #=> String
|
788
1013
|
# resp.name #=> String
|
789
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1014
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
790
1015
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
791
1016
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
792
1017
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -833,6 +1058,90 @@ module Aws::Kendra
|
|
833
1058
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
|
834
1059
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
|
835
1060
|
# resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
|
1061
|
+
# resp.configuration.database_configuration.sql_configuration.query_identifiers_enclosing_option #=> String, one of "DOUBLE_QUOTES", "NONE"
|
1062
|
+
# resp.configuration.salesforce_configuration.server_url #=> String
|
1063
|
+
# resp.configuration.salesforce_configuration.secret_arn #=> String
|
1064
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
|
1065
|
+
# 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"
|
1066
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_data_field_name #=> String
|
1067
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].document_title_field_name #=> String
|
1068
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings #=> Array
|
1069
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1070
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].date_field_format #=> String
|
1071
|
+
# resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].index_field_name #=> String
|
1072
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states #=> Array
|
1073
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states[0] #=> String, one of "DRAFT", "PUBLISHED", "ARCHIVED"
|
1074
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_data_field_name #=> String
|
1075
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_title_field_name #=> String
|
1076
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings #=> Array
|
1077
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].data_source_field_name #=> String
|
1078
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].date_field_format #=> String
|
1079
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].index_field_name #=> String
|
1080
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations #=> Array
|
1081
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].name #=> String
|
1082
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_data_field_name #=> String
|
1083
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_title_field_name #=> String
|
1084
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings #=> Array
|
1085
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].data_source_field_name #=> String
|
1086
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].date_field_format #=> String
|
1087
|
+
# resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].index_field_name #=> String
|
1088
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_data_field_name #=> String
|
1089
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.document_title_field_name #=> String
|
1090
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings #=> Array
|
1091
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].data_source_field_name #=> String
|
1092
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].date_field_format #=> String
|
1093
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].index_field_name #=> String
|
1094
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types #=> Array
|
1095
|
+
# resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types[0] #=> String, one of "ACTIVE_USER", "STANDARD_USER"
|
1096
|
+
# resp.configuration.salesforce_configuration.crawl_attachments #=> Boolean
|
1097
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.document_title_field_name #=> String
|
1098
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings #=> Array
|
1099
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].data_source_field_name #=> String
|
1100
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].date_field_format #=> String
|
1101
|
+
# resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].index_field_name #=> String
|
1102
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns #=> Array
|
1103
|
+
# resp.configuration.salesforce_configuration.include_attachment_file_patterns[0] #=> String
|
1104
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns #=> Array
|
1105
|
+
# resp.configuration.salesforce_configuration.exclude_attachment_file_patterns[0] #=> String
|
1106
|
+
# resp.configuration.one_drive_configuration.tenant_domain #=> String
|
1107
|
+
# resp.configuration.one_drive_configuration.secret_arn #=> String
|
1108
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list #=> Array
|
1109
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list[0] #=> String
|
1110
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.bucket #=> String
|
1111
|
+
# resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.key #=> String
|
1112
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns #=> Array
|
1113
|
+
# resp.configuration.one_drive_configuration.inclusion_patterns[0] #=> String
|
1114
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns #=> Array
|
1115
|
+
# resp.configuration.one_drive_configuration.exclusion_patterns[0] #=> String
|
1116
|
+
# resp.configuration.one_drive_configuration.field_mappings #=> Array
|
1117
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
1118
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
|
1119
|
+
# resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
|
1120
|
+
# resp.configuration.service_now_configuration.host_url #=> String
|
1121
|
+
# resp.configuration.service_now_configuration.secret_arn #=> String
|
1122
|
+
# resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
|
1123
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.crawl_attachments #=> Boolean
|
1124
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns #=> Array
|
1125
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns[0] #=> String
|
1126
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns #=> Array
|
1127
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns[0] #=> String
|
1128
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_data_field_name #=> String
|
1129
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.document_title_field_name #=> String
|
1130
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings #=> Array
|
1131
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
|
1132
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
|
1133
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
|
1134
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
|
1135
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
|
1136
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
|
1137
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns #=> Array
|
1138
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns[0] #=> String
|
1139
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_data_field_name #=> String
|
1140
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.document_title_field_name #=> String
|
1141
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings #=> Array
|
1142
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1143
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1144
|
+
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
836
1145
|
# resp.created_at #=> Time
|
837
1146
|
# resp.updated_at #=> Time
|
838
1147
|
# resp.description #=> String
|
@@ -910,6 +1219,7 @@ module Aws::Kendra
|
|
910
1219
|
#
|
911
1220
|
# * {Types::DescribeIndexResponse#name #name} => String
|
912
1221
|
# * {Types::DescribeIndexResponse#id #id} => String
|
1222
|
+
# * {Types::DescribeIndexResponse#edition #edition} => String
|
913
1223
|
# * {Types::DescribeIndexResponse#role_arn #role_arn} => String
|
914
1224
|
# * {Types::DescribeIndexResponse#server_side_encryption_configuration #server_side_encryption_configuration} => Types::ServerSideEncryptionConfiguration
|
915
1225
|
# * {Types::DescribeIndexResponse#status #status} => String
|
@@ -919,6 +1229,7 @@ module Aws::Kendra
|
|
919
1229
|
# * {Types::DescribeIndexResponse#document_metadata_configurations #document_metadata_configurations} => Array<Types::DocumentMetadataConfiguration>
|
920
1230
|
# * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
|
921
1231
|
# * {Types::DescribeIndexResponse#error_message #error_message} => String
|
1232
|
+
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
922
1233
|
#
|
923
1234
|
# @example Request syntax with placeholder values
|
924
1235
|
#
|
@@ -930,9 +1241,10 @@ module Aws::Kendra
|
|
930
1241
|
#
|
931
1242
|
# resp.name #=> String
|
932
1243
|
# resp.id #=> String
|
1244
|
+
# resp.edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
933
1245
|
# resp.role_arn #=> String
|
934
1246
|
# resp.server_side_encryption_configuration.kms_key_id #=> String
|
935
|
-
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
|
1247
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
936
1248
|
# resp.description #=> String
|
937
1249
|
# resp.created_at #=> Time
|
938
1250
|
# resp.updated_at #=> Time
|
@@ -948,9 +1260,13 @@ module Aws::Kendra
|
|
948
1260
|
# resp.document_metadata_configurations[0].search.facetable #=> Boolean
|
949
1261
|
# resp.document_metadata_configurations[0].search.searchable #=> Boolean
|
950
1262
|
# resp.document_metadata_configurations[0].search.displayable #=> Boolean
|
1263
|
+
# resp.document_metadata_configurations[0].search.sortable #=> Boolean
|
951
1264
|
# resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
|
952
1265
|
# resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
|
1266
|
+
# resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
|
953
1267
|
# resp.error_message #=> String
|
1268
|
+
# resp.capacity_units.storage_capacity_units #=> Integer
|
1269
|
+
# resp.capacity_units.query_capacity_units #=> Integer
|
954
1270
|
#
|
955
1271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
956
1272
|
#
|
@@ -1004,7 +1320,7 @@ module Aws::Kendra
|
|
1004
1320
|
# start_time: Time.now,
|
1005
1321
|
# end_time: Time.now,
|
1006
1322
|
# },
|
1007
|
-
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
|
1323
|
+
# status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
|
1008
1324
|
# })
|
1009
1325
|
#
|
1010
1326
|
# @example Response structure
|
@@ -1013,10 +1329,15 @@ module Aws::Kendra
|
|
1013
1329
|
# resp.history[0].execution_id #=> String
|
1014
1330
|
# resp.history[0].start_time #=> Time
|
1015
1331
|
# resp.history[0].end_time #=> Time
|
1016
|
-
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED"
|
1332
|
+
# resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"
|
1017
1333
|
# resp.history[0].error_message #=> String
|
1018
1334
|
# resp.history[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
1019
1335
|
# resp.history[0].data_source_error_code #=> String
|
1336
|
+
# resp.history[0].metrics.documents_added #=> String
|
1337
|
+
# resp.history[0].metrics.documents_modified #=> String
|
1338
|
+
# resp.history[0].metrics.documents_deleted #=> String
|
1339
|
+
# resp.history[0].metrics.documents_failed #=> String
|
1340
|
+
# resp.history[0].metrics.documents_scanned #=> String
|
1020
1341
|
# resp.next_token #=> String
|
1021
1342
|
#
|
1022
1343
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs AWS API Documentation
|
@@ -1062,7 +1383,7 @@ module Aws::Kendra
|
|
1062
1383
|
# resp.summary_items #=> Array
|
1063
1384
|
# resp.summary_items[0].name #=> String
|
1064
1385
|
# resp.summary_items[0].id #=> String
|
1065
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
|
1386
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1066
1387
|
# resp.summary_items[0].created_at #=> Time
|
1067
1388
|
# resp.summary_items[0].updated_at #=> Time
|
1068
1389
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1153,9 +1474,10 @@ module Aws::Kendra
|
|
1153
1474
|
# resp.index_configuration_summary_items #=> Array
|
1154
1475
|
# resp.index_configuration_summary_items[0].name #=> String
|
1155
1476
|
# resp.index_configuration_summary_items[0].id #=> String
|
1477
|
+
# resp.index_configuration_summary_items[0].edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
1156
1478
|
# resp.index_configuration_summary_items[0].created_at #=> Time
|
1157
1479
|
# 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"
|
1480
|
+
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
1159
1481
|
# resp.next_token #=> String
|
1160
1482
|
#
|
1161
1483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices AWS API Documentation
|
@@ -1167,6 +1489,38 @@ module Aws::Kendra
|
|
1167
1489
|
req.send_request(options)
|
1168
1490
|
end
|
1169
1491
|
|
1492
|
+
# Gets a list of tags associated with a specified resource. Indexes,
|
1493
|
+
# FAQs, and data sources can have tags associated with them.
|
1494
|
+
#
|
1495
|
+
# @option params [required, String] :resource_arn
|
1496
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1497
|
+
# get a list of tags for.
|
1498
|
+
#
|
1499
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1500
|
+
#
|
1501
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
1502
|
+
#
|
1503
|
+
# @example Request syntax with placeholder values
|
1504
|
+
#
|
1505
|
+
# resp = client.list_tags_for_resource({
|
1506
|
+
# resource_arn: "AmazonResourceName", # required
|
1507
|
+
# })
|
1508
|
+
#
|
1509
|
+
# @example Response structure
|
1510
|
+
#
|
1511
|
+
# resp.tags #=> Array
|
1512
|
+
# resp.tags[0].key #=> String
|
1513
|
+
# resp.tags[0].value #=> String
|
1514
|
+
#
|
1515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource AWS API Documentation
|
1516
|
+
#
|
1517
|
+
# @overload list_tags_for_resource(params = {})
|
1518
|
+
# @param [Hash] params ({})
|
1519
|
+
def list_tags_for_resource(params = {}, options = {})
|
1520
|
+
req = build_request(:list_tags_for_resource, params)
|
1521
|
+
req.send_request(options)
|
1522
|
+
end
|
1523
|
+
|
1170
1524
|
# Searches an active index. Use this API to search your documents using
|
1171
1525
|
# query. The `Query` operation enables to do faceted search and to
|
1172
1526
|
# filter results based on document attributes.
|
@@ -1225,7 +1579,18 @@ module Aws::Kendra
|
|
1225
1579
|
#
|
1226
1580
|
# @option params [Integer] :page_size
|
1227
1581
|
# Sets the number of results that are returned in each page of results.
|
1228
|
-
# The default page size is
|
1582
|
+
# The default page size is 10. The maximum number of results returned is
|
1583
|
+
# 100. If you ask for more than 100 results, only 100 are returned.
|
1584
|
+
#
|
1585
|
+
# @option params [Types::SortingConfiguration] :sorting_configuration
|
1586
|
+
# Provides information that determines how the results of the query are
|
1587
|
+
# sorted. You can set the field that Amazon Kendra should sort the
|
1588
|
+
# results on, and specify whether the results should be sorted in
|
1589
|
+
# ascending or descending order. In the case of ties in sorting the
|
1590
|
+
# results, the results are sorted by relevance.
|
1591
|
+
#
|
1592
|
+
# If you don't provide sorting configuration, the results are sorted by
|
1593
|
+
# the relevance that Amazon Kendra determines for the result.
|
1229
1594
|
#
|
1230
1595
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1231
1596
|
#
|
@@ -1326,6 +1691,10 @@ module Aws::Kendra
|
|
1326
1691
|
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
1327
1692
|
# page_number: 1,
|
1328
1693
|
# page_size: 1,
|
1694
|
+
# sorting_configuration: {
|
1695
|
+
# document_attribute_key: "DocumentAttributeKey", # required
|
1696
|
+
# sort_order: "DESC", # required, accepts DESC, ASC
|
1697
|
+
# },
|
1329
1698
|
# })
|
1330
1699
|
#
|
1331
1700
|
# @example Response structure
|
@@ -1491,6 +1860,69 @@ module Aws::Kendra
|
|
1491
1860
|
req.send_request(options)
|
1492
1861
|
end
|
1493
1862
|
|
1863
|
+
# Adds the specified tag to the specified index, FAQ, or data source
|
1864
|
+
# resource. If the tag already exists, the existing value is replaced
|
1865
|
+
# with the new value.
|
1866
|
+
#
|
1867
|
+
# @option params [required, String] :resource_arn
|
1868
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1869
|
+
# tag.
|
1870
|
+
#
|
1871
|
+
# @option params [required, Array<Types::Tag>] :tags
|
1872
|
+
# A list of tag keys to add to the index, FAQ, or data source. If a tag
|
1873
|
+
# already exists, the existing value is replaced with the new value.
|
1874
|
+
#
|
1875
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1876
|
+
#
|
1877
|
+
# @example Request syntax with placeholder values
|
1878
|
+
#
|
1879
|
+
# resp = client.tag_resource({
|
1880
|
+
# resource_arn: "AmazonResourceName", # required
|
1881
|
+
# tags: [ # required
|
1882
|
+
# {
|
1883
|
+
# key: "TagKey", # required
|
1884
|
+
# value: "TagValue", # required
|
1885
|
+
# },
|
1886
|
+
# ],
|
1887
|
+
# })
|
1888
|
+
#
|
1889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource AWS API Documentation
|
1890
|
+
#
|
1891
|
+
# @overload tag_resource(params = {})
|
1892
|
+
# @param [Hash] params ({})
|
1893
|
+
def tag_resource(params = {}, options = {})
|
1894
|
+
req = build_request(:tag_resource, params)
|
1895
|
+
req.send_request(options)
|
1896
|
+
end
|
1897
|
+
|
1898
|
+
# Removes a tag from an index, FAQ, or a data source.
|
1899
|
+
#
|
1900
|
+
# @option params [required, String] :resource_arn
|
1901
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, or data source to
|
1902
|
+
# remove the tag from.
|
1903
|
+
#
|
1904
|
+
# @option params [required, Array<String>] :tag_keys
|
1905
|
+
# A list of tag keys to remove from the index, FAQ, or data source. If a
|
1906
|
+
# tag key does not exist on the resource, it is ignored.
|
1907
|
+
#
|
1908
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1909
|
+
#
|
1910
|
+
# @example Request syntax with placeholder values
|
1911
|
+
#
|
1912
|
+
# resp = client.untag_resource({
|
1913
|
+
# resource_arn: "AmazonResourceName", # required
|
1914
|
+
# tag_keys: ["TagKey"], # required
|
1915
|
+
# })
|
1916
|
+
#
|
1917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource AWS API Documentation
|
1918
|
+
#
|
1919
|
+
# @overload untag_resource(params = {})
|
1920
|
+
# @param [Hash] params ({})
|
1921
|
+
def untag_resource(params = {}, options = {})
|
1922
|
+
req = build_request(:untag_resource, params)
|
1923
|
+
req.send_request(options)
|
1924
|
+
end
|
1925
|
+
|
1494
1926
|
# Updates an existing Amazon Kendra data source.
|
1495
1927
|
#
|
1496
1928
|
# @option params [required, String] :id
|
@@ -1587,6 +2019,133 @@ module Aws::Kendra
|
|
1587
2019
|
# acl_configuration: {
|
1588
2020
|
# allowed_groups_column_name: "ColumnName", # required
|
1589
2021
|
# },
|
2022
|
+
# sql_configuration: {
|
2023
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
2024
|
+
# },
|
2025
|
+
# },
|
2026
|
+
# salesforce_configuration: {
|
2027
|
+
# server_url: "Url", # required
|
2028
|
+
# secret_arn: "SecretArn", # required
|
2029
|
+
# standard_object_configurations: [
|
2030
|
+
# {
|
2031
|
+
# name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
|
2032
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2033
|
+
# document_title_field_name: "DataSourceFieldName",
|
2034
|
+
# field_mappings: [
|
2035
|
+
# {
|
2036
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2037
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2038
|
+
# index_field_name: "IndexFieldName", # required
|
2039
|
+
# },
|
2040
|
+
# ],
|
2041
|
+
# },
|
2042
|
+
# ],
|
2043
|
+
# knowledge_article_configuration: {
|
2044
|
+
# included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
|
2045
|
+
# standard_knowledge_article_type_configuration: {
|
2046
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2047
|
+
# document_title_field_name: "DataSourceFieldName",
|
2048
|
+
# field_mappings: [
|
2049
|
+
# {
|
2050
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2051
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2052
|
+
# index_field_name: "IndexFieldName", # required
|
2053
|
+
# },
|
2054
|
+
# ],
|
2055
|
+
# },
|
2056
|
+
# custom_knowledge_article_type_configurations: [
|
2057
|
+
# {
|
2058
|
+
# name: "SalesforceCustomKnowledgeArticleTypeName", # required
|
2059
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2060
|
+
# document_title_field_name: "DataSourceFieldName",
|
2061
|
+
# field_mappings: [
|
2062
|
+
# {
|
2063
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2064
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2065
|
+
# index_field_name: "IndexFieldName", # required
|
2066
|
+
# },
|
2067
|
+
# ],
|
2068
|
+
# },
|
2069
|
+
# ],
|
2070
|
+
# },
|
2071
|
+
# chatter_feed_configuration: {
|
2072
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2073
|
+
# document_title_field_name: "DataSourceFieldName",
|
2074
|
+
# field_mappings: [
|
2075
|
+
# {
|
2076
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2077
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2078
|
+
# index_field_name: "IndexFieldName", # required
|
2079
|
+
# },
|
2080
|
+
# ],
|
2081
|
+
# include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
|
2082
|
+
# },
|
2083
|
+
# crawl_attachments: false,
|
2084
|
+
# standard_object_attachment_configuration: {
|
2085
|
+
# document_title_field_name: "DataSourceFieldName",
|
2086
|
+
# field_mappings: [
|
2087
|
+
# {
|
2088
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2089
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2090
|
+
# index_field_name: "IndexFieldName", # required
|
2091
|
+
# },
|
2092
|
+
# ],
|
2093
|
+
# },
|
2094
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2095
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2096
|
+
# },
|
2097
|
+
# one_drive_configuration: {
|
2098
|
+
# tenant_domain: "TenantDomain", # required
|
2099
|
+
# secret_arn: "SecretArn", # required
|
2100
|
+
# one_drive_users: { # required
|
2101
|
+
# one_drive_user_list: ["OneDriveUser"],
|
2102
|
+
# one_drive_user_s3_path: {
|
2103
|
+
# bucket: "S3BucketName", # required
|
2104
|
+
# key: "S3ObjectKey", # required
|
2105
|
+
# },
|
2106
|
+
# },
|
2107
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2108
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2109
|
+
# field_mappings: [
|
2110
|
+
# {
|
2111
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2112
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2113
|
+
# index_field_name: "IndexFieldName", # required
|
2114
|
+
# },
|
2115
|
+
# ],
|
2116
|
+
# },
|
2117
|
+
# service_now_configuration: {
|
2118
|
+
# host_url: "ServiceNowHostUrl", # required
|
2119
|
+
# secret_arn: "SecretArn", # required
|
2120
|
+
# service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
|
2121
|
+
# knowledge_article_configuration: {
|
2122
|
+
# crawl_attachments: false,
|
2123
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2124
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2125
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2126
|
+
# document_title_field_name: "DataSourceFieldName",
|
2127
|
+
# field_mappings: [
|
2128
|
+
# {
|
2129
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2130
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2131
|
+
# index_field_name: "IndexFieldName", # required
|
2132
|
+
# },
|
2133
|
+
# ],
|
2134
|
+
# },
|
2135
|
+
# service_catalog_configuration: {
|
2136
|
+
# crawl_attachments: false,
|
2137
|
+
# include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2138
|
+
# exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2139
|
+
# document_data_field_name: "DataSourceFieldName", # required
|
2140
|
+
# document_title_field_name: "DataSourceFieldName",
|
2141
|
+
# field_mappings: [
|
2142
|
+
# {
|
2143
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2144
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2145
|
+
# index_field_name: "IndexFieldName", # required
|
2146
|
+
# },
|
2147
|
+
# ],
|
2148
|
+
# },
|
1590
2149
|
# },
|
1591
2150
|
# },
|
1592
2151
|
# description: "Description",
|
@@ -1621,6 +2180,14 @@ module Aws::Kendra
|
|
1621
2180
|
# @option params [Array<Types::DocumentMetadataConfiguration>] :document_metadata_configuration_updates
|
1622
2181
|
# The document metadata to update.
|
1623
2182
|
#
|
2183
|
+
# @option params [Types::CapacityUnitsConfiguration] :capacity_units
|
2184
|
+
# Sets the number of addtional storage and query capacity units that
|
2185
|
+
# should be used by the index. You can change the capacity of the index
|
2186
|
+
# up to 5 times per day.
|
2187
|
+
#
|
2188
|
+
# If you are using extra storage units, you can't reduce the storage
|
2189
|
+
# capacity below that required to meet the storage needs for your index.
|
2190
|
+
#
|
1624
2191
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1625
2192
|
#
|
1626
2193
|
# @example Request syntax with placeholder values
|
@@ -1647,9 +2214,14 @@ module Aws::Kendra
|
|
1647
2214
|
# facetable: false,
|
1648
2215
|
# searchable: false,
|
1649
2216
|
# displayable: false,
|
2217
|
+
# sortable: false,
|
1650
2218
|
# },
|
1651
2219
|
# },
|
1652
2220
|
# ],
|
2221
|
+
# capacity_units: {
|
2222
|
+
# storage_capacity_units: 1, # required
|
2223
|
+
# query_capacity_units: 1, # required
|
2224
|
+
# },
|
1653
2225
|
# })
|
1654
2226
|
#
|
1655
2227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
@@ -1674,7 +2246,7 @@ module Aws::Kendra
|
|
1674
2246
|
params: params,
|
1675
2247
|
config: config)
|
1676
2248
|
context[:gem_name] = 'aws-sdk-kendra'
|
1677
|
-
context[:gem_version] = '1.
|
2249
|
+
context[:gem_version] = '1.9.0'
|
1678
2250
|
Seahorse::Client::Request.new(handlers, context)
|
1679
2251
|
end
|
1680
2252
|
|