aws-sdk-kendra 1.4.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 25a7566510f4a76f542709ebc82aec3fb3cacf48ac13dc5f6977e4b4d2b13da9
4
- data.tar.gz: 92af3a32f139a12d1178a19b365628bf4a42397b97afda1b6a636b54189070ac
3
+ metadata.gz: 1afd0fafb0bfd970e8dde3ace760ed77dd6949081de8d1ac922893d078a819b0
4
+ data.tar.gz: dfd8199c82c90b56c96ec65e38a7df42ed2fc6541357cc3ba1dda0ca856f235b
5
5
  SHA512:
6
- metadata.gz: 37af333df02b0cb3b4dbb22f8cdcdf3d43500fc9b15dcbdf52c9ee317ff078a9c0c0178e74444a47da2ba7b3f6d14ce620eb00a3dd4742591780702daa37e23e
7
- data.tar.gz: 2b2b1cbf831df99df65e1c196675e2781f9af7d01a64e7eb6f1f2e8dcd939a26140dd449bed720aac875538ed2cfc6662307d3bdd120056e0a4a85d9a97c0715
6
+ metadata.gz: 9b3895c24994f135f93026de0081ad5816f43e0bd2fe8c6b73186dadc4e7f6a460b58c872f17753bb2fa6df85c6e299e3704184f49752181aa1dcd844fd784ac
7
+ data.tar.gz: ab705626c3f15b1db8e50cbed4a152311f1d70264b2cf3561838e8ae70b747d755cd35725eb52656d7fe1aaf0f5b15e155183ce3a305a32281e359846ee9b279
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-kendra/customizations'
45
45
  # @service
46
46
  module Aws::Kendra
47
47
 
48
- GEM_VERSION = '1.4.0'
48
+ GEM_VERSION = '1.5.0'
49
49
 
50
50
  end
@@ -331,6 +331,9 @@ module Aws::Kendra
331
331
  # @option params [required, Array<String>] :document_id_list
332
332
  # One or more identifiers for documents to delete from the index.
333
333
  #
334
+ # @option params [Types::DataSourceSyncJobMetricTarget] :data_source_sync_job_metric_target
335
+ # Maps a particular data source sync job to a particular data source.
336
+ #
334
337
  # @return [Types::BatchDeleteDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
335
338
  #
336
339
  # * {Types::BatchDeleteDocumentResponse#failed_documents #failed_documents} => Array&lt;Types::BatchDeleteDocumentResponseFailedDocument&gt;
@@ -340,6 +343,10 @@ module Aws::Kendra
340
343
  # resp = client.batch_delete_document({
341
344
  # index_id: "IndexId", # required
342
345
  # document_id_list: ["DocumentId"], # required
346
+ # data_source_sync_job_metric_target: {
347
+ # data_source_id: "DataSourceId", # required
348
+ # data_source_sync_job_id: "DataSourceSyncJobId", # required
349
+ # },
343
350
  # })
344
351
  #
345
352
  # @example Response structure
@@ -386,8 +393,20 @@ module Aws::Kendra
386
393
  # @option params [required, Array<Types::Document>] :documents
387
394
  # One or more documents to add to the index.
388
395
  #
389
- # Each document is limited to 5 Mb, the total size of the list is
390
- # limited to 50 Mb.
396
+ # Documents have the following file size limits.
397
+ #
398
+ # * 5 MB total size for inline documents
399
+ #
400
+ # * 50 MB total size for files from an S3 bucket
401
+ #
402
+ # * 5 MB extracted text for any file
403
+ #
404
+ # For more information about file size and transaction per second
405
+ # quotas, see [Quotas][1].
406
+ #
407
+ #
408
+ #
409
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
391
410
  #
392
411
  # @return [Types::BatchPutDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
393
412
  #
@@ -492,6 +511,11 @@ module Aws::Kendra
492
511
  #
493
512
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
494
513
  #
514
+ # @option params [Array<Types::Tag>] :tags
515
+ # A list of key-value pairs that identify the data source. You can use
516
+ # the tags to identify and organize your resources and to control access
517
+ # to resources.
518
+ #
495
519
  # @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
496
520
  #
497
521
  # * {Types::CreateDataSourceResponse#id #id} => String
@@ -501,7 +525,7 @@ module Aws::Kendra
501
525
  # resp = client.create_data_source({
502
526
  # name: "DataSourceName", # required
503
527
  # index_id: "IndexId", # required
504
- # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE
528
+ # type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
505
529
  # configuration: { # required
506
530
  # s3_configuration: {
507
531
  # bucket_name: "S3BucketName", # required
@@ -565,10 +589,140 @@ module Aws::Kendra
565
589
  # allowed_groups_column_name: "ColumnName", # required
566
590
  # },
567
591
  # },
592
+ # salesforce_configuration: {
593
+ # server_url: "Url", # required
594
+ # secret_arn: "SecretArn", # required
595
+ # standard_object_configurations: [
596
+ # {
597
+ # name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
598
+ # document_data_field_name: "DataSourceFieldName", # required
599
+ # document_title_field_name: "DataSourceFieldName",
600
+ # field_mappings: [
601
+ # {
602
+ # data_source_field_name: "DataSourceFieldName", # required
603
+ # date_field_format: "DataSourceDateFieldFormat",
604
+ # index_field_name: "IndexFieldName", # required
605
+ # },
606
+ # ],
607
+ # },
608
+ # ],
609
+ # knowledge_article_configuration: {
610
+ # included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
611
+ # standard_knowledge_article_type_configuration: {
612
+ # document_data_field_name: "DataSourceFieldName", # required
613
+ # document_title_field_name: "DataSourceFieldName",
614
+ # field_mappings: [
615
+ # {
616
+ # data_source_field_name: "DataSourceFieldName", # required
617
+ # date_field_format: "DataSourceDateFieldFormat",
618
+ # index_field_name: "IndexFieldName", # required
619
+ # },
620
+ # ],
621
+ # },
622
+ # custom_knowledge_article_type_configurations: [
623
+ # {
624
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
625
+ # document_data_field_name: "DataSourceFieldName", # required
626
+ # document_title_field_name: "DataSourceFieldName",
627
+ # field_mappings: [
628
+ # {
629
+ # data_source_field_name: "DataSourceFieldName", # required
630
+ # date_field_format: "DataSourceDateFieldFormat",
631
+ # index_field_name: "IndexFieldName", # required
632
+ # },
633
+ # ],
634
+ # },
635
+ # ],
636
+ # },
637
+ # chatter_feed_configuration: {
638
+ # document_data_field_name: "DataSourceFieldName", # required
639
+ # document_title_field_name: "DataSourceFieldName",
640
+ # field_mappings: [
641
+ # {
642
+ # data_source_field_name: "DataSourceFieldName", # required
643
+ # date_field_format: "DataSourceDateFieldFormat",
644
+ # index_field_name: "IndexFieldName", # required
645
+ # },
646
+ # ],
647
+ # include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
648
+ # },
649
+ # crawl_attachments: false,
650
+ # standard_object_attachment_configuration: {
651
+ # document_title_field_name: "DataSourceFieldName",
652
+ # field_mappings: [
653
+ # {
654
+ # data_source_field_name: "DataSourceFieldName", # required
655
+ # date_field_format: "DataSourceDateFieldFormat",
656
+ # index_field_name: "IndexFieldName", # required
657
+ # },
658
+ # ],
659
+ # },
660
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
661
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
662
+ # },
663
+ # one_drive_configuration: {
664
+ # tenant_domain: "TenantDomain", # required
665
+ # secret_arn: "SecretArn", # required
666
+ # one_drive_users: { # required
667
+ # one_drive_user_list: ["OneDriveUser"],
668
+ # one_drive_user_s3_path: {
669
+ # bucket: "S3BucketName", # required
670
+ # key: "S3ObjectKey", # required
671
+ # },
672
+ # },
673
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
674
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
675
+ # field_mappings: [
676
+ # {
677
+ # data_source_field_name: "DataSourceFieldName", # required
678
+ # date_field_format: "DataSourceDateFieldFormat",
679
+ # index_field_name: "IndexFieldName", # required
680
+ # },
681
+ # ],
682
+ # },
683
+ # service_now_configuration: {
684
+ # host_url: "ServiceNowHostUrl", # required
685
+ # secret_arn: "SecretArn", # required
686
+ # service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
687
+ # knowledge_article_configuration: {
688
+ # crawl_attachments: false,
689
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
690
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
691
+ # document_data_field_name: "DataSourceFieldName", # required
692
+ # document_title_field_name: "DataSourceFieldName",
693
+ # field_mappings: [
694
+ # {
695
+ # data_source_field_name: "DataSourceFieldName", # required
696
+ # date_field_format: "DataSourceDateFieldFormat",
697
+ # index_field_name: "IndexFieldName", # required
698
+ # },
699
+ # ],
700
+ # },
701
+ # service_catalog_configuration: {
702
+ # crawl_attachments: false,
703
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
704
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
705
+ # document_data_field_name: "DataSourceFieldName", # required
706
+ # document_title_field_name: "DataSourceFieldName",
707
+ # field_mappings: [
708
+ # {
709
+ # data_source_field_name: "DataSourceFieldName", # required
710
+ # date_field_format: "DataSourceDateFieldFormat",
711
+ # index_field_name: "IndexFieldName", # required
712
+ # },
713
+ # ],
714
+ # },
715
+ # },
568
716
  # },
569
717
  # description: "Description",
570
718
  # schedule: "ScanSchedule",
571
719
  # role_arn: "RoleArn", # required
720
+ # tags: [
721
+ # {
722
+ # key: "TagKey", # required
723
+ # value: "TagValue", # required
724
+ # },
725
+ # ],
572
726
  # })
573
727
  #
574
728
  # @example Response structure
@@ -608,6 +762,11 @@ module Aws::Kendra
608
762
  #
609
763
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
610
764
  #
765
+ # @option params [Array<Types::Tag>] :tags
766
+ # A list of key-value pairs that identify the FAQ. You can use the tags
767
+ # to identify and organize your resources and to control access to
768
+ # resources.
769
+ #
611
770
  # @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
612
771
  #
613
772
  # * {Types::CreateFaqResponse#id #id} => String
@@ -623,6 +782,12 @@ module Aws::Kendra
623
782
  # key: "S3ObjectKey", # required
624
783
  # },
625
784
  # role_arn: "RoleArn", # required
785
+ # tags: [
786
+ # {
787
+ # key: "TagKey", # required
788
+ # value: "TagValue", # required
789
+ # },
790
+ # ],
626
791
  # })
627
792
  #
628
793
  # @example Response structure
@@ -649,6 +814,13 @@ module Aws::Kendra
649
814
  # @option params [required, String] :name
650
815
  # The name for the new index.
651
816
  #
817
+ # @option params [String] :edition
818
+ # The Amazon Kendra edition to use for the index. Choose
819
+ # `DEVELOPER_EDITION` for indexes intended for development, testing, or
820
+ # proof of concept. Use `ENTERPRISE_EDITION` for your production
821
+ # databases. Once you set the edition for an index, it can't be
822
+ # changed.
823
+ #
652
824
  # @option params [required, String] :role_arn
653
825
  # An IAM role that gives Amazon Kendra permissions to access your Amazon
654
826
  # CloudWatch logs and metrics. This is also the role used when you use
@@ -671,6 +843,11 @@ module Aws::Kendra
671
843
  # **A suitable default value is auto-generated.** You should normally
672
844
  # not need to pass this option.**
673
845
  #
846
+ # @option params [Array<Types::Tag>] :tags
847
+ # A list of key-value pairs that identify the index. You can use the
848
+ # tags to identify and organize your resources and to control access to
849
+ # resources.
850
+ #
674
851
  # @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
675
852
  #
676
853
  # * {Types::CreateIndexResponse#id #id} => String
@@ -679,12 +856,19 @@ module Aws::Kendra
679
856
  #
680
857
  # resp = client.create_index({
681
858
  # name: "IndexName", # required
859
+ # edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
682
860
  # role_arn: "RoleArn", # required
683
861
  # server_side_encryption_configuration: {
684
862
  # kms_key_id: "KmsKeyId",
685
863
  # },
686
864
  # description: "Description",
687
865
  # client_token: "ClientTokenName",
866
+ # tags: [
867
+ # {
868
+ # key: "TagKey", # required
869
+ # value: "TagValue", # required
870
+ # },
871
+ # ],
688
872
  # })
689
873
  #
690
874
  # @example Response structure
@@ -700,6 +884,40 @@ module Aws::Kendra
700
884
  req.send_request(options)
701
885
  end
702
886
 
887
+ # Deletes an Amazon Kendra data source. An exception is not thrown if
888
+ # the data source is already being deleted. While the data source is
889
+ # being deleted, the `Status` field returned by a call to the operation
890
+ # is set to `DELETING`. For more information, see [Deleting Data
891
+ # Sources][1].
892
+ #
893
+ #
894
+ #
895
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
896
+ #
897
+ # @option params [required, String] :id
898
+ # The unique identifier of the data source to delete.
899
+ #
900
+ # @option params [required, String] :index_id
901
+ # The unique identifier of the index associated with the data source.
902
+ #
903
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
904
+ #
905
+ # @example Request syntax with placeholder values
906
+ #
907
+ # resp = client.delete_data_source({
908
+ # id: "DataSourceId", # required
909
+ # index_id: "IndexId", # required
910
+ # })
911
+ #
912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSource AWS API Documentation
913
+ #
914
+ # @overload delete_data_source(params = {})
915
+ # @param [Hash] params ({})
916
+ def delete_data_source(params = {}, options = {})
917
+ req = build_request(:delete_data_source, params)
918
+ req.send_request(options)
919
+ end
920
+
703
921
  # Removes an FAQ from an index.
704
922
  #
705
923
  # @option params [required, String] :id
@@ -786,7 +1004,7 @@ module Aws::Kendra
786
1004
  # resp.id #=> String
787
1005
  # resp.index_id #=> String
788
1006
  # resp.name #=> String
789
- # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
1007
+ # resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
790
1008
  # resp.configuration.s3_configuration.bucket_name #=> String
791
1009
  # resp.configuration.s3_configuration.inclusion_prefixes #=> Array
792
1010
  # resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
@@ -833,6 +1051,89 @@ module Aws::Kendra
833
1051
  # resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
834
1052
  # resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
835
1053
  # resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
1054
+ # resp.configuration.salesforce_configuration.server_url #=> String
1055
+ # resp.configuration.salesforce_configuration.secret_arn #=> String
1056
+ # resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
1057
+ # resp.configuration.salesforce_configuration.standard_object_configurations[0].name #=> String, one of "ACCOUNT", "CAMPAIGN", "CASE", "CONTACT", "CONTRACT", "DOCUMENT", "GROUP", "IDEA", "LEAD", "OPPORTUNITY", "PARTNER", "PRICEBOOK", "PRODUCT", "PROFILE", "SOLUTION", "TASK", "USER"
1058
+ # resp.configuration.salesforce_configuration.standard_object_configurations[0].document_data_field_name #=> String
1059
+ # resp.configuration.salesforce_configuration.standard_object_configurations[0].document_title_field_name #=> String
1060
+ # resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings #=> Array
1061
+ # resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].data_source_field_name #=> String
1062
+ # resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].date_field_format #=> String
1063
+ # resp.configuration.salesforce_configuration.standard_object_configurations[0].field_mappings[0].index_field_name #=> String
1064
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states #=> Array
1065
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.included_states[0] #=> String, one of "DRAFT", "PUBLISHED", "ARCHIVED"
1066
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_data_field_name #=> String
1067
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.document_title_field_name #=> String
1068
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings #=> Array
1069
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].data_source_field_name #=> String
1070
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].date_field_format #=> String
1071
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.standard_knowledge_article_type_configuration.field_mappings[0].index_field_name #=> String
1072
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations #=> Array
1073
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].name #=> String
1074
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_data_field_name #=> String
1075
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].document_title_field_name #=> String
1076
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings #=> Array
1077
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].data_source_field_name #=> String
1078
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].date_field_format #=> String
1079
+ # resp.configuration.salesforce_configuration.knowledge_article_configuration.custom_knowledge_article_type_configurations[0].field_mappings[0].index_field_name #=> String
1080
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.document_data_field_name #=> String
1081
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.document_title_field_name #=> String
1082
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings #=> Array
1083
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].data_source_field_name #=> String
1084
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].date_field_format #=> String
1085
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.field_mappings[0].index_field_name #=> String
1086
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types #=> Array
1087
+ # resp.configuration.salesforce_configuration.chatter_feed_configuration.include_filter_types[0] #=> String, one of "ACTIVE_USER", "STANDARD_USER"
1088
+ # resp.configuration.salesforce_configuration.crawl_attachments #=> Boolean
1089
+ # resp.configuration.salesforce_configuration.standard_object_attachment_configuration.document_title_field_name #=> String
1090
+ # resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings #=> Array
1091
+ # resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].data_source_field_name #=> String
1092
+ # resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].date_field_format #=> String
1093
+ # resp.configuration.salesforce_configuration.standard_object_attachment_configuration.field_mappings[0].index_field_name #=> String
1094
+ # resp.configuration.salesforce_configuration.include_attachment_file_patterns #=> Array
1095
+ # resp.configuration.salesforce_configuration.include_attachment_file_patterns[0] #=> String
1096
+ # resp.configuration.salesforce_configuration.exclude_attachment_file_patterns #=> Array
1097
+ # resp.configuration.salesforce_configuration.exclude_attachment_file_patterns[0] #=> String
1098
+ # resp.configuration.one_drive_configuration.tenant_domain #=> String
1099
+ # resp.configuration.one_drive_configuration.secret_arn #=> String
1100
+ # resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list #=> Array
1101
+ # resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_list[0] #=> String
1102
+ # resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.bucket #=> String
1103
+ # resp.configuration.one_drive_configuration.one_drive_users.one_drive_user_s3_path.key #=> String
1104
+ # resp.configuration.one_drive_configuration.inclusion_patterns #=> Array
1105
+ # resp.configuration.one_drive_configuration.inclusion_patterns[0] #=> String
1106
+ # resp.configuration.one_drive_configuration.exclusion_patterns #=> Array
1107
+ # resp.configuration.one_drive_configuration.exclusion_patterns[0] #=> String
1108
+ # resp.configuration.one_drive_configuration.field_mappings #=> Array
1109
+ # resp.configuration.one_drive_configuration.field_mappings[0].data_source_field_name #=> String
1110
+ # resp.configuration.one_drive_configuration.field_mappings[0].date_field_format #=> String
1111
+ # resp.configuration.one_drive_configuration.field_mappings[0].index_field_name #=> String
1112
+ # resp.configuration.service_now_configuration.host_url #=> String
1113
+ # resp.configuration.service_now_configuration.secret_arn #=> String
1114
+ # resp.configuration.service_now_configuration.service_now_build_version #=> String, one of "LONDON", "OTHERS"
1115
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.crawl_attachments #=> Boolean
1116
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns #=> Array
1117
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.include_attachment_file_patterns[0] #=> String
1118
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns #=> Array
1119
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.exclude_attachment_file_patterns[0] #=> String
1120
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.document_data_field_name #=> String
1121
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.document_title_field_name #=> String
1122
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings #=> Array
1123
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
1124
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
1125
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
1126
+ # resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
1127
+ # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
1128
+ # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
1129
+ # resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns #=> Array
1130
+ # resp.configuration.service_now_configuration.service_catalog_configuration.exclude_attachment_file_patterns[0] #=> String
1131
+ # resp.configuration.service_now_configuration.service_catalog_configuration.document_data_field_name #=> String
1132
+ # resp.configuration.service_now_configuration.service_catalog_configuration.document_title_field_name #=> String
1133
+ # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings #=> Array
1134
+ # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
1135
+ # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
1136
+ # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
836
1137
  # resp.created_at #=> Time
837
1138
  # resp.updated_at #=> Time
838
1139
  # resp.description #=> String
@@ -910,6 +1211,7 @@ module Aws::Kendra
910
1211
  #
911
1212
  # * {Types::DescribeIndexResponse#name #name} => String
912
1213
  # * {Types::DescribeIndexResponse#id #id} => String
1214
+ # * {Types::DescribeIndexResponse#edition #edition} => String
913
1215
  # * {Types::DescribeIndexResponse#role_arn #role_arn} => String
914
1216
  # * {Types::DescribeIndexResponse#server_side_encryption_configuration #server_side_encryption_configuration} => Types::ServerSideEncryptionConfiguration
915
1217
  # * {Types::DescribeIndexResponse#status #status} => String
@@ -919,6 +1221,7 @@ module Aws::Kendra
919
1221
  # * {Types::DescribeIndexResponse#document_metadata_configurations #document_metadata_configurations} => Array&lt;Types::DocumentMetadataConfiguration&gt;
920
1222
  # * {Types::DescribeIndexResponse#index_statistics #index_statistics} => Types::IndexStatistics
921
1223
  # * {Types::DescribeIndexResponse#error_message #error_message} => String
1224
+ # * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
922
1225
  #
923
1226
  # @example Request syntax with placeholder values
924
1227
  #
@@ -930,9 +1233,10 @@ module Aws::Kendra
930
1233
  #
931
1234
  # resp.name #=> String
932
1235
  # resp.id #=> String
1236
+ # resp.edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
933
1237
  # resp.role_arn #=> String
934
1238
  # resp.server_side_encryption_configuration.kms_key_id #=> String
935
- # resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "SYSTEM_UPDATING"
1239
+ # resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
936
1240
  # resp.description #=> String
937
1241
  # resp.created_at #=> Time
938
1242
  # resp.updated_at #=> Time
@@ -950,7 +1254,10 @@ module Aws::Kendra
950
1254
  # resp.document_metadata_configurations[0].search.displayable #=> Boolean
951
1255
  # resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
952
1256
  # resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
1257
+ # resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
953
1258
  # resp.error_message #=> String
1259
+ # resp.capacity_units.storage_capacity_units #=> Integer
1260
+ # resp.capacity_units.query_capacity_units #=> Integer
954
1261
  #
955
1262
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
956
1263
  #
@@ -1004,7 +1311,7 @@ module Aws::Kendra
1004
1311
  # start_time: Time.now,
1005
1312
  # end_time: Time.now,
1006
1313
  # },
1007
- # status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED
1314
+ # status_filter: "FAILED", # accepts FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING
1008
1315
  # })
1009
1316
  #
1010
1317
  # @example Response structure
@@ -1013,10 +1320,15 @@ module Aws::Kendra
1013
1320
  # resp.history[0].execution_id #=> String
1014
1321
  # resp.history[0].start_time #=> Time
1015
1322
  # resp.history[0].end_time #=> Time
1016
- # resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED"
1323
+ # resp.history[0].status #=> String, one of "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"
1017
1324
  # resp.history[0].error_message #=> String
1018
1325
  # resp.history[0].error_code #=> String, one of "InternalError", "InvalidRequest"
1019
1326
  # resp.history[0].data_source_error_code #=> String
1327
+ # resp.history[0].metrics.documents_added #=> String
1328
+ # resp.history[0].metrics.documents_modified #=> String
1329
+ # resp.history[0].metrics.documents_deleted #=> String
1330
+ # resp.history[0].metrics.documents_failed #=> String
1331
+ # resp.history[0].metrics.documents_scanned #=> String
1020
1332
  # resp.next_token #=> String
1021
1333
  #
1022
1334
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobs AWS API Documentation
@@ -1062,7 +1374,7 @@ module Aws::Kendra
1062
1374
  # resp.summary_items #=> Array
1063
1375
  # resp.summary_items[0].name #=> String
1064
1376
  # resp.summary_items[0].id #=> String
1065
- # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE"
1377
+ # resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
1066
1378
  # resp.summary_items[0].created_at #=> Time
1067
1379
  # resp.summary_items[0].updated_at #=> Time
1068
1380
  # resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
@@ -1153,9 +1465,10 @@ module Aws::Kendra
1153
1465
  # resp.index_configuration_summary_items #=> Array
1154
1466
  # resp.index_configuration_summary_items[0].name #=> String
1155
1467
  # resp.index_configuration_summary_items[0].id #=> String
1468
+ # resp.index_configuration_summary_items[0].edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
1156
1469
  # resp.index_configuration_summary_items[0].created_at #=> Time
1157
1470
  # 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"
1471
+ # resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
1159
1472
  # resp.next_token #=> String
1160
1473
  #
1161
1474
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndices AWS API Documentation
@@ -1167,6 +1480,38 @@ module Aws::Kendra
1167
1480
  req.send_request(options)
1168
1481
  end
1169
1482
 
1483
+ # Gets a list of tags associated with a specified resource. Indexes,
1484
+ # FAQs, and data sources can have tags associated with them.
1485
+ #
1486
+ # @option params [required, String] :resource_arn
1487
+ # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
1488
+ # get a list of tags for.
1489
+ #
1490
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1491
+ #
1492
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
1493
+ #
1494
+ # @example Request syntax with placeholder values
1495
+ #
1496
+ # resp = client.list_tags_for_resource({
1497
+ # resource_arn: "AmazonResourceName", # required
1498
+ # })
1499
+ #
1500
+ # @example Response structure
1501
+ #
1502
+ # resp.tags #=> Array
1503
+ # resp.tags[0].key #=> String
1504
+ # resp.tags[0].value #=> String
1505
+ #
1506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResource AWS API Documentation
1507
+ #
1508
+ # @overload list_tags_for_resource(params = {})
1509
+ # @param [Hash] params ({})
1510
+ def list_tags_for_resource(params = {}, options = {})
1511
+ req = build_request(:list_tags_for_resource, params)
1512
+ req.send_request(options)
1513
+ end
1514
+
1170
1515
  # Searches an active index. Use this API to search your documents using
1171
1516
  # query. The `Query` operation enables to do faceted search and to
1172
1517
  # filter results based on document attributes.
@@ -1225,7 +1570,8 @@ module Aws::Kendra
1225
1570
  #
1226
1571
  # @option params [Integer] :page_size
1227
1572
  # Sets the number of results that are returned in each page of results.
1228
- # The default page size is 100.
1573
+ # The default page size is 10. The maximum number of results returned is
1574
+ # 100. If you ask for more than 100 results, only 100 are returned.
1229
1575
  #
1230
1576
  # @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1231
1577
  #
@@ -1491,6 +1837,69 @@ module Aws::Kendra
1491
1837
  req.send_request(options)
1492
1838
  end
1493
1839
 
1840
+ # Adds the specified tag to the specified index, FAQ, or data source
1841
+ # resource. If the tag already exists, the existing value is replaced
1842
+ # with the new value.
1843
+ #
1844
+ # @option params [required, String] :resource_arn
1845
+ # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
1846
+ # tag.
1847
+ #
1848
+ # @option params [required, Array<Types::Tag>] :tags
1849
+ # A list of tag keys to add to the index, FAQ, or data source. If a tag
1850
+ # already exists, the existing value is replaced with the new value.
1851
+ #
1852
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1853
+ #
1854
+ # @example Request syntax with placeholder values
1855
+ #
1856
+ # resp = client.tag_resource({
1857
+ # resource_arn: "AmazonResourceName", # required
1858
+ # tags: [ # required
1859
+ # {
1860
+ # key: "TagKey", # required
1861
+ # value: "TagValue", # required
1862
+ # },
1863
+ # ],
1864
+ # })
1865
+ #
1866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResource AWS API Documentation
1867
+ #
1868
+ # @overload tag_resource(params = {})
1869
+ # @param [Hash] params ({})
1870
+ def tag_resource(params = {}, options = {})
1871
+ req = build_request(:tag_resource, params)
1872
+ req.send_request(options)
1873
+ end
1874
+
1875
+ # Removes a tag from an index, FAQ, or a data source.
1876
+ #
1877
+ # @option params [required, String] :resource_arn
1878
+ # The Amazon Resource Name (ARN) of the index, FAQ, or data source to
1879
+ # remove the tag from.
1880
+ #
1881
+ # @option params [required, Array<String>] :tag_keys
1882
+ # A list of tag keys to remove from the index, FAQ, or data source. If a
1883
+ # tag key does not exist on the resource, it is ignored.
1884
+ #
1885
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1886
+ #
1887
+ # @example Request syntax with placeholder values
1888
+ #
1889
+ # resp = client.untag_resource({
1890
+ # resource_arn: "AmazonResourceName", # required
1891
+ # tag_keys: ["TagKey"], # required
1892
+ # })
1893
+ #
1894
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResource AWS API Documentation
1895
+ #
1896
+ # @overload untag_resource(params = {})
1897
+ # @param [Hash] params ({})
1898
+ def untag_resource(params = {}, options = {})
1899
+ req = build_request(:untag_resource, params)
1900
+ req.send_request(options)
1901
+ end
1902
+
1494
1903
  # Updates an existing Amazon Kendra data source.
1495
1904
  #
1496
1905
  # @option params [required, String] :id
@@ -1588,6 +1997,130 @@ module Aws::Kendra
1588
1997
  # allowed_groups_column_name: "ColumnName", # required
1589
1998
  # },
1590
1999
  # },
2000
+ # salesforce_configuration: {
2001
+ # server_url: "Url", # required
2002
+ # secret_arn: "SecretArn", # required
2003
+ # standard_object_configurations: [
2004
+ # {
2005
+ # name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
2006
+ # document_data_field_name: "DataSourceFieldName", # required
2007
+ # document_title_field_name: "DataSourceFieldName",
2008
+ # field_mappings: [
2009
+ # {
2010
+ # data_source_field_name: "DataSourceFieldName", # required
2011
+ # date_field_format: "DataSourceDateFieldFormat",
2012
+ # index_field_name: "IndexFieldName", # required
2013
+ # },
2014
+ # ],
2015
+ # },
2016
+ # ],
2017
+ # knowledge_article_configuration: {
2018
+ # included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
2019
+ # standard_knowledge_article_type_configuration: {
2020
+ # document_data_field_name: "DataSourceFieldName", # required
2021
+ # document_title_field_name: "DataSourceFieldName",
2022
+ # field_mappings: [
2023
+ # {
2024
+ # data_source_field_name: "DataSourceFieldName", # required
2025
+ # date_field_format: "DataSourceDateFieldFormat",
2026
+ # index_field_name: "IndexFieldName", # required
2027
+ # },
2028
+ # ],
2029
+ # },
2030
+ # custom_knowledge_article_type_configurations: [
2031
+ # {
2032
+ # name: "SalesforceCustomKnowledgeArticleTypeName", # required
2033
+ # document_data_field_name: "DataSourceFieldName", # required
2034
+ # document_title_field_name: "DataSourceFieldName",
2035
+ # field_mappings: [
2036
+ # {
2037
+ # data_source_field_name: "DataSourceFieldName", # required
2038
+ # date_field_format: "DataSourceDateFieldFormat",
2039
+ # index_field_name: "IndexFieldName", # required
2040
+ # },
2041
+ # ],
2042
+ # },
2043
+ # ],
2044
+ # },
2045
+ # chatter_feed_configuration: {
2046
+ # document_data_field_name: "DataSourceFieldName", # required
2047
+ # document_title_field_name: "DataSourceFieldName",
2048
+ # field_mappings: [
2049
+ # {
2050
+ # data_source_field_name: "DataSourceFieldName", # required
2051
+ # date_field_format: "DataSourceDateFieldFormat",
2052
+ # index_field_name: "IndexFieldName", # required
2053
+ # },
2054
+ # ],
2055
+ # include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
2056
+ # },
2057
+ # crawl_attachments: false,
2058
+ # standard_object_attachment_configuration: {
2059
+ # document_title_field_name: "DataSourceFieldName",
2060
+ # field_mappings: [
2061
+ # {
2062
+ # data_source_field_name: "DataSourceFieldName", # required
2063
+ # date_field_format: "DataSourceDateFieldFormat",
2064
+ # index_field_name: "IndexFieldName", # required
2065
+ # },
2066
+ # ],
2067
+ # },
2068
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2069
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2070
+ # },
2071
+ # one_drive_configuration: {
2072
+ # tenant_domain: "TenantDomain", # required
2073
+ # secret_arn: "SecretArn", # required
2074
+ # one_drive_users: { # required
2075
+ # one_drive_user_list: ["OneDriveUser"],
2076
+ # one_drive_user_s3_path: {
2077
+ # bucket: "S3BucketName", # required
2078
+ # key: "S3ObjectKey", # required
2079
+ # },
2080
+ # },
2081
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2082
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2083
+ # field_mappings: [
2084
+ # {
2085
+ # data_source_field_name: "DataSourceFieldName", # required
2086
+ # date_field_format: "DataSourceDateFieldFormat",
2087
+ # index_field_name: "IndexFieldName", # required
2088
+ # },
2089
+ # ],
2090
+ # },
2091
+ # service_now_configuration: {
2092
+ # host_url: "ServiceNowHostUrl", # required
2093
+ # secret_arn: "SecretArn", # required
2094
+ # service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
2095
+ # knowledge_article_configuration: {
2096
+ # crawl_attachments: false,
2097
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2098
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2099
+ # document_data_field_name: "DataSourceFieldName", # required
2100
+ # document_title_field_name: "DataSourceFieldName",
2101
+ # field_mappings: [
2102
+ # {
2103
+ # data_source_field_name: "DataSourceFieldName", # required
2104
+ # date_field_format: "DataSourceDateFieldFormat",
2105
+ # index_field_name: "IndexFieldName", # required
2106
+ # },
2107
+ # ],
2108
+ # },
2109
+ # service_catalog_configuration: {
2110
+ # crawl_attachments: false,
2111
+ # include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2112
+ # exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2113
+ # document_data_field_name: "DataSourceFieldName", # required
2114
+ # document_title_field_name: "DataSourceFieldName",
2115
+ # field_mappings: [
2116
+ # {
2117
+ # data_source_field_name: "DataSourceFieldName", # required
2118
+ # date_field_format: "DataSourceDateFieldFormat",
2119
+ # index_field_name: "IndexFieldName", # required
2120
+ # },
2121
+ # ],
2122
+ # },
2123
+ # },
1591
2124
  # },
1592
2125
  # description: "Description",
1593
2126
  # schedule: "ScanSchedule",
@@ -1621,6 +2154,14 @@ module Aws::Kendra
1621
2154
  # @option params [Array<Types::DocumentMetadataConfiguration>] :document_metadata_configuration_updates
1622
2155
  # The document metadata to update.
1623
2156
  #
2157
+ # @option params [Types::CapacityUnitsConfiguration] :capacity_units
2158
+ # Sets the number of addtional storage and query capacity units that
2159
+ # should be used by the index. You can change the capacity of the index
2160
+ # up to 5 times per day.
2161
+ #
2162
+ # If you are using extra storage units, you can't reduce the storage
2163
+ # capacity below that required to meet the storage needs for your index.
2164
+ #
1624
2165
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1625
2166
  #
1626
2167
  # @example Request syntax with placeholder values
@@ -1650,6 +2191,10 @@ module Aws::Kendra
1650
2191
  # },
1651
2192
  # },
1652
2193
  # ],
2194
+ # capacity_units: {
2195
+ # storage_capacity_units: 1, # required
2196
+ # query_capacity_units: 1, # required
2197
+ # },
1653
2198
  # })
1654
2199
  #
1655
2200
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
@@ -1674,7 +2219,7 @@ module Aws::Kendra
1674
2219
  params: params,
1675
2220
  config: config)
1676
2221
  context[:gem_name] = 'aws-sdk-kendra'
1677
- context[:gem_version] = '1.4.0'
2222
+ context[:gem_version] = '1.5.0'
1678
2223
  Seahorse::Client::Request.new(handlers, context)
1679
2224
  end
1680
2225